diff --git a/.murdock b/.murdock index df31f056fa..d05c8a46e8 100755 --- a/.murdock +++ b/.murdock @@ -39,6 +39,7 @@ esp32c3-ci esp32c3-devkit esp32s3-ci esp32s3-devkit +esp32s2-devkit esp8266-ci esp8266-esp-12x hamilton diff --git a/boards/esp32s2-devkit/Kconfig b/boards/esp32s2-devkit/Kconfig new file mode 100644 index 0000000000..9b22afca5e --- /dev/null +++ b/boards/esp32s2-devkit/Kconfig @@ -0,0 +1,64 @@ +# Copyright (c) 2020 HAW Hamburg +# 2022 Gunar Schorcht +# +# This file is subject to the terms and conditions of the GNU Lesser +# General Public License v2.1. See the file LICENSE in the top level +# directory for more details. + +config BOARD + default "esp32s2-devkit" if BOARD_ESP32S2_DEVKIT + +config BOARD_ESP32S2_DEVKIT + bool + default y + select BOARD_COMMON_ESP32S2 + select CPU_MODEL_ESP32S2_MINI_1X_N4 if BOARD_VERSION_ESP32S2_DEVKITM_1 + select CPU_MODEL_ESP32S2_MINI_1X_N4 if BOARD_VERSION_ESP32S2_DEVKITM_1U + select CPU_MODEL_ESP32S2_MINI_1X_N4R2 if BOARD_VERSION_ESP32S2_DEVKITM_1R + select CPU_MODEL_ESP32S2_MINI_1X_N4R2 if BOARD_VERSION_ESP32S2_DEVKITM_1RU + select CPU_MODEL_ESP32S2_SOLO_N4 if BOARD_VERSION_ESP32S2_DEVKITC_1 + select CPU_MODEL_ESP32S2_SOLO_N4 if BOARD_VERSION_ESP32S2_DEVKITC_1U + select CPU_MODEL_ESP32S2_SOLO_N4R2 if BOARD_VERSION_ESP32S2_DEVKITC_1R + select CPU_MODEL_ESP32S2_SOLO_N4R2 if BOARD_VERSION_ESP32S2_DEVKITC_1RU + select CPU_MODEL_ESP32S2_WROOM if BOARD_VERSION_ESP32S2_SAOLA_1M + select CPU_MODEL_ESP32S2_WROOM if BOARD_VERSION_ESP32S2_SAOLA_1MI + select CPU_MODEL_ESP32S2_WROVER_N4R2 if BOARD_VERSION_ESP32S2_SAOLA_1R + select CPU_MODEL_ESP32S2_WROVER_N4R2 if BOARD_VERSION_ESP32S2_SAOLA_1RI + select HAS_ARDUINO + select HAS_PERIPH_ADC + select HAS_PERIPH_DAC + select HAS_PERIPH_I2C + select HAS_PERIPH_PWM + select HAS_PERIPH_SPI + + choice + bool "ESP32-S2-DevKit board version" + default BOARD_VERSION_ESP32S2_DEVKITM_1 + + config BOARD_VERSION_ESP32S2_DEVKITM_1 + bool "ESP32-S2-DevKitM-1" + config BOARD_VERSION_ESP32S2_DEVKITM_1U + bool "ESP32-S2-DevKitM-1U" + config BOARD_VERSION_ESP32S2_DEVKITM_1R + bool "ESP32-S2-DevKitM-1R" + config BOARD_VERSION_ESP32S2_DEVKITM_1RU + bool "ESP32-S2-DevKitM-1RU" + config BOARD_VERSION_ESP32S2_DEVKITC_1 + bool "ESP32-S2-DevKitC-1" + config BOARD_VERSION_ESP32S2_DEVKITC_1U + bool "ESP32-S2-DevKitC-1U" + config BOARD_VERSION_ESP32S2_DEVKITC_1R + bool "ESP32-S2-DevKitC-1R" + config BOARD_VERSION_ESP32S2_DEVKITC_1RU + bool "ESP32-S2-DevKitC-1RU" + config BOARD_VERSION_ESP32S2_SAOLA_1M + bool "ESP32-S2-SAOLA-1M" + config BOARD_VERSION_ESP32S2_SAOLA_1MI + bool "ESP32-S2-SAOLA-1MI" + config BOARD_VERSION_ESP32S2_SAOLA_1R + bool "ESP32-S2-SAOLA-1R" + config BOARD_VERSION_ESP32S2_SAOLA_1RI + bool "ESP32-S2-SAOLA-1RI" + endchoice + +source "$(RIOTBOARD)/common/esp32s2/Kconfig" diff --git a/boards/esp32s2-devkit/Makefile b/boards/esp32s2-devkit/Makefile new file mode 100644 index 0000000000..c71e835d77 --- /dev/null +++ b/boards/esp32s2-devkit/Makefile @@ -0,0 +1,5 @@ +MODULE = board + +DIRS = $(RIOTBOARD)/common/esp32s2 + +include $(RIOTBASE)/Makefile.base diff --git a/boards/esp32s2-devkit/Makefile.dep b/boards/esp32s2-devkit/Makefile.dep new file mode 100644 index 0000000000..69cb028fd6 --- /dev/null +++ b/boards/esp32s2-devkit/Makefile.dep @@ -0,0 +1 @@ +include $(RIOTBOARD)/common/esp32s2/Makefile.dep diff --git a/boards/esp32s2-devkit/Makefile.features b/boards/esp32s2-devkit/Makefile.features new file mode 100644 index 0000000000..b25714be7e --- /dev/null +++ b/boards/esp32s2-devkit/Makefile.features @@ -0,0 +1,44 @@ +# default board version if not defined +ifeq (,$(BOARD_VERSION)) + BOARD_VERSION += esp32s2-devkitm-1 +endif + +ifeq (esp32s2-devkitm-1,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_mini_1x_n4 +else ifeq (esp32s2-devkitm-1u,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_mini_1x_n4 +else ifeq (esp32s2-devkitm-1r,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_mini-1x_n4r2 +else ifeq (esp32s2-devkitm-1ru,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_mini-1x_n4r2 +else ifeq (esp32s2-devkitc_1,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_solo_n4 +else ifeq (esp32s2-devkitc_1u,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_solo_n4 +else ifeq (esp32s2-devkitc-1r,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_solo_n4r2 +else ifeq (esp32s2-devkitc-1ru,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_solo_n4r2 +else ifeq (esp32s2-saola-1m,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_wroom +else ifeq (esp32s2-saola-1mi,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_wroom +else ifeq (esp32s2-saola-1r,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_wrover_n4r2 +else ifeq (esp32s2-saola-1ri,$(BOARD_VERSION)) + CPU_MODEL = esp32s2_wrover_n4r2 +else + $(error BOARD_VERSION is unknown) +endif + +# common board and CPU features +include $(RIOTBOARD)/common/esp32s2/Makefile.features + +# additional features provided by the board +FEATURES_PROVIDED += periph_adc +FEATURES_PROVIDED += periph_dac +FEATURES_PROVIDED += periph_i2c +FEATURES_PROVIDED += periph_pwm +FEATURES_PROVIDED += periph_spi + +FEATURES_PROVIDED += arduino diff --git a/boards/esp32s2-devkit/Makefile.include b/boards/esp32s2-devkit/Makefile.include new file mode 100644 index 0000000000..43032c89f2 --- /dev/null +++ b/boards/esp32s2-devkit/Makefile.include @@ -0,0 +1,8 @@ +PSEUDOMODULES += esp32s2_devkitm_1 +PSEUDOMODULES += esp32s2_devkitm_1r +PSEUDOMODULES += esp32s2_devkitc_1 +PSEUDOMODULES += esp32s2_devkitc_1r +PSEUDOMODULES += esp32s2_saola_1 +PSEUDOMODULES += esp32s2_saola_1r + +include $(RIOTBOARD)/common/esp32s2/Makefile.include diff --git a/boards/esp32s2-devkit/doc.txt b/boards/esp32s2-devkit/doc.txt new file mode 100644 index 0000000000..5567bdafac --- /dev/null +++ b/boards/esp32s2-devkit/doc.txt @@ -0,0 +1,201 @@ +/* + * Copyright (C) 2022 Gunar Schorcht + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @defgroup boards_esp32s2_devkit ESP32-S2-DevKit Board + * @ingroup boards_esp32s2 + * @brief Support for generic ESP32S2 boards + * @author Gunar Schorcht + +\section esp32s2_devkit ESP32-S2-DevKit + +## Table of Contents {#esp32s2_devkit_toc} + +1. [Overview](#esp32s2_devkit_overview) +2. [Hardware](#esp32s2_devkit_hardware) + 1. [MCU](#esp32s2_devkit_mcu) + 2. [Board Configuration](#esp32s2_devkit_board_configuration) + 3. [Board Pinout](#esp32s2_devkit_pinout) +3. [Flashing the Device](#esp32s2_devkit_flashing) + +## Overview {#esp32s2_devkit_overview} + +The Espressif ESP32-S2-DevKit boards are a couple of boards that use one of +the following modules: + +- ESP32-S2-MINI-1x-N4 module (ESP32-S2-DevKitM-1 board) +- ESP32-S2-MINI-1x-N4R2 module (ESP32-S2-DevKitM-1R board) +- ESP32-S2-SOLO-N4 module (ESP32-S2-DevKitC-1 board) +- ESP32-S2-SOLO-N4R2 module (ESP32-S2-DevKitC-1R board) +- ESP32-S2-WROOM module (ESP32-S2-Saola-1 board) +- ESP32-S2-WROVER-N4R2 module (ESP32-S2-Saola-1R board) + +\image html "https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/_images/esp32-s2-devkitm-1-v1-annotated-photo.png" "Espressif ESP32-S2-DevKitM-1" width=600px + +
+Due to the different modules used, the available versions of the +ESP32-S2-DevKit board differ regarding the Flash size, the integrated SPI RAM +and the SPI voltage. To be able to use all these different versions of the +board with a single board definition, used board version can be specified +by the variable `BOARD_VERSION` during compilation, for example: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +BOARD=esp32s2-devkit BOARD_VERSION=esp32s2-devkitc-1r make ... +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following table shows the available board versions, the size of the +Flash and the SPI RAM as well as the value of the variable `BOARD_VERSION` +that is used to specify the board version. + +
+| Board Version | Flash (Mode) | SPI RAM (Mode) | `BOARD_VERSION` +|:----------------------|:-------------|:---------------|:----------------- +| ESP32-S2-DevKitM-1 | 4 MB (Quad) | - | `esp32s2-devkitm-1` (default) +| ESP32-S2-DevKitM-1U | 4 MB (Quad) | - | `esp32s2-devkitm-1u` +| ESP32-S2-DevKitM-1R | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitm-1r` +| ESP32-S2-DevKitM-1RU | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitm-1ru` +| ESP32-S2-DevKitC-1 | 4 MB (Quad) | - | `esp32s2-devkitc-1` +| ESP32-S2-DevKitC-1U | 4 MB (Quad) | - | `esp32s2-devkitc-1u` +| ESP32-S2-DevKitC-1R | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitc-1r` +| ESP32-S2-DevKitC-1RU | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-devkitc-1ru` +| ESP32-S2-Saola-1M | 4 MB (Quad) | - | `esp32s2-saola-1m` +| ESP32-S2-Saola-1MI | 4 MB (Quad) | - | `esp32s2-saola-1mi` +| ESP32-S2-Saola-1R | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-saola-1r` +| ESP32-S2-Saola-1RI | 4 MB (Quad) | 2 MB (Quad) | `esp32s2-saola-1ri` +
+
+ +@note +- If the board version is not specified, ESP32-S2-DevKitM-1 with 4 MByte + Flash is assumed and `BOARD_VERSION` is set to `esp32s2-devkitm-1` + by default. +- Using a board version with embedded SPI RAM (`BOARD_VERSION` is any of + `esp32s2-*-1r*` values) enables the + \ref esp32_spi_ram "esp_spi_ram" feature. The SPI RAM can then be used as + heap by enabling the \ref esp32_spi_ram "esp_spi_ram" pseudomodule. + +[Back to table of contents](#esp32s2_devkit_toc) + +## Hardware {#esp32s2_devkit_hardware} + +This section describes + +- the [MCU](#esp32s2_devkit_mcu), +- the default [board configuration](#esp32s2_devkit_board_configuration), +- [optional hardware configurations](#esp32s2_devkit_optional_hardware), +- the [board pinout](#esp32s2_devkit_pinout). + +[Back to table of contents](#esp32s2_devkit_toc) + +### MCU {#esp32s2_devkit_mcu} + +Most features of the board are provided by the ESP32-S2 SoC. For detailed +information about the ESP32-S2 SoC variant (family) and ESP32x SoCs, +see section \ref esp32_mcu_esp32 "ESP32 SoC Series". + +[Back to table of contents](#esp32s2_devkit_toc) + +### Board Configuration {#esp32s2_devkit_board_configuration} + +ESP32-S2-DevKit boards have no special hardware on board with the exception +of a single pin RGB-LED that uses a special bit-oriented protocol to +control the RGB-LED by 24-bit RGB values which is not supported yet. + +All GPIOs are simply broken out for flexibility. Therefore, the board +configuration is the most flexible one which provides: + +- 20 x ADC channels at maximum +- 2 x SPI +- 1 x I2C +- 2 x UART +- 1 RGB-LED + +Since almost GPIOs have broken out, GPIOs can be used for different purposes +in different applications. Following GPIOs are used for Flash and SPI RAM and +are not broken out: + +- ESP32-S2-DevKitC-1x: GPIO27..GPIO32 +- ESP32-S2-DevKitM-1x: GPIO26..GPIO32 +- ESP32-S2-Saola-1x: GPIO26..GPIO32 + +For flexibility, GPIOs can be used in multiple peripheral configurations, +but they can only be used for one peripheral at a time. For example, GPIO9 +is used in the ADC channel definition and the definition of the SCL signal +for I2C_DEV(0). + +This is possible because GPIOs are only used for a specific peripheral +interface when either + +- the corresponding peripheral module is used, e.g. `periph_i2c`, or +- the corresponding init function is called, e.g. `adc_init`. + +That is, the purpose for which a GPIO is used depends on which module +or function is used first. + +For example, if module `periph_i2c` is not used, the GPIOs listed in I2C +configuration can be used for the other purposes, that is, GPIO9 can be +used as ADC channel. + +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". + +
+Function | GPIOs | Remarks | Configuration +:---------------|:-------|:--------|:---------------------------------- +BUTTON0 | GPIO0 | | | +ADC_LINE(n) | GPIO1 ... GPIO10 | | \ref esp32_adc_channels "ADC Channels" +DAC_LINE(n) | GPIO17, GPIO18 | | \ref esp32_dac_channels "DAC Channels" +I2C_DEV(0) SCL | GPIO9 | | \ref esp32_i2c_interfaces "I2C Interfaces" +I2C_DEV(0) SDA | GPIO8 | | \ref esp32_i2c_interfaces "I2C Interfaces" +PWM_DEV(0) | GPIO11, GPIO12, GPIO13, GPIO14 | - | \ref esp32_pwm_channels "PWM Channels" +PWM_DEV(1) | GPIO15, GPIO16 | if module `esp_rtc_timer_32k` is not used | \ref esp32_pwm_channels "PWM Channels" +SPI_DEV(0) CLK | GPIO12 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" +SPI_DEV(0) MISO | GPIO13 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" +SPI_DEV(0) MOSI | GPIO11 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" +SPI_DEV(0) CS0 | GPIO10 | SPI2_HOST (FSPI) is used | \ref esp32_spi_interfaces "SPI Interfaces" +UART_DEV(0) TxD | GPIO43 | Console (configuration is fixed) | \ref esp32_uart_interfaces "UART interfaces" +UART_DEV(0) RxD | GPIO44 | Console (configuration is fixed) | \ref esp32_uart_interfaces "UART interfaces" +
+\n + +For detailed information about the peripheral configurations of ESP32-S2 +boards, see section \ref esp32_peripherals "Common Peripherals". + +[Back to table of contents](#esp32s2_devkit_toc) + +### Board Pinout {#esp32s2_devkit_pinout} + +The following figures show the pinouts as configured by default board +definition. + +@image html https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/_images/esp32-s2-devkitm-1-v1-pin-layout.png "ESP32-S2-DevKitM-1x Pinout" width=900px +@image html https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/_images/esp32-s2-devkitc-1-v1-pinout.png "ESP32-S2-DevKitC-1x Pinout" width=900px +@image html https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/_images/esp32-s2_saola1-pinout.jpg "ESP32-S2-Saola-1x Pinout" width=900px + +The corresponding board schematics can be found: + +- [ESP32-S2-DevKitM-1x](https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Schematics.pdf) +- [ESP32-S2-DevKitC-1x](https://dl.espressif.com/dl/schematics/SCH_ESP32-S2-DEVKITC-1_V1_20210508.pdf) +- [ESP32-S2-Saola-1x](https://dl.espressif.com/dl/schematics/ESP32-S2-SAOLA-1_V1.1_schematics.pdf) + +[Back to table of contents](#esp32s2_devkit_toc) + +## Flashing the Device {#esp32s2_devkit_flashing} + +Flashing RIOT is quite easy. The board has a Micro-USB connector with +reset/boot/flash logic. Just connect the board to your host computer +and type using the programming port: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +BOARD=esp32s2-devkit make flash ... +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +For detailed information about ESP32-S2 as well as configuring and compiling +RIOT for ESP32-S2 boards, see \ref esp32_riot. + +[Back to table of contents](#esp32s2_devkit_toc) + */ diff --git a/boards/esp32s2-devkit/include/arduino_board.h b/boards/esp32s2-devkit/include/arduino_board.h new file mode 100644 index 0000000000..13bd88688a --- /dev/null +++ b/boards/esp32s2-devkit/include/arduino_board.h @@ -0,0 +1,38 @@ +/* + * Copyright (C) 2022 Gunar Schorcht + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_esp32s2_devkit + * @{ + * + * @file + * @brief Board specific configuration for the Arduino API + * + * @author Gunar Schorcht + */ + +#ifndef ARDUINO_BOARD_H +#define ARDUINO_BOARD_H + +#include "arduino_board_common.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief The on-board LED is not available + */ +#define ARDUINO_LED (0) + +#ifdef __cplusplus +} +#endif + +#endif /* ARDUINO_BOARD_H */ +/** @} */ diff --git a/boards/esp32s2-devkit/include/arduino_pinmap.h b/boards/esp32s2-devkit/include/arduino_pinmap.h new file mode 100644 index 0000000000..f39513e016 --- /dev/null +++ b/boards/esp32s2-devkit/include/arduino_pinmap.h @@ -0,0 +1,63 @@ +/* + * Copyright (C) 2022 Gunar Schorcht + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_esp32s2_devkit + * @{ + * + * @file + * @brief Mapping from MCU pins to Arduino pins + * + * @author Gunar Schorcht + */ + +#ifndef ARDUINO_PINMAP_H +#define ARDUINO_PINMAP_H + +#include "periph/gpio.h" +#include "periph/adc.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @name Mapping of MCU pins to Arduino pins + * @{ + */ +#define ARDUINO_PIN_0 GPIO44 /**< Arduino Uno pin 0 (RxD) */ +#define ARDUINO_PIN_1 GPIO43 /**< Arduino Uno pin 1 (TxD) */ +#define ARDUINO_PIN_2 GPIO0 /**< Arduino Uno pin 2 */ +#define ARDUINO_PIN_3 GPIO10 /**< Arduino Uno pin 3 (PWM) */ +#define ARDUINO_PIN_4 GPIO3 /**< Arduino Uno pin 4 */ +#define ARDUINO_PIN_5 GPIO11 /**< Arduino Uno pin 5 (PWM) */ +#define ARDUINO_PIN_6 GPIO12 /**< Arduino Uno pin 6 (PWM) */ +#define ARDUINO_PIN_7 GPIO6 /**< Arduino Uno pin 7 */ +#define ARDUINO_PIN_8 GPIO7 /**< Arduino Uno pin 8 */ +#define ARDUINO_PIN_9 GPIO13 /**< Arduino Uno pin 9 (PWM) */ + +#define ARDUINO_PIN_10 GPIO38 /**< Arduino Uno pin 10 (CS0 / PWM) */ +#define ARDUINO_PIN_11 GPIO35 /**< Arduino Uno pin 11 (MOSI / PWM) */ +#define ARDUINO_PIN_12 GPIO37 /**< Arduino Uno pin 12 (MISO) */ +#define ARDUINO_PIN_13 GPIO36 /**< Arduino Uno pin 13 (SCK) */ + +#define ARDUINO_PIN_A0 GPIO1 /**< Arduino Uno pin A0 */ +#define ARDUINO_PIN_A1 GPIO2 /**< Arduino Uno pin A1 */ +#define ARDUINO_PIN_A2 GPIO4 /**< Arduino Uno pin A2 */ +#define ARDUINO_PIN_A3 GPIO5 /**< Arduino Uno pin A3 */ + +#define ARDUINO_PIN_A4 GPIO8 /**< Arduino Uno pin A4 (SDA) */ +#define ARDUINO_PIN_A5 GPIO9 /**< Arduino Uno pin A5 (SCL) */ +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* ARDUINO_PINMAP_H */ +/** @} */ diff --git a/boards/esp32s2-devkit/include/board.h b/boards/esp32s2-devkit/include/board.h new file mode 100644 index 0000000000..2ee8dd54bc --- /dev/null +++ b/boards/esp32s2-devkit/include/board.h @@ -0,0 +1,97 @@ +/* + * Copyright (C) 2022 Gunar Schorcht + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_esp32s2_devkit + * @brief Board definitions for ESP32-S2-DevKit boards + * @{ + * + * The board definitions in this file are valid for Espressif + * ESP32-S2-DevKitx boards that use one of the following modules: + * + * - ESP32-S2-MINI-1x module (ESP32-S2-DevKitM-1 board) + * - ESP32-S2-WROOM-1x module (ESP32-S2-DevKitC-1 board) + * - ESP32-S2-WROOM-2x module (ESP32-S2-DevKitC-1 board) + * + * where x stands for the module version with and without U + * (external antenna connector). + * + * Any modifications required for specific applications + * can be overridden by \ref esp32_application_specific_configurations + * "application-specific board configuration". + * + * @file + * @author Gunar Schorcht + */ + +#ifndef BOARD_H +#define BOARD_H + +#include + +/** + * @name Button pin definitions + * @{ + */ + +/** + * @brief Default button GPIO pin definition + * + * ESP32-S2-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, + * the button signal is inverted, i.e., pressing the button will give a + * low signal. + */ +#define BTN0_PIN GPIO0 + +/** + * @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 + +/** + * @brief Default interrupt flank definition for the button GPIO + */ +#ifndef BTN0_INT_FLANK +#define BTN0_INT_FLANK GPIO_FALLING +#endif + +/** + * @brief Definition for compatibility with previous versions + */ +#define BUTTON0_PIN BTN0_PIN + +/** @} */ + +/** + * @name LED (on-board) configuration + * + * ESP32-S2-DevKit boards have a SK68XXMINI-HS smart RGB-LED connected to + * GPIO18 on-board. This RGB-LEDs uses a special bit-oriented protocol to + * control the RGB-LED by 24-bit RGB values. Therefore, it can't be used as + * default LED definition for RIOT. + * @{ + */ +/** @} */ + +/* include common board definitions as last step */ +#include "board_common.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef __cplusplus +} /* end extern "C" */ +#endif + +#endif /* BOARD_H */ +/** @} */ diff --git a/boards/esp32s2-devkit/include/gpio_params.h b/boards/esp32s2-devkit/include/gpio_params.h new file mode 100644 index 0000000000..7270f71953 --- /dev/null +++ b/boards/esp32s2-devkit/include/gpio_params.h @@ -0,0 +1,45 @@ +/* + * Copyright (C) 2018 Gunar Schorcht + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +#ifndef GPIO_PARAMS_H +#define GPIO_PARAMS_H + +/** + * @ingroup boards_esp32s2_devkit + * @brief Board specific configuration of direct mapped GPIOs + * @file + * @author Gunar Schorcht + * @{ + */ + +#include "board.h" +#include "saul/periph.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief LED and Button configuration + */ +static const saul_gpio_params_t saul_gpio_params[] = +{ + { + .name = "BOOT", + .pin = BTN0_PIN, + .mode = BTN0_MODE, + .flags = SAUL_GPIO_INVERTED + }, +}; + +#ifdef __cplusplus +} +#endif + +#endif /* GPIO_PARAMS_H */ +/** @} */ diff --git a/boards/esp32s2-devkit/include/periph_conf.h b/boards/esp32s2-devkit/include/periph_conf.h new file mode 100644 index 0000000000..bbd5d62df7 --- /dev/null +++ b/boards/esp32s2-devkit/include/periph_conf.h @@ -0,0 +1,188 @@ +/* + * Copyright (C) 2022 Gunar Schorcht + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_esp32s2_devkit + * @brief Peripheral configurations for ESP32-S2-DevKit boards + * @{ + * + * The peripheral configurations in this file can be used for Espressif + * ESP32-S2-DevKitx boards that use one of the following modules: + * + * - ESP32-S2-MINI-1x module (ESP32-S2-DevKitM-1x board) + * - ESP32-S2-SOLO module (ESP32-S2-DevKitC-1x board) + * - ESP32-S2-WROOM module (ESP32-S2-Saola-1 board) + * - ESP32-S2-WROVER module (ESP32-S2-Saola-1R board) + * + * Any modifications required for specific applications + * can be overridden by \ref esp32_application_specific_configurations + * "application-specific board configuration". + * + * For detailed information about the peripheral configuration for ESP32-S2 + * boards, see section \ref esp32_peripherals "Common Peripherals". + * + * @note + * Most definitions can be overridden by an \ref esp32_application_specific_configurations + * "application-specific board configuration" if necessary. + * + * @file + * @author Gunar Schorcht + */ + +#ifndef PERIPH_CONF_H +#define PERIPH_CONF_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @name ADC and DAC channel configuration + * @{ + */ +/** + * @brief Declaration of GPIOs that can be used as ADC channels + * + * For generic boards, almost all ADC pins of ADC1 that are 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. + */ +#ifndef ADC_GPIOS +#define ADC_GPIOS { GPIO1, GPIO2, GPIO3, GPIO4, GPIO5, GPIO6, GPIO7, GPIO8, GPIO9, GPIO10 } +#endif + +/** + * @brief Declaration of GPIOs that can be used as DAC channels + * + * For generic boards the 2 DAC lines GPIO17 and GPIO18 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. + */ +#ifndef DAC_GPIOS +#define DAC_GPIOS { GPIO17, GPIO18 } +#endif +/** @} */ + +/** + * @name 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. + * + * @{ + */ +#ifndef I2C0_SPEED +#define I2C0_SPEED I2C_SPEED_FAST /**< I2C bus speed of I2C_DEV(0) */ +#endif +#ifndef I2C0_SCL +#define I2C0_SCL GPIO9 /**< SCL signal of I2C_DEV(0) */ +#endif +#ifndef I2C0_SDA +#define I2C0_SDA GPIO8 /**< SDA signal of I2C_DEV(0) */ +#endif +/** @} */ + +/** + * @name 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. + * + * @{ + */ + +/** + * @brief Declaration of the channels for device PWM_DEV(0), + * at maximum PWM_CHANNEL_NUM_DEV_MAX. + */ +#ifndef PWM0_GPIOS +#define PWM0_GPIOS { GPIO11, GPIO12, GPIO13, GPIO14 } +#endif + +/** + * @brief Declaration of the channels for device PWM_DEV(1), + * at maximum PWM_CHANNEL_NUM_DEV_MAX. + * + * These PWM channels cannot be used if an external 32 kHz crystal is + * connected to the board at GPIO15 and GPIO16. + */ +#ifndef MODULE_ESP_RTC_TIMER_32K +#ifndef PWM1_GPIOS +#define PWM1_GPIOS { GPIO15, GPIO16 } +#endif +#endif + +/** @} */ + +/** + * @name 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. + * @{ + */ +#ifndef SPI0_CTRL +#define SPI0_CTRL FSPI /**< FSPI is used as SPI_DEV(0) */ +#endif +#ifndef SPI0_SCK +#define SPI0_SCK GPIO36 /**< FSPI SCK (pin FSPICLK) */ +#endif +#ifndef SPI0_MISO +#define SPI0_MISO GPIO37 /**< FSPI MISO (pin FSPIQ) */ +#endif +#ifndef SPI0_MOSI +#define SPI0_MOSI GPIO35 /**< FSPI MOSI (pin FSPID) */ +#endif +#ifndef SPI0_CS0 +#define SPI0_CS0 GPIO34 /**< FSPI CS0 (pin FSPICS0) */ +#endif +/** @} */ + +/** + * @name UART configuration + * + * ESP32-S2 provides 2 UART interfaces at maximum: + * + * UART_DEV(0) uses fixed standard configuration.
+ * UART_DEV(1) is not used.
+ * + * @{ + */ +#define UART0_TXD GPIO43 /**< direct I/O pin for UART_DEV(0) TxD, can't be changed */ +#define UART0_RXD GPIO44 /**< direct I/O pin for UART_DEV(0) RxD, can't be changed */ + +/** @} */ + +#ifdef __cplusplus +} /* end extern "C" */ +#endif + +/* include common peripheral definitions as last step */ +#include "periph_conf_common.h" + +#endif /* PERIPH_CONF_H */ +/** @} */