From 71c8879099daf28df9c6ff2411e41d4bd335eff6 Mon Sep 17 00:00:00 2001 From: Lou Tianhao Date: Wed, 21 Feb 2024 17:31:45 +0800 Subject: [PATCH 1/3] docs(pm): add internal inspection mechanism description doc --- docs/en/api-reference/system/sleep_modes.rst | 8 +++++++- docs/zh_CN/api-reference/system/sleep_modes.rst | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst index 254e54e167..5f32cc155b 100644 --- a/docs/en/api-reference/system/sleep_modes.rst +++ b/docs/en/api-reference/system/sleep_modes.rst @@ -254,7 +254,13 @@ RTC peripherals or RTC memories do not need to be powered on during sleep in thi .. only:: SOC_PM_SUPPORT_EXT1_WAKEUP_MODE_PER_PIN - The RTC controller also supports triggering wakeup, allowing configurable IO to use different wakeup levels simultaneously. This can be configured with :cpp:func`esp_sleep_enable_ext1_wakeup_io`. + The RTC controller also supports triggering wakeup, allowing configurable IO to use different wakeup levels simultaneously. This can be configured with :cpp:func:`esp_sleep_enable_ext1_wakeup_io`. + + .. only:: not SOC_PM_SUPPORT_EXT1_WAKEUP_MODE_PER_PIN + + .. note:: + + Due to hardware limitation, When we use multi-IOs for EXT1 wakeup, it is not allowed to configue these IOs to different triggering modes, and there is corresponding inspection mechanism in :cpp:func:`esp_sleep_enable_ext1_wakeup_io`. .. warning:: diff --git a/docs/zh_CN/api-reference/system/sleep_modes.rst b/docs/zh_CN/api-reference/system/sleep_modes.rst index be32e6ed9d..5414290bed 100644 --- a/docs/zh_CN/api-reference/system/sleep_modes.rst +++ b/docs/zh_CN/api-reference/system/sleep_modes.rst @@ -254,7 +254,13 @@ RTC 控制器中内嵌定时器，可用于在预定义的时间到达后唤醒 .. only:: SOC_PM_SUPPORT_EXT1_WAKEUP_MODE_PER_PIN - 当前的 RTC 控制器也包含更强大的逻辑，允许配置的 IO 同时使用不同的唤醒电平。这可以通过:cpp:func:`esp_sleep_enable_ext1_wakeup_io` 函数来进行配置。 + 当前的 RTC 控制器也包含更强大的逻辑，允许配置的 IO 同时使用不同的唤醒电平。这可以通过 :cpp:func:`esp_sleep_enable_ext1_wakeup_io` 函数来进行配置。 + + .. only:: not SOC_PM_SUPPORT_EXT1_WAKEUP_MODE_PER_PIN + + .. note:: + + 由于硬件限制，当我们将多个 IO 用于 EXT1 唤醒，此时不允许将这些 IO 配制成不同的触发模式，在 :cpp:func:`esp_sleep_enable_ext1_wakeup_io` 已有相应的内部检查机制。 .. warning:: From bbe4d602e136aa5026927084998044d8856dfbaa Mon Sep 17 00:00:00 2001 From: Song Ruo Jing Date: Fri, 23 Feb 2024 10:45:15 +0800 Subject: [PATCH 2/3] doc(pm): improve english description --- docs/en/api-reference/system/sleep_modes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst index 5f32cc155b..d142ecd554 100644 --- a/docs/en/api-reference/system/sleep_modes.rst +++ b/docs/en/api-reference/system/sleep_modes.rst @@ -260,7 +260,7 @@ RTC peripherals or RTC memories do not need to be powered on during sleep in thi .. note:: - Due to hardware limitation, When we use multi-IOs for EXT1 wakeup, it is not allowed to configue these IOs to different triggering modes, and there is corresponding inspection mechanism in :cpp:func:`esp_sleep_enable_ext1_wakeup_io`. + Due to hardware limitation, when we use more than one IO for EXT1 wakeup, it is not allowed to configure different wakeup levels for the IOs, and there is corresponding inspection mechanism in :cpp:func:`esp_sleep_enable_ext1_wakeup_io`. .. warning:: From 5e9d02549fc324a3c5e8daf5ceadbdc05333f333 Mon Sep 17 00:00:00 2001 From: Lou Tian Hao Date: Fri, 23 Feb 2024 11:05:49 +0800 Subject: [PATCH 3/3] docs(pm): improve chinese description --- docs/zh_CN/api-reference/system/sleep_modes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh_CN/api-reference/system/sleep_modes.rst b/docs/zh_CN/api-reference/system/sleep_modes.rst index 5414290bed..511bfd17b1 100644 --- a/docs/zh_CN/api-reference/system/sleep_modes.rst +++ b/docs/zh_CN/api-reference/system/sleep_modes.rst @@ -260,7 +260,7 @@ RTC 控制器中内嵌定时器，可用于在预定义的时间到达后唤醒 .. note:: - 由于硬件限制，当我们将多个 IO 用于 EXT1 唤醒，此时不允许将这些 IO 配制成不同的触发模式，在 :cpp:func:`esp_sleep_enable_ext1_wakeup_io` 已有相应的内部检查机制。 + 由于硬件限制，当我们将多个 IO 用于 EXT1 唤醒，此时不允许将这些 IO 的唤醒模式配置成不同的电平，在 :cpp:func:`esp_sleep_enable_ext1_wakeup_io` 已有相应的内部检查机制。 .. warning::