michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: develop: flash_debug: Add descs about blackmagicprobe and uf2

Browse source 
Add description about blackmagicprobe(host-tools and probes) and
uf2(host-tools only).

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
Co-authored-by: Benjamin Cabé <kartben@gmail.com>
Co-authored-by: Andrew Featherstone <andrew.featherstone@gmail.com>
This commit is contained in:
TOKITA Hiroshi 2025-04-20 10:16:46 +09:00 • committed by Benjamin Cabé
commit aaa9d705a9
2 changed files with 57 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

38
doc/develop/flash_debug/host-tools.rst
View file

@ -12,6 +12,19 @@ hardware supports them and your Zephyr board directory's :file:`board.cmake`
file declares that support properly. See :ref:`west-build-flash-debug` for
more information on these commands.
.. _runner_blackmagicprobe:
Black Magic Probe
*****************
Black Magic Probe (BMP) is an open-source debugging hardware incorporating GDB debug
server functionality into the firmware.
There is no need for a GDB server program, so there is no program equivalent
to host-tool.
For more details, including usage instructions and supported targets,
see :ref:`black-magic-probe`.
.. _atmel_sam_ba_bootloader:
.. _runner_bossac:
@ -561,6 +574,28 @@ It can be used through the ``west flash`` command to flash Zephyr applications.
For advanced usage via the GUI or CLI, check out the `STM32CubeProgrammer User Manual`_.
.. _runner_uf2:
UF2 Uploader
************
The uf2 runner supports flashing some boards using the UF2 (USB Flashing Format).
UF2 is a user-friendly file format designed for drag-and-drop programming via a USB mass storage device.
It relies on the target device entering a special bootloader mode where it appears to the host
as a USB mass storage device.
Once in this mode, the application image can be uploaded by copying a ``.uf2`` file to the
mounted volume.
.. code-block:: console
west flash --runner uf2
If the UF2 volume is not automatically detected, you may need to manually specify the mount point
using the ``--device`` option:
For more about the UF2 format and its tooling, see `USB Flashing Format (UF2)`_.
.. _J-Link Software and Documentation Pack:
https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack
@ -632,3 +667,6 @@ For advanced usage via the GUI or CLI, check out the `STM32CubeProgrammer User M
.. _STLINK-V3PWR:
https://www.st.com/en/development-tools/stlink-v3pwr.html
.. _USB Flashing Format (UF2):
https://github.com/microsoft/uf2

19
doc/develop/flash_debug/probes.rst
View file

@ -488,6 +488,19 @@ NXP S32 Debug Probe is designed to work in conjunction with NXP S32 Design Studi
host tools as in indicated in :ref:`nxp-s32-debug-host-tools` before you program
the firmware.
.. _black-magic-probe:
Black Magic Probe
*****************
The Black Magic Probe is an open-source hardware for debugging that is designed
to be used with `Black Magic Debug`_ firmware.
The firmware incorporates GDB Server so that you can connect directly from ``gdb``
to the target device.
Some of the STM32F103-based boards can run the `Black Magic Debug`_ firmware.
See `Black Magic Debug supported hardware`_.
.. _LPCScrypt:
https://www.nxp.com/lpcscrypt
@ -526,3 +539,9 @@ the firmware.
.. _DAPLink Bootloader Update:
https://os.mbed.com/blog/entry/DAPLink-bootloader-update/
.. _Black Magic Debug:
https://black-magic.org/index.html
.. _Black Magic Debug supported hardware:
https://black-magic.org/hardware.html