Skip to content

Commit 9d0942b

Browse files
Marek Matejnashif
Marek Matej
authored and
nashif
committed
boards: espressif: Update boards documentation
Added a new 'Board variants' section to the board documentation to describe supported flash and PSRAM configurations for Espressif boards using snippet-based build-time selection. Signed-off-by: Marek Matej <[email protected]>
1 parent 43c8dec commit 9d0942b

File tree

14 files changed

+84
-0
lines changed

14 files changed

+84
-0
lines changed

‎boards/espressif/common/board-variants.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
:orphan:
2+
3+
.. espressif-board-variants
4+
5+
Board variants using Snippets
6+
=============================
7+
8+
ESP32 boards can be assembled with different modules using multiple combinations of SPI flash sizes, PSRAM sizes and PSRAM modes.
9+
The snippets under ``snippets/espressif`` provide a modular way to apply these variations at build time without duplicating board definitions.
10+
11+
The following snippet-based variants are supported:
12+
13+
=============== ========================
14+
Snippet name Description
15+
=============== ========================
16+
*Flash memory size*
17+
-----------------------------------------
18+
``flash-4M`` Board with 4MB of flash
19+
``flash-8M`` Board with 8MB of flash
20+
``flash-16M`` Board with 16MB of flash
21+
``flash-32M`` Board with 32MB of flash
22+
--------------- ------------------------
23+
*PSRAM memory size*
24+
-----------------------------------------
25+
``psram-2M`` Board with 2MB of PSRAM
26+
``psram-4M`` Board with 4MB of PSRAM
27+
``psram-8M`` Board with 8MB of PSRAM
28+
--------------- ------------------------
29+
*PSRAM utilization*
30+
-----------------------------------------
31+
``psram-reloc`` Relocate flash to PSRAM
32+
``psram-wifi`` Wi-Fi buffers in PSRAM
33+
=============== ========================
34+
35+
To apply a board variant, use the ``-S`` flag with west build:
36+
37+
.. zephyr-app-commands::
38+
:tool: west
39+
:zephyr-app: samples/hello_world
40+
:board: <esp_board_name_qualifier>
41+
:goals: build
42+
:west-args: -S flash-32M -S psram-4M
43+
:compact:
44+
45+
**Note:** These snippets are applicable to boards with compatible hardware support for the selected flash/PSRAM configuration.

‎boards/espressif/esp32_devkitc/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,9 @@ message in the monitor:
190190
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
191191
Hello World! esp32_devkitc
192192
193+
.. include:: ../../../espressif/common/board-variants.rst
194+
:start-after: espressif-board-variants
195+
193196
Debugging
194197
*********
195198

‎boards/espressif/esp32_ethernet_kit/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,9 @@ message in the monitor:
551551
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
552552
Hello World! esp32_ethernet_kit
553553
554+
.. include:: ../../../espressif/common/board-variants.rst
555+
:start-after: espressif-board-variants
556+
554557
Debugging
555558
*********
556559

‎boards/espressif/esp32c3_devkitc/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,9 @@ message in the monitor:
182182
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
183183
Hello World! esp32c3_devkitc
184184
185+
.. include:: ../../../espressif/common/board-variants.rst
186+
:start-after: espressif-board-variants
187+
185188
Debugging
186189
*********
187190

‎boards/espressif/esp32c3_devkitm/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,9 @@ message in the monitor:
182182
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
183183
Hello World! esp32c3_devkitm
184184
185+
.. include:: ../../../espressif/common/board-variants.rst
186+
:start-after: espressif-board-variants
187+
185188
Debugging
186189
*********
187190

‎boards/espressif/esp32c3_rust/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,9 @@ message in the monitor:
227227
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
228228
Hello World! esp32c3_rust
229229
230+
.. include:: ../../../espressif/common/board-variants.rst
231+
:start-after: espressif-board-variants
232+
230233
Debugging
231234
*********
232235

‎boards/espressif/esp32c6_devkitc/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,9 @@ message in the monitor:
224224
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
225225
Hello World! esp32c6_devkitc/esp32c6/hpcore
226226
227+
.. include:: ../../../espressif/common/board-variants.rst
228+
:start-after: espressif-board-variants
229+
227230
Debugging
228231
*********
229232

‎boards/espressif/esp32s2_devkitc/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,9 @@ message in the monitor:
181181
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
182182
Hello World! esp32s2_devkitc
183183
184+
.. include:: ../../../espressif/common/board-variants.rst
185+
:start-after: espressif-board-variants
186+
184187
Debugging
185188
*********
186189

‎boards/espressif/esp32s2_saola/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,9 @@ message in the monitor:
181181
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
182182
Hello World! esp32s2_saola
183183
184+
.. include:: ../../../espressif/common/board-variants.rst
185+
:start-after: espressif-board-variants
186+
184187
Debugging
185188
*********
186189

‎boards/espressif/esp32s3_devkitc/doc/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,9 @@ message in the monitor:
218218
***** Booting Zephyr OS vx.x.x-xxx-gxxxxxxxxxxxx *****
219219
Hello World! esp32s3_devkitc
220220
221+
.. include:: ../../../espressif/common/board-variants.rst
222+
:start-after: espressif-board-variants
223+
221224
Debugging
222225
*********
223226

0 commit comments

Comments
 (0)