Merge pull request #16982 from maribu/cpu/esp32/doc

cpu/esp32, boards/esp32-wrover-kit: restore intended alignment of tables
This commit is contained in:
Gunar Schorcht 2021-10-13 16:28:12 +02:00 committed by GitHub
commit 2797f0ef8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 0 deletions

View File

@ -79,6 +79,8 @@ These abbreviations are used in subsequent tables:
*SDC* = SD-Card interface is used (module **sdcard_spi** is enabled)<br> *SDC* = SD-Card interface is used (module **sdcard_spi** is enabled)<br>
*CAM* = Camera is plugged in/used *CAM* = Camera is plugged in/used
<center>
| Function | None | SDC | CAM | SDC + CAM | Remarks | Configuration | | Function | None | SDC | CAM | SDC + CAM | Remarks | Configuration |
|:----------------------|-----------|-----------|-----------|-----------|:------------------------------|-------------------------------| |:----------------------|-----------|-----------|-----------|-----------|:------------------------------|-------------------------------|
| `ADC_LINE(0)` | `GPIO34` | `GPIO34` | - | - | `CAMERA_D6` | \ref esp32_adc_channels | | `ADC_LINE(0)` | `GPIO34` | `GPIO34` | - | - | `CAMERA_D6` | \ref esp32_adc_channels |
@ -122,8 +124,12 @@ These abbreviations are used in subsequent tables:
| `CAMERA_SIO_C` | - | - | `GPIO27` | `GPIO27` | | | | `CAMERA_SIO_C` | - | - | `GPIO27` | `GPIO27` | | |
| `CAMERA_RESET` | - | - | `GPIO0` | `GPIO0` | | | | `CAMERA_RESET` | - | - | `GPIO0` | `GPIO0` | | |
</center>
Following table shows the default board configuration sorted by GPIOs. Following table shows the default board configuration sorted by GPIOs.
<center>
| Pin | None | SDC | CAM | SDC+CAM | Remarks | | Pin | None | SDC | CAM | SDC+CAM | Remarks |
|:-------|:-----------------------|:--------------------|:--------------------|:---------------------------|:-----| |:-------|:-----------------------|:--------------------|:--------------------|:---------------------------|:-----|
| GPIO0 | PWM_DEV(0):0 / LED0 | PWM_DEV(0):0 / LED0 | CAMERA_RESET | CAMERA_RESET | | | GPIO0 | PWM_DEV(0):0 / LED0 | PWM_DEV(0):0 / LED0 | CAMERA_RESET | CAMERA_RESET | |
@ -159,6 +165,8 @@ Following table shows the default board configuration sorted by GPIOs.
| GPIO36 | ADC_LINE(2) | ADC_LINE(2) | ADC_LINE(2) | CAMERA_D4 | | | GPIO36 | ADC_LINE(2) | ADC_LINE(2) | ADC_LINE(2) | CAMERA_D4 | |
| GPIO39 | ADC_LINE(3) | ADC_LINE(3) | ADC_LINE(3) | CAMERA_D5 | | | GPIO39 | ADC_LINE(3) | ADC_LINE(3) | ADC_LINE(3) | CAMERA_D5 | |
</center>
@note @note
- SPI_DEV(0) uses the HSPI interface with the GPIO2 pin as the MISO signal. - SPI_DEV(0) uses the HSPI interface with the GPIO2 pin as the MISO signal.
Since GPIO2 has bootstrapping functionality, it might be necessary to to Since GPIO2 has bootstrapping functionality, it might be necessary to to

View File

@ -81,6 +81,8 @@ ESP-IDF SDK.
The following table gives a short reference of all board configuration parameters used by the ESP32 The following table gives a short reference of all board configuration parameters used by the ESP32
port in alphabetical order. port in alphabetical order.
<center>
Parameter | Short Description | Type* Parameter | Short Description | Type*
----------------------------------------|-------------------------------------------------------------------|------ ----------------------------------------|-------------------------------------------------------------------|------
[ADC_GPIOS](#esp32_adc_channels) | GPIOs that can be used as ADC channels | m [ADC_GPIOS](#esp32_adc_channels) | GPIOs that can be used as ADC channels | m
@ -110,12 +112,15 @@ Parameter | Short Description
[UART2_TXD](#esp32_uart_interfaces) | GPIO used as TxD for UART_DEV(2) | o [UART2_TXD](#esp32_uart_interfaces) | GPIO used as TxD for UART_DEV(2) | o
[UART2_RXD](#esp32_uart_interfaces) | GPIO used as RxD for UART_DEV(2) | o [UART2_RXD](#esp32_uart_interfaces) | GPIO used as RxD for UART_DEV(2) | o
</center>
**Type:* m - mandatory, o - optional **Type:* m - mandatory, o - optional
The following table gives a short reference in alphabetical order of modules The following table gives a short reference in alphabetical order of modules
that can be enabled/disabled by board configurations and/or application's that can be enabled/disabled by board configurations and/or application's
makefile using `USEMODULE` and `DISABLE_MODULE`. makefile using `USEMODULE` and `DISABLE_MODULE`.
<center>
Module | Default | Short description Module | Default | Short description
----------------------------------------------------|-----------|------------------- ----------------------------------------------------|-----------|-------------------
@ -135,6 +140,8 @@ Module | Default | Short descript
[esp_wifi_ap](#esp32_wifi_ap_network_interface) | not used | enable the WiFi SoftAP network device [esp_wifi_ap](#esp32_wifi_ap_network_interface) | not used | enable the WiFi SoftAP network device
[esp_wifi_enterprise](#esp32_wifi_network_interface)| not used | enable the Wifi network device in WPA2 enterprise mode [esp_wifi_enterprise](#esp32_wifi_network_interface)| not used | enable the Wifi network device in WPA2 enterprise mode
</center>
[Back to table of contents](#esp32_toc) [Back to table of contents](#esp32_toc)