kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2026-01-01 01:41:18 +01:00
Code Releases Activity

Merge #19810

Browse Source 
19810: boards/esp32: small documentation fixes r=dylad a=gschorcht

### Contribution description

This PR fixes some documentation issues for ESP32x boards.

### Testing procedure

Green CI

### Issues/PRs references


Co-authored-by: Gunar Schorcht <gunar@schorcht.net>
This commit is contained in:
bors[bot] 2023-07-07 09:21:43 +00:00 committed by GitHub
commit 9a9d729deb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 74 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
boards/esp32s3-devkit/doc.txt
View File

@ -167,6 +167,8 @@ UART_DEV(0) RxD | GPIO44 | Console (configuration is fixed) | \ref esp32_uart_in
</center>
\n
@note The RGB-LED is connected to GPIO38 on ESP32-S3-DevKitC-1 revision 1.1 boards.
For detailed information about the peripheral configurations of ESP32-S3
boards, see section \ref esp32_peripherals "Common Peripherals".

16
boards/esp32s3-devkit/include/board.h
View File

@ -42,8 +42,8 @@
/**
* @brief Default button GPIO pin definition
*
* ESP32-S3-DevKit boards have a BOOT button connected to GPIO9, which can be
* used as button during normal operation. Since the GPIO9 pin is pulled up,
* ESP32-S3-DevKit boards have a BOOT button connected to GPIO0, which can be
* used as button during normal operation. Since the GPIO0 pin is pulled up,
* the button signal is inverted, i.e., pressing the button will give a
* low signal.
*/
@ -51,9 +51,6 @@
/**
* @brief Default button GPIO mode definition
*
* Since the GPIO of the button is pulled up with an external resistor, the
* mode for the GPIO pin has to be GPIO_IN.
*/
#define BTN0_MODE GPIO_IN_PU
@ -74,8 +71,13 @@
/**
* @name LED (on-board) configuration
*
* ESP32-S3-DevKit boards have a SK68XXMINI-HS smart RGB-LED connected to
* GPIO48 on-board. The WS281x driver module `ws281x` can be used to control it.
* ESP32-S3-DevKit boards have a SK68XXMINI-HS smart RGB LED on-board connected
* to either
*
* - GPIO48 (ESP32-S3-DevKitC-1 revision 1.0 and all ESP32-S3-DevKitM-1 boards) or
* - GPIO38 (ESP32-S3-DevKitC-1 revision 1.1).
*
* The WS281x driver module `ws281x` can be used for control.
* @{
*/
#ifndef WS281X_PARAM_PIN

42
cpu/esp32/doc_esp32.txt
View File

@ -159,35 +159,35 @@ though it **can vary** from board to board.
Device |Signal| Pin | Symbol | Remarks
:-----------------------|:----:|:-------|:-----------:|:---------------------------
`SPI_HOST0`/`SPI_HOST1` | SCK | GPIO6 |- | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | CMD | GPIO11 |- | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SD0 | GPIO7 |- | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SD1 | GPIO8 |- | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SD2 | GPIO9 |- | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST0`/`SPI_HOST1` | SD3 | GPIO10 |- | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST2` (`HSPI`) | SCK | GPIO14 |`#SPI1_SCK` | can be used
`SPI_HOST2` (`HSPI`) | MISO | GPIO12 |`#SPI1_MISO` | can be used
`SPI_HOST2` (`HSPI`) | MOSI | GPIO13 |`#SPI1_MOSI` | can be used
`SPI_HOST2` (`HSPI`) | CS0 | GPIO15 |`#SPI1_CS0` | can be used
`SPI_HOST3` (`VSPI`) | SCK | GPIO18 |`#SPI0_SCK` | can be used
`SPI_HOST3` (`VSPI`) | MISO | GPIO19 |`#SPI0_MISO` | can be used
`SPI_HOST3` (`VSPI`) | MOSI | GPIO23 |`#SPI0_MOSI` | can be used
`SPI_HOST3` (`VSPI`) | CS0 | GPIO5 |`#SPI0_CS0` | can be used
`SPI0_HOST`/`SPI1_HOST` | SCK | GPIO6 |- | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | CMD | GPIO11 |- | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SD0 | GPIO7 |- | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SD1 | GPIO8 |- | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SD2 | GPIO9 |- | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI0_HOST`/`SPI1_HOST` | SD3 | GPIO10 |- | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI2_HOST` (`HSPI`) | SCK | GPIO14 |`#SPI1_SCK` | can be used
`SPI2_HOST` (`HSPI`) | MISO | GPIO12 |`#SPI1_MISO` | can be used
`SPI2_HOST` (`HSPI`) | MOSI | GPIO13 |`#SPI1_MOSI` | can be used
`SPI2_HOST` (`HSPI`) | CS0 | GPIO15 |`#SPI1_CS0` | can be used
`SPI3_HOST` (`VSPI`) | SCK | GPIO18 |`#SPI0_SCK` | can be used
`SPI3_HOST` (`VSPI`) | MISO | GPIO19 |`#SPI0_MISO` | can be used
`SPI3_HOST` (`VSPI`) | MOSI | GPIO23 |`#SPI0_MOSI` | can be used
`SPI3_HOST` (`VSPI`) | CS0 | GPIO5 |`#SPI0_CS0` | can be used
</center><br>
Some boards use the `HSPI` (`SPI_HOST2`) as SD-Card interface (SDIO) in 4-bit SD mode.
Some boards use the `HSPI` (`SPI2_HOST`) as SD-Card interface (SDIO) in 4-bit SD mode.
<center>
Device | Pin | SD 4-bit mode | SPI mode
:---------------------|:------:|:-------------:|:----------:
`SPI_HOST2` (`HSPI`) | GPIO14 | CLK | SCK
`SPI_HOST2` (`HSPI`) | GPIO15 | CMD | CS0
`SPI_HOST2` (`HSPI`) | GPIO2 | DAT0 | MISO
`SPI_HOST2` (`HSPI`) | GPIO4 | DAT1 | -
`SPI_HOST2` (`HSPI`) | GPIO12 | DAT2 | -
`SPI_HOST2` (`HSPI`) | GPIO13 | DAT3 | MOSI
`SPI2_HOST` (`HSPI`) | GPIO14 | CLK | SCK
`SPI2_HOST` (`HSPI`) | GPIO15 | CMD | CS0
`SPI2_HOST` (`HSPI`) | GPIO2 | DAT0 | MISO
`SPI2_HOST` (`HSPI`) | GPIO4 | DAT1 | -
`SPI2_HOST` (`HSPI`) | GPIO12 | DAT2 | -
`SPI2_HOST` (`HSPI`) | GPIO13 | DAT3 | MOSI
</center><br>

20
cpu/esp32/doc_esp32c3.txt
View File

@ -129,16 +129,16 @@ though it **can vary** from board to board.
Device | Signal | Pin | Symbol | Remarks
:-----------------------|:------:|:-------|:-----------:|:---------------------------
`SPI_HOST0`/`SPI_HOST1` | SPICS0 | GPIO14 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPICLK | GPIO15 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPID | GPIO16 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPIQ | GPIO17 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPIHD | GPIO12 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST0`/`SPI_HOST1` | SPIWP | GPIO13 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST2` (`FSPI`) | SCK | GPIO6 |`#SPI0_SCK` | can be used
`SPI_HOST2` (`FSPI`) | MOSI | GPIO7 |`#SPI0_MOSI` | can be used
`SPI_HOST2` (`FSPI`) | MISO | GPIO2 |`#SPI0_MISO` | can be used
`SPI_HOST2` (`FSPI`) | CS0 | GPIO10 |`#SPI0_CS0` | can be used
`SPI0_HOST`/`SPI1_HOST` | SPICS0 | GPIO14 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPICLK | GPIO15 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPID | GPIO16 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPIQ | GPIO17 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPIHD | GPIO12 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI0_HOST`/`SPI1_HOST` | SPIWP | GPIO13 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI2_HOST` (`FSPI`) | SCK | GPIO6 |`#SPI0_SCK` | can be used
`SPI2_HOST` (`FSPI`) | MOSI | GPIO7 |`#SPI0_MOSI` | can be used
`SPI2_HOST` (`FSPI`) | MISO | GPIO2 |`#SPI0_MISO` | can be used
`SPI2_HOST` (`FSPI`) | CS0 | GPIO10 |`#SPI0_CS0` | can be used
</center><br>

32
cpu/esp32/doc_esp32s2.txt
View File

@ -223,22 +223,22 @@ though it **can vary** from board to board.
Device | Signal | Pin | Symbol | Remarks
:-----------------------|:------:|:-------|:-----------:|:---------------------------
`SPI_HOST0`/`SPI_HOST1` | SPICS0 | GPIO29 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPICS1 | GPIO26 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPICLK | GPIO30 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPID | GPIO32 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPIQ | GPIO31 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPIHD | GPIO27 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST0`/`SPI_HOST1` | SPIWP | GPIO28 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO4 | GPIO33 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO5 | GPIO34 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO6 | GPIO35 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO7 | GPIO36 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIDQA | GPIO37 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST2` (`FSPI`) | SCK | GPIO12 |`#SPI0_SCK` | can be used
`SPI_HOST2` (`FSPI`) | MOSI | GPIO11 |`#SPI0_MOSI` | can be used
`SPI_HOST2` (`FSPI`) | MISO | GPIO13 |`#SPI0_MISO` | can be used
`SPI_HOST2` (`FSPI`) | CS0 | GPIO10 |`#SPI0_CS0` | can be used
`SPI0_HOST`/`SPI1_HOST` | SPICS0 | GPIO29 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPICS1 | GPIO26 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPICLK | GPIO30 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPID | GPIO32 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPIQ | GPIO31 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPIHD | GPIO27 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI0_HOST`/`SPI1_HOST` | SPIWP | GPIO28 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO4 | GPIO33 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO5 | GPIO34 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO6 | GPIO35 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO7 | GPIO36 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIDQA | GPIO37 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI2_HOST` (`FSPI`) | SCK | GPIO12 |`#SPI0_SCK` | can be used
`SPI2_HOST` (`FSPI`) | MOSI | GPIO11 |`#SPI0_MOSI` | can be used
`SPI2_HOST` (`FSPI`) | MISO | GPIO13 |`#SPI0_MISO` | can be used
`SPI2_HOST` (`FSPI`) | CS0 | GPIO10 |`#SPI0_CS0` | can be used
</center><br>

32
cpu/esp32/doc_esp32s3.txt
View File

@ -231,22 +231,22 @@ though it **can vary** from board to board.
Device | Signal | Pin | Symbol | Remarks
:-----------------------|:------:|:-------|:-----------:|:---------------------------
`SPI_HOST0`/`SPI_HOST1` | SPICS0 | GPIO29 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPICS1 | GPIO26 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPICLK | GPIO30 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPID | GPIO32 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPIQ | GPIO31 | - | reserved for flash and PSRAM
`SPI_HOST0`/`SPI_HOST1` | SPIHD | GPIO27 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST0`/`SPI_HOST1` | SPIWP | GPIO28 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO4 | GPIO33 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO5 | GPIO34 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO6 | GPIO35 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIIO7 | GPIO36 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST0`/`SPI_HOST1` | SPIDQA | GPIO37 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI_HOST2` (`FSPI`) | SCK | GPIO12 |`#SPI0_SCK` | can be used
`SPI_HOST2` (`FSPI`) | MOSI | GPIO11 |`#SPI0_MOSI` | can be used
`SPI_HOST2` (`FSPI`) | MISO | GPIO13 |`#SPI0_MISO` | can be used
`SPI_HOST2` (`FSPI`) | CS0 | GPIO10 |`#SPI0_CS0` | can be used
`SPI0_HOST`/`SPI1_HOST` | SPICS0 | GPIO29 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPICS1 | GPIO26 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPICLK | GPIO30 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPID | GPIO32 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPIQ | GPIO31 | - | reserved for flash and PSRAM
`SPI0_HOST`/`SPI1_HOST` | SPIHD | GPIO27 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI0_HOST`/`SPI1_HOST` | SPIWP | GPIO28 | - | reserved for flash and PSRAM (only in `qio` or `qout` mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO4 | GPIO33 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO5 | GPIO34 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO6 | GPIO35 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIIO7 | GPIO36 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI0_HOST`/`SPI1_HOST` | SPIDQA | GPIO37 | - | reserved for Flash and PSRAM (only in octal mode)
`SPI2_HOST` (`FSPI`) | SCK | GPIO12 |`#SPI0_SCK` | can be used
`SPI2_HOST` (`FSPI`) | MOSI | GPIO11 |`#SPI0_MOSI` | can be used
`SPI2_HOST` (`FSPI`) | MISO | GPIO13 |`#SPI0_MISO` | can be used
`SPI2_HOST` (`FSPI`) | CS0 | GPIO10 |`#SPI0_CS0` | can be used
</center><br>