Filter Accept List#

Filter Accept List.

Provides support for adding and removing devices from the Filter Accept List in the Bluetooth controller.

The Filter Accept List allows filtering transmissions from other Bluetooth devices so that the local device only receives/accepts transmissions from the devices that it's interested in or wants to communicate with. Operations that support filtering provide a means to control how the Filter Accept List is used:

For advertising, use the command sl_bt_advertiser_configure and flags bits SL_BT_ADVERTISER_USE_FILTER_FOR_SCAN_REQUESTS and SL_BT_ADVERTISER_USE_FILTER_FOR_CONNECTION_REQUESTS to control the advertising filter policy
For scanning, use the command sl_bt_scanner_set_parameters_and_filter to control the scanning filter policy

Functions#

sl_status_t

sl_bt_accept_list_add_device_by_bonding(uint32_t bonding)

sl_status_t

sl_bt_accept_list_add_device_by_address(bd_addr address, uint8_t address_type)

sl_status_t

sl_bt_accept_list_remove_device_by_bonding(uint32_t bonding)

sl_status_t

sl_bt_accept_list_remove_device_by_address(bd_addr address, uint8_t address_type)

sl_status_t

sl_bt_accept_list_remove_all_devices()

Macros#

#define

sl_bt_cmd_accept_list_add_device_by_bonding_id 0x005e0020

#define

sl_bt_cmd_accept_list_add_device_by_address_id 0x015e0020

#define

sl_bt_cmd_accept_list_remove_device_by_bonding_id 0x025e0020

#define

sl_bt_cmd_accept_list_remove_device_by_address_id 0x035e0020

#define

sl_bt_cmd_accept_list_remove_all_devices_id 0x045e0020

#define

sl_bt_rsp_accept_list_add_device_by_bonding_id 0x005e0020

#define

sl_bt_rsp_accept_list_add_device_by_address_id 0x015e0020

#define

sl_bt_rsp_accept_list_remove_device_by_bonding_id 0x025e0020

#define

sl_bt_rsp_accept_list_remove_device_by_address_id 0x035e0020

#define

sl_bt_rsp_accept_list_remove_all_devices_id 0x045e0020

Function Documentation#

sl_bt_accept_list_add_device_by_bonding#

sl_status_t sl_bt_accept_list_add_device_by_bonding (uint32_t bonding)

Parameters

[in]

bonding

The bonding handle

Add a device to the Filter Accept List based on its bonding handle.

Returns

SL_STATUS_OK if successful. Error code otherwise.

Definition at line 11869 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_accept_list_add_device_by_address#

sl_status_t sl_bt_accept_list_add_device_by_address (bd_addr address, uint8_t address_type)

Parameters

[in]

address

Bluetooth address of the peer device

[in]

address_type

Enum sl_bt_gap_address_type_t. The peer device address type. Values:

sl_bt_gap_public_address (0x0): Public device address
sl_bt_gap_static_address (0x1): Static device address
sl_bt_gap_anonymous_address (0xff): Anonymous address. A Filter Accept List entry with this type matches all advertisements sent with no address.

Add a device to the Filter Accept List based on its identity address.

Use the special address type sl_bt_gap_anonymous_address to add an entry that matches all advertisements sent with no address.

Returns

SL_STATUS_OK if successful. Error code otherwise.

Definition at line 11890 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_accept_list_remove_device_by_bonding#

sl_status_t sl_bt_accept_list_remove_device_by_bonding (uint32_t bonding)

Parameters

[in]

bonding

The bonding handle

Remove a device from the Filter Accept List based on its bonding handle.

Returns

SL_STATUS_OK if successful. Error code otherwise.

Definition at line 11902 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_accept_list_remove_device_by_address#

sl_status_t sl_bt_accept_list_remove_device_by_address (bd_addr address, uint8_t address_type)

Parameters

[in]

address

Bluetooth address of the peer device

[in]

address_type

Enum sl_bt_gap_address_type_t. The peer device address type. Values:

sl_bt_gap_public_address (0x0): Public device address
sl_bt_gap_static_address (0x1): Static device address
sl_bt_gap_anonymous_address (0xff): Anonymous address. A Filter Accept List entry with this type matches all advertisements sent with no address.

Remove a device from the Filter Accept List based on its identity address.

Use the special address type sl_bt_gap_anonymous_address to remove an entry that matches all advertisements sent with no address.

Returns

SL_STATUS_OK if successful. Error code otherwise.

Definition at line 11923 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_accept_list_remove_all_devices#

sl_status_t sl_bt_accept_list_remove_all_devices ()

Remove all devices from the Filter Accept List.

Returns

SL_STATUS_OK if successful. Error code otherwise.

Definition at line 11934 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

Macro Definition Documentation#

sl_bt_cmd_accept_list_add_device_by_bonding_id#

#define sl_bt_cmd_accept_list_add_device_by_bonding_id

Value:

0x005e0020

Definition at line 11849 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_accept_list_add_device_by_address_id#

#define sl_bt_cmd_accept_list_add_device_by_address_id

Value:

0x015e0020

Definition at line 11850 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_accept_list_remove_device_by_bonding_id#

#define sl_bt_cmd_accept_list_remove_device_by_bonding_id

Value:

0x025e0020

Definition at line 11851 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_accept_list_remove_device_by_address_id#

#define sl_bt_cmd_accept_list_remove_device_by_address_id

Value:

0x035e0020

Definition at line 11852 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_accept_list_remove_all_devices_id#

#define sl_bt_cmd_accept_list_remove_all_devices_id

Value:

0x045e0020

Definition at line 11853 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_accept_list_add_device_by_bonding_id#

#define sl_bt_rsp_accept_list_add_device_by_bonding_id

Value:

0x005e0020

Definition at line 11854 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_accept_list_add_device_by_address_id#

#define sl_bt_rsp_accept_list_add_device_by_address_id

Value:

0x015e0020

Definition at line 11855 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_accept_list_remove_device_by_bonding_id#

#define sl_bt_rsp_accept_list_remove_device_by_bonding_id

Value:

0x025e0020

Definition at line 11856 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_accept_list_remove_device_by_address_id#

#define sl_bt_rsp_accept_list_remove_device_by_address_id

Value:

0x035e0020

Definition at line 11857 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_accept_list_remove_all_devices_id#

#define sl_bt_rsp_accept_list_remove_all_devices_id

Value:

0x045e0020

Definition at line 11858 of file /mnt/raid/workspaces/ws.0zwF9W456/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h