1OPENOCD(1) General Commands Manual OPENOCD(1)
2
6 openocd - A free and open on-chip debugging, in-system programming and
7 boundary-scan testing tool for ARM and MIPS systems
8
10 openocd [-fsdlcphv] [--file <filename>] [--search <dirname>] [--debug
11 <debuglevel>] [--log_output <filename>] [--command <cmd>] [--pipe]
12 [--help] [--version]
13
15 OpenOCD is an on-chip debugging, in-system programming and bound‐
16 ary-scan testing tool for various ARM and MIPS systems.
17 The debugger uses an IEEE 1149-1 compliant JTAG TAP bus master to
19 access on-chip debug functionality available on ARM based microcon‐
20 trollers or system-on-chip solutions. For MIPS systems the EJTAG inter‐
21 face is supported.
22 User interaction is realized through a telnet command line interface, a
24 gdb (the GNU debugger) remote protocol server, and a simplified RPC
25 connection that can be used to interface with OpenOCD's Jim Tcl engine.
26 OpenOCD supports various different types of JTAG interfaces/program‐
28 mers, please check the openocd info page for the complete list.
29
31 -f, --file <filename>
32 This is a shortcut for a -c "[script <filename>]" command, using
33 a search path to load the configuration file <filename>. In
34 order to specify multiple config files, you can use multiple
35 --file arguments. If no such -c options are included, the first
36 config file openocd.cfg in the search path will be used.
37 -s, --search <dirname>
39 Add <dirname> to the search path used for config files and
40 scripts. The search path begins with the current directory,
41 then includes these additional directories before other compo‐
42 nents such as the standard OpenOCD script libraries.
43 -d, --debug <debuglevel>
45 Set debug level. Possible values are:
46 * 0 (errors)
47 * 1 (warnings)
48 * 2 (informational messages)
49 * 3 (debug messages)
50 The default level is 2.
51 -l, --log_output <filename>
53 Redirect log output to the file <filename>. Per default the log
54 output is printed on stderr.
55 -c, --command <cmd>
57 Add the command <cmd> to a list of commands executed on server
58 startup. Note that you will need to explicitly invoke init if
59 the command requires access to a target or flash.
60 -p, --pipe
62 Use pipes when talking to gdb.
63 -h, --help
65 Show a help text and exit.
66 -v, --version
68 Show version information and exit.
69
71 Please report any bugs on the mailing list at
72 openocd-devel@lists.sourceforge.net.
73
75 OpenOCD is covered by the GNU General Public License (GPL), version 2
76 or later.
77
79 jtag(1)
80 The full documentation for openocd is maintained as a Texinfo manual.
82 If the info (or pinfo) and openocd programs are properly installed at
83 your site, the command info openocd should give you access to the com‐
84 plete manual.
85
87 Please see the file AUTHORS.
88 This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>. It
90 is licensed under the terms of the GNU GPL (version 2 or later).
91 November 24, 2009 OPENOCD(1)