boards: Update ESP32 related documentation
Update the note on the booting method for all ESP32 related boards. Signed-off-by: Marek Matej <marek.matej@espressif.com>
This commit is contained in:
parent
2395f08d48
commit
c0866030eb
17 changed files with 214 additions and 82 deletions
|
@ -115,7 +115,91 @@ below to retrieve those files.
|
||||||
It is recommended running the command above after :file:`west update`.
|
It is recommended running the command above after :file:`west update`.
|
||||||
|
|
||||||
Building & Flashing
|
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
|
Build and flash applications as usual (see :ref:`build_an_application` and
|
||||||
:ref:`application_run` for more details).
|
:ref:`application_run` for more details).
|
||||||
|
@ -149,7 +233,7 @@ message in the monitor:
|
||||||
Hello World! esp32_devkitc_wroom
|
Hello World! esp32_devkitc_wroom
|
||||||
|
|
||||||
Debugging
|
Debugging
|
||||||
---------
|
*********
|
||||||
|
|
||||||
ESP32-DEVKITC-WROOM support on OpenOCD is available upstream as of version 0.12.0.
|
ESP32-DEVKITC-WROOM support on OpenOCD is available upstream as of version 0.12.0.
|
||||||
Download and install OpenOCD from `OpenOCD`_.
|
Download and install OpenOCD from `OpenOCD`_.
|
||||||
|
|
|
@ -117,12 +117,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -438,12 +438,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -92,12 +92,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -88,12 +88,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -137,12 +137,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -503,12 +503,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -54,12 +54,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -42,12 +42,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -156,12 +156,15 @@ below to retrieve those files.
|
||||||
Programming and Debugging
|
Programming and Debugging
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -110,12 +110,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -136,12 +136,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -111,12 +111,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -98,12 +98,15 @@ incredibly easy 🎉 following the steps below.
|
||||||
Building and Flashing
|
Building and Flashing
|
||||||
*********************
|
*********************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -80,12 +80,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -96,12 +96,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -117,12 +117,15 @@ below to retrieve those files.
|
||||||
Building & Flashing
|
Building & Flashing
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
ESP-IDF bootloader
|
Simple boot
|
||||||
==================
|
===========
|
||||||
|
|
||||||
The board is using the ESP-IDF bootloader as the default 2nd stage bootloader.
|
The board could be loaded using the single binary image, without 2nd stage bootloader.
|
||||||
It is build as a subproject at each application build. No further attention
|
It is the default option when building the application without additional configuration.
|
||||||
is expected from the user.
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Simple boot does not provide any security features nor OTA updates.
|
||||||
|
|
||||||
MCUboot bootloader
|
MCUboot bootloader
|
||||||
==================
|
==================
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue