Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Docs/platforms/xtensa: Add UF2 file format docs

Browse source 
Add UF2 file format docs for Xtensa based Espressif devices

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
This commit is contained in:
Eren Terzioglu 2026-01-05 12:46:49 +01:00 • committed by Matteo Golin
parent be257fb910
commit a8a3e36adf
3 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Documentation/platforms/xtensa/esp32/index.rst
View file

@ -148,6 +148,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
--------------------

6
Documentation/platforms/xtensa/esp32s2/index.rst
View file

@ -141,6 +141,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
--------------------

6
Documentation/platforms/xtensa/esp32s3/index.rst
View file

@ -149,6 +149,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
--------------------