aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGareth McMullin2013-03-17 10:33:19 +1300
committerGareth McMullin2013-03-17 10:33:19 +1300
commit2465846c0df07e8919f660c3ffdaf37662aa5a8c (patch)
tree4a82749ed9d9f9d214e8e2c72f06047d0d5a2a15 /README
parent44a03f31e12da9e5fae9057db17177be920025f2 (diff)
Updated project README.
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 9 insertions, 4 deletions
diff --git a/README b/README
index 1bef2e6..52835f9 100644
--- a/README
+++ b/README
@@ -3,16 +3,17 @@ The Black Magic Debug Project -- README
=======================================
The Black Magic Debug Probe is gadget providing an in-application
-debug capability for ARM Cortex-M3 and Cortex-M0 microcontrollers. It
-interfaces with the GDB, the GNU source level debugger over the USB
-bus, and communicates with the target microcontroller over either a
-JTAG or Serial Wire debug port.
+debug capability for ARM Cortex-M microcontrollers. It interfaces
+with the GDB, the GNU source level debugger over the USB bus, and
+communicates with the target microcontroller over either a JTAG or
+Serial Wire debug port.
Currently supported microcontrollers:
- ST STM32 Family
- TI/LMI Stellaris Family
- NXP LPC11xx Family
+ - Atmel SAM3X
Getting started
@@ -46,8 +47,12 @@ RAM.
Project layout
==============
+driver/ - Windows drivers for the Black Magic probe hardware.
flashstub/ - Source code for flash programming stubs in target drivers.
hardware/ - Schematic (gschem) and PCB layout for the Black Magic Probe
+hardware/contrib/ - User contributed hardware variants.
+libopencm3/ - Submodule for the libopencm3 library needed for stm32 platforms.
scripts/ - Python scripts useful for programming devices.
src/ - Firmware source code for the Black Magic debug probe.
+upgrade/ - Alternate firmware upgrade tool written in C.