Skip to content

Commit 91f425d

Browse files
authored
Update README.md
1 parent bad14e9 commit 91f425d

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

‎README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
# Debugging, Tracing & Programming with the Black Magic Probe
2-
This guide covers setting up and using the [Black Magic Probe](https://github.com/blacksphere/blackmagic). The Black Magic Probe is a relatively cheap JTAG/SWD probe for ARM Cortex micro-controllers. A distinguishing feature of the Black Magic Probe is that it embeds a GDB server. As a result, the GNU Debugger can directly connect to the Black Magic Probe.
1+
# Embedded Debugging with the Black Magic Probe
2+
<img src="https://github.com/compuphase/Black-Magic-Probe-Book/blob/master/doc/BlackMagicProbe-front-cover.jpg" alt="Book cover" width="400" align="right">
3+
This guide covers setting up and using the [Black Magic Probe](https://github.com/blacksphere/blackmagic). The Black Magic Probe is a relatively cheap JTAG/SWD probe for ARM Cortex micro-controllers. A distinguishing feature of the Black Magic Probe is that it embeds a GDB server. As a result, the GNU Debugger can directly connect to the Black Magic Probe.<br>
34

45
While setting up and using the Black Magic Probe has also been covered in wikis and blogs, I found that those description often only scratched the surface of the subject. With this guide, I set out to give a more comprehensive account. Later, I also added specific notes on [ctxLink](http://www.sidprice.com/ctxlink/), a derivative of the Black Magic Probe that offers a WiFi connection.
56
## Utilities
67
Several utilities accompagny this guide. Some are small, such as `bmscan` to locate the (virtual) serial port at which the Black Magic Probe is found (or scans the local network for ctxLink). Another is a helper tool for a specific family of micro-controllers (`elf-postlink`). There are GUI utilities and text-mode utilities. All have been tested under Microsoft Windows and Linux.
8+
9+
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).
710
## Building the software
811
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`.
912

0 commit comments

Comments
 (0)