Skip to content

Commit 9c08484

Browse files
soburikartben
andcommitted
doc: develop: flash_debug: Add descs about blackmagicprobe and uf2
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>
1 parent 6463c68 commit 9c08484

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

doc/develop/flash_debug/host-tools.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ hardware supports them and your Zephyr board directory's :file:`board.cmake`
1212
file declares that support properly. See :ref:`west-build-flash-debug` for
1313
more information on these commands.
1414

15+
.. _runner_blackmagicprobe:
16+
17+
Black Magic Probe
18+
****************
19+
20+
Black Magic Probe (BMP) is an open-source debugging hardware incorporating GDB debug
21+
server functionality into the firmware.
22+
There is no need for a GDB server program, so there is no program equivalent
23+
to host-tool.
24+
25+
For more details, including usage instructions and supported targets,
26+
see :ref:`black-magic-probe`.
27+
1528
.. _atmel_sam_ba_bootloader:
1629
.. _runner_bossac:
1730

@@ -561,6 +574,28 @@ It can be used through the ``west flash`` command to flash Zephyr applications.
561574
562575
For advanced usage via the GUI or CLI, check out the `STM32CubeProgrammer User Manual`_.
563576

577+
.. _runner_uf2:
578+
579+
UF2 Uploader
580+
************
581+
582+
The uf2 runner supports flashing some boards using the UF2 (USB Flashing Format).
583+
UF2 is a user-friendly file format designed for drag-and-drop programming via a USB mass storage device.
584+
585+
It relies on the target device entering a special bootloader mode where it appears to the host
586+
as a USB mass storage device.
587+
Once in this mode, the application image can be uploaded by copying a ``.uf2`` file to the
588+
mounted volume.
589+
590+
.. code-block:: console
591+
592+
west flash --runner uf2
593+
594+
If the UF2 volume is not automatically detected, you may need to manually specify the mount point
595+
using the ``--device`` option:
596+
597+
For more about the UF2 format and its tooling, see `USB Flashing Format (UF2)`_.
598+
564599
.. _J-Link Software and Documentation Pack:
565600
https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack
566601

@@ -632,3 +667,6 @@ For advanced usage via the GUI or CLI, check out the `STM32CubeProgrammer User M
632667

633668
.. _STLINK-V3PWR:
634669
https://www.st.com/en/development-tools/stlink-v3pwr.html
670+
671+
.. _USB Flashing Format (UF2):
672+
https://github.com/microsoft/uf2

doc/develop/flash_debug/probes.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -488,6 +488,19 @@ NXP S32 Debug Probe is designed to work in conjunction with NXP S32 Design Studi
488488
host tools as in indicated in :ref:`nxp-s32-debug-host-tools` before you program
489489
the firmware.
490490

491+
.. _black-magic-probe:
492+
493+
Black Magic Probe
494+
*****************
495+
496+
The Black Magic Probe is an open-source hardware for debugging that is designed
497+
to be used with `Black Magic Debug`_ firmware.
498+
The firmware incorporates GDB Server so that you can connect directly from ``gdb``
499+
to the target device.
500+
501+
Some of the STM32F103-based boards can run the `Black Magic Debug`_ firmware.
502+
See `Black Magic Debug supported hardware`_.
503+
491504
.. _LPCScrypt:
492505
https://www.nxp.com/lpcscrypt
493506

@@ -526,3 +539,9 @@ the firmware.
526539

527540
.. _DAPLink Bootloader Update:
528541
https://os.mbed.com/blog/entry/DAPLink-bootloader-update/
542+
543+
.. _Black Magic Debug:
544+
https://black-magic.org/index.html
545+
546+
.. _Black Magic Debug supported hardware:
547+
https://black-magic.org/hardware.html

0 commit comments

Comments
 (0)