This section consists of several management entities:
API Reference | |
Advertisement & Scan | |
This section provides functions for LE advertisement and LE scan operations. | |
Connection and Filter Accept List | |
This section provides functions for LE connection related and Filter Accept List operations. | |
Phy | |
This section provides functionality to read and update PHY. | |
MultiAdv | |
This section describes Multiple Advertisement API, using this interface application can enable more than one advertisement train. | |
Utilities | |
This sections provides Bluetooth utilities functions related to trace, local bda, tx power etc. | |
LE Security | |
LE Security API. | |
Data Structures | |
struct | wiced_bt_ble_advert_elem_t |
Advertisement element. More... | |
struct | wiced_bt_ble_scan_results_t |
LE inquiry result type. More... | |
struct | wiced_bt_ble_phy_preferences_t |
Host PHY preferences. More... | |
struct | wiced_bt_ble_conn_params_t |
LE connection parameteres. More... | |
struct | wiced_bt_ble_pref_conn_params_t |
LE preferred connection parameters. More... | |
struct | wiced_bt_ble_multi_adv_params_t |
LE Multi advertising parameter. More... | |
struct | wiced_bt_ble_ext_adv_duration_config_t |
Advertisement duration configuration for specified adv handle. More... | |
struct | wiced_bt_ble_key_material_t |
Encryption Data Key Material structure. More... | |
struct | wiced_bt_ble_ext_adv_params_t |
Parameters for extended adv. More... | |
struct | wiced_bt_ble_ext_conn_cfg_t |
Extended ADV connection configuration structure. More... | |
struct | wiced_bt_ble_ext_adv_report_t |
Extended advertisement report data format. More... | |
struct | wiced_bt_ble_periodic_adv_sync_established_event_data_t |
Sync extablished to periodic advertiser event data format. More... | |
struct | wiced_bt_ble_periodic_adv_report_event_data_t |
Periodic advertising report data format. More... | |
struct | wiced_bt_ble_ext_adv_set_terminated_event_data_t |
extended adv set terminated event data format. More... | |
struct | wiced_bt_ble_scan_req_received_event_data_t |
scan request received event data format More... | |
struct | wiced_bt_ble_channel_sel_algo_event_data_t |
Channel selection algorithm event data format. More... | |
struct | wiced_bt_ble_biginfo_adv_report_t |
BIGInfo report. More... | |
struct | wiced_bt_ble_periodic_adv_sync_transfer_event_data_t |
Periodic Adv Sync Transfer Received Event Data. More... | |
struct | wiced_bt_ble_pawr_sync_established_event_data_t |
Periodic Advertising with Response (PAWR) Sync Established Event Data. More... | |
struct | wiced_bt_ble_pawr_subevent_data_req_event_data_t |
Periodic Advertising with Response (PAWR) Subevent Data Request Event Data. More... | |
struct | wiced_bt_ble_pawr_rsp_report_event_data_t |
Periodic Advertising with Response (PAWR) Response Report Event Data. More... | |
struct | wiced_bt_ble_pawr_ind_report_event_data_t |
Periodic Advertising with Response (PAWR) Indication Report Event Data. More... | |
union | wiced_bt_ble_adv_ext_event_data_t |
union of events data More... | |
struct | wiced_bt_ble_ext_scan_config_t |
Configuration for extended scanning. More... | |
struct | wiced_bt_ble_pawr_subevent_ind_data_t |
Configuration for Periodic Advertising with Response (PAWR) subevent indication data which is sent by the central device at the start of each subevent. More... | |
struct | wiced_bt_ble_pawr_subevent_rsp_data_t |
Configuration for Periodic Advertising with Response (PAWR) response data. More... | |
struct | wiced_bt_ble_periodic_adv_params_t |
LE Set Periodic Advertising Parameter V2 command parameter. More... | |
struct | wiced_bt_tx_power_result_t |
TX Power Result (in response to wiced_bt_dev_read_tx_power) More... | |
struct | wiced_bt_transmit_power_range_res_buf_t |
Transmit Power Range Result Buffer. More... | |
struct | wiced_bt_set_transmit_power_range_result_t |
Transmit Power Range Result (in response to wiced_bt_set_transmit_power_range) More... | |
struct | wiced_bt_set_adv_tx_power_result_t |
TX Power Result (in response to wiced_bt_ble_set_adv_tx_power) More... | |
struct | wiced_bt_dev_vendor_specific_command_complete_params_t |
Structure returned with Vendor Specific Command complete callback. More... | |
struct | wiced_bt_public_key_t |
Public key. More... | |
struct | wiced_bt_smp_sc_local_oob_t |
Data for BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT. More... | |
struct | wiced_bt_smp_remote_oob_req_t |
data type for BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT More... | |
struct | wiced_bt_smp_sc_remote_oob_req_t |
data type for BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT More... | |
struct | wiced_bt_dev_user_keypress_t |
Pairing keypress notification (BTM_USER_KEYPRESS_NOTIFICATION_EVT event data type) More... | |
struct | wiced_bt_dev_user_key_notif_t |
Data for pairing passkey notification (BTM_USER_PASSKEY_NOTIFICATION_EVT event data type) More... | |
struct | wiced_bt_dev_br_edr_pairing_info_t |
BR/EDR pairing complete infomation. More... | |
struct | wiced_bt_dev_user_cfm_req_t |
Data for pairing confirmation request (BTM_USER_CONFIRMATION_REQUEST_EVT event data type) More... | |
struct | wiced_bt_dev_ble_pairing_info_t |
LE pairing complete infomation. More... | |
union | wiced_bt_dev_pairing_info_t |
Transport dependent pairing complete infomation. More... | |
struct | wiced_bt_dev_pairing_cplt_t |
Pairing complete notification (BTM_PAIRING_COMPLETE_EVT event data type) More... | |
struct | wiced_bt_dev_security_failed_t |
Security/authentication failure status (used by BTM_SECURITY_FAILED_EVT notication) More... | |
struct | wiced_bt_dev_security_request_t |
Security request (BTM_SECURITY_REQUEST_EVT event data type) More... | |
struct | wiced_bt_local_id_keys |
LE keys. More... | |
struct | wiced_bt_local_identity_keys_t |
LE identity key for local device (used by BTM_LE_LOCAL_IDENTITY_KEYS_UPDATE_EVT and BTM_LE_LOCAL_KEYS_REQUEST_EVT notification) More... | |
struct | wiced_bt_ble_connection_param_update_t |
LE connection parameter update event related data. More... | |
struct | wiced_bt_ble_conn_subrate_t |
LE Physical link update event related data. More... | |
struct | wiced_bt_ble_phy_update_t |
BLE Physical link update event related data. More... | |
struct | wiced_bt_ble_phy_data_length_update_t |
LE data length update event related data. More... | |
struct | wiced_bt_ble_multi_adv_response_t |
LE Multi adv VSC response data. More... | |
struct | wiced_bt_dev_enabled_t |
Device enabled (used by BTM_ENABLED_EVT) More... | |
struct | wiced_bt_dev_disabled_t |
Device disabled (used by BTM_DISABLED_EVT) More... | |
struct | wiced_bt_dev_name_and_class_t |
Remote device information (used by BTM_PIN_REQUEST_EVT, BTM_SECURITY_ABORTED_EVT) More... | |
struct | wiced_bt_power_mgmt_notification_t |
Change in power management status (used by BTM_POWER_MANAGEMENT_STATUS_EVT notication) More... | |
struct | wiced_bt_dev_encryption_status_t |
Encryption status change (used by BTM_ENCRYPTION_STATUS_EVT) More... | |
struct | wiced_bt_dev_local_oob_t |
Local OOB data BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT. More... | |
struct | wiced_bt_dev_remote_oob_t |
BTM_REMOTE_OOB_DATA_REQUEST_EVT. More... | |
struct | wiced_bt_dev_bredr_io_caps_req_t |
BR/EDR Pairing IO Capabilities (to be filled by application callback on BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT) More... | |
struct | wiced_bt_dev_ble_io_caps_req_t |
LE Pairing IO Capabilities (to be filled by application callback on BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT) More... | |
struct | wiced_bt_ble_keys_t |
Paired device LE Keys. More... | |
struct | wiced_bt_device_sec_keys_t |
Paired Device Link key data. More... | |
struct | wiced_bt_device_link_keys_t |
Paired device link key notification (used by BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT notication) More... | |
struct | wiced_bt_device_br_packet_types_t |
BR packets statistics details. More... | |
struct | wiced_bt_device_edr_packet_types_t |
EDR packets statistics types details. More... | |
union | wiced_bt_br_edr_pkt_type_stats |
BR/EDR packet types detail statistics. More... | |
struct | wiced_bt_lq_br_edr_stats |
BR/EDR link statistics. More... | |
struct | wiced_bt_lq_le_stats |
LE link statistics. More... | |
struct | wiced_bt_lq_stats_result_t |
LQ Quality Result (in response to wiced_bt_dev_lq_stats) More... | |
struct | wiced_bt_ble_device_addr_update_t |
Event on update of random device address. More... | |
union | wiced_bt_management_evt_data_t |
Structure definitions for Bluetooth Management (wiced_bt_management_cback_t) event notifications. More... | |
Macros | |
#define | BTM_BLE_LEGACY_AD_DATA_LEN 31 |
Max legacy advertisement data len. | |
#define | BTM_AFH_CHNL_MAP_SIZE HCI_AFH_CHANNEL_MAP_LEN |
AFH channel map size. | |
#define | BLE_CHANNEL_MAP_LEN 5 |
AFH Channel Map len. | |
#define | BTM_BLE_DEFAULT_ADVERT_CHNL_MAP (BTM_BLE_ADVERT_CHNL_37| BTM_BLE_ADVERT_CHNL_38| BTM_BLE_ADVERT_CHNL_39) |
default advertising channel map | |
#define | BTM_BLE_ADVERT_FILTER_DEFAULT BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN |
default advertising filter policy | |
#define | BTM_BLE_ADVERT_INTERVAL_MIN 0x0020 |
adv parameter Min value | |
#define | BTM_BLE_ADVERT_INTERVAL_MAX 0x4000 |
adv parameter Max value | |
#define | BTM_BLE_SCAN_INTERVAL_MIN 0x0004 |
Scan interval minimum value. | |
#define | BTM_BLE_SCAN_INTERVAL_MAX 0x4000 |
Scan interval miximum value. | |
#define | BTM_BLE_SCAN_WINDOW_MIN 0x0004 |
Scan window minimum value. | |
#define | BTM_BLE_SCAN_WINDOW_MAX 0x4000 |
Scan window maximum value. | |
#define | BTM_BLE_CONN_INTERVAL_MIN 0x0006 |
Connection interval minimum value. | |
#define | BTM_BLE_CONN_INTERVAL_MAX 0x0C80 |
Connection interval maximum value. | |
#define | BTM_BLE_CONN_LATENCY_MAX 500 |
Maximum Connection Latency. | |
#define | BTM_BLE_CONN_SUP_TOUT_MIN 0x000A |
Minimum Supervision Timeout. | |
#define | BTM_BLE_CONN_SUP_TOUT_MAX 0x0C80 |
Maximum Supervision Timeout. | |
#define | BTM_BLE_CONN_PARAM_UNDEF 0xffff |
use this value when a specific value not to be overwritten | |
#define | BTM_BLE_CONN_SUP_TOUT_DEF 700 |
Default Supervision Timeout. | |
#define | BTM_BLE_SCAN_FAST_INTERVAL 96 |
default scan interval 30 ~ 60 ms (use 60) = 96 *0.625 | |
#define | BTM_BLE_SCAN_FAST_WINDOW 48 |
default scan window (in .625ms slots) for background auto connections 30 ms = 48 *0.625 | |
#define | BTM_BLE_SCAN_SLOW_INTERVAL_1 2048 |
default scan interval used in reduced power cycle (background scanning) 1.28 s = 2048 *0.625 | |
#define | BTM_BLE_SCAN_SLOW_WINDOW_1 18 |
default scan window used in reduced power cycle (background scanning) 11.25 ms = 18 *0.625 | |
#define | BTM_BLE_SCAN_SLOW_INTERVAL_2 4096 |
default scan interval used in reduced power cycle (background scanning) 2.56 s = 4096 *0.625 | |
#define | BTM_BLE_SCAN_SLOW_WINDOW_2 36 |
default scan window used in reduced power cycle (background scanning) 22.5 ms = 36 *0.625 | |
#define | BTM_BLE_CONN_INTERVAL_MIN_DEF 24 |
default connection interval min recommended min: 30ms = 24 * 1.25 | |
#define | BTM_BLE_CONN_INTERVAL_MAX_DEF 40 |
default connection interval max recommended max: 50 ms = 56 * 1.25 | |
#define | BTM_BLE_CONN_PERIPHERAL_LATENCY_DEF 0 |
default Peripheral latency | |
#define | BTM_BLE_CONN_TIMEOUT_DEF 2000 |
default supervision timeout | |
#define | BTM_BLE_AUTH_SIGNATURE_SIZE 12 |
LE Signature LE data signature length 8 Bytes + 4 bytes counter. | |
#define | BTM_BLE_POLICY_REJECT_ALL 0x00 |
relevant to both | |
#define | BTM_BLE_POLICY_ALLOW_SCAN 0x01 |
relevant to advertiser | |
#define | BTM_BLE_POLICY_ALLOW_CONN 0x02 |
relevant to advertiser | |
#define | BTM_BLE_POLICY_ALLOW_ALL 0x03 |
relevant to both | |
#define | BTM_BLE_LIMITED_DISCOVERABLE_FLAG (0x01 << 0) |
Limited Discoverable. | |
#define | BTM_BLE_GENERAL_DISCOVERABLE_FLAG (0x01 << 1) |
General Discoverable. | |
#define | BTM_BLE_BREDR_NOT_SUPPORTED (0x01 << 2) |
BR/EDR Not Supported. | |
#define | BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED (0x01 << 3) |
Simultaneous LE and BR/EDR to Same Device Capable (Controller). More... | |
#define | BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED (0x01 << 4) |
Simultaneous LE and BR/EDR to Same Device Capable (Host). More... | |
#define | BTM_BLE_NON_LIMITED_DISCOVERABLE_FLAG (0x00 ) |
Non Discoverable. | |
#define | BTM_BLE_ADVERT_FLAG_MASK (BTM_BLE_LIMITED_DISCOVERABLE_FLAG | BTM_BLE_BREDR_NOT_SUPPORTED | BTM_BLE_GENERAL_DISCOVERABLE_FLAG) |
LE adverisement mask. | |
#define | BTM_BLE_LIMITED_DISCOVERABLE_MASK (BTM_BLE_LIMITED_DISCOVERABLE_FLAG ) |
LE Limited discovery mask. | |
#define | BTM_BLE_PREFER_1M_PHY 0x01 |
LE 1M PHY preference. | |
#define | BTM_BLE_PREFER_2M_PHY 0x02 |
LE 2M PHY preference. | |
#define | BTM_BLE_PREFER_LELR_PHY 0x04 |
LE LELR PHY preference. | |
#define | BTM_BLE_PREFER_NO_LELR 0x0000 |
No preferred coding. | |
#define | BTM_BLE_PREFER_LELR_S2 0x0001 |
Preferred coding is S=2, 500 kb/s. | |
#define | BTM_BLE_PREFER_LELR_S8 0x0002 |
Preferred coding is S=8, 125 kb/s. | |
#define | BTM_BLE_PREFER_LELR_512K BTM_BLE_PREFER_LELR_S2 |
#define | BTM_BLE_PREFER_LELR_125K BTM_BLE_PREFER_LELR_S8 |
#define | MULTI_ADV_TX_POWER_MIN_INDEX 0 |
Multi adv tx min power index. | |
#define | MULTI_ADV_TX_POWER_MAX_INDEX 4 |
Multi adv tx max power index. | |
#define | WICED_BT_BLE_MAX_EXT_ADV_DATA_LEN 251 |
ADV extension structures. | |
#define | IS_CONNECTABLE_ADV_REPORT(x) (x & (1 << 0)) |
adv is connectable | |
#define | IS_SCANNABLE_ADV_REPORT(x) (x & (1 << 1)) |
adv is scannable | |
#define | IS_DIRECTED_ADV_REPORT(x) (x & (1 << 2)) |
directed adv | |
#define | IS_SCAN_RSP_ADV_REPORT(x) (x & (1 << 3)) |
scan response | |
#define | IS_LEGACY_ADV_REPORT(x) (x & (1 << 4)) |
legacy adv | |
#define | IS_ADV_REPORT_DATA_STATUS_INCOMPLETE(x) (x & (1 << 5)) |
adv data incomplete, more data to come | |
#define | IS_ADV_REPORT_DATA_STATUS_TRUNCATED(x) (x & (2 << 5)) |
Incomplete, data truncated, no more to come. | |
#define | WICED_BT_MAX_PAWR_SUBEVENT_DATA_LEN 251 |
Maximum PAWR Subevent data len. | |
#define | BTM_INQ_RES_IGNORE_RSSI 0x7f |
RSSI value not supplied (ignore it) | |
#define | BTM_SCAN_PARAM_IGNORE 0 |
Passed to BTM_SetScanConfig() to ignore. | |
#define | BTM_PIN_TYPE_VARIABLE HCI_PIN_TYPE_VARIABLE |
Variable Pin Type. | |
#define | BTM_PIN_TYPE_FIXED HCI_PIN_TYPE_FIXED |
Fix Length Pin Type. | |
#define | BTM_SECURITY_KEY_DATA_LEN 132 |
Security key data length (used by wiced_bt_device_link_keys_t structure) | |
#define | BTM_SECURITY_LOCAL_KEY_DATA_LEN 65 |
Local security key data length (used by wiced_bt_local_identity_keys_t structure) | |
#define | SMP_SEC_NONE 0 |
LE Security key level. More... | |
#define | SMP_SEC_UNAUTHENTICATE (1 << 0) |
Security Key Level: key not authenticated. | |
#define | SMP_SEC_AUTHENTICATED (1 << 2) |
Security Key Level: key authenticated. | |
#define | BTM_OOB_STATE |
OOB Data status. | |
#define | BTM_OOB_REQ_TYPE |
Type of OOB data required. | |
#define | BTM_LE_KEY_TYPES |
LE Key type. | |
#define | BTM_BLE_SCAN_TYPE |
Scan duty cycle (used for BTM_BLE_SCAN_STATE_CHANGED_EVT and wiced_bt_dev_create_connection) | |
#define | BTM_BLE_KEY_TYPE_ID 1 |
Identity resolving key. | |
#define | BTM_BLE_KEY_TYPE_ER 2 |
Encryption root key. | |
#define | BTM_PM_STATUS_CODES |
Power Management status codes. | |
#define | WICED_POWER_STATE_ACTIVE BTM_PM_STS_ACTIVE |
Power Management state. More... | |
#define | WICED_POWER_STATE_SNIFF BTM_PM_STS_SNIFF |
Sniff. | |
#define | WICED_POWER_STATE_SSR BTM_PM_STS_SSR |
Sniff subrating notification. | |
#define | WICED_POWER_STATE_PENDING BTM_PM_STS_PENDING |
Pending (waiting for status from controller) | |
#define | WICED_POWER_STATE_ERROR BTM_PM_STS_ERROR |
Error (controller returned error) | |
#define | BTM_AFH_CHNL_MAP_SIZE HCI_AFH_CHANNEL_MAP_LEN |
Channel Map Length. | |
#define | BTM_MANAGEMENT_EVT |
Bluetooth Management event. | |
#define | BTM_BLE_ADVERT_MODE |
advertisement type (used when calling wiced_bt_start_advertisements) | |
#define | BTM_BLE_CONN_MODE |
scan mode used in initiating | |
Typedefs | |
typedef uint8_t | wiced_bt_ble_chnl_map_t[BLE_CHANNEL_MAP_LEN] |
LE Channel Map. | |
typedef uint8_t | wiced_bt_ble_scanner_filter_policy_t |
LE Scanner filter policy. More... | |
typedef uint8_t | wiced_bt_ble_advert_filter_policy_t |
Advertising filter policy (see wiced_bt_ble_advert_filter_policy_e) | |
typedef uint8_t | wiced_dev_ble_signature_t[BTM_BLE_AUTH_SIGNATURE_SIZE] |
Device address (see BTM_BLE_AUTH_SIGNATURE_SIZE) | |
typedef uint8_t | wiced_bt_ble_advert_type_t |
LE advertisement data type (see wiced_bt_ble_advert_type_e) | |
typedef uint8_t | wiced_bt_dev_ble_evt_type_t |
Scan result event value (see wiced_bt_dev_ble_evt_type_e) | |
typedef uint8_t | wiced_bt_ble_conn_type_t |
Connection type (see wiced_bt_ble_conn_type_e) | |
typedef uint8_t | wiced_bt_ble_sec_action_type_t |
LE security type. More... | |
typedef uint8_t | wiced_bt_ble_host_phy_preferences_t |
Host preferences on PHY. More... | |
typedef uint16_t | wiced_bt_ble_lelr_phy_preferences_t |
The PHY_options parameter is a bit field that allows the Host to specify options for LE long range PHY. More... | |
typedef int8_t | wiced_bt_ble_adv_tx_power_t |
Transmit Power in dBm ( MULTI_ADV_TX_POWER_MIN_INDEX to MULTI_ADV_TX_POWER_MAX_INDEX ) | |
typedef uint8_t | wiced_bt_ble_multi_advert_type_t |
LE advertisement type (see wiced_bt_ble_multi_advert_type_e) | |
typedef uint8_t | wiced_bt_ble_privacy_mode_t |
LE Privacy mode. More... | |
typedef uint8_t | wiced_bt_ble_multi_advert_filtering_policy_t |
LE advertisement filtering policy (see wiced_bt_ble_multi_advert_filtering_policy_e) | |
typedef void() | wiced_bt_ble_scan_result_cback_t(wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data) |
Callback wiced_bt_ble_scan_result_cback_t. More... | |
typedef void() | wiced_bt_ble_read_phy_complete_callback_t(wiced_bt_ble_phy_update_t *p_phy_result) |
Callback wiced_bt_ble_read_phy_complete_callback_t. More... | |
typedef uint8_t | wiced_bt_ble_ext_adv_phy_t |
LE phy to be used for extended advertisement. | |
typedef uint8_t | wiced_bt_ble_ext_adv_phy_mask_t |
LE phy mask to be used for extended advertisement. | |
typedef uint16_t | wiced_bt_ble_ext_adv_event_property_t |
LE extended advertisement event property. | |
typedef uint8_t | wiced_bt_ble_ext_adv_handle_t |
advertisement set handle value | |
typedef uint8_t | wiced_bt_ble_ext_adv_sid_t |
SID value. | |
typedef uint8_t | wiced_bt_ble_ext_adv_scan_req_notification_setting_t |
Enable or disable notification value (see wiced_bt_ble_ext_adv_scan_req_notification_setting_e) | |
typedef uint16_t | wiced_bt_ble_periodic_adv_prop_t |
Periodic adv property (see wiced_bt_ble_periodic_adv_prop_e) | |
typedef uint8_t | wiced_bt_ble_ext_scan_filter_duplicate_t |
Extended scan duplicate filter policy (see wiced_bt_ble_ext_scan_filter_duplicate_e) | |
typedef uint8_t | wiced_bt_ble_ext_filter_policy_t |
Filter policy used. More... | |
typedef uint8_t | wiced_bt_ble_adv_sync_options_t |
Options used in create periodic sync to periodic adv command (see wiced_bt_ble_adv_sync_options_e) | |
typedef uint8_t | wiced_bt_ble_periodic_adv_sync_transfer_mode_t |
Mode used in create periodic sync to periodic adv command (see wiced_bt_ble_periodic_adv_sync_transfer_mode_e) | |
typedef uint8_t | wiced_bt_ble_phy_adv_options_t |
Phy adv options to be set in wiced_bt_ble_set_ext_adv_params_v2. | |
typedef uint16_t | wiced_bt_ble_periodic_adv_sync_handle_t |
Sync_Handle to be used to identify the periodic advertiser. More... | |
typedef uint16_t | wiced_bt_ble_adv_report_event_mask_t |
Bit mask to identify the type of the adv received in extended adv report. More... | |
typedef uint8_t | wiced_bt_ble_ext_adv_report_count_t |
Min and Max reports (see wiced_bt_ble_ext_adv_report_count_e) | |
typedef uint8_t | wiced_bt_ble_advertiser_clock_accuracy_t |
Advertiser clock accuracy (see wiced_bt_ble_advertiser_clock_accuracy_e) | |
typedef wiced_bt_ble_periodic_adv_sync_handle_t | wiced_bt_ble_connection_handle_t |
sync handle and connection handle are same range | |
typedef uint8_t | wiced_bt_ble_channel_sel_algo_t |
LE channel algorithm selection (see wiced_bt_ble_channel_sel_algo_e) | |
typedef void(* | wiced_bt_ble_adv_ext_event_cb_fp_t) (wiced_bt_ble_adv_ext_event_t event, wiced_bt_ble_adv_ext_event_data_t *p_data) |
Callback wiced_bt_ble_adv_ext_event_cb_fp_t. More... | |
typedef uint8_t | wiced_bt_dev_io_cap_t |
IO capabilities. | |
typedef uint8_t | wiced_bt_dev_auth_req_t |
BR/EDR authentication requirement (see wiced_bt_dev_auth_req_e) | |
typedef uint8_t | wiced_bt_dev_le_auth_req_t |
LE authentication requirement (see wiced_bt_dev_le_auth_req_e) | |
typedef uint8_t | wiced_bt_smp_sec_level_t |
LE Security key level. | |
typedef uint8_t | wiced_bt_dev_oob_data_t |
OOB data (see wiced_bt_dev_oob_data_e) | |
typedef uint8_t | wiced_bt_dev_oob_data_req_type_t |
OOB data type requested (see wiced_bt_dev_oob_data_req_type_t) | |
typedef uint8_t | wiced_bt_dev_le_key_type_t |
LE key type (see wiced_bt_dev_le_key_type_e) | |
typedef uint8_t | wiced_bt_ble_scan_type_t |
scan type (see wiced_bt_ble_scan_type_e) | |
typedef uint8_t | wiced_bt_smp_status_t |
SMP Pairing status (see wiced_bt_smp_status_e) | |
typedef uint8_t | wiced_bt_dev_power_mgmt_status_t |
Power management status (see wiced_bt_dev_power_mgmt_status_e) | |
typedef uint8_t | wiced_bt_br_chnl_map_t[BTM_AFH_CHNL_MAP_SIZE] |
Array of Channel Map Length. | |
typedef uint8_t | wiced_bt_management_evt_t |
Bluetooth management events (see wiced_bt_management_evt_e) | |
typedef uint8_t | wiced_bt_link_quality_stats_param_t |
Link Quality Statistic Action (see wiced_bt_dev_link_quality_stats_param_e) | |
typedef uint16_t | wiced_bt_link_policy_settings_t[1] |
Link Policy Settings type (see wiced_bt_link_policy_settings_values_e) | |
typedef uint8_t | wiced_bt_ble_advert_mode_t |
Advertisement type (see wiced_bt_ble_advert_mode_e) | |
typedef uint8_t | wiced_bt_ble_conn_mode_t |
Conn mode (see wiced_bt_ble_conn_mode_e) | |
typedef wiced_result_t() | wiced_bt_management_cback_t(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data) |
Bluetooth Management callback. More... | |
typedef void() | wiced_bt_connection_status_change_cback_t(wiced_bt_device_address_t bd_addr, uint8_t *p_features, wiced_bool_t is_connected, uint16_t handle, wiced_bt_transport_t transport, uint8_t reason) |
Connection status change callback. More... | |
typedef void() | wiced_bt_inquiry_result_cback_t(wiced_bt_dev_inquiry_scan_result_t *p_inquiry_result, uint8_t *p_eir_data) |
Inquiry result callback. More... | |
typedef void() | wiced_bt_dev_cmpl_cback_t(void *p_data) |
Asynchronous operation complete callback. More... | |
typedef void() | wiced_bt_dev_vendor_specific_command_complete_cback_t(wiced_bt_dev_vendor_specific_command_complete_params_t *p_command_complete_params) |
Vendor specific command complete. More... | |
typedef void() | wiced_bt_remote_name_cback_t(wiced_bt_dev_remote_name_result_t *p_remote_name_result) |
Remote name result callback. More... | |
typedef void() | wiced_bt_dev_vse_callback_t(uint8_t len, uint8_t *p) |
Vendor event handler callback. More... | |
typedef void() | wiced_bt_hci_trace_cback_t(wiced_bt_hci_trace_type_t type, uint16_t length, uint8_t *p_data) |
HCI trace callback. More... | |
#define BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED (0x01 << 3) |
Simultaneous LE and BR/EDR to Same Device Capable (Controller).
#define BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED (0x01 << 4) |
Simultaneous LE and BR/EDR to Same Device Capable (Host).
#define BTM_BLE_PREFER_LELR_512K BTM_BLE_PREFER_LELR_S2 |
#define BTM_BLE_PREFER_LELR_125K BTM_BLE_PREFER_LELR_S8 |
#define SMP_SEC_NONE 0 |
LE Security key level.
Security Key Level: None
#define WICED_POWER_STATE_ACTIVE BTM_PM_STS_ACTIVE |
Power Management state.
Active
typedef uint8_t wiced_bt_ble_scanner_filter_policy_t |
LE Scanner filter policy.
Scanner filter policy (see wiced_bt_ble_scanner_filter_policy_e)
typedef uint8_t wiced_bt_ble_sec_action_type_t |
LE security type.
typedef uint8_t wiced_bt_ble_host_phy_preferences_t |
Host preferences on PHY.
bit field that indicates the transmitter PHYs that the Host prefers the Controller to use.Bit number 3 -7 reserved for future.
typedef uint16_t wiced_bt_ble_lelr_phy_preferences_t |
The PHY_options parameter is a bit field that allows the Host to specify options for LE long range PHY.
Default connection is with no LE coded PHY.The Controller may override any preferred coding (S2 coded phy for 512k speed and s8 coded phy for 128K) for transmitting on the LE Coded PHY. The Host may specify a preferred coding even if it prefers not to use the LE Coded transmitter PHY since the Controller may override the PHY preference. Bit 2-15 reserved for future use.
typedef uint8_t wiced_bt_ble_privacy_mode_t |
LE Privacy mode.
Refer wiced_bt_ble_privacy_e
typedef void() wiced_bt_ble_scan_result_cback_t(wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data) |
Callback wiced_bt_ble_scan_result_cback_t.
Scan result callback (from calling wiced_bt_ble_scan)
p_scan_result | : scan result data (NULL indicates end of scanning) |
p_adv_data | : Advertisement data (parse using wiced_bt_ble_check_advertising_data) |
typedef void() wiced_bt_ble_read_phy_complete_callback_t(wiced_bt_ble_phy_update_t *p_phy_result) |
Callback wiced_bt_ble_read_phy_complete_callback_t.
read phy complete callback (from calling wiced_bt_ble_read_phy)
p_phy_result | : read phys result |
typedef uint8_t wiced_bt_ble_ext_filter_policy_t |
Filter policy used.
typedef uint16_t wiced_bt_ble_periodic_adv_sync_handle_t |
Sync_Handle to be used to identify the periodic advertiser.
Range: 0x0000-0x0EFF
typedef uint16_t wiced_bt_ble_adv_report_event_mask_t |
Bit mask to identify the type of the adv received in extended adv report.
(see wiced_bt_ble_ext_adv_report_t) event_type filed
typedef void(* wiced_bt_ble_adv_ext_event_cb_fp_t) (wiced_bt_ble_adv_ext_event_t event, wiced_bt_ble_adv_ext_event_data_t *p_data) |
Callback wiced_bt_ble_adv_ext_event_cb_fp_t.
Adv extension command status, command complete event and LE adv extension meta event callback
event | : Event type (see wiced_bt_ble_adv_ext_event_t) |
p_data | : Event data (see wiced_bt_ble_adv_ext_event_data_t) |
typedef wiced_result_t() wiced_bt_management_cback_t(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data) |
Bluetooth Management callback.
Callback for Bluetooth Management event notifications. Registered using wiced_bt_stack_init()
event | : Event ID |
p_event_data | : Event data |
typedef void() wiced_bt_connection_status_change_cback_t(wiced_bt_device_address_t bd_addr, uint8_t *p_features, wiced_bool_t is_connected, uint16_t handle, wiced_bt_transport_t transport, uint8_t reason) |
Connection status change callback.
Callback for Bluetooth Management event notifications. Registered using wiced_bt_register_connection_status_change()
[in] | bd_addr | : BD Address of remote |
[in] | p_features | : unused (NULL) |
[in] | is_connected | : TRUE if connected |
[in] | handle | : Connection handle |
[in] | transport | : BT_TRANSPORT_BR_EDR or BT_TRANSPORT_LE |
[in] | reason | : status for acl connection change HCI_SUCCESS HCI_ERR_PAGE_TIMEOUT HCI_ERR_MEMORY_FULL HCI_ERR_CONNECTION_TOUT HCI_ERR_PEER_USER HCI_ERR_CONN_CAUSE_LOCAL_HOST HCI_ERR_LMP_RESPONSE_TIMEOUT HCI_ERR_CONN_FAILED_ESTABLISHMENT connection status change callback |
typedef void() wiced_bt_inquiry_result_cback_t(wiced_bt_dev_inquiry_scan_result_t *p_inquiry_result, uint8_t *p_eir_data) |
Inquiry result callback.
p_inquiry_result | : Inquiry result data (NULL if inquiry is complete) |
p_eir_data | : Extended inquiry response datainquiry result callback |
typedef void() wiced_bt_dev_cmpl_cback_t(void *p_data) |
Asynchronous operation complete callback.
p_data | : Operation dependent data |
typedef void() wiced_bt_dev_vendor_specific_command_complete_cback_t(wiced_bt_dev_vendor_specific_command_complete_params_t *p_command_complete_params) |
Vendor specific command complete.
p_command_complete_params | : Command complete parameters. |
typedef void() wiced_bt_remote_name_cback_t(wiced_bt_dev_remote_name_result_t *p_remote_name_result) |
Remote name result callback.
p_remote_name_result | : Remote name result data |
typedef void() wiced_bt_dev_vse_callback_t(uint8_t len, uint8_t *p) |
Vendor event handler callback.
len | : input data length |
p | : input data |
typedef void() wiced_bt_hci_trace_cback_t(wiced_bt_hci_trace_type_t type, uint16_t length, uint8_t *p_data) |
HCI trace callback.
Callback for HCI traces Registered using wiced_bt_dev_register_hci_trace()
[in] | type | : Trace type |
[in] | length | : Length of the trace data |
[in] | p_data | : Pointer to the data |
Scanner filter policy.
Advertising filter policy.
Advertisement data types.
Scan result event type.
Multi-advertisement type.
Multi-advertisement Filtering policy.
anonymous enum |
anonymous enum |
anonymous enum |
Advertising event properties: Describes the type of advertising event that is being configured and its basic properties.
anonymous enum |
anonymous enum |
Extended scan duplicate filter policy.
Filter policy used in extended create connection command.
Options used in create periodic sync to periodic adv command.
Mode used in Periodic Advertising Sync Transfer Parameters.
anonymous enum |
ADV extension events to the application.
Enumerator | |
---|---|
WICED_BT_BLE_PERIODIC_ADV_SYNC_ESTABLISHED_EVENT | Sync established to periodic advertiser's periodic advertisement. Event Data : wiced_bt_ble_periodic_adv_sync_established_event_data_t |
WICED_BT_BLE_PERIODIC_ADV_REPORT_EVENT | Periodic adv report. Event Data: wiced_bt_ble_periodic_adv_report_event_data_t |
WICED_BT_BLE_PERIODIC_ADV_SYNC_LOST_EVENT | Periodic sync lost event. Event Data: wiced_bt_ble_periodic_adv_sync_handle_t |
WICED_BT_BLE_ADV_SET_TERMINATED_EVENT | Advertising set terminated becaue either connection being created or adv timeout. Event data: wiced_bt_ble_ext_adv_set_terminated_event_data_t |
WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT | scan request received event. Event data: wiced_bt_ble_scan_req_received_event_data_t |
WICED_BT_BLE_CHANNEL_SEL_ALGO_EVENT | LE Channel selected algorithm event. Event Data: wiced_bt_ble_channel_sel_algo_event_data_t |
WICED_BT_BLE_BIGINFO_ADV_REPORT_EVENT | BIGInfo adv report event. Event Data: wiced_bt_ble_biginfo_adv_report_t |
WICED_BT_BLE_PERIODIC_ADV_SYNC_TRANSFER_EVENT | Periodic Adv Sync Transfer Event. Event Data: wiced_bt_ble_periodic_adv_sync_transfer_event_data_t |
WICED_BT_BLE_PAWR_SYNC_ESTABLISHED_EVENT | Periodic Adv Sync Transfer Event. Event Data: wiced_bt_ble_pawr_sync_established_event_data_t |
WICED_BT_BLE_PAWR_SUBEVENT_DATA_REQ_EVENT | Periodic Adv Sync Transfer Event. Event Data: wiced_bt_ble_pawr_subevent_data_req_event_data_t |
WICED_BT_BLE_PAWR_IND_REPORT_EVENT | Periodic Adv Sync Transfer Event. Event Data: wiced_bt_ble_pawr_ind_report_event_data_t |
WICED_BT_BLE_PAWR_RSP_REPORT_EVENT | Periodic Adv Sync Transfer Event. Event Data: wiced_bt_ble_pawr_rsp_report_event_data_t |
enum wiced_bt_sec_flags_e |
Pairing IO Capabilities.
BR/EDR Authentication requirement.
LE Authentication requirement.
LE Key type.
Scan duty cycle (used for BTM_BLE_SCAN_STATE_CHANGED_EVT and wiced_bt_dev_create_connection)
SMP Pairing status codes.
LE Multi adv opcodes returned.
Bluetooth Management events used in wiced_bt_management_cback_t.
Enumerator | |
---|---|
BTM_ENABLED_EVT | Event notifies Bluetooth controller and host stack is enabled. Event data: wiced_bt_management_evt_data_t::enabled Indicates the stack is up. Application can now start calling bluetooth AIROC Bluetooth APIs |
BTM_DISABLED_EVT | Event notifies Bluetooth controller and host stack disabled. Event data: NULL |
BTM_POWER_MANAGEMENT_STATUS_EVT | Event notifies Power management status change. Event data: wiced_bt_management_evt_data_t::power_mgmt_notification |
BTM_RE_START_EVT | Event notifies Bluetooth controller and host stack re-enabled. Event data: wiced_bt_management_evt_data_t::enabled
|
BTM_PIN_REQUEST_EVT | Event requests app for the PIN to be used for pairing (legacy pairing only). Event data: wiced_bt_management_evt_data_t::pin_request |
BTM_USER_CONFIRMATION_REQUEST_EVT | Event requests user confirmation for the numeric value to continue the App is expected to respond with using wiced_bt_dev_confirm_req_reply typically by confirming via a display to the user Event data: wiced_bt_management_evt_data_t::user_confirmation_request. |
BTM_PASSKEY_NOTIFICATION_EVT | Event notifies user passkey app App is expected to display the passkey to the user Event data: wiced_bt_management_evt_data_t::user_passkey_notification. |
BTM_PASSKEY_REQUEST_EVT | Event requests user passkey from app Event data: wiced_bt_management_evt_data_t::user_passkey_request. |
BTM_KEYPRESS_NOTIFICATION_EVT | Event notifies keypress notification event to app Event data: wiced_bt_management_evt_data_t::user_keypress_notification. |
BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT | Event requests BR/EDR IO capabilities for BR/EDR pairing from app Event data: wiced_bt_management_evt_data_t::pairing_io_capabilities_br_edr_request App is expected to fill in it's BR/EDR IO capabilities into the incoming wiced_bt_management_evt_data_t::pairing_io_capabilities_br_edr_request structure member.
|
BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT | Event notifies received IO capabilities response for BR/EDR pairing. Event data: wiced_bt_management_evt_data_t::pairing_io_capabilities_br_edr_response
|
BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT | Event requests LE IO capabilities for LE pairing from app. Peripheral can check peer io capabilities in event data before updating with local io capabilities. Event data: wiced_bt_management_evt_data_t::pairing_io_capabilities_ble_request |
BTM_PAIRING_COMPLETE_EVT | Event notifies simple pairing complete to app Event data: wiced_bt_management_evt_data_t::pairing_complete. |
BTM_ENCRYPTION_STATUS_EVT | Event notifies encryption status change to app Event data: wiced_bt_management_evt_data_t::encryption_status. |
BTM_SECURITY_REQUEST_EVT | Event requests app to allow stack to continue Security procedures/pairing to continue with the peer. App needs to respond with wiced_bt_ble_security_grant App is expected to either allow or deny the incoming pairing request based on it's state Event data: wiced_bt_management_evt_data_t::security_request |
BTM_SECURITY_FAILED_EVT | Event notifies Security procedure/authentication failed to app Event data: wiced_bt_management_evt_data_t::security_failed. |
BTM_SECURITY_ABORTED_EVT | Event notifies security procedure aborted locally, or unexpected link drop. Event data: wiced_bt_management_evt_data_t::security_aborted |
BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT | Event notifies result of reading local OOB data from the controller Event data: wiced_bt_management_evt_data_t::read_local_oob_data_complete.
|
BTM_REMOTE_OOB_DATA_REQUEST_EVT | Event requests OOB data of the remote device from app Event data: wiced_bt_management_evt_data_t::remote_oob_data_request.
|
BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT | Event notifies app with the updated remote device link keys in this event. App is expected to store device_link_keys to NV memory. This is the place to verify that the correct link key has been generated. Event data: wiced_bt_management_evt_data_t::paired_device_link_keys_update |
BTM_PAIRED_DEVICE_LINK_KEYS_REQUEST_EVT | Event requests for stored remote device link keys from app (restore device_link_keys from NV memory). If available then fill the stored keys into |
BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT | Event notifies updated local identity key to the app (stored local_identity_keys NV memory). App is expected to store the identity key to NV memory. Event data: wiced_bt_management_evt_data_t::local_identity_keys_update |
BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT | Event requests local identity key from app (get local_identity_keys from NV memory). If available then fill the local key into |
BTM_BLE_SCAN_STATE_CHANGED_EVT | Event notifies LE scan state change to app Event data: wiced_bt_management_evt_data_t::ble_scan_state_changed. |
BTM_BLE_ADVERT_STATE_CHANGED_EVT | Event notifies LE advertisement state change to app Event data: wiced_bt_management_evt_data_t::ble_advert_state_changed. |
BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT | Event requests SMP remote oob data. Reply using wiced_bt_smp_oob_data_reply. Event data: wiced_bt_management_evt_data_t::smp_remote_oob_data_request |
BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT | Event requests LE secure connection remote oob data request. Reply using wiced_bt_smp_sc_oob_reply. Event data: wiced_bt_management_evt_data_t::smp_sc_remote_oob_data_request |
BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT | Event notifies LE secure connection local OOB data (wiced_bt_smp_create_local_sc_oob_data) returned by the stack The app is expected to copy the data into it's memory and share out of band with the peer Event data: wiced_bt_management_evt_data_t::p_smp_sc_local_oob_data. |
BTM_SCO_CONNECTED_EVT | Event notfies SCO connected to app Event data: wiced_bt_management_evt_data_t::sco_connected.
|
BTM_SCO_DISCONNECTED_EVT | Event notifies SCO disconnected event to app Event data: wiced_bt_management_evt_data_t::sco_disconnected.
|
BTM_SCO_CONNECTION_REQUEST_EVT | Event notifies SCO connection request to app App is expected to reply with. Event data: wiced_bt_management_evt_data_t::sco_connection_request
|
BTM_SCO_CONNECTION_CHANGE_EVT | Event notifies SCO connection change to app Event data: wiced_bt_management_evt_data_t::sco_connection_change.
|
BTM_BLE_CONNECTION_PARAM_UPDATE | Event notifies LE connection parameter update to app Event data: wiced_bt_management_evt_data_t::ble_connection_param_update. |
BTM_BLE_PHY_UPDATE_EVT | Event notifies LE Physical link update to app Event data: wiced_bt_management_evt_data_t::ble_phy_update_event. |
BTM_LPM_STATE_LOW_POWER | Event notifies Bluetooth device wake has been deasserted. Used for Host Stack Use Case. |
BTM_MULTI_ADVERT_RESP_EVENT | Event notifies Multi adv command status event used for the status of the command sent Event data: wiced_bt_management_evt_data_t::ble_multi_adv_response_event. |
BTM_BLE_DATA_LENGTH_UPDATE_EVENT | Event to notify change in the data length and timeout configured for Rx and Tx on the LE link Event data: wiced_bt_management_evt_data_t::ble_data_length_update_event. |
BTM_BLE_SUBRATE_CHANGE_EVENT | Event to notify subrate change event BLE link Event data: wiced_bt_management_evt_data_t::ble_subrate_change_event. |
BTM_BLE_DEVICE_ADDRESS_UPDATE_EVENT | Event to notify change in the device address Application can register to receive a callback on device address update through wiced_bt_ble_notify_on_device_address_change Event data: wiced_bt_management_evt_data_t::ble_subrate_change_event. |
.Enumeration of known link policy settings value assignments of the wiced_bt_link_policy_settings_t
Enumerator | |
---|---|
WICED_ENABLE_ROLE_SWITCH | Enable Role Switch. |
WICED_ENABLE_HOLD_MODE | Enable Hold mode. |
WICED_ENABLE_SNIFF_MODE | Enable Sniff mode. |
advertisement type (used when calling wiced_bt_start_advertisements)
HCI trace types.