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/esp32c6/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_N15 = 3,              /*!< Corresponding to -15dbm */
80     ESP_PWR_LVL_N12 = 4,              /*!< Corresponding to -12dbm */
81     ESP_PWR_LVL_N9  = 5,              /*!< Corresponding to  -9dbm */
82     ESP_PWR_LVL_N6  = 6,              /*!< Corresponding to  -6dbm */
83     ESP_PWR_LVL_N3  = 7,              /*!< Corresponding to  -3dbm */
84     ESP_PWR_LVL_N0  = 8,              /*!< Corresponding to   0dbm */
85     ESP_PWR_LVL_P3  = 9,             /*!< Corresponding to  +3dbm */
86     ESP_PWR_LVL_P6  = 10,             /*!< Corresponding to  +6dbm */
87     ESP_PWR_LVL_P9  = 11,             /*!< Corresponding to  +9dbm */
88     ESP_PWR_LVL_P12 = 12,             /*!< Corresponding to  +12dbm */
89     ESP_PWR_LVL_P15 = 13,             /*!< Corresponding to  +15dbm */
90     ESP_PWR_LVL_P18 = 14,             /*!< Corresponding to  +18dbm */
91     ESP_PWR_LVL_P20 = 15,              /*!< Corresponding to  +20dbm */
92     ESP_PWR_LVL_INVALID = 0xFF,         /*!< Indicates an invalid value */
93 } esp_power_level_t;
94 
95 /**
96  * @brief The enhanced type of which tx power, could set Advertising/Connection/Default and etc.
97  */
98 typedef enum {
99     ESP_BLE_ENHANCED_PWR_TYPE_DEFAULT = 0,
100     ESP_BLE_ENHANCED_PWR_TYPE_ADV,
101     ESP_BLE_ENHANCED_PWR_TYPE_SCAN,
102     ESP_BLE_ENHANCED_PWR_TYPE_INIT,
103     ESP_BLE_ENHANCED_PWR_TYPE_CONN,
104     ESP_BLE_ENHANCED_PWR_TYPE_MAX,
105 } esp_ble_enhanced_power_type_t;
106 
107 /**
108  * @brief Select buffers
109 */
110 typedef enum {
111     ESP_BLE_LOG_BUF_HCI         = 0x02,
112     ESP_BLE_LOG_BUF_CONTROLLER  = 0x05,
113 } esp_ble_log_buf_t;
114 
115 /**
116  * @brief Address type and address value.
117  */
118 typedef struct {
119     uint8_t type;     /*!< Type of the Bluetooth address (public, random, etc.) */
120     uint8_t val[6];   /*!< Array containing the 6-byte Bluetooth address value */
121 } esp_ble_addr_t;
122 
123 /**
124  * @brief  Set BLE TX power
125  *         Connection Tx power should only be set after connection created.
126  * @param  power_type : The type of which tx power, could set Advertising/Connection/Default and etc
127  * @param  power_level: Power level(index) corresponding to absolute value(dbm)
128  * @return              ESP_OK - success, other - failed
129  */
130 esp_err_t esp_ble_tx_power_set(esp_ble_power_type_t power_type, esp_power_level_t power_level);
131 
132 /**
133  * @brief  Get BLE TX power
134  *         Connection Tx power should only be get after connection created.
135  * @param  power_type : The type of which tx power, could set Advertising/Connection/Default and etc
136  * @return             >= 0 - Power level, < 0 - Invalid
137  */
138 esp_power_level_t esp_ble_tx_power_get(esp_ble_power_type_t power_type);
139 
140 /**
141  * @brief  ENHANCED API for Setting BLE TX power
142  *         Connection Tx power should only be set after connection created.
143  * @param  power_type : The enhanced type of which tx power, could set Advertising/Connection/Default and etc.
144  * @param  handle : The handle of Advertising or Connection and the value 0 for other enhanced power types.
145  * @param  power_level: Power level(index) corresponding to absolute value(dbm)
146  * @return              ESP_OK - success, other - failed
147  */
148 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);
149 
150 /**
151  * @brief  ENHANCED API of Getting BLE TX power
152  *         Connection Tx power should only be get after connection created.
153  * @param  power_type : The enhanced type of which tx power, could set Advertising/Connection/Default and etc
154  * @param  handle : The handle of Advertising or Connection and the value 0 for other enhanced power types.
155  * @return             >= 0 - Power level, < 0 - Invalid
156  */
157 esp_power_level_t esp_ble_tx_power_get_enhanced(esp_ble_enhanced_power_type_t power_type, uint16_t handle);
158 
159 #define CONFIG_VERSION  0x20241121
160 #define CONFIG_MAGIC    0x5A5AA5A5
161 
162 /**
163  * @brief Controller config options, depend on config mask.
164  *        Config mask indicate which functions enabled, this means
165  *        some options or parameters of some functions enabled by config mask.
166  */
167 typedef struct {
168     uint32_t config_version;                         /*!< Configuration version */
169     uint16_t ble_ll_resolv_list_size;                /*!< Size of the BLE resolving list */
170     uint16_t ble_hci_evt_hi_buf_count;               /*!< Number of high priority HCI event buffers */
171     uint16_t ble_hci_evt_lo_buf_count;               /*!< Number of low priority HCI event buffers */
172     uint8_t ble_ll_sync_list_cnt;                    /*!< Number of entries in the BLE sync list */
173     uint8_t ble_ll_sync_cnt;                         /*!< Number of BLE sync instances */
174     uint16_t ble_ll_rsp_dup_list_count;              /*!< Size of the BLE response duplicate list */
175     uint16_t ble_ll_adv_dup_list_count;              /*!< Size of the BLE advertising duplicate list */
176     uint8_t ble_ll_tx_pwr_dbm;                       /*!< BLE transmit power in dBm */
177     uint64_t rtc_freq;                               /*!< RTC (Real-Time Clock) frequency */
178     uint16_t ble_ll_sca;                             /*!< BLE sleep clock accuracy in ppm */
179     uint8_t ble_ll_scan_phy_number;                  /*!< Number of BLE scanning physical layers */
180     uint16_t ble_ll_conn_def_auth_pyld_tmo;          /*!< BLE connection default authentication payload timeout */
181     uint8_t ble_ll_jitter_usecs;                     /*!< BLE link layer jitter in microseconds */
182     uint16_t ble_ll_sched_max_adv_pdu_usecs;         /*!< BLE scheduler maximum advertising PDU duration in microseconds */
183     uint16_t ble_ll_sched_direct_adv_max_usecs;      /*!< BLE scheduler maximum direct advertising duration in microseconds */
184     uint16_t ble_ll_sched_adv_max_usecs;             /*!< BLE scheduler maximum advertising duration in microseconds */
185     uint16_t ble_scan_rsp_data_max_len;              /*!< Maximum length of BLE scan response data */
186     uint8_t ble_ll_cfg_num_hci_cmd_pkts;             /*!< Number of BLE LL configuration HCI command packets */
187     uint32_t ble_ll_ctrl_proc_timeout_ms;            /*!< BLE link layer controller process timeout in milliseconds */
188     uint16_t nimble_max_connections;                 /*!< Maximum number of concurrent BLE connections */
189     uint8_t ble_whitelist_size;                      /*!< Size of the BLE whitelist */
190     uint16_t ble_acl_buf_size;                       /*!< Size of the BLE ACL data buffer */
191     uint16_t ble_acl_buf_count;                      /*!< Number of BLE ACL data buffers */
192     uint16_t ble_hci_evt_buf_size;                   /*!< Size of the BLE HCI event buffer */
193     uint16_t ble_multi_adv_instances;                /*!< Number of BLE multi-advertising instances */
194     uint16_t ble_ext_adv_max_size;                   /*!< Maximum size of BLE extended advertising data */
195     uint16_t controller_task_stack_size;             /*!< Controller task stack size */
196     uint8_t controller_task_prio;                    /*!< Controller task priority */
197     uint8_t controller_run_cpu;                      /*!< CPU core on which the controller runs */
198     uint8_t enable_qa_test;                          /*!< Enable quality assurance (QA) testing */
199     uint8_t enable_bqb_test;                         /*!< Enable Bluetooth Qualification Test (BQB) testing */
200     uint8_t enable_tx_cca;                           /*!< Enable Transmit Clear Channel Assessment (TX CCA) */
201     uint8_t cca_rssi_thresh;                         /*!< RSSI threshold for Transmit Clear Channel Assessment (CCA) */
202     uint8_t sleep_en;                                /*!< Enable sleep mode */
203     uint8_t coex_phy_coded_tx_rx_time_limit;         /*!< PHY coded transmission and reception time limit for coexistence */
204     uint8_t dis_scan_backoff;                        /*!< Disable scan backoff */
205     uint8_t ble_scan_classify_filter_enable;         /*!< Enable BLE scan classify filter */
206     uint8_t cca_drop_mode;                           /*!< CCA drop mode */
207     int8_t cca_low_tx_pwr;                           /*!< CCA low transmit power */
208     uint8_t main_xtal_freq;                          /*!< Main crystal frequency */
209     uint32_t version_num;                            /*!< Controller configuration version number */
210     uint8_t cpu_freq_mhz;                            /*!< CPU frequency in megahertz (MHz) */
211     uint8_t ignore_wl_for_direct_adv;                /*!< Ignore the whitelist for direct advertising */
212     uint8_t enable_pcl;                              /*!< Enable power control */
213     uint8_t csa2_select;                             /*!< Select CSA#2*/
214     uint8_t enable_csr;                              /*!< Enable CSR */
215     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 */
216     uint32_t config_magic;                           /*!< Magic number for configuration validation */
217 } esp_bt_controller_config_t;
218 
219 #define BT_CONTROLLER_INIT_CONFIG_DEFAULT() {                                           \
220     .config_version = CONFIG_VERSION,                                                   \
221     .ble_ll_resolv_list_size = CONFIG_BT_LE_LL_RESOLV_LIST_SIZE,                        \
222     .ble_hci_evt_hi_buf_count = DEFAULT_BT_LE_HCI_EVT_HI_BUF_COUNT,                     \
223     .ble_hci_evt_lo_buf_count = DEFAULT_BT_LE_HCI_EVT_LO_BUF_COUNT,                     \
224     .ble_ll_sync_list_cnt = DEFAULT_BT_LE_MAX_PERIODIC_ADVERTISER_LIST,                 \
225     .ble_ll_sync_cnt = DEFAULT_BT_LE_MAX_PERIODIC_SYNCS,                                \
226     .ble_ll_rsp_dup_list_count = CONFIG_BT_LE_LL_DUP_SCAN_LIST_COUNT,                   \
227     .ble_ll_adv_dup_list_count = CONFIG_BT_LE_LL_DUP_SCAN_LIST_COUNT,                   \
228     .ble_ll_tx_pwr_dbm = BLE_LL_TX_PWR_DBM_N,                                           \
229     .rtc_freq = RTC_FREQ_N,                                                             \
230     .ble_ll_sca = CONFIG_BT_LE_LL_SCA,                                                  \
231     .ble_ll_scan_phy_number = BLE_LL_SCAN_PHY_NUMBER_N,                                 \
232     .ble_ll_conn_def_auth_pyld_tmo = BLE_LL_CONN_DEF_AUTH_PYLD_TMO_N,                   \
233     .ble_ll_jitter_usecs = BLE_LL_JITTER_USECS_N,                                       \
234     .ble_ll_sched_max_adv_pdu_usecs = BLE_LL_SCHED_MAX_ADV_PDU_USECS_N,                 \
235     .ble_ll_sched_direct_adv_max_usecs = BLE_LL_SCHED_DIRECT_ADV_MAX_USECS_N,           \
236     .ble_ll_sched_adv_max_usecs = BLE_LL_SCHED_ADV_MAX_USECS_N,                         \
237     .ble_scan_rsp_data_max_len = DEFAULT_BT_LE_SCAN_RSP_DATA_MAX_LEN_N,                 \
238     .ble_ll_cfg_num_hci_cmd_pkts = BLE_LL_CFG_NUM_HCI_CMD_PKTS_N,                       \
239     .ble_ll_ctrl_proc_timeout_ms = BLE_LL_CTRL_PROC_TIMEOUT_MS_N,                       \
240     .nimble_max_connections = DEFAULT_BT_LE_MAX_CONNECTIONS,                            \
241     .ble_whitelist_size = DEFAULT_BT_NIMBLE_WHITELIST_SIZE,                             \
242     .ble_acl_buf_size = DEFAULT_BT_LE_ACL_BUF_SIZE,                                     \
243     .ble_acl_buf_count = DEFAULT_BT_LE_ACL_BUF_COUNT,                                   \
244     .ble_hci_evt_buf_size = DEFAULT_BT_LE_HCI_EVT_BUF_SIZE,                             \
245     .ble_multi_adv_instances = DEFAULT_BT_LE_MAX_EXT_ADV_INSTANCES,                     \
246     .ble_ext_adv_max_size = DEFAULT_BT_LE_EXT_ADV_MAX_SIZE,                             \
247     .controller_task_stack_size = NIMBLE_LL_STACK_SIZE,                                 \
248     .controller_task_prio       = ESP_TASK_BT_CONTROLLER_PRIO,                          \
249     .controller_run_cpu         = 0,                                                    \
250     .enable_qa_test             = RUN_QA_TEST,                                          \
251     .enable_bqb_test            = RUN_BQB_TEST,                                         \
252     .enable_tx_cca              = DEFAULT_BT_LE_TX_CCA_ENABLED,                         \
253     .cca_rssi_thresh            = 256 - DEFAULT_BT_LE_CCA_RSSI_THRESH,                  \
254     .sleep_en                   = NIMBLE_SLEEP_ENABLE,                                  \
255     .coex_phy_coded_tx_rx_time_limit = DEFAULT_BT_LE_COEX_PHY_CODED_TX_RX_TLIM_EFF,     \
256     .dis_scan_backoff           = NIMBLE_DISABLE_SCAN_BACKOFF,                          \
257     .ble_scan_classify_filter_enable         = 1,                                       \
258     .main_xtal_freq             = CONFIG_XTAL_FREQ,                                     \
259     .version_num                = efuse_hal_chip_revision(),                            \
260     .cpu_freq_mhz               = CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ,                      \
261     .ignore_wl_for_direct_adv   = 0,                                                    \
262     .enable_pcl                 = DEFAULT_BT_LE_POWER_CONTROL_ENABLED,                  \
263     .csa2_select                = DEFAULT_BT_LE_50_FEATURE_SUPPORT,                     \
264     .enable_csr                 = 0,                                                    \
265     .ble_aa_check               = DEFAULT_BT_LE_CTRL_CHECK_CONNECT_IND_ACCESS_ADDRESS,  \
266     .config_magic = CONFIG_MAGIC,                                                       \
267 }
268 
269 /**
270  * @brief       Initialize BT controller to allocate task and other resource.
271  *              This function should be called only once, before any other BT functions are called.
272  * @param  cfg: Initial configuration of BT controller.
273  * @return      ESP_OK - success, other - failed
274  */
275 esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg);
276 
277 /**
278  * @brief  Get BT controller is initialised/de-initialised/enabled/disabled
279  * @return status value
280  */
281 esp_bt_controller_status_t esp_bt_controller_get_status(void);
282 
283 /**
284  * @brief  Get BLE TX power
285  *         Connection Tx power should only be get after connection created.
286  * @param  power_type : The type of which tx power, could set Advertising/Connection/Default and etc
287  * @return             >= 0 - Power level, < 0 - Invalid
288  */
289 esp_power_level_t esp_ble_tx_power_get(esp_ble_power_type_t power_type);
290 
291 /**
292  * @brief  De-initialize BT controller to free resource and delete task.
293  *         You should stop advertising and scanning, as well as
294  *         disconnect all existing connections before de-initializing BT controller.
295  *
296  * This function should be called only once, after any other BT functions are called.
297  * This function is not whole completed, esp_bt_controller_init cannot called after this function.
298  * @return  ESP_OK - success, other - failed
299  */
300 esp_err_t esp_bt_controller_deinit(void);
301 
302 /**
303  * @brief Enable BT controller.
304  *               Due to a known issue, you cannot call esp_bt_controller_enable() a second time
305  *               to change the controller mode dynamically. To change controller mode, call
306  *               esp_bt_controller_disable() and then call esp_bt_controller_enable() with the new mode.
307  * @param mode : the mode(BLE/BT/BTDM) to enable. For compatible of API, retain this argument.
308  * @return       ESP_OK - success, other - failed
309  */
310 esp_err_t esp_bt_controller_enable(esp_bt_mode_t mode);
311 
312 /**
313  * @brief  Disable BT controller
314  * @return       ESP_OK - success, other - failed
315  */
316 esp_err_t esp_bt_controller_disable(void);
317 
318 /** @brief esp_vhci_host_callback
319  *  used for vhci call host function to notify what host need to do
320  */
321 typedef struct esp_vhci_host_callback {
322     void (*notify_host_send_available)(void);               /*!< callback used to notify that the host can send packet to controller */
323     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*/
324 } esp_vhci_host_callback_t;
325 
326 /** @brief esp_vhci_host_check_send_available
327  *  used for check actively if the host can send packet to controller or not.
328  *  @return true for ready to send, false means cannot send packet
329  */
330 bool esp_vhci_host_check_send_available(void);
331 
332 /** @brief esp_vhci_host_send_packet
333  * host send packet to controller
334  *
335  * Should not call this function from within a critical section
336  * or when the scheduler is suspended.
337  *
338  * @param data the packet point
339  * @param len the packet length
340  */
341 void esp_vhci_host_send_packet(uint8_t *data, uint16_t len);
342 
343 /** @brief esp_vhci_host_register_callback
344  * register the vhci reference callback
345  * struct defined by vhci_host_callback structure.
346  * @param callback esp_vhci_host_callback type variable
347  * @return ESP_OK - success, ESP_FAIL - failed
348  */
349 esp_err_t esp_vhci_host_register_callback(const esp_vhci_host_callback_t *callback);
350 
351 /** @brief esp_bt_controller_mem_release
352  * release the controller memory as per the mode
353  *
354  * This function releases the BSS, data and other sections of the controller to heap. The total size is about 70k bytes.
355  *
356  * esp_bt_controller_mem_release(mode) should be called only before esp_bt_controller_init()
357  * or after esp_bt_controller_deinit().
358  *
359  * Note that once BT controller memory is released, the process cannot be reversed. It means you cannot use the bluetooth
360  * mode which you have released by this function.
361  *
362  * If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled)
363  * then do not call this function.
364  *
365  * If the app calls esp_bt_controller_enable(ESP_BT_MODE_BLE) to use BLE only then it is safe to call
366  * esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT) at initialization time to free unused BT Classic memory.
367  *
368  * 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,
369  * which internally calls esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) and additionally releases the BSS and data
370  * consumed by the BT/BLE host stack to heap. For more details about usage please refer to the documentation of
371  * esp_bt_mem_release() function
372  *
373  * @param mode : the mode want to release memory
374  * @return ESP_OK - success, other - failed
375  */
376 esp_err_t esp_bt_controller_mem_release(esp_bt_mode_t mode);
377 
378 /** @brief esp_bt_mem_release
379  * release controller memory and BSS and data section of the BT/BLE host stack as per the mode
380  *
381  * This function first releases controller memory by internally calling esp_bt_controller_mem_release().
382  * 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
383  *
384  * Note that once BT memory is released, the process cannot be reversed. It means you cannot use the bluetooth
385  * mode which you have released by this function.
386  *
387  * If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled)
388  * then do not call this function.
389  *
390  * If you never intend to use bluetooth in a current boot-up cycle, you can call esp_bt_mem_release(ESP_BT_MODE_BTDM)
391  * before esp_bt_controller_init or after esp_bt_controller_deinit.
392  *
393  * 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".
394  * In such cases, after receiving the WiFi configuration, you can disable/deinit bluetooth and release its memory.
395  * Below is the sequence of APIs to be called for such scenarios:
396  *
397  *      esp_bluedroid_disable();
398  *      esp_bluedroid_deinit();
399  *      esp_bt_controller_disable();
400  *      esp_bt_controller_deinit();
401  *      esp_bt_mem_release(ESP_BT_MODE_BTDM);
402  *
403  * @param mode : the mode whose memory is to be released
404  * @return ESP_OK - success, other - failed
405  */
406 esp_err_t esp_bt_mem_release(esp_bt_mode_t mode);
407 
408 /**
409  * @brief Returns random static address or -1 if not present.
410  * @return ESP_OK - success, other - failed
411  */
412 extern int esp_ble_hw_get_static_addr(esp_ble_addr_t *addr);
413 
414 #if CONFIG_BT_LE_CONTROLLER_LOG_ENABLED
415 /**
416  * @brief dump all log information cached in buffers.
417  * @param output : true for log dump, false will take no effect
418  */
419 void esp_ble_controller_log_dump_all(bool output);
420 #endif // CONFIG_BT_LE_CONTROLLER_LOG_ENABLED
421 
422 #if CONFIG_PM_ENABLE
423 modem_clock_lpclk_src_t esp_bt_get_lpclk_src(void);
424 
425 void esp_bt_set_lpclk_src(modem_clock_lpclk_src_t clk_src);
426 #endif // CONFIG_PM_ENABLE
427 
428 #ifdef __cplusplus
429 }
430 #endif
431 
432 #endif /* __ESP_BT_H__ */
433