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:

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)

Macros#

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.

This command returns the error SL_STATUS_BT_CTRL_CONTROLLER_BUSY if the Filter Accept List is currently used by scanning filter policy, advertising filter policy, or by initiator filter policy, i.e. initiating connection to devices on the Filter Accept List. If the list is currently in use, the application needs to first stop the operation that uses the Filter Accept List, then add a device to the Filter Accept List, and then restart the operation that uses the Filter Accept List.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 11171 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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_random_resolvable_address (0x2): Resolvable private random address

  • sl_bt_gap_random_nonresolvable_address (0x3): Non-resolvable private random 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.

This command returns the error SL_STATUS_BT_CTRL_CONTROLLER_BUSY if the Filter Accept List is currently used by scanning filter policy, advertising filter policy, or by initiator filter policy, i.e. initiating connection to devices on the Filter Accept List. If the list is currently in use, the application needs to first stop the operation that uses the Filter Accept List, then add a device to the Filter Accept List, and then restart the operation that uses the Filter Accept List.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 11204 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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.

This command returns the error SL_STATUS_BT_CTRL_CONTROLLER_BUSY if the Filter Accept List is currently used by scanning filter policy, advertising filter policy, or by initiator filter policy, i.e. initiating connection to devices on the Filter Accept List. If the list is currently in use, the application needs to first stop the operation that uses the Filter Accept List, then remove a device from the Filter Accept List, and then restart the operation that uses the Filter Accept List.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 11224 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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_random_resolvable_address (0x2): Resolvable private random address

  • sl_bt_gap_random_nonresolvable_address (0x3): Non-resolvable private random 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.

This command returns the error SL_STATUS_BT_CTRL_CONTROLLER_BUSY if the Filter Accept List is currently used by scanning filter policy, advertising filter policy, or by initiator filter policy, i.e. initiating connection to devices on the Filter Accept List. If the list is currently in use, the application needs to first stop the operation that uses the Filter Accept List, then remove a device from the Filter Accept List, and then restart the operation that uses the Filter Accept List.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 11257 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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.

This command returns the error SL_STATUS_BT_CTRL_CONTROLLER_BUSY if the Filter Accept List is currently used by scanning filter policy, advertising filter policy, or by initiator filter policy, i.e. initiating connection to devices on the Filter Accept List. If the list is currently in use, the application needs to first stop the operation that uses the Filter Accept List, and then remove all devices from the Filter Accept List.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 11275 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11143 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11144 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11145 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11146 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11147 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11148 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11149 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11150 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11151 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/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 11152 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h