From 3b29030e1018b0fb4efedf2685b4c12c2e87d4e6 Mon Sep 17 00:00:00 2001 From: Darian Leung Date: Tue, 4 Jan 2022 16:38:21 +0800 Subject: [PATCH] docs: Update Power Management and Sleep Modes docs for ESP32-S3 --- docs/en/api-reference/system/power_management.rst | 6 +++--- docs/en/api-reference/system/sleep_modes.rst | 4 ---- .../system/inc/power_management_esp32s2_and_later.rst | 2 +- docs/zh_CN/api-reference/system/power_management.rst | 4 ++-- 4 files changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/en/api-reference/system/power_management.rst b/docs/en/api-reference/system/power_management.rst index d195388716..6ae75bd9e3 100644 --- a/docs/en/api-reference/system/power_management.rst +++ b/docs/en/api-reference/system/power_management.rst @@ -96,7 +96,7 @@ To skip unnecessary wake-up you can consider initializing an esp_timer with the Dynamic Frequency Scaling and Peripheral Drivers ------------------------------------------------ -When DFS is enabled, the APB frequency can be changed multiple times within a single RTOS tick. The APB frequency change does not affect the work of some peripherals, while other peripherals may have issues. For example, Timer Group peripheral timers will keep counting, however, the speed at which they count will change proportionally to the APB frequency. +When DFS is enabled, the APB frequency can be changed multiple times within a single RTOS tick. The APB frequency change does not affect the operation of some peripherals, while other peripherals may have issues. For example, Timer Group peripheral timers will keep counting, however, the speed at which they count will change proportionally to the APB frequency. The following peripherals work normally even when the APB frequency is changing: @@ -120,7 +120,7 @@ The following drivers will hold the ``ESP_PM_APB_FREQ_MAX`` lock while the drive - **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. - **TWAI**: between calls to :cpp:func:`twai_driver_install` and :cpp:func:`twai_driver_uninstall`. :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 esp32c3: - **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_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. The following peripheral drivers are not aware of DFS yet. Applications need to acquire/release locks themselves, when necessary: @@ -129,7 +129,7 @@ The following peripheral drivers are not aware of DFS yet. Applications need to - PCNT - Sigma-delta - Timer group - :esp32: - MCPWM + :SOC_MCPWM_SUPPORTED: - MCPWM API Reference ------------- diff --git a/docs/en/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst index bb204d5708..647ac89bb5 100644 --- a/docs/en/api-reference/system/sleep_modes.rst +++ b/docs/en/api-reference/system/sleep_modes.rst @@ -227,10 +227,6 @@ Implementation of basic functionality of deep sleep is shown in :example:`protoc More extensive example in :example:`system/deep_sleep` illustrates usage of various deep sleep wakeup triggers and ULP coprocessor programming. -.. only:: esp32c3 - - An example in :example:`system/deep_sleep` illustrates usage of deep sleep wakeup triggered by timer. - API Reference ------------- diff --git a/docs/zh_CN/api-reference/system/inc/power_management_esp32s2_and_later.rst b/docs/zh_CN/api-reference/system/inc/power_management_esp32s2_and_later.rst index 2212c5e085..4054209783 100644 --- a/docs/zh_CN/api-reference/system/inc/power_management_esp32s2_and_later.rst +++ b/docs/zh_CN/api-reference/system/inc/power_management_esp32s2_and_later.rst @@ -1,5 +1,5 @@ +---------------+---------------------------------------+-------------------------------------+ -| CPU最高频率 | 电源管理锁获取情况 | APB 频率和 CPU 频率 | +| CPU 最高频率 | 电源管理锁获取情况 | APB 频率和 CPU 频率 | | | | | +---------------+---------------------------------------+-------------------------------------+ | 240 | 获取 ``ESP_PM_CPU_FREQ_MAX`` | | CPU: 240 MHz | diff --git a/docs/zh_CN/api-reference/system/power_management.rst b/docs/zh_CN/api-reference/system/power_management.rst index c3d83a3c87..4538996ed6 100644 --- a/docs/zh_CN/api-reference/system/power_management.rst +++ b/docs/zh_CN/api-reference/system/power_management.rst @@ -120,7 +120,7 @@ ESP-IDF 中集成的电源管理算法可以根据应用程序组件的需求， - **WiFi**：从调用 :cpp:func:`esp_wifi_start` 至 :cpp:func:`esp_wifi_stop` 期间。如果启用了调制解调器睡眠模式，广播关闭时将释放此管理锁。 - **TWAI**：从调用 :cpp:func:`twai_driver_install` 至 :cpp:func:`twai_driver_uninstall` 期间。 :SOC_BT_SUPPORTED and esp32: - **Bluetooth**：从调用 :cpp:func:`esp_bt_controller_enable` 至 :cpp:func:`esp_bt_controller_disable` 期间。如果启用了蓝牙调制解调器，广播关闭时将释放此管理锁。但依然占用 ``ESP_PM_NO_LIGHT_SLEEP`` 锁，除非将 :ref:`CONFIG_BTDM_CTRL_LOW_POWER_CLOCK` 选项设置为 “外部 32 kHz 晶振”。 - :SOC_BT_SUPPORTED and esp32c3: - **Bluetooth**：从调用 :cpp:func:`esp_bt_controller_enable` 至 :cpp:func:`esp_bt_controller_disable` 期间。如果启用了蓝牙调制解调器，广播关闭时将释放此管理锁。但依然占用 ``ESP_PM_NO_LIGHT_SLEEP`` 锁。 + :SOC_BT_SUPPORTED and not esp32: - **Bluetooth**：从调用 :cpp:func:`esp_bt_controller_enable` 至 :cpp:func:`esp_bt_controller_disable` 期间。如果启用了蓝牙调制解调器，广播关闭时将释放此管理锁。但依然占用 ``ESP_PM_NO_LIGHT_SLEEP`` 锁。 以下外设驱动程序无法感知动态调频，应用程序需自己获取/释放管理锁： @@ -129,7 +129,7 @@ ESP-IDF 中集成的电源管理算法可以根据应用程序组件的需求， - PCNT - Sigma-delta - Timer group - :esp32: - MCPWM + :SOC_MCPWM_SUPPORTED: - MCPWM API 参考 -------------