From 335566eb4a35923a7b9f9acbb892dad19b01ebfd Mon Sep 17 00:00:00 2001 From: Thiadmer Riemersma Date: Thu, 22 Sep 2022 17:30:08 +0200 Subject: [PATCH] Update README.md Added a summary of the various utilities. --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f89b9ea..3d09d2f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,25 @@ Several utilities accompagny this guide. Some are small, such as `bmscan` to loc The software is licensed under the [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0). -For the purpose of troubleshooting, pre-build versions of the "hosted" variant of the Black Magic firmware are also available for Windows and Linux (see [Releases](https://github.com/compuphase/Black-Magic-Probe-Book/releases)). +A summary of the utilities: + + + + + + + + + + + + + + + + +
Icon bmdebug A front-end for GDB with specific support for the Black Magic Probe and debugging embedded targets.
Icon bmflash A utility to download firmware into the Flash memory of a microcontroller, with support for serialization.
Icon bmprofile A sampling profiler using the CoreSight debugging features and the TRACESWO channel.
Icon bmtrace A utility to monitor SWO trace messages, with support for filtering, multiple channels and the Common Trace Format.
bmscan A command-line utility to check the COM port (Windows) or ttyACM device (Linux) that the Black Magic Probe is attached to. It can locate the IP address of a ctxLink probe by doing a network scan.
elf‑postlink A utility to set the checksum in the vector table for NXP microcontrollers in the LPC series. As the name suggests, this utility can be run on an ELF file after the "link" stage.
tracegen A utility to generate C source files from a TSDL specification for the Common Trace Format.
+ ## Building the software Several makefiles are provided for various compilers. Use the one that is appropriate for your system. It is most convenient if you rename the correct makefile (for your system) to `Makefile`, so that you don't have to specify it on the command line each time you run `make`.