fixup! fixup! boards/seeedstudio-xiao-esp32s3: initial support

crasbe · crasbe · commit 4fabe4b029f4 · 2025-10-30T00:18:58.000+01:00
diff --git a/boards/seeedstudio-xiao-esp32s3/Kconfig b/boards/seeedstudio-xiao-esp32s3/Kconfig
@@ -1,14 +1,11 @@
-# Copyright (c) 2024 TUDresden
-#               2024 Isikcan 'Jon' Yilmaz - TUDresden
-#
-# 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.
+# SPDX-FileCopyrightText: 2024 Technische Universität Dresden
+# SPDX-FileCopyrightText: 2024 Isikcan 'Jon' Yilmaz
+# SPDX-License-Identifier: LGPL-2.1-only
 
 config BOARD
-    default "esp32s3-seeedstudio" if BOARD_ESP32S3_SEEEDSTUDIO
+    default "seeedstudio-xiao-esp32s3" if BOARD_SEEEDSTUDIO-XIAO-ESP32S3
 
-config BOARD_ESP32S3_SEEEDSTUDIO
+config BOARD_SEEEDSTUDIO-XIAO-ESP32S3
     bool
     default y
     select BOARD_COMMON_ESP32S3
diff --git a/boards/seeedstudio-xiao-esp32s3/Makefile.features b/boards/seeedstudio-xiao-esp32s3/Makefile.features
@@ -1,4 +1,4 @@
-# the board uses a ESP32-S3 with a 16MB QSPI Flash and a 8MB QSPI PSRAM
+# the board uses a ESP32-S3 with an 8MB QSPI Flash and an 8MB QSPI PSRAM
 CPU_MODEL = esp32s3
 FEATURES_PROVIDED += esp_spi_ram
 
@@ -16,3 +16,4 @@ FEATURES_PROVIDED += periph_usbdev
 FEATURES_PROVIDED += esp_jtag
 FEATURES_PROVIDED += highlevel_stdio
 FEATURES_PROVIDED += tinyusb_device
+FEATURES_PROVIDED += xiao_shield
diff --git a/boards/seeedstudio-xiao-esp32s3/Makefile.include b/boards/seeedstudio-xiao-esp32s3/Makefile.include
@@ -1,5 +1,5 @@
-# The board uses a ESP32-S3 with a 16MB QSPI Flash and a 8MB QSPI PSRAM
-FLASH_SIZE ?= 16
+# The board uses an ESP32-S3 with a 8MB QSPI Flash and an 8MB QSPI PSRAM
+FLASH_SIZE ?= 8
 
 PORT_LINUX ?= /dev/ttyACM0
 
diff --git a/boards/seeedstudio-xiao-esp32s3/doc.md b/boards/seeedstudio-xiao-esp32s3/doc.md
@@ -1,32 +1,28 @@
-/*
- * Copyright (C) 2024 Isikcan 'Jon' Yilmaz
- *
- * 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_esp32s3_seeedstudio ESP32 Seeed Studio XIAO Board
- * @ingroup     boards_esp32s3
- * @brief       Support for the Seeed Studio Xiao ESP32S3
- * @author      Isikcan 'Jon' Yilmaz <can158@gmail.com>
-
-\section esp32s3_seeedstudio Seeed Studio Xiao ESP32
+<!--
+SPDX-FileCopyrightText: 2024 Isikcan 'Jon' Yilmaz
+SPDX-License-Identifier: LGPL-2.1-only
+-->
+
+@defgroup    boards_seeedstudio-xiao-esp32s3 Seeed Studio XIAO ESP32S3 Board
+@ingroup     boards_esp32s3
+@brief       Support for the Seeed Studio Xiao ESP32S3
+@author      Isikcan 'Jon' Yilmaz <can158@gmail.com>
+
+\section esp32s3_seeedstudio Seeed Studio Xiao ESP32S3
 
 ## Table of Contents {#esp32s3_seeedstudio_toc}
 
-1. [Overview](#esp32s3_seeedstudio_overview)
-2. [Hardware](#esp32s3_seeedstudio_hardware)
-    1. [MCU](#esp32s3_seeedstudio_mcu)
-    2. [Board Configuration](#esp32s3_seeedstudio_board_configuration)
-    3. [Board Pinout](#esp32s3_seeedstudio_pinout)
-3. [Flashing the Device](#esp32s3_seeedstudio_flashing)
-4. [Using STDIO](#esp32s3_seeedstudio_stdio)
+-# [Overview](#esp32s3_seeedstudio_overview)
+-# [Hardware](#esp32s3_seeedstudio_hardware)
+    -# [MCU](#esp32s3_seeedstudio_mcu)
+    -# [Board Configuration](#esp32s3_seeedstudio_board_configuration)
+    -# [Board Pinout](#esp32s3_seeedstudio_pinout)
+-# [Flashing the Device](#esp32s3_seeedstudio_flashing)
+-# [Using STDIO](#esp32s3_seeedstudio_stdio)
 
 ## Overview {#esp32s3_seeedstudio_overview}
 
-The Seeed Studio ESP32S3 is one of the ESP32-S3 boards from Seeed Studio.
+The Seeed Studio Xiao ESP32S3 is one of the ESP32-S3 boards from Seeed Studio.
 \image html https://files.seeedstudio.com/wiki/SeeedStudio-XIAO-ESP32S3/img/xiaoesp32s3.jpg "Seeed Studio ESP32S3" width=800px
 
 Vendor's info page for the board [here](https://wiki.seeedstudio.com/xiao_esp32s3_getting_started/)
@@ -61,7 +57,8 @@ see section \ref esp32_mcu_esp32 "ESP32 SoC Series".
 
 ### Board Configuration {#esp32s3_seeedstudio_board_configuration}
 
-Seeed Studio Xiao ESP32S3 boards have no special hardware on board, besides a yellow LED connected to GPIO21.
+Seeed Studio Xiao ESP32S3 boards have no special hardware on board,
+besides a yellow LED connected to GPIO21.
 
 The default board configuration provides:
 
@@ -78,7 +75,8 @@ boards, see section \ref esp32_peripherals "Common Peripherals".
 
 ### Board Pinout {#esp32s3_seeedstudio_pinout}
 
-The following figure shows the pinout as configured by board definition (excluding the camera module).
+The following figure shows the pinout as configured by board definition
+(excluding the camera module).
 
 @image html https://files.seeedstudio.com/wiki/SeeedStudio-XIAO-ESP32S3/img/2.jpg "Seeed Studio Xiao ESP32S3 Pinout" width=900px
 
@@ -93,7 +91,7 @@ Since the board does not have a USB-to-Serial chip, the easiest way to flash
 the board is using the USB Serial/JTAG interface. Just connect the board to
 your host computer and use the following command:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-BOARD=esp32s3-seeedstudio make flash ...
+BOARD=seeedstudio-xiao-esp32s3 make flash ...
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 @note Usually the make system resets the board before flashing to enable the
@@ -130,7 +128,5 @@ via the USB CDC ACM interface.
 Alternatively, the UART interface could be used with an external USB-to-Serial
 adapter. Simply add `stdio_uart` to the list of used modules for this purpose:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-BOARD=esp32s3-seeedstudio USEMODULE=stdio_uart make flash ...
+BOARD=seeedstudio-xiao-esp32s3 USEMODULE=stdio_uart make flash ...
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- */
diff --git a/boards/seeedstudio-xiao-esp32s3/include/board.h b/boards/seeedstudio-xiao-esp32s3/include/board.h
@@ -1,13 +1,12 @@
 /*
- * Copyright (C) 2024 Isikcan 'Jon' Yilmaz
- *
- * 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.
+ * SPDX-FileCopyrightText: 2024 Isikcan 'Jon' Yilmaz
+ * SPDX-License-Identifier: LGPL-2.1-only
  */
 
+#pragma once
+
 /**
- * @ingroup     boards_esp32s3_seeedstudio
+ * @ingroup     boards_seeedstudio-xiao-esp32s3
  * @brief       Board definitions for Seeed Studio Xiao ESP32S3 board
  * @{
  *
@@ -21,9 +20,6 @@
  * @author      Isikcan 'Jon' Yilmaz <can158@gmail.com>
  */
 
-#ifndef BOARD_H
-#define BOARD_H
-
 #include <stdint.h>
 
 /**
@@ -47,13 +43,13 @@
  * 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
+#define BTN0_MODE       GPIO_IN
 
 /**
  * @brief   Default interrupt flank definition for the button GPIO
  */
 #ifndef BTN0_INT_FLANK
-#define BTN0_INT_FLANK  GPIO_FALLING
+#  define BTN0_INT_FLANK    GPIO_FALLING
 #endif
 
 /**
@@ -71,8 +67,8 @@
  */
 /** @} */
 #ifndef LED0_PIN
-#define LED0_PIN        GPIO21
-#define LED0_ACTIVE     (0)
+#  define LED0_PIN      GPIO21
+#  define LED0_ACTIVE   (0)
 #endif
 
 /* include common board definitions as last step */
@@ -85,6 +81,4 @@ extern "C" {
 #ifdef __cplusplus
 } /* end extern "C" */
 #endif
-
-#endif /* BOARD_H */
 /** @} */
diff --git a/boards/seeedstudio-xiao-esp32s3/include/gpio_params.h b/boards/seeedstudio-xiao-esp32s3/include/gpio_params.h
@@ -1,16 +1,12 @@
 /*
- * Copyright (C) 2024 Isikcan 'Jon' Yilmaz
- *
- * 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.
+ * SPDX-FileCopyrightText: 2024 Isikcan 'Jon' Yilmaz
+ * SPDX-License-Identifier: LGPL-2.1-only
  */
 
-#ifndef GPIO_PARAMS_H
-#define GPIO_PARAMS_H
+#pragma once
 
 /**
- * @ingroup     boards_esp32s3_seeedstudio
+ * @ingroup     boards_seeedstudio-xiao-esp32s3
  * @brief       Board specific configuration of direct mapped GPIOs
  * @file
  * @author      Isikcan 'Jon' Yilmaz <can158@gmail.com>
@@ -46,6 +42,4 @@ static const  saul_gpio_params_t saul_gpio_params[] =
 #ifdef __cplusplus
 }
 #endif
-
-#endif /* GPIO_PARAMS_H */
 /** @} */
diff --git a/boards/seeedstudio-xiao-esp32s3/include/periph_conf.h b/boards/seeedstudio-xiao-esp32s3/include/periph_conf.h
@@ -1,13 +1,12 @@
 /*
- * Copyright (C) 2024 Isikcan 'Jon' Yilmaz
- *
- * 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.
+ * SPDX-FileCopyrightText: 2024 Isikcan 'Jon' Yilmaz
+ * SPDX-License-Identifier: LGPL-2.1-only
  */
 
+#pragma once
+
 /**
- * @ingroup     boards_esp32s3_seeedstudio
+ * @ingroup     boards_seeedstudio-xiao-esp32s3
  * @brief       Peripheral configurations for Seeed Studio Xiao ESP32S3 boards
  * @{
  *
@@ -18,25 +17,18 @@
  * For detailed information about the peripheral configuration for ESP32-S3
  * 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      Isikcan 'Jon' Yilmaz <can158@gmail.com>
  */
 
-#ifndef PERIPH_CONF_H
-#define PERIPH_CONF_H
-
 #include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- * @name    ADC and DAC channel configuration
+ * @name    ADC Channel Configuration
  * @{
  */
 /**
@@ -51,14 +43,15 @@ extern "C" {
  * purposes.
  */
 #ifndef ADC_GPIOS
-#define ADC_GPIOS   { GPIO1, GPIO2, GPIO3, GPIO4, GPIO5, GPIO6, GPIO7, GPIO8, GPIO9 }
+#  define ADC_GPIOS { GPIO1, GPIO2, GPIO3, GPIO4, GPIO5, GPIO6, GPIO7, GPIO8, GPIO9 }
 #endif
 /** @} */
 
 /**
  * @name   I2C configuration
  *
- * For generic boards, only one I2C interface I2C_DEV(0) is defined.
+ * For the Seeedstudio Xiao ESP32S3 board, 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
@@ -67,13 +60,13 @@ extern "C" {
  * @{
  */
 #ifndef I2C0_SPEED
-#define I2C0_SPEED  I2C_SPEED_FAST  /**< I2C bus speed of I2C_DEV(0) */
+#  define I2C0_SPEED    I2C_SPEED_FAST  /**< I2C bus speed of I2C_DEV(0) */
 #endif
 #ifndef I2C0_SCL
-#define I2C0_SCL    GPIO6           /**< SCL signal of I2C_DEV(0) */
+#  define I2C0_SCL      GPIO6           /**< SCL signal of I2C_DEV(0) */
 #endif
 #ifndef I2C0_SDA
-#define I2C0_SDA    GPIO5           /**< SDA signal of I2C_DEV(0) */
+#  define I2C0_SDA      GPIO5           /**< SDA signal of I2C_DEV(0) */
 #endif
 /** @} */
 
@@ -95,9 +88,9 @@ extern "C" {
  * @brief Declaration of the channels for device PWM_DEV(0),
  *        at maximum PWM_CHANNEL_NUM_DEV_MAX.
  */
-// #ifndef PWM0_GPIOS
-// #define PWM0_GPIOS  { GPIO12, GPIO13, GPIO14, GPIO15, GPIO16 }
-// #endif
+#ifndef PWM0_GPIOS
+#  define PWM0_GPIOS    { GPIO21 }
+#endif
 
 /**
  * @brief Declaration of the channels for device PWM_DEV(1),
@@ -117,23 +110,23 @@ extern "C" {
  * 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.
- * @{ TODO SPI pins
+ * @{
  */
-// #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
+#ifndef SPI0_CTRL
+#  define SPI0_CTRL FSPI    /**< FSPI is used as SPI_DEV(0) */
+#endif
+#ifndef SPI0_SCK
+#  define SPI0_SCK  GPIO7   /**< FSPI SCK (pin FSPICLK) */
+#endif
+#ifndef SPI0_MISO
+#  define SPI0_MISO GPIO8   /**< FSPI MISO (pin FSPIQ) */
+#endif
+#ifndef SPI0_MOSI
+#  define SPI0_MOSI GPIO9   /**< FSPI MOSI (pin FSPID) */
+#endif
+#ifndef SPI0_CS0
+#  define SPI0_CS0  GPIO3   /**< FSPI CS0 (pin FSPICS0) */
+#endif
 /** @} */
 
 /**
@@ -143,25 +136,19 @@ extern "C" {
  *
  * UART_DEV(0) uses fixed standard configuration.<br>
  * UART_DEV(1) is not used.<br>
+ * UART_DEV(2) 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 */
-
 /** @} */
 
-/**
- * @name Camera configurations and pins
- * TODO also mic pins
- */
-
 #ifdef __cplusplus
 } /* end extern "C" */
 #endif
 
 /* include common peripheral definitions as last step */
 #include "periph_conf_common.h"
 
-#endif /* PERIPH_CONF_H */
 /** @} */
