esp-idf/docs/en/api-reference/peripherals/gpio.rst

GPIO & RTC GPIO
===============

:link_to_translation:`zh_CN:[中文]`

GPIO Summary
------------

.. include:: gpio/{IDF_TARGET_PATH_NAME}.inc
    :start-after: gpio-summary
    :end-before: ---


.. only:: SOC_RTCIO_INPUT_OUTPUT_SUPPORTED

    There is also separate "RTC GPIO" support, which functions when GPIOs are routed to the "RTC" low-power and analog subsystem. These pin functions can be used when:

    .. list::

        - In Deep-sleep mode
        :SOC_ULP_SUPPORTED: - The :doc:`Ultra Low Power co-processor <../../api-reference/system/ulp>` is running
        - Analog functions such as ADC/DAC/etc are in use.

Application Example
-------------------

* GPIO output and input interrupt example: :example:`peripherals/gpio/generic_gpio`.

API Reference - Normal GPIO
---------------------------

.. include-build-file:: inc/gpio.inc
.. include-build-file:: inc/gpio_types.inc


.. only:: SOC_RTCIO_INPUT_OUTPUT_SUPPORTED

    API Reference - RTC GPIO
    ------------------------

    .. include-build-file:: inc/rtc_io.inc
    .. include-build-file:: inc/rtc_io_types.inc
docs: Add missing peripheral driver docs (ADC, DAC, RTC I/O, I2S) 2017-02-15 21:59:50 -05:00			`GPIO & RTC GPIO`
			`===============`
Draft of GPIO API included 2016-10-25 06:09:05 -04:00
Docs/translate gpio 2022-05-31 00:19:34 -04:00			:link_to_translation:`zh_CN:[中文]`

doc: split gpio summary by target name 2022-11-09 03:11:36 -05:00			`GPIO Summary`
			`------------`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
doc: split gpio summary by target name 2022-11-09 03:11:36 -05:00			`.. include:: gpio/{IDF_TARGET_PATH_NAME}.inc`
			`:start-after: gpio-summary`
			`:end-before: ---`
doc: Update English pages with generic target name 2019-12-08 22:01:09 -05:00
gpio:support gpio in/out/interrupt for esp32s3(728) Add support of gpio for esp32s3(728). Adjust some pins and comments in test_gpio.c. Add support for gpio functions for gpio19 and gpio20. Update S3 programming guide Peripheral API: gpio and sigmadelta. Add unit test for input and output function of S3 USB pins(GPIO19 and GPIO20) and C3 USB pins(GPIO18 and GPIO19). Adjust input only test in test_spi_master.c. 2021-06-09 05:18:39 -04:00
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`.. only:: SOC_RTCIO_INPUT_OUTPUT_SUPPORTED`

			`There is also separate "RTC GPIO" support, which functions when GPIOs are routed to the "RTC" low-power and analog subsystem. These pin functions can be used when:`

			`.. list::`

Docs/translate gpio 2022-05-31 00:19:34 -04:00			`- In Deep-sleep mode`
docs: Updated ULP documentation This commit updates documentation for ULP. 2022-02-21 05:43:02 -05:00			:SOC_ULP_SUPPORTED: - The :doc:`Ultra Low Power co-processor <../../api-reference/system/ulp>` is running
Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`- Analog functions such as ADC/DAC/etc are in use.`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
			`Application Example`
			`-------------------`

doc: split gpio summary by target name 2022-11-09 03:11:36 -05:00			* GPIO output and input interrupt example: :example:`peripherals/gpio/generic_gpio`.
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 12:18:25 -04:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 04:36:01 -04:00			`API Reference - Normal GPIO`
			`---------------------------`
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs> 2016-11-05 12:18:25 -04:00
docs: add new top-level docs builder that builds docs for a single chip 2019-11-12 22:46:16 -05:00			`.. include-build-file:: inc/gpio.inc`
doc: add peripheral_types.h as API reference for peripheral docs Closes DOC-136 Closes IDF-1673 2020-04-27 22:52:14 -04:00			`.. include-build-file:: inc/gpio_types.inc`
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 16:50:55 -05:00

Docs: Add C3 support to build_docs 2020-10-28 21:57:09 -04:00			`.. only:: SOC_RTCIO_INPUT_OUTPUT_SUPPORTED`

			`API Reference - RTC GPIO`
			`------------------------`

			`.. include-build-file:: inc/rtc_io.inc`
			`.. include-build-file:: inc/rtc_io_types.inc`