Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
The Black Magic Probe consists of both hardware and firmware components. Both are under open-source licenses and available on Github.
- Firmware: https://github.com/blacksphere/blackmagic (GPLv3)
- Hardware: https://github.com/blacksphere/blackmagic-hardware (CC-BY-SA)
Getting the project source
The project resides in a GitHub git repository
Clone this repository (or fork and clone) using your desired method. Typically:
git clone https://github.com/blacksphere/blackmagic.git
The project uses libopencm3, which is included as a git submodule. Thus, prior to building the project, one must initialize this submodule:
cd /path/to/blackmagic git submodule init git submodule update
Compiling for the native hardware
To build the firmware for the standard hardware platform run
make in the
top-level directory. You will require a GCC cross compiler for ARM Cortex-M3
targets. A good option is gcc-arm-embedded.
The default makefile assumes the target prefix is
arm-none-eabi-, but you can override this
on the command line:
This will result in binary files:
blackmagic - ELF binary of the Black Magic debug probe.
blackmagic.bin - Flat binary of the Black Magic debug probe, load at
blackmagic_dfu - ELF binary of the Black Magic DFU bootloader.
blackmagic_dfu.bin - Flat binary of the DFU bootloader, load at
A number of users have contributed alternative hardware designs that are compatible with the native firmware. Some of these designs are in the hardware repo. Check the README files for details.
There have also been efforts to port the firmware to other hardware platforms, most notably the ST-Link and discovery boards, as these are very cheap and common. See this tutorial.
Building on Windows
Sid Price wrote a detailed step by step guide describing how to set up CygWin and compile the Black Magic Probe firmware.
Compiling as a PC application using FT2232 hardware
The Black Magic application can also be compiled as a native PC application which will use an FT2232 device to implement the physical JTAG interface. This is not the intended mode of operation, but is useful for debugging, experimentation, and if you don't have the actual hardware. Pending patches (May 2018) bring programming speed for MPSSE FTDI devices to similar speed as the original BMP.
Compile the application with the command:
Running the application
blackmagic -c <cable> will start a GDB server on TCP port 2000.
<cable> is a string identifier for your particular FTDI JTAG cable. See src/platforms/libftdi/platform.c for valid options.
Enabling DEBUG() messages
First compile in the debug messages when building the firmware:
Then enable debug messages in gdb with the new command
monitor debug_bmp enable
The debug messages appear on the debug UART. On a BMP the USB UART device is used.
screen /dev/ttyACM2 115200