Skip to content

Commit 2f9af2c

Browse files
committed
docs(ble): Removed note in esp_bt_controller_config_t
1 parent dcece38 commit 2f9af2c

File tree

1 file changed

+2
-27
lines changed
  • components/bt/include/esp32/include

1 file changed

+2
-27
lines changed

components/bt/include/esp32/include/esp_bt.h

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -217,24 +217,8 @@ the adv packet will be discarded until the memory is restored. */
217217

218218
/**
219219
* @brief Bluetooth Controller config options
220-
* @note
221-
* 1. The following parameters can be configured at runtime when calling esp_bt_controller_init():
222-
*
223-
* `controller_task_stack_size`, `controller_task_prio`, `hci_uart_no`, `hci_uart_baudrate`
224-
* `scan_duplicate_mode`, `scan_duplicate_type`, `normal_adv_size`, `mesh_adv_size`, `send_adv_reserved_size`,
225-
* `controller_debug_flag`, `mode`, `ble_max_conn`, `bt_max_acl_conn`, `bt_sco_datapath`, `auto_latency`,
226-
* `bt_legacy_auth_vs_evt`
227-
*
228-
* 2. The following parameters cannot be configured at runtime when calling `esp_bt_controller_init()`.
229-
* They will be overwritten with values in menuconfig or from a macro:
230-
*
231-
* `bt_max_sync_conn`, `ble_sca`, `pcm_role`, `pcm_polar`, `hli`, `dup_list_refresh_period`, `ble_scan_backoff`,
232-
* `magic`.
233220
*/
234221
typedef struct {
235-
/*
236-
* Following parameters can be configured runtime, when call esp_bt_controller_init()
237-
*/
238222
uint16_t controller_task_stack_size; /*!< Bluetooth Controller task stack size in bytes */
239223
uint8_t controller_task_prio; /*!< Bluetooth Controller task priority */
240224
uint8_t hci_uart_no; /*!< If use UART1/2 as HCI IO interface, indicate UART number */
@@ -251,11 +235,6 @@ typedef struct {
251235
uint8_t bt_sco_datapath; /*!< SCO data path, i.e. HCI or PCM module */
252236
bool auto_latency; /*!< BLE auto latency, used to enhance Classic Bluetooth performance */
253237
bool bt_legacy_auth_vs_evt; /*!< BR/EDR Legacy auth complete event required to protect from BIAS attack */
254-
/*
255-
* Following parameters can not be configured runtime when call esp_bt_controller_init()
256-
* It will be overwrite with a constant value which in menuconfig or from a macro.
257-
* So, do not modify the value when esp_bt_controller_init()
258-
*/
259238
uint8_t bt_max_sync_conn; /*!< BR/EDR maximum ACL connection numbers. Effective in menuconfig */
260239
uint8_t ble_sca; /*!< BLE low power crystal accuracy index */
261240
uint8_t pcm_role; /*!< PCM role (master & slave)*/
@@ -625,16 +604,12 @@ esp_err_t esp_bt_sleep_disable(void);
625604
esp_err_t esp_ble_scan_dupilcate_list_flush(void);
626605

627606
/**
628-
* @brief Power on Bluetooth Wi-Fi power domain
629-
*
630-
* @note This function is not recommended to use due to potential risk.
607+
* @brief bt Wi-Fi power domain power on
631608
*/
632609
void esp_wifi_bt_power_domain_on(void);
633610

634611
/**
635-
* @brief Power off Bluetooth Wi-Fi power domain
636-
*
637-
* @note This function is not recommended to use due to potential risk.
612+
* @brief bt Wi-Fi power domain power off
638613
*/
639614
void esp_wifi_bt_power_domain_off(void);
640615

0 commit comments

Comments
 (0)