1 /* 2 * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD 3 * 4 * SPDX-License-Identifier: Apache-2.0 5 */ 6 7 #ifndef __ESP_BT_H__ 8 #define __ESP_BT_H__ 9 10 #include <stdint.h> 11 #include <stdbool.h> 12 #include "esp_err.h" 13 #include "sdkconfig.h" 14 #include "esp_task.h" 15 16 #include "nimble/nimble_npl.h" 17 #include "../../../../controller/esp32c2/esp_bt_cfg.h" 18 #include "hal/efuse_hal.h" 19 #include "esp_private/esp_modem_clock.h" 20 21 #ifdef CONFIG_BT_LE_HCI_INTERFACE_USE_UART 22 #include "driver/uart.h" 23 #endif 24 25 #ifdef __cplusplus 26 extern "C" { 27 #endif 28 29 /** 30 * @brief Bluetooth mode for controller enable/disable. 31 */ 32 typedef enum { 33 ESP_BT_MODE_IDLE = 0x00, /*!< Bluetooth is not running */ 34 ESP_BT_MODE_BLE = 0x01, /*!< Run BLE mode */ 35 ESP_BT_MODE_CLASSIC_BT = 0x02, /*!< Run Classic BT mode */ 36 ESP_BT_MODE_BTDM = 0x03, /*!< Run dual mode */ 37 } esp_bt_mode_t; 38 39 /** 40 * @brief Bluetooth controller enable/disable/initialised/de-initialised status. 41 */ 42 typedef enum { 43 ESP_BT_CONTROLLER_STATUS_IDLE = 0, /*!< Controller is in idle state */ 44 ESP_BT_CONTROLLER_STATUS_INITED, /*!< Controller is in initialising state */ 45 ESP_BT_CONTROLLER_STATUS_ENABLED, /*!< Controller is in enabled state */ 46 ESP_BT_CONTROLLER_STATUS_NUM, /*!< Controller is in disabled state */ 47 } esp_bt_controller_status_t; 48 49 /** 50 * @brief BLE tx power type 51 * ESP_BLE_PWR_TYPE_CONN_HDL0-8: for each connection, and only be set after connection completed. 52 * when disconnect, the correspond TX power is not effected. 53 * ESP_BLE_PWR_TYPE_ADV : for advertising/scan response. 54 * ESP_BLE_PWR_TYPE_SCAN : for scan. 55 * ESP_BLE_PWR_TYPE_DEFAULT : if each connection's TX power is not set, it will use this default value. 56 * if neither in scan mode nor in adv mode, it will use this default value. 57 * If none of power type is set, system will use ESP_PWR_LVL_P3 as default for ADV/SCAN/CONN0-9. 58 */ 59 typedef enum { 60 ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, /*!< For connection handle 0 */ 61 ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, /*!< For connection handle 1 */ 62 ESP_BLE_PWR_TYPE_CONN_HDL2 = 2, /*!< For connection handle 2 */ 63 ESP_BLE_PWR_TYPE_CONN_HDL3 = 3, /*!< For connection handle 3 */ 64 ESP_BLE_PWR_TYPE_CONN_HDL4 = 4, /*!< For connection handle 4 */ 65 ESP_BLE_PWR_TYPE_CONN_HDL5 = 5, /*!< For connection handle 5 */ 66 ESP_BLE_PWR_TYPE_CONN_HDL6 = 6, /*!< For connection handle 6 */ 67 ESP_BLE_PWR_TYPE_CONN_HDL7 = 7, /*!< For connection handle 7 */ 68 ESP_BLE_PWR_TYPE_CONN_HDL8 = 8, /*!< For connection handle 8 */ 69 ESP_BLE_PWR_TYPE_ADV = 9, /*!< For advertising */ 70 ESP_BLE_PWR_TYPE_SCAN = 10, /*!< For scan */ 71 ESP_BLE_PWR_TYPE_DEFAULT = 11, /*!< For default, if not set other, it will use default value */ 72 ESP_BLE_PWR_TYPE_NUM = 12, /*!< TYPE numbers */ 73 } esp_ble_power_type_t; 74 75 /** 76 * @brief Bluetooth TX power level(index), it's just a index corresponding to power(dbm). 77 */ 78 typedef enum { 79 ESP_PWR_LVL_N24 = 0, /*!< Corresponding to -24dbm */ 80 ESP_PWR_LVL_N21 = 1, /*!< Corresponding to -21dbm */ 81 ESP_PWR_LVL_N18 = 2, /*!< Corresponding to -18dbm */ 82 ESP_PWR_LVL_N15 = 3, /*!< Corresponding to -15dbm */ 83 ESP_PWR_LVL_N12 = 4, /*!< Corresponding to -12dbm */ 84 ESP_PWR_LVL_N9 = 5, /*!< Corresponding to -9dbm */ 85 ESP_PWR_LVL_N6 = 6, /*!< Corresponding to -6dbm */ 86 ESP_PWR_LVL_N3 = 7, /*!< Corresponding to -3dbm */ 87 ESP_PWR_LVL_N0 = 8, /*!< Corresponding to 0dbm */ 88 ESP_PWR_LVL_P3 = 9, /*!< Corresponding to +3dbm */ 89 ESP_PWR_LVL_P6 = 10, /*!< Corresponding to +6dbm */ 90 ESP_PWR_LVL_P9 = 11, /*!< Corresponding to +9dbm */ 91 ESP_PWR_LVL_P12 = 12, /*!< Corresponding to +12dbm */ 92 ESP_PWR_LVL_P15 = 13, /*!< Corresponding to +15dbm */ 93 ESP_PWR_LVL_P18 = 14, /*!< Corresponding to +18dbm */ 94 ESP_PWR_LVL_P20 = 15, /*!< Corresponding to +20dbm */ 95 ESP_PWR_LVL_P21 = 15, /*!< Corresponding to +20dbm, this enum variable has been deprecated */ 96 ESP_PWR_LVL_INVALID = 0xFF, /*!< Indicates an invalid value */ 97 } esp_power_level_t; 98 99 /** 100 * @brief The enhanced type of which tx power, could set Advertising/Connection/Default and etc. 101 */ 102 typedef enum { 103 ESP_BLE_ENHANCED_PWR_TYPE_DEFAULT = 0, 104 ESP_BLE_ENHANCED_PWR_TYPE_ADV, 105 ESP_BLE_ENHANCED_PWR_TYPE_SCAN, 106 ESP_BLE_ENHANCED_PWR_TYPE_INIT, 107 ESP_BLE_ENHANCED_PWR_TYPE_CONN, 108 ESP_BLE_ENHANCED_PWR_TYPE_MAX, 109 } esp_ble_enhanced_power_type_t; 110 111 /** 112 * @brief Select buffers 113 */ 114 typedef enum { 115 ESP_BLE_LOG_BUF_HCI = 0x02, 116 ESP_BLE_LOG_BUF_CONTROLLER = 0x05, 117 } esp_ble_log_buf_t; 118 119 /** 120 * @brief Address type and address value. 121 */ 122 typedef struct { 123 uint8_t type; /*!< Type of the Bluetooth address (public, random, etc.) */ 124 uint8_t val[6]; /*!< Array containing the 6-byte Bluetooth address value */ 125 } esp_ble_addr_t; 126 127 /** 128 * @brief Set BLE TX power 129 * Connection Tx power should only be set after connection created. 130 * @param power_type : The type of which tx power, could set Advertising/Connection/Default and etc 131 * @param power_level: Power level(index) corresponding to absolute value(dbm) 132 * @return ESP_OK - success, other - failed 133 */ 134 esp_err_t esp_ble_tx_power_set(esp_ble_power_type_t power_type, esp_power_level_t power_level); 135 136 /** 137 * @brief Get BLE TX power 138 * Connection Tx power should only be get after connection created. 139 * @param power_type : The type of which tx power, could set Advertising/Connection/Default and etc 140 * @return >= 0 - Power level, < 0 - Invalid 141 */ 142 esp_power_level_t esp_ble_tx_power_get(esp_ble_power_type_t power_type); 143 144 /** 145 * @brief ENHANCED API for Setting BLE TX power 146 * Connection Tx power should only be set after connection created. 147 * @param power_type : The enhanced type of which tx power, could set Advertising/Connection/Default and etc 148 * @param handle : The handle of Advertising or Connection and the value 0 for other enhanced power types. 149 * @param power_level: Power level(index) corresponding to absolute value(dbm) 150 * @return ESP_OK - success, other - failed 151 */ 152 esp_err_t esp_ble_tx_power_set_enhanced(esp_ble_enhanced_power_type_t power_type, uint16_t handle, esp_power_level_t power_level); 153 154 /** 155 * @brief ENHANCED API of Getting BLE TX power 156 * Connection Tx power should only be get after connection created. 157 * @param power_type : The enhanced type of which tx power, could set Advertising/Connection/Default and etc 158 * @param handle : The handle of Advertising or Connection and the value 0 for other enhanced power types. 159 * @return >= 0 - Power level, < 0 - Invalid 160 */ 161 esp_power_level_t esp_ble_tx_power_get_enhanced(esp_ble_enhanced_power_type_t power_type, uint16_t handle); 162 163 /** 164 * @brief Get version number from chip revision number 165 * 166 * @return uint8_t version_number 167 */ 168 uint8_t esp_ble_get_chip_rev_version(void); 169 170 #define CONFIG_VERSION 0x20241121 171 #define CONFIG_MAGIC 0x5A5AA5A5 172 173 /** 174 * @brief Controller config options, depend on config mask. 175 * Config mask indicate which functions enabled, this means 176 * some options or parameters of some functions enabled by config mask. 177 */ 178 typedef struct { 179 uint32_t config_version; /*!< Version number of the defined structure */ 180 uint16_t ble_ll_resolv_list_size; /*!< Size of the resolvable private address list */ 181 uint16_t ble_hci_evt_hi_buf_count; /*!< Count of high buffers for HCI events */ 182 uint16_t ble_hci_evt_lo_buf_count; /*!< Count of low buffers for HCI events */ 183 uint8_t ble_ll_sync_list_cnt; /*!< Number of synchronization lists */ 184 uint8_t ble_ll_sync_cnt; /*!< Number of synchronizations */ 185 uint16_t ble_ll_rsp_dup_list_count; /*!< Count of duplicated lists for scan response packets */ 186 uint16_t ble_ll_adv_dup_list_count; /*!< Count of duplicated lists for advertising packets */ 187 uint8_t ble_ll_tx_pwr_dbm; /*!< Tx power (transmit power) in dBm */ 188 uint64_t rtc_freq; /*!< Frequency of RTC (Real-Time Clock) */ 189 uint16_t ble_ll_sca; /*!< Sleep Clock Accuracy (SCA) parameter */ 190 uint8_t ble_ll_scan_phy_number; /*!< Number of PHYs supported for scanning */ 191 uint16_t ble_ll_conn_def_auth_pyld_tmo; /*!< Connection default authentication payload timeout */ 192 uint8_t ble_ll_jitter_usecs; /*!< Jitter time in microseconds */ 193 uint16_t ble_ll_sched_max_adv_pdu_usecs; /*!< Maximum time in microseconds for advertising PDU scheduling */ 194 uint16_t ble_ll_sched_direct_adv_max_usecs; /*!< Maximum time in microseconds for directed advertising scheduling */ 195 uint16_t ble_ll_sched_adv_max_usecs; /*!< Maximum time in microseconds for advertising scheduling */ 196 uint16_t ble_scan_rsp_data_max_len; /*!< Maximum length of scan response data */ 197 uint8_t ble_ll_cfg_num_hci_cmd_pkts; /*!< Number of HCI command packets that can be queued */ 198 uint32_t ble_ll_ctrl_proc_timeout_ms; /*!< Control processing timeout in milliseconds */ 199 uint16_t nimble_max_connections; /*!< Maximum number of connections supported */ 200 uint8_t ble_whitelist_size; /*!< Size of the white list */ 201 uint16_t ble_acl_buf_size; /*!< Buffer size of ACL (Asynchronous Connection-Less) data */ 202 uint16_t ble_acl_buf_count; /*!< Buffer count of ACL data */ 203 uint16_t ble_hci_evt_buf_size; /*!< Buffer size for HCI event data */ 204 uint16_t ble_multi_adv_instances; /*!< Number of advertising instances */ 205 uint16_t ble_ext_adv_max_size; /*!< Maximum size of extended advertising data */ 206 uint16_t controller_task_stack_size; /*!< Size of Bluetooth controller task stack */ 207 uint8_t controller_task_prio; /*!< Priority of the Bluetooth task */ 208 uint8_t controller_run_cpu; /*!< CPU number on which the Bluetooth controller task runs */ 209 uint8_t enable_qa_test; /*!< Enable for QA test */ 210 uint8_t enable_bqb_test; /*!< Enable for BQB test */ 211 uint8_t enable_uart_hci; /*!< Enable UART for HCI (Host Controller Interface) */ 212 uint8_t ble_hci_uart_port; /*!< Port of UART for HCI */ 213 uint32_t ble_hci_uart_baud; /*!< Baudrate of UART for HCI */ 214 uint8_t ble_hci_uart_data_bits; /*!< Data bits of UART for HCI */ 215 uint8_t ble_hci_uart_stop_bits; /*!< Stop bits of UART for HCI */ 216 uint8_t ble_hci_uart_flow_ctrl; /*!< Flow control of UART for HCI */ 217 uint8_t ble_hci_uart_uart_parity; /*!< UART parity */ 218 uint8_t enable_tx_cca; /*!< Enable Clear Channel Assessment (CCA) when transmitting */ 219 uint8_t cca_rssi_thresh; /*!< RSSI threshold for CCA */ 220 uint8_t sleep_en; /*!< Enable sleep functionality */ 221 uint8_t coex_phy_coded_tx_rx_time_limit; /*!< Coexistence PHY coded TX and RX time limit */ 222 uint8_t dis_scan_backoff; /*!< Disable scan backoff */ 223 uint8_t ble_scan_classify_filter_enable; /*!< Enable classification filter for BLE scan */ 224 uint8_t cca_drop_mode; /*!< CCA drop mode */ 225 int8_t cca_low_tx_pwr; /*!< Low TX power setting for CCA */ 226 uint8_t main_xtal_freq; /*!< Main crystal frequency */ 227 uint8_t version_num; /*!< Version number */ 228 uint8_t ignore_wl_for_direct_adv; /*!< Ignore the white list for directed advertising */ 229 uint8_t csa2_select; /*!< Select CSA#2 */ 230 uint8_t ble_aa_check; /*!< True if adds a verification step for the Access Address within the CONNECT_IND PDU; false otherwise. Configurable in menuconfig */ 231 uint32_t config_magic; /*!< Configuration magic value */ 232 } esp_bt_controller_config_t; 233 234 #define BT_CONTROLLER_INIT_CONFIG_DEFAULT() { \ 235 .config_version = CONFIG_VERSION, \ 236 .ble_ll_resolv_list_size = CONFIG_BT_LE_LL_RESOLV_LIST_SIZE, \ 237 .ble_hci_evt_hi_buf_count = DEFAULT_BT_LE_HCI_EVT_HI_BUF_COUNT, \ 238 .ble_hci_evt_lo_buf_count = DEFAULT_BT_LE_HCI_EVT_LO_BUF_COUNT, \ 239 .ble_ll_sync_list_cnt = DEFAULT_BT_LE_MAX_PERIODIC_ADVERTISER_LIST, \ 240 .ble_ll_sync_cnt = DEFAULT_BT_LE_MAX_PERIODIC_SYNCS, \ 241 .ble_ll_rsp_dup_list_count = CONFIG_BT_LE_LL_DUP_SCAN_LIST_COUNT, \ 242 .ble_ll_adv_dup_list_count = CONFIG_BT_LE_LL_DUP_SCAN_LIST_COUNT, \ 243 .ble_ll_tx_pwr_dbm = BLE_LL_TX_PWR_DBM_N, \ 244 .rtc_freq = RTC_FREQ_N, \ 245 .ble_ll_sca = CONFIG_BT_LE_LL_SCA, \ 246 .ble_ll_scan_phy_number = BLE_LL_SCAN_PHY_NUMBER_N, \ 247 .ble_ll_conn_def_auth_pyld_tmo = BLE_LL_CONN_DEF_AUTH_PYLD_TMO_N, \ 248 .ble_ll_jitter_usecs = BLE_LL_JITTER_USECS_N, \ 249 .ble_ll_sched_max_adv_pdu_usecs = BLE_LL_SCHED_MAX_ADV_PDU_USECS_N, \ 250 .ble_ll_sched_direct_adv_max_usecs = BLE_LL_SCHED_DIRECT_ADV_MAX_USECS_N, \ 251 .ble_ll_sched_adv_max_usecs = BLE_LL_SCHED_ADV_MAX_USECS_N, \ 252 .ble_scan_rsp_data_max_len = DEFAULT_BT_LE_SCAN_RSP_DATA_MAX_LEN_N, \ 253 .ble_ll_cfg_num_hci_cmd_pkts = BLE_LL_CFG_NUM_HCI_CMD_PKTS_N, \ 254 .ble_ll_ctrl_proc_timeout_ms = BLE_LL_CTRL_PROC_TIMEOUT_MS_N, \ 255 .nimble_max_connections = DEFAULT_BT_LE_MAX_CONNECTIONS, \ 256 .ble_whitelist_size = DEFAULT_BT_NIMBLE_WHITELIST_SIZE, \ 257 .ble_acl_buf_size = DEFAULT_BT_LE_ACL_BUF_SIZE, \ 258 .ble_acl_buf_count = DEFAULT_BT_LE_ACL_BUF_COUNT, \ 259 .ble_hci_evt_buf_size = DEFAULT_BT_LE_HCI_EVT_BUF_SIZE, \ 260 .ble_multi_adv_instances = DEFAULT_BT_LE_MAX_EXT_ADV_INSTANCES, \ 261 .ble_ext_adv_max_size = DEFAULT_BT_LE_EXT_ADV_MAX_SIZE, \ 262 .controller_task_stack_size = NIMBLE_LL_STACK_SIZE, \ 263 .controller_task_prio = ESP_TASK_BT_CONTROLLER_PRIO, \ 264 .controller_run_cpu = 0, \ 265 .enable_qa_test = RUN_QA_TEST, \ 266 .enable_bqb_test = RUN_BQB_TEST, \ 267 .enable_tx_cca = DEFAULT_BT_LE_TX_CCA_ENABLED, \ 268 .cca_rssi_thresh = 256 - DEFAULT_BT_LE_CCA_RSSI_THRESH, \ 269 .sleep_en = NIMBLE_SLEEP_ENABLE, \ 270 .coex_phy_coded_tx_rx_time_limit = DEFAULT_BT_LE_COEX_PHY_CODED_TX_RX_TLIM_EFF, \ 271 .dis_scan_backoff = NIMBLE_DISABLE_SCAN_BACKOFF, \ 272 .ble_scan_classify_filter_enable = 0, \ 273 .main_xtal_freq = CONFIG_XTAL_FREQ, \ 274 .version_num = esp_ble_get_chip_rev_version(), \ 275 .ignore_wl_for_direct_adv = 0, \ 276 .csa2_select = DEFAULT_BT_LE_50_FEATURE_SUPPORT, \ 277 .ble_aa_check = DEFAULT_BT_LE_CTRL_CHECK_CONNECT_IND_ACCESS_ADDRESS, \ 278 .config_magic = CONFIG_MAGIC, \ 279 } 280 281 /** 282 * @brief Initialize BT controller to allocate task and other resource. 283 * This function should be called only once, before any other BT functions are called. 284 * @param cfg: Initial configuration of BT controller. 285 * @return ESP_OK - success, other - failed 286 */ 287 esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg); 288 289 /** 290 * @brief Get BT controller is initialised/de-initialised/enabled/disabled 291 * @return status value 292 */ 293 esp_bt_controller_status_t esp_bt_controller_get_status(void); 294 295 /** 296 * @brief Get BLE TX power 297 * Connection Tx power should only be get after connection created. 298 * @param power_type : The type of which tx power, could set Advertising/Connection/Default and etc 299 * @return >= 0 - Power level, < 0 - Invalid 300 */ 301 esp_power_level_t esp_ble_tx_power_get(esp_ble_power_type_t power_type); 302 303 /** 304 * @brief De-initialize BT controller to free resource and delete task. 305 * You should stop advertising and scanning, as well as 306 * disconnect all existing connections before de-initializing BT controller. 307 * 308 * This function should be called only once, after any other BT functions are called. 309 * This function is not whole completed, esp_bt_controller_init cannot called after this function. 310 * @return ESP_OK - success, other - failed 311 */ 312 esp_err_t esp_bt_controller_deinit(void); 313 314 /** 315 * @brief Enable BT controller. 316 * Due to a known issue, you cannot call esp_bt_controller_enable() a second time 317 * to change the controller mode dynamically. To change controller mode, call 318 * esp_bt_controller_disable() and then call esp_bt_controller_enable() with the new mode. 319 * @param mode : the mode(BLE/BT/BTDM) to enable. For compatible of API, retain this argument. 320 * @return ESP_OK - success, other - failed 321 */ 322 esp_err_t esp_bt_controller_enable(esp_bt_mode_t mode); 323 324 /** 325 * @brief Disable BT controller 326 * @return ESP_OK - success, other - failed 327 */ 328 esp_err_t esp_bt_controller_disable(void); 329 330 /** @brief esp_vhci_host_callback 331 * used for vhci call host function to notify what host need to do 332 */ 333 typedef struct esp_vhci_host_callback { 334 void (*notify_host_send_available)(void); /*!< callback used to notify that the host can send packet to controller */ 335 int (*notify_host_recv)(uint8_t *data, uint16_t len); /*!< callback used to notify that the controller has a packet to send to the host*/ 336 } esp_vhci_host_callback_t; 337 338 /** @brief esp_vhci_host_check_send_available 339 * used for check actively if the host can send packet to controller or not. 340 * @return true for ready to send, false means cannot send packet 341 */ 342 bool esp_vhci_host_check_send_available(void); 343 344 /** @brief esp_vhci_host_send_packet 345 * host send packet to controller 346 * 347 * Should not call this function from within a critical section 348 * or when the scheduler is suspended. 349 * 350 * @param data the packet point 351 * @param len the packet length 352 */ 353 void esp_vhci_host_send_packet(uint8_t *data, uint16_t len); 354 355 /** @brief esp_vhci_host_register_callback 356 * register the vhci reference callback 357 * struct defined by vhci_host_callback structure. 358 * @param callback esp_vhci_host_callback type variable 359 * @return ESP_OK - success, ESP_FAIL - failed 360 */ 361 esp_err_t esp_vhci_host_register_callback(const esp_vhci_host_callback_t *callback); 362 363 /** @brief esp_bt_controller_mem_release 364 * release the controller memory as per the mode 365 * 366 * This function releases the BSS, data and other sections of the controller to heap. The total size is about 70k bytes. 367 * 368 * esp_bt_controller_mem_release(mode) should be called only before esp_bt_controller_init() 369 * or after esp_bt_controller_deinit(). 370 * 371 * Note that once BT controller memory is released, the process cannot be reversed. It means you cannot use the bluetooth 372 * mode which you have released by this function. 373 * 374 * If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled) 375 * then do not call this function. 376 * 377 * If the app calls esp_bt_controller_enable(ESP_BT_MODE_BLE) to use BLE only then it is safe to call 378 * esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT) at initialization time to free unused BT Classic memory. 379 * 380 * If the mode is ESP_BT_MODE_BTDM, then it may be useful to call API esp_bt_mem_release(ESP_BT_MODE_BTDM) instead, 381 * which internally calls esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) and additionally releases the BSS and data 382 * consumed by the BT/BLE host stack to heap. For more details about usage please refer to the documentation of 383 * esp_bt_mem_release() function 384 * 385 * @param mode : the mode want to release memory 386 * @return ESP_OK - success, other - failed 387 */ 388 esp_err_t esp_bt_controller_mem_release(esp_bt_mode_t mode); 389 390 /** @brief esp_bt_mem_release 391 * release controller memory and BSS and data section of the BT/BLE host stack as per the mode 392 * 393 * This function first releases controller memory by internally calling esp_bt_controller_mem_release(). 394 * Additionally, if the mode is set to ESP_BT_MODE_BTDM, it also releases the BSS and data consumed by the BT/BLE host stack to heap 395 * 396 * Note that once BT memory is released, the process cannot be reversed. It means you cannot use the bluetooth 397 * mode which you have released by this function. 398 * 399 * If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled) 400 * then do not call this function. 401 * 402 * If you never intend to use bluetooth in a current boot-up cycle, you can call esp_bt_mem_release(ESP_BT_MODE_BTDM) 403 * before esp_bt_controller_init or after esp_bt_controller_deinit. 404 * 405 * For example, if a user only uses bluetooth for setting the WiFi configuration, and does not use bluetooth in the rest of the product operation". 406 * In such cases, after receiving the WiFi configuration, you can disable/deinit bluetooth and release its memory. 407 * Below is the sequence of APIs to be called for such scenarios: 408 * 409 * esp_bluedroid_disable(); 410 * esp_bluedroid_deinit(); 411 * esp_bt_controller_disable(); 412 * esp_bt_controller_deinit(); 413 * esp_bt_mem_release(ESP_BT_MODE_BTDM); 414 * 415 * @param mode : the mode whose memory is to be released 416 * @return ESP_OK - success, other - failed 417 */ 418 esp_err_t esp_bt_mem_release(esp_bt_mode_t mode); 419 420 /** 421 * @brief Returns random static address or -1 if not present. 422 * @return ESP_OK - success, other - failed 423 */ 424 extern int esp_ble_hw_get_static_addr(esp_ble_addr_t *addr); 425 426 #if CONFIG_BT_LE_CONTROLLER_LOG_ENABLED 427 /** 428 * @brief dump all controller log information cached in buffer 429 * @param output : true for log dump, false will take no effect 430 */ 431 void esp_ble_controller_log_dump_all(bool output); 432 #endif // CONFIG_BT_LE_CONTROLLER_LOG_ENABLED 433 434 #if CONFIG_PM_ENABLE 435 modem_clock_lpclk_src_t esp_bt_get_lpclk_src(void); 436 437 void esp_bt_set_lpclk_src(modem_clock_lpclk_src_t clk_src); 438 #endif // CONFIG_PM_ENABLE 439 440 #ifdef __cplusplus 441 } 442 #endif 443 444 #endif /* __ESP_BT_H__ */ 445
