General Description

This section contains LE Extended advertisement and scanning defines, structures and functions.

Note: Applications using extended and periodic mode advertising and scanning shall use only extended mode APIs cannot invoke any of the Legacy mode APIs for advertisement and scanning

Data Structures
struct	wiced_ble_ext_adv_duration_config_t
	Advertisement duration configuration for specified adv handle. More...

struct	wiced_ble_ext_scan_results_t
	Extended scan results. More...

struct	wiced_ble_ext_adv_params_t
	Parameters for extended adv. More...

struct	wiced_ble_ext_conn_cfg_phy_options_t
	Phy options for Extended Create Connection. More...

struct	wiced_ble_ext_conn_cfg_t
	Extended ADV connection configuration structure. More...

struct	wiced_ble_ext_scan_req_received_event_data_t
	scan request received event data format More...

struct	wiced_ble_biginfo_adv_report_t
	BIGInfo report. More...

struct	wiced_ble_ext_scan_phy_params_t
	structure for scan parameter per phy More...

struct	wiced_ble_ext_scan_params_t
	Configuration for extended scanning. More...

struct	wiced_ble_ext_scan_enable_params_t
	Extended scanning enable params. More...

struct	wiced_ble_ext_adv_set_terminated_event_data_t
	extended adv set terminated event data format. More...

struct	wiced_ble_cmd_cmplt_event_data_t
	Data for the command complete event. More...

struct	wiced_ble_set_padv_sync_transfer_param_event_data_t
	Set Periodic Adv Sync Transfer Param Event Data. More...

union	wiced_ble_ext_adv_event_data_t
	union of events data More...

Macros
#define	IS_BTM_BLE_EXT_EVT_COMPLETE_DATA(evt) (((evt)&BTM_BLE_EXT_EVT_DATA_STATUS) == 0)
	Complete data packet received.

#define	IS_BTM_BLE_EXT_EVT_INCOMPLETE_DATA(evt) (((evt)&BTM_BLE_EXT_EVT_DATA_STATUS) == 1)
	Incomplete data packet received, more to come.

#define	IS_BTM_BLE_EXT_EVT_TRUNCATED_DATA(evt) (((evt)&BTM_BLE_EXT_EVT_DATA_STATUS) == 2)
	Truncated data packet received, no more to come.

#define	IS_EXT_ADV_REPORT_CONNECTABLE_ADV(x) (x & (1 << 0))
	adv is connectable

#define	IS_EXT_ADV_REPORT_SCANNABLE_ADV(x) (x & (1 << 1))
	adv is scannable

#define	IS_EXT_ADV_REPORT_DIRECTED_ADV(x) (x & (1 << 2))
	directed adv

#define	IS_EXT_ADV_REPORT_SCAN_RSP(x) (x & (1 << 3))
	scan response

#define	IS_EXT_ADV_REPORT_LEGACY_ADV(x) (x & (1 << 4))
	legacy adv

#define	IS_EXT_ADV_REPORT_DATA_STATUS_INCOMPLETE(x) (x & (1 << 5))
	adv data incomplete, more data to come

#define	IS_EXT_ADV_REPORT_DATA_STATUS_TRUNCATED(x) (x & (2 << 5))
	Incomplete, data truncated, no more to come.

Typedefs
typedef uint16_t	wiced_ble_ext_adv_evt_type_mask_t
	Extended adv report event type.

typedef uint8_t	wiced_ble_ext_adv_phy_mask_t
	LE phy mask to be used for extended advertisement.

typedef uint16_t	wiced_ble_ext_adv_event_property_t
	LE extended advertisement event property for setting extended adv params.

typedef uint8_t	wiced_ble_ext_adv_scan_req_notification_setting_t
	Enable or disable notification value (see wiced_ble_ext_adv_scan_req_notification_setting_e)

typedef void()	wiced_ble_ext_scan_result_cback_t(wiced_ble_ext_scan_results_t p_scan_result, uint16_t adv_data_len, uint8_t p_adv_data)
	Callback for receiving extended scan results. More...

typedef uint8_t	wiced_ble_ext_scan_filter_duplicate_t
	Extended scan duplicate filter policy (see wiced_ble_ext_scan_filter_duplicate_e)

typedef uint8_t	wiced_ble_ext_conn_initiator_filter_policy_t
	Initiator filter policy used. More...

typedef uint8_t	wiced_ble_ext_adv_phy_options_t
	Phy adv options to be set in wiced_ble_ext_adv_set_params. More...

typedef uint16_t	wiced_ble_ext_adv_report_event_mask_t
	Bit mask to identify the type of the adv received in extended adv report. More...

typedef uint8_t	wiced_ble_ext_adv_report_count_t
	Min and Max reports (see wiced_ble_ext_adv_report_count_e)

typedef void(*	wiced_ble_ext_adv_event_cback_t) (wiced_ble_ext_adv_event_t event, wiced_ble_ext_adv_event_data_t *p_data)
	Callback wiced_ble_ext_adv_event_cback_t. More...

Enumerations
enum	{ BTM_BLE_EXT_EVT_CONNECTABLE_ADVERTISEMENT = 0x1, BTM_BLE_EXT_EVT_SCANNABLE_ADVERTISEMENT = 0x2, BTM_BLE_EXT_EVT_DIRECTED_ADVERTISEMENT = 0x4, BTM_BLE_EXT_EVT_SCAN_RESPONSE = 0x8, BTM_BLE_EXT_EVT_LEGACY_ADV_PDU = 0x10, BTM_BLE_EXT_EVT_DATA_STATUS = 0x60 }
	Extended Scan result event type. More...

enum	{ WICED_BLE_EXT_ADV_PHY_1M_BIT = (1 << 0), WICED_BLE_EXT_ADV_PHY_2M_BIT = (1 << 1), WICED_BLE_EXT_ADV_PHY_LE_CODED_BIT = (1 << 2) }
	LE PHY bit mask. More...

enum	{ WICED_BLE_EXT_ADV_EVENT_PROPERTY_CONNECTABLE_ADV = (1 << 0), WICED_BLE_EXT_ADV_EVENT_PROPERTY_SCANNABLE_ADV = (1 << 1), WICED_BLE_EXT_ADV_EVENT_PROPERTY_DIRECTED_ADV = (1 << 2), WICED_BLE_EXT_ADV_EVENT_PROPERTY_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV = (1 << 3), WICED_BLE_EXT_ADV_EVENT_PROPERTY_LEGACY_ADV = (1 << 4), WICED_BLE_EXT_ADV_EVENT_PROPERTY_ANONYMOUS_ADV = (1 << 5), WICED_BLE_EXT_ADV_EVENT_PROPERTY_INCLUDE_TX_POWER = (1 << 6) }
	Advertising event properties: Describes the type of advertising event that is being configured and its basic properties. More...

enum	{ WICED_BLE_EXT_ADV_HANDLE_MIN = 0x00, WICED_BLE_EXT_ADV_HANDLE_MAX = 0xef }
	Advertisement set handle to identify adv set b/n host and controller. More...

enum	wiced_ble_ext_adv_scan_req_notification_setting_e { WICED_BLE_EXT_ADV_SCAN_REQ_NOTIFY_DISABLE = 0x00, WICED_BLE_EXT_ADV_SCAN_REQ_NOTIFY_ENABLE = 0x01 }
	Value to configure to receive scan request recived notification. More...

enum	wiced_ble_ext_scan_filter_duplicate_e { WICED_BLE_EXT_SCAN_FILTER_DUPLICATE_DISABLE, WICED_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE, WICED_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE_RESET_ON_SCAN_PERIOD }
	Extended scan duplicate filter policy. More...

enum	wiced_ble_ext_conn_initiator_filter_policy_e { WICED_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS = 0, WICED_BT_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS = WICED_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS, WICED_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS = 1, WICED_BT_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS = WICED_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS }
	Initiator filter policy enums used in extended create connection command. More...

enum	wiced_ble_ext_scanning_filter_policy_e { WICED_BLE_EXT_SCAN_BASIC_UNFILTERED_SP = WICED_BLE_SCAN_BASIC_UNFILTERED_SP, WICED_BLE_EXT_SCAN_BASIC_FILTERED_SP = WICED_BLE_SCAN_BASIC_FILTERED_SP, WICED_BLE_EXT_SCAN_EXTENDED_UNFILTERED_SP = WICED_BLE_SCAN_EXTENDED_UNFILTERED_SP, WICED_BLE_EXT_SCAN_EXTENDED_FILTERED_SP = WICED_BLE_SCAN_EXTENDED_FILTERED_SP }
	Scanning filter policy enums used in set extended scan parameters command. More...

enum	wiced_ble_ext_adv_phy_options_e { WICED_BLE_EXT_ADV_PHY_OPTIONS_NO_PREFERENCE = 0, WICED_BLE_EXT_ADV_PHY_OPTIONS_PREFER_S2 = 1, WICED_BLE_EXT_ADV_PHY_OPTIONS_PREFER_S8 = 2, WICED_BLE_EXT_ADV_PHY_OPTIONS_REQUIRE_S2 = 3, WICED_BLE_EXT_ADV_PHY_OPTIONS_REQUIRE_S8 = 4 }
	Phy adv options to be set in wiced_ble_ext_adv_set_params. More...

enum	wiced_ble_ext_adv_report_count_e { ADV_REP_EVT_COUNT_MIN = 1, ADV_REP_EVT_COUNT_MAX = 10 }
	Min and Max possible number of reports in LE extended adv report event. More...

enum	wiced_ble_ext_adv_event_t { WICED_BLE_ADV_SET_TERMINATED_EVENT, WICED_BT_BLE_ADV_SET_TERMINATED_EVENT = WICED_BLE_ADV_SET_TERMINATED_EVENT, WICED_BLE_SCAN_REQUEST_RECEIVED_EVENT, WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT = WICED_BLE_SCAN_REQUEST_RECEIVED_EVENT, WICED_BLE_BIGINFO_ADV_REPORT_EVENT, WICED_BT_BLE_BIGINFO_ADV_REPORT_EVENT = WICED_BLE_BIGINFO_ADV_REPORT_EVENT, WICED_BLE_EXT_COMMAND_CMPLT_EVENT, WICED_BLE_PERIODIC_ADV_SYNC_ESTABLISHED_EVENT, WICED_BLE_PERIODIC_ADV_REPORT_EVENT, WICED_BLE_PERIODIC_ADV_SYNC_LOST_EVENT, WICED_BLE_PERIODIC_ADV_SYNC_TRANSFER_EVENT, WICED_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT, WICED_BT_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT = WICED_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT, WICED_BLE_PAWR_RSP_REPORT_EVENT, WICED_BT_BLE_PAWR_RSP_REPORT_EVENT = WICED_BLE_PAWR_RSP_REPORT_EVENT, WICED_BLE_SET_PERIODIC_ADV_SYNC_TRANSFER_PARAM_EVENT }
	ADV extension events to the application. More...

Functions
wiced_bool_t	wiced_ble_ext_adv_support (void)
	Check if the local Bluetooth controller supports extended advertising. More...

uint8_t	wiced_ble_ext_adv_set_max_adv_handles (uint8_t num_adv_sets)
	Create extended adv sets. More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_set_params (wiced_ble_ext_adv_handle_t adv_handle, const wiced_ble_ext_adv_params_t *p_params)
	Sends the HCI command to set the parameters for extended advertisement. More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_set_random_address (wiced_ble_ext_adv_handle_t adv_handle, wiced_bt_device_address_t random_addr)
	Sends HCI command to set the random address for an adv set. More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_set_adv_data (wiced_ble_ext_adv_handle_t adv_handle, uint16_t data_len, uint8_t *p_data)
	Sends HCI command to write the extended adv data. More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_set_scan_rsp_data (wiced_ble_ext_adv_handle_t adv_handle, uint16_t data_len, uint8_t *p_data)
	Sends HCI command to write the extended scan rsp data. More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_enable (uint8_t enable, uint8_t num_sets, wiced_ble_ext_adv_duration_config_t *p_dur)
	Sends the HCI command to enable/disable extended advertisements. More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_remove_adv_set (wiced_ble_ext_adv_handle_t adv_handle)
	Sends the HCI command to remove an extended advertisement set (which is currently not advertising) More...

wiced_bt_dev_status_t	wiced_ble_ext_adv_clear_adv_sets (void)
	Sends the HCI command to remove all extended advertisement sets which are currently not advertising. More...

wiced_bt_dev_status_t	wiced_ble_ext_scan_register_cb (wiced_ble_ext_scan_result_cback_t *p_ext_scan_cback)
	Register the extended scan callback to receive the advertisement reports. More...

wiced_bt_dev_status_t	wiced_ble_ext_scan_configure_reassembly (uint16_t max_ext_adv_len, uint16_t max_ext_scan_partial_pkt_q_count)
	Application may enable reassembly of incoming partial advertisement data segments with this API. More...

wiced_bt_dev_status_t	wiced_ble_ext_scan_set_params (const wiced_ble_ext_scan_params_t *p_scp)
	Set extended scanning parameters. More...

wiced_bt_dev_status_t	wiced_ble_ext_scan_enable (wiced_bool_t enable, const wiced_ble_ext_scan_enable_params_t *p_sce)
	Start extended scanning. More...

wiced_bt_dev_status_t	wiced_ble_ext_create_connection (wiced_ble_ext_conn_cfg_t *p_ext_conn_cfg)
	Creates a connection using extended HCI commands. More...

wiced_bt_dev_status_t	wiced_ble_cancel_connection (void)
	Cancel a ble connection. More...

void	wiced_ble_ext_adv_register_cback (wiced_ble_ext_adv_event_cback_t p_app_adv_ext_event_cb)
	Register an application callback function to receive extended, periodic advertising events and PAWR command failed status event. More...

wiced_bt_dev_status_t	wiced_ble_ext_read_adv_data_len (void)
	Read the maximum length of data supported by the Controller for use as advertisement data or scan response data in an advertising event or as periodic advertisement data. More...

Typedef Documentation

◆ wiced_ble_ext_scan_result_cback_t

typedef void() wiced_ble_ext_scan_result_cback_t(wiced_ble_ext_scan_results_t *p_scan_result, uint16_t adv_data_len, uint8_t *p_adv_data)

Callback for receiving extended scan results.

Extended Scan result callback (from calling wiced_ble_ext_scan_enable)

Parameters

p_scan_result	: scan result data (NULL indicates end of scanning)
adv_data_len	: length of the pointer pointed to by `p_adv_data`
p_adv_data	: Advertisement data (parse using wiced_ble_adv_data_search)

Returns: void

◆ wiced_ble_ext_conn_initiator_filter_policy_t

typedef uint8_t wiced_ble_ext_conn_initiator_filter_policy_t

Initiator filter policy used.

(see wiced_ble_ext_conn_initiator_filter_policy_e)

◆ wiced_ble_ext_adv_phy_options_t

typedef uint8_t wiced_ble_ext_adv_phy_options_t

Phy adv options to be set in wiced_ble_ext_adv_set_params.

(see wiced_ble_ext_adv_phy_options_e)

◆ wiced_ble_ext_adv_report_event_mask_t

typedef uint16_t wiced_ble_ext_adv_report_event_mask_t

Bit mask to identify the type of the adv received in extended adv report.

(see wiced_ble_ext_scan_results_t::ext_evt_type field )

◆ wiced_ble_ext_adv_event_cback_t

typedef void(* wiced_ble_ext_adv_event_cback_t) (wiced_ble_ext_adv_event_t event, wiced_ble_ext_adv_event_data_t *p_data)

Callback wiced_ble_ext_adv_event_cback_t.

Adv extension command status, command complete event and LE adv extension meta event callback

Parameters

event	: Event type (see wiced_ble_periodic_event_t)
p_data	: Event data (see wiced_ble_ext_adv_event_data_t)

Returns: void

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Extended Scan result event type.

Enumerator
BTM_BLE_EXT_EVT_CONNECTABLE_ADVERTISEMENT	Connectable adv report.
BTM_BLE_EXT_EVT_SCANNABLE_ADVERTISEMENT	Scannable adv report.
BTM_BLE_EXT_EVT_DIRECTED_ADVERTISEMENT	Directed adv report.
BTM_BLE_EXT_EVT_SCAN_RESPONSE	Scan response.
BTM_BLE_EXT_EVT_LEGACY_ADV_PDU	Legacy PDU adv report.
BTM_BLE_EXT_EVT_DATA_STATUS	Extended adv report data status.

◆ anonymous enum

anonymous enum

LE PHY bit mask.

Enumerator
WICED_BLE_EXT_ADV_PHY_1M_BIT	Bit mask to specify for LE1M PHY.
WICED_BLE_EXT_ADV_PHY_2M_BIT	Bit mask to specify for LE2M PHY.
WICED_BLE_EXT_ADV_PHY_LE_CODED_BIT	Bit mask to specify for LE coded PHY.

◆ anonymous enum

anonymous enum

Advertising event properties: Describes the type of advertising event that is being configured and its basic properties.

Enumerator
WICED_BLE_EXT_ADV_EVENT_PROPERTY_CONNECTABLE_ADV	Connectable ADV.
WICED_BLE_EXT_ADV_EVENT_PROPERTY_SCANNABLE_ADV	Scannable ADV.
WICED_BLE_EXT_ADV_EVENT_PROPERTY_DIRECTED_ADV	Low duty cycle directed advertisement.
WICED_BLE_EXT_ADV_EVENT_PROPERTY_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV	3.75 ms Adv Interval, only valid in legacy ADV
WICED_BLE_EXT_ADV_EVENT_PROPERTY_LEGACY_ADV	Legacy Advertisement. Adv data cannot be more than 31 bytes.
WICED_BLE_EXT_ADV_EVENT_PROPERTY_ANONYMOUS_ADV	Omits advertisers address from all PDUs.
WICED_BLE_EXT_ADV_EVENT_PROPERTY_INCLUDE_TX_POWER	Include Tx power in ext ADV pdus.

◆ anonymous enum

anonymous enum

Advertisement set handle to identify adv set b/n host and controller.

Enumerator
WICED_BLE_EXT_ADV_HANDLE_MIN	min advertisement set handle value
WICED_BLE_EXT_ADV_HANDLE_MAX	max advertisement set handle value

◆ wiced_ble_ext_adv_scan_req_notification_setting_e

enum wiced_ble_ext_adv_scan_req_notification_setting_e

Value to configure to receive scan request recived notification.

Enumerator
WICED_BLE_EXT_ADV_SCAN_REQ_NOTIFY_DISABLE	Do not send Notification on scan request.
WICED_BLE_EXT_ADV_SCAN_REQ_NOTIFY_ENABLE	Send Notification on scan request.

◆ wiced_ble_ext_scan_filter_duplicate_e

enum wiced_ble_ext_scan_filter_duplicate_e

Extended scan duplicate filter policy.

Enumerator

WICED_BLE_EXT_SCAN_FILTER_DUPLICATE_DISABLE

send all advertisements received from advertisers

WICED_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE

duplicate advertisements should not be sent until scan disabled

WICED_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE_RESET_ON_SCAN_PERIOD

filter duplicate adv during a single scan duration.

Period should be non zero on using this option

◆ wiced_ble_ext_conn_initiator_filter_policy_e

enum wiced_ble_ext_conn_initiator_filter_policy_e

Initiator filter policy enums used in extended create connection command.

Enumerator
WICED_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS	Filter Accept List is not used to determine which advertiser to connect to. Peer_Address_Type and Peer_Address shall be used
WICED_BT_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS	Attention use WICED_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS
WICED_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS	Filter Accept List is used to determine which advertiser to connect to. Peer_Address_Type and Peer_Address shall be ignored.
WICED_BT_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS	Attention use WICED_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS

◆ wiced_ble_ext_scanning_filter_policy_e

enum wiced_ble_ext_scanning_filter_policy_e

Scanning filter policy enums used in set extended scan parameters command.

Enumerator
WICED_BLE_EXT_SCAN_BASIC_UNFILTERED_SP	Basic unfiltered scanning policy.
WICED_BLE_EXT_SCAN_BASIC_FILTERED_SP	Basic filtered scanning policy.
WICED_BLE_EXT_SCAN_EXTENDED_UNFILTERED_SP	Extended unfiltered scanning policy.
WICED_BLE_EXT_SCAN_EXTENDED_FILTERED_SP	Extended filtered scanning policy.

◆ wiced_ble_ext_adv_phy_options_e

enum wiced_ble_ext_adv_phy_options_e

Phy adv options to be set in wiced_ble_ext_adv_set_params.

Enumerator
WICED_BLE_EXT_ADV_PHY_OPTIONS_NO_PREFERENCE	The Host has no preferred or required coding when transmitting on the LE Coded PHY.
WICED_BLE_EXT_ADV_PHY_OPTIONS_PREFER_S2	The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY.
WICED_BLE_EXT_ADV_PHY_OPTIONS_PREFER_S8	The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY.
WICED_BLE_EXT_ADV_PHY_OPTIONS_REQUIRE_S2	The Host requires that S=2 coding be used when transmitting on the LE Coded PHY.
WICED_BLE_EXT_ADV_PHY_OPTIONS_REQUIRE_S8	The Host requires that S=8 coding be used when transmitting on the LE Coded PHY.

◆ wiced_ble_ext_adv_report_count_e

enum wiced_ble_ext_adv_report_count_e

Min and Max possible number of reports in LE extended adv report event.

Enumerator
ADV_REP_EVT_COUNT_MIN	min number of reports in LE extended adv report event
ADV_REP_EVT_COUNT_MAX	max number of reports in LE extended adv report event

◆ wiced_ble_ext_adv_event_t

enum wiced_ble_ext_adv_event_t

ADV extension events to the application.

Enumerator
WICED_BLE_ADV_SET_TERMINATED_EVENT	Advertising set terminated because either connection being created or adv timeout. wiced_ble_ext_adv_set_terminated_event_data_t
WICED_BT_BLE_ADV_SET_TERMINATED_EVENT	Attention use WICED_BLE_ADV_SET_TERMINATED_EVENT
WICED_BLE_SCAN_REQUEST_RECEIVED_EVENT	scan request received event. wiced_ble_ext_scan_req_received_event_data_t
WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT	Attention use WICED_BLE_SCAN_REQUEST_RECEIVED_EVENT
WICED_BLE_BIGINFO_ADV_REPORT_EVENT	BIGInfo adv report event. wiced_ble_biginfo_adv_report_t
WICED_BT_BLE_BIGINFO_ADV_REPORT_EVENT	Attention use WICED_BLE_BIGINFO_ADV_REPORT_EVENT
WICED_BLE_EXT_COMMAND_CMPLT_EVENT	command complete Event. wiced_ble_cmd_cmplt_event_data_t
WICED_BLE_PERIODIC_ADV_SYNC_ESTABLISHED_EVENT	Sync established to periodic advertiser's periodic advertisement. wiced_ble_padv_sync_established_event_data_t
WICED_BLE_PERIODIC_ADV_REPORT_EVENT	Periodic adv report. wiced_ble_padv_report_event_data_t
WICED_BLE_PERIODIC_ADV_SYNC_LOST_EVENT	Periodic sync lost event. wiced_ble_padv_sync_handle_t
WICED_BLE_PERIODIC_ADV_SYNC_TRANSFER_EVENT	Periodic Adv Sync Transfer Event. wiced_ble_padv_sync_transfer_event_data_t
WICED_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT	PAWR event on advertiser to request for subevent data wiced_ble_padv_subevent_data_req_event_data_t.
WICED_BT_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT	Attention use WICED_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT
WICED_BLE_PAWR_RSP_REPORT_EVENT	PAWR event on advertiser to report the subevent response data wiced_ble_padv_rsp_report_event_data_t.
WICED_BT_BLE_PAWR_RSP_REPORT_EVENT	Attention use WICED_BLE_PAWR_RSP_REPORT_EVENT
WICED_BLE_SET_PERIODIC_ADV_SYNC_TRANSFER_PARAM_EVENT	Set Periodic Adv Sync Transfer param Event. wiced_ble_set_padv_sync_transfer_param_event_data_t

Function Documentation

◆ wiced_ble_ext_adv_support()

wiced_bool_t wiced_ble_ext_adv_support ( void )

Check if the local Bluetooth controller supports extended advertising.

Returns: wiced_bool_t

◆ wiced_ble_ext_adv_set_max_adv_handles()

uint8_t wiced_ble_ext_adv_set_max_adv_handles ( uint8_t num_adv_sets )

Create extended adv sets.

Note: By default max adv sets supported is set to 1. Applications using multiple adv extended sets/handles need to invoke this API prior to invoking wiced_ble_ext_adv_set_random_address, wiced_ble_ext_adv_set_params

Returns: Number of extended adv sets created. A successful invocation of this API returns num_adv_sets

◆ wiced_ble_ext_adv_set_params()

wiced_bt_dev_status_t wiced_ble_ext_adv_set_params	(	wiced_ble_ext_adv_handle_t	adv_handle,
		const wiced_ble_ext_adv_params_t *	p_params
	)

Sends the HCI command to set the parameters for extended advertisement.

Parameters

[in]	adv_handle	Advertisement set handle
[in]	p_params	Extended adv parameters

Returns: wiced_bt_dev_status_t

WICED_BT_SUCCESS : If all extended adv params are set successfully
WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_PENDING : If command queued to send down

◆ wiced_ble_ext_adv_set_random_address()

wiced_bt_dev_status_t wiced_ble_ext_adv_set_random_address	(	wiced_ble_ext_adv_handle_t	adv_handle,
		wiced_bt_device_address_t	random_addr
	)

Sends HCI command to set the random address for an adv set.

Parameters

[in]	adv_handle	- handle of the advertising set
[in]	random_addr	- random address to use for this set

Returns: wiced_bt_dev_status_t

WICED_BT_SUCCESS : If random addr is set successfully
WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_PENDING : If command queued to send down

◆ wiced_ble_ext_adv_set_adv_data()

wiced_bt_dev_status_t wiced_ble_ext_adv_set_adv_data	(	wiced_ble_ext_adv_handle_t	adv_handle,
		uint16_t	data_len,
		uint8_t *	p_data
	)

Sends HCI command to write the extended adv data.

Note: This API allows sending data formatted with wiced_ble_adv_data_build.; This API cannot be used for advertising sets with event_properties that do not support advertising with data viz., WICED_BLE_EXT_ADV_EVENT_PROPERTY_DIRECTED_ADV, WICED_BLE_EXT_ADV_EVENT_PROPERTY_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV

Parameters

[in]	adv_handle	- handle of the advertising set
[in]	data_len	- length of the adv data to use for this set
[in]	p_data	- pointer to the adv data to use for this set

Returns: wiced_bt_dev_status_t WICED_BT_SUCCESS : If all extended adv data set successfully
WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_PENDING : If command queued to send down

◆ wiced_ble_ext_adv_set_scan_rsp_data()

wiced_bt_dev_status_t wiced_ble_ext_adv_set_scan_rsp_data	(	wiced_ble_ext_adv_handle_t	adv_handle,
		uint16_t	data_len,
		uint8_t *	p_data
	)

Sends HCI command to write the extended scan rsp data.

Parameters

[in]	adv_handle	- handle of the advertising set
[in]	data_len	- length of the scan response data to use for this set
[in]	p_data	- pointer to the scan response data to use for this set

Returns: wiced_bt_dev_status_t

WICED_BT_SUCCESS : If all extended scan response data set successfully
WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_PENDING : If command queued to send down

◆ wiced_ble_ext_adv_enable()

wiced_bt_dev_status_t wiced_ble_ext_adv_enable	(	uint8_t	enable,
		uint8_t	num_sets,
		wiced_ble_ext_adv_duration_config_t *	p_dur
	)

Sends the HCI command to enable/disable extended advertisements.

Parameters

[in]	enable	- true to enable, false to disable
[in]	num_sets	- number of sets to enable, unused if disabling
[in]	p_dur	- pointer to adv handle(s) and duration configuration

Returns: wiced_bt_dev_status_t

WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_adv_remove_adv_set()

wiced_bt_dev_status_t wiced_ble_ext_adv_remove_adv_set ( wiced_ble_ext_adv_handle_t adv_handle )

Sends the HCI command to remove an extended advertisement set (which is currently not advertising)

Parameters

[in] adv_handle - handle to advertisement set

Returns: wiced_bt_dev_status_t

WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_adv_clear_adv_sets()

wiced_bt_dev_status_t wiced_ble_ext_adv_clear_adv_sets ( void )

Sends the HCI command to remove all extended advertisement sets which are currently not advertising.

Returns: wiced_bt_dev_status_t

WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successfuly

◆ wiced_ble_ext_scan_register_cb()

wiced_bt_dev_status_t wiced_ble_ext_scan_register_cb ( wiced_ble_ext_scan_result_cback_t * p_ext_scan_cback )

Register the extended scan callback to receive the advertisement reports.

Parameters

[in] p_ext_scan_cback - pointer to scan result callback

Returns: wiced_bt_dev_status_t

WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_scan_configure_reassembly()

wiced_bt_dev_status_t wiced_ble_ext_scan_configure_reassembly	(	uint16_t	max_ext_adv_len,
		uint16_t	max_ext_scan_partial_pkt_q_count
	)

Application may enable reassembly of incoming partial advertisement data segments with this API.

The stack will reassemble the incoming chained ADV segments upto max_ext_adv_len.

Note: Inorder to use the reassembly feature for extended adv reports, the application is required to create a default heap using wiced_bt_create_heap. The heap should be sized greater than max_ext_adv_len * max_ext_scan_partial_pkt_q_count. BTSTACK manages allocation and free of the reassembled buffers from this heap.

Parameters

[in]	max_ext_adv_len	- max adv length expected. The stack code will attempt to reassemble adv data reports upto this length
[in]	max_ext_scan_partial_pkt_q_count	- max queue size to store the partial packets of the advertisement chain.

Returns: wiced_bt_dev_status_t

WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_scan_set_params()

wiced_bt_dev_status_t wiced_ble_ext_scan_set_params ( const wiced_ble_ext_scan_params_t * p_scp )

Set extended scanning parameters.

Parameters

[in] p_scp pointer to scan configuration

Returns: wiced_bt_dev_status_t

WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_scan_enable()

wiced_bt_dev_status_t wiced_ble_ext_scan_enable	(	wiced_bool_t	enable,
		const wiced_ble_ext_scan_enable_params_t *	p_sce
	)

Start extended scanning.

Parameters

[in]	enable	Set 1 to start/enable scanning, 0 to stop/disable
[in]	p_sce	Scanning enable parameters

Returns: wiced_bt_dev_status_t

WICED_BT_ILLEGAL_VALUE : If paramer is wrong
WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_create_connection()

wiced_bt_dev_status_t wiced_ble_ext_create_connection ( wiced_ble_ext_conn_cfg_t * p_ext_conn_cfg )

Creates a connection using extended HCI commands.

Parameters

[in] p_ext_conn_cfg - pointer to connection configuration

Note: The adv_handle and sub_event parameters of connection configuration shall be set to 0xFF if p_ext_conn_cfg->adv_handle and p_ext_conn_cfg->sub_event parameters are not to be used

Returns: wiced_bt_dev_status_t

WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_cancel_connection()

wiced_bt_dev_status_t wiced_ble_cancel_connection ( void )

Cancel a ble connection.

Returns: wiced_bt_dev_status_t

WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_adv_register_cback()

void wiced_ble_ext_adv_register_cback ( wiced_ble_ext_adv_event_cback_t p_app_adv_ext_event_cb )

Register an application callback function to receive extended, periodic advertising events and PAWR command failed status event.

Parameters

[in] p_app_adv_ext_event_cb - pointer to function to receive extended adv events.

Returns: wiced_bt_dev_status_t WICED_BT_UNSUPPORTED : If command not supported
WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_PENDING : If command queued to send down
WICED_BT_SUCCESS : If successful

◆ wiced_ble_ext_read_adv_data_len()

wiced_bt_dev_status_t wiced_ble_ext_read_adv_data_len ( void )

Read the maximum length of data supported by the Controller for use as advertisement data or scan response data in an advertising event or as periodic advertisement data.

Note: Application receives BTM_BLE_READ_MAX_ADV_DATA_LEN_EVENT to notify Maximum Advertising data length

Returns: wiced_bt_dev_status_t WICED_BT_NO_RESOURCES : If no memory to issue the command
WICED_BT_SUCCESS : If successful

General Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Typedef Documentation

◆ wiced_ble_ext_scan_result_cback_t

◆ wiced_ble_ext_conn_initiator_filter_policy_t

◆ wiced_ble_ext_adv_phy_options_t

◆ wiced_ble_ext_adv_report_event_mask_t

◆ wiced_ble_ext_adv_event_cback_t

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ wiced_ble_ext_adv_scan_req_notification_setting_e

◆ wiced_ble_ext_scan_filter_duplicate_e

◆ wiced_ble_ext_conn_initiator_filter_policy_e

◆ wiced_ble_ext_scanning_filter_policy_e

◆ wiced_ble_ext_adv_phy_options_e

◆ wiced_ble_ext_adv_report_count_e

◆ wiced_ble_ext_adv_event_t

Function Documentation

◆ wiced_ble_ext_adv_support()

◆ wiced_ble_ext_adv_set_max_adv_handles()

◆ wiced_ble_ext_adv_set_params()

◆ wiced_ble_ext_adv_set_random_address()

◆ wiced_ble_ext_adv_set_adv_data()

◆ wiced_ble_ext_adv_set_scan_rsp_data()

◆ wiced_ble_ext_adv_enable()

◆ wiced_ble_ext_adv_remove_adv_set()

◆ wiced_ble_ext_adv_clear_adv_sets()

◆ wiced_ble_ext_scan_register_cb()

◆ wiced_ble_ext_scan_configure_reassembly()

◆ wiced_ble_ext_scan_set_params()

◆ wiced_ble_ext_scan_enable()

◆ wiced_ble_ext_create_connection()

◆ wiced_ble_cancel_connection()

◆ wiced_ble_ext_adv_register_cback()

◆ wiced_ble_ext_read_adv_data_len()