git.sur5r.net Git - openocd/blob - doc/openocd.1

   1 .TH "OPENOCD" "1" "May 03, 2007" "" ""
   2 .SH "NAME"
   3 openocd \- A free and open on\-chip debugging, in\-system programming and
   4 boundary\-scan testing tool for ARM systems (currently ARM7/9 and XScale, Cortex\-M3 support to be merged)
   5 .SH "SYNOPSIS"
   6 .B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR <filename>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-help]
   7 .SH "DESCRIPTION"
   8 .B OpenOCD
   9 is an on\-chip debugging, in\-system programming and boundary\-scan
  10 testing tool for ARM systems.
  11 .PP
  12 The debugger uses an IEEE 1149\-1 compliant JTAG TAP bus master to access
  13 on\-chip debug functionality available on ARM7/9 and XScale based
  14 microcontrollers / system\-on\-chip solutions.
  15 .PP
  16 User interaction is realized through a telnet command line interface and
  17 a gdb (the GNU debugger) remote protocol server.
  18 .PP
  19 OpenOCD supports various different types of JTAG interfaces/programmers:
  20   * Parallel port wigglers
  21   * Amontec JTAG Accelerator
  22   * FTDI FT2232 based USB devices
  23   * USBJTAG
  24   * OOCD\-Link
  25   * Amontec JTAGkey
  26   * Amontec JTAGkey\-Tiny
  27   * Olimex ARM\-USB\-OCD
  28   * eVerve Signalyzer
  29   * ... other FT2232 based dongles
  30 .PP
  31 It also supports a number of different ARM7/9 cores:
  32   * ARM7TDMI(\-s)
  33   * ARM720t
  34   * ARM9TDMI
  35   * ARM920t
  36   * ARM922t
  37   * ARM926ej\-s
  38   * ARM966e
  39 .PP
  40 Support for Intel XScale CPUs is also included:
  41   * PXA25x
  42   * IXP42x
  43
  44 PXA27x debugging should be similar to the PXA25x but fails in the current
  45 version of OpenOCD.
  46 .SH "OPTIONS"
  47 .TP
  48 .B "\-f, \-\-file <filename>"
  49 Use configuration file
  50 .BR <filename> .
  51 If this option is omitted, the config file
  52 .B openocd.cfg
  53 in the current working directory will be used.
  54 .TP
  55 .B "\-d, \-\-debug <debuglevel>"
  56 Set debug level. Possible values are:
  57 .br
  58 .RB "  * " 0 " (errors)"
  59 .br
  60 .RB "  * " 1 " (warnings)"
  61 .br
  62 .RB "  * " 2 " (informational messages)"
  63 .br
  64 .RB "  * " 3 " (debug messages)"
  65 .br
  66 The default level is
  67 .BR 2 .
  68 .TP
  69 .B "\-l, \-\-log_output <filename>"
  70 Redirect log output to the file
  71 .BR <filename> .
  72 Per default the log output is printed on
  73 .BR stderr .
  74 .TP
  75 .B "\-h, \-\-help"
  76 Show a help text and exit.
  77 .\".TP
  78 .\".B "\-v, \-\-version"
  79 .\"Show version information and exit.
  80 .SH "BUGS"
  81 Please report any bugs at
  82 .B http://developer.berlios.de/bugs/?group_id=4148
  83 or on the mailing list
  84 .BR openocd\-development@lists.berlios.de .
  85 .SH "LICENCE"
  86 .B OpenOCD
  87 is covered by the GNU General Public License (GPL), version 2 or later.
  88 .\"
  89 .SH "SEE ALSO"
  90
  91 .SH "AUTHORS"
  92 Dominic Rath <Dominic.Rath@gmx.de>
  93 .br
  94 Magnus Lundin <lundin@mlu.mine.nu>
  95 .br
  96 Michael Fischer <fischermi@t\-online.de>
  97 .br
  98 Spencer Oliver <spen@spen\-soft.co.uk>
  99 .br
 100 and others
 101 .PP
 102 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
 103 It is licensed under the terms of the GNU GPL (v2 or later).