BLE_ABSTRACTION Function Documentation

 

STATIC_ASSERT

STATIC_ASSERT()

 

Location: bondlist.h:81

 

BondList_Size

uint8_t BondList_Size()

 

Location: bondlist.h:117

 

Bondlist functions.

 

Get the number of entries in the bond list stored to flash
Returns:
Number of entries in the the bond list with a valid bond state

Returns:
Number of entries in the the bond list with a valid bond state

 

BondList_GetIRKs

uint8_t BondList_GetIRKs(struct gap_sec_key * irks)

 

Location: bondlist.h:127

 

Get the IRKs from bond lists.

 

Get the IRKs from bond lists having valid bond state irks Pointer to gap_sec_key structure
Returns:
Number of IRKs found

Returns:
Number of IRKs found

 

Parameters

Direction Name Description

in

irks

Pointer to gap_sec_key structure

 

BondList_FindByIRK

const BondInfo_t * BondList_FindByIRK(const uint8_t * irk)

 

Location: bondlist.h:136

 

Search for the bond information matching specified IRK in flash.

 


Returns:
If found an entry in flash, return its address as a pointer to a const BondInfo_t element NULL otherwise

 

Parameters

Direction Name Description

in

irk

Matching IRK to search for

 

BondList_FindByAddr

const BondInfo_t * BondList_FindByAddr(const uint8_t * addr, uint8_t addrType)

 

Location: bondlist.h:147

 

Search for the bonding information for a peer device in flash matching specified address and address type.

 


Returns:
If found an entry in flash, return its address as a pointer to a const BondInfo_t element NULL otherwise

 

Parameters

Direction Name Description

in

addr

Address of the peer device to search

in

addrType

Address type of the peer device to search

 

BondList_FlashDefrag

bool BondList_FlashDefrag()

 

Location: bondlist.h:154

 

Squeeze bond information together to make space for a new entry.

 


Returns:
True if successful, false otherwise

 

BondList_Add

uint16_t BondList_Add(BondInfo_t * bond_info)

 

Location: bondlist.h:163

 

Add bond information to the bond list.

 


Returns:
Non-zero if bond information is added to bond list successfully, false otherwise

 

Parameters

Direction Name Description

in

bond_info

Pointer to bond information

 

BondList_Remove

bool BondList_Remove(uint16_t bondStateIndex)

 

Location: bondlist.h:171

 

Remove a bond list entry matching the specified index.

 


Returns:
True if successful, false otherwise

 

Parameters

Direction Name Description

in

bondStateIndex

Index of bond list to remove

 

BondList_RemoveAll

bool BondList_RemoveAll()

 

Location: bondlist.h:179

 

Erase bond list sectors containing bond list information in flash.

 


Returns:
If found an error erasing any sector, return false true otherwise