From e849809f4b4e810fef608dba5769757c42f0e25e Mon Sep 17 00:00:00 2001 From: Lou Tianhao Date: Mon, 27 Nov 2023 14:31:37 +0800 Subject: [PATCH 1/3] docs(pm):change_deepsleep_example_readme --- examples/system/deep_sleep/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/system/deep_sleep/README.md b/examples/system/deep_sleep/README.md index 45cc87ad92..d88548380d 100644 --- a/examples/system/deep_sleep/README.md +++ b/examples/system/deep_sleep/README.md @@ -11,8 +11,8 @@ The following wake up sources are demonstrated in this example (refer to the [Wa - **Timer:** An RTC timer that can be programmed to trigger a wake up after a preset time. This example will trigger a wake up every 20 seconds. - **EXT0:** External wake up 0 can trigger wakeup when one predefined RTC GPIO is at a predefined logic level. This example uses GPIO25 in ESP32 or GPIO3 in ESP32-S2/S3 to trigger a wake up when the pin is HIGH. (This wake up source is only available on ESP32, ESP32-S2, and ESP32-S3.) -- **EXT1:** External wake up 1 which is tied to multiple RTC GPIOs. This example uses GPIO2 and GPIO4 to trigger a wake up with any one of the two pins are HIGH. (This wake up source is available on ESP32, ESP32-S2, ESP32-S3 and ESP32-C6.) -- **GPIO:** Pads powered by VDD3P3_RTC can be used to trigger a wake up from deep sleep. You may choose the pin and trigger level in menuconfig. (This wake up source is unavailable on ESP32, ESP32-S2, and ESP32-S3.) +- **EXT1:** External wake up 1 which is tied to multiple RTC GPIOs. This example uses GPIO2 and GPIO4 to trigger a wake up with any one of the two pins are HIGH. (This wake up source is available on ESP32, ESP32-S2, ESP32-S3, ESP32-C6 and ESP32-H2.) +- **GPIO:** Pads powered by VDD3P3_RTC can be used to trigger a wake up from deep sleep. You may choose the pin and trigger level in menuconfig. (This wake up source is unavailable on ESP32, ESP32-S2, ESP32-S3 and ESP32-H2.) - **Touch:** Touch pad sensor interrupt. This example uses touch pads connected to GPIO32, GPIO33 in ESP32 or GPIO9 in ESP32-S2/S3 to trigger a wake up when any of the pads are pressed. - **ULP:** Ultra Low Power Coprocessor which can continue to run during deep sleep. This example utilizes the ULP and constantly sample the chip's temperature and trigger a wake up if the chips temperature exceeds ~5 degrees Celsius. From 70e83a587168cc2c20a677973736e36a4e3c1ff9 Mon Sep 17 00:00:00 2001 From: Lou Tianhao Date: Mon, 27 Nov 2023 15:01:57 +0800 Subject: [PATCH 2/3] docs(pm):add gpio wakeup description when pd top --- docs/en/api-reference/system/sleep_modes.rst | 6 ++++++ docs/zh_CN/api-reference/system/sleep_modes.rst | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/en/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst index 112ad7c340..f5e96cb0e8 100644 --- a/docs/en/api-reference/system/sleep_modes.rst +++ b/docs/en/api-reference/system/sleep_modes.rst @@ -305,6 +305,12 @@ RTC peripherals or RTC memories do not need to be powered on during sleep in thi Additionally, IOs that are powered by the VDD3P3_RTC power domain can be used to wake up the chip from Deep-sleep. The wakeup pin and wakeup trigger level can be configured by calling :cpp:func:`esp_deep_sleep_enable_gpio_wakeup`. The function will enable the Deep-sleep wakeup for the selected pin. + .. only:: esp32c6 or esp32h2 + + .. note:: + + In Light-sleep mode, setting Kconfig option :ref:`CONFIG_PM_POWER_DOWN_PERIPHERAL_IN_LIGHT_SLEEP` will invalidate GPIO wakeup. + UART Wakeup (Light-sleep Only) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/zh_CN/api-reference/system/sleep_modes.rst b/docs/zh_CN/api-reference/system/sleep_modes.rst index 8c3c6055c5..ca1519fde0 100644 --- a/docs/zh_CN/api-reference/system/sleep_modes.rst +++ b/docs/zh_CN/api-reference/system/sleep_modes.rst @@ -305,6 +305,12 @@ RTC 控制器中内嵌定时器，可用于在预定义的时间到达后唤醒 此外，可将由 VDD3P3_RTC 电源域供电的 IO 用于芯片的 Deep-sleep 唤醒。调用 :cpp:func:`esp_deep_sleep_enable_gpio_wakeup` 函数可以配置相应的唤醒管脚和唤醒触发电平，该函数用于启用相应管脚的 Deep-sleep 唤醒功能。 + .. only:: esp32c6 or esp32h2 + + .. note:: + + 在 Light-sleep 模式下，设置 Kconfig 选项 :ref:`CONFIG_PM_POWER_DOWN_PERIPHERAL_IN_LIGHT_SLEEP` 将使 GPIO 唤醒失效。 + UART 唤醒（仅适用于 Light-sleep 模式） ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 09a3d068d940e0c723444b1833b99941b2270034 Mon Sep 17 00:00:00 2001 From: Lou Tianhao Date: Mon, 27 Nov 2023 15:15:16 +0800 Subject: [PATCH 3/3] docs(pm):add uart wakeup description when pd top --- docs/en/api-reference/system/sleep_modes.rst | 6 ++++++ docs/zh_CN/api-reference/system/sleep_modes.rst | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/en/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst index f5e96cb0e8..5e37220909 100644 --- a/docs/en/api-reference/system/sleep_modes.rst +++ b/docs/en/api-reference/system/sleep_modes.rst @@ -318,6 +318,12 @@ When {IDF_TARGET_NAME} receives UART input from external devices, it is often ne :cpp:func:`esp_sleep_enable_uart_wakeup` function can be used to enable this wakeup source. + .. only:: esp32c6 or esp32h2 + + .. note:: + + In Light-sleep mode, setting Kconfig option :ref:`CONFIG_PM_POWER_DOWN_PERIPHERAL_IN_LIGHT_SLEEP` will invalidate UART wakeup. + .. _disable_sleep_wakeup_source: Disable Sleep Wakeup Source diff --git a/docs/zh_CN/api-reference/system/sleep_modes.rst b/docs/zh_CN/api-reference/system/sleep_modes.rst index ca1519fde0..5eb61a70df 100644 --- a/docs/zh_CN/api-reference/system/sleep_modes.rst +++ b/docs/zh_CN/api-reference/system/sleep_modes.rst @@ -318,6 +318,12 @@ UART 唤醒（仅适用于 Light-sleep 模式） 可调用 :cpp:func:`esp_sleep_enable_uart_wakeup` 函数来启用此唤醒源。 + .. only:: esp32c6 or esp32h2 + + .. note:: + + 在 Light-sleep 模式下，设置 Kconfig 选项 :ref:`CONFIG_PM_POWER_DOWN_PERIPHERAL_IN_LIGHT_SLEEP` 将使 UART 唤醒失效。 + .. _disable_sleep_wakeup_source: 禁用睡眠模式唤醒源