periph_conf.h File Reference

Peripheral MCU configuration for generic ESP32-WROOM-32 boards. More...

Detailed Description

Peripheral MCU configuration for generic ESP32-WROOM-32 boards.

This configuration can be used for a large set of ESP32 boards that use an ESP32-WROOM-32 module and simply break out all GPIOs to external pads without having any special hardware or interfaces on-board. Examples are Espressif's EPS32-DEVKIT or NodeMCU-ESP32S and a large number of clones.

For detailed information about the configuration of ESP32 boards, see section Common Peripherals.

Note
Most definitions can be overridden by an application-specific board configuration.
Author
Gunar Schorcht gunar.nosp@m.@sch.nosp@m.orcht.nosp@m..net

Definition in file periph_conf.h.

#include <stdint.h>
#include "periph_conf_common.h"
+ Include dependency graph for periph_conf.h:

Go to the source code of this file.

ADC and DAC channel configuration

#define ADC_GPIOS
 Declaration of GPIOs that can be used as ADC channels. More...
 
#define DAC_GPIOS   { GPIO25, GPIO26 }
 Declaration of GPIOs that can be used as DAC channels. More...
 

I2C configuration

For generic boards, only one I2C interface I2C_DEV(0) is defined.

The GPIOs listed in the configuration are only initialized as I2C signals when module periph_i2c is used. Otherwise they are not allocated and can be used for other purposes.

#define I2C0_SPEED   I2C_SPEED_FAST
 I2C bus speed of I2C_DEV(0) More...
 
#define I2C0_SCL   GPIO22
 SCL signal of I2C_DEV(0) [UEXT1]. More...
 
#define I2C0_SDA   GPIO21
 SDA signal of I2C_DEV(0) [UEXT1]. More...
 

PWM channel configuration

For generic boards, two PWM devices are configured.

These devices contain all GPIOs that are not defined as I2C, SPI or UART for this board. Generally, all outputs pins could be used as PWM channels.

Note
As long as the according PWM device is not initialized with the pwm_init, the GPIOs declared for this device can be used for other purposes.
#define PWM0_GPIOS   { GPIO0, GPIO2, GPIO4, GPIO16, GPIO17 }
 Declaration of the channels for device PWM_DEV(0), at maximum six channels. More...
 
#define PWM1_GPIOS   { GPIO27, GPIO32, GPIO33 }
 Declaration of the channels for device PWM_DEV(1), at maximum six channels. More...
 

SPI configuration

Note
The GPIOs listed in the configuration are first initialized as SPI signals when the corresponding SPI interface is used for the first time by either calling the spi_init_cs function or the spi_acquire function. That is, they are not allocated as SPI signals before and can be used for other purposes as long as the SPI interface is not used.
#define SPI0_CTRL   VSPI
 VSPI is used as SPI_DEV(0) More...
 
#define SPI0_SCK   GPIO18
 VSPI SCK. More...
 
#define SPI0_MISO   GPIO19
 VSPI MISO. More...
 
#define SPI0_MOSI   GPIO23
 VSPI MOSI. More...
 
#define SPI0_CS0   GPIO5
 VSPI CS0. More...
 
#define SPI1_CTRL   HSPI
 HSPI is used as SPI_DEV(1) More...
 
#define SPI1_SCK   GPIO14
 HSPI SCK. More...
 
#define SPI1_MISO   GPIO12
 HSPI MISO. More...
 
#define SPI1_MOSI   GPIO13
 HSPI MOSI. More...
 
#define SPI1_CS0   GPIO15
 HSPI CS0. More...
 

UART configuration

ESP32 provides 3 UART interfaces at maximum:

UART_DEV(0) uses fixed standard configuration.
UART_DEV(1) is defined here.
UART_DEV(2) is not used.

#define UART0_TXD   GPIO1
 direct I/O pin for UART_DEV(0) TxD, can't be changed More...
 
#define UART0_RXD   GPIO3
 direct I/O pin for UART_DEV(0) RxD, can't be changed More...
 
#define UART1_TXD   GPIO10
 direct I/O pin for UART_DEV(1) TxD More...
 
#define UART1_RXD   GPIO9
 direct I/O pin for UART_DEV(1) RxD More...
 

Macro Definition Documentation

◆ ADC_GPIOS

#define ADC_GPIOS
Value:
{ GPIO0 , GPIO2 , GPIO4 , GPIO12, GPIO13, GPIO14, \
GPIO15, GPIO25, GPIO26, GPIO27, GPIO32, GPIO33, \
GPIO34, GPIO35, GPIO36, GPIO39 }

Declaration of GPIOs that can be used as ADC channels.

For generic boards, all ADC pins that have broken out are declared as ADC channels.

Note
As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC channels with the adc_init function, they can be used for other purposes.

Definition at line 55 of file periph_conf.h.

◆ DAC_GPIOS

#define DAC_GPIOS   { GPIO25, GPIO26 }

Declaration of GPIOs that can be used as DAC channels.

For generic boards the 2 DAC lines GPIO25 and GPIO26 are declared as DAC channels.

Note
As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC channels with the dac_init function, they can be used for other purposes.

Definition at line 71 of file periph_conf.h.

◆ I2C0_SCL

#define I2C0_SCL   GPIO22

SCL signal of I2C_DEV(0) [UEXT1].

Definition at line 90 of file periph_conf.h.

◆ I2C0_SDA

#define I2C0_SDA   GPIO21

SDA signal of I2C_DEV(0) [UEXT1].

Definition at line 93 of file periph_conf.h.

◆ I2C0_SPEED

#define I2C0_SPEED   I2C_SPEED_FAST

I2C bus speed of I2C_DEV(0)

Definition at line 87 of file periph_conf.h.

◆ PWM0_GPIOS

#define PWM0_GPIOS   { GPIO0, GPIO2, GPIO4, GPIO16, GPIO17 }

Declaration of the channels for device PWM_DEV(0), at maximum six channels.

Definition at line 116 of file periph_conf.h.

◆ PWM1_GPIOS

#define PWM1_GPIOS   { GPIO27, GPIO32, GPIO33 }

Declaration of the channels for device PWM_DEV(1), at maximum six channels.

Definition at line 124 of file periph_conf.h.

◆ SPI0_CS0

#define SPI0_CS0   GPIO5

VSPI CS0.

Definition at line 151 of file periph_conf.h.

◆ SPI0_CTRL

#define SPI0_CTRL   VSPI

VSPI is used as SPI_DEV(0)

Definition at line 139 of file periph_conf.h.

◆ SPI0_MISO

#define SPI0_MISO   GPIO19

VSPI MISO.

Definition at line 145 of file periph_conf.h.

◆ SPI0_MOSI

#define SPI0_MOSI   GPIO23

VSPI MOSI.

Definition at line 148 of file periph_conf.h.

◆ SPI0_SCK

#define SPI0_SCK   GPIO18

VSPI SCK.

Definition at line 142 of file periph_conf.h.

◆ SPI1_CS0

#define SPI1_CS0   GPIO15

HSPI CS0.

Definition at line 167 of file periph_conf.h.

◆ SPI1_CTRL

#define SPI1_CTRL   HSPI

HSPI is used as SPI_DEV(1)

Definition at line 155 of file periph_conf.h.

◆ SPI1_MISO

#define SPI1_MISO   GPIO12

HSPI MISO.

Definition at line 161 of file periph_conf.h.

◆ SPI1_MOSI

#define SPI1_MOSI   GPIO13

HSPI MOSI.

Definition at line 164 of file periph_conf.h.

◆ SPI1_SCK

#define SPI1_SCK   GPIO14

HSPI SCK.

Definition at line 158 of file periph_conf.h.

◆ UART0_RXD

#define UART0_RXD   GPIO3

direct I/O pin for UART_DEV(0) RxD, can't be changed

Definition at line 183 of file periph_conf.h.

◆ UART0_TXD

#define UART0_TXD   GPIO1

direct I/O pin for UART_DEV(0) TxD, can't be changed

Definition at line 182 of file periph_conf.h.

◆ UART1_RXD

#define UART1_RXD   GPIO9

direct I/O pin for UART_DEV(1) RxD

Definition at line 190 of file periph_conf.h.

◆ UART1_TXD

#define UART1_TXD   GPIO10

direct I/O pin for UART_DEV(1) TxD

Definition at line 187 of file periph_conf.h.