espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-30 18:57:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update components/esp_hw_support/include/esp_sleep.h

Browse Source
This commit is contained in:
Michael (XIAO Xufeng)
2022-07-25 14:53:57 +08:00
parent 37cd376957
commit 07253938a6
1 changed files with 6 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
components/esp_hw_support/include/esp_sleep.h
View File

@ -101,10 +101,8 @@ esp_err_t esp_sleep_disable_wakeup_source(esp_sleep_source_t source);
#if SOC_ULP_SUPPORTED #if SOC_ULP_SUPPORTED
/** /**
* @brief Enable wakeup by ULP coprocessor * @brief Enable wakeup by ULP coprocessor
* @note In revisions 0 and 1 of the ESP32, ULP wakeup source * @note On ESP32, ULP wakeup source cannot be used when RTC_PERIPH power domain is forced,
* cannot be used when RTC_PERIPH power domain is forced * to be powered on (ESP_PD_OPTION_ON) or when ext0 wakeup source is used.
* to be powered on (ESP_PD_OPTION_ON) or when
* ext0 wakeup source is used.
* @return * @return
* - ESP_OK on success * - ESP_OK on success
* - ESP_ERR_NOT_SUPPORTED if additional current by touch (CONFIG_ESP32_RTC_EXT_CRYST_ADDIT_CURRENT) is enabled. * - ESP_ERR_NOT_SUPPORTED if additional current by touch (CONFIG_ESP32_RTC_EXT_CRYST_ADDIT_CURRENT) is enabled.
@ -128,10 +126,8 @@ esp_err_t esp_sleep_enable_timer_wakeup(uint64_t time_in_us);
/** /**
* @brief Enable wakeup by touch sensor * @brief Enable wakeup by touch sensor
* *
* @note In revisions 0 and 1 of the ESP32, touch wakeup source * @note On ESP32, touch wakeup source can not be used when RTC_PERIPH power domain is forced
* can not be used when RTC_PERIPH power domain is forced * to be powered on (ESP_PD_OPTION_ON) or when ext0 wakeup source is used.
* to be powered on (ESP_PD_OPTION_ON) or when ext0 wakeup
* source is used.
* *
* @note The FSM mode of the touch button should be configured * @note The FSM mode of the touch button should be configured
* as the timer trigger mode. * as the timer trigger mode.
@ -179,8 +175,7 @@ bool esp_sleep_is_valid_wakeup_gpio(gpio_num_t gpio_num);
* @note This function does not modify pin configuration. The pin is * @note This function does not modify pin configuration. The pin is
* configured in esp_sleep_start, immediately before entering sleep mode. * configured in esp_sleep_start, immediately before entering sleep mode.
* *
* @note In revisions 0 and 1 of the ESP32, ext0 wakeup source * @note On ESP32, ext0 wakeup source can not be used together with touch or ULP wakeup sources.
* 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 * @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. * functionality can be used: 0,2,4,12-15,25-27,32-39.
@ -265,8 +260,7 @@ esp_err_t esp_deep_sleep_enable_gpio_wakeup(uint64_t gpio_pin_mask, esp_deepslee
* wakeup level, for each GPIO which is used for wakeup. * wakeup level, for each GPIO which is used for wakeup.
* Then call this function to enable wakeup feature. * Then call this function to enable wakeup feature.
* *
* @note In revisions 0 and 1 of the ESP32, GPIO wakeup source * @note On ESP32, GPIO wakeup source can not be used together with touch or ULP wakeup sources.
* can not be used together with touch or ULP wakeup sources.
* *
* @return * @return
* - ESP_OK on success * - ESP_OK on success