Merge branch 'bugfix/sleep_comments' into 'master'
doc: Specify that sleep wakeup source restrictions apply to all current ESP32 revisions See merge request espressif/esp-idf!8351
This commit is contained in:
commit
fdd6bfe3c4
1 changed files with 5 additions and 10 deletions
|
@ -89,10 +89,8 @@ esp_err_t esp_sleep_disable_wakeup_source(esp_sleep_source_t source);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @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 ULP wakeup source cannot 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.
|
|
||||||
* @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.
|
||||||
|
@ -112,8 +110,7 @@ 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 Touch wakeup source cannot 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
|
* to be powered on (ESP_PD_OPTION_ON) or when ext0 wakeup
|
||||||
* source is used.
|
* source is used.
|
||||||
*
|
*
|
||||||
|
@ -148,8 +145,7 @@ touch_pad_t esp_sleep_get_touchpad_wakeup_status(void);
|
||||||
* @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 ext0 wakeup source cannot 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.
|
||||||
|
@ -206,8 +202,7 @@ esp_err_t esp_sleep_enable_ext1_wakeup(uint64_t mask, esp_sleep_ext1_wakeup_mode
|
||||||
* 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 GPIO wakeup source cannot 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
|
||||||
|
|
Loading…
Reference in a new issue