 |
AIROC™ BTSDK v4.9 - Documentation | |||
|
AIROC™ BTSDK v4.9 - Documentation | |||
AIROC Bluetooth Low Energy (LE) Functions. More...
Data Structures | |
| struct | wiced_bt_ble_advert_elem_t |
| struct | wiced_bt_ble_scan_results_t |
| LE inquiry result type. More... | |
| struct | wiced_bt_ble_conn_params_t |
| LE connection parameteres. More... | |
| struct | wiced_bt_ble_phy_preferences_t |
| Host PHY preferences. More... | |
Macros | |
| #define | BLE_CHANNEL_MAP_LEN 5 |
| #define | BTM_BLE_SCAN_MODES |
| Scan modes. | |
| #define | BTM_BLE_DEFAULT_ADVERT_CHNL_MAP (BTM_BLE_ADVERT_CHNL_37| BTM_BLE_ADVERT_CHNL_38| BTM_BLE_ADVERT_CHNL_39) |
| #define | BTM_BLE_ADVERT_FILTER_DEFAULT BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN |
| #define | BTM_BLE_ADVERT_INTERVAL_MIN 0x0020 |
| #define | BTM_BLE_ADVERT_INTERVAL_MAX 0x4000 |
| #define | BTM_BLE_SCAN_INTERVAL_MIN 0x0004 |
| #define | BTM_BLE_SCAN_INTERVAL_MAX 0x4000 |
| #define | BTM_BLE_SCAN_WINDOW_MIN 0x0004 |
| #define | BTM_BLE_SCAN_WINDOW_MAX 0x4000 |
| #define | BTM_BLE_CONN_INTERVAL_MIN 0x0006 |
| #define | BTM_BLE_CONN_INTERVAL_MAX 0x0C80 |
| #define | BTM_BLE_CONN_LATENCY_MAX 500 |
| #define | BTM_BLE_CONN_SUP_TOUT_MIN 0x000A |
| #define | BTM_BLE_CONN_SUP_TOUT_MAX 0x0C80 |
| #define | BTM_BLE_CONN_PARAM_UNDEF 0xffff /* use this value when a specific value not to be overwritten */ |
| #define | BTM_BLE_CONN_SUP_TOUT_DEF 700 |
| #define | BTM_BLE_SCAN_FAST_INTERVAL 96 /* 30 ~ 60 ms (use 60) = 96 *0.625 */ |
| #define | BTM_BLE_SCAN_FAST_WINDOW 48 /* 30 ms = 48 *0.625 */ |
| #define | BTM_BLE_SCAN_SLOW_INTERVAL_1 2048 /* 1.28 s = 2048 *0.625 */ |
| #define | BTM_BLE_SCAN_SLOW_WINDOW_1 18 /* 11.25 ms = 18 *0.625 */ |
| #define | BTM_BLE_SCAN_SLOW_INTERVAL_2 4096 /* 2.56 s = 4096 *0.625 */ |
| #define | BTM_BLE_SCAN_SLOW_WINDOW_2 36 /* 22.5 ms = 36 *0.625 */ |
| #define | BTM_BLE_CONN_INTERVAL_MIN_DEF 24 /* recommended min: 30ms = 24 * 1.25 */ |
| #define | BTM_BLE_CONN_INTERVAL_MAX_DEF 40 /* recommended max: 50 ms = 56 * 1.25 */ |
| #define | BTM_BLE_CONN_PERIPHERAL_LATENCY_DEF 0 /* 0 */ |
| #define | BTM_BLE_CONN_TIMEOUT_DEF 2000 |
| #define | BTM_BLE_DIR_CONN_FALLBACK_UNDIR 1 |
| #define | BTM_BLE_DIR_CONN_FALLBACK_NO_ADV 2 |
| #define | BTM_BLE_DIR_CONN_FALLBACK BTM_BLE_DIR_CONN_FALLBACK_UNDIR |
| #define | BTM_BLE_AUTH_SIGNATURE_SIZE 12 |
| LE Signature. More... | |
| #define | BTM_BLE_POLICY_REJECT_ALL 0x00 /* relevant to both */ |
| #define | BTM_BLE_POLICY_ALLOW_SCAN 0x01 /* relevant to advertiser */ |
| #define | BTM_BLE_POLICY_ALLOW_CONN 0x02 /* relevant to advertiser */ |
| #define | BTM_BLE_POLICY_ALLOW_ALL 0x03 /* relevant to both */ |
| #define | BTM_BLE_LIMITED_DISCOVERABLE_FLAG (0x01 << 0) |
| #define | BTM_BLE_GENERAL_DISCOVERABLE_FLAG (0x01 << 1) |
| #define | BTM_BLE_BREDR_NOT_SUPPORTED (0x01 << 2) |
| #define | BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED (0x01 << 3) |
| Simultaneous LE and BR/EDR to Same Device Capable (Controller). More... | |
| #define | BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED (0x01 << 4) |
| Simultaneous LE and BR/EDR to Same Device Capable (Host). More... | |
| #define | BTM_BLE_NON_LIMITED_DISCOVERABLE_FLAG (0x00 ) /* lowest bit unset */ |
| #define | BTM_BLE_ADVERT_FLAG_MASK (BTM_BLE_LIMITED_DISCOVERABLE_FLAG | BTM_BLE_BREDR_NOT_SUPPORTED | BTM_BLE_GENERAL_DISCOVERABLE_FLAG) |
| #define | BTM_BLE_LIMITED_DISCOVERABLE_MASK (BTM_BLE_LIMITED_DISCOVERABLE_FLAG ) |
| #define | BTM_BLE_CONN_TYPES |
| Background connection type. | |
| #define | BTM_BLE_SEC_ACTION_TYPES |
| LE encryption method. | |
| #define | BTM_BLE_PREFER_1M_PHY 0x01 |
| #define | BTM_BLE_PREFER_2M_PHY 0x02 |
| #define | BTM_BLE_PREFER_LELR_PHY 0x04 |
| #define | BTM_BLE_PREFER_NO_LELR 0x0000 |
| #define | BTM_BLE_PREFER_LELR_125K 0x0001 |
| #define | BTM_BLE_PREFER_LELR_512K 0x0002 |
Typedefs | |
| typedef uint8_t | wiced_bt_ble_chnl_map_t [BLE_CHANNEL_MAP_LEN] |
| typedef uint8_t | wiced_bt_ble_scan_mode_t |
| scan mode (see wiced_bt_ble_scan_mode_e) | |
| typedef uint8_t | wiced_bt_ble_scanner_filter_policy_t |
| Scanner filter policy (see wiced_bt_ble_scanner_filter_policy_e) | |
| typedef uint8_t | wiced_bt_ble_advert_chnl_map_t |
| LE advertisement channel map (see wiced_bt_ble_advert_chnl_map_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 |
| LE advertisement data type (see wiced_bt_ble_advert_type_e) | |
| typedef uint8_t | wiced_bt_dev_ble_evt_type_t |
| Scan result event value (see wiced_bt_dev_ble_evt_type_e) | |
| typedef uint8_t | wiced_bt_ble_conn_type_t |
| Connection type (see wiced_bt_ble_conn_type_e) | |
| typedef uint8_t | wiced_bt_ble_sec_action_type_t |
| typedef UINT8 | wiced_bt_ble_host_phy_preferences_t |
| typedef UINT16 | wiced_bt_ble_lelr_phy_preferences_t |
| typedef 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. More... | |
| typedef void( | wiced_bt_ble_scan_result_cback_t )(wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data) |
| Callback wiced_bt_ble_scan_result_cback_t. More... | |
| typedef void( | wiced_bt_ble_read_phy_complete_callback_t )(wiced_bt_ble_phy_update_t *p_phy_result) |
| Callback wiced_bt_ble_read_phy_complete_callback_t. More... | |
Functions | |
| wiced_result_t | wiced_bt_start_advertisements (wiced_bt_ble_advert_mode_t advert_mode, wiced_bt_ble_address_type_t directed_advertisement_bdaddr_type, wiced_bt_device_address_ptr_t directed_advertisement_bdaddr_ptr) |
| Function wiced_bt_start_advertisements. More... | |
| wiced_bt_ble_advert_mode_t | wiced_bt_ble_get_current_advert_mode (void) |
| Function wiced_bt_ble_get_current_advert_mode. More... | |
| wiced_result_t | wiced_bt_ble_set_raw_advertisement_data (uint8_t num_elem, wiced_bt_ble_advert_elem_t *p_data) |
| Function wiced_bt_ble_set_raw_advertisement_data. More... | |
| wiced_bt_dev_status_t | wiced_bt_ble_set_raw_scan_response_data (uint8_t num_elem, wiced_bt_ble_advert_elem_t *p_data) |
| Function wiced_bt_ble_set_raw_scan_response_data. More... | |
| wiced_bt_dev_status_t | wiced_bt_ble_observe (wiced_bool_t start, uint8_t duration, wiced_bt_ble_scan_result_cback_t *p_scan_result_cback) |
| Function wiced_bt_ble_observe. More... | |
| wiced_result_t | wiced_bt_ble_scan (wiced_bt_ble_scan_type_t scan_type, wiced_bool_t duplicate_filter_enable, wiced_bt_ble_scan_result_cback_t *p_scan_result_cback) |
| Function wiced_bt_ble_scan. More... | |
| wiced_bt_ble_scan_type_t | wiced_bt_ble_get_current_scan_state (void) |
| Function wiced_bt_ble_get_current_scan_state. More... | |
| void | wiced_bt_ble_security_grant (wiced_bt_device_address_t bd_addr, uint8_t res) |
| Function wiced_bt_ble_security_grant. More... | |
| wiced_bool_t | wiced_bt_ble_data_signature (wiced_bt_device_address_t bd_addr, uint8_t *p_text, uint16_t len, wiced_dev_ble_signature_t signature) |
| Function wiced_bt_ble_data_signature. More... | |
| wiced_bool_t | wiced_bt_ble_verify_signature (wiced_bt_device_address_t bd_addr, uint8_t *p_orig, uint16_t len, uint32_t counter, uint8_t *p_comp) |
| Function wiced_bt_ble_verify_signature. More... | |
| wiced_bool_t | wiced_bt_ble_set_background_connection_type (wiced_bt_ble_conn_type_t conn_type, wiced_bt_ble_selective_conn_cback_t *p_select_cback) |
| Function wiced_bt_ble_set_background_connection_type. More... | |
| wiced_bool_t | wiced_bt_ble_update_background_connection_device (wiced_bool_t add_remove, wiced_bt_device_address_t remote_bda) |
| Function wiced_bt_ble_update_background_connection_device. More... | |
| uint8_t * | wiced_bt_ble_check_advertising_data (uint8_t *p_adv, wiced_bt_ble_advert_type_t type, uint8_t *p_length) |
| Function wiced_bt_ble_check_advertising_data. More... | |
| wiced_bool_t | wiced_bt_ble_get_security_state (wiced_bt_device_address_t bd_addr, uint8_t *p_le_sec_flags, uint8_t *p_le_key_size) |
| Function wiced_bt_ble_get_security_state. More... | |
| wiced_bool_t | wiced_bt_ble_update_advertising_filter_accept_list (wiced_bool_t add, wiced_bt_device_address_t remote_bda) |
| Function wiced_bt_ble_update_advertising_filter_accept_list. More... | |
| wiced_bool_t | wiced_btm_ble_update_advertisement_filter_policy (wiced_bt_ble_advert_filter_policy_t advertising_policy) |
| Function wiced_btm_ble_update_advertisement_filter_policy. More... | |
| wiced_bool_t | wiced_bt_ble_update_scanner_filter_list (wiced_bool_t add, wiced_bt_device_address_t remote_bda, wiced_bt_ble_address_type_t addr_type) |
| Function wiced_bt_ble_update_scanner_filter_list. More... | |
| void | wiced_bt_ble_update_scanner_filter_policy (wiced_bt_ble_scanner_filter_policy_t scanner_policy) |
| Function wiced_bt_ble_update_scanner_filter_policy. More... | |
| wiced_bool_t | wiced_bt_ble_clear_filter_accept_list (void) |
| Function wiced_bt_ble_clear_filter_accept_list. More... | |
| uint8_t | wiced_bt_ble_get_filter_accept_list_size (void) |
| Function wiced_bt_ble_get_filter_accept_list_size. More... | |
| wiced_result_t | wiced_bt_ble_set_adv_tx_power (int8_t power) |
| Function wiced_bt_ble_set_adv_tx_power. More... | |
| wiced_result_t | wiced_bt_ble_read_adv_tx_power (wiced_bt_dev_cmpl_cback_t *p_cback) |
| Function wiced_bt_ble_read_adv_tx_power. More... | |
| wiced_result_t | wiced_bt_ble_set_channel_classification (const wiced_bt_ble_chnl_map_t ble_channel_map) |
| Function wiced_bt_ble_set_channel_classification. More... | |
| wiced_result_t | wiced_bt_ble_get_connection_parameters (wiced_bt_device_address_t bda, wiced_bt_ble_conn_params_t *p_conn_parameters) |
| Function wiced_bt_gatt_ble_get_connection_parameters. More... | |
| uint8_t * | wiced_btm_get_private_bda (void) |
| Function wiced_btm_get_private_bda. More... | |
| wiced_result_t | wiced_ble_private_device_address_resolution (wiced_bt_device_address_t rpa, BT_OCTET16 irk) |
| Function wiced_ble_private_device_address_resolution. More... | |
| wiced_bt_dev_status_t | wiced_bt_ble_read_phy (wiced_bt_device_address_t remote_bd_addr, wiced_bt_ble_read_phy_complete_callback_t *p_read_phy_complete_callback) |
| Function wiced_bt_ble_read_phy. More... | |
| wiced_bt_dev_status_t | wiced_bt_ble_set_default_phy (wiced_bt_ble_phy_preferences_t *phy_preferences) |
| Function wiced_bt_ble_set_default_phy. More... | |
| wiced_bt_dev_status_t | wiced_bt_ble_set_phy (wiced_bt_ble_phy_preferences_t *phy_preferences) |
| Function wiced_bt_ble_set_phy. More... | |
| wiced_result_t | wiced_bt_dev_add_device_to_address_resolution_db (wiced_bt_device_link_keys_t *p_link_keys) |
| Function wiced_bt_dev_add_device_to_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) |
| Function wiced_bt_dev_remove_device_from_address_resolution_db. 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) |
| Function wiced_bt_dev_get_ble_keys. More... | |
AIROC Bluetooth Low Energy (LE) Functions.
| #define BTM_BLE_AUTH_SIGNATURE_SIZE 12 |
LE Signature.
LE data signature length 8 Bytes + 4 bytes counter
| #define BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED (0x01 << 3) |
Simultaneous LE and BR/EDR to Same Device Capable (Controller).
| #define BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED (0x01 << 4) |
Simultaneous LE and BR/EDR to Same Device Capable (Host).
| typedef void( wiced_bt_ble_read_phy_complete_callback_t)(wiced_bt_ble_phy_update_t *p_phy_result) |
Callback wiced_bt_ble_read_phy_complete_callback_t.
read phy complete callback (from calling wiced_bt_ble_read_phy)
| p_phy_result | : read phys result |
| typedef void( wiced_bt_ble_scan_result_cback_t)(wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data) |
Callback wiced_bt_ble_scan_result_cback_t.
Scan result callback (from calling wiced_bt_ble_scan)
| p_scan_result | : scan result data (NULL indicates end of scanning) |
| p_adv_data | : Advertisement data (parse using wiced_bt_ble_check_advertising_data) |
| typedef 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)
| remote_bda | : remote device |
| p_remote_name | : remote device name |
| anonymous enum |
Advertising filter policy.
Advertisement data types.
Scan result event type.
