Device Management

API Reference


group Wicedbt_DeviceManagement

This section consists of several management entities:

  • Device Control - controls the local device

  • Device Discovery - manages inquiries, discover database

  • ACL Channels - manages BLE ACL connections

  • Security - manages all security functionality

Defines

BTM_AFH_CHNL_MAP_SIZE

AFH channel map size.

BLE_CHANNEL_MAP_LEN

AFH Channel Map len.

BTM_BLE_DEFAULT_ADVERT_CHNL_MAP

default advertising channel map

BTM_BLE_ADVERT_FILTER_DEFAULT

default advertising filter policy

BTM_BLE_ADVERT_INTERVAL_MIN

adv parameter Min value

BTM_BLE_ADVERT_INTERVAL_MAX

adv parameter Max value

BTM_BLE_SCAN_INTERVAL_MIN

Scan interval minimum value.

BTM_BLE_SCAN_INTERVAL_MAX

Scan interval miximum value.

BTM_BLE_SCAN_WINDOW_MIN

Scan window minimum value.

BTM_BLE_SCAN_WINDOW_MAX

Scan window maximum value.

BTM_BLE_CONN_INTERVAL_MIN

Connection interval minimum value.

BTM_BLE_CONN_INTERVAL_MAX

Connection interval maximum value.

BTM_BLE_CONN_LATENCY_MAX

Maximum Connection Latency.

BTM_BLE_CONN_SUP_TOUT_MIN

Minimum Supervision Timeout.

BTM_BLE_CONN_SUP_TOUT_MAX

Maximum Supervision Timeout.

BTM_BLE_CONN_PARAM_UNDEF

use this value when a specific value not to be overwritten

BTM_BLE_CONN_SUP_TOUT_DEF

Default Supervision Timeout.

BTM_BLE_SCAN_FAST_INTERVAL

default scan interval 30 ~ 60 ms (use 60) = 96 *0.625

BTM_BLE_SCAN_FAST_WINDOW

default scan window for background connection, applicable for auto connection or selective conenction 30 ms = 48 *0.625

BTM_BLE_SCAN_SLOW_INTERVAL_1

default scan interval used in reduced power cycle (background scanning) 1.28 s = 2048 *0.625

BTM_BLE_SCAN_SLOW_WINDOW_1

default scan window used in reduced power cycle (background scanning) 11.25 ms = 18 *0.625

BTM_BLE_SCAN_SLOW_INTERVAL_2

default scan interval used in reduced power cycle (background scanning) 2.56 s = 4096 *0.625

BTM_BLE_SCAN_SLOW_WINDOW_2

default scan window used in reduced power cycle (background scanning) 22.5 ms = 36 *0.625

BTM_BLE_CONN_INTERVAL_MIN_DEF

default connection interval min recommended min: 30ms = 24 * 1.25

BTM_BLE_CONN_INTERVAL_MAX_DEF

default connection interval max recommended max: 50 ms = 56 * 1.25

BTM_BLE_CONN_PERIPHERAL_LATENCY_DEF

default Peripheral latency

BTM_BLE_CONN_TIMEOUT_DEF

default supervision timeout

BTM_BLE_AUTH_SIGNATURE_SIZE

BLE Signature BLE data signature length 8 Bytes + 4 bytes counter.

BTM_BLE_POLICY_REJECT_ALL

relevant to both

BTM_BLE_POLICY_ALLOW_SCAN

relevant to advertiser

BTM_BLE_POLICY_ALLOW_CONN

relevant to advertiser

BTM_BLE_POLICY_ALLOW_ALL

relevant to both

BTM_BLE_LIMITED_DISCOVERABLE_FLAG

Limited Discoverable.

BTM_BLE_GENERAL_DISCOVERABLE_FLAG

General Discoverable.

BTM_BLE_BREDR_NOT_SUPPORTED

BR/EDR Not Supported.

BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED

Simultaneous LE and BR/EDR to Same Device Capable (Controller).

BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED

Simultaneous LE and BR/EDR to Same Device Capable (Host).

BTM_BLE_NON_LIMITED_DISCOVERABLE_FLAG

Non Discoverable.

BTM_BLE_ADVERT_FLAG_MASK

BLE adverisement mask.

BTM_BLE_LIMITED_DISCOVERABLE_MASK

BLE Limited discovery mask.

BTM_BLE_PREFER_1M_PHY

LE 1M PHY preference.

BTM_BLE_PREFER_2M_PHY

LE 2M PHY preference.

BTM_BLE_PREFER_LELR_PHY

LE LELR PHY preference.

BTM_BLE_PREFER_NO_LELR

No preferred coding.

BTM_BLE_PREFER_LELR_125K

Preferred coding is S=2.

BTM_BLE_PREFER_LELR_512K

Preferred coding is S=8.

MULTI_ADV_TX_POWER_MIN_INDEX

Multi adv tx min power index.

MULTI_ADV_TX_POWER_MAX_INDEX

Multi adv tx max power index.

WICED_BT_BLE_MAX_EXT_ADV_DATA_LEN

ADV extension structures.

IS_CONNECTABLE_ADV_REPORT(x)

adv is connectable

IS_SCANNABLE_ADV_REPORT(x)

adv is scannable

IS_DIRECTED_ADV_REPORT(x)

directed adv

IS_SCAN_RSP_ADV_REPORT(x)

scan response

IS_LEGACY_ADV_REPORT(x)

legacy adv

IS_ADV_REPORT_DATA_STATUS_INCOMPLETE(x)

adv data incomplete, more data to come

IS_ADV_REPORT_DATA_STATUS_TRUNCATED(x)

Incomplete, data truncated, no more to come.

BTM_INQ_RES_IGNORE_RSSI

RSSI value not supplied (ignore it)

BTM_SCAN_PARAM_IGNORE

Passed to BTM_SetScanConfig() to ignore.

BTM_PIN_TYPE_VARIABLE

Variable Pin Type.

BTM_PIN_TYPE_FIXED

Fix Length Pin Type.

BTM_SECURITY_KEY_DATA_LEN

Security key data length (used by wiced_bt_device_link_keys_t structure)

BTM_SECURITY_LOCAL_KEY_DATA_LEN

Local security key data length (used by wiced_bt_local_identity_keys_t structure)

BTM_OOB_STATE

OOB Data status.

BTM_OOB_REQ_TYPE

Type of OOB data required.

BTM_LE_KEY_TYPES

LE Key type.

BTM_BLE_SCAN_TYPE

Scan duty cycle (used for BTM_BLE_SCAN_STATE_CHANGED_EVT and wiced_bt_dev_create_connection)

BTM_BLE_KEY_TYPE_ID

Identity resolving key.

BTM_BLE_KEY_TYPE_ER

Encryption root key.

BTM_PM_STATUS_CODES

Power Management status codes.

WICED_POWER_STATE_ACTIVE

Power Management state.

Active

WICED_POWER_STATE_SNIFF

Sniff.

WICED_POWER_STATE_SSR

Sniff subrating notification.

WICED_POWER_STATE_PENDING

Pending (waiting for status from controller)

WICED_POWER_STATE_ERROR

Error (controller returned error)

BTM_AFH_CHNL_MAP_SIZE

Channel Map Length.

BTM_MANAGEMENT_EVT

Bluetooth Management event.

BTM_BLE_ADVERT_MODE

advertisement type (used when calling wiced_bt_start_advertisements)

BTM_BLE_CONN_MODE

scan mode used in initiating

Typedefs

typedef uint8_t wiced_bt_ble_chnl_map_t[BLE_CHANNEL_MAP_LEN]

BLE Channel Map.

typedef uint8_t wiced_bt_ble_scanner_filter_policy_t

BLE Scanner filter policy.

Scanner filter policy (see wiced_bt_ble_scanner_filter_policy_e)

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

BLE 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

BLE security type.

refer wiced_bt_ble_sec_action_type_e

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.

note

These preferences applicable only when BTM_BLE_PREFER_LELR_PHY flag gest set

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

BLE advertisement type (see wiced_bt_ble_multi_advert_type_e)

typedef uint8_t wiced_bt_ble_privacy_mode_t

BLE Privacy mode.

Refer wiced_bt_ble_privacy_e

typedef uint8_t wiced_bt_ble_multi_advert_filtering_policy_t

BLE advertisement filtering policy (see wiced_bt_ble_multi_advert_filtering_policy_e)

wiced_bool_t() wiced_bt_ble_selective_conn_cback_t (wiced_bt_device_address_t remote_bda, uint8_t *p_remote_name)

Callback wiced_bt_ble_selective_conn_cback_t.

Selective connection callback (registered with wiced_bt_ble_set_background_connection_type)

Return

Parameters
  • remote_bda: : remote device

  • p_remote_name: : remote device name

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)

Return

Nothing

Parameters

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)

Return

Nothing

Parameters
  • p_phy_result: : read phys result

typedef uint8_t wiced_bt_ble_ext_adv_phy_t

BLE phy to be used for extended advertisement.

typedef uint8_t wiced_bt_ble_ext_adv_phy_mask_t

BLE phy mask to be used for extended advertisement.

typedef uint16_t wiced_bt_ble_ext_adv_event_property_t

BLE 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.

(see wiced_bt_ble_ext_filter_policy_e)

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 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 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.

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

Return

Nothing

Parameters

typedef wiced_result_t wiced_bt_dev_status_t

Result/Status.

typedef uint8_t wiced_bt_sec_level_t
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

BLE authentication requirement (see wiced_bt_dev_le_auth_req_e)

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)

Link Quality Statistic Action (see wiced_bt_dev_link_quality_stats_param_e)

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)

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()

Return

Status of event handling

Parameters
  • event: : Event ID

  • p_event_data: : Event data

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()

Parameters
  • [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

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.

Parameters
  • p_inquiry_result: : Inquiry result data (NULL if inquiry is complete)

  • p_eir_data: : Extended inquiry response datainquiry result callback

void() wiced_bt_dev_cmpl_cback_t (void *p_data)

Asynchronous operation complete callback.

Return

void

Parameters
  • p_data: : Operation dependent data

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.

Return

void

Parameters
  • p_command_complete_params: : Command complete parameters.

void() wiced_bt_remote_name_cback_t (wiced_bt_dev_remote_name_result_t *p_remote_name_result)

Remote name result callback.

Return

voidremote name result callback

Parameters
  • p_remote_name_result: : Remote name result data

void() wiced_bt_dev_vse_callback_t (uint8_t len, uint8_t *p)

Vendor event handler callback.

Parameters
  • len: : input data length

  • p: : input data

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()

Return

void

Parameters
  • [in] type: : Trace type

  • [in] length: : Length of the trace data

  • [in] p_data: : Pointer to the data

typedef void (*wiced_bt_debug_trace_cback_t)(char *p_trace_buf, int trace_buf_len, wiced_bt_trace_type_t trace_type)

Debug trace callback.

Callback for Debug traces Registered using wiced_bt_dev_register_debug_trace()

Return

void

Parameters
  • [in] p_trace_buf: : Trace buffer

  • [in] trace_buf_len: : Length of the trace data

  • [in] trace_type: : Trace type

Enums

enum wiced_bt_ble_scanner_filter_policy_e

wiced_bt_ble_scanner_filter_policy_e: Scanner filter policy.

Values:

enumerator BTM_BLE_SCAN_POLICY_ACCEPT_ADV_RSP

accept adv packet from all, directed adv pkt not directed to local device is ignored

enumerator BTM_BLE_SCAN_POLICY_FILTER_ADV_RSP

accept adv packet from device in filter Accept List, directed adv packet not directed to local device is ignored

enumerator BTM_BLE_SCAN_POLICY_ACCEPT_RPA_DIR_ADV_RSP

accept adv packet from all, directed adv pkt not directed to local device is ignored except direct adv with RPA

enumerator BTM_BLE_SCAN_POLICY_FILTER_RPA_DIR_ADV_RSP

accept adv packet from device in filter Accept List, directed adv pkt not directed to me is ignored except direct adv with RPA

enumerator BTM_BLE_SCAN_POLICY_MAX

Max Scan filter policy value.

enum wiced_bt_ble_advert_filter_policy_e

wiced_bt_ble_advert_filter_policy_e: Advertising filter policy.

Values:

enumerator BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN

Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use) (default)

enumerator BTM_BLE_ADV_POLICY_ACCEPT_CONN_FILTER_SCAN

Process connection requests from all devices and only scan requests from devices that are in the Filter Accept List.

enumerator BTM_BLE_ADV_POLICY_FILTER_CONN_ACCEPT_SCAN

Process scan requests from all devices and only connection requests from devices that are in the Filter Accept List.

enumerator BTM_BLE_ADV_POLICY_FILTER_CONN_FILTER_SCAN

Process scan and connection requests only from devices in the Filter Accept List.

enumerator BTM_BLE_ADV_POLICY_MAX

Max Adv filter value.

enum wiced_bt_ble_advert_type_e

wiced_bt_ble_advert_type_e: Advertisement data types.

Values:

enumerator BTM_BLE_ADVERT_TYPE_FLAG

Advertisement flags.

enumerator BTM_BLE_ADVERT_TYPE_16SRV_PARTIAL

List of supported services - 16 bit UUIDs (partial)

enumerator BTM_BLE_ADVERT_TYPE_16SRV_COMPLETE

List of supported services - 16 bit UUIDs (complete)

enumerator BTM_BLE_ADVERT_TYPE_32SRV_PARTIAL

List of supported services - 32 bit UUIDs (partial)

enumerator BTM_BLE_ADVERT_TYPE_32SRV_COMPLETE

List of supported services - 32 bit UUIDs (complete)

enumerator BTM_BLE_ADVERT_TYPE_128SRV_PARTIAL

List of supported services - 128 bit UUIDs (partial)

enumerator BTM_BLE_ADVERT_TYPE_128SRV_COMPLETE

List of supported services - 128 bit UUIDs (complete)

enumerator BTM_BLE_ADVERT_TYPE_NAME_SHORT

Short name.

enumerator BTM_BLE_ADVERT_TYPE_NAME_COMPLETE

Complete name.

enumerator BTM_BLE_ADVERT_TYPE_TX_POWER

TX Power level.

enumerator BTM_BLE_ADVERT_TYPE_DEV_CLASS

Device Class.

enumerator BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_HASH_C

Simple Pairing Hash C.

enumerator BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_RAND_C

Simple Pairing Randomizer R.

enumerator BTM_BLE_ADVERT_TYPE_SM_TK

Security manager TK value.

enumerator BTM_BLE_ADVERT_TYPE_SM_OOB_FLAG

Security manager Out-of-Band data.

enumerator BTM_BLE_ADVERT_TYPE_INTERVAL_RANGE

Peripheral connection interval range.

enumerator BTM_BLE_ADVERT_TYPE_SOLICITATION_SRV_UUID

List of solicitated services - 16 bit UUIDs.

enumerator BTM_BLE_ADVERT_TYPE_128SOLICITATION_SRV_UUID

List of solicitated services - 128 bit UUIDs.

enumerator BTM_BLE_ADVERT_TYPE_SERVICE_DATA

Service data - 16 bit UUID.

enumerator BTM_BLE_ADVERT_TYPE_PUBLIC_TARGET

Public target address.

enumerator BTM_BLE_ADVERT_TYPE_RANDOM_TARGET

Random target address.

enumerator BTM_BLE_ADVERT_TYPE_APPEARANCE

Appearance.

enumerator BTM_BLE_ADVERT_TYPE_ADVERT_INTERVAL

Advertising interval.

enumerator BTM_BLE_ADVERT_TYPE_LE_BD_ADDR

LE device bluetooth address.

enumerator BTM_BLE_ADVERT_TYPE_LE_ROLE

LE role.

enumerator BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_HASH

Simple Pairing Hash C-256.

enumerator BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_RAND

Simple Pairing Randomizer R-256.

enumerator BTM_BLE_ADVERT_TYPE_32SOLICITATION_SRV_UUID

List of solicitated services - 32 bit UUIDs.

enumerator BTM_BLE_ADVERT_TYPE_32SERVICE_DATA

Service data - 32 bit UUID.

enumerator BTM_BLE_ADVERT_TYPE_128SERVICE_DATA

Service data - 128 bit UUID.

enumerator BTM_BLE_ADVERT_TYPE_CONN_CONFIRM_VAL

LE Secure Connections Confirmation Value.

enumerator BTM_BLE_ADVERT_TYPE_CONN_RAND_VAL

LE Secure Connections Random Value.

enumerator BTM_BLE_ADVERT_TYPE_URI

URI.

enumerator BTM_BLE_ADVERT_TYPE_INDOOR_POS

Indoor Positioning.

enumerator BTM_BLE_ADVERT_TYPE_TRANS_DISCOVER_DATA

Transport Discovery Data.

enumerator BTM_BLE_ADVERT_TYPE_SUPPORTED_FEATURES

LE Supported Features.

enumerator BTM_BLE_ADVERT_TYPE_UPDATE_CH_MAP_IND

Channel Map Update Indication.

enumerator BTM_BLE_ADVERT_TYPE_PB_ADV

PB-ADV.

enumerator BTM_BLE_ADVERT_TYPE_MESH_MSG

Mesh Message.

enumerator BTM_BLE_ADVERT_TYPE_MESH_BEACON

Mesh Beacon.

enumerator BTM_BLE_ADVERT_TYPE_PSRI

Generic Audio Provate Set Random Identifier.

enumerator BTM_BLE_ADVERT_TYPE_3D_INFO_DATA

3D Information Data

enumerator BTM_BLE_ADVERT_TYPE_MANUFACTURER

Manufacturer data.

enum wiced_bt_ble_sec_flags_e

wiced_bt_ble_sec_flags_e: security settings used with L2CAP LE COC

Values:

Link encrypted.

Paired without man-in-the-middle protection.

Link with man-in-the-middle protection.

enum wiced_bt_dev_ble_evt_type_e

wiced_bt_dev_ble_evt_type_e: Scan result event type.

Values:

enumerator BTM_BLE_EVT_CONNECTABLE_ADVERTISEMENT

Connectable advertisement.

enumerator BTM_BLE_EVT_CONNECTABLE_DIRECTED_ADVERTISEMENT

Connectable Directed advertisement.

enumerator BTM_BLE_EVT_SCANNABLE_ADVERTISEMENT

Scannable advertisement.

enumerator BTM_BLE_EVT_NON_CONNECTABLE_ADVERTISEMENT

Non connectable advertisement.

enumerator BTM_BLE_EVT_SCAN_RSP

Scan response.

enum wiced_bt_ble_conn_type_e

wiced_bt_ble_conn_type_e: Background connection type.

Values:

enumerator BTM_BLE_CONN_NONE

No background connection.

enumerator BTM_BLE_CONN_AUTO

Auto connection.

enumerator BTM_BLE_CONN_SELECTIVE

Selective connection.

enum wiced_bt_ble_sec_action_type_e

wiced_bt_ble_sec_action_type_e: LE encryption method.

Values:

enumerator BTM_BLE_SEC_NONE

No encryption.

enumerator BTM_BLE_SEC_ENCRYPT

encrypt the link using current key

enumerator BTM_BLE_SEC_ENCRYPT_NO_MITM

encryption without MITM

enumerator BTM_BLE_SEC_ENCRYPT_MITM

encryption with MITM

enum wiced_bt_ble_multi_advert_start_e

wiced_bt_ble_multi_advert_start_e: Multi-advertisement start/stop.

Values:

enumerator MULTI_ADVERT_STOP

Stop Multi-adverstisment.

enumerator MULTI_ADVERT_START

Start Multi-adverstisment.

enum wiced_bt_ble_multi_advert_type_e

wiced_bt_ble_multi_advert_type_e: Multi-advertisement type.

Values:

enumerator MULTI_ADVERT_CONNECTABLE_UNDIRECT_EVENT

Multi adv Connectable undirected event.

enumerator MULTI_ADVERT_CONNECTABLE_DIRECT_EVENT

Multi adv Connectable directed event.

enumerator MULTI_ADVERT_DISCOVERABLE_EVENT

Multi adv Discoverable event.

enumerator MULTI_ADVERT_NONCONNECTABLE_EVENT

Multi adv NonConnectable event.

enumerator MULTI_ADVERT_LOW_DUTY_CYCLE_DIRECT_EVENT

Multi adv Low Cycle directed event.

enum wiced_bt_ble_privacy_e

wiced_bt_ble_privacy_e: Privacy mode refer Spec version 5.0 Vol 3 Part C Section 10.7 privacy feature.

Values:

enumerator BTM_BLE_PRIVACY_MODE_NETWORK

network privacy mode

enumerator BTM_BLE_PRIVACY_MODE_DEVICE

device privacy mode

enum wiced_bt_ble_multi_advert_filtering_policy_e

wiced_bt_ble_multi_advert_filtering_policy_e: Multi-advertisement Filtering policy.

Values:

enumerator MULTI_ADVERT_FILTER_POLICY_NOT_USED

Multi adv filter filter Accept List not used.

enumerator MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_CONNECTION

Multi adv filter filter Accept List for scan request.

enumerator MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_SCANNING

Multi adv filter filter Accept List for connection request.

enumerator MULTI_ADVERT_FILTER_POLICY_USE_FOR_ALL

Multi adv filter filter Accept List for all.

enum [anonymous]

@1: BLE PHY.

Values:

enumerator WICED_BT_BLE_EXT_ADV_PHY_1M

advetiser advertisement PHY is LE 1M

enumerator WICED_BT_BLE_EXT_ADV_PHY_2M

advetiser advertisement PHY is LE 2M

enumerator WICED_BT_BLE_EXT_ADV_PHY_LE_CODED

advetiser advertisement PHY is LE Coded (for long range)

enumerator WICED_BT_BLE_EXT_ADV_NUM_PHYS

3 PHYs are defined

enum [anonymous]

@2: BLE PHY bit mask.

Values:

enumerator WICED_BT_BLE_EXT_ADV_PHY_1M_BIT

Bit mask to specify for LE1M PHY.

enumerator WICED_BT_BLE_EXT_ADV_PHY_2M_BIT

Bit mask to specify for LE2M PHY.

enumerator WICED_BT_BLE_EXT_ADV_PHY_LE_CODED_BIT

Bit mask to specify for LE coded PHY.

enum [anonymous]

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

Values:

enumerator WICED_BT_BLE_EXT_ADV_EVENT_CONNECTABLE_ADV

Connectable ADV.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_SCANNABLE_ADV

Scannable ADV.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_DIRECTED_ADV

Low duty cycle directed advertisement.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV

3.75 ms Advertising Interval, only valid in legacy ADV

enumerator WICED_BT_BLE_EXT_ADV_EVENT_LEGACY_ADV

Legacy Advertisement.

Adv data cannot be more than 31 bytes.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_ANONYMOUS_ADV

Omits advertisers address from all PDUs.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_INCLUDE_TX_POWER

Include Tx power in ext ADV pdus.

enum [anonymous]

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

Values:

enumerator WICED_BT_BLE_EXT_ADV_HANDLE_MIN

min advertisement set handle value

enumerator WICED_BT_BLE_EXT_ADV_HANDLE_MAX

max advertisement set handle value

enum [anonymous]

@5: The Advertising set identifier(SID) is used to uniquely identify adv sets from advertiser.

SID the value to be transmitted in the advertising SID subfield of the ADI field of the Extended ADV PDUs

Values:

enumerator WICED_BT_BLE_EXT_ADV_SID_MIN

min SID value

enumerator WICED_BT_BLE_EXT_ADV_SID_MAX

max SID value

enum wiced_bt_ble_ext_adv_scan_req_notification_setting_e

wiced_bt_ble_ext_adv_scan_req_notification_setting_e: Value to configure to receive scan request recived notification.

Values:

enumerator WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_DISABLE

Do not send Notification on scan request.

enumerator WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_ENABLE

Send Notification on scan request.

enum wiced_bt_ble_periodic_adv_prop_e

wiced_bt_ble_periodic_adv_prop_e: Periodic adv property.

Values:

enumerator WICED_BT_BLE_PERIODIC_ADV_PROPERTY_INCLUDE_TX_POWER

Speicify Tx power in periodic adv events.

enum wiced_bt_ble_ext_scan_filter_duplicate_e

wiced_bt_ble_ext_scan_filter_duplicate_e: Extended scan duplicate filter policy.

Values:

enumerator WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_DISABLE

send all advertisements received from advertisers

enumerator WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE

duplicate advertisements should not be sent until scan disabled

enumerator WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE_RESET_ON_SCAN_PERIOD

filter duplicate adv during single scan Duration (see wiced_bt_ble_ext_scan_enable_t).Period should be non zero on using this option

enum wiced_bt_ble_ext_filter_policy_e

wiced_bt_ble_ext_filter_policy_e: Filter policy used in extended create connection command.

Values:

enumerator WICED_BT_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

enumerator WICED_BT_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.

enum wiced_bt_ble_adv_sync_options_e

wiced_bt_ble_adv_sync_options_e: Options used in create periodic sync to periodic adv command.

Values:

enumerator WICED_BT_BLE_IGNORE_SYNC_TO_PERIODIC_ADV_LIST

Use the Advertising_SID, Advertising_Address_Type, and Advertising Address parameters specified in create sync command to determine which advertiser to listen to.

enumerator WICED_BT_BLE_SYNC_TO_PERIODIC_ADV_LIST

Use the Periodic Advertiser List to determine which advertiser to listen to.

enum [anonymous]

@6: When controller receives succesfully periodic adv event based on create sync to periodic advertiser command, sync handle get generated by controller and reported in periodic sync established event scanner uniquely identifies periodic adv data from adv reports using this handle and advertismenet set id(SID)

Values:

enumerator PERIODIC_SYNC_HANDLE_MIN
enumerator PERIODIC_SYNC_HANDLE_MAX
enum wiced_bt_ble_ext_adv_report_count_e

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

Values:

enumerator ADV_REP_EVT_COUNT_MIN

min number of reports in LE extended adv report event

enumerator ADV_REP_EVT_COUNT_MAX

max number of reports in LE extended adv report event

enum wiced_bt_ble_advertiser_clock_accuracy_e

wiced_bt_ble_advertiser_clock_accuracy_e: Advertiser clock accuracy.

Values:

enumerator ADVERTISER_CLK_ACCURACY_500PPM
enumerator ADVERTISER_CLK_ACCURACY_250PPM
enumerator ADVERTISER_CLK_ACCURACY_150PPM
enumerator ADVERTISER_CLK_ACCURACY_100PPM
enumerator ADVERTISER_CLK_ACCURACY_75PPM
enumerator ADVERTISER_CLK_ACCURACY_50PPM
enumerator ADVERTISER_CLK_ACCURACY_30PPM
enumerator ADVERTISER_CLK_ACCURACY_20PPM
enum wiced_bt_ble_channel_sel_algo_e

wiced_bt_ble_channel_sel_algo_e: BLE channel selection algorithms.

Values:

enumerator LE_CHANNEL_SEL_ALGO_1_USED

LE channel selection algorithm#1 used.

enumerator LE_CHANNEL_SEL_ALGO_2_USED

LE channel selection algorithm#2 used.

enum wiced_bt_ble_adv_ext_event_t

wiced_bt_ble_adv_ext_event_t: ADV extension events to the application.

Values:

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

enumerator WICED_BT_BLE_PERIODIC_ADV_REPORT_EVENT

Periodic adv report.

Event Data: wiced_bt_ble_periodic_adv_report_event_data_t

enumerator WICED_BT_BLE_PERIODIC_ADV_SYNC_LOST_EVENT

Periodic sync lost event.

Event Data: wiced_bt_ble_periodic_adv_sync_handle_t

enumerator 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

enumerator WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT

scan request received event.

Event data: wiced_bt_ble_scan_req_received_event_data_t

enumerator WICED_BT_BLE_CHANNEL_SEL_ALGO_EVENT

LE Channel selected algorithm event.

Event Data: wiced_bt_ble_channel_sel_algo_event_data_t

enum wiced_bt_sec_level_e

wiced_bt_sec_level_e: Security Service Levels (bit fields)

Values:

enumerator BTM_SEC_BEST_EFFORT

BTM_SEC_BEST_EFFORT : Recommended choice for most applications, to connect to the widest range of devices.

Allows stack to choose the highest level of security possible between the two devices

enumerator BTM_SEC_SC_REQUIRED

BTM_SEC_SC_REQUIRED : Can be set by applications which need to enforce secure connections.

Note: If this bit is set, the stack will only allow connections to devices paired using Secure Connections

enumerator BTM_SEC_AUTH_REQUIRED

BTM_SEC_AUTH_REQUIRED - Can be set by applications which need to enforce Authentication Note: If this bit is set, the stack will only allow connections to devices paired using authentication.

enumerator BTM_SEC_SC_AUTH_REQUIRED

BTM_SEC_SC_AUTH_REQUIRED : Can be set by applications which need to enforce secure connections with MITM protection.

Note: If this bit is set, the stack will only allow connections to devices paired using Secure Connections with Man In The Middle (MITM) protection

enum wiced_bt_sec_flags_e

wiced_bt_sec_flags_e: security flags for current BR/EDR link

Values:

Link encrypted.

Paired without man-in-the-middle protection.

Link with man-in-the-middle protection.

enum wiced_bt_dev_io_cap_e

wiced_bt_dev_io_cap_e: Pairing IO Capabilities.

Values:

enumerator BTM_IO_CAPABILITIES_DISPLAY_ONLY

Display Only.

enumerator BTM_IO_CAPABILITIES_DISPLAY_AND_YES_NO_INPUT

Display Yes/No.

enumerator BTM_IO_CAPABILITIES_KEYBOARD_ONLY

Keyboard Only.

enumerator BTM_IO_CAPABILITIES_NONE

No Input, No Output.

enumerator BTM_IO_CAPABILITIES_BLE_DISPLAY_AND_KEYBOARD_INPUT

Keyboard display (For BLE SMP)

enumerator BTM_IO_CAPABILITIES_MAX

Max value for IO capability.

enum wiced_bt_dev_auth_req_e

wiced_bt_dev_auth_req_e: BR/EDR Authentication requirement.

Values:

enumerator BTM_AUTH_SINGLE_PROFILE_NO

MITM Protection Not Required - Single Profile/non-bonding.

Numeric comparison with automatic accept allowed

enumerator BTM_AUTH_SINGLE_PROFILE_YES

MITM Protection Required - Single Profile/non-bonding.

Use IO Capabilities to determine authentication procedure

enumerator BTM_AUTH_ALL_PROFILES_NO

MITM Protection Not Required - All Profiles/dedicated bonding.

Numeric comparison with automatic accept allowed

enumerator BTM_AUTH_ALL_PROFILES_YES

MITM Protection Required - All Profiles/dedicated bonding.

Use IO Capabilities to determine authentication procedure

enumerator BTM_AUTH_SINGLE_PROFILE_GENERAL_BONDING_NO

MITM Protection Not Required - Single Profiles/general bonding.

Numeric comparison with automatic accept allowed

enumerator BTM_AUTH_SINGLE_PROFILE_GENERAL_BONDING_YES

MITM Protection Required - Single Profiles/general bonding.

Use IO Capabilities to determine authentication procedure

enum wiced_bt_dev_le_auth_req_e

wiced_bt_dev_le_auth_req_e: LE Authentication requirement.

Values:

enumerator BTM_LE_AUTH_REQ_NO_BOND

Not required - No Bond.

enumerator BTM_LE_AUTH_REQ_BOND

Required - General Bond.

enumerator BTM_LE_AUTH_REQ_MITM

MITM required - Auth Y/N.

enumerator BTM_LE_AUTH_REQ_SC

LE Secure Connection or legacy, no MITM, no Bonding.

enumerator BTM_LE_AUTH_REQ_KP

Keypress supported Y/N.

enumerator BTM_LE_AUTH_REQ_H7

Key derivation function H7 supported Y/N.

enumerator BTM_LE_AUTH_REQ_SC_BOND

LE Secure Connection or legacy, no MITM, Bonding.

enumerator BTM_LE_AUTH_REQ_SC_MITM

LE Secure Connection or legacy, MITM, no Bonding.

enumerator BTM_LE_AUTH_REQ_SC_MITM_BOND

LE Secure Connection or legacy , MITM, Bonding.

enumerator BTM_LE_AUTH_REQ_MASK

Auth Request Mask.

enum wiced_bt_dev_oob_data_e

wiced_bt_dev_oob_data_e: OOB Data status.

Values:

enumerator BTM_OOB_NONE

No OOB data.

enumerator BTM_OOB_PRESENT_192

OOB data present (from the P-192 public key)

enumerator BTM_OOB_PRESENT_256

OOB data present (from the P-256 public key)

enumerator BTM_OOB_PRESENT_192_256

OOB data present (from the P-192 and P-256 public keys)

enumerator BTM_OOB_UNKNOWN

OOB data unknown.

enum wiced_bt_dev_oob_data_req_type_e

wiced_bt_dev_oob_data_req_type_e: Type of OOB data required.

Values:

enumerator BTM_OOB_INVALID_TYPE

Invalid OOB Type.

enumerator BTM_OOB_PEER

Peer OOB data requested.

enumerator BTM_OOB_LOCAL

Local OOB data requested.

enumerator BTM_OOB_BOTH

Both local and peer OOB data requested.

enum wiced_bt_dev_le_key_type_e

wiced_bt_dev_le_key_type_e: LE Key type.

Values:

enumerator BTM_LE_KEY_PENC

encryption information of peer device

enumerator BTM_LE_KEY_PID

identity key of the peer device

enumerator BTM_LE_KEY_PCSRK

peer SRK

enumerator BTM_LE_KEY_PLK

peer link key

enumerator BTM_LE_KEY_LENC

Central role security information:div.

enumerator BTM_LE_KEY_LID

Central device ID key.

enumerator BTM_LE_KEY_LCSRK

local CSRK has been deliver to peer

enumerator BTM_LE_KEY_LLK

Local link key.

enum wiced_bt_ble_scan_type_e

wiced_bt_ble_scan_type_e: Scan duty cycle (used for BTM_BLE_SCAN_STATE_CHANGED_EVT and wiced_bt_dev_create_connection)

Values:

enumerator BTM_BLE_SCAN_TYPE_NONE

Stop scanning.

enumerator BTM_BLE_SCAN_TYPE_HIGH_DUTY

General inquiry high duty cycle scan.

enumerator BTM_BLE_SCAN_TYPE_LOW_DUTY

General inquiry low duty cycle scan.

enumerator BTM_BLE_SCAN_TYPE_LIMITED_HIGH_DUTY

Limited inquiry high duty cycle scan.

enumerator BTM_BLE_SCAN_TYPE_LIMITED_LOW_DUTY

Limited inquiry low duty cycle scan.

enum wiced_bt_smp_status_e

wiced_bt_smp_status_e: SMP Pairing status codes.

Values:

enumerator SMP_SUCCESS

Success.

enumerator SMP_PASSKEY_ENTRY_FAIL

Passkey entry failed.

enumerator SMP_OOB_FAIL

OOB failed.

enumerator SMP_PAIR_AUTH_FAIL

Authentication failed.

enumerator SMP_CONFIRM_VALUE_ERR

Value confirmation failed.

enumerator SMP_PAIR_NOT_SUPPORT

Not supported.

enumerator SMP_ENC_KEY_SIZE

Encryption key size failure.

enumerator SMP_INVALID_CMD

Invalid command.

enumerator SMP_PAIR_FAIL_UNKNOWN

Unknown failure.

enumerator SMP_REPEATED_ATTEMPTS

Repeated attempts.

enumerator SMP_INVALID_PARAMETERS

Invalid parameters.

enumerator SMP_DHKEY_CHK_FAIL

DH Key check failed.

enumerator SMP_NUMERIC_COMPAR_FAIL

Numeric comparison failed.

enumerator SMP_BR_PAIRING_IN_PROGR

BR paIring in progress.

enumerator SMP_XTRANS_DERIVE_NOT_ALLOW

Cross transport key derivation not allowed.

enumerator SMP_MAX_FAIL_RSN_PER_SPEC

SMP Max Fail Reason as per spec.

enumerator SMP_PAIR_INTERNAL_ERR

Internal error.

enumerator SMP_UNKNOWN_IO_CAP

unknown IO capability, unable to decide associatino model

enumerator SMP_INIT_FAIL

Initialization failed.

enumerator SMP_CONFIRM_FAIL

Confirmation failed.

enumerator SMP_BUSY

Busy.

enumerator SMP_ENC_FAIL

Encryption failed.

enumerator SMP_STARTED

Started.

enumerator SMP_RSP_TIMEOUT

Response timeout.

enumerator SMP_FAIL

Generic failure.

enumerator SMP_CONN_TOUT

Connection timeout.

enum wiced_bt_multi_adv_opcodes_t

wiced_bt_multi_adv_opcodes_t: BLE Multi adv opcodes returned.

Values:

enumerator SET_ADVT_PARAM_MULTI

Opcode as a result of calling wiced_set_multi_advertisement_params.

enumerator SET_ADVT_DATA_MULTI

Opcode as a result of calling wiced_set_multi_advertisement_data.

enumerator SET_SCAN_RESP_DATA_MULTI

Opcode as a result of calling wiced_set_multi_advertisement_scan_response_data.

enumerator SET_RANDOM_ADDR_MULTI

Opcode as a result of calling wiced_set_multi_advertisements_random_address.

enumerator SET_ADVT_ENABLE_MULTI

Opcode as a result of calling wiced_start_multi_advertisements.

enum wiced_bt_dev_power_mgmt_status_e

wiced_bt_dev_power_mgmt_status_e: Power Management status.

Values:

enumerator BTM_PM_STS_ACTIVE

Active.

enumerator BTM_PM_STS_HOLD

Hold.

enumerator BTM_PM_STS_SNIFF

Sniff.

enumerator BTM_PM_STS_PARK

Park.

enumerator BTM_PM_STS_SSR

Sniff subrating notification.

enumerator BTM_PM_STS_PENDING

Pending (waiting for status from controller)

enumerator BTM_PM_STS_ERROR

Error (controller returned error)

enum wiced_bt_management_evt_e

wiced_bt_management_evt_e: Bluetooth Management events used in wiced_bt_management_cback_t.

note

Some of the events are BR/EDR events which are available only in dual mode(BR/EDR+BLE) operation.

Values:

enumerator BTM_ENABLED_EVT

Bluetooth controller and host stack enabled.

Event data: wiced_bt_dev_enabled_t

enumerator BTM_DISABLED_EVT

Bluetooth controller and host stack disabled.

Event data: NULL

enumerator BTM_POWER_MANAGEMENT_STATUS_EVT

Power management status change.

Event data: wiced_bt_power_mgmt_notification_t

enumerator BTM_RE_START_EVT

Bluetooth controller and host stack re-enabled.

Event data: tBTM_ENABLED_EVT

enumerator BTM_PIN_REQUEST_EVT

PIN request (used only with legacy devices).

Event data: wiced_bt_dev_name_and_class_t

enumerator BTM_USER_CONFIRMATION_REQUEST_EVT

received USER_CONFIRMATION_REQUEST event (respond using wiced_bt_dev_confirm_req_reply).

Event data: wiced_bt_dev_user_cfm_req_t

enumerator BTM_PASSKEY_NOTIFICATION_EVT

received USER_PASSKEY_NOTIFY event.

Event data: wiced_bt_dev_user_key_notif_t

enumerator BTM_PASSKEY_REQUEST_EVT

received USER_PASSKEY_REQUEST event

enumerator BTM_KEYPRESS_NOTIFICATION_EVT

received KEYPRESS_NOTIFY event.

note

BR/EDR Only Event data: wiced_bt_dev_user_keypress_t

enumerator BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT

Requesting IO capabilities for BR/EDR pairing.

Event data: wiced_bt_dev_bredr_io_caps_req_t

note

BR/EDR Only

enumerator BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT

Received IO capabilities response for BR/EDR pairing.

Event data:

enumerator BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT

Requesting IO capabilities for BLE pairing.

note

BR/EDR Only Peripheral can check peer io capabilities in event data before updating with local io capabilities. Event data: wiced_bt_dev_ble_io_caps_req_t

enumerator BTM_PAIRING_COMPLETE_EVT

received SIMPLE_PAIRING_COMPLETE event.

Event data: wiced_bt_dev_pairing_cplt_t

enumerator BTM_ENCRYPTION_STATUS_EVT

Encryption status change.

Event data: wiced_bt_dev_encryption_status_t

enumerator BTM_SECURITY_REQUEST_EVT

Security request (respond using wiced_bt_ble_security_grant).

Event data: wiced_bt_dev_security_request_t

enumerator BTM_SECURITY_FAILED_EVT

Security procedure/authentication failed.

Event data: wiced_bt_dev_security_failed_t

enumerator BTM_SECURITY_ABORTED_EVT

Security procedure aborted locally, or unexpected link drop.

Event data: wiced_bt_dev_name_and_class_t

enumerator BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT

Result of reading local OOB data.

enumerator BTM_REMOTE_OOB_DATA_REQUEST_EVT

OOB data from remote device.

note

BR/EDR Only

Updated remote device link keys (store device_link_keys to NV memory).

note

BR/EDR Only This is the place to verify that the correct link key has been generated. Event data: wiced_bt_device_link_keys_t

Request for stored remote device link keys (restore device_link_keys from NV memory).

If successful, return WICED_BT_SUCCESS. Event data: wiced_bt_device_link_keys_t

enumerator BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT

Update local identity key (stored local_identity_keys NV memory).

Event data: wiced_bt_local_identity_keys_t

enumerator BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT

Request local identity key (get local_identity_keys from NV memory).

If successful, return WICED_BT_SUCCESS. Event data: wiced_bt_local_identity_keys_t

enumerator BTM_BLE_SCAN_STATE_CHANGED_EVT

BLE scan state change.

Event data: wiced_bt_ble_scan_type_t

enumerator BTM_BLE_ADVERT_STATE_CHANGED_EVT

BLE advertisement state change.

Event data: wiced_bt_ble_advert_mode_t

enumerator BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT

SMP remote oob data request.

Reply using wiced_bt_smp_oob_data_reply. Event data: wiced_bt_smp_remote_oob_req_t

enumerator BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT

LE secure connection remote oob data request.

Reply using wiced_bt_smp_sc_oob_reply. Event data: wiced_bt_smp_sc_remote_oob_req_t

note

BR/EDR Only

enumerator BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT

LE secure connection local OOB data (wiced_bt_smp_create_local_sc_oob_data).

Event data: wiced_bt_smp_sc_local_oob_t

enumerator BTM_SCO_CONNECTED_EVT

SCO connected event.

Event data:

enumerator BTM_SCO_DISCONNECTED_EVT

SCO disconnected event.

note

BR/EDR Only Event data:

enumerator BTM_SCO_CONNECTION_REQUEST_EVT

SCO connection request event.

note

BR/EDR Only Event data:

enumerator BTM_SCO_CONNECTION_CHANGE_EVT

SCO connection change event.

note

BR/EDR Only Event data:

enumerator BTM_BLE_CONNECTION_PARAM_UPDATE

BLE connection parameter update.

note

BR/EDR Only Event data: wiced_bt_ble_connection_param_update_t

enumerator BTM_BLE_PHY_UPDATE_EVT

BLE Physical link update.

Event data: wiced_bt_ble_phy_update_t

enumerator BTM_LPM_STATE_LOW_POWER

BT device wake has been deasserted.

Used for Host Stack Use Case.

enumerator BTM_MULTI_ADVERT_RESP_EVENT

Multi adv command status event Used for the status of the command sent.

wiced_bt_dev_link_quality_stats_param_e: Link Quality statistics action type.

Values:

clear link quality stats

read link quality stats

read then clear link quality stats

wiced_bt_link_policy_settings_values_e: .Enumeration of known link policy settings value assignments of the wiced_bt_link_policy_settings_t

Values:

Enable Role Switch.

Enable Hold mode.

Enable Sniff mode.

enum wiced_bt_ble_advert_mode_e

wiced_bt_ble_advert_mode_e: advertisement type (used when calling wiced_bt_start_advertisements)

Values:

enumerator BTM_BLE_ADVERT_OFF

Stop advertising.

enumerator BTM_BLE_ADVERT_DIRECTED_HIGH

Directed advertisement (high duty cycle)

enumerator BTM_BLE_ADVERT_DIRECTED_LOW

Directed advertisement (low duty cycle)

enumerator BTM_BLE_ADVERT_UNDIRECTED_HIGH

Undirected advertisement (high duty cycle)

enumerator BTM_BLE_ADVERT_UNDIRECTED_LOW

Undirected advertisement (low duty cycle)

enumerator BTM_BLE_ADVERT_NONCONN_HIGH

Non-connectable advertisement (high duty cycle)

enumerator BTM_BLE_ADVERT_NONCONN_LOW

Non-connectable advertisement (low duty cycle)

enumerator BTM_BLE_ADVERT_DISCOVERABLE_HIGH

discoverable advertisement (high duty cycle)

enumerator BTM_BLE_ADVERT_DISCOVERABLE_LOW

discoverable advertisement (low duty cycle)

enum wiced_bt_ble_conn_mode_e

wiced_bt_ble_conn_mode_e: scan mode used in initiating

Values:

enumerator BLE_CONN_MODE_OFF

Stop initiating.

enumerator BLE_CONN_MODE_LOW_DUTY

slow connection scan parameter

enumerator BLE_CONN_MODE_HIGH_DUTY

fast connection scan parameter

enum wiced_bt_hci_trace_type_t

wiced_bt_hci_trace_type_t: HCI trace types.

Values:

enumerator HCI_TRACE_EVENT

HCI event data from controller to the host.

enumerator HCI_TRACE_COMMAND

HCI command data from host to controller.

enumerator HCI_TRACE_INCOMING_ACL_DATA

HCI incoming acl data.

enumerator HCI_TRACE_OUTGOING_ACL_DATA

HCI outgoing acl data.

enumerator HCI_TRACE_INCOMING_ISO_DATA

HCI incoming ISO data.

enumerator HCI_TRACE_OUTGOING_ISO_DATA

HCI outgoing ISO data.

enumerator HCI_TRACE_INCOMING_SCO_DATA

HCI incoming sco data.

enumerator HCI_TRACE_OUTGOING_SCO_DATA

HCI outgoing sco data.

struct wiced_bt_ble_advert_elem_t
#include <wiced_bt_ble.h>

Advertisement element.

Public Members

uint8_t *p_data

Advertisement data.

uint16_t len

Advertisement length.

wiced_bt_ble_advert_type_t advert_type

Advertisement data type.

struct wiced_bt_ble_scan_results_t
#include <wiced_bt_ble.h>

LE inquiry result type.

Public Members

wiced_bool_t is_extended

True if an extended ADV.

wiced_bt_device_address_t remote_bd_addr

Device address.

uint8_t ble_addr_type

LE Address type.

wiced_bt_dev_ble_evt_type_t ble_evt_type

Scan result event type.

int8_t rssi

Set to BTM_INQ_RES_IGNORE_RSSI, if not valid.

uint8_t flag

Adverisement Flag value.

uint8_t primary_phy

Primary PHY.

uint8_t secondary_phy

Secondary PHY.

uint8_t adv_sid

advertisement security ID

uint8_t tx_power

Tx power.

uint16_t periodic_adv_interval

Periodic advertisement interval.

uint8_t direct_addr_type

Directed address type.

wiced_bt_device_address_t direct_bda

Directed address.

struct wiced_bt_ble_phy_preferences_t
#include <wiced_bt_ble.h>

Host PHY preferences.

Public Members

wiced_bt_device_address_t remote_bd_addr

Peer Device address.

wiced_bt_ble_host_phy_preferences_t tx_phys

Host preference among the TX PHYs.

wiced_bt_ble_host_phy_preferences_t rx_phys

Host preference among the RX PHYs.

wiced_bt_ble_lelr_phy_preferences_t phy_opts

Host preference on LE coded PHY.

struct wiced_bt_ble_conn_params_t
#include <wiced_bt_ble.h>

BLE connection parameteres.

Public Members

uint8_t role

Connection role 0: Central 1: Peripheral.

uint16_t conn_interval

Connection interval in slots.

uint16_t conn_latency

Connection latency.

uint16_t supervision_timeout

Supervision timeout.

struct wiced_bt_ble_pref_conn_params_t
#include <wiced_bt_ble.h>

BLE preferred connection parameters.

Public Members

uint16_t conn_interval_min

minimum connection interval

uint16_t conn_interval_max

maximum connection interval

uint16_t conn_latency

connection latency

uint16_t conn_supervision_timeout

connection supervision timeout

struct wiced_bt_ble_multi_adv_params_t
#include <wiced_bt_ble.h>

LE Multi advertising parameter.

Public Members

uint16_t adv_int_min

< BTM_BLE_ADVERT_INTERVAL_MIN to BTM_BLE_ADVERT_INTERVAL_MAX ( As per spec )

Minimum adv interval BTM_BLE_ADVERT_INTERVAL_MIN to BTM_BLE_ADVERT_INTERVAL_MAX ( As per spec )

uint16_t adv_int_max

Maximum adv interval.

wiced_bt_ble_multi_advert_type_t adv_type

Adv event type.

wiced_bt_ble_advert_chnl_map_t channel_map

Adv channel map.

wiced_bt_ble_advert_filter_policy_t adv_filter_policy

Advertising filter policy.

wiced_bt_ble_adv_tx_power_t adv_tx_power

Adv tx power.

wiced_bt_device_address_t peer_bd_addr

Peer Device address.

wiced_bt_ble_address_type_t peer_addr_type

Peer LE Address type.

wiced_bt_device_address_t own_bd_addr

Own LE address.

wiced_bt_ble_address_type_t own_addr_type

Own LE Address type.

struct wiced_bt_ble_ext_adv_duration_config_t
#include <wiced_bt_ble.h>

Advertisement duration configuration for specified adv handle.

Public Members

wiced_bt_ble_ext_adv_handle_t adv_handle

advertisement set handle

uint16_t adv_duration

0 = No advertising duration.

Advertising to continue until the Host disables it. 0xXXXX = Range: 0x0001 - 0xFFFF (10 ms to 655,350 ms)

uint8_t max_ext_adv_events

0xXX: Maximum number of extended advertising events the Controller shall attempt to send prior to disabling the extended advertising set even if the adv_duration parameter has not expired.

0x00: No maximum number of advertising events

struct wiced_bt_ble_ext_conn_cfg_t
#include <wiced_bt_ble.h>

Extended ADV connection configuration structure.

Public Members

wiced_bt_ble_ext_adv_phy_mask_t initiating_phys

< Bit 0 = 1: Scan connectable advertisements on the LE 1M PHY.

Connection parameters for the LE 1M PHY are provided. Bit 1 = 1: Connection parameters for the LE 2M PHY are provided. Bit 2 = 1: Scan connectable advertisements on the LE Coded PHY. Connection parameters for the LE Coded PHY are provided the PHY(s) bit mask on which the advertising packets should be received on the primary advertising channel and the PHYs for which connection parameters have been specified.

uint16_t scan_int[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0004 to 0xFFFF.Time = N * 0.625 ms.

Time Range: 2.5 ms to 40.959375 s

uint16_t scan_window[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0004 to 0xFFFF.Time = N * 0.625 ms.

Time Range: 2.5 ms to 40.959375 s

uint16_t min_conn_int[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0006 to 0x0C80 Time = N * 1.25 ms Time Range: 7.5 ms to 4 s.

uint16_t max_conn_int[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0006 to 0x0C80 Time = N * 1.25 ms Time Range: 7.5 ms to 4 s.

uint16_t conn_latency[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0000 to 0x01F3.

uint16_t supervision_to[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x000A to 0x0C80 Time = N * 10 ms Time Range: 100 ms to 32 s.

uint16_t min_ce_len[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0000 � 0xFFFF.

Time = N * 0.625 ms

uint16_t max_ce_len[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0000 � 0xFFFF.

Time = N * 0.625 ms

struct wiced_bt_ble_ext_adv_report_t
#include <wiced_bt_ble.h>

Extended advertisement report data format.

Note:When multiple advertising packets are used to complete a single advertising report(i.e. if adv set data received as multipl adv reports), the RSSI and TxPower event parameters shall be set based on the last packet received.

Public Members

wiced_bt_ble_adv_report_event_mask_t event_type

Type of the adv.

(See wiced_bt_ble_adv_report_event_mask_t)

wiced_bt_ble_address_type_t addr_type

advertiser address type

wiced_bt_device_address_t bd_addr

advertiser address

wiced_bt_ble_ext_adv_phy_t prim_phy

PHY on which extended ADV PDUs received.

wiced_bt_ble_ext_adv_phy_t sec_phy

PHY on which auxilary ADV PDUs received.

wiced_bt_ble_ext_adv_sid_t adv_sid

advertising set identifier

int8_t tx_pwr

advertisement transmit power

int8_t rssi

advertisement RSSI

uint16_t periodic_adv_int

Interval of the periodic advertisements if periodic adv enabled on the same set.

Range: N = 0x0006 to 0xFFFF, Time = N * 1.25 ms

wiced_bt_ble_address_type_t dir_addr_type

Target device address type in case of directed adv report.

wiced_bt_device_address_t dir_bdaddr

Target device address in case of directed adv report.

uint8_t data_len

adv data length

uint8_t ad_data[]

adv data

struct wiced_bt_ble_periodic_adv_sync_established_event_data_t
#include <wiced_bt_ble.h>

Sync extablished to periodic advertiser event data format.

(The LE Periodic Advertising Sync Established event indicates that the Controller has received the first periodic advertising packet from an advertiser after the LE_Periodic_Advertising_Create_Sync Command has been sent to the Controller.)

Public Members

uint8_t status

HCI status.

wiced_bt_ble_periodic_adv_sync_handle_t sync_handle

sync handle

wiced_bt_ble_ext_adv_sid_t adv_sid

advertisement set identifier

wiced_bt_ble_address_type_t adv_addr_type

advertiser address type

wiced_bt_device_address_t adv_addr

advertiser address

wiced_bt_ble_ext_adv_phy_t adv_phy

advertiser phy

uint16_t periodic_adv_int

Periodic adv interval.

wiced_bt_ble_advertiser_clock_accuracy_t advertiser_clock_accuracy

advertiser clock accuracy

struct wiced_bt_ble_periodic_adv_report_event_data_t
#include <wiced_bt_ble.h>

Periodic advertising report data format.

Public Members

wiced_bt_ble_periodic_adv_sync_handle_t sync_handle

sync handle

int8_t adv_tx_power

advertisement transmit power Range: -127 to +126 dbm.

127 means tx power is not available

int8_t adv_rssi

RSSI.

range: -127 to +126. 127 means RSSI is not available

uint8_t cte_type

CTE Type.

uint8_t data_status

0 = complete data, 1 = data incomplete more data to come, 2 = data truncated.other RFU

uint8_t data_len

Range: 0 -248.

Other values RFU

uint8_t adv_data[WICED_BT_BLE_MAX_EXT_ADV_DATA_LEN]

periodic adv data

struct wiced_bt_ble_ext_adv_set_terminated_event_data_t
#include <wiced_bt_ble.h>

extended adv set terminated event data format.

This event generated asynchronously by the controller when adv set get terminated either adv duration expires or connection being created

Public Members

uint8_t status

HCI status.

wiced_bt_ble_ext_adv_handle_t adv_handle

advertisement set handle

wiced_bt_ble_connection_handle_t conn_handle

connection handle.

The conn_handle parameter is only valid when advertising ends because a connection was created

uint8_t num_completed_ext_adv_events

number of completed extended advertising events the Controller had transmitted when either the duration elapsed or the maximum number of extended advertising events was reached; otherwise it shall be set to zero.

struct wiced_bt_ble_scan_req_received_event_data_t
#include <wiced_bt_ble.h>

scan request received event data format

Public Members

wiced_bt_ble_ext_adv_handle_t adv_handle

advertisement set handle

wiced_bt_ble_address_type_t scanner_addr_type

Scanner address type.

wiced_bt_device_address_t scanner_address

Scanner address.

struct wiced_bt_ble_channel_sel_algo_event_data_t
#include <wiced_bt_ble.h>

Channel selection algorithm event data format.

Public Members

wiced_bt_ble_connection_handle_t connection_handle

HCI connection handle.

wiced_bt_ble_channel_sel_algo_t channel_sel_algo

BLE channel selection algorithm used for this connection.

union wiced_bt_ble_adv_ext_event_data_t
#include <wiced_bt_ble.h>

union of events data

Public Members

wiced_bt_ble_periodic_adv_sync_established_event_data_t sync_establish

Data for WICED_BT_BLE_PERIODIC_ADV_SYNC_ESTABLISHED_EVENT.

wiced_bt_ble_periodic_adv_report_event_data_t periodic_adv_report

Data for WICED_BT_BLE_PERIODIC_ADV_REPORT_EVENT.

wiced_bt_ble_periodic_adv_sync_handle_t sync_handle

Data for WICED_BT_BLE_PERIODIC_ADV_SYNC_LOST_EVENT.

wiced_bt_ble_ext_adv_set_terminated_event_data_t adv_set_terminated

Data for WICED_BT_BLE_ADV_SET_TERMINATED_EVENT.

wiced_bt_ble_scan_req_received_event_data_t scan_req_received

Data for WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT.

wiced_bt_ble_channel_sel_algo_event_data_t channel_sel_algo

Data for WICED_BT_BLE_CHANNEL_SEL_ALGO_EVENT.

struct wiced_bt_ble_ext_scan_config_t
#include <wiced_bt_ble.h>

Configuration for extended scanning.

Public Members

wiced_bt_ble_ext_adv_phy_mask_t scanning_phys

The Scanning_PHYs parameter indicates the PHY(s) on which the advertising packets should be received on the primary advertising channel.

uint8_t enc_phy_scan_type

encoded phy scan type.

(active or passive)

uint16_t enc_phy_scan_int

encoded phy scan interval

uint16_t enc_phy_scan_win

encoded phy scan window

uint16_t duration

When the Duration and Period parameters are non-zero, the Controller shall scan for the duration of the Duration parameter within a scan period specified by the Period parameter.

After the scan period has expired, a new scan period shall begin and scanning shall begin again for the duration specified. The scan periods continue until the Host disables scanning. Duration parameter cannot be greater than or equal to the Period parameter If the Duration parameter is zero or both the Duration parameter and Period parameter are non-zero controller continue scanning until host disable scanning with enable set to false Scan duration

uint16_t period

Scan period.

struct wiced_bt_tx_power_result_t
#include <wiced_bt_dev.h>

TX Power Result (in response to wiced_bt_dev_read_tx_power)

Public Members

wiced_result_t status

Status of the operation.

uint8_t hci_status

Status from controller (Refer Spec 5.0 Vol 2 Part D Error Codes)

int8_t tx_power

TX power in dB.

wiced_bt_device_address_t rem_bda

Remote BD address.

struct wiced_bt_set_adv_tx_power_result_t
#include <wiced_bt_dev.h>

TX Power Result (in response to wiced_bt_ble_set_adv_tx_power)

Public Members

uint16_t un_used1

Unused.

uint16_t un_used2

Unused.

uint8_t *p_param_buf

Command status, see list of HCI Error codes in core spec.

struct wiced_bt_dev_vendor_specific_command_complete_params_t
#include <wiced_bt_dev.h>

Structure returned with Vendor Specific Command complete callback.

Public Members

uint16_t opcode

Vendor specific command opcode.

uint16_t param_len

Return parameter length.

uint8_t *p_param_buf

Return parameter buffer (Contains Command Specific data)

struct wiced_bt_dev_local_addr_ext_t
#include <wiced_bt_dev.h>

Structure for local address extendend API.

note

#wiced_bt_dev_read_local_addr_ext API function sets private_addr_type and private_addr only if BLE privacy is set to true

Public Members

wiced_bool_t is_static_rand_addr_used

True if static random address is used.

wiced_bool_t is_privacy_enabled

True BLE Privacy is enabled.

wiced_bt_ble_address_type_t private_addr_type

Private address type.

wiced_bt_device_address_t private_addr

Private address.

wiced_bt_device_address_t local_addr

Local Bluetooth Address.

struct wiced_bt_public_key_t
#include <wiced_bt_dev.h>

Public key.

Public Members

BT_OCTET32 x

X cordinate value.

BT_OCTET32 y

Y cordinate value.

struct wiced_bt_smp_sc_local_oob_t
#include <wiced_bt_dev.h>

Data for BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT.

Public Members

wiced_bool_t present

TRUE if local oob is present.

BT_OCTET16 randomizer

randomizer

BT_OCTET16 commitment

commitment

wiced_bt_ble_address_t addr_sent_to

peer address sent to

BT_OCTET32 private_key_used

private key

wiced_bt_public_key_t public_key_used

public key

struct wiced_bt_smp_remote_oob_req_t
#include <wiced_bt_dev.h>

data type for BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT

Public Members

wiced_bt_device_address_t bd_addr

peer address

struct wiced_bt_smp_sc_remote_oob_req_t
#include <wiced_bt_dev.h>

data type for BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT

Public Members

wiced_bt_device_address_t bd_addr

peer address

wiced_bt_dev_oob_data_req_type_t oob_type

requested oob data types (BTM_OOB_PEER, BTM_OOB_LOCAL, or BTM_OOB_BOTH)

struct wiced_bt_dev_user_keypress_t
#include <wiced_bt_dev.h>

Pairing keypress notification (BTM_USER_KEYPRESS_NOTIFICATION_EVT event data type)

Public Members

wiced_bt_device_address_t bd_addr

peer address

wiced_bt_dev_passkey_entry_type_t keypress_type

type of keypress

struct wiced_bt_dev_user_key_notif_t
#include <wiced_bt_dev.h>

Data for pairing passkey notification (BTM_USER_PASSKEY_NOTIFICATION_EVT event data type)

Public Members

wiced_bt_device_address_t bd_addr

peer address

uint32_t passkey

passkey

struct wiced_bt_dev_br_edr_pairing_info_t
#include <wiced_bt_dev.h>

BR/EDR pairing complete infomation.

Public Members

uint8_t status

status of the simple pairing process (see defintions for HCI status codes)

struct wiced_bt_dev_user_cfm_req_t
#include <wiced_bt_dev.h>

Data for pairing confirmation request (BTM_USER_CONFIRMATION_REQUEST_EVT event data type)

Public Members

wiced_bt_device_address_t bd_addr

peer address

uint32_t numeric_value

numeric value for comparison (if “just_works”, do not show this number to UI)

wiced_bool_t just_works

TRUE, if using “just works” association model.

wiced_bt_dev_auth_req_t local_authentication_requirements

Authentication requirement for local device.

wiced_bt_dev_auth_req_t remote_authentication_requirements

Authentication requirement for peer device.

struct wiced_bt_dev_ble_pairing_info_t
#include <wiced_bt_dev.h>

BLE pairing complete infomation.

Public Members

wiced_result_t status

status of the simple pairing process

uint8_t reason

failure reason (see wiced_bt_smp_status_t)

uint8_t sec_level

0 - None, 1- Unauthenticated Key, 4-Authenticated Key

wiced_bool_t is_pair_cancel

True if cancelled, else False.

wiced_bt_device_address_t resolved_bd_addr

Resolved address (if remote device using private address)

wiced_bt_ble_address_type_t resolved_bd_addr_type

Resolved addr type of bonded device.

union wiced_bt_dev_pairing_info_t
#include <wiced_bt_dev.h>

Transport dependent pairing complete infomation.

Public Members

wiced_bt_dev_br_edr_pairing_info_t br_edr

BR/EDR pairing complete infomation.

wiced_bt_dev_ble_pairing_info_t ble

BLE pairing complete infomation.

struct wiced_bt_dev_pairing_cplt_t
#include <wiced_bt_dev.h>

Pairing complete notification (BTM_PAIRING_COMPLETE_EVT event data type)

Public Members

uint8_t *bd_addr

peer address

wiced_bt_transport_t transport

BT_TRANSPORT_BR_EDR or BT_TRANSPORT_LE.

wiced_bt_dev_pairing_info_t pairing_complete_info

Transport dependent pairing complete infomation.

struct wiced_bt_dev_security_failed_t
#include <wiced_bt_dev.h>

Security/authentication failure status (used by BTM_SECURITY_FAILED_EVT notication)

Public Members

wiced_bt_device_address_t bd_addr

[in] Peer address

wiced_result_t status

Status of the operation.

uint8_t hci_status

Status from controller.

struct wiced_bt_dev_security_request_t
#include <wiced_bt_dev.h>

Security request (BTM_SECURITY_REQUEST_EVT event data type)

Public Members

wiced_bt_device_address_t bd_addr

peer address

struct wiced_bt_dev_bonded_device_info_t
#include <wiced_bt_dev.h>

bonding device information from wiced_bt_dev_get_bonded_devices

Public Members

wiced_bt_device_address_t bd_addr

peer address

wiced_bt_ble_address_type_t addr_type

peer address type : BLE_ADDR_PUBLIC/BLE_ADDR_RANDOM

wiced_bt_device_type_t device_type

peer device type : BT_DEVICE_TYPE_BREDR/BT_DEVICE_TYPE_BLE/BT_DEVICE_TYPE_BREDR_BLE

struct wiced_bt_local_id_keys
#include <wiced_bt_dev.h>

LE keys.

Public Members

BT_OCTET16 ir

IR Key.

BT_OCTET16 irk

IRK Key.

BT_OCTET16 dhk

DHK Key.

struct wiced_bt_local_identity_keys_t
#include <wiced_bt_dev.h>

LE identity key for local device (used by BTM_LE_LOCAL_IDENTITY_KEYS_UPDATE_EVT and BTM_LE_LOCAL_KEYS_REQUEST_EVT notification)

Public Members

uint8_t key_type_mask

The type of the key (BTM_BLE_KEY_TYPE_ID or BTM_BLE_KEY_TYPE_ER)

wiced_bt_local_id_keys id_keys

Local ID Keys.

BT_OCTET16 er

BLE encryption key.

struct wiced_bt_ble_connection_param_update_t
#include <wiced_bt_dev.h>

BLE connection parameter update event related data.

Public Members

uint8_t status

connection parameters update status

wiced_bt_device_address_t bd_addr

peer bd address

uint16_t conn_interval

updated connection interval ( in 0.625msec )

uint16_t conn_latency

updated connection latency

uint16_t supervision_timeout

updated supervision timeout

struct wiced_bt_ble_phy_update_t
#include <wiced_bt_dev.h>

BLE Physical link update event related data.

Public Members

uint8_t status

LE Phy update status.

wiced_bt_device_address_t bd_address

peer BD address

uint8_t tx_phy

Transmitter PHY, values: 1=1M, 2=2M, 3=LE coded.

uint8_t rx_phy

Receiver PHY, values: 1=1M, 2=2M, 3=LE coded.

struct wiced_bt_ble_multi_adv_response_t
#include <wiced_bt_dev.h>

BLE Multi adv VSC response data.

Public Members

wiced_bt_multi_adv_opcodes_t opcode

Multi adv vendor specifiv opcode.

uint8_t status

status of the operation received from controller, 0 - Success.

Check the HCI error codes Vol 1, Part F, Table 1.1 Error codes

struct wiced_bt_dev_enabled_t
#include <wiced_bt_dev.h>

Device enabled (used by BTM_ENABLED_EVT)

Public Members

wiced_result_t status

Status.

struct wiced_bt_dev_disabled_t
#include <wiced_bt_dev.h>

Device disabled (used by BTM_DISABLED_EVT)

Public Members

uint8_t reason

Reason for BTM Disable.

struct wiced_bt_dev_name_and_class_t
#include <wiced_bt_dev.h>

Remote device information (used by BTM_PIN_REQUEST_EVT, BTM_SECURITY_ABORTED_EVT)

Public Members

wiced_bt_device_address_t *bd_addr

BD Address of remote.

wiced_bt_dev_class_t *dev_class

peer class of device

uint8_t *bd_name

BD Name of remote.

struct wiced_bt_power_mgmt_notification_t
#include <wiced_bt_dev.h>

Change in power management status (used by BTM_POWER_MANAGEMENT_STATUS_EVT notication)

Public Members

wiced_bt_device_address_t bd_addr

BD Address of remote.

wiced_bt_dev_power_mgmt_status_t status

PM status.

uint16_t value

Additional mode data.

uint8_t hci_status

HCI status.

struct wiced_bt_dev_encryption_status_t
#include <wiced_bt_dev.h>

Encryption status change (used by BTM_ENCRYPTION_STATUS_EVT)

Public Members

uint8_t *bd_addr

BD Address of remote.

wiced_bt_transport_t transport

BT_TRANSPORT_BR_EDR or BT_TRANSPORT_LE.

void *p_ref_data

Optional data passed in by wiced_bt_dev_set_encryption.

wiced_result_t result

Result of the operation.

struct wiced_bt_dev_local_oob_t
#include <wiced_bt_dev.h>

Local OOB data BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT.

Public Members

wiced_result_t status

Status.

wiced_bool_t is_extended_oob_data

TRUE if extended OOB data.

BT_OCTET16 c_192

Simple Pairing Hash C derived from the P-192 public key.

BT_OCTET16 r_192

Simple Pairing Randomnizer R associated with the P-192 public key.

BT_OCTET16 c_256

Simple Pairing Hash C derived from the P-256 public key (valid only if is_extended_oob_data=TRUE)

BT_OCTET16 r_256

Simple Pairing Randomnizer R associated with the P-256 public key (valid only if is_extended_oob_data=TRUE)

struct wiced_bt_dev_remote_oob_t
#include <wiced_bt_dev.h>

BTM_REMOTE_OOB_DATA_REQUEST_EVT.

Public Members

wiced_bt_device_address_t bd_addr

BD Address of remote.

wiced_bool_t extended_oob_data

TRUE if requesting extended OOB (P-256)

struct wiced_bt_dev_bredr_io_caps_req_t
#include <wiced_bt_dev.h>

BR/EDR Pairing IO Capabilities (to be filled by application callback on BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT)

Public Members

wiced_bt_device_address_t bd_addr

[in] BD Address of remote

wiced_bt_dev_io_cap_t local_io_cap

local IO capabilities (to be filled by application callback)

wiced_bt_dev_oob_data_t oob_data

OOB data present at peer device for the local device.

wiced_bt_dev_auth_req_t auth_req

Authentication required for peer device.

wiced_bool_t is_orig

TRUE, if local device initiated the pairing process.

struct wiced_bt_dev_ble_io_caps_req_t
#include <wiced_bt_dev.h>

BLE Pairing IO Capabilities (to be filled by application callback on BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT)

Public Members

wiced_bt_device_address_t bd_addr

[in] BD Address of remote

wiced_bt_dev_io_cap_t local_io_cap

local IO capabilities (to be filled by application callback)

uint8_t oob_data

OOB data present (locally) for the peer device.

wiced_bt_dev_le_auth_req_t auth_req

Authentication request (for local device) contain bonding and MITM info.

uint8_t max_key_size

Max encryption key size.

wiced_bt_dev_le_key_type_t init_keys

Keys to be distributed, bit mask.

wiced_bt_dev_le_key_type_t resp_keys

keys to be distributed, bit mask

struct wiced_bt_ble_keys_t
#include <wiced_bt_dev.h>

Paired device BLE Keys.

Public Members

BT_OCTET16 irk

peer diverified identity root

BT_OCTET16 pltk

peer long term key

BT_OCTET16 pcsrk

peer SRK peer device used to secured sign local data

BT_OCTET16 lltk

local long term key

BT_OCTET16 lcsrk

local SRK peer device used to secured sign local data

BT_OCTET8 rand

random vector for LTK generation

uint16_t ediv

LTK diversifier of this Peripheral device.

uint16_t div

local DIV to generate local LTK=d1(ER,DIV,0) and CSRK=d1(ER,DIV,1)

uint8_t sec_level

local pairing security level

uint8_t key_size

key size of the LTK delivered to peer device

uint8_t srk_sec_level

security property of peer SRK for this device

uint8_t local_csrk_sec_level

security property of local CSRK for this device

uint32_t counter

peer sign counter for verifying rcv signed cmd

uint32_t local_counter

local sign counter for sending signed write cmd

struct wiced_bt_device_sec_keys_t
#include <wiced_bt_dev.h>

Paired Device Link key data.

Public Members

uint8_t br_edr_key_type

BR/EDR Link Key type.

wiced_bt_link_key_t br_edr_key

BR/EDR Link Key.

wiced_bt_dev_le_key_type_t le_keys_available_mask

Mask of available BLE keys.

wiced_bt_ble_address_type_t ble_addr_type

LE device type: public or random address.

wiced_bt_ble_keys_t le_keys

LE keys.

#include <wiced_bt_dev.h>

Paired device link key notification (used by BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT notication)

Public Members

[in] BD Address of remote

[in/out] Key data

[in] BD Address remote used to originate connection

struct wiced_bt_device_br_packet_types_t
#include <wiced_bt_dev.h>

BR packets statistics details.

Public Members

uint16_t null_count

No.of NULL packets received/transmitted.

uint16_t pool_count

No.of POLL packets received/transmitted.

uint16_t dm1_count

No.of DM1 packets received/transmitted.

uint16_t dh1_count

No.of DH1 packets received/transmitted.

uint16_t dv_count

No.of DV packets received/transmitted.

uint16_t aux1_count

No.of AUX1 packets received/transmitted.

uint16_t dm3_count

No.of DM3 packets received/transmitted.

uint16_t dh3_count

No.of DH3 packets received/transmitted.

uint16_t dm5_count

No.of DM5 packets received/transmitted.

uint16_t dh5_count

No.of DH5 packets received/transmitted.

struct wiced_bt_device_edr_packet_types_t
#include <wiced_bt_dev.h>

EDR packets statistics types details.

Public Members

uint16_t null_count

No.of NULL packets received/transmitted.

uint16_t pool_count

No.of POLL packets received/transmitted.

uint16_t dm1_count

No.of DM1 packets received/transmitted.

uint16_t _2_dh1_count

No.of 2DH1 packets received/transmitted.

uint16_t _3_dh1_count

No.of 3DH1 packets received/transmitted.

uint16_t _2_dh3_count

No.of 2DH3 packets received/transmitted.

uint16_t _3_dh3_count

No.of 3DH3 packets received/transmitted.

uint16_t _2_dh5_count

No.of 2DH5 packets received/transmitted.

uint16_t _3_dh5_count

No.of 3DH5 packets received/transmitted.

uint16_t not_used

Not Used.

union wiced_bt_br_edr_pkt_type_stats
#include <wiced_bt_dev.h>

BR/EDR packet types detail statistics.

Public Members

uint16_t array[10]

Statistic Arrary.

wiced_bt_device_br_packet_types_t br_packet_types

BR packets statistics details.

BR packet statastics

wiced_bt_device_edr_packet_types_t edr_packet_types

EDR packet statastics.

struct wiced_bt_lq_br_edr_stats
#include <wiced_bt_dev.h>

BR/EDR link statistics.

Public Members

wiced_bt_br_edr_pkt_type_stats rxPkts

Received packets details.

wiced_bt_br_edr_pkt_type_stats txPkts

Transmitted packets details.

uint32_t rxAclBytes

Total Received ACL bytes.

uint32_t txAclBytes

Total Transmitted ACL bytes.

uint16_t hecErrs

hecErrs packet count

uint16_t crcErrs

crcErrs packet count

uint16_t seqnRepeat

seqnRepeat packet count

struct wiced_bt_lq_le_stats
#include <wiced_bt_dev.h>

LE link statistics.

Public Members

uint32_t tx_pkt_cnt

transmit packet count

uint32_t tx_acked_cnt

transmit packet acknowledged count

uint32_t rx_good_pkt_cnt

received good packet count

uint32_t rx_good_bytes

received good byte count

uint32_t rx_all_pkt_sync_to

all received packet sync timeout count

uint32_t rx_all_pkt_crc_err

all received packet crc error count

struct wiced_bt_lq_stats_result_t
#include <wiced_bt_dev.h>

LQ Quality Result (in response to wiced_bt_dev_lq_stats)

Public Members

uint8_t status

event status

uint16_t conn_handle

connection handle of link quality stats

uint8_t action

see wiced_bt_dev_link_quality_stats_param for options

wiced_bt_lq_br_edr_stats br_edr_stats

br edr statistics

wiced_bt_lq_le_stats le_stats

le statistics

union wiced_bt_lq_stats_result_t::[anonymous] wiced_bt_lq_stats

LQ Quality Statistics.

union wiced_bt_management_evt_data_t
#include <wiced_bt_dev.h>

Structure definitions for Bluetooth Management (wiced_bt_management_cback_t) event notifications.

Public Members

wiced_bt_dev_enabled_t enabled

Data for BTM_ENABLED_EVT.

wiced_bt_dev_disabled_t disabled

Data for BTM_DISABLED_EVT.

wiced_bt_power_mgmt_notification_t power_mgmt_notification

Data for BTM_POWER_MANAGEMENT_STATUS_EVT.

wiced_bt_dev_name_and_class_t pin_request

Data for BTM_PIN_REQUEST_EVT.

wiced_bt_dev_user_cfm_req_t user_confirmation_request

Data for BTM_USER_CONFIRMATION_REQUEST_EVT.

wiced_bt_dev_user_key_notif_t user_passkey_notification

Data for BTM_USER_PASSKEY_NOTIFICATION_EVT.

wiced_bt_dev_user_key_req_t user_passkey_request

Data for BTM_USER_PASSKEY_REQUEST_EVT.

wiced_bt_dev_user_keypress_t user_keypress_notification

Data for BTM_USER_KEYPRESS_NOTIFICATION_EVT - See wiced_bt_dev_user_keypress_t.

wiced_bt_dev_bredr_io_caps_req_t pairing_io_capabilities_br_edr_request

Data for BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT.

wiced_bt_dev_bredr_io_caps_rsp_t pairing_io_capabilities_br_edr_response

Data for BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT.

wiced_bt_dev_ble_io_caps_req_t pairing_io_capabilities_ble_request

Data for BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT.

wiced_bt_dev_pairing_cplt_t pairing_complete

Data for BTM_PAIRING_COMPLETE_EVT.

wiced_bt_dev_encryption_status_t encryption_status

Data for BTM_ENCRYPTION_STATUS_EVT.

wiced_bt_dev_security_request_t security_request

Data for BTM_SECURITY_REQUEST_EVT.

wiced_bt_dev_security_failed_t security_failed

Data for BTM_SECURITY_FAILED_EVT See wiced_bt_dev_security_failed_t.

wiced_bt_dev_name_and_class_t security_aborted

Data for BTM_SECURITY_ABORTED_EVT.

wiced_bt_dev_local_oob_t read_local_oob_data_complete

Data for BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT.

wiced_bt_dev_remote_oob_t remote_oob_data_request

Data for BTM_REMOTE_OOB_DATA_REQUEST_EVT.

Data for BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT.

Data for BTM_PAIRED_DEVICE_LINK_KEYS_REQUEST_EVT.

wiced_bt_local_identity_keys_t local_identity_keys_update

Data for BTM_LOCAL_IDENTITY_KEYS_UPDATE_EVT.

wiced_bt_local_identity_keys_t local_identity_keys_request

Data for BTM_LOCAL_IDENTITY_KEYS_REQUEST_EVT.

wiced_bt_ble_scan_type_t ble_scan_state_changed

Data for BTM_BLE_SCAN_STATE_CHANGED_EVT.

wiced_bt_ble_advert_mode_t ble_advert_state_changed

Data for BTM_BLE_ADVERT_STATE_CHANGED_EVT.

wiced_bt_smp_remote_oob_req_t smp_remote_oob_data_request

Data for BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT.

wiced_bt_smp_sc_remote_oob_req_t smp_sc_remote_oob_data_request

Data for BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT.

wiced_bt_smp_sc_local_oob_t *p_smp_sc_local_oob_data

Data for BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT.

wiced_bt_sco_connected_t sco_connected

Data for BTM_SCO_CONNECTED_EVT.

wiced_bt_sco_disconnected_t sco_disconnected

Data for BTM_SCO_DISCONNECTED_EVT.

wiced_bt_sco_connection_request_t sco_connection_request

Data for BTM_SCO_CONNECTION_REQUEST_EVT.

wiced_bt_sco_connection_change_t sco_connection_change

Data for BTM_SCO_CONNECTION_CHANGE_EVT.

wiced_bt_ble_connection_param_update_t ble_connection_param_update

Data for BTM_BLE_CONNECTION_PARAM_UPDATE.

wiced_bt_ble_phy_update_t ble_phy_update_event

Data for BTM_BLE_PHY_UPDATE_EVT.

wiced_bt_ble_multi_adv_response_t ble_multi_adv_response_event

Response status update event for the multiadv command BTM_MULTI_ADV_VSC_RESP_EVENT.