Mistake on this page?
Report an issue in GitHub or email us
Functions
BB_API_BLE_WL

Functions

bool_t BbBlePeriodicListCheckAddr (uint8_t addrType, uint64_t addr, uint8_t SID)
 Check if address is periodic listed. More...
 
uint8_t BbBlePeriodicListGetSize (void)
 Get periodic list size. More...
 
void BbBlePeriodicListClear (void)
 Clear all periodic list entries. More...
 
bool_t BbBlePeriodicListAdd (uint8_t addrType, uint64_t addr, uint8_t SID)
 Add device to the periodic list. More...
 
bool_t BbBlePeriodicListRemove (bool_t randAddr, uint64_t addr, uint8_t SID)
 Remove device from the periodic list. More...
 
bool_t BbBleWhiteListCheckAddr (bool_t randAddr, uint64_t addr)
 Check if address is white listed. More...
 
uint8_t BbBleWhiteListGetSize (void)
 Get white list size. More...
 
void BbBleWhiteListClear (void)
 Clear all white list entries. More...
 
bool_t BbBleWhiteListAdd (bool_t randAddr, uint64_t addr)
 Add device to the white list. More...
 
bool_t BbBleWhiteListRemove (bool_t randAddr, uint64_t addr)
 Remove device from the white list. More...
 
void BbBleWhiteListAddAnonymous (void)
 Add anonymous device to the white list. More...
 
void BbBleWhiteListRemoveAnonymous (void)
 Remove anonymous device from the white list. More...
 
bool_t BbBleWhiteListIsAnonymousAllowed (void)
 Check if anonymous peer is allowed. More...
 

Detailed Description

Function Documentation

bool_t BbBlePeriodicListAdd ( uint8_t  addrType,
uint64_t  addr,
uint8_t  SID 
)

Add device to the periodic list.

Parameters
addrTypeAddress type.
addrBluetooth device address.
SIDSet ID.
Returns
TRUE if successful, FALSE if list full.

Adds the given address to the periodic list stored in the BB.

Note
No resource synchronization is required to modify the periodic list resource as the LL modifies the periodic list only when advertising events are disabled.
bool_t BbBlePeriodicListCheckAddr ( uint8_t  addrType,
uint64_t  addr,
uint8_t  SID 
)

Check if address is periodic listed.

Parameters
addrTypeAddress type.
addrBluetooth device address.
SIDSet ID.
Returns
TRUE if white listed, FALSE otherwise.
void BbBlePeriodicListClear ( void  )

Clear all periodic list entries.

Clear all periodic list entries stored in the BB.

Note
No resource synchronization is required to modify the periodic list resource as the LL modifies the periodic list only when advertising events are disabled.
uint8_t BbBlePeriodicListGetSize ( void  )

Get periodic list size.

Returns
Total number of periodic list entries.

Read the periodic list capacity supported by the BB.

bool_t BbBlePeriodicListRemove ( bool_t  randAddr,
uint64_t  addr,
uint8_t  SID 
)

Remove device from the periodic list.

Parameters
randAddrTRUE if random address, FALSE if public.
addrBluetooth device address.
SIDSet ID.
Returns
TRUE if successful, FALSE if address not in the list.

Removes the given address from the periodic list stored in the BB.

Note
No resource synchronization is required to modify the white list resource as the LL modifies the white list only when advertising events are disabled.
bool_t BbBleWhiteListAdd ( bool_t  randAddr,
uint64_t  addr 
)

Add device to the white list.

Parameters
randAddrTRUE if random address, FALSE if public.
addrBluetooth device address.
Returns
TRUE if successful, FALSE if list full.

Adds the given address to the white list stored in the BB.

Note
No resource synchronization is required to modify the white list resource as the LL modifies the white list only when advertising events are disabled.
void BbBleWhiteListAddAnonymous ( void  )

Add anonymous device to the white list.

bool_t BbBleWhiteListCheckAddr ( bool_t  randAddr,
uint64_t  addr 
)

Check if address is white listed.

Parameters
randAddrTRUE if random address, FALSE if public.
addrBluetooth device address.
Returns
TRUE if white listed, FALSE otherwise.
void BbBleWhiteListClear ( void  )

Clear all white list entries.

Clear all white list entries stored in the BB.

Note
No resource synchronization is required to modify the white list resource as the LL modifies the white list only when advertising events are disabled.
uint8_t BbBleWhiteListGetSize ( void  )

Get white list size.

Returns
Total number of white list entries.

Read the white list capacity supported by the BB.

bool_t BbBleWhiteListIsAnonymousAllowed ( void  )

Check if anonymous peer is allowed.

Returns
TRUE if anonymous allowed, FALSE if disallowed.
bool_t BbBleWhiteListRemove ( bool_t  randAddr,
uint64_t  addr 
)

Remove device from the white list.

Parameters
randAddrTRUE if random address, FALSE if public.
addrBluetooth device address.
Returns
TRUE if successful, FALSE if address not in the list.

Removes the given address from the white list stored in the BB.

Note
No resource synchronization is required to modify the white list resource as the LL modifies the white list only when advertising events are disabled.
void BbBleWhiteListRemoveAnonymous ( void  )

Remove anonymous device from the white list.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.