NAME¶

openocd - A free and open on-chip debugging, in-system programming andboundary-scan testing tool for ARM and MIPS systems

SYNOPSIS¶

openocd [-fsdlcphv] [--file <filename>] [--search <dirname>] [--debug <debuglevel>] [--log_output <filename>] [--command <cmd>] [--pipe] [--help] [--version]

DESCRIPTION¶

OpenOCDis an on-chip debugging, in-system programming and boundary-scantesting tool for various ARM and MIPS systems.

The debugger uses an IEEE 1149-1 compliant JTAG TAP bus master to accesson-chip debug functionality available on ARM based microcontrollers orsystem-on-chip solutions. For MIPS systems the EJTAG interface is supported.

User interaction is realized through a telnet command line interface,a gdb (the GNU debugger) remote protocol server, and a simplified RPCconnection that can be used to interface with OpenOCD's Jim Tcl engine.

OpenOCD supports various different types of JTAG interfaces/programmers,please check the openocd info page for the complete list.

OPTIONS¶

-f, --file <filename>

This is a shortcut for a -c "[script <filename>]" command, using a search path to load the configuration file <filename>.In order to specify multiple config files, you can use multiple--filearguments. If no such -c options are included, the first config file openocd.cfgin the search path will be used.

-s, --search <dirname>

Add<dirname>to the search path used for config files and scripts.The search path begins with the current directory,then includes these additional directories before othercomponents such as the standard OpenOCD script libraries.

-d, --debug <debuglevel>

Set debug level. Possible values are:
* 0 (errors)
* 1 (warnings)
* 2 (informational messages)
* 3 (debug messages)
The default level is2.

-l, --log_output <filename>

Redirect log output to the file<filename>.Per default the log output is printed onstderr.

-c, --command <cmd>

Add the command<cmd>to a list of commands executed on server startup.Note that you will need to explicitly invokeinitif the command requires access to a target or flash.

-p, --pipe

Use pipes when talking to gdb.

-h, --help

Show a help text and exit.

-v, --version

Show version information and exit.

BUGS¶

Please report any bugs on the mailing list atopenocd-devel@lists.sourceforge.net.

LICENCE¶

OpenOCDis covered by the GNU General Public License (GPL), version 2 or later.

SEE ALSO¶

jtag(1)

The full documentation foropenocdis maintained as a Texinfo manual. If theinfo(orpinfo)andopenocdprograms are properly installed at your site, the commandinfo openocdshould give you access to the complete manual.

AUTHORS¶

Please see the file AUTHORS.

This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>.It is licensed under the terms of the GNU GPL (version 2 or later).