boards: Adding Adafruit QT Py ESP32s3 support.

This adds support for the ESP32s3 based Adafruit QT Py, as well as its
PSRAM variant.

Signed-off-by: Ian Wakely <raveious.irw@gmail.com>
This commit is contained in:
Ian Wakely 2024-11-24 20:31:10 -05:00 committed by Benjamin Cabé
commit 6f7bbf7239
21 changed files with 794 additions and 0 deletions

View file

@ -0,0 +1,6 @@
# Copyright (c) 2024 Ian Wakely
config HEAP_MEM_POOL_ADD_SIZE_BOARD
int
default 4096 if BOARD_ADAFRUIT_QT_PY_ESP32S3_ESP32S3_PROCPU
default 256 if BOARD_ADAFRUIT_QT_PY_ESP32S3_ESP32S3_APPCPU

View file

@ -0,0 +1,9 @@
# Adafruit ESP32S3 board configuration
# Copyright (c) 2024 Ian Wakely
config BOARD_ADAFRUIT_QT_PY_ESP32S3
select SOC_ESP32S3_WROOM_N8 if "$(BOARD_REVISION)" = ""
select SOC_ESP32S3_WROOM_N4R2 if "$(BOARD_REVISION)" = "psram"
select SOC_ESP32S3_PROCPU if BOARD_ADAFRUIT_QT_PY_ESP32S3_ESP32S3_PROCPU
select SOC_ESP32S3_APPCPU if BOARD_ADAFRUIT_QT_PY_ESP32S3_ESP32S3_APPCPU

View file

@ -0,0 +1,10 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0
choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice
choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice

View file

@ -0,0 +1,67 @@
/*
* Copyright 2022 Google LLC
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <zephyr/dt-bindings/pinctrl/esp-pinctrl-common.h>
#include <dt-bindings/pinctrl/esp32s3-pinctrl.h>
#include <zephyr/dt-bindings/pinctrl/esp32s3-gpio-sigmap.h>
&pinctrl {
uart0_default: uart0_default {
group1 {
pinmux = <UART0_TX_GPIO5>;
output-high;
};
group2 {
pinmux = <UART0_RX_GPIO16>;
bias-pull-up;
};
};
spim2_default: spim2_default {
group1 {
pinmux = <SPIM2_MISO_GPIO37>,
<SPIM2_SCLK_GPIO36>;
};
group2 {
pinmux = <SPIM2_MOSI_GPIO35>;
output-low;
};
};
spim3_ws2812_led: spim3_ws2812_led {
group1 {
pinmux = <SPIM3_MOSI_GPIO39>;
output-low;
};
};
i2c0_default: i2c0_default {
group1 {
pinmux = <I2C0_SDA_GPIO7>,
<I2C0_SCL_GPIO6>;
bias-pull-up;
drive-open-drain;
output-high;
};
};
i2c1_default: i2c1_default {
group1 {
pinmux = <I2C1_SDA_GPIO41>,
<I2C1_SCL_GPIO40>;
bias-pull-up;
drive-open-drain;
output-high;
};
};
twai_default: twai_default {
group1 {
pinmux = <TWAI_TX_GPIO9>,
<TWAI_RX_GPIO8>;
};
};
};

View file

@ -0,0 +1,30 @@
/*
* Copyright (c) 2024 Ian Wakely
*/
/dts-v1/;
#include <espressif/esp32s3/esp32s3_wroom_n8.dtsi>
#include "adafruit_qt_py_esp32s3-pinctrl.dtsi"
#include <espressif/partitions_0x0_amp.dtsi>
/ {
model = "Adafruit QT Py ESP32S3 APPCPU";
compatible = "espressif,esp32s3";
chosen {
zephyr,sram = &sram1;
zephyr,ipc_shm = &shm0;
zephyr,ipc = &ipm0;
zephyr,flash = &flash0;
zephyr,code-partition = &slot0_appcpu_partition;
};
};
&trng0 {
status = "okay";
};
&ipm0 {
status = "okay";
};

View file

@ -0,0 +1,27 @@
identifier: adafruit_qt_py_esp32s3/esp32s3/appcpu
name: Adafruit QT Py ESP32S3 APPCPU
type: mcu
arch: xtensa
toolchain:
- zephyr
supported:
- uart
testing:
ignore_tags:
- net
- bluetooth
- flash
- cpp
- posix
- watchdog
- logging
- kernel
- pm
- gpio
- crypto
- eeprom
- heap
- cmsis_rtos
- jwt
- zdsp
vendor: adafruit

View file

@ -0,0 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
CONFIG_MAIN_STACK_SIZE=2048
CONFIG_CLOCK_CONTROL=y

View file

@ -0,0 +1,34 @@
/*
* Copyright (c) 2024 Ian Wakely
*/
/delete-node/ &flash0;
/ {
model = "Adafruit QT Py ESP32S3 PSRAM APPCPU";
soc {
flash: flash-controller@60002000 {
compatible = "espressif,esp32-flash-controller";
reg = <0x60002000 0x1000>;
#address-cells = <1>;
#size-cells = <1>;
/* 4MB flash */
flash0: flash@0 {
compatible = "soc-nv-flash";
erase-block-size = <4096>;
write-block-size = <4>;
reg = <0x0 DT_SIZE_M(4)>;
};
};
};
};
/* 2MB psram */
&psram0 {
reg = <0x3c000000 DT_SIZE_M(2)>;
status = "okay";
};
#include <espressif/partitions_0x0_amp.dtsi>

View file

@ -0,0 +1,27 @@
identifier: adafruit_qt_py_esp32s3@psram/esp32s3/appcpu
name: Adafruit QT Py ESP32S3 PSRAM APPCPU
type: mcu
arch: xtensa
toolchain:
- zephyr
supported:
- uart
testing:
ignore_tags:
- net
- bluetooth
- flash
- cpp
- posix
- watchdog
- logging
- kernel
- pm
- gpio
- crypto
- eeprom
- heap
- cmsis_rtos
- jwt
- zdsp
vendor: adafruit

View file

@ -0,0 +1,149 @@
/*
* Copyright (c) 2023 Seeed Studio inc.
* Copyright (c) 2024 Ian Wakely
*
* SPDX-License-Identifier: Apache-2.0
*/
/dts-v1/;
#include <espressif/esp32s3/esp32s3_wroom_n8.dtsi>
#include <zephyr/dt-bindings/led/led.h>
#include <zephyr/dt-bindings/input/input-event-codes.h>
#include "adafruit_qt_py_esp32s3-pinctrl.dtsi"
#include "seeed_xiao_connector.dtsi"
#include <espressif/partitions_0x0_amp.dtsi>
/ {
model = "Adafruit QT Py ESP32S3 PROCPU";
compatible = "seeed,xiao-esp32s3";
chosen {
zephyr,sram = &sram1;
zephyr,console = &usb_serial;
zephyr,shell-uart = &usb_serial;
zephyr,flash = &flash0;
zephyr,code-partition = &slot0_partition;
zephyr,bt-hci = &esp32_bt_hci;
};
aliases {
i2c-0 = &i2c0;
watchdog0 = &wdt0;
led-strip = &led_strip;
sw0 = &button0;
};
buttons {
compatible = "gpio-keys";
button0: button_0 {
gpios = <&gpio0 0 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
label = "User button";
zephyr,code = <INPUT_KEY_0>;
};
};
};
&usb_serial {
status = "okay";
};
&uart0 {
status = "okay";
current-speed = <115200>;
pinctrl-0 = <&uart0_default>;
pinctrl-names = "default";
};
&i2c0 {
status = "okay";
clock-frequency = <I2C_BITRATE_STANDARD>;
pinctrl-0 = <&i2c0_default>;
pinctrl-names = "default";
};
&i2c1 {
status = "okay";
clock-frequency = <I2C_BITRATE_STANDARD>;
pinctrl-0 = <&i2c1_default>;
pinctrl-names = "default";
};
&trng0 {
status = "okay";
};
&spi2 {
#address-cells = <1>;
#size-cells = <0>;
status = "okay";
pinctrl-0 = <&spim2_default>;
pinctrl-names = "default";
};
&spi3 {
#address-cells = <1>;
#size-cells = <0>;
status = "okay";
pinctrl-0 = <&spim3_ws2812_led>;
pinctrl-names = "default";
line-idle-low;
led_strip: ws2812@0 {
compatible = "worldsemi,ws2812-spi";
/* SPI */
reg = <0>; /* ignored, but necessary for SPI bindings */
spi-max-frequency = <6400000>;
/* WS2812 */
chain-length = <1>;
spi-cpha;
spi-one-frame = <0xf0>; /* 11110000: 625 ns high and 625 ns low */
spi-zero-frame = <0xc0>; /* 11000000: 312.5 ns high and 937.5 ns low */
color-mapping = <LED_COLOR_ID_GREEN
LED_COLOR_ID_RED
LED_COLOR_ID_BLUE>;
};
};
&gpio0 {
status = "okay";
};
&gpio1 {
status = "okay";
/*
* Unlike some of the other Adafruit boards, the neopixel on this board has
* its positive side hooked up to a GPIO pin rather than a positive voltage
* rail to save on power. This will enable the LED on board initialization.
*/
neopixel-power-enable {
gpio-hog;
gpios = <6 GPIO_ACTIVE_HIGH>;
output-high;
};
};
&wdt0 {
status = "okay";
};
&twai {
pinctrl-0 = <&twai_default>;
pinctrl-names = "default";
};
&timer0 {
status = "okay";
};
&timer1 {
status = "okay";
};
&esp32_bt_hci {
status = "okay";
};

View file

@ -0,0 +1,19 @@
identifier: adafruit_qt_py_esp32s3/esp32s3/procpu
name: Adafruit QT Py ESP32S3 PROCPU
type: mcu
arch: xtensa
toolchain:
- zephyr
supported:
- gpio
- uart
- i2c
- i2s
- spi
- can
- counter
- watchdog
- entropy
- pwm
- dma
vendor: adafruit

View file

@ -0,0 +1,7 @@
# SPDX-License-Identifier: Apache-2.0
CONFIG_MAIN_STACK_SIZE=2048
CONFIG_CONSOLE=y
CONFIG_SERIAL=y
CONFIG_UART_CONSOLE=y
CONFIG_GPIO=y

View file

@ -0,0 +1,34 @@
/*
* Copyright (c) 2024 Ian Wakely
*/
/delete-node/ &flash0;
/ {
model = "Adafruit QT Py ESP32S3 PSRAM PROCPU";
soc {
flash: flash-controller@60002000 {
compatible = "espressif,esp32-flash-controller";
reg = <0x60002000 0x1000>;
#address-cells = <1>;
#size-cells = <1>;
/* 4MB flash */
flash0: flash@0 {
compatible = "soc-nv-flash";
erase-block-size = <4096>;
write-block-size = <4>;
reg = <0x0 DT_SIZE_M(4)>;
};
};
};
};
/* 2MB psram */
&psram0 {
reg = <0x3c000000 DT_SIZE_M(2)>;
status = "okay";
};
#include <espressif/partitions_0x0_amp.dtsi>

View file

@ -0,0 +1,19 @@
identifier: adafruit_qt_py_esp32s3@psram/esp32s3/procpu
name: Adafruit QT Py ESP32S3 PSRAM PROCPU
type: mcu
arch: xtensa
toolchain:
- zephyr
supported:
- gpio
- uart
- i2c
- i2s
- spi
- can
- counter
- watchdog
- entropy
- pwm
- dma
vendor: adafruit

View file

@ -0,0 +1,9 @@
# SPDX-License-Identifier: Apache-2.0
if(NOT "${OPENOCD}" MATCHES "^${ESPRESSIF_TOOLCHAIN_PATH}/.*")
set(OPENOCD OPENOCD-NOTFOUND)
endif()
find_program(OPENOCD openocd PATHS ${ESPRESSIF_TOOLCHAIN_PATH}/openocd-esp32/bin NO_DEFAULT_PATH)
include(${ZEPHYR_BASE}/boards/common/esp32.board.cmake)
include(${ZEPHYR_BASE}/boards/common/openocd.board.cmake)

View file

@ -0,0 +1,12 @@
board:
name: adafruit_qt_py_esp32s3
full_name: QT Py ESP32-S3
vendor: adafruit
socs:
- name: esp32s3
revision:
format: "custom"
default: ""
revisions:
- name: ""
- name: "psram"

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

View file

@ -0,0 +1,291 @@
.. zephyr:board:: adafruit_qt_py_esp32s3
Overview
********
An Adafruit based Xiao compatible board based on the ESP32-S3, which is great
for IoT projects and prototyping with new sensors.
For more details see the `Adafruit QT Py ESP32S3`_ product page.
Hardware
********
This board comes in 2 variants, both based on the ESP32-S3 with WiFi and BLE
support. The default variant supporting 8MB of flash with no PSRAM, while the
``psram`` variant supporting 4MB of flash with 2MB of PSRAM. Both boards have a
USB-C port for programming and debugging and is based on a standard XIAO 14
pin pinout.
In addition to the Xiao compatible pinout, it also has a RGB NeoPixel for
status and debugging, a reset button, and a button for entering the ROM
bootloader or user input. Like many other Adafruit boards, it has a
`SparkFun Qwiic`_-compatible `STEMMA QT`_ connector for the I2C bus so you
don't even need to solder.
ESP32-S3 is a low-power MCU-based system on a chip (SoC) with integrated
2.4 GHz Wi-Fi and Bluetooth® Low Energy (Bluetooth LE). It consists of
high-performance dual-core microprocessor (Xtensa® 32-bit LX7), a low power
coprocessor, a Wi-Fi baseband, a Bluetooth LE baseband, RF module, and
numerous peripherals.
Supported Features
==================
Current Zephyr's Adafruit QT Py ESP32-S3 board supports the following features:
+------------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+============+============+=====================================+
| UART | on-chip | serial port |
+------------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+------------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+------------+------------+-------------------------------------+
| USB-JTAG | on-chip | hardware interface |
+------------+------------+-------------------------------------+
| SPI Master | on-chip | spi |
+------------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+------------+------------+-------------------------------------+
| I2S | on-chip | i2s |
+------------+------------+-------------------------------------+
| TWAI/CAN | on-chip | can |
+------------+------------+-------------------------------------+
| ADC | on-chip | adc |
+------------+------------+-------------------------------------+
| Timers | on-chip | counter |
+------------+------------+-------------------------------------+
| Watchdog | on-chip | watchdog |
+------------+------------+-------------------------------------+
| TRNG | on-chip | entropy |
+------------+------------+-------------------------------------+
| LEDC | on-chip | pwm |
+------------+------------+-------------------------------------+
| MCPWM | on-chip | pwm |
+------------+------------+-------------------------------------+
| PCNT | on-chip | qdec |
+------------+------------+-------------------------------------+
| GDMA | on-chip | dma |
+------------+------------+-------------------------------------+
| Wi-Fi | on-chip | |
+------------+------------+-------------------------------------+
| Bluetooth | on-chip | |
+------------+------------+-------------------------------------+
Prerequisites
-------------
Espressif HAL requires WiFi and Bluetooth binary blobs in order work. Run the
command below to retrieve those files.
.. code-block:: console
west blobs fetch hal_espressif
.. note::
It is recommended running the command above after :file:`west update`.
Building & Flashing
*******************
Simple boot
===========
The board could be loaded using the single binary image, without 2nd stage
bootloader. It is the default option when building the application without
additional configuration.
.. note::
Simple boot does not provide any security features nor OTA updates.
MCUboot bootloader
==================
User may choose to use MCUboot bootloader instead. In that case the bootloader
must be built (and flashed) at least once.
There are two options to be used when building an application:
1. Sysbuild
2. Manual build
.. note::
User can select the MCUboot bootloader by adding the following line
to the board default configuration file.
.. code:: cfg
CONFIG_BOOTLOADER_MCUBOOT=y
Sysbuild
========
The sysbuild makes possible to build and flash all necessary images needed to
bootstrap the board with the ESP32 SoC.
To build the sample application using sysbuild use the command:
.. zephyr-app-commands::
:tool: west
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3
:goals: build
:west-args: --sysbuild
:compact:
By default, the ESP32 sysbuild creates bootloader (MCUboot) and application
images. But it can be configured to create other kind of images.
Build directory structure created by sysbuild is different from traditional
Zephyr build. Output is structured by the domain subdirectories:
.. code-block::
build/
├── hello_world
│ └── zephyr
│ ├── zephyr.elf
│ └── zephyr.bin
├── mcuboot
│ └── zephyr
│ ├── zephyr.elf
│ └── zephyr.bin
└── domains.yaml
.. note::
With ``--sysbuild`` option the bootloader will be re-build and re-flash
every time the pristine build is used.
For more information about the system build please read the :ref:`sysbuild` documentation.
Manual build
============
During the development cycle, it is intended to build & flash as quickly possible.
For that reason, images can be built one at a time using traditional build.
The instructions following are relevant for both manual build and sysbuild.
The only difference is the structure of the build directory.
.. note::
Remember that bootloader (MCUboot) needs to be flash at least once.
Build and flash applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
.. tabs::
.. group-tab:: QT Py ESP32S3
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3/esp32s3/procpu
:goals: build
.. group-tab:: QT Py ESP32S3 with PSRAM
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3@psram/esp32s3/procpu
:goals: build
The usual ``flash`` target will work with the ``adafruit_qt_py_esp32s3`` board
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. tabs::
.. group-tab:: QT Py ESP32S3
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3/esp32s3/procpu
:goals: flash
.. group-tab:: QT Py ESP32S3 with PSRAM
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3@psram/esp32s3/procpu
:goals: flash
Open the serial monitor using the following command:
.. code-block:: shell
west espressif monitor
After the board has automatically reset and booted, you should see the following
message in the monitor:
.. code-block:: console
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
Hello World! adafruit_qt_py_esp32s3/esp32s3/procpu
Debugging
*********
ESP32-S3 support on OpenOCD is available at `OpenOCD ESP32`_.
ESP32-S3 has a built-in JTAG circuitry and can be debugged without any
additional chip. Only an USB cable connected to the D+/D- pins is necessary.
Further documentation can be obtained from the SoC vendor
in `JTAG debugging for ESP32-S3`_.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. tabs::
.. group-tab:: QT Py ESP32S3
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3/esp32s3/procpu
:goals: debug
.. group-tab:: QT Py ESP32S3 with PSRAM
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3@psram/esp32s3/procpu
:goals: debug
You can debug an application in the usual way. Here is an example for
the :zephyr:code-sample:`hello_world` application.
.. tabs::
.. group-tab:: QT Py ESP32S3
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3/esp32s3/procpu
:goals: debug
.. group-tab:: QT Py ESP32S3 with PSRAM
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: adafruit_qt_py_esp32s3@psram/esp32s3/procpu
:goals: debug
References
**********
.. target-notes::
.. _`Adafruit QT Py ESP32S3`: https://www.adafruit.com/product/5426
.. _`Adafruit QT Py ESP32S3 - PSRAM`: https://www.adafruit.com/product/5700
.. _`JTAG debugging for ESP32-S3`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/jtag-debugging/
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
.. _`SparkFun Qwiic`: https://www.sparkfun.com/qwiic
.. _`STEMMA QT`: https://learn.adafruit.com/introducing-adafruit-stemma-qt

View file

@ -0,0 +1,3 @@
if(DEFINED BOARD_REVISION AND NOT BOARD_REVISION STREQUAL "psram")
message(FATAL_ERROR "Invalid board revision, ${BOARD_REVISION}, valid revisions are: <none> (for non-PSRAM version), psram")
endif()

View file

@ -0,0 +1,30 @@
/*
* Copyright (c) 2024 Ian Wakely
*
* SPDX-License-Identifier: Apache-2.0
*/
/ {
xiao_d: connector {
compatible = "seeed,xiao-gpio";
#gpio-cells = <2>;
gpio-map-mask = <0xffffffff 0xffffffc0>;
gpio-map-pass-thru = <0 0x3f>;
gpio-map = <0 0 &gpio0 18 0>, /* D0 */
<1 0 &gpio0 17 0>, /* D1 */
<2 0 &gpio0 9 0>, /* D2 */
<3 0 &gpio0 8 0>, /* D3 */
<4 0 &gpio0 7 0>, /* D4 */
<5 0 &gpio0 6 0>, /* D5 */
<6 0 &gpio0 5 0>, /* D6 */
<7 0 &gpio0 16 0>, /* D7 */
<8 0 &gpio1 4 0>, /* D8 */
<9 0 &gpio1 5 0>, /* D9 */
<10 0 &gpio1 3 0>; /* D10 */
};
};
xiao_spi: &spi2 {};
xiao_i2c: &i2c0 {};
xiao_serial: &uart0 {};
xiao_adc: &adc0 {};

View file

@ -0,0 +1,7 @@
set ESP_RTOS none
set ESP32_ONLYCPU 1
# Source the JTAG interface configuration file
source [find interface/esp_usb_jtag.cfg]
# Source the ESP32-S3 configuration file
source [find target/esp32s3.cfg]