aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGareth McMullin2011-02-09 16:56:42 +1300
committerGareth McMullin2011-02-09 16:56:42 +1300
commitd1cf80db33340b7004c02b37148127b8b58c687c (patch)
treea7cee0688355fd8f5649d5a9120071f6de9804ac /README
parent4b105beb616a84c8a548287201dce11f0b191e72 (diff)
Updated README, added HACKING.
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
index b91903f..76ada7b 100644
--- a/README
+++ b/README
@@ -13,6 +13,31 @@ Currently supported microcontrollers:
- ST STM32 Family
- TI/LMI Stellaris Family
+
+Getting started
+===============
+The Black Magic Probe is available as a built-up product form Black
+Sphere Technologies. Contact <sales@blacksphere.co.nz> should
+you wish to order one. If you would like to work on the project see
+the file HACKING for developer's info.
+
+When connected via USB, the Black Magic probe will enumerate as a CDC-ACM
+device which the OS should present as a tty device or serial port. The
+GDB remote debugging protocol is implemented over this virtual character
+stream. To connect your ARM GDB to the target device use the following
+commands:
+
+(gdb) target extended-remote /dev/ttyACM0
+(gdb) mon jtag_scan
+(gdb) attach 1
+
+The command 'mon swdp_scan' may be used to use the Serial-Wire Debug Protocol
+instead of JTAG to connect to the target.
+
+Once attached, all the standard GDB commands may be used to start and control
+the execution of the embedded application.
+
+
Project layout
==============
flashstub/ - Source code for flash programming stubs in target drivers.