| /****************************************************************************** |
| * |
| * Copyright 1999-2012 Broadcom Corporation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at: |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| * |
| ******************************************************************************/ |
| |
| /****************************************************************************** |
| * |
| * This file contains the Bluetooth Manager (BTM) API function external |
| * definitions. |
| * |
| ******************************************************************************/ |
| #ifndef BTM_BLE_API_H |
| #define BTM_BLE_API_H |
| |
| #include <base/callback_forward.h> |
| #include <hardware/bt_common_types.h> |
| |
| #include <cstdint> |
| #include <memory> |
| |
| #include "btm_api.h" |
| #include "btm_ble_api_types.h" |
| #include "osi/include/alarm.h" |
| #include "stack/btm/neighbor_inquiry.h" |
| #include "types/bt_transport.h" |
| #include "types/raw_address.h" |
| |
| void btm_ble_init(); |
| void btm_ble_free(); |
| |
| /***************************************************************************** |
| * EXTERNAL FUNCTION DECLARATIONS |
| ****************************************************************************/ |
| /******************************************************************************* |
| * |
| * Function BTM_SecAddBleDevice |
| * |
| * Description Add/modify device. This function will be normally called |
| * during host startup to restore all required information |
| * for a LE device stored in the NVRAM. |
| * |
| * Parameters: bd_addr - BD address of the peer |
| * dev_type - Remote device's device type. |
| * addr_type - LE device address type. |
| * |
| ******************************************************************************/ |
| extern void BTM_SecAddBleDevice(const RawAddress& bd_addr, |
| tBT_DEVICE_TYPE dev_type, |
| tBLE_ADDR_TYPE addr_type); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_SecAddBleKey |
| * |
| * Description Add/modify LE device information. This function will be |
| * normally called during host startup to restore all required |
| * information stored in the NVRAM. |
| * |
| * Parameters: bd_addr - BD address of the peer |
| * p_le_key - LE key values. |
| * key_type - LE SMP key type. |
| * |
| ******************************************************************************/ |
| extern void BTM_SecAddBleKey(const RawAddress& bd_addr, |
| tBTM_LE_KEY_VALUE* p_le_key, |
| tBTM_LE_KEY_TYPE key_type); |
| |
| /** |
| * This function is called to set scan parameters. |cb| is called with operation |
| * status |
| **/ |
| extern void BTM_BleSetScanParams(uint32_t scan_interval, uint32_t scan_window, |
| tBLE_SCAN_MODE scan_type, |
| base::Callback<void(uint8_t)> cb); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleGetVendorCapabilities |
| * |
| * Description This function reads local LE features |
| * |
| * Parameters p_cmn_vsc_cb : Locala LE capability structure |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern void BTM_BleGetVendorCapabilities(tBTM_BLE_VSC_CB* p_cmn_vsc_cb); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleGetDynamicAudioBuffer |
| * |
| * Description This function reads dynamic audio buffer |
| * |
| * Parameters p_dynamic_audio_buffer_cb : Dynamic Audio Buffer structure |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern void BTM_BleGetDynamicAudioBuffer( |
| tBTM_BT_DYNAMIC_AUDIO_BUFFER_CB* p_dynamic_audio_buffer_cb); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleSetStorageConfig |
| * |
| * Description This function is called to setup storage configuration and |
| * setup callbacks. |
| * |
| * Parameters uint8_t batch_scan_full_max -Batch scan full maximum |
| uint8_t batch_scan_trunc_max - Batch scan truncated value |
| maximum |
| uint8_t batch_scan_notify_threshold - Threshold value |
| cb - Setup callback |
| tBTM_BLE_SCAN_THRESHOLD_CBACK *p_thres_cback -Threshold |
| callback |
| void *p_ref - Reference value |
| * |
| * |
| ******************************************************************************/ |
| extern void BTM_BleSetStorageConfig( |
| uint8_t batch_scan_full_max, uint8_t batch_scan_trunc_max, |
| uint8_t batch_scan_notify_threshold, |
| base::Callback<void(uint8_t /* status */)> cb, |
| tBTM_BLE_SCAN_THRESHOLD_CBACK* p_thres_cback, tBTM_BLE_REF_VALUE ref_value); |
| |
| /* This function is called to enable batch scan */ |
| extern void BTM_BleEnableBatchScan( |
| tBTM_BLE_BATCH_SCAN_MODE scan_mode, uint32_t scan_interval, |
| uint32_t scan_window, tBTM_BLE_DISCARD_RULE discard_rule, |
| tBLE_ADDR_TYPE addr_type, base::Callback<void(uint8_t /* status */)> cb); |
| |
| /* This function is called to disable batch scanning */ |
| extern void BTM_BleDisableBatchScan( |
| base::Callback<void(uint8_t /* status */)> cb); |
| |
| /* This function is called to read batch scan reports */ |
| extern void BTM_BleReadScanReports(tBLE_SCAN_MODE scan_mode, |
| tBTM_BLE_SCAN_REP_CBACK cb); |
| |
| /* This function is called to setup the callback for tracking */ |
| extern void BTM_BleTrackAdvertiser(tBTM_BLE_TRACK_ADV_CBACK* p_track_cback, |
| tBTM_BLE_REF_VALUE ref_value); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleObserve |
| * |
| * Description This procedure keep the device listening for advertising |
| * events from a broadcast device. |
| * |
| * Parameters start: start or stop observe. |
| * duration: how long the scan should last, in seconds. 0 means |
| * scan without timeout. Starting the scan second time without |
| * timeout will disable the timer. |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern tBTM_STATUS BTM_BleObserve(bool start, uint8_t duration, |
| tBTM_INQ_RESULTS_CB* p_results_cb, |
| tBTM_CMPL_CB* p_cmpl_cb); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleOpportunisticObserve |
| * |
| * Description Register/unregister opportunistic scan callback. This method |
| * does not trigger scan start/stop, but if scan is ever started, |
| * this callback would get called with scan results. Additionally, |
| * this callback is not reset on each scan start/stop. It's |
| * intended to be used by LE Audio related profiles, that would |
| * find yet unpaired members of CSIS set, or broadcasts. |
| * |
| * Parameters enable: enable/disable observing. |
| * p_results_cb: callback for results. |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern void BTM_BleOpportunisticObserve(bool enable, |
| tBTM_INQ_RESULTS_CB* p_results_cb); |
| |
| /** Returns local device encryption root (ER) */ |
| const Octet16& BTM_GetDeviceEncRoot(); |
| |
| /** Returns local device identity root (IR) */ |
| extern const Octet16& BTM_GetDeviceIDRoot(); |
| |
| /** Return local device DHK. */ |
| extern const Octet16& BTM_GetDeviceDHK(); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_SecurityGrant |
| * |
| * Description This function is called to grant security process. |
| * |
| * Parameters bd_addr - peer device bd address. |
| * res - result of the operation BTM_SUCCESS if success. |
| * Otherwise, BTM_REPEATED_ATTEMPTS is too many |
| * attempts. |
| * |
| * Returns None |
| * |
| ******************************************************************************/ |
| extern void BTM_SecurityGrant(const RawAddress& bd_addr, uint8_t res); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BlePasskeyReply |
| * |
| * Description This function is called after Security Manager submitted |
| * passkey request to the application. |
| * |
| * Parameters: bd_addr - Address of the device for which passkey was |
| * requested |
| * res - result of the operation SMP_SUCCESS if success |
| * passkey - numeric value in the range of |
| * BTM_MIN_PASSKEY_VAL(0) - |
| * BTM_MAX_PASSKEY_VAL(999999(0xF423F)). |
| * |
| ******************************************************************************/ |
| extern void BTM_BlePasskeyReply(const RawAddress& bd_addr, uint8_t res, |
| uint32_t passkey); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleConfirmReply |
| * |
| * Description This function is called after Security Manager submitted |
| * numeric comparison request to the application. |
| * |
| * Parameters: bd_addr - Address of the device with which numeric |
| * comparison was requested |
| * res - comparison result BTM_SUCCESS if success |
| * |
| ******************************************************************************/ |
| extern void BTM_BleConfirmReply(const RawAddress& bd_addr, uint8_t res); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_LeOobDataReply |
| * |
| * Description This function is called to provide the OOB data for |
| * SMP in response to BTM_LE_OOB_REQ_EVT |
| * |
| * Parameters: bd_addr - Address of the peer device |
| * res - result of the operation SMP_SUCCESS if success |
| * p_data - simple pairing Randomizer C. |
| * |
| ******************************************************************************/ |
| extern void BTM_BleOobDataReply(const RawAddress& bd_addr, uint8_t res, |
| uint8_t len, uint8_t* p_data); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleSecureConnectionOobDataReply |
| * |
| * Description This function is called to provide the OOB data for |
| * SMP in response to BTM_LE_OOB_REQ_EVT when secure connection |
| * data is available |
| * |
| * Parameters: bd_addr - Address of the peer device |
| * p_c - pointer to Confirmation |
| * p_r - pointer to Randomizer. |
| * |
| ******************************************************************************/ |
| extern void BTM_BleSecureConnectionOobDataReply(const RawAddress& bd_addr, |
| uint8_t* p_c, uint8_t* p_r); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleDataSignature |
| * |
| * Description This function is called to sign the data using AES128 CMAC |
| * algorith. |
| * |
| * Parameter bd_addr: target device the data to be signed for. |
| * p_text: singing data |
| * len: length of the signing data |
| * signature: output parameter where data signature is going to |
| * be stored. |
| * |
| * Returns true if signing sucessul, otherwise false. |
| * |
| ******************************************************************************/ |
| extern bool BTM_BleDataSignature(const RawAddress& bd_addr, uint8_t* p_text, |
| uint16_t len, BLE_SIGNATURE signature); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleVerifySignature |
| * |
| * Description This function is called to verify the data signature |
| * |
| * Parameter bd_addr: target device the data to be signed for. |
| * p_orig: original data before signature. |
| * len: length of the signing data |
| * counter: counter used when doing data signing |
| * p_comp: signature to be compared against. |
| |
| * Returns true if signature verified correctly; otherwise false. |
| * |
| ******************************************************************************/ |
| extern bool BTM_BleVerifySignature(const RawAddress& bd_addr, uint8_t* p_orig, |
| uint16_t len, uint32_t counter, |
| uint8_t* p_comp); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_IsBleConnection |
| * |
| * Description This function is called to check if the connection handle |
| * for an LE link |
| * |
| * Returns true if connection is LE link, otherwise false. |
| * |
| ******************************************************************************/ |
| extern bool BTM_IsBleConnection(uint16_t conn_handle); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_ReadRemoteConnectionAddr |
| * |
| * Description Read the remote device address currently used. |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern bool BTM_ReadRemoteConnectionAddr(const RawAddress& pseudo_addr, |
| RawAddress& conn_addr, |
| tBLE_ADDR_TYPE* p_addr_type); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleLoadLocalKeys |
| * |
| * Description Local local identity key, encryption root or sign counter. |
| * |
| * Parameters: key_type: type of key, can be BTM_BLE_KEY_TYPE_ID, |
| * BTM_BLE_KEY_TYPE_ER |
| * or BTM_BLE_KEY_TYPE_COUNTER. |
| * p_key: pointer to the key. |
| * |
| * Returns non2. |
| * |
| ******************************************************************************/ |
| extern void BTM_BleLoadLocalKeys(uint8_t key_type, tBTM_BLE_LOCAL_KEYS* p_key); |
| |
| #include "stack/btm/btm_ble_bgconn.h" |
| |
| /******************************************************** |
| * |
| * Function BTM_BleSetPrefConnParams |
| * |
| * Description Set a peripheral's preferred connection parameters. When |
| * any of the value does not want to be updated while others |
| * do, use BTM_BLE_CONN_PARAM_UNDEF for the ones want to |
| * leave untouched. |
| * |
| * Parameters: bd_addr - BD address of the peripheral |
| * min_conn_int - minimum preferred connection interval |
| * max_conn_int - maximum preferred connection interval |
| * peripheral_latency - preferred peripheral latency |
| * supervision_tout - preferred supervision timeout |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern void BTM_BleSetPrefConnParams(const RawAddress& bd_addr, |
| uint16_t min_conn_int, |
| uint16_t max_conn_int, |
| uint16_t peripheral_latency, |
| uint16_t supervision_tout); |
| |
| /****************************************************************************** |
| * |
| * Function BTM_BleReadControllerFeatures |
| * |
| * Description Reads BLE specific controller features |
| * |
| * Parameters: tBTM_BLE_CTRL_FEATURES_CBACK : Callback to notify when |
| * features are read |
| * |
| * Returns void |
| * |
| ******************************************************************************/ |
| extern void BTM_BleReadControllerFeatures( |
| tBTM_BLE_CTRL_FEATURES_CBACK* p_vsc_cback); |
| |
| /******************************************************************************* |
| * |
| * Function BTM__BLEReadDiscoverability |
| * |
| * Description This function is called to read the current LE |
| * discoverability mode of the device. |
| * |
| * Returns BTM_BLE_NON_DISCOVERABLE ,BTM_BLE_LIMITED_DISCOVERABLE or |
| * BTM_BLE_GENRAL_DISCOVERABLE |
| * |
| ******************************************************************************/ |
| uint16_t BTM_BleReadDiscoverability(); |
| |
| /******************************************************************************* |
| * |
| * Function BTM__BLEReadConnectability |
| * |
| * Description This function is called to read the current LE |
| * connectibility mode of the device. |
| * |
| * Returns BTM_BLE_NON_CONNECTABLE or BTM_BLE_CONNECTABLE |
| * |
| ******************************************************************************/ |
| extern uint16_t BTM_BleReadConnectability(); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_ReadDevInfo |
| * |
| * Description This function is called to read the device/address type |
| * of BD address. |
| * |
| * Parameter remote_bda: remote device address |
| * p_dev_type: output parameter to read the device type. |
| * p_addr_type: output parameter to read the address type. |
| * |
| ******************************************************************************/ |
| extern void BTM_ReadDevInfo(const RawAddress& remote_bda, |
| tBT_DEVICE_TYPE* p_dev_type, |
| tBLE_ADDR_TYPE* p_addr_type); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_ReadConnectedTransportAddress |
| * |
| * Description This function is called to read the paired device/address |
| * type of other device paired corresponding to the BD_address |
| * |
| * Parameter remote_bda: remote device address, carry out the transport |
| * address |
| * transport: active transport |
| * |
| * Return true if an active link is identified; false otherwise |
| * |
| ******************************************************************************/ |
| extern bool BTM_ReadConnectedTransportAddress(RawAddress* remote_bda, |
| tBT_TRANSPORT transport); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleConfigPrivacy |
| * |
| * Description This function is called to enable or disable the privacy in |
| * the local device. |
| * |
| * Parameters enable: true to enable it; false to disable it. |
| * |
| * Returns bool privacy mode set success; otherwise failed. |
| * |
| ******************************************************************************/ |
| extern bool BTM_BleConfigPrivacy(bool enable); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleLocalPrivacyEnabled |
| * |
| * Description Checks if local device supports private address |
| * |
| * Returns Return true if local privacy is enabled else false |
| * |
| ******************************************************************************/ |
| extern bool BTM_BleLocalPrivacyEnabled(void); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleMaxMultiAdvInstanceCount |
| * |
| * Description Returns the maximum number of multi adv instances supported |
| * by the controller. |
| * |
| * Returns Max multi adv instance count |
| * |
| ******************************************************************************/ |
| extern uint8_t BTM_BleMaxMultiAdvInstanceCount(); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleReceiverTest |
| * |
| * Description This function is called to start the LE Receiver test |
| * |
| * Parameter rx_freq - Frequency Range |
| * p_cmd_cmpl_cback - Command Complete callback |
| * |
| ******************************************************************************/ |
| void BTM_BleReceiverTest(uint8_t rx_freq, tBTM_CMPL_CB* p_cmd_cmpl_cback); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleTransmitterTest |
| * |
| * Description This function is called to start the LE Transmitter test |
| * |
| * Parameter tx_freq - Frequency Range |
| * test_data_len - Length in bytes of payload data in each |
| * packet |
| * packet_payload - Pattern to use in the payload |
| * p_cmd_cmpl_cback - Command Complete callback |
| * |
| ******************************************************************************/ |
| void BTM_BleTransmitterTest(uint8_t tx_freq, uint8_t test_data_len, |
| uint8_t packet_payload, |
| tBTM_CMPL_CB* p_cmd_cmpl_cback); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleTestEnd |
| * |
| * Description This function is called to stop the in-progress TX or RX test |
| * |
| * Parameter p_cmd_cmpl_cback - Command complete callback |
| * |
| ******************************************************************************/ |
| void BTM_BleTestEnd(tBTM_CMPL_CB* p_cmd_cmpl_cback); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_UseLeLink |
| * |
| * Description Select the underlying physical link to use. |
| * |
| * Returns true to use LE, false use BR/EDR. |
| * |
| ******************************************************************************/ |
| extern bool BTM_UseLeLink(const RawAddress& bd_addr); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleAdvFilterParamSetup |
| * |
| * Description This function is called to setup the adv data payload filter |
| * condition. |
| * |
| ******************************************************************************/ |
| extern void BTM_BleAdvFilterParamSetup( |
| tBTM_BLE_SCAN_COND_OP action, tBTM_BLE_PF_FILT_INDEX filt_index, |
| std::unique_ptr<btgatt_filt_param_setup_t> p_filt_params, |
| tBTM_BLE_PF_PARAM_CB cb); |
| |
| /** |
| * This functions are called to configure the adv data payload filter condition |
| */ |
| extern void BTM_LE_PF_set(tBTM_BLE_PF_FILT_INDEX filt_index, |
| std::vector<ApcfCommand> commands, |
| tBTM_BLE_PF_CFG_CBACK cb); |
| extern void BTM_LE_PF_clear(tBTM_BLE_PF_FILT_INDEX filt_index, |
| tBTM_BLE_PF_CFG_CBACK cb); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleEnableDisableFilterFeature |
| * |
| * Description Enable or disable the APCF feature |
| * |
| * Parameters enable - true - enables APCF, false - disables APCF |
| * |
| ******************************************************************************/ |
| extern void BTM_BleEnableDisableFilterFeature( |
| uint8_t enable, tBTM_BLE_PF_STATUS_CBACK p_stat_cback); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleGetEnergyInfo |
| * |
| * Description This function obtains the energy info |
| * |
| * Parameters p_ener_cback - Callback pointer |
| * |
| * Returns status |
| * |
| ******************************************************************************/ |
| extern tBTM_STATUS BTM_BleGetEnergyInfo( |
| tBTM_BLE_ENERGY_INFO_CBACK* p_ener_cback); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_SetBleDataLength |
| * |
| * Description Set the maximum BLE transmission packet size |
| * |
| * Returns BTM_SUCCESS if success; otherwise failed. |
| * |
| ******************************************************************************/ |
| extern tBTM_STATUS BTM_SetBleDataLength(const RawAddress& bd_addr, |
| uint16_t tx_pdu_length); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleReadPhy |
| * |
| * Description To read the current PHYs for specified LE connection |
| * |
| * |
| * Returns BTM_SUCCESS if success; otherwise failed. |
| * |
| ******************************************************************************/ |
| extern void BTM_BleReadPhy( |
| const RawAddress& bd_addr, |
| base::Callback<void(uint8_t tx_phy, uint8_t rx_phy, uint8_t status)> cb); |
| |
| /******************************************************************************* |
| * |
| * Function BTM_BleSetPhy |
| * |
| * Description To set PHY preferences for specified LE connection |
| * |
| * |
| * Returns BTM_SUCCESS if success; otherwise failed. |
| * |
| ******************************************************************************/ |
| extern void BTM_BleSetPhy(const RawAddress& bd_addr, uint8_t tx_phys, |
| uint8_t rx_phys, uint16_t phy_options); |
| |
| extern void btm_ble_multi_adv_cleanup(void); |
| |
| /******************************************************************************* |
| * |
| * Function btm_ble_get_acl_remote_addr |
| * |
| * Description This function reads the active remote address used for the |
| * connection. |
| * |
| * Returns success return true, otherwise false. |
| * |
| ******************************************************************************/ |
| bool btm_ble_get_acl_remote_addr(uint16_t hci_handle, RawAddress& conn_addr, |
| tBLE_ADDR_TYPE* p_addr_type); |
| |
| #endif |
