Skip to content

Latest commit

 

History

History
167 lines (129 loc) · 8.66 KB

index.md

File metadata and controls

167 lines (129 loc) · 8.66 KB
Raw
:hidden:
:maxdepth: 1
:caption: Intro

hardware
getting-started
upgrade
supported-targets

:hidden:
:maxdepth: 1
:caption: Knowledgebase

knowledge/faq
knowledge/terminology
knowledge/pinouts
knowledge/compiling-windows
knowledge/links

:hidden:
:maxdepth: 1
:caption: Usage

usage/gdb-commands
usage/gdb-automation
usage/semihosting
usage/traceswo
usage/swo
usage/rtt
usage/platformio
usage/stm32cubeide

:hidden:
:maxdepth: 1
:caption: Target Specific Usage

target-usage/stm32
target-usage/sam3x-4x-x7x

:hidden:
:maxdepth: 1
:caption: Hacking

hacking/contrib
hacking/hacking
hacking/target-drivers
hacking/target-cortex-m
hacking/target-cortex-a
hacking/target-mm32
hacking/target-clock-generation

Black Magic Debug: The Plug&Play MCU Debugger

Black Magic Debug Project Goals

The goal of this project is the creation of an easy to use, mostly plug-and-play, JTAG/SWD debugger for embedded microcontrollers. The project focuses on professional embedded software developers that prefer retaining control over their build systems and testing environments instead of relying on highly abstracted vendor tools that give the impression of simplicity at the cost of transparency.

Project News

What is Black Magic Debug

In most cases Black Magic Debug takes the form of a firmware for the Black Magic Probe hardware, and implements a GNU DeBugger (GDB) server.

The Black Magic GDB server features:

  • Automatic target detection
  • No need for target specific configuration scripts
  • All protocol and target specific control is done through GDB monitor commands
  • No "software in the middle" like OpenOCD required
  • Easily scriptable thanks to the GDB scripting capabilities
  • Interface to the host computer is a standard USB CDC ACM device (virtual serial port), which does not require special drivers on Linux or macOS.
  • Targets ARM Cortex-M and Cortex-A based microcontrollers
  • Provides full debugging functionality, including: watchpoints, flash memory breakpoints, memory and register examination, flash memory programming, etc.
  • [Semihosting / Host IO support] as well as [Serial Wire Debug TRACESWO support].
  • Implements USB DFU class for easy firmware upgrade as updates become available.
  • Works with Windows, Linux and Mac environments.

All you need is to install the GNU cross compilation toolchain, containing GCC and GDB for your microcontroller. Plug the Black Magic Probe hardware, running the Black Magic Debug firmware, into your computer. Instruct your GDB to use the BMP as your remote target using the target extended-remote *serial_port* command and you are off to the races. Further details are found in Getting Started.

If you are an embedded development beginner Black Magic Probe is also a great choice for you. But expect more of a Unix command line experience than a Windows klickybunti GUI.

If anything is unclear or hard to understand let us know. Our goal is to make the documentation on this website comprehensive enough that it is all you need to get started with microcontroller development and debugging using the Black Magic Probe.

Supported Targets

Quick Demo

Here is a quick example of a GDB session using the Black Magic Probe.

:preload: 1
:font-size: 15px
:theme: monokai

The session goes through the following steps:

  • Connecting to BMP -> target extended-remote <serial port>
  • Scanning for targets using SWD -> monitor swdp_scan
  • Attaching to the detected target -> attach 1
  • Loading the project binary -> load
  • Starting the firmware with a breakpoint set to the start of the main function -> start
  • Stepping over the main function -> next,[enter,...]
  • Continuing execution -> continue
  • Breaking and detaching from the target -> CTRL-C, CTRL-D

Support the Project

The best way to support the project is purchasing the official Black Magic Probe hardware. If you would like to support the project beyond that please consider supporting these individuals and organizations:

Getting Hardware

The official Black Magic Probe hardware was specifically designed with Black Magic Debug in mind and the proceeds from the sales directly support and further the development of the software. See the Support the Project section for other means of sponsoring the development of Black Magic Debug.

The official Black Magic Probe hardware is available from these distributors in alphabetical order:

  • DE: 1BitSquared Germany Black Magic Probe V2.3 (Multiple accessory options) (Newest)
  • USA: 1BitSquared US Black Magic Probe V2.3 (Multiple accessory options) (Newest)
  • USA: Adafruit Industries Black Magic Probe V2.3 (With JTAG/SWD and UART cables) (Newest)
  • NL: Elektor Black Magic Probe V2.3 (With JTAG/SWD and UART cables and 7Pin Adapter) (Newest)
  • USA: Mouser Black Magic Probe V2.3 (With JTAG/SWD and UART cables) (Newest)

Other Hardware supported by Black Magic Debug:

Black Magic Debug App (BMDA)

You can also compile the Black Magic Debug as a stand alone application instead of a firmware that you can flash onto a microcontroller. This mode resembles the way OpenOCD is used as an "application in the middle". Please find more details on the hardware page.

Contact:

  • If you have questions or suggestions feel free to join us in our chat Discord