 |
AIROC™ BTSDK v4.9 - Documentation | |||
|
AIROC™ BTSDK v4.9 - Documentation | |||
Bluetooth Management (BTM) Application Programming Interface. More...
Data Structures | |
| struct | wiced_bt_tx_power_result_t |
| TX Power Result (in response to wiced_bt_dev_read_tx_power) More... | |
| struct | wiced_bt_set_adv_tx_power_result_t |
| TX Power Result (in response to wiced_bt_ble_set_adv_tx_power) More... | |
| struct | wiced_bt_dev_vendor_specific_command_complete_params_t |
| Structure returned with Vendor Specific Command complete callback. More... | |
| struct | wiced_bt_public_key_t |
| Public key. More... | |
| struct | wiced_bt_smp_sc_local_oob_t |
| Data for BTM_SMP_SC_LOCAL_OOB_DATA_NOTIFICATION_EVT. More... | |
| struct | wiced_bt_smp_remote_oob_req_t |
| data type for BTM_SMP_REMOTE_OOB_DATA_REQUEST_EVT More... | |
| struct | wiced_bt_smp_sc_remote_oob_req_t |
| data type for BTM_SMP_SC_REMOTE_OOB_DATA_REQUEST_EVT More... | |
| struct | wiced_bt_dev_user_keypress_t |
| Pairing keypress notification (BTM_USER_KEYPRESS_NOTIFICATION_EVT event data type) More... | |
| struct | wiced_bt_dev_user_key_notif_t |
| Data for pairing passkey notification (BTM_USER_PASSKEY_NOTIFICATION_EVT event data type) More... | |
| struct | wiced_bt_dev_br_edr_pairing_info_t |
| BR/EDR pairing complete infomation. More... | |
| struct | wiced_bt_dev_user_cfm_req_t |
| Data for pairing confirmation request (BTM_USER_CONFIRMATION_REQUEST_EVT event data type) More... | |
| struct | wiced_bt_dev_ble_pairing_info_t |
| LE pairing complete infomation. More... | |
| union | wiced_bt_dev_pairing_info_t |
| Transport dependent pairing complete infomation. More... | |
| struct | wiced_bt_dev_pairing_cplt_t |
| Pairing complete notification (BTM_PAIRING_COMPLETE_EVT event data type) More... | |
| struct | wiced_bt_dev_security_failed_t |
| Security/authentication failure status (used by BTM_SECURITY_FAILED_EVT notication) More... | |
| struct | wiced_bt_dev_security_request_t |
| Security request (BTM_SECURITY_REQUEST_EVT event data type) More... | |
| struct | wiced_bt_local_id_keys |
| LE keys. More... | |
| struct | wiced_bt_local_identity_keys_t |
| LE identity key for local device (used by BTM_LE_LOCAL_IDENTITY_KEYS_UPDATE_EVT and BTM_LE_LOCAL_KEYS_REQUEST_EVT notification) More... | |
| struct | wiced_bt_ble_connection_param_update_t |
| LE connection parameter update event related data. More... | |
| struct | wiced_bt_ble_phy_update_t |
| LE Physical link update event related data. More... | |
| struct | wiced_bt_ble_phy_data_length_update_t |
| LE data length update event related data. More... | |
| struct | wiced_bt_ble_multi_adv_response_t |
| LE Multi adv VSC response data. More... | |
| struct | wiced_bt_dev_enabled_t |
| Device enabled (used by BTM_ENABLED_EVT) More... | |
| struct | wiced_bt_dev_disabled_t |
| Device disabled (used by BTM_DISABLED_EVT) More... | |
| struct | wiced_bt_dev_name_and_class_t |
| Remote device information (used by BTM_PIN_REQUEST_EVT, BTM_SECURITY_ABORTED_EVT) More... | |
| struct | wiced_bt_power_mgmt_notification_t |
| Change in power management status (used by BTM_POWER_MANAGEMENT_STATUS_EVT notication) More... | |
| struct | wiced_bt_dev_encryption_status_t |
| Encryption status change (used by BTM_ENCRYPTION_STATUS_EVT) More... | |
| struct | wiced_bt_dev_local_oob_t |
| Local OOB data BTM_READ_LOCAL_OOB_DATA_COMPLETE_EVT. More... | |
| struct | wiced_bt_dev_remote_oob_t |
| BTM_REMOTE_OOB_DATA_REQUEST_EVT. More... | |
| struct | wiced_bt_dev_bredr_io_caps_req_t |
| BR/EDR Pairing IO Capabilities (to be filled by application callback on BTM_PAIRING_IO_CAPABILITIES_BR_EDR_REQUEST_EVT) More... | |
| struct | wiced_bt_dev_ble_io_caps_req_t |
| LE Pairing IO Capabilities (to be filled by application callback on BTM_PAIRING_IO_CAPABILITIES_BLE_REQUEST_EVT) More... | |
| struct | wiced_bt_ble_keys_s |
| Paired device LE Keys. More... | |
| struct | wiced_bt_device_sec_keys_s |
| Paired Device Link key data. More... | |
| struct | wiced_bt_device_link_keys_s |
| Paired device link key notification (used by BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT notication) More... | |
| struct | wiced_bt_device_br_packet_types_t |
| BR packets statistics details. More... | |
| struct | edr_packet_types_s |
| EDR packets statistics types details. More... | |
| union | wiced_bt_br_edr_pkt_type_stats_s |
| BR/EDR packet types detail statistics. More... | |
| struct | wiced_bt_lq_br_edr_stats_s |
| BR/EDR link statistics. More... | |
| struct | wiced_bt_lq_le_stats_s |
| LE link statistics. More... | |
| struct | wiced_bt_lq_stats_result_s |
| LQ Quality Result (in response to wiced_bt_dev_lq_stats) More... | |
| union | wiced_bt_management_evt_data_t |
| Structure definitions for Bluetooth Management (wiced_bt_management_cback_t) event notifications. More... | |
Macros | |
| #define | BTM_INQ_RES_IGNORE_RSSI 0x7f |
| RSSI value not supplied (ignore it) | |
| #define | BTM_SCAN_PARAM_IGNORE 0 |
| Passed to BTM_SetScanConfig() to ignore. | |
| #define | BTM_PIN_TYPE_VARIABLE HCI_PIN_TYPE_VARIABLE |
| Variable Pin Type. | |
| #define | BTM_PIN_TYPE_FIXED HCI_PIN_TYPE_FIXED |
| Fix Length Pin Type. | |
| #define | BTM_SECURITY_KEY_DATA_LEN 132 |
| Security key data length (used by wiced_bt_device_link_keys_t structure) | |
| #define | BTM_SECURITY_LOCAL_KEY_DATA_LEN 65 |
| Local security key data length (used by wiced_bt_local_identity_keys_t structure) | |
| #define | SMP_SEC_NONE 0 |
| LE Security key level. More... | |
| #define | SMP_SEC_UNAUTHENTICATE (1 << 0) |
| Security Key Level: key not authenticated. | |
| #define | SMP_SEC_AUTHENTICATED (1 << 2) |
| Security Key Level: key authenticated. | |
| #define | BTM_OOB_STATE |
| OOB Data status. | |
| #define | BTM_OOB_REQ_TYPE |
| Type of OOB data required. | |
| #define | BTM_LE_KEY_TYPES |
| LE Key type. | |
| #define | BTM_BLE_SCAN_TYPE |
| Scan duty cycle (used for BTM_BLE_SCAN_STATE_CHANGED_EVT and wiced_bt_dev_create_connection) | |
| #define | BTM_BLE_KEY_TYPE_ID 1 |
| Identity resolving key. | |
| #define | BTM_BLE_KEY_TYPE_ER 2 |
| Encryption root key. | |
| #define | BTM_PM_STATUS_CODES |
| Power Management status codes. | |
| #define | WICED_POWER_STATE_ACTIVE BTM_PM_STS_ACTIVE |
| Power Management state. More... | |
| #define | WICED_POWER_STATE_SNIFF BTM_PM_STS_SNIFF |
| Sniff. | |
| #define | WICED_POWER_STATE_SSR BTM_PM_STS_SSR |
| Sniff subrating notification. | |
| #define | WICED_POWER_STATE_PENDING BTM_PM_STS_PENDING |
| Pending (waiting for status from controller) | |
| #define | WICED_POWER_STATE_ERROR BTM_PM_STS_ERROR |
| Error (controller returned error) | |
| #define | BTM_AFH_CHNL_MAP_SIZE HCI_AFH_CHANNEL_MAP_LEN |
| Channel Map Length. | |
| #define | BTM_MANAGEMENT_EVT |
| Bluetooth Management event. | |
| #define | BTM_BLE_ADVERT_MODE |
| advertisement type (used when calling wiced_bt_start_advertisements) | |
| #define | BTM_BLE_CONN_MODE |
| scan mode used in initiating | |
Typedefs | |
| typedef uint8_t | wiced_bt_dev_io_cap_t |
| IO capabilities. | |
| typedef uint8_t | wiced_bt_dev_auth_req_t |
| BR/EDR authentication requirement (see wiced_bt_dev_auth_req_e) | |
| typedef uint8_t | wiced_bt_dev_le_auth_req_t |
| LE authentication requirement (see wiced_bt_dev_le_auth_req_e) | |
| typedef uint8_t | wiced_bt_smp_sec_level_t |
| LE Security key level. | |
| typedef uint8_t | wiced_bt_dev_oob_data_t |
| OOB data (see wiced_bt_dev_oob_data_e) | |
| typedef uint8_t | wiced_bt_dev_oob_data_req_type_t |
| OOB data type requested (see wiced_bt_dev_oob_data_req_type_t) | |
| typedef uint8_t | wiced_bt_dev_le_key_type_t |
| LE key type (see wiced_bt_dev_le_key_type_e) | |
| typedef uint8_t | wiced_bt_ble_scan_type_t |
| scan type (see wiced_bt_ble_scan_type_e) | |
| typedef uint8_t | wiced_bt_smp_status_t |
| SMP Pairing status (see wiced_bt_smp_status_e) | |
| typedef uint8_t | wiced_bt_dev_power_mgmt_status_t |
| Power management status (see wiced_bt_dev_power_mgmt_status_e) | |
| typedef uint8_t | wiced_bt_br_chnl_map_t [BTM_AFH_CHNL_MAP_SIZE] |
| Array of Channel Map Length. | |
| typedef uint8_t | wiced_bt_management_evt_t |
| Bluetooth management events (see wiced_bt_management_evt_e) | |
| typedef struct wiced_bt_ble_keys_s | wiced_bt_ble_keys_t |
| Paired device LE Keys. | |
|
typedef struct wiced_bt_device_sec_keys_s | wiced_bt_device_sec_keys_t |
| Paired Device Link key data. | |
|
typedef struct wiced_bt_device_link_keys_s | wiced_bt_device_link_keys_t |
| Paired device link key notification (used by BTM_PAIRED_DEVICE_LINK_KEYS_UPDATE_EVT notication) | |
| typedef struct edr_packet_types_s | wiced_bt_device_edr_packet_types_t |
| EDR packets statistics types details. | |
|
typedef union wiced_bt_br_edr_pkt_type_stats_s | wiced_bt_br_edr_pkt_type_stats |
| BR/EDR packet types detail statistics. | |
|
typedef struct wiced_bt_lq_br_edr_stats_s | wiced_bt_lq_br_edr_stats |
| BR/EDR link statistics. | |
|
typedef struct wiced_bt_lq_le_stats_s | wiced_bt_lq_le_stats |
| LE link statistics. | |
|
typedef struct wiced_bt_lq_stats_result_s | wiced_bt_lq_stats_result_t |
| LQ Quality Result (in response to wiced_bt_dev_lq_stats) | |
| typedef uint8_t | wiced_bt_link_quality_stats_param_t |
| Link Quality Statistic Action (see wiced_bt_dev_link_quality_stats_param_e) | |
| typedef uint16_t | wiced_bt_link_policy_settings_t [1] |
| Link Policy Settings type (see wiced_bt_link_policy_settings_values_e) | |
| typedef uint8_t | wiced_bt_ble_advert_mode_t |
| Advertisement type (see wiced_bt_ble_advert_mode_e) | |
| typedef uint8_t | wiced_bt_ble_conn_mode_t |
| Conn mode (see wiced_bt_ble_conn_mode_e) | |
| typedef wiced_result_t( | wiced_bt_management_cback_t )(wiced_bt_management_evt_t event, wiced_bt_management_evt_data_t *p_event_data) |
| Bluetooth Management callback. More... | |
| typedef void( | wiced_bt_connection_status_change_cback_t )(wiced_bt_device_address_t bd_addr, uint8_t *p_features, wiced_bool_t is_connected, uint16_t handle, wiced_bt_transport_t transport, uint8_t reason) |
| Connection status change callback. More... | |
| typedef void( | wiced_bt_inquiry_result_cback_t )(wiced_bt_dev_inquiry_scan_result_t *p_inquiry_result, uint8_t *p_eir_data) |
| Inquiry result callback. More... | |
| typedef void( | wiced_bt_dev_cmpl_cback_t )(void *p_data) |
| Asynchronous operation complete callback. More... | |
| typedef void( | wiced_bt_dev_vendor_specific_command_complete_cback_t )(wiced_bt_dev_vendor_specific_command_complete_params_t *p_command_complete_params) |
| Vendor specific command complete. More... | |
| typedef void( | wiced_bt_remote_name_cback_t )(wiced_bt_dev_remote_name_result_t *p_remote_name_result) |
| Remote name result callback. More... | |
| typedef void( | wiced_bt_dev_vse_callback_t )(uint8_t len, uint8_t *p) |
| Vendor event handler callback. More... | |
| typedef void( | wiced_bt_hci_trace_cback_t )(wiced_bt_hci_trace_type_t type, uint16_t length, uint8_t *p_data) |
| HCI trace callback. More... | |
Functions | |
| void | wiced_bt_dev_register_hci_trace (wiced_bt_hci_trace_cback_t *p_cback) |
| Register to get the hci traces. More... | |
| void | wiced_bt_dev_update_hci_trace_mode (wiced_bool_t enable) |
| Update the hci trace mode. More... | |
| void | wiced_bt_dev_update_debug_trace_mode (wiced_bool_t enable) |
| Update the debug trace mode. More... | |
| wiced_result_t | wiced_bt_set_local_bdaddr (wiced_bt_device_address_t bd_addr, wiced_bt_ble_address_type_t addr_type) |
| Set Local Bluetooth Device Address. More... | |
| wiced_result_t | wiced_bt_dev_get_role (wiced_bt_device_address_t remote_bd_addr, wiced_bt_dev_role_t *p_role, wiced_bt_transport_t transport) |
| This function is called to get the role of the local device for the ACL connection with the specified remote device. More... | |
| wiced_result_t | wiced_bt_set_tx_power (wiced_bt_device_address_t bd_addr, int8_t power, wiced_bt_dev_vendor_specific_command_complete_cback_t *p_cb) |
| Command to set the tx power on link This command will adjust the transmit power attenuation on a per connection basis. More... | |
| wiced_result_t | wiced_bt_dev_read_tx_power (wiced_bt_device_address_t remote_bda, wiced_bt_transport_t transport, wiced_bt_dev_cmpl_cback_t *p_cback) |
| Read the transmit power for the requested link. More... | |
| void | wiced_bt_set_pairable_mode (uint8_t allow_pairing, uint8_t connect_only_paired) |
| Enable or disable pairing. More... | |
| wiced_result_t | wiced_bt_dev_register_vse_callback (wiced_bt_dev_vse_callback_t cb) |
| Application can register Vendor-Specific HCI event callback. More... | |
| wiced_result_t | wiced_bt_dev_deregister_vse_callback (wiced_bt_dev_vse_callback_t cb) |
| Application can deregister Vendor-Specific HCI event callback. More... | |
| wiced_bt_dev_status_t | wiced_bt_dev_link_quality_stats (wiced_bt_device_address_t bda, wiced_bt_transport_t transport, uint8_t action, wiced_bt_dev_cmpl_cback_t *p_cback) |
| This API is called to get the statistics for an ACL link. More... | |
| wiced_result_t | wiced_bt_dev_get_ble_keys (wiced_bt_device_address_t bd_addr, wiced_bt_dev_le_key_type_t *p_key_mask) |
| get le key mask from stored key information of nv ram More... | |
| wiced_result_t | wiced_bt_dev_add_device_to_address_resolution_db (wiced_bt_device_link_keys_t *p_link_keys) |
| add link key information to internal address resolution db More... | |
| wiced_result_t | wiced_bt_dev_remove_device_from_address_resolution_db (wiced_bt_device_link_keys_t *p_link_keys) |
| remove link key information from internal address resolution db More... | |
| uint16_t | wiced_bt_dev_get_acl_conn_handle (wiced_bt_device_address_t bdaddr, wiced_bt_transport_t transport) |
| get the acl connection handle for bdaddr More... | |
| wiced_result_t | wiced_bt_dev_sec_bond (wiced_bt_device_address_t bd_addr, wiced_bt_ble_address_type_t bd_addr_type, wiced_bt_transport_t transport, uint8_t pin_len, uint8_t *p_pin) |
| Bluetooth LE Security Functions. More... | |
| wiced_result_t | wiced_bt_dev_sec_pair_without_bonding (wiced_bt_device_address_t bd_addr, wiced_bt_ble_address_type_t bd_addr_type, wiced_bt_transport_t transport, uint8_t pin_len, uint8_t *p_pin) |
| Pair with peer device(dont store the keys). More... | |
| wiced_result_t | wiced_bt_dev_sec_bond_cancel (wiced_bt_device_address_t bd_addr) |
| Cancel an ongoing bonding process with peer device. More... | |
| wiced_result_t | wiced_bt_dev_set_encryption (wiced_bt_device_address_t bd_addr, wiced_bt_transport_t transport, void *p_ref_data) |
| Encrypt the specified connection. More... | |
| void | wiced_bt_dev_confirm_req_reply (wiced_result_t res, wiced_bt_device_address_t bd_addr) |
| Confirm the numeric value for pairing (in response to BTM_USER_CONFIRMATION_REQUEST_EVT of wiced_bt_management_cback_t) More... | |
| void | wiced_bt_dev_send_key_press_notif (wiced_bt_device_address_t bd_addr, wiced_bt_dev_passkey_entry_type_t type) |
| Inform remote device of keypress during pairing. More... | |
| wiced_result_t | wiced_bt_dev_delete_bonded_device (wiced_bt_device_address_t bd_addr) |
| remove bonding with remote device with assigned bd_addr Note: This API cannot be used while being connected to the remote bd_addr More... | |
| wiced_bool_t | wiced_bt_dev_get_security_state (wiced_bt_device_address_t bd_addr, uint8_t *p_sec_flags) |
| Get security flags for the device. More... | |
Bluetooth Management (BTM) Application Programming Interface.
The BTM consists of several management entities:
