espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-19 23:45:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: initial parallel IO programming guide

Browse Source 
Also correct the GPIO information on esp32h2.
This commit is contained in:
morris
2023-02-22 13:29:31 +08:00
parent f534247a00
commit a7f5ff32ff
8 changed files with 48 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/peripherals/gpio/esp32h2.inc
+5 -4
View File
@@ -62,11 +62,11 @@ The table below provides more information on pin usage, and please note the comm
- Strapping pin
* - GPIO10
-
- Analog comparator reference voltage
-
* - GPIO11
-
- Analog comparator input (non-inverting)
-
* - GPIO12
@@ -137,7 +137,8 @@ The table below provides more information on pin usage, and please note the comm
- Strapping pin: GPIO2, GPIO3, GPIO8, GPIO9, and GPIO25 are strapping pins. For more infomation, please refer to `ESP32H2 datasheet <https://www.espressif.com/sites/default/files/documentation/esp32h2_datasheet_en.pdf>`_.
- SPI0/1: GPIO15-21 are usually used for SPI flash and not recommended for other uses.
- USB-JTAG: GPIO 26 and 27 are used by USB-JTAG by default. In order to use them as GPIOs, USB-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; therefore, only the remaining 21 GPIO pins are available.
- 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.
---
docs/en/api-reference/peripherals/index.rst
+1
View File
@@ -22,6 +22,7 @@ Peripherals API
lcd
ledc
:SOC_MCPWM_SUPPORTED: mcpwm
:SOC_PARLIO_SUPPORTED: parlio
:SOC_PCNT_SUPPORTED: pcnt
:SOC_RMT_SUPPORTED: rmt
:esp32: sd_pullup_requirements
docs/en/api-reference/peripherals/parlio.rst
+27
View File
@@ -0,0 +1,27 @@
Parallel IO
===========
Introduction
------------
The Parallel IO peripheral is a general purpose parallel interface that can be used to connect to external devices such as LED matrix, LCD display, Printer and Camera. The peripheral has independent TX and RX units. Each unit can have up to 8 or 16 data signals plus 1 or 2 clock signals. [1]_
.. warning::
At the moment, the Parallel IO driver only supports TX mode. The RX feature is still working in progress.
Application Examples
--------------------
* Simple REG LED Matrix with HUB75 interface: :example:`peripherals/parlio/simple_rgb_led_matrix`.
API Reference
-------------
.. include-build-file:: inc/parlio_tx.inc
.. include-build-file:: inc/components/driver/parlio/include/driver/parlio_types.inc
.. include-build-file:: inc/components/hal/include/hal/parlio_types.inc
.. [1]
Different ESP chip series might have different numbers of PARLIO TX/RX instances, and the maximum data bus can also be different. For more details, please refer to *{IDF_TARGET_NAME} Technical Reference Manual* > Chapter *Parallel IO (PARLIO)* [`PDF <{IDF_TARGET_TRM_EN_URL}#parlio>`__]. The driver will not forbid you from applying for more driver objects, but it will return error when all available hardware resources are used up. Please always check the return value when doing resource allocation (e.g. :cpp:func:`parlio_new_tx_unit`).