docs(ble): Optimized the BLE low power guide

Author: weiyuhannnn

docs/en/api-guides/ble/get-started/ble-data-exchange.rst

@@ -296,7 +296,7 @@ If you have not completed the ESP-IDF development environment setup, please refe
 Try It Out
 ^^^^^^^^^^^^^^^^^^
 
-Please refer to :ref:`Bluetooth LE Introduction Try It Out <nimble_gatt_server_practice>` 。
+Please refer to :ref:`Bluetooth LE Introduction Try It Out <nimble_gatt_server_practice>`.
 
 
 Code Explanation

docs/en/api-guides/low-power-mode/low-power-mode-ble.rst

@@ -8,72 +8,51 @@ This section introduces clock source selection in low power modes for Bluetooth
 Clock Source Selection in Low Power Mode
 --------------------------------------------
 
-According to the Bluetooth specification, the sleep clock accuracy must be within 500 PPM, so make sure the clock source selected for Bluetooth LE low power mode should meet that requirement. Otherwise Bluetooth LE may not perform normally and cause a series of problem such as ACL connection establishment failure or ACL connection timeout, etc.
-
+According to the Bluetooth specification, the sleep clock accuracy must be within 500 PPM. Make sure the clock source selected for Bluetooth LE low power mode meets this requirement. Otherwise, Bluetooth LE may not perform normally and can cause a series of problems, such as ACL connection establishment failure or ACL connection timeout.
 
 Selecting Main XTAL
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To select the main XTAL as the Bluetooth LE internal clock source, configure the following option:
 
-.. only:: esp32 or esp32c3 or esp32s3
-
-    **Configuration Path:**
+.. only:: esp32
 
-    ``Component config → Bluetooth → Controller Options → MODEM SLEEP Options → Bluetooth modem sleep → Bluetooth Modem sleep Mode 1 → Bluetooth low power clock``
+    :ref:`CONFIG_BTDM_CTRL_LOW_POWER_CLOCK` = Main crystal (`CONFIG_BTDM_CTRL_LPCLK_SEL_MAIN_XTAL`)
 
-    **Configuration Option:**
+.. only:: esp32c3 or esp32s3
 
-    - \ (X) Main crystal
+    :ref:`CONFIG_BT_CTRL_LOW_POWER_CLOCK` = Main crystal (`CONFIG_BT_CTRL_LPCLK_SEL_MAIN_XTAL`)
 
 .. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61
 
-    **Configuration Path:**
-
-    ``Component config → Bluetooth → Controller Options → BLE low power clock source``
-
-    **Configuration Option:**
+    :ref:`CONFIG_BT_LE_LP_CLK_SRC` = Use main XTAL as RTC clock source (`CONFIG_BT_LE_LP_CLK_SRC_MAIN_XTAL`)
 
-    - \ (X) Use main XTAL as RTC clock source
+When this is selected, the main XTAL remains powered on during light-sleep, resulting in higher current consumption. Please refer to :example_file:`Power Save README <bluetooth/nimble/power_save/README.md>` for the typical current consumption in light-sleep using XTAL versus a 32 kHz external crystal.
 
-When this is selected, the main XTAL remains powered on during light-sleep, resulting in higher current consumption.
-Please refer :example_file:`Power Save README <bluetooth/nimble/power_save/README.md>`  for the typical current consumption in light-sleep using XTAL versus a 32kHz external crystal.
-
-Selecting 32kHz External Crystal
+Selecting 32 kHz External Crystal
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-To use a 32kHz external crystal as the Bluetooth LE internal clock source, configure the following options:
+To use a 32 kHz external crystal as the Bluetooth LE internal clock source, configure the following options:
 
-.. only:: esp32 or esp32c3 or esp32s3
+**Configuration Path 1:**
 
-    **Configuration Path 1:**
+.. only:: esp32
 
-    ``Component config → Bluetooth → Controller Options → MODEM SLEEP Options → Bluetooth modem sleep → Bluetooth Modem sleep Mode 1 → Bluetooth low power clock``
+    :ref:`CONFIG_BTDM_CTRL_LOW_POWER_CLOCK` = External 32 kHz crystal/oscillator (`CONFIG_BTDM_CTRL_LPCLK_SEL_EXT_32K_XTAL`)
 
-    **Configuration Option:**
+.. only:: esp32c3 or esp32s3
 
-    - \ (X) External 32kHz crystal/oscillator
+    :ref:`CONFIG_BT_CTRL_LOW_POWER_CLOCK` = External 32 kHz crystal/oscillator (`CONFIG_BT_CTRL_LPCLK_SEL_EXT_32K_XTAL`)
 
 .. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61
 
-    **Configuration Path 1:**
-
-    ``Component config → Bluetooth → Controller Options → BLE low power clock source``
-
-    **Configuration Option:**
-
-    - \ (X) Use system RTC slow clock source
+    :ref:`CONFIG_BT_LE_LP_CLK_SRC` = Use system RTC slow clock source (`CONFIG_BT_LE_LP_CLK_SRC_DEFAULT`)
 
 **Configuration Path 2:**
 
-``Component config → Hardware Settings → RTC Clock Config → RTC clock source``
-
-**Configuration Option:**
-
- - \ (X) External 32 kHz crystal
-
-**Note:** Even if 32kHz is selected in menuconfig, the system will fall back to the main XTAL if the external crystal is not detected during Bluetooth LE initialization. This may lead to unexpected current consumption in light-sleep mode.
+:ref:`CONFIG_RTC_CLK_SRC` = External 32 kHz crystal (`CONFIG_RTC_CLK_SRC_EXT_CRYS`)
 
+**Note:** Even if 32 kHz is selected in menuconfig, the system will fall back to the main XTAL if the external crystal is not detected during Bluetooth LE initialization. This may lead to unexpected current consumption in light-sleep mode.
 
 Selecting 136 kHz RC Oscillator
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -84,11 +63,7 @@ Selecting 136 kHz RC Oscillator
 
     **Configuration Path 1:**
 
-    `Component config → Bluetooth → Controller Options → MODEM SLEEP Options → Bluetooth modem sleep → Bluetooth Modem sleep Mode 1 → Bluetooth low power clock``
-
-    **Configuration Option:**
-
-    - \ (X) Internal 136kHz RC oscillator
+    :ref:`CONFIG_BT_CTRL_LOW_POWER_CLOCK` = Internal 136kHz RC oscillator (`CONFIG_BT_CTRL_LPCLK_SEL_RTC_SLOW`)
 
     Generally, the 136 kHz RC oscillator cannot meet the accuracy requirement of Bluetooth LE. It is only suitable for scenarios with low clock accuracy requirements, such as legacy advertising (ADV) or scanning. It does not support connections in central or peripheral roles.
 
@@ -102,25 +77,17 @@ Selecting 136 kHz RC Oscillator
 
     **Configuration Path 1:**
 
-    ``Component config → Bluetooth → Controller Options → BLE low power clock source``
-
-    **Configuration Option:**
-
-    - \ (X) Use system RTC slow clock source
+    :ref:`CONFIG_BT_LE_LP_CLK_SRC` = Use system RTC slow clock source (`CONFIG_BT_LE_LP_CLK_SRC_DEFAULT`)
 
 .. only:: not esp32
 
     **Configuration Path 2:**
 
-    ``Component config → Hardware Settings → RTC Clock Config → RTC clock source``
-
-    **Configuration Option:**
-
-    - \ (X) Internal 136 kHz RC oscillator
+    :ref:`CONFIG_RTC_CLK_SRC` = Internal 136 kHz RC oscillator (`CONFIG_RTC_CLK_SRC_INT_RC`)
 
 .. only:: esp32c2 or esp32c6 or esp32h2 or esp32c5 or esp32c61
 
-    If low current consumption is required but have no access to the External 32kHz Crystal, then this clock source is recommended. However, selecting this clock source will have the sleep clock accuracy larger than 500 PPM, which is supported if the peer device is also an ESP chip. If the peer device is not an ESP chip, here's some Bluetooth LE event not supported:
+    If low current consumption is required but there is no access to the External 32 kHz Crystal, this clock source is recommended. However, this clock source has a sleep clock accuracy exceeding 500 PPM, which is only supported when pairing with another ESP chip. For non-ESP peer devices, the following Bluetooth LE features are not supported:
 
     1. Central role of Connection
     2. Advertiser of Periodic Advertising
@@ -129,22 +96,18 @@ Selecting 136 kHz RC Oscillator
 
     **Configuration Path:**
 
-    ``Component config → Bluetooth → Controller Options``
-
-    **Configuration Options:**
-
-    - \ [*] Enable to set constant peer SCA
-    - \ (3000) Constant peer sleep clock accuracy value
+      - :ref:`CONFIG_BT_LE_LL_PEER_SCA_SET_ENABLE` = y
+      - :ref:`CONFIG_BT_LE_LL_PEER_SCA` = 3000
 
-    **Note:** Using the 136 kHz RC oscillator may cause rare issues like connection establishment failure or connection timeout.
+    **Note:** Using the 136 kHz RC oscillator may occasionally cause issues such as connection establishment failures or connection timeouts.
 
 
-**How to Check the Current Clock Source Used by Bluetooth LE**
+How to Check the Current Clock Source Used by Bluetooth LE
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You can determine the Bluetooth LE clock source from the logs during Bluetooth LE initialization:
+You can check the current Bluetooth LE clock source from the initialization logs:
 
-.. list-table:: Bluetooth LE Initialization Log Messages and Clock Source Correspondence
+.. list-table:: Bluetooth LE Initialization Logs and Clock Sources
     :widths: 50 50
     :header-rows: 1
 
@@ -163,22 +126,18 @@ You can determine the Bluetooth LE clock source from the logs during Bluetooth L
 FAQ
 --------------------------------------
 
-**1. Bluetooth LE ACL Connection Fails or Disconnects in Low Power Mode**
+1. Bluetooth LE ACL Connection Fails or Disconnects in Low Power Mode
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 As explained in the clock source selection section above, when ACL connections fail to establish or unexpectedly disconnect in low power mode, first verify whether the current clock source meets Bluetooth LE accuracy requirements.
 
 
-**2. Measured light-sleep Current Is Higher Than Expected**
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-As introduced in the clock source selection section above, if the main XTAL is used as the clock source, it will remain powered on during light-sleep, resulting in higher current consumption than other clock sources.
+2. Measured light-sleep Current Higher Than Expected
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The average current can be application specific, and depends on the Bluetooth LE configuration and the period of time in light-sleep mode. Some application may have larger average current because it has Bluetooth LE taking a larger ratio of time transmitting and receiving.
+As described in the clock source selection section above, if the main XTAL is used as the clock source, it remains powered on during light-sleep, resulting in higher current consumption than other clock sources. The average current may vary depending on the specific application, Bluetooth LE configuration, and the duration spent in light-sleep. Some applications may have higher average current because Bluetooth LE is active for a larger proportion of the time transmitting and receiving.
 
-**3. Unable to Enter light-sleep Mode**
+3. Unable to Enter light-sleep Mode
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-When Auto light-sleep is enabled but the device fails to enter light-sleep, it's often due to insufficient IDLE duration, which prevents meeting the automatic light-sleep entry conditions.
-
-This could be caused by excessive logging or Bluetooth LE configuration that prevents sufficient IDLE time, such as continuous scan mode.
+If Auto light-sleep is enabled but the device fails to enter light-sleep, it's usually due to insufficient IDLE time, which prevents the automatic entry conditions from being met. This can be caused by excessive logging or Bluetooth LE configurations that reduce IDLE time, such as continuous scanning.

docs/en/api-reference/system/power_management.rst

@@ -116,7 +116,7 @@ The following drivers hold the ``ESP_PM_APB_FREQ_MAX`` lock while the driver is
     - **Ethernet**: between calls to :cpp:func:`esp_eth_driver_install` and :cpp:func:`esp_eth_driver_uninstall`.
     :SOC_WIFI_SUPPORTED: - **WiFi**: between calls to :cpp:func:`esp_wifi_start` and :cpp:func:`esp_wifi_stop`. If modem sleep is enabled, the lock will be released for the periods of time when radio is disabled.
     :SOC_TWAI_SUPPORTED: - **TWAI**: between calls to :cpp:func:`twai_driver_install` and :cpp:func:`twai_driver_uninstall` (only when the clock source is set to :cpp:enumerator:`TWAI_CLK_SRC_APB`).
-    :SOC_BT_SUPPORTED and esp32: - **Bluetooth**: between calls to :cpp:func:`esp_bt_controller_enable` and :cpp:func:`esp_bt_controller_disable`. If Bluetooth Modem-sleep is enabled, the ``ESP_PM_APB_FREQ_MAX`` lock will be released for the periods of time when radio is disabled. However the ``ESP_PM_NO_LIGHT_SLEEP`` lock will still be held, unless :ref:`CONFIG_BTDM_CTRL_LOW_POWER_CLOCK` option is set to "External 32kHz crystal".
+    :SOC_BT_SUPPORTED and esp32: - **Bluetooth**: between calls to :cpp:func:`esp_bt_controller_enable` and :cpp:func:`esp_bt_controller_disable`. If Bluetooth Modem-sleep is enabled, the ``ESP_PM_APB_FREQ_MAX`` lock will be released for the periods of time when radio is disabled. However the ``ESP_PM_NO_LIGHT_SLEEP`` lock will still be held, unless :ref:`CONFIG_BTDM_CTRL_LOW_POWER_CLOCK` option is set to "External 32 kHz crystal".
     :SOC_BT_SUPPORTED and not esp32: - **Bluetooth**: between calls to :cpp:func:`esp_bt_controller_enable` and :cpp:func:`esp_bt_controller_disable`. If Bluetooth Modem-sleep is enabled, the ``ESP_PM_APB_FREQ_MAX`` lock will be released for the periods of time when radio is disabled. However the ``ESP_PM_NO_LIGHT_SLEEP`` lock will still be held.
     :SOC_PCNT_SUPPORTED: - **PCNT**: between calls to :cpp:func:`pcnt_unit_enable` and :cpp:func:`pcnt_unit_disable`.
     :SOC_SDM_SUPPORTED: - **Sigma-delta**: between calls to :cpp:func:`sdm_channel_enable` and :cpp:func:`sdm_channel_disable`.