Skip to content

Commit

Permalink
boards: Update ESP32 related documentation
Browse files Browse the repository at this point in the history
Update the note on the booting method for all ESP32 related boards.

Signed-off-by: Marek Matej <marek.matej@espressif.com>
  • Loading branch information
Marek Matej authored and nashif committed Apr 8, 2024
1 parent 2395f08 commit c086603
Show file tree
Hide file tree
Showing 17 changed files with 214 additions and 82 deletions.
88 changes: 86 additions & 2 deletions boards/espressif/esp32_devkitc_wroom/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,91 @@ below to retrieve those files.
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 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 ESP32 SoC.

To build the sample application using sysbuild use the command:

.. zephyr-app-commands::
:tool: west
:app: samples/hello_world
:board: esp_wrover_kit
: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).
Expand Down Expand Up @@ -149,7 +233,7 @@ message in the monitor:
Hello World! esp32_devkitc_wroom
Debugging
---------
*********

ESP32-DEVKITC-WROOM support on OpenOCD is available upstream as of version 0.12.0.
Download and install OpenOCD from `OpenOCD`_.
Expand Down
13 changes: 8 additions & 5 deletions boards/espressif/esp32_devkitc_wrover/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/espressif/esp32_ethernet_kit/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -438,12 +438,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/espressif/esp32c3_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/espressif/esp32s2_saola/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/espressif/esp32s3_devkitm/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/espressif/esp_wrover_kit/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -503,12 +503,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/franzininho/esp32s2_franzininho/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/heltec/heltec_wifi_lora32_v2/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,12 +156,15 @@ below to retrieve those files.
Programming and Debugging
*************************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/luatos/esp32c3_luatos_core/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/luatos/esp32s3_luatos_core/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/olimex/olimex_esp32_evb/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/others/icev_wireless/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,15 @@ incredibly easy 🎉 following the steps below.
Building and Flashing
*********************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down
13 changes: 8 additions & 5 deletions boards/seeed/xiao_esp32c3/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,15 @@ below to retrieve those files.
Building & Flashing
*******************

ESP-IDF bootloader
==================
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::

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.
Simple boot does not provide any security features nor OTA updates.

MCUboot bootloader
==================
Expand Down

0 comments on commit c086603

Please sign in to comment.