edi
/
firebeetle2_esp32c6_zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
firebeetle2_esp32c6_zephyr/boards/espressif/esp32s2_devkitc/doc/index.rst

6.3 KiB
Raw Blame History

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

System Message: ERROR/3 (<stdin>, line 1)

Unknown directive type "zephyr:board".

.. zephyr:board:: esp32s2_devkitc

Overview

ESP32-S2-DevKitC is an entry-level development board. This board integrates complete Wi-Fi functions. 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-DevKitC on a breadboard. For more information, check ESP32-S2-DevKitC [1].

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 [2] or the technical reference manual at ESP32-S2 Technical Reference Manual [3].

Supported Features

System Message: ERROR/3 (<stdin>, line 44)

Unknown directive type "zephyr:board-supported-hw".

.. 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.

System Message: WARNING/2 (<stdin>, line 55)

Cannot analyze code. Pygments package not found.

.. code-block:: console

   west blobs fetch hal_espressif

Note

It is recommended running the command above after :file:`west update`.

System Message: ERROR/3 (<stdin>, line 61); backlink

Unknown interpreted text role "file".

Building & Flashing

System Message: ERROR/3 (<stdin>, line 66)

Unknown directive type "zephyr:board-supported-runners".

.. 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.

System Message: WARNING/2 (<stdin>, line 94)

Cannot analyze code. Pygments package not found.

.. 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:

System Message: ERROR/3 (<stdin>, line 106)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :tool: west
   :zephyr-app: samples/hello_world
   :board: esp32s2_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:

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.

System Message: ERROR/3 (<stdin>, line 138); backlink

Unknown interpreted text role "ref".

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).

System Message: ERROR/3 (<stdin>, line 153); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<stdin>, line 153); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<stdin>, line 156)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32s2_devkitc
   :goals: build

The usual flash target will work with the esp32s2_devkitc board configuration. Here is an example for the :zephyr:code-sample:`hello_world` application.

System Message: ERROR/3 (<stdin>, line 161); backlink

Unknown interpreted text role "zephyr:code-sample".

System Message: ERROR/3 (<stdin>, line 165)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32s2_devkitc
   :goals: flash

Open the serial monitor using the following command:

System Message: WARNING/2 (<stdin>, line 172)

Cannot analyze code. Pygments package not found.

.. code-block:: shell

   west espressif monitor

After the board has automatically reset and booted, you should see the following message in the monitor:

System Message: WARNING/2 (<stdin>, line 179)

Cannot analyze code. Pygments package not found.

.. code-block:: console

   ***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
   Hello World! esp32s2_devkitc

Debugging

ESP32-S2 support on OpenOCD is available at OpenOCD ESP32 [5].

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 [4].

Here is an example for building the :zephyr:code-sample:`hello_world` application.

System Message: ERROR/3 (<stdin>, line 205); backlink

Unknown interpreted text role "zephyr:code-sample".

System Message: ERROR/3 (<stdin>, line 207)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32s2_devkitc
   :goals: build flash

You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.

System Message: ERROR/3 (<stdin>, line 212); backlink

Unknown interpreted text role "zephyr:code-sample".

System Message: ERROR/3 (<stdin>, line 214)

Unknown directive type "zephyr-app-commands".

.. zephyr-app-commands::
   :zephyr-app: samples/hello_world
   :board: esp32s2_devkitc
   :goals: debug

References

[1]https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html
[2]https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
[3]https://espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf
[4]https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-guides/jtag-debugging/index.html
[5]https://github.com/espressif/openocd-esp32/releases
</html>