From 53d1f9b2ca5718e4996e9cf3406f857d0ed26df2 Mon Sep 17 00:00:00 2001 From: drath Date: Thu, 14 Jun 2007 09:47:00 +0000 Subject: - added manpage for OpenOCD (thanks to Uwe Hermann) - fixed bug in ARM926EJ-S cache handling that caused cache linefills to be disabled after first debug entry - added support for auto image type detection (thanks to Vincent Palatin) - further work on ETM trace decoding (tested with a ETB interface using an ETM in normal 16-bit port mode, still experimental) git-svn-id: svn://svn.berlios.de/openocd/trunk@169 b42882b7-edfa-0310-969c-e2dbd0fdcd60 --- doc/openocd.1 | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 doc/openocd.1 (limited to 'doc/openocd.1') diff --git a/doc/openocd.1 b/doc/openocd.1 new file mode 100644 index 00000000..d3135300 --- /dev/null +++ b/doc/openocd.1 @@ -0,0 +1,103 @@ +.TH "OPENOCD" "1" "May 03, 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) +.SH "SYNOPSIS" +.B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR ] [\fB\-\-debug\fR ] [\fB\-\-log_output\fR ] [\fB\-\-help] +.SH "DESCRIPTION" +.B OpenOCD +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 +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 + * Amontec JTAG Accelerator + * FTDI FT2232 based USB devices + * USBJTAG + * OOCD\-Link + * Amontec JTAGkey + * Amontec JTAGkey\-Tiny + * Olimex ARM\-USB\-OCD + * eVerve Signalyzer + * ... other FT2232 based dongles +.PP +It also supports a number of different ARM7/9 cores: + * ARM7TDMI(\-s) + * ARM720t + * ARM9TDMI + * ARM920t + * ARM922t + * ARM926ej\-s + * ARM966e +.PP +Support for Intel XScale CPUs is also included: + * PXA25x + * IXP42x + +PXA27x debugging should be similar to the PXA25x but fails in the current +version of OpenOCD. +.SH "OPTIONS" +.TP +.B "\-f, \-\-file " +Use configuration file +.BR . +If this option is omitted, the config file +.B openocd.cfg +in the current working directory will be used. +.TP +.B "\-d, \-\-debug " +Set debug level. Possible values are: +.br +.RB " * " 0 " (errors)" +.br +.RB " * " 1 " (warnings)" +.br +.RB " * " 2 " (informational messages)" +.br +.RB " * " 3 " (debug messages)" +.br +The default level is +.BR 2 . +.TP +.B "\-l, \-\-log_output " +Redirect log output to the file +.BR . +Per default the log output is printed on +.BR stderr . +.TP +.B "\-h, \-\-help" +Show a help text and exit. +.\".TP +.\".B "\-v, \-\-version" +.\"Show version information and exit. +.SH "BUGS" +Please report any bugs at +.B http://developer.berlios.de/bugs/?group_id=4148 +or on the mailing list +.BR openocd\-development@lists.berlios.de . +.SH "LICENCE" +.B OpenOCD +is covered by the GNU General Public License (GPL), version 2 or later. +.\" +.SH "SEE ALSO" + +.SH "AUTHORS" +Dominic Rath +.br +Magnus Lundin +.br +Michael Fischer +.br +Spencer Oliver +.br +and others +.PP +This manual page was written by Uwe Hermann . +It is licensed under the terms of the GNU GPL (v2 or later). -- cgit v1.2.3