Docs/platforms/espressif: Add UF2 file format docs

Add UF2 file format docs for RISC-V based Espressif devices

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
This commit is contained in:
Eren Terzioglu
2026-01-05 12:47:14 +01:00
committed by Matteo Golin
parent a8a3e36adf
commit 328ffdb297
3 changed files with 18 additions and 0 deletions
@@ -131,6 +131,12 @@ where:
* ``ESPTOOL_BINDIR=./`` is the path of the externally-built 2nd stage bootloader and the partition table (if applicable): when built using the ``make bootloader``, these files are placed into ``nuttx`` folder.
* ``ESPTOOL_BAUD`` is able to change the flash baud rate if desired.
To create and flash with UF2 (USB Flashing Format) binary, ``UF2=1`` option needs to be set during build phase
(e.g ``make UF2=1 -j8``). This flag will create UF2 format file addition to binary. This output can be used to
flash the device with `ESP USB Bridge <https://github.com/espressif/esp-usb-bridge>`__.
To flash using ESP USB Bridge, either drag and drop the generated UF2 file onto the flasher's
mass storage device, or use the ``UF2=1`` flag during flashing (e.g. ``make flash ESPTOOL_PORT=<port> ESPTOOL_BINDIR=./ UF2=1``)
Flashing NSH Example
--------------------
@@ -131,6 +131,12 @@ where:
* ``ESPTOOL_BINDIR=./`` is the path of the externally-built 2nd stage bootloader and the partition table (if applicable): when built using the ``make bootloader``, these files are placed into ``nuttx`` folder.
* ``ESPTOOL_BAUD`` is able to change the flash baud rate if desired.
To create and flash with UF2 (USB Flashing Format) binary, ``UF2=1`` option needs to be set during build phase
(e.g ``make UF2=1 -j8``). This flag will create UF2 format file addition to binary. This output can be used to
flash the device with `ESP USB Bridge <https://github.com/espressif/esp-usb-bridge>`__.
To flash using ESP USB Bridge, either drag and drop the generated UF2 file onto the flasher's
mass storage device, or use the ``UF2=1`` flag during flashing (e.g. ``make flash ESPTOOL_PORT=<port> ESPTOOL_BINDIR=./ UF2=1``)
Flashing NSH Example
--------------------
@@ -131,6 +131,12 @@ where:
* ``ESPTOOL_BINDIR=./`` is the path of the externally-built 2nd stage bootloader and the partition table (if applicable): when built using the ``make bootloader``, these files are placed into ``nuttx`` folder.
* ``ESPTOOL_BAUD`` is able to change the flash baud rate if desired.
To create and flash with UF2 (USB Flashing Format) binary, ``UF2=1`` option needs to be set during build phase
(e.g ``make UF2=1 -j8``). This flag will create UF2 format file addition to binary. This output can be used to
flash the device with `ESP USB Bridge <https://github.com/espressif/esp-usb-bridge>`__.
To flash using ESP USB Bridge, either drag and drop the generated UF2 file onto the flasher's
mass storage device, or use the ``UF2=1`` flag during flashing (e.g. ``make flash ESPTOOL_PORT=<port> ESPTOOL_BINDIR=./ UF2=1``)
Flashing NSH Example
--------------------