-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
boards: esp32s3_devkitc: initial board support
Initial board files created to support the esp32s3_devkitc board. Signed-off-by: Marcio Ribeiro <marcio.ribeiro@espressif.com>
- Loading branch information
Showing
10 changed files
with
631 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
# ESP32S3 DevKitC board configuration | ||
config BOARD_ESP32S3_DEVKITC | ||
bool "ESP32S3 DevKitC Board" | ||
depends on SOC_SERIES_ESP32S3 | ||
|
||
config BOARD_ESP32S3_DEVKITM_APPCPU | ||
bool "ESP32S3 Board configuration for APPCPU (core 1)." | ||
depends on SOC_SERIES_ESP32S3 && SOC_ESP32S3_APPCPU | ||
|
||
choice SOC_PART_NUMBER | ||
default SOC_ESP32S3_WROOM_N8R8 | ||
endchoice |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# ESP32S3 DevKitC board configuration | ||
|
||
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
config BOARD | ||
default "esp32s3_devkitc" | ||
depends on BOARD_ESP32S3_DEVKITC | ||
|
||
config ENTROPY_GENERATOR | ||
default y | ||
|
||
config HEAP_MEM_POOL_SIZE | ||
default 98304 if WIFI | ||
default 40960 if BT | ||
default 4096 | ||
|
||
choice BT_HCI_BUS_TYPE | ||
default BT_ESP32 if BT | ||
endchoice |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,279 @@ | ||
.. _esp32s3_devkitc: | ||
|
||
ESP32S3-DevKitC | ||
############### | ||
|
||
Overview | ||
******** | ||
|
||
The ESP32-S3-DevKitC is an entry-level development board equipped with either ESP32-S3-WROOM-1 | ||
or ESP32-S3-WROOM-1U, a module named for its small size. This board integrates complete Wi-Fi | ||
and Bluetooth Low Energy functions. For more information, check `ESP32-S3 DevKitC`_ | ||
|
||
Hardware | ||
******** | ||
|
||
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. | ||
|
||
ESP32-S3 DevKitC includes the following features: | ||
|
||
- Dual core 32-bit Xtensa Microprocessor (Tensilica LX7), running up to 240MHz | ||
- Additional vector instructions support for AI acceleration | ||
- 512KB of SRAM | ||
- 384KB of ROM | ||
- Wi-Fi 802.11b/g/n | ||
- Bluetooth LE 5.0 with long-range support and up to 2Mbps data rate | ||
|
||
Digital interfaces: | ||
|
||
- 45 programmable GPIOs | ||
- 4x SPI | ||
- 1x LCD interface (8-bit ~16-bit parallel RGB, I8080 and MOTO6800), supporting conversion between RGB565, YUV422, YUV420 and YUV411 | ||
- 1x DVP 8-bit ~16-bit camera interface | ||
- 3x UART | ||
- 2x I2C | ||
- 2x I2S | ||
- 1x RMT (TX/RX) | ||
- 1x pulse counter | ||
- LED PWM controller, up to 8 channels | ||
- 1x full-speed USB OTG | ||
- 1x USB Serial/JTAG controller | ||
- 2x MCPWM | ||
- 1x SDIO host controller with 2 slots | ||
- General DMA controller (GDMA), with 5 transmit channels and 5 receive channels | ||
- 1x TWAI® controller, compatible with ISO 11898-1 (CAN Specification 2.0) | ||
- Addressable RGB LED, driven by GPIO48. | ||
|
||
Analog interfaces: | ||
|
||
- 2x 12-bit SAR ADCs, up to 20 channels | ||
- 1x temperature sensor | ||
- 14x touch sensing IOs | ||
|
||
Timers: | ||
|
||
- 4x 54-bit general-purpose timers | ||
- 1x 52-bit system timer | ||
- 3x watchdog timers | ||
|
||
Low Power: | ||
|
||
- Power Management Unit with five power modes | ||
- Ultra-Low-Power (ULP) coprocessors: ULP-RISC-V and ULP-FSM | ||
|
||
Security: | ||
|
||
- Secure boot | ||
- Flash encryption | ||
- 4-Kbit OTP, up to 1792 bits for users | ||
- Cryptographic hardware acceleration: (AES-128/256, Hash, RSA, RNG, HMAC, Digital signature) | ||
|
||
For more information, check the datasheet at `ESP32-S3 Datasheet`_. | ||
|
||
Supported Features | ||
================== | ||
|
||
Current Zephyr's ESP32-S3-DevKitC 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 | | ||
+------------+------------+-------------------------------------+ | ||
| 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 | | ||
+------------+------------+-------------------------------------+ | ||
| USB-CDC | on-chip | serial | | ||
+------------+------------+-------------------------------------+ | ||
|
||
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 | ||
******************* | ||
|
||
ESP-IDF bootloader | ||
================== | ||
|
||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader. | ||
It is build as a subproject at each application build. No further attention | ||
is expected from the user. | ||
|
||
MCUboot bootloader | ||
================== | ||
|
||
User may choose to use MCUboot bootloader instead. In that case the bootloader | ||
must be build (and flash) 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. | ||
``` | ||
CONFIG_BOOTLOADER_MCUBOOT=y | ||
``` | ||
|
||
Sysbuild | ||
======== | ||
|
||
The sysbuild makes possible to build and flash all necessary images needed to | ||
bootstrap the board with the EPS32 SoC. | ||
|
||
To build the sample application using sysbuild use the command: | ||
|
||
.. zephyr-app-commands:: | ||
:tool: west | ||
:app: samples/hello_world | ||
:board: esp32s3_devkitc | ||
: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 build 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). | ||
|
||
.. zephyr-app-commands:: | ||
:zephyr-app: samples/hello_world | ||
:board: esp32s3_devkitc | ||
:goals: build | ||
|
||
The usual ``flash`` target will work with the ``esp32s3_devkitc`` board | ||
configuration. Here is an example for the :ref:`hello_world` | ||
application. | ||
|
||
.. zephyr-app-commands:: | ||
:zephyr-app: samples/hello_world | ||
:board: esp32s3_devkitc | ||
: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! esp32s3_devkitc | ||
Debugging | ||
********* | ||
|
||
ESP32-S3 support on OpenOCD is available upstream as of version 0.12.0. | ||
Download and install OpenOCD from `OpenOCD`_. | ||
|
||
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 :ref:`hello_world` application. | ||
|
||
.. zephyr-app-commands:: | ||
:zephyr-app: samples/hello_world | ||
:board: esp32s3_devkitc | ||
:goals: build flash | ||
|
||
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. | ||
|
||
.. zephyr-app-commands:: | ||
:zephyr-app: samples/hello_world | ||
:board: esp32s3_devkitc | ||
:goals: debug | ||
|
||
.. _`JTAG debugging for ESP32-S3`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/jtag-debugging/ | ||
.. _`OpenOCD`: https://github.com/openocd-org/openocd | ||
.. _`ESP32-S3 DevKitC`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html | ||
|
||
References | ||
********** | ||
|
||
.. _ESP32-S3 DevKitC User Guide: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html | ||
.. _ESP32-S3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s3-wroom-1_wroom-1u_datasheet_en.pdf | ||
.. _ESP32 Technical Reference Manual: https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf |
Oops, something went wrong.