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 ACL connections (BR/EDR and LE)

  • SCO Channels - manages SCO connections

  • Power Management - manages park, sniff, hold, etc.

Defines

BTM_INQ_RES_IGNORE_RSSI

RSSI value not supplied (ignore it)

BTM_SCAN_PARAM_IGNORE

Passed to BTM_SetScanConfig() to ignore.

BTM_DEFAULT_DISC_WINDOW

Default Discovery Window (in 0.625 msec intervals)

BTM_DEFAULT_DISC_INTERVAL

Default Discovery Interval (in 0.625 msec intervals)

BTM_DEFAULT_CONN_WINDOW

Default Connection Window.

BTM_DEFAULT_CONN_INTERVAL

Default Connection Interval.

BTM_DISCOVERABLE_MASK

Discoverable Mask.

BTM_MAX_DISCOVERABLE

Max Value for Discoverable.

BTM_CONNECTABLE_MASK

Connectable Mask.

BTM_SCAN_TYPE_STANDARD

Standard Scan Type : Device listens for the duration of the scan window.

BTM_SCAN_TYPE_INTERLACED

Interlaces Scan Type : Device performed two back to back scans.

BTM_INQ_RESULT

Inquiry results.

BTM_INQ_RESULT_WITH_RSSI

Inquiry results with RSSI.

BTM_INQ_RESULT_EXTENDED

Extended Inquiry results.

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.

SCO link type.

Link type SCO

Link type eSCO.

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

Bluetooth pairing keypress value (see wiced_bt_dev_passkey_entry_type_e)

typedef uint8_t wiced_bt_sco_type_t

SCO link type.

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

Parameters
  • event – : Event ID

  • p_event_data – : Event data

Returns

Status of event handling

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
  • bd_addr[in] : BD Address of remote

  • p_features[in] : BR/EDR Peer feature

  • is_connected[in] : TRUE if connected

  • handle[in] : Connection handle

  • transport[in] : BT_TRANSPORT_BR_EDR or BT_TRANSPORT_LE

  • reason[in] : 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.

Parameters

p_data – : Operation dependent data

Returns

void

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.

Parameters

p_command_complete_params – : Command complete parameters.

Returns

void

void() wiced_bt_remote_name_cback_t (wiced_bt_dev_remote_name_result_t *p_remote_name_result)

Remote name result callback.

Parameters

p_remote_name_result – : Remote name result data

Returns

voidremote name result callback

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

Parameters
  • type[in] : Trace type

  • length[in] : Length of the trace data

  • p_data[in] : Pointer to the data

Returns

void

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

Parameters
  • p_trace_buf[in] : Trace buffer

  • trace_buf_len[in] : Length of the trace data

  • trace_type[in] : Trace type

Returns

void

Enums

enum wiced_bt_discoverability_mode_e

wiced_bt_discoverability_mode_e: BR-EDR Discoverable modes.

Values:

enumerator BTM_NON_DISCOVERABLE

Non discoverable.

enumerator BTM_LIMITED_DISCOVERABLE

Limited BR/EDR discoverable.

enumerator BTM_GENERAL_DISCOVERABLE

General BR/EDR discoverable.

enum wiced_bt_connectability_mode_e

wiced_bt_connectability_mode_e: BR/EDR Connectable modes.

Values:

enumerator BTM_NON_CONNECTABLE

Not connectable.

enumerator BTM_CONNECTABLE

BR/EDR connectable.

enum wiced_bt_inquiry_mode_e

wiced_bt_inquiry_mode_e: Inquiry modes.

note

These modes are associated with the inquiry active values

Values:

enumerator BTM_INQUIRY_NONE

Stop inquiry.

enumerator BTM_GENERAL_INQUIRY

General inquiry.

enumerator BTM_LIMITED_INQUIRY

Limited inquiry.

enumerator BTM_BR_INQUIRY_MASK

BR Inquiry Mask.

enum wiced_bt_dev_filter_cond_e

wiced_bt_dev_filter_cond_e: Inquiry Filter Condition types (see wiced_bt_dev_inq_parms_t)

Values:

enumerator BTM_CLR_INQUIRY_FILTER

No inquiry filter.

enumerator BTM_FILTER_COND_DEVICE_CLASS

Filter on device class.

enumerator BTM_FILTER_COND_BD_ADDR

Filter on device addr.

enum [anonymous]

@15: BTM service definitions (used for storing EIR data to bit mask refer eir_uuid_mask in wiced_bt_dev_inquiry_scan_result_t)

Values:

enumerator BTM_EIR_UUID_SERVCLASS_SERIAL_PORT

Serial Port Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_DIALUP_NETWORKING

Dialup Networking Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_IRMC_SYNC

IRMC SYNC Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_OBEX_OBJECT_PUSH

OBEX Object Push Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_OBEX_FILE_TRANSFER

OBEX File Transfer Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_IRMC_SYNC_COMMAND

IRMC SYNC Command Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HEADSET

Headset Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_AUDIO_SOURCE

Audio Source Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_AUDIO_SINK

Audio Sink Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_AV_REM_CTRL_TARGET

AVRCP TG Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_AV_REMOTE_CONTROL

AVRCP CT Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HEADSET_AUDIO_GATEWAY

Headset AG Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_DIRECT_PRINTING

Direct Printing Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HF_HANDSFREE

HF Handsfree Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_AG_HANDSFREE

AG Handsfree Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HUMAN_INTERFACE

Human Interface Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_SAP

SAP Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_PBAP_PCE

PBAP PCE Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_PBAP_PSE

PBAP PSE Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_PHONE_ACCESS

Phone Access Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HEADSET_HS

Headset HS Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_PNP_INFORMATION

PNP Information Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_MESSAGE_ACCESS

Message Access Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_MESSAGE_NOTIFICATION

Message Notification Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HDP_SOURCE

HDP Source Service Index.

enumerator BTM_EIR_UUID_SERVCLASS_HDP_SINK

HDP Sink Service Index.

enumerator BTM_EIR_MAX_SERVICES

Max Service Index.

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_passkey_entry_type_e

wiced_bt_dev_passkey_entry_type_e: Pairing keypress types.

Values:

enumerator BTM_PASSKEY_ENTRY_STARTED

passkey entry started

enumerator BTM_PASSKEY_DIGIT_ENTERED

passkey digit entered

enumerator BTM_PASSKEY_DIGIT_ERASED

passkey digit erased

enumerator BTM_PASSKEY_DIGIT_CLEARED

passkey cleared

enumerator BTM_PASSKEY_ENTRY_COMPLETED

passkey entry completed

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

Event data: wiced_bt_dev_user_key_req_t

note

BR/EDR Only

enumerator BTM_KEYPRESS_NOTIFICATION_EVT

received KEYPRESS_NOTIFY event.

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: wiced_bt_dev_bredr_io_caps_rsp_t

note

BR/EDR Only

enumerator BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT

Requesting IO capabilities for BLE pairing.

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

Event data: wiced_bt_dev_local_oob_t

note

BR/EDR Only

enumerator BTM_REMOTE_OOB_DATA_REQUEST_EVT

OOB data from remote device wiced_bt_dev_remote_oob_data_reply).

Event data: wiced_bt_dev_remote_oob_t

note

BR/EDR Only

Updated remote device link keys (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_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: wiced_bt_sco_connected_t

note

BR/EDR Only

enumerator BTM_SCO_DISCONNECTED_EVT

SCO disconnected event.

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_tx_power_result_t
#include <>

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

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

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

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_dev_cod_cond_t
#include <>

Class of Device inquiry filter.

Public Members

wiced_bt_dev_class_t dev_class

class of device

wiced_bt_dev_class_t dev_class_mask

class of device filter mask

union wiced_bt_dev_inq_filt_cond_t
#include <>

Inquiry filter.

Public Members

wiced_bt_device_address_t bdaddr_cond

bluetooth address filter

wiced_bt_dev_cod_cond_t cod_cond

class of device filter

struct wiced_bt_dev_inq_parms_t
#include <>

Inquiry Parameters.

Public Members

uint8_t mode

Inquiry mode (see wiced_bt_inquiry_mode_e)

uint8_t duration

Inquiry duration (1.28 sec increments)

uint8_t filter_cond_type

Inquiry filter type (see wiced_bt_dev_filter_cond_e)

wiced_bt_dev_inq_filt_cond_t filter_cond

Inquiry filter.

struct wiced_bt_dev_inquiry_scan_result_t
#include <>

Inquiry Results.

Public Members

uint16_t clock_offset

Clock offset.

wiced_bt_device_address_t remote_bd_addr

Device address.

wiced_bt_dev_class_t dev_class

Class of device.

uint8_t page_scan_rep_mode

Page scan repetition mode.

uint8_t page_scan_per_mode

Page scan per mode.

uint8_t page_scan_mode

Page scan mode.

int8_t rssi

Receive signal strength index (BTM_INQ_RES_IGNORE_RSSI, if not available)

uint32_t eir_uuid_mask

Bit mask of EIR UUIDs.

wiced_bool_t eir_complete_list

TRUE if EIR array is complete.

struct wiced_bt_dev_rssi_result_t
#include <>

RSSI Result (in response to wiced_bt_dev_read_rssi)

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 rssi

RSSI in dB.

wiced_bt_device_address_t rem_bda

Remote BD address.

struct wiced_bt_dev_remote_name_result_t
#include <>

Structure returned with remote name request.

Public Members

uint16_t status

Status of the operation.

BTM_SUCCESS for success otherwise BTM_BAD_VALUE_RET

wiced_bt_device_address_t bd_addr

Remote BD address.

uint16_t length

Device name Length.

wiced_bt_remote_name_t remote_bd_name

Remote device name.

struct wiced_bt_dev_switch_role_result_t
#include <>

Structure returned with switch role request.

Public Members

uint8_t status

Status of the operation.

(Refer Spec 5.0 Vol 2 Part D Error Codes)

uint8_t role

BTM_ROLE_CENTRAL or BTM_ROLE_PERIPHERAL.

wiced_bt_device_address_t bd_addr

Remote BD address involved with the switch.

struct wiced_bt_public_key_t
#include <>

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

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_dev_bredr_io_caps_rsp_t
#include <>

Data type for IO capabalities response (BTM_PAIRING_IO_CAPABILITIES_BR_EDR_RESPONSE_EVT)

Public Members

wiced_bt_device_address_t bd_addr

Peer address.

wiced_bt_dev_io_cap_t io_cap

Peer IO capabilities.

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.

struct wiced_bt_dev_user_key_req_t
#include <>

Pairing user passkey request (BTM_USER_PASSKEY_REQUEST_EVT event data type)

Public Members

wiced_bt_device_address_t bd_addr

peer address

struct wiced_bt_smp_sc_peer_oob_data_t
#include <>

Data associated with the information received from the peer via OOB interface.

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_received_from

peer address

struct wiced_bt_smp_sc_oob_data_t
#include <>

Data for wiced_bt_smp_sc_oob_reply.

Public Members

wiced_bt_smp_sc_local_oob_t local_oob_data

My OOB sent to peer out of band.

wiced_bt_smp_sc_peer_oob_data_t peer_oob_data

Peer OOB received out of band.

struct wiced_bt_sco_connected_t
#include <>

SCO connected event related data.

Public Members

uint16_t sco_index

SCO index.

struct wiced_bt_sco_disconnected_t
#include <>

SCO disconnected event related data.

Public Members

uint16_t sco_index

SCO index.

struct wiced_bt_sco_connection_request_t
#include <>

SCO connect request event related data.

Public Members

uint16_t sco_index

SCO index.

wiced_bt_device_address_t bd_addr

Peer bd address.

wiced_bt_dev_class_t dev_class

Peer device class.

SCO link type.

struct wiced_bt_sco_connection_change_t
#include <>

SCO connection change event related data.

Public Members

uint16_t sco_index

SCO index.

uint16_t rx_pkt_len

RX packet length.

uint16_t tx_pkt_len

TX packet length.

wiced_bt_device_address_t bd_addr

Peer bd address.

uint8_t hci_status

HCI status.

uint8_t tx_interval

TX interval.

uint8_t retrans_windows

Retransmission windows.

struct wiced_bt_smp_remote_oob_req_t
#include <>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Device enabled (used by BTM_ENABLED_EVT)

Public Members

wiced_result_t status

Status.

struct wiced_bt_dev_disabled_t
#include <>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.