Skip to content

Commit 2150ec4

Browse files
committed
cpu/esp32: fix doc regarding GPIOs in deep-sleep mode
1 parent 1aa8534 commit 2150ec4

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

cpu/esp32/doc.txt

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1405,15 +1405,14 @@ _Light-sleep_ and the _Deep-sleep_ mode:
14051405

14061406
Parameter | Default | Mode | Description
14071407
:----------------|:-------------------------|:------|:------------
1408-
ESP_PM_GPIO_HOLD | not defined | Deep | Hold GPIO output level if defined
1409-
ESP_PM_WUP_PINS | none | Deep | GPIOs used as wake-up source
1410-
ESP_PM_WUP_LEVEL | ESP_PM_WUP_PINS_ANY_HIGH | Deep | Level for wake-up pins to wake-up
1408+
ESP_PM_GPIO_HOLD | not defined | Deep | Hold GPIO output level in _Deep-sleep_ mode if defined
1409+
ESP_PM_WUP_PINS | none | Deep | GPIOs used as wake-up source from _Deep-sleep_ mode
1410+
ESP_PM_WUP_LEVEL | ESP_PM_WUP_PINS_ANY_HIGH | Deep | Level for wake-up pins to wake-up from _Deep-sleep_ mode
14111411
ESP_PM_WUP_UART0 | disabled | Light | Positive UART0 RxD signal edges to wake-up
14121412
ESP_PM_WUP_UART1 | disabled | Light | Positive UART1 RxD signal edges to wake-up
14131413

14141414
</center><br>
14151415

1416-
@note
14171416
- If `ESP_PM_GPIO_HOLD` is defined, GPIOs hold their last output level
14181417
when entering _Deep-sleep_ mode. Please note that only RTC GPIOs
14191418
can hold their output value in _Deep-sleep_ mode.
@@ -1431,17 +1430,25 @@ ESP_PM_WUP_UART1 | disabled | Light | Positive UART1 RxD signal
14311430
- `ESP_PM_WUP_PINS_ANY_HIGH` (default) - The system is woken up when any of
14321431
the GPIOs specified in `ESP_PM_WUP_PINS` becomes HIGH.
14331432
- `ESP_PM_WUP_PINS_ANY_LOW` - The system is woken up when any of
1434-
the GPIOs specified in `ESP_PM_WUP_PINS` becomes LOW
1435-
(only available with the ESP32-C3 variant).
1433+
the GPIOs specified in `ESP_PM_WUP_PINS` becomes LOW.
14361434
- `ESP_PM_WUP_PINS_ALL_LOW` - The system is woken up when all GPIOs specified
1437-
in `ESP_PM_WUP_PINS` become LOW (not available with the ESP32-C3 variant).
1435+
in `ESP_PM_WUP_PINS` become LOW.
14381436
- `ESP_PM_WUP_UART0` and `ESP_PM_WUP_UART1` define the number of positive
14391437
edges of the RxD signal of the respective UART that are necessary to wake
14401438
up the system in the _Light-sleep_ mode. The value must be greater than 2,
14411439
otherwise UART is not activated as wake-up source. The specified value is
14421440
reduced by 2 so that `ESP_PM_WUP_UART0` or `ESP_PM_WUP_UART1` plus 2 is
14431441
the number of positive edges required to wake up.
14441442

1443+
@note
1444+
- Wake-up from _Light-sleep_ mode works for any of the GPIOs defined as input
1445+
with enabled interrupt.
1446+
- `ESP_PM_GPIO_HOLD` is not available on ESP32-C3 variant.
1447+
- `ESP_PM_GPIO_HOLD` works only for RTC GPIOs.
1448+
- `ESP_PM_WUP_PINS_ANY_LOW` is not available on ESP32 variant.
1449+
- `ESP_PM_WUP_PINS_ALL_LOW` is only available on ESP32 variant, all other
1450+
ESP32x variants support only `ESP_PM_WUP_PINS_ANY_LOW` instead.
1451+
14451452
In the following example the system shall be woken up from _Deep-sleep_ if
14461453
the pulled-up pin `GPIO25` (`ESP_PM_WUP_PINS=GPIO25`) goes LOW
14471454
(`ESP_PM_WUP_LEVEL=ESP_PM_WUP_PINS_ALL_LOW`). The last GPIO output values

0 commit comments

Comments
 (0)