]> git.gag.com Git - fw/openocd/blobdiff - doc/openocd.1
- documentation fixes (thanks to Uwe Hermann)
[fw/openocd] / doc / openocd.1
index d3135300ddf940f1f80c5710769f8d2139299cf6..b747c6d0a05c2d17caa228fa69f48292e5b3aa6f 100644 (file)
@@ -1,7 +1,7 @@
-.TH "OPENOCD" "1" "May 03, 2007" "" ""
+.TH "OPENOCD" "1" "July 26, 2007" "" ""
 .SH "NAME"
 openocd \- A free and open on\-chip debugging, in\-system programming and
-boundary\-scan testing tool for ARM systems (currently ARM7/9 and XScale, Cortex\-M3 support to be merged)
+boundary\-scan testing tool for ARM systems (currently ARM7/9, XScale, and Cortex\-M3)
 .SH "SYNOPSIS"
 .B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR <filename>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-help]
 .SH "DESCRIPTION"
@@ -10,14 +10,20 @@ is an on\-chip debugging, in\-system programming and boundary\-scan
 testing tool for ARM systems.
 .PP 
 The debugger uses an IEEE 1149\-1 compliant JTAG TAP bus master to access
-on\-chip debug functionality available on ARM7/9 and XScale based
+on\-chip debug functionality available on ARM7/9, XScale, and Cortex-M3 based
 microcontrollers / system\-on\-chip solutions.
 .PP 
 User interaction is realized through a telnet command line interface and
 a gdb (the GNU debugger) remote protocol server.
 .PP 
 OpenOCD supports various different types of JTAG interfaces/programmers:
-  * Parallel port wigglers
+  * Parallel port wigglers, e.g.
+    * Macraigor Wiggler JTAG cable
+    * Gateworks GW16012 JTAG programmer
+    * Xilinx DLC5 JTAG parallel cable III
+    * Ka-Ro TRITON starterkit II JTAG cable
+    * Lattice parallel port JTAG cable
+    * ST FlashLINK programming cable
   * Amontec JTAG Accelerator
   * FTDI FT2232 based USB devices
   * USBJTAG
@@ -26,7 +32,12 @@ OpenOCD supports various different types of JTAG interfaces/programmers:
   * Amontec JTAGkey\-Tiny
   * Olimex ARM\-USB\-OCD
   * eVerve Signalyzer
-  * ... other FT2232 based dongles
+  * American Microsystem M5960
+  * Turtelizer 2
+  * Hitex STR9-comSTICK
+  * Luminary Micro evb_lm3s811
+  * ASIX PRESTO
+  * usbprog
 .PP 
 It also supports a number of different ARM7/9 cores:
   * ARM7TDMI(\-s)
@@ -36,13 +47,12 @@ It also supports a number of different ARM7/9 cores:
   * ARM922t
   * ARM926ej\-s
   * ARM966e
+  * Cortex-M3
 .PP 
 Support for Intel XScale CPUs is also included:
   * PXA25x
+  * PXA27x
   * IXP42x
-
-PXA27x debugging should be similar to the PXA25x but fails in the current
-version of OpenOCD.
 .SH "OPTIONS"
 .TP 
 .B "\-f, \-\-file <filename>"
@@ -87,7 +97,7 @@ or on the mailing list
 is covered by the GNU General Public License (GPL), version 2 or later.
 .\"
 .SH "SEE ALSO"
-
+.BR jtag (1)
 .SH "AUTHORS"
 Dominic Rath <Dominic.Rath@gmx.de>
 .br