riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

boards/*esp32*: Fix documentation format

Browse Source 
Fix broken references and missing open/closing group commands.
This commit is contained in:
Marian Buschsieweke 2021-10-05 16:06:58 +02:00
parent 72cab30703
commit 49ab2f0ef2
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
32 changed files with 70 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
boards/common/esp32/include/board_common.h
View File

@ -13,7 +13,7 @@
* This file contains board configurations that are valid for all ESP32. * This file contains board configurations that are valid for all ESP32.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @author Gunar Schorcht <gunar@schorcht.net> * @author Gunar Schorcht <gunar@schorcht.net>
* @file * @file
@ -112,7 +112,7 @@ extern "C" {
* @brief MTD drive start address in SPI flash memory * @brief MTD drive start address in SPI flash memory
* *
* Defines the start address of the MTD system device in the SPI * Defines the start address of the MTD system device in the SPI
* flash memory. It can be overridden by \ref esp32_app_spec_conf * flash memory. It can be overridden by \ref esp32_application_specific_configurations
* "application-specific board configuration" * "application-specific board configuration"
* *
* If the MTD start address is not defined or is 0, the first possible * If the MTD start address is not defined or is 0, the first possible

5
boards/common/esp32/include/periph_conf_common.h
View File

@ -13,7 +13,7 @@
* This file contains peripheral configurations that are valid for all ESP32. * This file contains peripheral configurations that are valid for all ESP32.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @author Gunar Schorcht <gunar@schorcht.net> * @author Gunar Schorcht <gunar@schorcht.net>
* @file * @file
@ -170,6 +170,7 @@ static const gpio_t pwm1_channels[] = PWM1_GPIOS;
/** /**
* @name SPI configuration * @name SPI configuration
* @{
*/ */
/** /**
@ -205,11 +206,11 @@ static const spi_conf_t spi_config[] = {
* @note SPI_NUMOF definition must not be changed. * @note SPI_NUMOF definition must not be changed.
*/ */
#define SPI_NUMOF ARRAY_SIZE(spi_config) #define SPI_NUMOF ARRAY_SIZE(spi_config)
/** @} */ /** @} */
/** /**
* @name UART configuration * @name UART configuration
* @{
*/ */
#ifndef UART0_TXD #ifndef UART0_TXD

2
boards/esp32-ethernet-kit-v1_0/doc_common.txt
View File

@ -47,7 +47,7 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="common_board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="common_board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]

3
boards/esp32-ethernet-kit-v1_0/include/periph_conf.h
View File

@ -41,9 +41,10 @@
#endif #endif
/** /**
* @brief Declaration of GPIOs that can be used as DAC channels * @name Declaration of GPIOs that can be used as DAC channels
* *
* ESP32-Ethernet-Kit has no GPIOs left that might be used as DAC channels. * ESP32-Ethernet-Kit has no GPIOs left that might be used as DAC channels.
* @{
*/ */
#ifndef DAC_GPIOS #ifndef DAC_GPIOS
#define DAC_GPIOS { } #define DAC_GPIOS { }

8
boards/esp32-heltec-lora32-v2/doc.txt
View File

@ -50,7 +50,7 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]
@ -88,7 +88,7 @@ unless you exactly know what you are doing.
The following table shows the default board configuration, which is sorted The following table shows the default board configuration, which is sorted
according to the defined functionality of GPIOs. This configuration can be according to the defined functionality of GPIOs. This configuration can be
overridden by \ref esp32_app_spec_conf "application-specific configurations". overridden by \ref esp32_application_specific_configurations "application-specific configurations".
<center> <center>
\anchor esp32_heltec_lora_32_v2_table_board_configuration \anchor esp32_heltec_lora_32_v2_table_board_configuration
@ -120,7 +120,7 @@ OLED RESET | GPIO16 | | |
\ref esp32_flash_modes "flash modes". \ref esp32_flash_modes "flash modes".
For detailed information about the configuration of ESP32 boards, see For detailed information about the configuration of ESP32 boards, see
section \ref esp32_comm_periph "Common Peripherals". section \ref esp32_peripherals "Common Peripherals".
### <a name="oled_display"> Using the OLED Display </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="oled_display"> Using the OLED Display </a> &nbsp;&nbsp; [[TOC](#toc)]
@ -167,7 +167,7 @@ BOARD=esp32-heltec-lora32-v2 make -C tests/pkg_u8g2/ flash
MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet
network interface modules have been tested with the board. You could use network interface modules have been tested with the board. You could use
the following code in your the following code in your
\ref esp32_app_spec_conf "application-specific configuration" \ref esp32_application_specific_configurations "application-specific configuration"
to use such modules: to use such modules:
``` ```

2
boards/esp32-heltec-lora32-v2/include/arduino_pinmap.h
View File

@ -54,7 +54,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO4 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO4 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO15 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO15 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

4
boards/esp32-heltec-lora32-v2/include/board.h
View File

@ -17,10 +17,10 @@
* Additionally, it has an OLED display connected via I2C on board. * Additionally, it has an OLED display connected via I2C on board.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

4
boards/esp32-heltec-lora32-v2/include/periph_conf.h
View File

@ -17,10 +17,10 @@
* Additionally, it has an OLED display connected via I2C on board. * Additionally, it has an OLED display connected via I2C on board.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

8
boards/esp32-mh-et-live-minikit/doc.txt
View File

@ -65,11 +65,11 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]
The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_app_spec_conf "application-specific configuration". The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_application_specific_configurations "application-specific configuration".
<center> <center>
\anchor esp32_mh-et-live-minikit_table_board_configuration \anchor esp32_mh-et-live-minikit_table_board_configuration
@ -111,11 +111,11 @@ GPIO33 | - | | | |
- GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes". - GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes".
- The **RESET** signal of MRF24J40 shield can be connected to the RST **pin** of the board (see \ref esp32_mh-et-live-minikit "pinout") to keep the configured GPIO free for other purposes. - The **RESET** signal of MRF24J40 shield can be connected to the RST **pin** of the board (see \ref esp32_mh-et-live-minikit "pinout") to keep the configured GPIO free for other purposes.
For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals".
### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)]
ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such a module: ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such a module:
``` ```
#if MODULE_ENC28J80 && BOARD_ESP32_MH_ET_LIVE_MINIKIT #if MODULE_ENC28J80 && BOARD_ESP32_MH_ET_LIVE_MINIKIT

2
boards/esp32-mh-et-live-minikit/include/arduino_pinmap.h
View File

@ -54,7 +54,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

4
boards/esp32-mh-et-live-minikit/include/board.h
View File

@ -18,10 +18,10 @@
* it can be configured very flexibly. * it can be configured very flexibly.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

4
boards/esp32-mh-et-live-minikit/include/board_modules.h
View File

@ -16,7 +16,7 @@
* The board can be used with lots of optional stackable hardware modules. * The board can be used with lots of optional stackable hardware modules.
* This file contains the default configurations for those hardware modules * This file contains the default configurations for those hardware modules
* that have been tested. Most of these configurations can be overridden by an * that have been tested. Most of these configurations can be overridden by an
* \ref esp32_app_spec_conf "application-specific configuration". * \ref esp32_application_specific_configurations "application-specific configuration".
* *
* The configurations of the respective hardware modules only take place if * The configurations of the respective hardware modules only take place if
* the corresponding driver modules are used. * the corresponding driver modules are used.
@ -71,7 +71,7 @@ extern "C" {
* CS signal. * CS signal.
* *
* @note Please override the definition of CS pin by an by \ref * @note Please override the definition of CS pin by an by \ref
* esp32_app_spec_conf "application-specific configurations" according to your * esp32_application_specific_configurations "application-specific configurations" according to your
* solder bride configuration. * solder bride configuration.
* @{ * @{
*/ */

4
boards/esp32-mh-et-live-minikit/include/periph_conf.h
View File

@ -18,10 +18,10 @@
* it can be configured very flexibly. * it can be configured very flexibly.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

8
boards/esp32-olimex-evb/doc.txt
View File

@ -54,7 +54,7 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]
@ -67,7 +67,7 @@ Olimex ESP32-EVB and Olimex ESP32-GATEWAY have the following on-board components
- two Relais (Olimex ESP32-EVB only) - two Relais (Olimex ESP32-EVB only)
- [UEXT](https://www.olimex.com/Products/Modules/UEXT/) connector with I2C, SPI and UART interfaces (Olimex ESP32-EVB only) - [UEXT](https://www.olimex.com/Products/Modules/UEXT/) connector with I2C, SPI and UART interfaces (Olimex ESP32-EVB only)
The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_app_spec_conf "application-specific configurations". The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_application_specific_configurations "application-specific configurations".
<center> <center>
\anchor esp32_olimex-esp32-evb_table_board_configuration \anchor esp32_olimex-esp32-evb_table_board_configuration
@ -111,11 +111,11 @@ USEMODULE += olimex_esp32_gateway
- GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes". - GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes".
- It might be necessary to remove the SD card or the peripheral hardware attached to the SPI_DEV(0) interface for flashing RIOT. Reason is that the **SPI_DEV(0)** interface uses the HSPI interface with the GPIO2 pin as the MISO signal, which has bootstrapping functionality. - It might be necessary to remove the SD card or the peripheral hardware attached to the SPI_DEV(0) interface for flashing RIOT. Reason is that the **SPI_DEV(0)** interface uses the HSPI interface with the GPIO2 pin as the MISO signal, which has bootstrapping functionality.
For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals".
### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)]
MRF24J40-based IEEE 802.15.4 radio modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such modules: MRF24J40-based IEEE 802.15.4 radio modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules:
``` ```
#ifdef BOARD_ESP32_OLIMEX_EVB && !MODULE_ESP32_OLIMEX_GATEWAY #ifdef BOARD_ESP32_OLIMEX_EVB && !MODULE_ESP32_OLIMEX_GATEWAY

2
boards/esp32-olimex-evb/include/arduino_pinmap.h
View File

@ -54,7 +54,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO13 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO13 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO16 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO16 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

4
boards/esp32-olimex-evb/include/board.h
View File

@ -20,10 +20,10 @@
* configuration. * configuration.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @author Gunar Schorcht <gunar@schorcht.net> * @author Gunar Schorcht <gunar@schorcht.net>

4
boards/esp32-olimex-evb/include/periph_conf.h
View File

@ -21,10 +21,10 @@
* configuration. * configuration.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @author Gunar Schorcht <gunar@schorcht.net> * @author Gunar Schorcht <gunar@schorcht.net>

6
boards/esp32-ttgo-t-beam/doc.txt
View File

@ -51,7 +51,7 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]
@ -88,7 +88,7 @@ unless you exactly know what you are doing.
The following table shows the default board configuration, which is sorted The following table shows the default board configuration, which is sorted
according to the defined functionality of GPIOs. This configuration can be according to the defined functionality of GPIOs. This configuration can be
overridden by \ref esp32_app_spec_conf "application-specific configurations". overridden by \ref esp32_application_specific_configurations "application-specific configurations".
TTGO- T-Beam rev1 TTGO- T-Beam rev1
@ -141,7 +141,7 @@ UART_DEV(1):RxD | GPIO12 | GPS (configuration is fixed) | \ref esp32_uart_interf
as ADC channels. as ADC channels.
For detailed information about the configuration of ESP32 boards, see For detailed information about the configuration of ESP32 boards, see
section \ref esp32_comm_periph "Common Peripherals". section \ref esp32_peripherals "Common Peripherals".
### <a name="pinout"> Board Pinout </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="pinout"> Board Pinout </a> &nbsp;&nbsp; [[TOC](#toc)]

2
boards/esp32-ttgo-t-beam/include/arduino_pinmap.h
View File

@ -50,7 +50,7 @@ extern "C" {
#define ARDUINO_PIN_A3 GPIO35 /**< Arduino Uno pin A3 */ #define ARDUINO_PIN_A3 GPIO35 /**< Arduino Uno pin A3 */
#define ARDUINO_PIN_A4 GPIO36 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO36 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO39 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO39 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

4
boards/esp32-ttgo-t-beam/include/board.h
View File

@ -17,10 +17,10 @@
* Additionally, it has an OLED display connected via I2C on board. * Additionally, it has an OLED display connected via I2C on board.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

4
boards/esp32-ttgo-t-beam/include/periph_conf.h
View File

@ -17,10 +17,10 @@
* Additionally, it has an GPS receiver connected via UART on board. * Additionally, it has an GPS receiver connected via UART on board.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

8
boards/esp32-wemos-lolin-d32-pro/doc.txt
View File

@ -50,7 +50,7 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]
@ -60,7 +60,7 @@ The board for the Wemos LOLIN D32 Pro has the following on-board components:
- 1 x Micro SD card interface - 1 x Micro SD card interface
- 1 x TFT display connector - 1 x TFT display connector
The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_app_spec_conf "application-specific configuration". The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by an \ref esp32_application_specific_configurations "application-specific configuration".
<center> <center>
\anchor esp32_wemos-lolin-d32-pro_table_board_configuration \anchor esp32_wemos-lolin-d32-pro_table_board_configuration
@ -99,11 +99,11 @@ GPIO27 | - | TFT_DC | when TFT is connected | |
USEMODULE += esp_lolin_tft USEMODULE += esp_lolin_tft
``` ```
For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals".
### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)]
MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such modules: MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules:
``` ```
#ifdef BOARD_ESP32_WEMOS_LOLIN_D32_PRO #ifdef BOARD_ESP32_WEMOS_LOLIN_D32_PRO

2
boards/esp32-wemos-lolin-d32-pro/include/arduino_pinmap.h
View File

@ -54,7 +54,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

4
boards/esp32-wemos-lolin-d32-pro/include/board.h
View File

@ -29,10 +29,10 @@
* configuration. * configuration.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

4
boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h
View File

@ -30,10 +30,10 @@
* configuration. * configuration.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @author Gunar Schorcht <gunar@schorcht.net> * @author Gunar Schorcht <gunar@schorcht.net>

8
boards/esp32-wroom-32/doc.txt
View File

@ -41,7 +41,7 @@ This section describes
### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="mcu"> MCU </a> &nbsp;&nbsp; [[TOC](#toc)]
Most features of the board are provided by the ESP32 SoC. For detailed Most features of the board are provided by the ESP32 SoC. For detailed
information about the ESP32, see section \ref esp32_mcu "MCU ESP32". information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".
### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="board_configuration"> Board Configuration </a> &nbsp;&nbsp; [[TOC](#toc)]
@ -65,7 +65,7 @@ That is, the purpose for which a GPIO is used depends on which module or functio
For example, if module periph_i2c is not used, the GPIOs listed in I2C configuration can be used for the other purposes. For example, if module periph_i2c is not used, the GPIOs listed in I2C configuration can be used for the other purposes.
The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_app_spec_conf "application-specific configurations". The following table shows the default board configuration, which is sorted according to the defined functionality of GPIOs. This configuration can be overridden by \ref esp32_application_specific_configurations "application-specific configurations".
<center> <center>
\anchor esp32_wroom_32_table_board_configuration \anchor esp32_wroom_32_table_board_configuration
@ -97,11 +97,11 @@ UART_DEV(1):RxD | GPIO9 | not available in **qout** and **qio** flash mode | \r
- The configuration of DAC channels contains all ESP32 GPIOs that can be used as DAC channels. - The configuration of DAC channels contains all ESP32 GPIOs that can be used as DAC channels.
- GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes". - GPIO9 and GIOP10 can only be used in **dout** and **dio** \ref esp32_flash_modes "flash modes".
For detailed information about the configuration of ESP32 boards, see section \ref esp32_comm_periph "Common Peripherals". For detailed information about the configuration of ESP32 boards, see section \ref esp32_peripherals "Common Peripherals".
### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)] ### <a name="optional_hardware"> Optional Hardware Configurations </a> &nbsp;&nbsp; [[TOC](#toc)]
MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_app_spec_conf "application-specific configuration" to use such modules: MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules:
``` ```
#ifdef BOARD_ESP32_WROOM-32 #ifdef BOARD_ESP32_WROOM-32

2
boards/esp32-wroom-32/include/arduino_pinmap.h
View File

@ -54,7 +54,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO21 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO22 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

4
boards/esp32-wroom-32/include/board.h
View File

@ -18,10 +18,10 @@
* number of clones. * number of clones.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

4
boards/esp32-wroom-32/include/periph_conf.h
View File

@ -18,10 +18,10 @@
* number of clones. * number of clones.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file

2
boards/esp32-wrover-kit/include/arduino_pinmap.h
View File

@ -54,7 +54,7 @@ extern "C" {
#define ARDUINO_PIN_A4 GPIO26 /**< Arduino Uno pin A4 (SDA) */ #define ARDUINO_PIN_A4 GPIO26 /**< Arduino Uno pin A4 (SDA) */
#define ARDUINO_PIN_A5 GPIO27 /**< Arduino Uno pin A5 (SCL) */ #define ARDUINO_PIN_A5 GPIO27 /**< Arduino Uno pin A5 (SCL) */
/** @ */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }

6
boards/esp32-wrover-kit/include/board.h
View File

@ -32,10 +32,10 @@
* configuration. * configuration.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file
@ -77,6 +77,8 @@
#define LED_BLUE_PIN LED2_PIN /**< LED2 is a blue LED */ #define LED_BLUE_PIN LED2_PIN /**< LED2 is a blue LED */
#endif #endif
/** @} */
/** /**
* @name SD-Card interface configuration * @name SD-Card interface configuration
* *

4
boards/esp32-wrover-kit/include/periph_conf.h
View File

@ -32,10 +32,10 @@
* configuration. * configuration.
* *
* For detailed information about the configuration of ESP32 boards, see * For detailed information about the configuration of ESP32 boards, see
* section \ref esp32_comm_periph "Common Peripherals". * section \ref esp32_peripherals "Common Peripherals".
* *
* @note * @note
* Most definitions can be overridden by an \ref esp32_app_spec_conf * Most definitions can be overridden by an \ref esp32_application_specific_configurations
* "application-specific board configuration". * "application-specific board configuration".
* *
* @file * @file