Initial commit with basic project structure and Firebeetle 2 board definition
This commit is contained in:
228
boards/espressif/esp32s2_saola/doc/index.rst
Normal file
228
boards/espressif/esp32s2_saola/doc/index.rst
Normal file
@@ -0,0 +1,228 @@
|
||||
.. zephyr:board:: esp32s2_saola
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
ESP32-S2-Saola is a small-sized ESP32-S2 based development board produced by Espressif.
|
||||
Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing.
|
||||
Developers can either connect peripherals with jumper wires or mount ESP32-S2-Saola on a breadboard.
|
||||
For more information, check `ESP32-S3-DevKitC`_.
|
||||
|
||||
Hardware
|
||||
********
|
||||
|
||||
ESP32-S2 is a highly integrated, low-power, single-core Wi-Fi Microcontroller SoC, designed to be secure and
|
||||
cost-effective, with a high performance and a rich set of IO capabilities.
|
||||
|
||||
The features include the following:
|
||||
|
||||
- RSA-3072-based secure boot
|
||||
- AES-XTS-256-based flash encryption
|
||||
- Protected private key and device secrets from software access
|
||||
- Cryptographic accelerators for enhanced performance
|
||||
- Protection against physical fault injection attacks
|
||||
- Various peripherals:
|
||||
|
||||
- 43x programmable GPIOs
|
||||
- 14x configurable capacitive touch GPIOs
|
||||
- USB OTG
|
||||
- LCD interface
|
||||
- camera interface
|
||||
- SPI
|
||||
- I2S
|
||||
- UART
|
||||
- ADC
|
||||
- DAC
|
||||
- LED PWM with up to 8 channels
|
||||
|
||||
For more information, check the datasheet at `ESP32-S2 Datasheet`_ or the technical reference
|
||||
manual at `ESP32-S2 Technical Reference Manual`_.
|
||||
|
||||
Supported Features
|
||||
==================
|
||||
|
||||
.. zephyr:board-supported-hw::
|
||||
|
||||
System requirements
|
||||
===================
|
||||
|
||||
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
|
||||
*******************
|
||||
|
||||
.. zephyr:board-supported-runners::
|
||||
|
||||
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: esp32s2_saola
|
||||
: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).
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/hello_world
|
||||
:board: esp32s2_saola
|
||||
:goals: build
|
||||
|
||||
The usual ``flash`` target will work with the ``esp32s2_saola`` board
|
||||
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
|
||||
application.
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/hello_world
|
||||
:board: esp32s2_saola
|
||||
: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! esp32s2_saola
|
||||
|
||||
Debugging
|
||||
*********
|
||||
|
||||
ESP32-S2 support on OpenOCD is available at `OpenOCD ESP32`_.
|
||||
|
||||
The following table shows the pin mapping between ESP32-S2 board and JTAG interface.
|
||||
|
||||
+---------------+-----------+
|
||||
| ESP32 pin | JTAG pin |
|
||||
+===============+===========+
|
||||
| MTDO / GPIO40 | TDO |
|
||||
+---------------+-----------+
|
||||
| MTDI / GPIO41 | TDI |
|
||||
+---------------+-----------+
|
||||
| MTCK / GPIO39 | TCK |
|
||||
+---------------+-----------+
|
||||
| MTMS / GPIO42 | TMS |
|
||||
+---------------+-----------+
|
||||
|
||||
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S2`_.
|
||||
|
||||
Here is an example for building the :zephyr:code-sample:`hello_world` application.
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/hello_world
|
||||
:board: esp32s2_saola
|
||||
:goals: build flash
|
||||
|
||||
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/hello_world
|
||||
:board: esp32s2_saola
|
||||
:goals: debug
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
.. target-notes::
|
||||
|
||||
.. _`ESP32-S3-DevKitC`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html
|
||||
.. _`ESP32-S2 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
|
||||
.. _`ESP32-S2 Technical Reference Manual`: https://espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf
|
||||
.. _`JTAG debugging for ESP32-S2`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-guides/jtag-debugging/index.html
|
||||
.. _`OpenOCD ESP32`: https://github.com/espressif/openocd-esp32/releases
|
||||
Reference in New Issue
Block a user