From aaa1ea8af157a055abd591092d5e8a359728ef51 Mon Sep 17 00:00:00 2001 From: Lou Tianhao Date: Fri, 10 Nov 2023 15:56:50 +0800 Subject: [PATCH] docs(pm/ext1): support esp_sleep_enable_io_ext1_wakeup and esp_sleep_disable_io_ext1_wakeup --- docs/en/api-reference/system/sleep_modes.rst | 8 ++++---- docs/en/migration-guides/release-5.x/5.3/index.rst | 1 + docs/en/migration-guides/release-5.x/5.3/system.rst | 2 +- docs/zh_CN/api-reference/system/sleep_modes.rst | 8 ++++---- docs/zh_CN/migration-guides/release-5.x/5.3/index.rst | 1 + docs/zh_CN/migration-guides/release-5.x/5.3/system.rst | 1 + 6 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 docs/zh_CN/migration-guides/release-5.x/5.3/system.rst diff --git a/docs/en/api-reference/system/sleep_modes.rst b/docs/en/api-reference/system/sleep_modes.rst index 0d82c21baf..10dfafcb62 100644 --- a/docs/en/api-reference/system/sleep_modes.rst +++ b/docs/en/api-reference/system/sleep_modes.rst @@ -220,7 +220,7 @@ RTC peripherals or RTC memories do not need to be powered on during sleep in thi External Wakeup (``ext1``) ^^^^^^^^^^^^^^^^^^^^^^^^^^ - The RTC controller contains the logic to trigger wakeup using multiple RTC GPIOs. One of the following two logic functions can be used to trigger general ext1 wakeup: + The RTC controller contains the logic to trigger wakeup using multiple RTC GPIOs. One of the following two logic functions can be used to trigger ext1 wakeup: .. only:: esp32 @@ -248,15 +248,15 @@ RTC peripherals or RTC memories do not need to be powered on during sleep in thi gpio_pullup_dis(gpio_num); gpio_pulldown_en(gpio_num); - :cpp:func:`esp_sleep_append_ext1_wakeup` function can be used to append ext1 wakeup IO and set corresponding wakeup level. + :cpp:func:`esp_sleep_set_ext1_wakeup_io` function can be used to append ext1 wakeup IO and set corresponding wakeup level. - :cpp:func:`esp_sleep_remove_ext1_wakeup` function can be used to remove ext1 wakeup IO. + :cpp:func:`esp_sleep_clear_ext1_wakeup_io` function can be used to remove ext1 wakeup IO. :cpp:func:`esp_sleep_enable_ext1_wakeup` function can be used to reset all previous ext1 wakeup configurations and enable new ext1 wakeup IO and set corresponding wakeup level. .. 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_append_ext1_wakeup`. + 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_set_ext1_wakeup_io`. .. warning:: diff --git a/docs/en/migration-guides/release-5.x/5.3/index.rst b/docs/en/migration-guides/release-5.x/5.3/index.rst index caccc54187..b4717423b3 100644 --- a/docs/en/migration-guides/release-5.x/5.3/index.rst +++ b/docs/en/migration-guides/release-5.x/5.3/index.rst @@ -7,3 +7,4 @@ Migration from 5.2 to 5.3 :maxdepth: 1 peripherals + system diff --git a/docs/en/migration-guides/release-5.x/5.3/system.rst b/docs/en/migration-guides/release-5.x/5.3/system.rst index 3563c2285f..de3c7ead05 100644 --- a/docs/en/migration-guides/release-5.x/5.3/system.rst +++ b/docs/en/migration-guides/release-5.x/5.3/system.rst @@ -6,4 +6,4 @@ System Power Management ----------------------- -* ``esp_sleep_enable_ext1_wakeup_with_level_mask`` is deprecated, use ``esp_sleep_append_ext1_wakeup`` and ``esp_sleep_remove_ext1_wakeup`` instead. +* ``esp_sleep_enable_ext1_wakeup_with_level_mask`` is deprecated, use ``esp_sleep_set_ext1_wakeup_io`` and ``esp_sleep_clear_ext1_wakeup_io`` instead. diff --git a/docs/zh_CN/api-reference/system/sleep_modes.rst b/docs/zh_CN/api-reference/system/sleep_modes.rst index 10dcedc9a6..ed02cb5f0b 100644 --- a/docs/zh_CN/api-reference/system/sleep_modes.rst +++ b/docs/zh_CN/api-reference/system/sleep_modes.rst @@ -220,7 +220,7 @@ RTC 控制器中内嵌定时器，可用于在预定义的时间到达后唤醒 外部唤醒 (``ext1``) ^^^^^^^^^^^^^^^^^^^^^^ - RTC 控制器中包含使用多个 RTC GPIO 触发唤醒的逻辑。从以下两个逻辑函数中任选其一，均可触发普通 ext1 唤醒： + RTC 控制器中包含使用多个 RTC GPIO 触发唤醒的逻辑。从以下两个逻辑函数中任选其一，均可触发 ext1 唤醒： .. only:: esp32 @@ -248,15 +248,15 @@ RTC 控制器中内嵌定时器，可用于在预定义的时间到达后唤醒 gpio_pullup_dis(gpio_num); gpio_pulldown_en(gpio_num); - 可调用 :cpp:func:`esp_sleep_append_ext1_wakeup` 函数可用于增加 ext1 唤醒 IO 并设置相应的唤醒电平。 + 可调用 :cpp:func:`esp_sleep_set_ext1_wakeup_io` 函数可用于增加 ext1 唤醒 IO 并设置相应的唤醒电平。 - 可调用 :cpp:func:`esp_sleep_remove_ext1_wakeup` 函数可用于移除 ext1 唤醒 IO。 + 可调用 :cpp:func:`esp_sleep_clear_ext1_wakeup_io` 函数可用于移除 ext1 唤醒 IO。 可调用 :cpp:func:`esp_sleep_enable_ext1_wakeup` 函数可用于重置所有先前的 ext1 唤醒配置，并启用新的 ext1 唤醒 IO 并设置相应的唤醒电平。 .. only:: SOC_PM_SUPPORT_EXT1_WAKEUP_MODE_PER_PIN - 当前的 RTC 控制器也包含更强大的逻辑，允许配置的 IO 同时使用不同的唤醒电平。这可以通过:cpp:func:`esp_sleep_append_ext1_wakeup` 函数来进行配置。 + 当前的 RTC 控制器也包含更强大的逻辑，允许配置的 IO 同时使用不同的唤醒电平。这可以通过:cpp:func:`esp_sleep_set_ext1_wakeup_io` 函数来进行配置。 .. warning:: diff --git a/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst index 25aeb7dff3..40d26176f4 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.3/index.rst @@ -7,3 +7,4 @@ :maxdepth: 1 peripherals + system diff --git a/docs/zh_CN/migration-guides/release-5.x/5.3/system.rst b/docs/zh_CN/migration-guides/release-5.x/5.3/system.rst new file mode 100644 index 0000000000..d984c08a77 --- /dev/null +++ b/docs/zh_CN/migration-guides/release-5.x/5.3/system.rst @@ -0,0 +1 @@ +.. include:: ../../../../en/migration-guides/release-5.x/5.3/system.rst \ No newline at end of file