feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

esp_system: add VDD_SDIO power domain configuration to documentation

Browse Source 
Add a warning in `sleep_modes` doc page to explain how to keep
VDD_SDIO power domain ON.
This commit is contained in:
Omar Chebib
2021-03-04 17:44:14 +08:00
parent b0684e8b3c
commit ae3b4819da
3 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/esp_system/Kconfig
View File

@@ -88,7 +88,9 @@ menu "ESP System Settings"
default y default y
help help
If enabled, chip will try to power down flash at light sleep, which costs more time when chip wakes up. If enabled, chip will try to power down flash at light sleep, which costs more time when chip wakes up.
Only can be enabled if there is no SPIRAM configured. Can only be enabled if there is no SPIRAM configured. This option will in fact consider VDD_SDIO auto power
value (ESP_PD_OPTION_AUTO) as OFF. Also, it is possible to force a power domain to stay ON during light
sleep by using esp_sleep_pd_config() function.
config ESP_SYSTEM_PM_POWER_DOWN_CPU config ESP_SYSTEM_PM_POWER_DOWN_CPU
bool "Power down CPU in light sleep" bool "Power down CPU in light sleep"

2
components/esp_system/sleep_modes.c
View File

@@ -719,7 +719,7 @@ esp_err_t esp_light_sleep_start(void)
* If VDD_SDIO power domain is requested to be turned off, bit `RTC_SLEEP_PD_VDDSDIO` * If VDD_SDIO power domain is requested to be turned off, bit `RTC_SLEEP_PD_VDDSDIO`
* will be set in `pd_flags`. * will be set in `pd_flags`.
*/ */
if ((pd_flags & RTC_SLEEP_PD_VDDSDIO) != 0) { if (pd_flags & RTC_SLEEP_PD_VDDSDIO) {
/* /*
* When VDD_SDIO power domain has to be turned off, the minimum sleep time of the * When VDD_SDIO power domain has to be turned off, the minimum sleep time of the
* system needs to meet the sum below: * system needs to meet the sum below:

11
docs/en/api-reference/system/sleep_modes.rst
View File

@@ -1,6 +1,8 @@
Sleep Modes Sleep Modes
=========== ===========
{IDF_TARGET_SPI_POWER_DOMAIN:default="VDD_SPI", esp32="VDD_SDIO"}
Overview Overview
-------- --------
@@ -132,6 +134,15 @@ This wakeup mode doesn't require RTC peripherals or RTC memories to be powered o
:cpp:func:`esp_sleep_enable_gpio_wakeup` function can be used to enable this wakeup source. :cpp:func:`esp_sleep_enable_gpio_wakeup` function can be used to enable this wakeup source.
.. warning::
Before entering light sleep mode, check if any GPIO pin to be driven is part of the {IDF_TARGET_SPI_POWER_DOMAIN} power domain. If so, this power domain must be configured to remain ON during sleep.
For example, on ESP32-WROOM-32 board, GPIO16 and GPIO17 are linked to {IDF_TARGET_SPI_POWER_DOMAIN} power domain. If they are configured to remain high during
light sleep, the power domain should be configured to remain powered ON. This can be done with :cpp:func:`esp_sleep_pd_config()`::
esp_sleep_pd_config(ESP_PD_DOMAIN_VDDSDIO, ESP_PD_OPTION_ON);
UART wakeup (light sleep only) UART wakeup (light sleep only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^