This is an automated email from the ASF dual-hosted git repository. linguini1 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit a8a3e36adf7e4fd46c868543ccf5828914ad2abc Author: Eren Terzioglu <[email protected]> AuthorDate: Mon Jan 5 12:46:49 2026 +0100 Docs/platforms/xtensa: Add UF2 file format docs Add UF2 file format docs for Xtensa based Espressif devices Signed-off-by: Eren Terzioglu <[email protected]> --- Documentation/platforms/xtensa/esp32/index.rst | 6 ++++++ Documentation/platforms/xtensa/esp32s2/index.rst | 6 ++++++ Documentation/platforms/xtensa/esp32s3/index.rst | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/Documentation/platforms/xtensa/esp32/index.rst b/Documentation/platforms/xtensa/esp32/index.rst index 314c1974dfd..7af5670f0f1 100644 --- a/Documentation/platforms/xtensa/esp32/index.rst +++ b/Documentation/platforms/xtensa/esp32/index.rst @@ -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 -------------------- diff --git a/Documentation/platforms/xtensa/esp32s2/index.rst b/Documentation/platforms/xtensa/esp32s2/index.rst index 1b34b843577..168fe8fcdb6 100644 --- a/Documentation/platforms/xtensa/esp32s2/index.rst +++ b/Documentation/platforms/xtensa/esp32s2/index.rst @@ -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 -------------------- diff --git a/Documentation/platforms/xtensa/esp32s3/index.rst b/Documentation/platforms/xtensa/esp32s3/index.rst index a58c085dac6..8b5f81f1c77 100644 --- a/Documentation/platforms/xtensa/esp32s3/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/index.rst @@ -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 --------------------
