Skip to content

Commit

Permalink
Merge branch 'docs/add_more_information_about_c3_gpio0_gpio5' into 'm…
Browse files Browse the repository at this point in the history 
…aster'

Add more information about which GPIOs of ESP32-C3/ESP32-C2/ESP32-H2 can wake up the chip from Deep-sleep mode

Closes DOC-4899

See merge request espressif/esp-idf!23279
  • Loading branch information
@skywxFang
skywxFang committed May 5, 2023
2 parents ef23242 + 719b75d commit 0bfffa0
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 23 deletions.
4 changes: 2 additions & 2 deletions docs/en/api-reference/peripherals/gpio/esp32c2.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ The table below provides more information on pin usage, and please note the comm
.. note::
- Strapping pin: GPIO8 and GPIO9 are strapping pins. For more infomation, please refer to `ESP8684 datasheet <https://www.espressif.com/sites/default/files/documentation/esp8684_datasheet_en.pdf>`_.
- Strapping pin: GPIO8 and GPIO9 are strapping pins. For more information, please refer to `ESP8684 datasheet <https://www.espressif.com/sites/default/files/documentation/esp8684_datasheet_en.pdf>`_.
- SPI0/1: GPIO12-17 are usually used for SPI flash and not recommended for other uses.
- RTC: GPIO0-5 can be used when in Deep-sleep mode.
- RTC: GPIO0-5 can be used to wake up the chip from Deep-sleep mode. Other GPIOs can only wake up the chip from Light-sleep mode. For more information, please refer to Section :ref:`Wakeup Sources<api-reference-wakeup-source>`.
---
4 changes: 2 additions & 2 deletions docs/en/api-reference/peripherals/gpio/esp32c3.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ The table below provides more information on pin usage, and please note the comm
.. note::
- Strapping pin: GPIO2, GPIO8 and GPIO9 are strapping pins. For more infomation, please refer to `ESP32-C3 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_.
- Strapping pin: GPIO2, GPIO8 and GPIO9 are strapping pins. For more information, please refer to `ESP32-C3 Datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_.
- SPI0/1: GPIO12-17 are usually used for SPI flash and PSRAM and are not recommended for other uses.
- USB-JTAG: GPIO 18 and 19 are used by USB-JTAG by default. In order to use them as GPIOs, USB-JTAG will be disabled by the drivers.
- RTC: GPIO0-5 can be used when in Deep-sleep mode.
- RTC: GPIO0-5 can be used to wake up the chip from Deep-sleep mode. Other GPIOs can only wake up the chip from Light-sleep mode. For more information, please refer to Section :ref:`Wakeup Sources<api-reference-wakeup-source>`.
---
19 changes: 10 additions & 9 deletions docs/en/api-reference/peripherals/gpio/esp32h2.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,35 +51,35 @@ The table below provides more information on pin usage, and please note the comm
* - GPIO7
-
-
- RTC
* - GPIO8
-
- Strapping pin
- Strapping pin, RTC
* - GPIO9
-
- Strapping pin
- Strapping pin, RTC
* - GPIO10
- Analog comparator reference voltage
-
- RTC
* - GPIO11
- Analog comparator input (non-inverting)
-
- RTC
* - GPIO12
-
-
- RTC
* - GPIO13
-
-
- RTC
* - GPIO14
-
-
- RTC
* - GPIO15
-
Expand Down Expand Up @@ -135,10 +135,11 @@ The table below provides more information on pin usage, and please note the comm
.. note::
- Strapping pin: GPIO2, GPIO3, GPIO8, GPIO9, and GPIO25 are strapping pins. For more infomation, please refer to `ESP32H2 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_.
- Strapping pin: GPIO2, GPIO3, GPIO8, GPIO9, and GPIO25 are strapping pins. For more information, please refer to `ESP32H2 datasheet <{IDF_TARGET_DATASHEET_EN_URL}>`_.
- SPI0/1: GPIO15-21 are usually used for SPI flash and not recommended for other uses.
- USB-Serial-JTAG: GPIO 26 and 27 are used by USB-Serial-JTAG by default. In order to use them as GPIOs, USB-Serial-JTAG will be disabled by the drivers.
- For chip variants with an SiP flash built in, GPIO15 ~ GPIO21 are dedicated to connecting the SiP flash and are not fan-out to the external pins. In addition, GPIO6 ~ GPIO7 are also not fan-out to the external pins. In conclusion, only GPIO0~ GPIO5, GPIO8~ GPIO14, GPIO22~ GPIO27 are available to users.
- For chip variant without SiP flash, apart from the flash IOs mentioned above, GPIO22 is not fan-out to the external pin, thus they're not available to users.
- RTC: GPIO7-14 can be used to wake up the chip from Deep-sleep mode. Other GPIOs can only wake up the chip from Light-sleep mode. For more information, please refer to Section :ref:`Wakeup Sources<api-reference-wakeup-source>`.

---
2 changes: 2 additions & 0 deletions docs/en/api-reference/system/sleep_modes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Once wakeup sources are configured, the application can enter sleep mode using :

If Wi-Fi connections need to be maintained, enable Wi-Fi Modem-sleep mode and automatic Light-sleep feature (see :doc:`Power Management APIs <power_management>`). This will allow the system to wake up from sleep automatically when required by the Wi-Fi driver, thereby maintaining a connection to the AP.

.. _api-reference-wakeup-source:

Wakeup Sources
--------------

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/api-reference/peripherals/gpio/esp32c2.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,6 @@
- Strapping 管脚：GPIO8 和 GPIO9 是 Strapping 管脚。更多信息请参考 `ESP8684 技术规格书 <{IDF_TARGET_DATASHEET_CN_URL}>`_。
- SPI0/1：GPIO12-17 通常用于 SPI flash，不推荐用于其他用途。
- RTC：GPIO0-5 可以在 Deep-sleep 模式时使用。
- RTC：GPIO0-5 可用于将芯片从 Deep-sleep 模式中唤醒，其他 GPIO 仅能将芯片从 Light-sleep 模式中唤醒。更多信息请参考 :ref:`唤醒源<api-reference-wakeup-source>` 章节。
---
2 changes: 1 addition & 1 deletion docs/zh_CN/api-reference/peripherals/gpio/esp32c3.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,6 @@
- Strapping 管脚：GPIO2、GPIO8、和 GPIO9 是 Strapping 管脚。更多信息请参考 `ESP32-C3 技术规格书 <{IDF_TARGET_DATASHEET_CN_URL}>`_。
- SPI0/1：GPIO12-17 通常用于 SPI flash 和 PSRAM，不推荐用于其他用途。
- USB-JTAG：GPIO18 和 GPIO19 默认用于 USB-JTAG。用做 GPIO 时驱动程序将禁用 USB-JTAG。
- RTC：GPIO0-5 可以在 Deep-sleep 模式时使用。
- RTC：GPIO0-5 可用于将芯片从 Deep-sleep 模式中唤醒，其他 GPIO 仅能将芯片从 Light-sleep 模式中唤醒。更多信息请参考 :ref:`唤醒源<api-reference-wakeup-source>` 章节。
---
17 changes: 9 additions & 8 deletions docs/zh_CN/api-reference/peripherals/gpio/esp32h2.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,35 +53,35 @@
* - GPIO7
-
-
- RTC
* - GPIO8
-
- Strapping 管脚
- Strapping 管脚，RTC
* - GPIO9
-
- Strapping 管脚
- Strapping 管脚，RTC
* - GPIO10
- 模拟比较器外部参考电压
-
- RTC
* - GPIO11
- 模拟比较器同相输入
-
- RTC
* - GPIO12
-
-
- RTC
* - GPIO13
-
-
- RTC
* - GPIO14
-
-
- RTC
* - GPIO15
-
Expand Down Expand Up @@ -142,5 +142,6 @@
- USB-Serial-JTAG: GPIO26 和 GPIO27 默认用于 USB-Serial-JTAG。用做 GPIO 时驱动程序将禁用 USB-Serial-JTAG。
- 对于合封了 flash 的芯片型号， GPIO15 ~ GPIO21 专门用于连接该 flash, 并未引出至芯片管脚。且 GPIO6 ~ GPIO7 也未引出至芯片管脚，用户不可用。用户可配置使用其他剩余的 19 个 GPIO 管脚, 编号为: GPIO0 ~ GPIO5、GPIO8 ~ GPIO14、GPIO22 ~ GPIO27。
- 对于未合封 flash 的芯片型号， 除了以上提到的给 Flash 专用的 GPIO 以外, GPIO22 也并未引出至芯片管脚，用户不可用。
- RTC：GPIO7-14 可用于将芯片从 Deep-sleep 模式中唤醒，其他 GPIO 仅能将芯片从 Light-sleep 模式中唤醒。更多信息请参考 :ref:`唤醒源<api-reference-wakeup-source>` 章节。
---
2 changes: 2 additions & 0 deletions docs/zh_CN/api-reference/system/sleep_modes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Light-sleep 和 Deep-sleep 模式有多种唤醒源。这些唤醒源也可以

如需保持 Wi-Fi 连接，请启用 Wi-Fi Modem-sleep 模式和自动 Light-sleep 模式（请参阅 :doc:`电源管理 API <power_management>`）。在这两种模式下，Wi-Fi 驱动程序发出请求时，系统将自动从睡眠中被唤醒，从而保持与 AP 的连接。

.. _api-reference-wakeup-source:

唤醒源
---------

Expand Down

0 comments on commit 0bfffa0

Please sign in to comment.