git.gag.com Git - fw/openocd/blob - doc/openocd.1

   1 .TH "OPENOCD" "1" "July 26, 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, XScale, and Cortex\-M3)
   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, XScale, and Cortex-M3 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, e.g.
  21     * Macraigor Wiggler JTAG cable
  22     * Gateworks GW16012 JTAG programmer
  23     * Xilinx DLC5 JTAG parallel cable III
  24     * Ka-Ro TRITON starterkit II JTAG cable
  25     * Lattice parallel port JTAG cable
  26     * ST FlashLINK programming cable
  27   * Amontec JTAG Accelerator
  28   * FTDI FT2232 based USB devices
  29   * USBJTAG
  30   * OOCD\-Link
  31   * Amontec JTAGkey
  32   * Amontec JTAGkey\-Tiny
  33   * Olimex ARM\-USB\-OCD
  34   * eVerve Signalyzer
  35   * American Microsystem M5960
  36   * Turtelizer 2
  37   * Hitex STR9-comSTICK
  38   * Luminary Micro evb_lm3s811
  39   * ASIX PRESTO
  40   * usbprog
  41 .PP
  42 It also supports a number of different ARM7/9 cores:
  43   * ARM7TDMI(\-s)
  44   * ARM720t
  45   * ARM9TDMI
  46   * ARM920t
  47   * ARM922t
  48   * ARM926ej\-s
  49   * ARM966e
  50   * Cortex-M3
  51 .PP
  52 Support for Intel XScale CPUs is also included:
  53   * PXA25x
  54   * PXA27x
  55   * IXP42x
  56 .SH "OPTIONS"
  57 .TP
  58 .B "\-f, \-\-file <filename>"
  59 Use configuration file
  60 .BR <filename> .
  61 If this option is omitted, the config file
  62 .B openocd.cfg
  63 in the current working directory will be used.
  64 .TP
  65 .B "\-d, \-\-debug <debuglevel>"
  66 Set debug level. Possible values are:
  67 .br
  68 .RB "  * " 0 " (errors)"
  69 .br
  70 .RB "  * " 1 " (warnings)"
  71 .br
  72 .RB "  * " 2 " (informational messages)"
  73 .br
  74 .RB "  * " 3 " (debug messages)"
  75 .br
  76 The default level is
  77 .BR 2 .
  78 .TP
  79 .B "\-l, \-\-log_output <filename>"
  80 Redirect log output to the file
  81 .BR <filename> .
  82 Per default the log output is printed on
  83 .BR stderr .
  84 .TP
  85 .B "\-h, \-\-help"
  86 Show a help text and exit.
  87 .\".TP
  88 .\".B "\-v, \-\-version"
  89 .\"Show version information and exit.
  90 .SH "BUGS"
  91 Please report any bugs at
  92 .B http://developer.berlios.de/bugs/?group_id=4148
  93 or on the mailing list
  94 .BR openocd\-development@lists.berlios.de .
  95 .SH "LICENCE"
  96 .B OpenOCD
  97 is covered by the GNU General Public License (GPL), version 2 or later.
  98 .\"
  99 .SH "SEE ALSO"
 100 .BR jtag (1)
 101 .SH "AUTHORS"
 102 Dominic Rath <Dominic.Rath@gmx.de>
 103 .br
 104 Magnus Lundin <lundin@mlu.mine.nu>
 105 .br
 106 Michael Fischer <fischermi@t\-online.de>
 107 .br
 108 Spencer Oliver <spen@spen\-soft.co.uk>
 109 .br
 110 and others
 111 .PP
 112 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
 113 It is licensed under the terms of the GNU GPL (v2 or later).