From 9fb3f19e3a7a6314dc0cd9509712027b780a3af7 Mon Sep 17 00:00:00 2001 From: Linda Date: Tue, 29 Aug 2023 11:04:41 +0800 Subject: [PATCH] docs: Updated wakeup GPIOs for ESP32-S2, ESP32-S3, ESP32-C6 and ESP32-H2 --- components/esp_hw_support/include/esp_sleep.h | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/components/esp_hw_support/include/esp_sleep.h b/components/esp_hw_support/include/esp_sleep.h index 47eb5d46ef..7ff9e1502b 100644 --- a/components/esp_hw_support/include/esp_sleep.h +++ b/components/esp_hw_support/include/esp_sleep.h @@ -194,10 +194,13 @@ bool esp_sleep_is_valid_wakeup_gpio(gpio_num_t gpio_num); * configured in esp_deep_sleep_start/esp_light_sleep_start, * immediately before entering sleep mode. * - * @note On ESP32, ext0 wakeup source can not be used together with touch or ULP wakeup sources. + * @note ESP32: ext0 wakeup source can not be used together with touch or ULP wakeup sources. * - * @param gpio_num GPIO number used as wakeup source. Only GPIOs which are have RTC - * functionality can be used: 0,2,4,12-15,25-27,32-39. + * @param gpio_num GPIO number used as wakeup source. Only GPIOs with the RTC + * functionality can be used. For different SoCs, the related GPIOs are: + * - ESP32: 0, 2, 4, 12-15, 25-27, 32-39 + * - ESP32-S2: 0-21 + * - ESP32-S3: 0-21 * @param level input level which will trigger wakeup (0=low, 1=high) * @return * - ESP_OK on success @@ -227,8 +230,13 @@ esp_err_t esp_sleep_enable_ext0_wakeup(gpio_num_t gpio_num, int level); * kept enabled using esp_sleep_pd_config function. * * @param mask bit mask of GPIO numbers which will cause wakeup. Only GPIOs - * which have RTC functionality can be used in this bit map: - * 0,2,4,12-15,25-27,32-39. + * which have RTC functionality can be used in this bit map. + * For different SoCs, the related GPIOs are: + * - ESP32: 0, 2, 4, 12-15, 25-27, 32-39 + * - ESP32-S2: 0-21 + * - ESP32-S3: 0-21 + * - ESP32-C6: 0-7 + * - ESP32-H2: 7-14 * @param mode select logic function used to determine wakeup condition: * - ESP_EXT1_WAKEUP_ALL_LOW: wake up when all selected GPIOs are low * - ESP_EXT1_WAKEUP_ANY_HIGH: wake up when any of the selected GPIOs is high