You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
SId Price cf2bd66a62 Add required quotes to st-link udev rules 2 months ago
.github workflows: add size diff workflow 3 months ago
.vscode misc: Added recomendations for VSCode extensions to be used with the project 5 months ago
contrib/zsh hosted: Documented the new command line option and added it to the ZSH completions 5 months ago
driver Add required quotes to st-link udev rules 2 months ago
libopencm3@44e142d4f9 misc: Switched to using C11 5 months ago
scripts workflows: add size diff workflow 3 months ago
src stm32f4: fix wrong idcode when probing (#1242) 2 months ago
upgrade misc: Cleanup include guards. 3 months ago
.clang-format misc: Removed the executable bit from the clang-format configuration 4 months ago
.clang-tidy misc: Made an exception in the clang-tidy config for memcpy/memmove/etc 5 months ago
.gitattributes gitattributes: add attributes file 2 years ago
.gitignore Move all files from "pc" folder to "hosted", update Makefile.inc 5 months ago
.gitmodules Changed libopencm3 url to https. 10 years ago
CODE_OF_CONDUCT.md misc: Added a code of conduct based on the Contributors Covenant 5 months ago
CONTRIBUTING.md misc: Added advice on how contribution licensing should be done and works 3 months ago
COPYING Added README and COPYING 12 years ago
COPYING-BSD misc: Added a license file for BSD-3-Clause that covers the SFDP code and any other additions made under that license 4 months ago
COPYING-MIT misc: Added a file with the MIT license as stm32g0.c is licensed under MIT 4 months ago
Makefile misc: Added a clang-tidy Makefile target so enforcing the formatting is easier 5 months ago
README.md misc: change old wiki links to point to website instead 4 months ago
UsingRTT.md rtt: Cleaned up updated and improved the RTT usage documentation. 3 months ago
UsingSWO.md swo-docs: Converted to markdown and cleaned up a bit. 3 months ago
shell.nix add blackmagic package itself 6 months ago

README.md

Black Magic Probe

Discord

Firmware for the Black Magic Debug Probe.

The Black Magic Probe is a modern, in-application debugging tool for embedded microprocessors. It allows you see what is going on 'inside' an application running on an embedded microprocessor while it executes. It is able to control and examine the state of the target microprocessor using a JTAG or Serial Wire Debugging (SWD) port and on-chip debug logic provided by the microprocessor. The probe connects to a host computer using a standard USB interface. The user is able to control exactly what happens using the GNU source level debugging software, GDB. Serial Wire Output (SWO) allows the target to write tracing and logging to the host without using usb or serial port. Decoding SWO in the probe itself makes SWO viewing as simple as connecting to a serial port.

Resources

Toolchain specific remarks

Building the firmware is done with the most recent toolchain available from ARM's GNU-RM toolchains. If you have a toolchain from other sources and find problems, check if it is a failure of your toolchain and if not open an issue or better provide a pull request with a fix.

OS specific remarks for BMP-Hosted

Most hosted building is done on and for Linux. BMP-hosted for windows can also be build with Mingw on Linux.

Building hosted for BMP firmware probes only with "make PROBE_HOST=hosted HOSTED_BMP_ONLY=1" does not require libusb, libftdi and evt. libhidapi development headers and libraries for running.

On BSD/Macos, using dev/tty.usbmodemXXX should work but unresolved discussions indicate a hanging open() call on the second invocation. If that happens, try with cu.usbmodemXXX.

Reporting problems

Before reporting issues, check against the latest git version. If possible, test against another target /and/or debug probe. Consider broken USB cables and connectors. Try to reproduce with bmp-hosted with at least debug bit 1 set (blackmagic -v 1 ...), as debug messages will be dumped to the starting console. When reporting issues, be as specific as possible!

Sample Session

> arm-none-eabi-gdb gpio.elf
...<GDB Copyright message>
(gdb) tar ext /dev/ttyACM0
Remote debugging using /dev/ttyACM0
(gdb) mon s
Target voltage: 2.94V
Available Targets:
No. Att Driver
 1      STM32F40x M3/M4
(gdb) att 1
Attaching to program: /devel/en_apps/gpio/f4_discovery/gpio.elf, Remote target
0x08002298 in UsartIOCtl ()
(gdb) load
Loading section .text, size 0x5868 lma 0x8000000
Loading section .data, size 0x9e0 lma 0x8005868
Loading section .rodata, size 0x254 lma 0x8006248
Start address 0x800007c, load size 25756
Transfer rate: 31 KB/sec, 919 bytes/write.
(gdb) b main
Breakpoint 1 at 0x80000e8: file /devel/en_apps/gpio/f4_discovery/../gpio.c, line 70.
(gdb) r
Starting program: /devel/en_apps/gpio/f4_discovery/gpio.elf
Note: automatically using hardware breakpoints for read-only addresses.

Breakpoint 1, main () at /devel/en_apps/gpio/f4_discovery/../gpio.c:70
70      {

Black Magic Debug App

You can also build the Black Magic Debug suite as a PC program called Black Magic Debug App by running make PROBE_HOST=hosted

This builds the same GDB server that is running on the Black Magic Probe. While connection to the Black Magic Probe GDB server is via serial line, connection to the Black Magic Debug App is via TCP port 2000 for the first GDB server and higher for more invokations. Use "tar(get) ext(ented) :2000" to connect.

Black Magic Debug App can talk to

  • Black Magic Probe firmware probes via the USB-serial port
  • ST-LinkV2 and V3 with recent firmware
  • CMSIS-DAP compatible probes
  • JLINK probes
  • FTDI MPSSE based probe.

When connected to a single BMP supported probe, starting "blackmagic" w/o any arguments starts the server. When several BMP supported probes are connected, their types, position and serial number is displayed and the program exits. Add "-P (position)" to the next invocation to select one. For the setup from the sample session above:

In another terminal:

> blackmagic
Black Magic Debug App v1.8.0
 for Black Magic Probe, ST-Link v2 and v3, CMSIS-DAP, JLink and libftdi/MPSSE
Using 1d50:6018 8BB20A03 Black Magic Debug
 Black Magic Probe  v1.8.0
Listening on TCP: 2000

And in the GDB terminal:

(gdb) tar ext :2000
Remote debugging using :2000
(gdb) mon s
...

Black Magic Debug App also provides for Flashing, reading and verification of a binary file, by default starting at lowest flash address. The -t argument displays information about the connected target. Use -h/--help to get a list of supported options.