1 \input texinfo @c -*-texinfo-*-
3 @setfilename openocd.info
4 @settitle Open On-Chip Debugger (OpenOCD)
5 @dircategory Development
8 * OpenOCD: (openocd). Open On-Chip Debugger.
17 @item Copyright @copyright{} 2008 The OpenOCD Project
18 @item Copyright @copyright{} 2007-2008 Spencer Oliver @email{spen@@spen-soft.co.uk}
19 @item Copyright @copyright{} 2008 Oyvind Harboe @email{oyvind.harboe@@zylin.com}
20 @item Copyright @copyright{} 2008 Duane Ellis @email{openocd@@duaneellis.com}
24 Permission is granted to copy, distribute and/or modify this document
25 under the terms of the GNU Free Documentation License, Version 1.2 or
26 any later version published by the Free Software Foundation; with no
27 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
28 Texts. A copy of the license is included in the section entitled ``GNU
29 Free Documentation License''.
34 @title Open On-Chip Debugger (OpenOCD)
35 @subtitle Edition @value{EDITION} for OpenOCD version @value{VERSION}
36 @subtitle @value{UPDATED}
38 @vskip 0pt plus 1filll
45 @node Top, About, , (dir)
48 This manual documents edition @value{EDITION} of the Open On-Chip Debugger
49 (OpenOCD) version @value{VERSION}, @value{UPDATED}.
54 * About:: About OpenOCD
55 * Developers:: OpenOCD Developers
56 * Building OpenOCD:: Building OpenOCD From SVN
57 * JTAG Hardware Dongles:: JTAG Hardware Dongles
58 * Running:: Running OpenOCD
59 * Simple Configuration Files:: Simple Configuration Files
60 * Config File Guidelines:: Config File Guidelines
61 * About JIM-Tcl:: About JIM-Tcl
62 * Daemon Configuration:: Daemon Configuration
63 * Interface - Dongle Configuration:: Interface - Dongle Configuration
64 * Reset Configuration:: Reset Configuration
65 * Tap Creation:: Tap Creation
66 * Target Configuration:: Target Configuration
67 * Flash Commands:: Flash Commands
68 * NAND Flash Commands:: NAND Flash Commands
69 * General Commands:: General Commands
70 * JTAG Commands:: JTAG Commands
71 * Sample Scripts:: Sample Target Scripts
73 * GDB and OpenOCD:: Using GDB and OpenOCD
74 * Tcl Scripting API:: Tcl Scripting API
75 * Upgrading:: Deprecated/Removed Commands
76 * Target Library:: Target Library
77 * FAQ:: Frequently Asked Questions
78 * Tcl Crash Course:: Tcl Crash Course
79 * License:: GNU Free Documentation License
80 @comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
81 @comment case issue with ``Index.html'' and ``index.html''
82 @comment Occurs when creating ``--html --no-split'' output
83 @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html
84 * OpenOCD Concept Index:: Concept Index
85 * Command and Driver Index:: Command and Driver Index
92 OpenOCD was created by Dominic Rath as part of a diploma thesis written at the
93 University of Applied Sciences Augsburg (@uref{http://www.fh-augsburg.de}).
94 Since that time, the project has grown into an active open-source project,
95 supported by a diverse community of software and hardware developers from
98 @section What is OpenOCD?
100 The Open On-Chip Debugger (OpenOCD) aims to provide debugging,
101 in-system programming and boundary-scan testing for embedded target
104 @b{JTAG:} OpenOCD uses a ``hardware interface dongle'' to communicate
105 with the JTAG (IEEE 1149.1) compliant taps on your target board.
107 @b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB
108 based, parallel port based, and other standalone boxes that run
109 OpenOCD internally. @xref{JTAG Hardware Dongles}.
111 @b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
112 ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
113 Cortex-M3 (Stellaris LM3 and ST STM32) based cores to be
114 debugged via the GDB protocol.
116 @b{Flash Programing:} Flash writing is supported for external CFI
117 compatible NOR flashes (Intel and AMD/Spansion command set) and several
118 internal flashes (LPC2000, AT91SAM7, STR7x, STR9x, LM3, and
119 STM32x). Preliminary support for various NAND flash controllers
120 (LPC3180, Orion, S3C24xx, more) controller is included.
122 @section OpenOCD Web Site
124 The OpenOCD web site provides the latest public news from the community:
126 @uref{http://openocd.berlios.de/web/}
130 @chapter OpenOCD Developer Resources
133 If you are interested in improving the state of OpenOCD's debugging and
134 testing support, new contributions will be welcome. Motivated developers
135 can produce new target, flash or interface drivers, improve the
136 documentation, as well as more conventional bug fixes and enhancements.
138 The resources in this chapter are available for developers wishing to explore
139 or expand the OpenOCD source code.
141 @section OpenOCD Subversion Repository
143 The ``Building From Source'' section provides instructions to retrieve
144 and and build the latest version of the OpenOCD source code.
145 @xref{Building OpenOCD}.
147 Developers that want to contribute patches to the OpenOCD system are
148 @b{strongly} encouraged to base their work off of the most recent trunk
149 revision. Patches created against older versions may require additional
150 work from their submitter in order to be updated for newer releases.
152 @section Doxygen Developer Manual
154 During the development of the 0.2.0 release, the OpenOCD project began
155 providing a Doxygen reference manual. This document contains more
156 technical information about the software internals, development
157 processes, and similar documentation:
159 @uref{http://openocd.berlios.de/doc/doxygen/index.html}
161 This document is a work-in-progress, but contributions would be welcome
162 to fill in the gaps. All of the source files are provided in-tree,
163 listed in the Doxyfile configuration in the top of the repository trunk.
165 @section OpenOCD Developer Mailing List
167 The OpenOCD Developer Mailing List provides the primary means of
168 communication between developers:
170 @uref{https://lists.berlios.de/mailman/listinfo/openocd-development}
172 All drivers developers are enouraged to also subscribe to the list of
173 SVN commits to keep pace with the ongoing changes:
175 @uref{https://lists.berlios.de/mailman/listinfo/openocd-svn}
177 @node Building OpenOCD
178 @chapter Building OpenOCD
181 @section Pre-Built Tools
182 If you are interested in getting actual work done rather than building
183 OpenOCD, then check if your interface supplier provides binaries for
184 you. Chances are that that binary is from some SVN version that is more
185 stable than SVN trunk where bleeding edge development takes place.
187 @section Packagers Please Read!
189 You are a @b{PACKAGER} of OpenOCD if you
192 @item @b{Sell dongles} and include pre-built binaries
193 @item @b{Supply tools} i.e.: A complete development solution
194 @item @b{Supply IDEs} like Eclipse, or RHIDE, etc.
195 @item @b{Build packages} i.e.: RPM files, or DEB files for a Linux Distro
198 As a @b{PACKAGER}, you will experience first reports of most issues.
199 When you fix those problems for your users, your solution may help
200 prevent hundreds (if not thousands) of other questions from other users.
202 If something does not work for you, please work to inform the OpenOCD
203 developers know how to improve the system or documentation to avoid
204 future problems, and follow-up to help us ensure the issue will be fully
205 resolved in our future releases.
207 That said, the OpenOCD developers would also like you to follow a few
211 @item @b{Always build with printer ports enabled.}
212 @item @b{Try to use LIBFTDI + LIBUSB where possible. You cover more bases.}
216 @item @b{Why YES to LIBFTDI + LIBUSB?}
218 @item @b{LESS} work - libusb perhaps already there
219 @item @b{LESS} work - identical code, multiple platforms
220 @item @b{MORE} dongles are supported
221 @item @b{MORE} platforms are supported
222 @item @b{MORE} complete solution
224 @item @b{Why not LIBFTDI + LIBUSB} (i.e.: ftd2xx instead)?
226 @item @b{LESS} speed - some say it is slower
227 @item @b{LESS} complex to distribute (external dependencies)
231 @section Building From Source
233 You can download the current SVN version with an SVN client of your choice from the
234 following repositories:
236 @uref{svn://svn.berlios.de/openocd/trunk}
240 @uref{http://svn.berlios.de/svnroot/repos/openocd/trunk}
242 Using the SVN command line client, you can use the following command to fetch the
243 latest version (make sure there is no (non-svn) directory called "openocd" in the
247 svn checkout svn://svn.berlios.de/openocd/trunk openocd
250 Building OpenOCD requires a recent version of the GNU autotools (autoconf >= 2.59 and automake >= 1.9).
251 For building on Windows,
252 you have to use Cygwin. Make sure that your @env{PATH} environment variable contains no
253 other locations with Unix utils (like UnxUtils) - these can't handle the Cygwin
254 paths, resulting in obscure dependency errors (This is an observation I've gathered
255 from the logs of one user - correct me if I'm wrong).
257 You further need the appropriate driver files, if you want to build support for
258 a FTDI FT2232 based interface:
261 @item @b{ftdi2232} libftdi (@uref{http://www.intra2net.com/opensource/ftdi/})
262 @item @b{ftd2xx} libftd2xx (@uref{http://www.ftdichip.com/Drivers/D2XX.htm})
263 @item When using the Amontec JTAGkey, you have to get the drivers from the Amontec
264 homepage (@uref{http://www.amontec.com}). The JTAGkey uses a non-standard VID/PID.
267 libftdi is supported under Windows. Do not use versions earlier than 0.14.
269 In general, the D2XX driver provides superior performance (several times as fast),
270 but has the draw-back of being binary-only - though that isn't that bad, as it isn't
271 a kernel module, only a user space library.
273 To build OpenOCD (on both Linux and Cygwin), use the following commands:
279 Bootstrap generates the configure script, and prepares building on your system.
282 ./configure [options, see below]
285 Configure generates the Makefiles used to build OpenOCD.
292 Make builds OpenOCD, and places the final executable in ./src/, the last step, ``make install'' is optional.
294 The configure script takes several options, specifying which JTAG interfaces
295 should be included (among other things):
299 @option{--enable-parport} - Enable building the PC parallel port driver.
301 @option{--enable-parport_ppdev} - Enable use of ppdev (/dev/parportN) for parport.
303 @option{--enable-parport_giveio} - Enable use of giveio for parport instead of ioperm.
305 @option{--enable-amtjtagaccel} - Enable building the Amontec JTAG-Accelerator driver.
307 @option{--enable-ecosboard} - Enable building support for eCosBoard based JTAG debugger.
309 @option{--enable-ioutil} - Enable ioutil functions - useful for standalone OpenOCD implementations.
311 @option{--enable-httpd} - Enable builtin httpd server - useful for standalone OpenOCD implementations.
313 @option{--enable-ep93xx} - Enable building support for EP93xx based SBCs.
315 @option{--enable-at91rm9200} - Enable building support for AT91RM9200 based SBCs.
317 @option{--enable-gw16012} - Enable building support for the Gateworks GW16012 JTAG programmer.
319 @option{--enable-ft2232_ftd2xx} - Numerous USB type ARM JTAG dongles use the FT2232C chip from this FTDICHIP.COM chip (closed source).
321 @option{--enable-ft2232_libftdi} - An open source (free) alternative to FTDICHIP.COM ftd2xx solution (Linux, MacOS, Cygwin).
323 @option{--with-ftd2xx-win32-zipdir=PATH} - If using FTDICHIP.COM ft2232c driver,
324 give the directory where the Win32 FTDICHIP.COM 'CDM' driver zip file was unpacked.
326 @option{--with-ftd2xx-linux-tardir=PATH} - If using FTDICHIP.COM ft2232c driver
327 on Linux, give the directory where the Linux driver's TAR.GZ file was unpacked.
329 @option{--with-ftd2xx-lib=shared|static} - Linux only. Default: static. Specifies how the FTDICHIP.COM libftd2xx driver should be linked. Note: 'static' only works in conjunction with @option{--with-ftd2xx-linux-tardir}. The 'shared' value is supported (12/26/2008), however you must manually install the required header files and shared libraries in an appropriate place. This uses ``libusb'' internally.
331 @option{--enable-presto_libftdi} - Enable building support for ASIX Presto programmer using the libftdi driver.
333 @option{--enable-presto_ftd2xx} - Enable building support for ASIX Presto programmer using the FTD2XX driver.
335 @option{--enable-usbprog} - Enable building support for the USBprog JTAG programmer.
337 @option{--enable-oocd_trace} - Enable building support for the OpenOCD+trace ETM capture device.
339 @option{--enable-jlink} - Enable building support for the Segger J-Link JTAG programmer.
341 @option{--enable-vsllink} - Enable building support for the Versaloon-Link JTAG programmer.
343 @option{--enable-rlink} - Enable building support for the Raisonance RLink JTAG programmer.
345 @option{--enable-arm-jtag-ew} - Enable building support for the Olimex ARM-JTAG-EW programmer.
347 @option{--enable-dummy} - Enable building the dummy port driver.
350 @section Parallel Port Dongles
352 If you want to access the parallel port using the PPDEV interface you have to specify
353 both the @option{--enable-parport} AND the @option{--enable-parport_ppdev} option since
354 the @option{--enable-parport_ppdev} option actually is an option to the parport driver
355 (see @uref{http://forum.sparkfun.com/viewtopic.php?t=3795} for more info).
357 The same is true for the @option{--enable-parport_giveio} option, you have to
358 use both the @option{--enable-parport} AND the @option{--enable-parport_giveio} option if you want to use giveio instead of ioperm parallel port access method.
360 @section FT2232C Based USB Dongles
362 There are 2 methods of using the FTD2232, either (1) using the
363 FTDICHIP.COM closed source driver, or (2) the open (and free) driver
364 libftdi. Some claim the (closed) FTDICHIP.COM solution is faster.
366 The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
367 TAR.GZ file. You must unpack them ``some where'' convient. As of this
368 writing (12/26/2008) FTDICHIP does not supply means to install these
369 files ``in an appropriate place'' As a result, there are two
370 ``./configure'' options that help.
372 Below is an example build process:
375 @item Check out the latest version of ``openocd'' from SVN.
377 @item If you are using the FTDICHIP.COM driver, download
378 and unpack the Windows or Linux FTD2xx drivers
379 (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}).
380 If you are using the libftdi driver, install that package
381 (e.g. @command{apt-get install libftdi} on systems with APT).
384 /home/duane/ftd2xx.win32 => the Cygwin/Win32 ZIP file contents
385 /home/duane/libftd2xx0.4.16 => the Linux TAR.GZ file contents
388 @item Configure with options resembling the following.
391 @item Cygwin FTDICHIP solution:
393 ./configure --prefix=/home/duane/mytools \
394 --enable-ft2232_ftd2xx \
395 --with-ftd2xx-win32-zipdir=/home/duane/ftd2xx.win32
398 @item Linux FTDICHIP solution:
400 ./configure --prefix=/home/duane/mytools \
401 --enable-ft2232_ftd2xx \
402 --with-ft2xx-linux-tardir=/home/duane/libftd2xx0.4.16
405 @item Cygwin/Linux LIBFTDI solution ... assuming that
407 @item For Windows -- that the Windows port of LIBUSB is in place.
408 @item For Linux -- that libusb has been built/installed and is in place.
409 @item That libftdi has been built and installed (relies on libusb).
412 Then configure the libftdi solution like this:
415 ./configure --prefix=/home/duane/mytools \
416 --enable-ft2232_libftdi
420 @item Then just type ``make'', and perhaps ``make install''.
424 @section Miscellaneous Configure Options
428 @option{--disable-option-checking} - Ignore unrecognized @option{--enable} and @option{--with} options.
430 @option{--enable-gccwarnings} - Enable extra gcc warnings during build.
433 @option{--enable-release} - Enable building of an OpenOCD release, generally
434 this is for developers. It simply omits the svn version string when the
435 openocd @option{-v} is executed.
438 @node JTAG Hardware Dongles
439 @chapter JTAG Hardware Dongles
448 Defined: @b{dongle}: A small device that plugins into a computer and serves as
449 an adapter .... [snip]
451 In the OpenOCD case, this generally refers to @b{a small adapater} one
452 attaches to your computer via USB or the Parallel Printer Port. The
453 execption being the Zylin ZY1000 which is a small box you attach via
454 an ethernet cable. The Zylin ZY1000 has the advantage that it does not
455 require any drivers to be installed on the developer PC. It also has
456 a built in web interface. It supports RTCK/RCLK or adaptive clocking
457 and has a built in relay to power cycle targets remotely.
460 @section Choosing a Dongle
462 There are three things you should keep in mind when choosing a dongle.
465 @item @b{Voltage} What voltage is your target? 1.8, 2.8, 3.3, or 5V? Does your dongle support it?
466 @item @b{Connection} Printer Ports - Does your computer have one?
467 @item @b{Connection} Is that long printer bit-bang cable practical?
468 @item @b{RTCK} Do you require RTCK? Also known as ``adaptive clocking''
471 @section Stand alone Systems
473 @b{ZY1000} See: @url{http://www.zylin.com/zy1000.html} Technically, not a
474 dongle, but a standalone box. The ZY1000 has the advantage that it does
475 not require any drivers installed on the developer PC. It also has
476 a built in web interface. It supports RTCK/RCLK or adaptive clocking
477 and has a built in relay to power cycle targets remotely.
479 @section USB FT2232 Based
481 There are many USB JTAG dongles on the market, many of them are based
482 on a chip from ``Future Technology Devices International'' (FTDI)
483 known as the FTDI FT2232; this is a USB full speed (12 Mbps) chip.
484 See: @url{http://www.ftdichip.com} for more information.
485 In summer 2009, USB high speed (480 Mbps) versions of these FTDI
486 chips are starting to become available in JTAG adapters.
488 As of 28/Nov/2008, the following are supported:
492 @* Link @url{http://www.hs-augsburg.de/~hhoegl/proj/usbjtag/usbjtag.html}
494 @* See: @url{http://www.amontec.com/jtagkey.shtml}
496 @* See: @url{http://www.oocdlink.com} By Joern Kaipf
498 @* See: @url{http://www.signalyzer.com}
499 @item @b{evb_lm3s811}
500 @* See: @url{http://www.luminarymicro.com} - The Stellaris LM3S811 eval board has an FTD2232C chip built in.
501 @item @b{olimex-jtag}
502 @* See: @url{http://www.olimex.com}
504 @* See: @url{http://www.tincantools.com}
505 @item @b{turtelizer2}
507 @uref{http://www.ethernut.de/en/hardware/turtelizer/index.html, Turtelizer 2}, or
508 @url{http://www.ethernut.de}
510 @* Link: @url{http://www.hitex.com/index.php?id=383}
512 @* Link @url{http://www.hitex.com/stm32-stick}
513 @item @b{axm0432_jtag}
514 @* Axiom AXM-0432 Link @url{http://www.axman.com}
516 @* Link @url{http://www.hitex.com/index.php?id=cortino}
519 @section USB JLINK based
520 There are several OEM versions of the Segger @b{JLINK} adapter. It is
521 an example of a micro controller based JTAG adapter, it uses an
522 AT91SAM764 internally.
525 @item @b{ATMEL SAMICE} Only works with ATMEL chips!
526 @* Link: @url{http://www.atmel.com/dyn/products/tools_card.asp?tool_id=3892}
527 @item @b{SEGGER JLINK}
528 @* Link: @url{http://www.segger.com/jlink.html}
530 @* Link: @url{http://www.iar.com/website1/1.0.1.0/369/1/index.php}
533 @section USB RLINK based
534 Raisonance has an adapter called @b{RLink}. It exists in a stripped-down form on the STM32 Primer, permanently attached to the JTAG lines. It also exists on the STM32 Primer2, but that is wired for SWD and not JTAG, thus not supported.
537 @item @b{Raisonance RLink}
538 @* Link: @url{http://www.raisonance.com/products/RLink.php}
539 @item @b{STM32 Primer}
540 @* Link: @url{http://www.stm32circle.com/resources/stm32primer.php}
541 @item @b{STM32 Primer2}
542 @* Link: @url{http://www.stm32circle.com/resources/stm32primer2.php}
548 @* Link: @url{http://www.embedded-projects.net/usbprog} - which uses an Atmel MEGA32 and a UBN9604
550 @item @b{USB - Presto}
551 @* Link: @url{http://tools.asix.net/prg_presto.htm}
553 @item @b{Versaloon-Link}
554 @* Link: @url{http://www.simonqian.com/en/Versaloon}
556 @item @b{ARM-JTAG-EW}
557 @* Link: @url{http://www.olimex.com/dev/arm-jtag-ew.html}
560 @section IBM PC Parallel Printer Port Based
562 The two well known ``JTAG Parallel Ports'' cables are the Xilnx DLC5
563 and the MacGraigor Wiggler. There are many clones and variations of
568 @item @b{Wiggler} - There are many clones of this.
569 @* Link: @url{http://www.macraigor.com/wiggler.htm}
571 @item @b{DLC5} - From XILINX - There are many clones of this
572 @* Link: Search the web for: ``XILINX DLC5'' - it is no longer
573 produced, PDF schematics are easily found and it is easy to make.
575 @item @b{Amontec - JTAG Accelerator}
576 @* Link: @url{http://www.amontec.com/jtag_accelerator.shtml}
579 @* Link: @url{http://www.gateworks.com/products/avila_accessories/gw16042.php}
582 @*@uref{http://www.ccac.rwth-aachen.de/@/~michaels/@/index.php/hardware/@/armjtag,
583 Improved parallel-port wiggler-style JTAG adapter}
585 @item @b{Wiggler_ntrst_inverted}
586 @* Yet another variation - See the source code, src/jtag/parport.c
588 @item @b{old_amt_wiggler}
589 @* Unknown - probably not on the market today
592 @* Link: Most likely @url{http://www.olimex.com/dev/arm-jtag.html} [another wiggler clone]
595 @* Link: @url{http://www.amontec.com/chameleon.shtml}
601 @* ispDownload from Lattice Semiconductor
602 @url{http://www.latticesemi.com/lit/docs/@/devtools/dlcable.pdf}
605 @* From ST Microsystems;
606 @uref{http://www.st.com/stonline/@/products/literature/um/7889.pdf,
607 FlashLINK JTAG programing cable for PSD and uPSD}
615 @* An EP93xx based Linux machine using the GPIO pins directly.
618 @* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
624 @cindex running OpenOCD
626 @cindex --debug_level
630 The @option{--help} option shows:
634 --help | -h display this help
635 --version | -v display OpenOCD version
636 --file | -f use configuration file <name>
637 --search | -s dir to search for config files and scripts
638 --debug | -d set debug level <0-3>
639 --log_output | -l redirect log output to file <name>
640 --command | -c run <command>
641 --pipe | -p use pipes when talking to gdb
644 By default OpenOCD reads the file configuration file ``openocd.cfg''
645 in the current directory. To specify a different (or multiple)
646 configuration file, you can use the ``-f'' option. For example:
649 openocd -f config1.cfg -f config2.cfg -f config3.cfg
652 Once started, OpenOCD runs as a daemon, waiting for connections from
653 clients (Telnet, GDB, Other).
655 If you are having problems, you can enable internal debug messages via
658 Also it is possible to interleave commands w/config scripts using the
659 @option{-c} command line switch.
661 To enable debug output (when reporting problems or working on OpenOCD
662 itself), use the @option{-d} command line switch. This sets the
663 @option{debug_level} to "3", outputting the most information,
664 including debug messages. The default setting is "2", outputting only
665 informational messages, warnings and errors. You can also change this
666 setting from within a telnet or gdb session using @option{debug_level
667 <n>} @xref{debug_level}.
669 You can redirect all output from the daemon to a file using the
670 @option{-l <logfile>} switch.
672 Search paths for config/script files can be added to OpenOCD by using
673 the @option{-s <search>} switch. The current directory and the OpenOCD
674 target library is in the search path by default.
676 For details on the @option{-p} option. @xref{Connecting to GDB}.
678 Note! OpenOCD will launch the GDB & telnet server even if it can not
679 establish a connection with the target. In general, it is possible for
680 the JTAG controller to be unresponsive until the target is set up
681 correctly via e.g. GDB monitor commands in a GDB init script.
683 @node Simple Configuration Files
684 @chapter Simple Configuration Files
685 @cindex configuration
688 There are 4 basic ways of ``configurating'' OpenOCD to run, they are:
691 @item A small openocd.cfg file which ``sources'' other configuration files
692 @item A monolithic openocd.cfg file
693 @item Many -f filename options on the command line
694 @item Your Mixed Solution
697 @section Small configuration file method
699 This is the preferred method. It is simple and works well for many
700 people. The developers of OpenOCD would encourage you to use this
701 method. If you create a new configuration please email new
702 configurations to the development list.
704 Here is an example of an openocd.cfg file for an ATMEL at91sam7x256
707 source [find interface/signalyzer.cfg]
709 # GDB can also flash my flash!
710 gdb_memory_map enable
711 gdb_flash_program enable
713 source [find target/sam7x256.cfg]
716 There are many example configuration scripts you can work with. You
717 should look in the directory: @t{$(INSTALLDIR)/lib/openocd}. You
721 @item @b{board} - eval board level configurations
722 @item @b{interface} - specific dongle configurations
723 @item @b{target} - the target chips
724 @item @b{tcl} - helper scripts
725 @item @b{xscale} - things specific to the xscale.
728 Look first in the ``boards'' area, then the ``targets'' area. Often a board
729 configuration is a good example to work from.
731 @section Many -f filename options
732 Some believe this is a wonderful solution, others find it painful.
734 You can use a series of ``-f filename'' options on the command line,
735 OpenOCD will read each filename in sequence, for example:
738 openocd -f file1.cfg -f file2.cfg -f file2.cfg
741 You can also intermix various commands with the ``-c'' command line
744 @section Monolithic file
745 The ``Monolithic File'' dispenses with all ``source'' statements and
746 puts everything in one self contained (monolithic) file. This is not
749 Please try to ``source'' various files or use the multiple -f
752 @section Advice for you
753 Often, one uses a ``mixed approach''. Where possible, please try to
754 ``source'' common things, and if needed cut/paste parts of the
755 standard distribution configuration files as needed.
757 @b{REMEMBER:} The ``important parts'' of your configuration file are:
760 @item @b{Interface} - Defines the dongle
761 @item @b{Taps} - Defines the JTAG Taps
762 @item @b{GDB Targets} - What GDB talks to
763 @item @b{Flash Programing} - Very Helpful
766 Some key things you should look at and understand are:
769 @item The reset configuration of your debug environment as a whole
770 @item Is there a ``work area'' that OpenOCD can use?
771 @* For ARM - work areas mean up to 10x faster downloads.
772 @item For MMU/MPU based ARM chips (i.e.: ARM9 and later) will that work area still be available?
773 @item For complex targets (multiple chips) the JTAG SPEED becomes an issue.
778 @node Config File Guidelines
779 @chapter Config File Guidelines
781 This section/chapter is aimed at developers and integrators of
782 OpenOCD. These are guidelines for creating new boards and new target
783 configurations as of 28/Nov/2008.
785 However, you, the user of OpenOCD, should be somewhat familiar with
786 this section as it should help explain some of the internals of what
787 you might be looking at.
789 The user should find the following directories under @t{$(INSTALLDIR)/lib/openocd} :
793 @*Think JTAG Dongle. Files that configure the JTAG dongle go here.
795 @* Think Circuit Board, PWA, PCB, they go by many names. Board files
796 contain initialization items that are specific to a board - for
797 example: The SDRAM initialization sequence for the board, or the type
798 of external flash and what address it is found at. Any initialization
799 sequence to enable that external flash or SDRAM should be found in the
800 board file. Boards may also contain multiple targets, i.e.: Two CPUs, or
801 a CPU and an FPGA or CPLD.
803 @* Think chip. The ``target'' directory represents a JTAG tap (or
804 chip) OpenOCD should control, not a board. Two common types of targets
805 are ARM chips and FPGA or CPLD chips.
808 @b{If needed...} The user in their ``openocd.cfg'' file or the board
809 file might override a specific feature in any of the above files by
810 setting a variable or two before sourcing the target file. Or adding
811 various commands specific to their situation.
813 @section Interface Config Files
815 The user should be able to source one of these files via a command like this:
818 source [find interface/FOOBAR.cfg]
820 openocd -f interface/FOOBAR.cfg
823 A preconfigured interface file should exist for every interface in use
824 today, that said, perhaps some interfaces have only been used by the
825 sole developer who created it.
827 Interface files should be found in @t{$(INSTALLDIR)/lib/openocd/interface}
829 @section Board Config Files
831 @b{Note: BOARD directory NEW as of 28/nov/2008}
833 The user should be able to source one of these files via a command like this:
836 source [find board/FOOBAR.cfg]
838 openocd -f board/FOOBAR.cfg
842 The board file should contain one or more @t{source [find
843 target/FOO.cfg]} statements along with any board specific things.
845 In summary the board files should contain (if present)
848 @item External flash configuration (i.e.: NOR flash on CS0, two NANDs on CS2)
849 @item SDRAM configuration (size, speed, etc.
850 @item Board specific IO configuration (i.e.: GPIO pins might disable a 2nd flash)
851 @item Multiple TARGET source statements
852 @item All things that are not ``inside a chip''
853 @item Things inside a chip go in a 'target' file
856 @section Target Config Files
858 The user should be able to source one of these files via a command like this:
861 source [find target/FOOBAR.cfg]
863 openocd -f target/FOOBAR.cfg
866 In summary the target files should contain
871 @item Reset configuration
873 @item CPU/Chip/CPU-Core specific features
877 @subsection Important variable names
879 By default, the end user should never need to set these
880 variables. However, if the user needs to override a setting they only
881 need to set the variable in a simple way.
885 @* This gives a name to the overall chip, and is used as part of the
886 tap identifier dotted name.
888 @* By default little - unless the chip or board is not normally used that way.
890 @* When OpenOCD examines the JTAG chain, it will attempt to identify
891 every chip. If the @t{-expected-id} is nonzero, OpenOCD attempts
892 to verify the tap id number verses configuration file and may issue an
893 error or warning like this. The hope is that this will help to pinpoint
894 problems in OpenOCD configurations.
897 Info: JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f
898 (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
899 Error: ERROR: Tap: sam7x256.cpu - Expected id: 0x12345678,
901 Error: ERROR: expected: mfg: 0x33c, part: 0x2345, ver: 0x1
902 Error: ERROR: got: mfg: 0x787, part: 0xf0f0, ver: 0x3
905 @item @b{_TARGETNAME}
906 @* By convention, this variable is created by the target configuration
907 script. The board configuration file may make use of this variable to
908 configure things like a ``reset init'' script, or other things
909 specific to that board and that target.
911 If the chip has 2 targets, use the names @b{_TARGETNAME0},
912 @b{_TARGETNAME1}, ... etc.
914 @b{Remember:} The ``board file'' may include multiple targets.
916 At no time should the name ``target0'' (the default target name if
917 none was specified) be used. The name ``target0'' is a hard coded name
918 - the next target on the board will be some other number.
919 In the same way, avoid using target numbers even when they are
920 permitted; use the right target name(s) for your board.
922 The user (or board file) should reasonably be able to:
925 source [find target/FOO.cfg]
926 $_TARGETNAME configure ... FOO specific parameters
928 source [find target/BAR.cfg]
929 $_TARGETNAME configure ... BAR specific parameters
934 @subsection Tcl Variables Guide Line
935 The Full Tcl/Tk language supports ``namespaces'' - JIM-Tcl does not.
937 Thus the rule we follow in OpenOCD is this: Variables that begin with
938 a leading underscore are temporary in nature, and can be modified and
939 used at will within a ?TARGET? configuration file.
941 @b{EXAMPLE:} The user should be able to do this:
945 # PXA270 #1 network side, big endian
946 # PXA270 #2 video side, little endian
950 source [find target/pxa270.cfg]
951 # variable: _TARGETNAME = network.cpu
952 # other commands can refer to the "network.cpu" tap.
953 $_TARGETNAME configure .... params for this CPU..
957 source [find target/pxa270.cfg]
958 # variable: _TARGETNAME = video.cpu
959 # other commands can refer to the "video.cpu" tap.
960 $_TARGETNAME configure .... params for this CPU..
964 source [find target/spartan3.cfg]
966 # Since $_TARGETNAME is temporal..
967 # these names still work!
968 network.cpu configure ... params
969 video.cpu configure ... params
973 @subsection Default Value Boiler Plate Code
975 All target configuration files should start with this (or a modified form)
979 if @{ [info exists CHIPNAME] @} @{
980 set _CHIPNAME $CHIPNAME
982 set _CHIPNAME sam7x256
985 if @{ [info exists ENDIAN] @} @{
991 if @{ [info exists CPUTAPID ] @} @{
992 set _CPUTAPID $CPUTAPID
994 set _CPUTAPID 0x3f0f0f0f
999 @subsection Creating Taps
1000 After the ``defaults'' are choosen [see above] the taps are created.
1002 @b{SIMPLE example:} such as an Atmel AT91SAM7X256
1006 set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
1007 jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf \
1008 -expected-id $_CPUTAPID
1011 @b{COMPLEX example:}
1013 This is an SNIP/example for an STR912 - which has 3 internal taps. Key features shown:
1016 @item @b{Unform tap names} - See: Tap Naming Convention
1017 @item @b{_TARGETNAME} is created at the end where used.
1021 if @{ [info exists FLASHTAPID ] @} @{
1022 set _FLASHTAPID $FLASHTAPID
1024 set _FLASHTAPID 0x25966041
1026 jtag newtap $_CHIPNAME flash -irlen 8 -ircapture 0x1 -irmask 0x1 \
1027 -expected-id $_FLASHTAPID
1029 if @{ [info exists CPUTAPID ] @} @{
1030 set _CPUTAPID $CPUTAPID
1032 set _CPUTAPID 0x25966041
1034 jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0xf -irmask 0xe \
1035 -expected-id $_CPUTAPID
1038 if @{ [info exists BSTAPID ] @} @{
1039 set _BSTAPID $BSTAPID
1041 set _BSTAPID 0x1457f041
1043 jtag newtap $_CHIPNAME bs -irlen 5 -ircapture 0x1 -irmask 0x1 \
1044 -expected-id $_BSTAPID
1046 set _TARGETNAME [format "%s.cpu" $_CHIPNAME]
1049 @b{Tap Naming Convention}
1051 See the command ``jtag newtap'' for detail, but in brief the names you should use are:
1060 @item @b{unknownN} - it happens :-(
1063 @subsection Reset Configuration
1065 Some chips have specific ways the TRST and SRST signals are
1066 managed. If these are @b{CHIP SPECIFIC} they go here, if they are
1067 @b{BOARD SPECIFIC} they go in the board file.
1069 @subsection Work Areas
1071 Work areas are small RAM areas used by OpenOCD to speed up downloads,
1072 and to download small snippets of code to program flash chips.
1074 If the chip includes a form of ``on-chip-ram'' - and many do - define
1075 a reasonable work area and use the ``backup'' option.
1077 @b{PROBLEMS:} On more complex chips, this ``work area'' may become
1078 inaccessible if/when the application code enables or disables the MMU.
1080 @subsection ARM Core Specific Hacks
1082 If the chip has a DCC, enable it. If the chip is an ARM9 with some
1083 special high speed download features - enable it.
1085 If the chip has an ARM ``vector catch'' feature - by default enable
1086 it for Undefined Instructions, Data Abort, and Prefetch Abort, if the
1087 user is really writing a handler for those situations - they can
1088 easily disable it. Experiance has shown the ``vector catch'' is
1089 helpful - for common programing errors.
1091 If present, the MMU, the MPU and the CACHE should be disabled.
1093 Some ARM cores are equipped with trace support, which permits
1094 examination of the instruction and data bus activity. Trace
1095 activity is controlled through an ``Embedded Trace Module'' (ETM)
1096 on one of the core's scan chains. The ETM emits voluminous data
1097 through a ``trace port''. The trace port is accessed in one
1098 of two ways. When its signals are pinned out from the chip,
1099 boards may provide a special high speed debugging connector;
1100 software support for this is not configured by default, use
1101 the ``--enable-oocd_trace'' option. Alternatively, trace data
1102 may be stored an on-chip SRAM which is packaged as an ``Embedded
1103 Trace Buffer'' (ETB). An ETB has its own TAP, usually right after
1104 its associated ARM core. OpenOCD supports the ETM, and your
1105 target configuration should set it up with the relevant trace
1106 port: ``etb'' for chips which use that, else the board-specific
1107 option will be either ``oocd_trace'' or ``dummy''.
1110 etm config $_TARGETNAME 16 normal full etb
1111 etb config $_TARGETNAME $_CHIPNAME.etb
1114 @subsection Internal Flash Configuration
1116 This applies @b{ONLY TO MICROCONTROLLERS} that have flash built in.
1118 @b{Never ever} in the ``target configuration file'' define any type of
1119 flash that is external to the chip. (For example a BOOT flash on
1120 Chip Select 0.) Such flash information goes in a board file - not
1121 the TARGET (chip) file.
1125 @item at91sam7x256 - has 256K flash YES enable it.
1126 @item str912 - has flash internal YES enable it.
1127 @item imx27 - uses boot flash on CS0 - it goes in the board file.
1128 @item pxa270 - again - CS0 flash - it goes in the board file.
1132 @chapter About JIM-Tcl
1136 OpenOCD includes a small ``TCL Interpreter'' known as JIM-TCL. You can
1137 learn more about JIM here: @url{http://jim.berlios.de}
1140 @item @b{JIM vs. Tcl}
1141 @* JIM-TCL is a stripped down version of the well known Tcl language,
1142 which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
1143 fewer features. JIM-Tcl is a single .C file and a single .H file and
1144 impliments the basic Tcl command set along. In contrast: Tcl 8.6 is a
1145 4.2 MB .zip file containing 1540 files.
1147 @item @b{Missing Features}
1148 @* Our practice has been: Add/clone the real Tcl feature if/when
1149 needed. We welcome JIM Tcl improvements, not bloat.
1152 @* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
1153 command interpreter today (28/nov/2008) is a mixture of (newer)
1154 JIM-Tcl commands, and (older) the orginal command interpreter.
1157 @* At the OpenOCD telnet command line (or via the GDB mon command) one
1158 can type a Tcl for() loop, set variables, etc.
1160 @item @b{Historical Note}
1161 @* JIM-Tcl was introduced to OpenOCD in spring 2008.
1163 @item @b{Need a crash course in Tcl?}
1164 @* See: @xref{Tcl Crash Course}.
1167 @node Daemon Configuration
1168 @chapter Daemon Configuration
1169 @cindex initialization
1170 The commands here are commonly found in the openocd.cfg file and are
1171 used to specify what TCP/IP ports are used, and how GDB should be
1174 @section Configuration Stage
1175 @cindex configuration stage
1176 @cindex configuration command
1178 When the OpenOCD server process starts up, it enters a
1179 @emph{configuration stage} which is the only time that
1180 certain commands, @emph{configuration commands}, may be issued.
1181 Those configuration commands include declaration of TAPs
1182 and other basic setup.
1183 The server must leave the configuration stage before it
1184 may access or activate TAPs.
1185 After it leaves this stage, configuration commands may no
1188 @deffn {Config Command} init
1189 This command terminates the configuration stage and
1190 enters the normal command mode. This can be useful to add commands to
1191 the startup scripts and commands such as resetting the target,
1192 programming flash, etc. To reset the CPU upon startup, add "init" and
1193 "reset" at the end of the config script or at the end of the OpenOCD
1194 command line using the @option{-c} command line switch.
1196 If this command does not appear in any startup/configuration file
1197 OpenOCD executes the command for you after processing all
1198 configuration files and/or command line options.
1200 @b{NOTE:} This command normally occurs at or near the end of your
1201 openocd.cfg file to force OpenOCD to ``initialize'' and make the
1202 targets ready. For example: If your openocd.cfg file needs to
1203 read/write memory on your target, @command{init} must occur before
1204 the memory read/write commands. This includes @command{nand probe}.
1207 @section TCP/IP Ports
1211 The OpenOCD server accepts remote commands in several syntaxes.
1212 Each syntax uses a different TCP/IP port, which you may specify
1213 only during configuration (before those ports are opened).
1215 @deffn {Command} gdb_port (number)
1217 Specify or query the first port used for incoming GDB connections.
1218 The GDB port for the
1219 first target will be gdb_port, the second target will listen on gdb_port + 1, and so on.
1220 When not specified during the configuration stage,
1221 the port @var{number} defaults to 3333.
1224 @deffn {Command} tcl_port (number)
1225 Specify or query the port used for a simplified RPC
1226 connection that can be used by clients to issue TCL commands and get the
1227 output from the Tcl engine.
1228 Intended as a machine interface.
1229 When not specified during the configuration stage,
1230 the port @var{number} defaults to 6666.
1233 @deffn {Command} telnet_port (number)
1234 Specify or query the
1235 port on which to listen for incoming telnet connections.
1236 This port is intended for interaction with one human through TCL commands.
1237 When not specified during the configuration stage,
1238 the port @var{number} defaults to 4444.
1241 @section GDB Configuration
1242 @anchor{GDB Configuration}
1244 @cindex GDB configuration
1245 You can reconfigure some GDB behaviors if needed.
1246 The ones listed here are static and global.
1247 @xref{Target Create}, about declaring individual targets.
1248 @xref{Target Events}, about configuring target-specific event handling.
1250 @deffn {Command} gdb_breakpoint_override <hard|soft|disable>
1251 @anchor{gdb_breakpoint_override}
1252 Force breakpoint type for gdb @command{break} commands.
1253 The raison d'etre for this option is to support GDB GUI's which don't
1254 distinguish hard versus soft breakpoints, if the default OpenOCD and
1255 GDB behaviour is not sufficient. GDB normally uses hardware
1256 breakpoints if the memory map has been set up for flash regions.
1258 This option replaces older arm7_9 target commands that addressed
1262 @deffn {Config command} gdb_detach <resume|reset|halt|nothing>
1263 Configures what OpenOCD will do when GDB detaches from the daemon.
1264 Default behaviour is @var{resume}.
1267 @deffn {Config command} gdb_flash_program <enable|disable>
1268 @anchor{gdb_flash_program}
1269 Set to @var{enable} to cause OpenOCD to program the flash memory when a
1270 vFlash packet is received.
1271 The default behaviour is @var{enable}.
1274 @deffn {Config command} gdb_memory_map <enable|disable>
1275 Set to @var{enable} to cause OpenOCD to send the memory configuration to GDB when
1276 requested. GDB will then know when to set hardware breakpoints, and program flash
1277 using the GDB load command. @command{gdb_flash_program enable} must also be enabled
1278 for flash programming to work.
1279 Default behaviour is @var{enable}.
1280 @xref{gdb_flash_program}.
1283 @deffn {Config command} gdb_report_data_abort <enable|disable>
1284 Specifies whether data aborts cause an error to be reported
1285 by GDB memory read packets.
1286 The default behaviour is @var{disable};
1287 use @var{enable} see these errors reported.
1290 @node Interface - Dongle Configuration
1291 @chapter Interface - Dongle Configuration
1292 Interface commands are normally found in an interface configuration
1293 file which is sourced by your openocd.cfg file. These commands tell
1294 OpenOCD what type of JTAG dongle you have and how to talk to it.
1295 @section Simple Complete Interface Examples
1296 @b{A Turtelizer FT2232 Based JTAG Dongle}
1300 ft2232_device_desc "Turtelizer JTAG/RS232 Adapter A"
1301 ft2232_layout turtelizer2
1302 ft2232_vid_pid 0x0403 0xbdc8
1309 @b{A Raisonance RLink}
1318 parport_cable wiggler
1323 interface arm-jtag-ew
1325 @section Interface Command
1327 The interface command tells OpenOCD what type of JTAG dongle you are
1328 using. Depending on the type of dongle, you may need to have one or
1329 more additional commands.
1333 @item @b{interface} <@var{name}>
1335 @*Use the interface driver <@var{name}> to connect to the
1336 target. Currently supported interfaces are
1341 @* PC parallel port bit-banging (Wigglers, PLD download cable, ...)
1343 @item @b{amt_jtagaccel}
1344 @* Amontec Chameleon in its JTAG Accelerator configuration connected to a PC's EPP
1348 @* FTDI FT2232 (USB) based devices using either the open-source libftdi or the binary only
1349 FTD2XX driver. The FTD2XX is superior in performance, but not available on every
1350 platform. The libftdi uses libusb, and should be portable to all systems that provide
1354 @*Cirrus Logic EP93xx based single-board computer bit-banging (in development)
1357 @* ASIX PRESTO USB JTAG programmer.
1360 @* usbprog is a freely programmable USB adapter.
1363 @* Gateworks GW16012 JTAG programmer.
1366 @* Segger jlink USB adapter
1369 @* Raisonance RLink USB adapter
1372 @* vsllink is part of Versaloon which is a versatile USB programmer.
1374 @item @b{arm-jtag-ew}
1375 @* Olimex ARM-JTAG-EW USB adapter
1376 @comment - End parameters
1378 @comment - End Interface
1380 @subsection parport options
1383 @item @b{parport_port} <@var{number}>
1384 @cindex parport_port
1385 @*Either the address of the I/O port (default: 0x378 for LPT1) or the number of
1386 the @file{/dev/parport} device
1388 When using PPDEV to access the parallel port, use the number of the parallel port:
1389 @option{parport_port 0} (the default). If @option{parport_port 0x378} is specified
1390 you may encounter a problem.
1391 @item @b{parport_cable} <@var{name}>
1392 @cindex parport_cable
1393 @*The layout of the parallel port cable used to connect to the target.
1394 Currently supported cables are
1398 The original Wiggler layout, also supported by several clones, such
1399 as the Olimex ARM-JTAG
1402 Same as original wiggler except an led is fitted on D5.
1403 @item @b{wiggler_ntrst_inverted}
1404 @cindex wiggler_ntrst_inverted
1405 Same as original wiggler except TRST is inverted.
1406 @item @b{old_amt_wiggler}
1407 @cindex old_amt_wiggler
1408 The Wiggler configuration that comes with Amontec's Chameleon Programmer. The new
1409 version available from the website uses the original Wiggler layout ('@var{wiggler}')
1412 The Amontec Chameleon's CPLD when operated in configuration mode. This is only used to
1413 program the Chameleon itself, not a connected target.
1416 The Xilinx Parallel cable III.
1419 The parallel port adapter found on the 'Karo Triton 1 Development Board'.
1420 This is also the layout used by the HollyGates design
1421 (see @uref{http://www.lartmaker.nl/projects/jtag/}).
1424 The ST Parallel cable.
1427 Same as original wiggler except SRST and TRST connections reversed and
1428 TRST is also inverted.
1431 Altium Universal JTAG cable.
1433 @item @b{parport_write_on_exit} <@var{on}|@var{off}>
1434 @cindex parport_write_on_exit
1435 @*This will configure the parallel driver to write a known value to the parallel
1436 interface on exiting OpenOCD
1439 @subsection amt_jtagaccel options
1441 @item @b{parport_port} <@var{number}>
1442 @cindex parport_port
1443 @*Either the address of the I/O port (default: 0x378 for LPT1) or the number of the
1444 @file{/dev/parport} device
1446 @subsection ft2232 options
1449 @item @b{ft2232_device_desc} <@var{description}>
1450 @cindex ft2232_device_desc
1451 @*The USB device description of the FTDI FT2232 device. If not
1452 specified, the FTDI default value is used. This setting is only valid
1453 if compiled with FTD2XX support.
1455 @b{TODO:} Confirm the following: On Windows the name needs to end with
1456 a ``space A''? Or not? It has to do with the FTD2xx driver. When must
1457 this be added and when must it not be added? Why can't the code in the
1458 interface or in OpenOCD automatically add this if needed? -- Duane.
1460 @item @b{ft2232_serial} <@var{serial-number}>
1461 @cindex ft2232_serial
1462 @*The serial number of the FTDI FT2232 device. If not specified, the FTDI default
1464 @item @b{ft2232_layout} <@var{name}>
1465 @cindex ft2232_layout
1466 @*The layout of the FT2232 GPIO signals used to control output-enables and reset
1467 signals. Valid layouts are
1470 "USBJTAG-1" layout described in the original OpenOCD diploma thesis
1472 Amontec JTAGkey and JTAGkey-Tiny
1473 @item @b{signalyzer}
1475 @item @b{olimex-jtag}
1478 American Microsystems M5960
1479 @item @b{evb_lm3s811}
1480 Luminary Micro EVB_LM3S811 as a JTAG interface (not onboard processor), no TRST or
1481 SRST signals on external connector
1484 @item @b{stm32stick}
1485 Hitex STM32 Performance Stick
1486 @item @b{flyswatter}
1487 Tin Can Tools Flyswatter
1488 @item @b{turtelizer2}
1489 egnite Software turtelizer2
1492 @item @b{axm0432_jtag}
1495 Hitex Cortino JTAG interface
1498 @item @b{ft2232_vid_pid} <@var{vid}> <@var{pid}>
1499 @*The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
1500 default values are used. Multiple <@var{vid}>, <@var{pid}> pairs may be given, e.g.
1502 ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
1504 @item @b{ft2232_latency} <@var{ms}>
1505 @*On some systems using FT2232 based JTAG interfaces the FT_Read function call in
1506 ft2232_read() fails to return the expected number of bytes. This can be caused by
1507 USB communication delays and has proved hard to reproduce and debug. Setting the
1508 FT2232 latency timer to a larger value increases delays for short USB packets but it
1509 also reduces the risk of timeouts before receiving the expected number of bytes.
1510 The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
1513 @subsection ep93xx options
1514 @cindex ep93xx options
1515 Currently, there are no options available for the ep93xx interface.
1519 JTAG clock setup is part of system setup.
1520 It @emph{does not belong with interface setup} since any interface
1521 only knows a few of the constraints for the JTAG clock speed.
1522 Sometimes the JTAG speed is
1523 changed during the target initialization process: (1) slow at
1524 reset, (2) program the CPU clocks, (3) run fast.
1525 Both the "slow" and "fast" clock rates are functions of the
1526 oscillators used, the chip, the board design, and sometimes
1527 power management software that may be active.
1529 The speed used during reset can be adjusted using pre_reset
1530 and post_reset event handlers.
1531 @xref{Target Events}.
1533 If your system supports adaptive clocking (RTCK), configuring
1534 JTAG to use that is probably the most robust approach.
1535 However, it introduces delays to synchronize clocks; so it
1536 may not be the fastest solution.
1538 @b{NOTE:} Script writers should consider using @command{jtag_rclk}
1539 instead of @command{jtag_khz}.
1541 @deffn {Command} jtag_khz max_speed_kHz
1542 A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
1543 JTAG interfaces usually support a limited number of
1544 speeds. The speed actually used won't be faster
1545 than the speed specified.
1547 As a rule of thumb, if you specify a clock rate make
1548 sure the JTAG clock is no more than @math{1/6th CPU-Clock}.
1549 This is especially true for synthesized cores (ARMxxx-S).
1551 Speed 0 (khz) selects RTCK method.
1553 If your system uses RTCK, you won't need to change the
1554 JTAG clocking after setup.
1555 Not all interfaces, boards, or targets support ``rtck''.
1556 If the interface device can not
1557 support it, an error is returned when you try to use RTCK.
1560 @defun jtag_rclk fallback_speed_kHz
1562 This Tcl proc (defined in startup.tcl) attempts to enable RTCK/RCLK.
1563 If that fails (maybe the interface, board, or target doesn't
1564 support it), falls back to the specified frequency.
1566 # Fall back to 3mhz if RTCK is not supported
1571 @node Reset Configuration
1572 @chapter Reset Configuration
1573 @cindex Reset Configuration
1575 Every system configuration may require a different reset
1576 configuration. This can also be quite confusing.
1577 Resets also interact with @var{reset-init} event handlers,
1578 which do things like setting up clocks and DRAM, and
1579 JTAG clock rates. (@xref{JTAG Speed}.)
1580 Please see the various board files for examples.
1583 To maintainers and integrators:
1584 Reset configuration touches several things at once.
1585 Normally the board configuration file
1586 should define it and assume that the JTAG adapter supports
1587 everything that's wired up to the board's JTAG connector.
1588 However, the target configuration file could also make note
1589 of something the silicon vendor has done inside the chip,
1590 which will be true for most (or all) boards using that chip.
1591 And when the JTAG adapter doesn't support everything, the
1592 system configuration file will need to override parts of
1593 the reset configuration provided by other files.
1596 @section Types of Reset
1598 There are many kinds of reset possible through JTAG, but
1599 they may not all work with a given board and adapter.
1600 That's part of why reset configuration can be error prone.
1604 @emph{System Reset} ... the @emph{SRST} hardware signal
1605 resets all chips connected to the JTAG adapter, such as processors,
1606 power management chips, and I/O controllers. Normally resets triggered
1607 with this signal behave exactly like pressing a RESET button.
1609 @emph{JTAG TAP Reset} ... the @emph{TRST} hardware signal resets
1610 just the TAP controllers connected to the JTAG adapter.
1611 Such resets should not be visible to the rest of the system; resetting a
1612 device's the TAP controller just puts that controller into a known state.
1614 @emph{Emulation Reset} ... many devices can be reset through JTAG
1615 commands. These resets are often distinguishable from system
1616 resets, either explicitly (a "reset reason" register says so)
1617 or implicitly (not all parts of the chip get reset).
1619 @emph{Other Resets} ... system-on-chip devices often support
1620 several other types of reset.
1621 You may need to arrange that a watchdog timer stops
1622 while debugging, preventing a watchdog reset.
1623 There may be individual module resets.
1626 In the best case, OpenOCD can hold SRST, then reset
1627 the TAPs via TRST and send commands through JTAG to halt the
1628 CPU at the reset vector before the 1st instruction is executed.
1629 Then when it finally releases the SRST signal, the system is
1630 halted under debugger control before any code has executed.
1631 This is the behavior required to support the @command{reset halt}
1632 and @command{reset init} commands; after @command{reset init} a
1633 board-specific script might do things like setting up DRAM.
1634 (@xref{Reset Command}.)
1636 @section SRST and TRST Signal Issues
1638 Because SRST and TRST are hardware signals, they can have a
1639 variety of system-specific constraints. Some of the most
1644 @item @emph{Signal not available} ... Some boards don't wire
1645 SRST or TRST to the JTAG connector. Some JTAG adapters don't
1646 support such signals even if they are wired up.
1647 Use the @command{reset_config} @var{signals} options to say
1648 when one of those signals is not connected.
1649 When SRST is not available, your code might not be able to rely
1650 on controllers having been fully reset during code startup.
1652 @item @emph{Signals shorted} ... Sometimes a chip, board, or
1653 adapter will connect SRST to TRST, instead of keeping them separate.
1654 Use the @command{reset_config} @var{combination} options to say
1655 when those signals aren't properly independent.
1657 @item @emph{Timing} ... Reset circuitry like a resistor/capacitor
1658 delay circuit, reset supervisor, or on-chip features can extend
1659 the effect of a JTAG adapter's reset for some time after the adapter
1660 stops issuing the reset. For example, there may be chip or board
1661 requirements that all reset pulses last for at least a
1662 certain amount of time; and reset buttons commonly have
1663 hardware debouncing.
1664 Use the @command{jtag_nsrst_delay} and @command{jtag_ntrst_delay}
1665 commands to say when extra delays are needed.
1667 @item @emph{Drive type} ... Reset lines often have a pullup
1668 resistor, letting the JTAG interface treat them as open-drain
1669 signals. But that's not a requirement, so the adapter may need
1670 to use push/pull output drivers.
1671 Also, with weak pullups it may be advisable to drive
1672 signals to both levels (push/pull) to minimize rise times.
1673 Use the @command{reset_config} @var{trst_type} and
1674 @var{srst_type} parameters to say how to drive reset signals.
1677 There can also be other issues.
1678 Some devices don't fully conform to the JTAG specifications.
1679 Trivial system-specific differences are common, such as
1680 SRST and TRST using slightly different names.
1681 There are also vendors who distribute key JTAG documentation for
1682 their chips only to developers who have signed a Non-Disclosure
1685 Sometimes there are chip-specific extensions like a requirement to use
1686 the normally-optional TRST signal (precluding use of JTAG adapters which
1687 don't pass TRST through), or needing extra steps to complete a TAP reset.
1689 In short, SRST and especially TRST handling may be very finicky,
1690 needing to cope with both architecture and board specific constraints.
1692 @section Commands for Handling Resets
1694 @deffn {Command} jtag_nsrst_delay milliseconds
1695 How long (in milliseconds) OpenOCD should wait after deasserting
1696 nSRST (active-low system reset) before starting new JTAG operations.
1697 When a board has a reset button connected to SRST line it will
1698 probably have hardware debouncing, implying you should use this.
1701 @deffn {Command} jtag_ntrst_delay milliseconds
1702 How long (in milliseconds) OpenOCD should wait after deasserting
1703 nTRST (active-low JTAG TAP reset) before starting new JTAG operations.
1706 @deffn {Command} reset_config mode_flag ...
1707 This command tells OpenOCD the reset configuration
1708 of your combination of JTAG interface, board, and target.
1710 The @var{mode_flag} options can be specified in any order, but only one
1711 of each type -- @var{signals}, @var{combination}, @var{trst_type},
1712 and @var{srst_type} -- may be specified at a time.
1713 If you don't provide a new value for a given type, its previous
1714 value (perhaps the default) is unchanged.
1715 For example, this means that you don't need to say anything at all about
1716 TRST just to declare that if the JTAG adapter should want to drive SRST,
1717 it must explicitly be driven high (@option{srst_push_pull}).
1719 @var{signals} can specify which of the reset signals are connected.
1720 For example, If the JTAG interface provides SRST, but the board doesn't
1721 connect that signal properly, then OpenOCD can't use it.
1722 Possible values are @option{none} (the default), @option{trst_only},
1723 @option{srst_only} and @option{trst_and_srst}.
1726 If your board provides SRST or TRST through the JTAG connector,
1727 you must declare that or else those signals will not be used.
1730 The @var{combination} is an optional value specifying broken reset
1731 signal implementations.
1732 The default behaviour if no option given is @option{separate},
1733 indicating everything behaves normally.
1734 @option{srst_pulls_trst} states that the
1735 test logic is reset together with the reset of the system (e.g. Philips
1736 LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
1737 the system is reset together with the test logic (only hypothetical, I
1738 haven't seen hardware with such a bug, and can be worked around).
1739 @option{combined} implies both @option{srst_pulls_trst} and
1740 @option{trst_pulls_srst}.
1742 The optional @var{trst_type} and @var{srst_type} parameters allow the
1743 driver mode of each reset line to be specified. These values only affect
1744 JTAG interfaces with support for different driver modes, like the Amontec
1745 JTAGkey and JTAGAccelerator. Also, they are necessarily ignored if the
1746 relevant signal (TRST or SRST) is not connected.
1748 Possible @var{trst_type} driver modes for the test reset signal (TRST)
1749 are @option{trst_push_pull} (default) and @option{trst_open_drain}.
1750 Most boards connect this signal to a pulldown, so the JTAG TAPs
1751 never leave reset unless they are hooked up to a JTAG adapter.
1753 Possible @var{srst_type} driver modes for the system reset signal (SRST)
1754 are the default @option{srst_open_drain}, and @option{srst_push_pull}.
1755 Most boards connect this signal to a pullup, and allow the
1756 signal to be pulled low by various events including system
1757 powerup and pressing a reset button.
1762 @chapter Tap Creation
1763 @cindex tap creation
1764 @cindex tap configuration
1766 In order for OpenOCD to control a target, a JTAG tap must be
1769 Commands to create taps are normally found in a configuration file and
1770 are not normally typed by a human.
1772 When a tap is created a @b{dotted.name} is created for the tap. Other
1773 commands use that dotted.name to manipulate or refer to the tap.
1777 @item @b{Debug Target} A tap can be used by a GDB debug target
1778 @item @b{Flash Programing} Some chips program the flash directly via JTAG,
1779 instead of indirectly by making a CPU do it.
1780 @item @b{Boundry Scan} Some chips support boundary scan.
1784 @section jtag newtap
1785 @b{@t{jtag newtap CHIPNAME TAPNAME configparams ....}}
1790 @cindex tap geometry
1792 @comment START options
1795 @* is a symbolic name of the chip.
1797 @* is a symbol name of a tap present on the chip.
1798 @item @b{Required configparams}
1799 @* Every tap has 3 required configparams, and several ``optional
1800 parameters'', the required parameters are:
1801 @comment START REQUIRED
1803 @item @b{-irlen NUMBER} - the length in bits of the instruction register, mostly 4 or 5 bits.
1804 @item @b{-ircapture NUMBER} - the IDCODE capture command, usually 0x01.
1805 @item @b{-irmask NUMBER} - the corresponding mask for the IR register. For
1806 some devices, there are bits in the IR that aren't used. This lets you mask
1807 them off when doing comparisons. In general, this should just be all ones for
1809 @comment END REQUIRED
1811 An example of a FOOBAR Tap
1813 jtag newtap foobar tap -irlen 7 -ircapture 0x42 -irmask 0x55
1815 Creates the tap ``foobar.tap'' with the instruction register (IR) is 7
1816 bits long, during Capture-IR 0x42 is loaded into the IR, and bits
1817 [6,4,2,0] are checked.
1819 @item @b{Optional configparams}
1820 @comment START Optional
1822 @item @b{-expected-id NUMBER}
1823 @* By default it is zero. If non-zero represents the
1824 expected tap ID used when the JTAG chain is examined. Repeat
1825 the option as many times as required if multiple id's can be
1826 expected. See below.
1829 @* By default not specified the tap is enabled. Some chips have a
1830 JTAG route controller (JRC) that is used to enable and/or disable
1831 specific JTAG taps. You can later enable or disable any JTAG tap via
1832 the command @b{jtag tapenable DOTTED.NAME} or @b{jtag tapdisable
1834 @comment END Optional
1837 @comment END OPTIONS
1840 @comment START NOTES
1842 @item @b{Technically}
1843 @* newtap is a sub command of the ``jtag'' command
1844 @item @b{Big Picture Background}
1845 @*GDB Talks to OpenOCD using the GDB protocol via
1846 TCP/IP. OpenOCD then uses the JTAG interface (the dongle) to
1847 control the JTAG chain on your board. Your board has one or more chips
1848 in a @i{daisy chain configuration}. Each chip may have one or more
1849 JTAG taps. GDB ends up talking via OpenOCD to one of the taps.
1850 @item @b{NAME Rules}
1851 @*Names follow ``C'' symbol name rules (start with alpha ...)
1852 @item @b{TAPNAME - Conventions}
1854 @item @b{tap} - should be used only FPGA or CPLD like devices with a single tap.
1855 @item @b{cpu} - the main CPU of the chip, alternatively @b{foo.arm} and @b{foo.dsp}
1856 @item @b{flash} - if the chip has a flash tap, example: str912.flash
1857 @item @b{bs} - for boundary scan if this is a seperate tap.
1858 @item @b{etb} - for an embedded trace buffer (example: an ARM ETB11)
1859 @item @b{jrc} - for JTAG route controller (example: OMAP3530 found on Beagleboards)
1860 @item @b{unknownN} - where N is a number if you have no idea what the tap is for
1861 @item @b{Other names} - Freescale IMX31 has a SDMA (smart dma) with a JTAG tap, that tap should be called the ``sdma'' tap.
1862 @item @b{When in doubt} - use the chip maker's name in their data sheet.
1864 @item @b{DOTTED.NAME}
1865 @* @b{CHIPNAME}.@b{TAPNAME} creates the tap name, aka: the
1866 @b{Dotted.Name} is the @b{CHIPNAME} and @b{TAPNAME} combined with a
1867 dot (period); for example: @b{xilinx.tap}, @b{str912.flash},
1868 @b{omap3530.jrc}, or @b{stm32.cpu} The @b{dotted.name} is used in
1869 numerous other places to refer to various taps.
1871 @* The order this command appears via the config files is
1873 @item @b{Multi Tap Example}
1874 @* This example is based on the ST Microsystems STR912. See the ST
1875 document titled: @b{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
1876 28/102, Figure 3: JTAG chaining inside the STR91xFA}.
1878 @url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}
1879 @*@b{checked: 28/nov/2008}
1881 The diagram shows that the TDO pin connects to the flash tap, flash TDI
1882 connects to the CPU debug tap, CPU TDI connects to the boundary scan
1883 tap which then connects to the TDI pin.
1887 # create tap: 'str912.flash'
1888 jtag newtap str912 flash ... params ...
1889 # create tap: 'str912.cpu'
1890 jtag newtap str912 cpu ... params ...
1891 # create tap: 'str912.bs'
1892 jtag newtap str912 bs ... params ...
1895 @item @b{Note: Deprecated} - Index Numbers
1896 @* Prior to 28/nov/2008, JTAG taps where numbered from 0..N this
1897 feature is still present, however its use is highly discouraged and
1898 should not be counted upon. Update all of your scripts to use
1899 TAP names rather than numbers.
1900 @item @b{Multiple chips}
1901 @* If your board has multiple chips, you should be
1902 able to @b{source} two configuration files, in the proper order, and
1903 have the taps created in the proper order.
1906 @comment at command level
1907 @comment DOCUMENT old command
1908 @section jtag_device - REMOVED
1910 @b{jtag_device} <@var{IR length}> <@var{IR capture}> <@var{IR mask}> <@var{IDCODE instruction}>
1914 @* @b{Removed: 28/nov/2008} This command has been removed and replaced
1915 by the ``jtag newtap'' command. The documentation remains here so that
1916 one can easily convert the old syntax to the new syntax. About the old
1917 syntax: The old syntax is positional, i.e.: The 3rd parameter is the
1918 ``irmask''. The new syntax requires named prefixes, and supports
1919 additional options, for example ``-expected-id 0x3f0f0f0f''. Please refer to the
1920 @b{jtag newtap} command for details.
1922 OLD: jtag_device 8 0x01 0xe3 0xfe
1923 NEW: jtag newtap CHIPNAME TAPNAME -irlen 8 -ircapture 0x01 -irmask 0xe3
1926 @section Enable/Disable Taps
1927 @b{Note:} These commands are intended to be used as a machine/script
1928 interface. Humans might find the ``scan_chain'' command more helpful
1929 when querying the state of the JTAG taps.
1931 @b{By default, all taps are enabled}
1934 @item @b{jtag tapenable} @var{DOTTED.NAME}
1935 @item @b{jtag tapdisable} @var{DOTTED.NAME}
1936 @item @b{jtag tapisenabled} @var{DOTTED.NAME}
1941 @cindex route controller
1943 These commands are used when your target has a JTAG route controller
1944 that effectively adds or removes a tap from the JTAG chain in a
1947 The ``standard way'' to remove a tap would be to place the tap in
1948 bypass mode. But with the advent of modern chips, this is not always a
1949 good solution. Some taps operate slowly, others operate fast, and
1950 there are other JTAG clock synchronisation problems one must face. To
1951 solve that problem, the JTAG route controller was introduced. Rather
1952 than ``bypass'' the tap, the tap is completely removed from the
1953 circuit and skipped.
1956 From OpenOCD's point of view, a JTAG tap is in one of 3 states:
1959 @item @b{Enabled - Not In ByPass} and has a variable bit length
1960 @item @b{Enabled - In ByPass} and has a length of exactly 1 bit.
1961 @item @b{Disabled} and has a length of ZERO and is removed from the circuit.
1964 The IEEE JTAG definition has no concept of a ``disabled'' tap.
1965 @b{Historical note:} this feature was added 28/nov/2008
1967 @b{jtag tapisenabled DOTTED.NAME}
1969 This command returns 1 if the named tap is currently enabled, 0 if not.
1970 This command exists so that scripts that manipulate a JRC (like the
1971 OMAP3530 has) can determine if OpenOCD thinks a tap is presently
1972 enabled or disabled.
1975 @node Target Configuration
1976 @chapter Target Configuration
1979 This chapter discusses how to create a GDB debug target. Before
1980 creating a ``target'' a JTAG tap DOTTED.NAME must exist first.
1982 @section targets [NAME]
1983 @b{Note:} This command name is PLURAL - not singular.
1985 With NO parameter, this plural @b{targets} command lists all known
1986 targets in a human friendly form.
1988 With a parameter, this plural @b{targets} command sets the current
1989 target to the given name. (i.e.: If there are multiple debug targets)
1994 CmdName Type Endian ChainPos State
1995 -- ---------- ---------- ---------- -------- ----------
1996 0: target0 arm7tdmi little 0 halted
1999 @section target COMMANDS
2000 @b{Note:} This command name is SINGULAR - not plural. It is used to
2001 manipulate specific targets, to create targets and other things.
2003 Once a target is created, a TARGETNAME (object) command is created;
2004 see below for details.
2006 The TARGET command accepts these sub-commands:
2008 @item @b{create} .. parameters ..
2009 @* creates a new target, see below for details.
2011 @* Lists all supported target types (perhaps some are not yet in this document).
2013 @* Lists all current debug target names, for example: 'str912.cpu' or 'pxa27.cpu' example usage:
2015 foreach t [target names] {
2016 puts [format "Target: %s\n" $t]
2020 @* Returns the current target. OpenOCD always has, or refers to the ``current target'' in some way.
2021 By default, commands like: ``mww'' (used to write memory) operate on the current target.
2022 @item @b{number} @b{NUMBER}
2023 @* Internally OpenOCD maintains a list of targets - in numerical index
2024 (0..N-1) this command returns the name of the target at index N.
2027 set thename [target number $x]
2028 puts [format "Target %d is: %s\n" $x $thename]
2031 @* Returns the number of targets known to OpenOCD (see number above)
2034 set c [target count]
2035 for { set x 0 } { $x < $c } { incr x } {
2036 # Assuming you have created this function
2037 print_target_details $x
2043 @section TARGETNAME (object) commands
2044 @b{Use:} Once a target is created, an ``object name'' that represents the
2045 target is created. By convention, the target name is identical to the
2046 tap name. In a multiple target system, one can preceed many common
2047 commands with a specific target name and effect only that target.
2049 str912.cpu mww 0x1234 0x42
2050 omap3530.cpu mww 0x5555 123
2053 @b{Model:} The Tcl/Tk language has the concept of object commands. A
2054 good example is a on screen button, once a button is created a button
2055 has a name (a path in Tk terms) and that name is useable as a 1st
2056 class command. For example in Tk, one can create a button and later
2057 configure it like this:
2061 button .foobar -background red -command @{ foo @}
2063 .foobar configure -foreground blue
2065 set x [.foobar cget -background]
2067 puts [format "The button is %s" $x]
2070 In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
2071 button. Commands available as a ``target object'' are:
2073 @comment START targetobj commands.
2075 @item @b{configure} - configure the target; see Target Config/Cget Options below
2076 @item @b{cget} - query the target configuration; see Target Config/Cget Options below
2077 @item @b{curstate} - current target state (running, halt, etc.
2079 @* Intended for a human to see/read the currently configure target events.
2080 @item @b{Various Memory Commands} See the ``mww'' command elsewhere.
2081 @comment start memory
2091 @item @b{Memory To Array, Array To Memory}
2092 @* These are aimed at a machine interface to memory
2094 @item @b{mem2array ARRAYNAME WIDTH ADDRESS COUNT}
2095 @item @b{array2mem ARRAYNAME WIDTH ADDRESS COUNT}
2097 @* @b{ARRAYNAME} is the name of an array variable
2098 @* @b{WIDTH} is 8/16/32 - indicating the memory access size
2099 @* @b{ADDRESS} is the target memory address
2100 @* @b{COUNT} is the number of elements to process
2102 @item @b{Used during ``reset''}
2103 @* These commands are used internally by the OpenOCD scripts to deal
2104 with odd reset situations and are not documented here.
2106 @item @b{arp_examine}
2110 @item @b{arp_waitstate}
2112 @item @b{invoke-event} @b{EVENT-NAME}
2113 @* Invokes the specific event manually for the target
2116 @section Target Events
2118 @anchor{Target Events}
2119 At various times, certain things can happen, or you want them to happen.
2123 @item What should happen when GDB connects? Should your target reset?
2124 @item When GDB tries to flash the target, do you need to enable the flash via a special command?
2125 @item During reset, do you need to write to certain memory location to reconfigure the SDRAM?
2128 All of the above items are handled by target events.
2130 To specify an event action, either during target creation, or later
2131 via ``$_TARGETNAME configure'' see this example.
2133 Syntactially, the option is: ``-event NAME BODY'' where NAME is a
2134 target event name, and BODY is a Tcl procedure or string of commands
2137 The programmers model is the ``-command'' option used in Tcl/Tk
2138 buttons and events. Below are two identical examples, the first
2139 creates and invokes small procedure. The second inlines the procedure.
2142 proc my_attach_proc @{ @} @{
2146 mychip.cpu configure -event gdb-attach my_attach_proc
2147 mychip.cpu configure -event gdb-attach @{
2153 @section Current Events
2154 The following events are available:
2156 @item @b{debug-halted}
2157 @* The target has halted for debug reasons (i.e.: breakpoint)
2158 @item @b{debug-resumed}
2159 @* The target has resumed (i.e.: gdb said run)
2160 @item @b{early-halted}
2161 @* Occurs early in the halt process
2162 @item @b{examine-end}
2163 @* Currently not used (goal: when JTAG examine completes)
2164 @item @b{examine-start}
2165 @* Currently not used (goal: when JTAG examine starts)
2166 @item @b{gdb-attach}
2167 @* When GDB connects
2168 @item @b{gdb-detach}
2169 @* When GDB disconnects
2171 @* When the taret has halted and GDB is not doing anything (see early halt)
2172 @item @b{gdb-flash-erase-start}
2173 @* Before the GDB flash process tries to erase the flash
2174 @item @b{gdb-flash-erase-end}
2175 @* After the GDB flash process has finished erasing the flash
2176 @item @b{gdb-flash-write-start}
2177 @* Before GDB writes to the flash
2178 @item @b{gdb-flash-write-end}
2179 @* After GDB writes to the flash
2181 @* Before the taret steps, gdb is trying to start/resume the target
2183 @* The target has halted
2184 @item @b{old-gdb_program_config}
2185 @* DO NOT USE THIS: Used internally
2186 @item @b{old-pre_resume}
2187 @* DO NOT USE THIS: Used internally
2188 @item @b{reset-assert-pre}
2189 @* Before reset is asserted on the tap.
2190 @item @b{reset-assert-post}
2191 @* Reset is now asserted on the tap.
2192 @item @b{reset-deassert-pre}
2193 @* Reset is about to be released on the tap
2194 @item @b{reset-deassert-post}
2195 @* Reset has been released on the tap
2197 @* Currently not used.
2198 @item @b{reset-halt-post}
2199 @* Currently not usd
2200 @item @b{reset-halt-pre}
2201 @* Currently not used
2202 @item @b{reset-init}
2203 @* Used by @b{reset init} command for board-specific initialization.
2204 This is where you would configure PLLs and clocking, set up DRAM so
2205 you can download programs that don't fit in on-chip SRAM, set up pin
2206 multiplexing, and so on.
2207 @item @b{reset-start}
2208 @* Currently not used
2209 @item @b{reset-wait-pos}
2210 @* Currently not used
2211 @item @b{reset-wait-pre}
2212 @* Currently not used
2213 @item @b{resume-start}
2214 @* Before any target is resumed
2215 @item @b{resume-end}
2216 @* After all targets have resumed
2220 @* Target has resumed
2221 @item @b{tap-enable}
2222 @* Executed by @b{jtag tapenable DOTTED.NAME} command. Example:
2224 jtag configure DOTTED.NAME -event tap-enable @{
2229 @item @b{tap-disable}
2230 @*Executed by @b{jtag tapdisable DOTTED.NAME} command. Example:
2232 jtag configure DOTTED.NAME -event tap-disable @{
2233 puts "Disabling CPU"
2239 @section Target Create
2240 @anchor{Target Create}
2242 @cindex target creation
2245 @b{target} @b{create} <@var{NAME}> <@var{TYPE}> <@var{PARAMS ...}>
2247 @*This command creates a GDB debug target that refers to a specific JTAG tap.
2248 @comment START params
2251 @* Is the name of the debug target. By convention it should be the tap
2252 DOTTED.NAME. This name is also used to create the target object
2253 command, and in other places the target needs to be identified.
2255 @* Specifies the target type, i.e.: ARM7TDMI, or Cortex-M3. Currently supported targets are:
2256 @comment START types
2273 @*PARAMs are various target configuration parameters. The following ones are mandatory:
2274 @comment START mandatory
2276 @item @b{-endian big|little}
2277 @item @b{-chain-position DOTTED.NAME}
2278 @comment end MANDATORY
2283 @section Target Config/Cget Options
2284 These options can be specified when the target is created, or later
2285 via the configure option or to query the target via cget.
2287 You should specify a working area if you can; typically it uses some
2288 on-chip SRAM. Such a working area can speed up many things, including bulk
2289 writes to target memory; flash operations like checking to see if memory needs
2290 to be erased; GDB memory checksumming; and may help perform otherwise
2291 unavailable operations (like some coprocessor operations on ARM7/9 systems).
2293 @item @b{-type} - returns the target type
2294 @item @b{-event NAME BODY} see Target events
2295 @item @b{-work-area-virt [ADDRESS]} specify/set the work area base address
2296 which will be used when an MMU is active.
2297 @item @b{-work-area-phys [ADDRESS]} specify/set the work area base address
2298 which will be used when an MMU is inactive.
2299 @item @b{-work-area-size [ADDRESS]} specify/set the work area
2300 @item @b{-work-area-backup [0|1]} does the work area get backed up;
2301 by default, it doesn't. When possible, use a working_area that doesn't
2302 need to be backed up, since performing a backup slows down operations.
2303 @item @b{-endian [big|little]}
2304 @item @b{-variant [NAME]} some chips have variants OpenOCD needs to know about
2305 @item @b{-chain-position DOTTED.NAME} the tap name this target refers to.
2309 for @{ set x 0 @} @{ $x < [target count] @} @{ incr x @} @{
2310 set name [target number $x]
2311 set y [$name cget -endian]
2312 set z [$name cget -type]
2313 puts [format "Chip %d is %s, Endian: %s, type: %s" $x $y $z]
2317 @section Target Variants
2320 @* Use variant @option{lm3s} when debugging older Stellaris LM3S targets.
2321 This will cause OpenOCD to use a software reset rather than asserting
2322 SRST, to avoid a issue with clearing the debug registers.
2323 This is fixed in Fury Rev B, DustDevil Rev B, Tempest; these revisions will
2324 be detected and the normal reset behaviour used.
2326 @*Supported variants are
2327 @option{ixp42x}, @option{ixp45x}, @option{ixp46x},
2328 @option{pxa250}, @option{pxa255}, @option{pxa26x}.
2330 @* Use variant @option{ejtag_srst} when debugging targets that do not
2331 provide a functional SRST line on the EJTAG connector. This causes
2332 OpenOCD to instead use an EJTAG software reset command to reset the
2333 processor. You still need to enable @option{srst} on the reset
2334 configuration command to enable OpenOCD hardware reset functionality.
2335 @comment END variants
2337 @section working_area - Command Removed
2338 @cindex working_area
2339 @*@b{Please use the ``$_TARGETNAME configure -work-area-... parameters instead}
2340 @* This documentation remains because there are existing scripts that
2341 still use this that need to be converted.
2343 working_area target# address size backup| [virtualaddress]
2345 @* The target# is a the 0 based target numerical index.
2347 @node Flash Commands
2348 @chapter Flash Commands
2350 OpenOCD has different commands for NOR and NAND flash;
2351 the ``flash'' command works with NOR flash, while
2352 the ``nand'' command works with NAND flash.
2353 This partially reflects different hardware technologies:
2354 NOR flash usually supports direct CPU instruction and data bus access,
2355 while data from a NAND flash must be copied to memory before it can be
2356 used. (SPI flash must also be copied to memory before use.)
2357 However, the documentation also uses ``flash'' as a generic term;
2358 for example, ``Put flash configuration in board-specific files''.
2361 As of 28-nov-2008 OpenOCD does not know how to program a SPI
2362 flash that a micro may boot from. Perhaps you, the reader, would like to
2363 contribute support for this.
2368 @item Configure via the command @command{flash bank}
2369 @* Do this in a board-specific configuration file,
2370 passing parameters as needed by the driver.
2371 @item Operate on the flash via @command{flash subcommand}
2372 @* Often commands to manipulate the flash are typed by a human, or run
2373 via a script in some automated way. Common tasks include writing a
2374 boot loader, operating system, or other data.
2376 @* Flashing via GDB requires the flash be configured via ``flash
2377 bank'', and the GDB flash features be enabled.
2378 @xref{GDB Configuration}.
2381 Many CPUs have the ablity to ``boot'' from the first flash bank.
2382 This means that misprograming that bank can ``brick'' a system,
2383 so that it can't boot.
2384 JTAG tools, like OpenOCD, are often then used to ``de-brick'' the
2385 board by (re)installing working boot firmware.
2387 @section Flash Configuration Commands
2388 @cindex flash configuration
2390 @deffn {Config Command} {flash bank} driver base size chip_width bus_width target [driver_options]
2391 Configures a flash bank which provides persistent storage
2392 for addresses from @math{base} to @math{base + size - 1}.
2393 These banks will often be visible to GDB through the target's memory map.
2394 In some cases, configuring a flash bank will activate extra commands;
2395 see the driver-specific documentation.
2398 @item @var{driver} ... identifies the controller driver
2399 associated with the flash bank being declared.
2400 This is usually @code{cfi} for external flash, or else
2401 the name of a microcontroller with embedded flash memory.
2402 @xref{Flash Driver List}.
2403 @item @var{base} ... Base address of the flash chip.
2404 @item @var{size} ... Size of the chip, in bytes.
2405 For some drivers, this value is detected from the hardware.
2406 @item @var{chip_width} ... Width of the flash chip, in bytes;
2407 ignored for most microcontroller drivers.
2408 @item @var{bus_width} ... Width of the data bus used to access the
2409 chip, in bytes; ignored for most microcontroller drivers.
2410 @item @var{target} ... Names the target used to issue
2411 commands to the flash controller.
2412 @comment Actually, it's currently a controller-specific parameter...
2413 @item @var{driver_options} ... drivers may support, or require,
2414 additional parameters. See the driver-specific documentation
2415 for more information.
2418 This command is not available after OpenOCD initialization has completed.
2419 Use it in board specific configuration files, not interactively.
2423 @comment the REAL name for this command is "ocd_flash_banks"
2424 @comment less confusing would be: "flash list" (like "nand list")
2425 @deffn Command {flash banks}
2426 Prints a one-line summary of each device declared
2427 using @command{flash bank}, numbered from zero.
2428 Note that this is the @emph{plural} form;
2429 the @emph{singular} form is a very different command.
2432 @deffn Command {flash probe} num
2433 Identify the flash, or validate the parameters of the configured flash. Operation
2434 depends on the flash type.
2435 The @var{num} parameter is a value shown by @command{flash banks}.
2436 Most flash commands will implicitly @emph{autoprobe} the bank;
2437 flash drivers can distinguish between probing and autoprobing,
2438 but most don't bother.
2441 @section Erasing, Reading, Writing to Flash
2442 @cindex flash erasing
2443 @cindex flash reading
2444 @cindex flash writing
2445 @cindex flash programming
2447 One feature distinguishing NOR flash from NAND or serial flash technologies
2448 is that for read access, it acts exactly like any other addressible memory.
2449 This means you can use normal memory read commands like @command{mdw} or
2450 @command{dump_image} with it, with no special @command{flash} subcommands.
2451 @xref{Memory access}.
2452 @xref{Image access}.
2454 Write access works differently. Flash memory normally needs to be erased
2455 before it's written. Erasing a sector turns all of its bits to ones, and
2456 writing can turn ones into zeroes. This is why there are special commands
2457 for interactive erasing and writing, and why GDB needs to know which parts
2458 of the address space hold NOR flash memory.
2461 Most of these erase and write commands leverage the fact that NOR flash
2462 chips consume target address space. They implicitly refer to the current
2463 JTAG target, and map from an address in that target's address space
2464 back to a flash bank.
2465 @comment In May 2009, those mappings may fail if any bank associated
2466 @comment with that target doesn't succesfuly autoprobe ... bug worth fixing?
2467 A few commands use abstract addressing based on bank and sector numbers,
2468 and don't depend on searching the current target and its address space.
2469 Avoid confusing the two command models.
2472 Some flash chips implement software protection against accidental writes,
2473 since such buggy writes could in some cases ``brick'' a system.
2474 For such systems, erasing and writing may require sector protection to be
2476 Examples include CFI flash such as ``Intel Advanced Bootblock flash'',
2477 and AT91SAM7 on-chip flash.
2478 @xref{flash protect}.
2480 @anchor{flash erase_sector}
2481 @deffn Command {flash erase_sector} num first last
2482 Erase sectors in bank @var{num}, starting at sector @var{first} up to and including
2483 @var{last}. Sector numbering starts at 0.
2484 The @var{num} parameter is a value shown by @command{flash banks}.
2487 @deffn Command {flash erase_address} address length
2488 Erase sectors starting at @var{address} for @var{length} bytes.
2489 The flash bank to use is inferred from the @var{address}, and
2490 the specified length must stay within that bank.
2491 As a special case, when @var{length} is zero and @var{address} is
2492 the start of the bank, the whole flash is erased.
2495 @deffn Command {flash fillw} address word length
2496 @deffnx Command {flash fillh} address halfword length
2497 @deffnx Command {flash fillb} address byte length
2498 Fills flash memory with the specified @var{word} (32 bits),
2499 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
2500 starting at @var{address} and continuing
2501 for @var{length} units (word/halfword/byte).
2502 No erasure is done before writing; when needed, that must be done
2503 before issuing this command.
2504 Writes are done in blocks of up to 1024 bytes, and each write is
2505 verified by reading back the data and comparing it to what was written.
2506 The flash bank to use is inferred from the @var{address} of
2507 each block, and the specified length must stay within that bank.
2509 @comment no current checks for errors if fill blocks touch multiple banks!
2511 @anchor{flash write_bank}
2512 @deffn Command {flash write_bank} num filename offset
2513 Write the binary @file{filename} to flash bank @var{num},
2514 starting at @var{offset} bytes from the beginning of the bank.
2515 The @var{num} parameter is a value shown by @command{flash banks}.
2518 @anchor{flash write_image}
2519 @deffn Command {flash write_image} [erase] filename [offset] [type]
2520 Write the image @file{filename} to the current target's flash bank(s).
2521 A relocation @var{offset} may be specified, in which case it is added
2522 to the base address for each section in the image.
2523 The file [@var{type}] can be specified
2524 explicitly as @option{bin} (binary), @option{ihex} (Intel hex),
2525 @option{elf} (ELF file), @option{s19} (Motorola s19).
2526 @option{mem}, or @option{builder}.
2527 The relevant flash sectors will be erased prior to programming
2528 if the @option{erase} parameter is given.
2529 The flash bank to use is inferred from the @var{address} of
2533 @section Other Flash commands
2534 @cindex flash protection
2536 @deffn Command {flash erase_check} num
2537 Check erase state of sectors in flash bank @var{num},
2538 and display that status.
2539 The @var{num} parameter is a value shown by @command{flash banks}.
2540 This is the only operation that
2541 updates the erase state information displayed by @option{flash info}. That means you have
2542 to issue an @command{flash erase_check} command after erasing or programming the device
2543 to get updated information.
2544 (Code execution may have invalidated any state records kept by OpenOCD.)
2547 @deffn Command {flash info} num
2548 Print info about flash bank @var{num}
2549 The @var{num} parameter is a value shown by @command{flash banks}.
2550 The information includes per-sector protect status.
2553 @anchor{flash protect}
2554 @deffn Command {flash protect} num first last (on|off)
2555 Enable (@var{on}) or disable (@var{off}) protection of flash sectors
2556 @var{first} to @var{last} of flash bank @var{num}.
2557 The @var{num} parameter is a value shown by @command{flash banks}.
2560 @deffn Command {flash protect_check} num
2561 Check protection state of sectors in flash bank @var{num}.
2562 The @var{num} parameter is a value shown by @command{flash banks}.
2563 @comment @option{flash erase_sector} using the same syntax.
2566 @section Flash Drivers, Options, and Commands
2567 @anchor{Flash Driver List}
2568 As noted above, the @command{flash bank} command requires a driver name,
2569 and allows driver-specific options and behaviors.
2570 Some drivers also activate driver-specific commands.
2572 @subsection External Flash
2574 @deffn {Flash Driver} cfi
2575 @cindex Common Flash Interface
2577 The ``Common Flash Interface'' (CFI) is the main standard for
2578 external NOR flash chips, each of which connects to a
2579 specific external chip select on the CPU.
2580 Frequently the first such chip is used to boot the system.
2581 Your board's @code{reset-init} handler might need to
2582 configure additional chip selects using other commands (like: @command{mww} to
2583 configure a bus and its timings) , or
2584 perhaps configure a GPIO pin that controls the ``write protect'' pin
2586 The CFI driver can use a target-specific working area to significantly
2589 The CFI driver can accept the following optional parameters, in any order:
2592 @item @var{jedec_probe} ... is used to detect certain non-CFI flash ROMs,
2593 like AM29LV010 and similar types.
2594 @item @var{x16_as_x8} ...
2597 To configure two adjacent banks of 16 MBytes each, both sixteen bits (two bytes)
2598 wide on a sixteen bit bus:
2601 flash bank cfi 0x00000000 0x01000000 2 2 $_TARGETNAME
2602 flash bank cfi 0x01000000 0x01000000 2 2 $_TARGETNAME
2606 @subsection Internal Flash (Microcontrollers)
2608 @deffn {Flash Driver} aduc702x
2609 The ADUC702x analog microcontrollers from ST Micro
2610 include internal flash and use ARM7TDMI cores.
2611 The aduc702x flash driver works with models ADUC7019 through ADUC7028.
2612 The setup command only requires the @var{target} argument
2613 since all devices in this family have the same memory layout.
2616 flash bank aduc702x 0 0 0 0 $_TARGETNAME
2620 @deffn {Flash Driver} at91sam7
2621 All members of the AT91SAM7 microcontroller family from Atmel
2622 include internal flash and use ARM7TDMI cores.
2623 The driver automatically recognizes a number of these chips using
2624 the chip identification register, and autoconfigures itself.
2627 flash bank at91sam7 0 0 0 0 $_TARGETNAME
2630 For chips which are not recognized by the controller driver, you must
2631 provide additional parameters in the following order:
2634 @item @var{chip_model} ... label used with @command{flash info}
2636 @item @var{sectors_per_bank}
2637 @item @var{pages_per_sector}
2638 @item @var{pages_size}
2639 @item @var{num_nvm_bits}
2640 @item @var{freq_khz} ... required if an external clock is provided,
2641 optional (but recommended) when the oscillator frequency is known
2644 It is recommended that you provide zeroes for all of those values
2645 except the clock frequency, so that everything except that frequency
2646 will be autoconfigured.
2647 Knowing the frequency helps ensure correct timings for flash access.
2649 The flash controller handles erases automatically on a page (128/256 byte)
2650 basis, so explicit erase commands are not necessary for flash programming.
2651 However, there is an ``EraseAll`` command that can erase an entire flash
2652 plane (of up to 256KB), and it will be used automatically when you issue
2653 @command{flash erase_sector} or @command{flash erase_address} commands.
2655 @deffn Command {at91sam7 gpnvm} bitnum (set|clear)
2656 Set or clear a ``General Purpose Non-Volatle Memory'' (GPNVM)
2657 bit for the processor. Each processor has a number of such bits,
2658 used for controlling features such as brownout detection (so they
2659 are not truly general purpose).
2661 This assumes that the first flash bank (number 0) is associated with
2662 the appropriate at91sam7 target.
2667 @deffn {Flash Driver} avr
2668 The AVR 8-bit microcontrollers from Atmel integrate flash memory.
2669 @emph{The current implementation is incomplete.}
2670 @comment - defines mass_erase ... pointless given flash_erase_address
2673 @deffn {Flash Driver} ecosflash
2674 @emph{No idea what this is...}
2675 The @var{ecosflash} driver defines one mandatory parameter,
2676 the name of a modules of target code which is downloaded
2680 @deffn {Flash Driver} lpc2000
2681 Most members of the LPC2000 microcontroller family from NXP
2682 include internal flash and use ARM7TDMI cores.
2683 The @var{lpc2000} driver defines two mandatory and one optional parameters,
2684 which must appear in the following order:
2687 @item @var{variant} ... required, may be
2688 @var{lpc2000_v1} (older LPC21xx and LPC22xx)
2689 or @var{lpc2000_v2} (LPC213x, LPC214x, LPC210[123], LPC23xx and LPC24xx)
2690 @item @var{clock_kHz} ... the frequency, in kiloHertz,
2691 at which the core is running
2692 @item @var{calc_checksum} ... optional (but you probably want to provide this!),
2693 telling the driver to calculate a valid checksum for the exception vector table.
2696 LPC flashes don't require the chip and bus width to be specified.
2699 flash bank lpc2000 0x0 0x7d000 0 0 $_TARGETNAME \
2700 lpc2000_v2 14765 calc_checksum
2704 @deffn {Flash Driver} lpc288x
2705 The LPC2888 microcontroller from NXP needs slightly different flash
2706 support from its lpc2000 siblings.
2707 The @var{lpc288x} driver defines one mandatory parameter,
2708 the programming clock rate in Hz.
2709 LPC flashes don't require the chip and bus width to be specified.
2712 flash bank lpc288x 0 0 0 0 $_TARGETNAME 12000000
2716 @deffn {Flash Driver} ocl
2717 @emph{No idea what this is, other than using some arm7/arm9 core.}
2720 flash bank ocl 0 0 0 0 $_TARGETNAME
2724 @deffn {Flash Driver} pic32mx
2725 The PIC32MX microcontrollers are based on the MIPS 4K cores,
2726 and integrate flash memory.
2727 @emph{The current implementation is incomplete.}
2730 flash bank pix32mx 0 0 0 0 $_TARGETNAME
2733 @comment numerous *disabled* commands are defined:
2734 @comment - chip_erase ... pointless given flash_erase_address
2735 @comment - lock, unlock ... pointless given protect on/off (yes?)
2736 @comment - pgm_word ... shouldn't bank be deduced from address??
2737 Some pic32mx-specific commands are defined:
2738 @deffn Command {pic32mx pgm_word} address value bank
2739 Programs the specified 32-bit @var{value} at the given @var{address}
2740 in the specified chip @var{bank}.
2744 @deffn {Flash Driver} stellaris
2745 All members of the Stellaris LM3Sxxx microcontroller family from
2747 include internal flash and use ARM Cortex M3 cores.
2748 The driver automatically recognizes a number of these chips using
2749 the chip identification register, and autoconfigures itself.
2750 @footnote{Currently there is a @command{stellaris mass_erase} command.
2751 That seems pointless since the same effect can be had using the
2752 standard @command{flash erase_address} command.}
2755 flash bank stellaris 0 0 0 0 $_TARGETNAME
2759 @deffn {Flash Driver} stm32x
2760 All members of the STM32 microcontroller family from ST Microelectronics
2761 include internal flash and use ARM Cortex M3 cores.
2762 The driver automatically recognizes a number of these chips using
2763 the chip identification register, and autoconfigures itself.
2766 flash bank stm32x 0 0 0 0 $_TARGETNAME
2769 Some stm32x-specific commands
2770 @footnote{Currently there is a @command{stm32x mass_erase} command.
2771 That seems pointless since the same effect can be had using the
2772 standard @command{flash erase_address} command.}
2775 @deffn Command {stm32x lock} num
2776 Locks the entire stm32 device.
2777 The @var{num} parameter is a value shown by @command{flash banks}.
2780 @deffn Command {stm32x unlock} num
2781 Unlocks the entire stm32 device.
2782 The @var{num} parameter is a value shown by @command{flash banks}.
2785 @deffn Command {stm32x options_read} num
2786 Read and display the stm32 option bytes written by
2787 the @command{stm32x options_write} command.
2788 The @var{num} parameter is a value shown by @command{flash banks}.
2791 @deffn Command {stm32x options_write} num (SWWDG|HWWDG) (RSTSTNDBY|NORSTSTNDBY) (RSTSTOP|NORSTSTOP)
2792 Writes the stm32 option byte with the specified values.
2793 The @var{num} parameter is a value shown by @command{flash banks}.
2797 @deffn {Flash Driver} str7x
2798 All members of the STR7 microcontroller family from ST Microelectronics
2799 include internal flash and use ARM7TDMI cores.
2800 The @var{str7x} driver defines one mandatory parameter, @var{variant},
2801 which is either @code{STR71x}, @code{STR73x} or @code{STR75x}.
2804 flash bank str7x 0x40000000 0x00040000 0 0 $_TARGETNAME STR71x
2808 @deffn {Flash Driver} str9x
2809 Most members of the STR9 microcontroller family from ST Microelectronics
2810 include internal flash and use ARM966E cores.
2811 The str9 needs the flash controller to be configured using
2812 the @command{str9x flash_config} command prior to Flash programming.
2815 flash bank str9x 0x40000000 0x00040000 0 0 $_TARGETNAME
2816 str9x flash_config 0 4 2 0 0x80000
2819 @deffn Command {str9x flash_config} num bbsr nbbsr bbadr nbbadr
2820 Configures the str9 flash controller.
2821 The @var{num} parameter is a value shown by @command{flash banks}.
2824 @item @var{bbsr} - Boot Bank Size register
2825 @item @var{nbbsr} - Non Boot Bank Size register
2826 @item @var{bbadr} - Boot Bank Start Address register
2827 @item @var{nbbadr} - Boot Bank Start Address register
2833 @deffn {Flash Driver} tms470
2834 Most members of the TMS470 microcontroller family from Texas Instruments
2835 include internal flash and use ARM7TDMI cores.
2836 This driver doesn't require the chip and bus width to be specified.
2838 Some tms470-specific commands are defined:
2840 @deffn Command {tms470 flash_keyset} key0 key1 key2 key3
2841 Saves programming keys in a register, to enable flash erase and write commands.
2844 @deffn Command {tms470 osc_mhz} clock_mhz
2845 Reports the clock speed, which is used to calculate timings.
2848 @deffn Command {tms470 plldis} (0|1)
2849 Disables (@var{1}) or enables (@var{0}) use of the PLL to speed up
2854 @subsection str9xpec driver
2857 Here is some background info to help
2858 you better understand how this driver works. OpenOCD has two flash drivers for
2862 Standard driver @option{str9x} programmed via the str9 core. Normally used for
2863 flash programming as it is faster than the @option{str9xpec} driver.
2865 Direct programming @option{str9xpec} using the flash controller. This is an
2866 ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
2867 core does not need to be running to program using this flash driver. Typical use
2868 for this driver is locking/unlocking the target and programming the option bytes.
2871 Before we run any commands using the @option{str9xpec} driver we must first disable
2872 the str9 core. This example assumes the @option{str9xpec} driver has been
2873 configured for flash bank 0.
2875 # assert srst, we do not want core running
2876 # while accessing str9xpec flash driver
2878 # turn off target polling
2881 str9xpec enable_turbo 0
2883 str9xpec options_read 0
2884 # re-enable str9 core
2885 str9xpec disable_turbo 0
2889 The above example will read the str9 option bytes.
2890 When performing a unlock remember that you will not be able to halt the str9 - it
2891 has been locked. Halting the core is not required for the @option{str9xpec} driver
2892 as mentioned above, just issue the commands above manually or from a telnet prompt.
2894 @subsubsection str9xpec driver options
2896 @b{flash bank str9xpec} <@var{base}> <@var{size}> 0 0 <@var{target}>
2897 @*Before using the flash commands the turbo mode must be enabled using str9xpec
2898 @option{enable_turbo} <@var{num>.}
2900 Only use this driver for locking/unlocking the device or configuring the option bytes.
2901 Use the standard str9 driver for programming.
2903 @subsubsection str9xpec specific commands
2904 @cindex str9xpec specific commands
2905 These are flash specific commands when using the str9xpec driver.
2908 @item @b{str9xpec enable_turbo} <@var{num}>
2909 @cindex str9xpec enable_turbo
2910 @*enable turbo mode, will simply remove the str9 from the chain and talk
2911 directly to the embedded flash controller.
2912 @item @b{str9xpec disable_turbo} <@var{num}>
2913 @cindex str9xpec disable_turbo
2914 @*restore the str9 into JTAG chain.
2915 @item @b{str9xpec lock} <@var{num}>
2916 @cindex str9xpec lock
2917 @*lock str9 device. The str9 will only respond to an unlock command that will
2919 @item @b{str9xpec unlock} <@var{num}>
2920 @cindex str9xpec unlock
2921 @*unlock str9 device.
2922 @item @b{str9xpec options_read} <@var{num}>
2923 @cindex str9xpec options_read
2924 @*read str9 option bytes.
2925 @item @b{str9xpec options_write} <@var{num}>
2926 @cindex str9xpec options_write
2927 @*write str9 option bytes.
2930 @subsubsection STR9 option byte configuration
2931 @cindex STR9 option byte configuration
2934 @item @b{str9xpec options_cmap} <@var{num}> <@option{bank0}|@option{bank1}>
2935 @cindex str9xpec options_cmap
2936 @*configure str9 boot bank.
2937 @item @b{str9xpec options_lvdthd} <@var{num}> <@option{2.4v}|@option{2.7v}>
2938 @cindex str9xpec options_lvdthd
2939 @*configure str9 lvd threshold.
2940 @item @b{str9xpec options_lvdsel} <@var{num}> <@option{vdd}|@option{vdd_vddq}>
2941 @cindex str9xpec options_lvdsel
2942 @*configure str9 lvd source.
2943 @item @b{str9xpec options_lvdwarn} <@var{bank}> <@option{vdd}|@option{vdd_vddq}>
2944 @cindex str9xpec options_lvdwarn
2945 @*configure str9 lvd reset warning source.
2950 @subsection mFlash Configuration
2951 @cindex mFlash Configuration
2952 @b{mflash bank} <@var{soc}> <@var{base}> <@var{RST pin}> <@var{target}>
2954 @*Configures a mflash for <@var{soc}> host bank at
2955 <@var{base}>. Pin number format is dependent on host GPIO calling convention.
2956 Currently, mflash bank support s3c2440 and pxa270.
2958 (ex. of s3c2440) mflash <@var{RST pin}> is GPIO B1.
2961 mflash bank s3c2440 0x10000000 1b 0
2964 (ex. of pxa270) mflash <@var{RST pin}> is GPIO 43.
2967 mflash bank pxa270 0x08000000 43 0
2970 @subsection mFlash commands
2971 @cindex mFlash commands
2974 @item @b{mflash probe}
2975 @cindex mflash probe
2977 @item @b{mflash write} <@var{num}> <@var{file}> <@var{offset}>
2978 @cindex mflash write
2979 @*Write the binary <@var{file}> to mflash bank <@var{num}>, starting at
2980 <@var{offset}> bytes from the beginning of the bank.
2981 @item @b{mflash dump} <@var{num}> <@var{file}> <@var{offset}> <@var{size}>
2983 @*Dump <size> bytes, starting at <@var{offset}> bytes from the beginning of the <@var{num}> bank
2985 @item @b{mflash config pll} <@var{frequency}>
2986 @cindex mflash config pll
2987 @*Configure mflash pll. <@var{frequency}> is input frequency of mflash. The order is Hz.
2988 Issuing this command will erase mflash's whole internal nand and write new pll.
2989 After this command, mflash needs power-on-reset for normal operation.
2990 If pll was newly configured, storage and boot(optional) info also need to be update.
2991 @item @b{mflash config boot}
2992 @cindex mflash config boot
2993 @*Configure bootable option. If bootable option is set, mflash offer the first 8 sectors
2995 @item @b{mflash config storage}
2996 @cindex mflash config storage
2997 @*Configure storage information. For the normal storage operation, this information must be
3001 @node NAND Flash Commands
3002 @chapter NAND Flash Commands
3005 Compared to NOR or SPI flash, NAND devices are inexpensive
3006 and high density. Today's NAND chips, and multi-chip modules,
3007 commonly hold multiple GigaBytes of data.
3009 NAND chips consist of a number of ``erase blocks'' of a given
3010 size (such as 128 KBytes), each of which is divided into a
3011 number of pages (of perhaps 512 or 2048 bytes each). Each
3012 page of a NAND flash has an ``out of band'' (OOB) area to hold
3013 Error Correcting Code (ECC) and other metadata, usually 16 bytes
3014 of OOB for every 512 bytes of page data.
3016 One key characteristic of NAND flash is that its error rate
3017 is higher than that of NOR flash. In normal operation, that
3018 ECC is used to correct and detect errors. However, NAND
3019 blocks can also wear out and become unusable; those blocks
3020 are then marked "bad". NAND chips are even shipped from the
3021 manufacturer with a few bad blocks. The highest density chips
3022 use a technology (MLC) that wears out more quickly, so ECC
3023 support is increasingly important as a way to detect blocks
3024 that have begun to fail, and help to preserve data integrity
3025 with techniques such as wear leveling.
3027 Software is used to manage the ECC. Some controllers don't
3028 support ECC directly; in those cases, software ECC is used.
3029 Other controllers speed up the ECC calculations with hardware.
3030 Single-bit error correction hardware is routine. Controllers
3031 geared for newer MLC chips may correct 4 or more errors for
3032 every 512 bytes of data.
3034 You will need to make sure that any data you write using
3035 OpenOCD includes the apppropriate kind of ECC. For example,
3036 that may mean passing the @code{oob_softecc} flag when
3037 writing NAND data, or ensuring that the correct hardware
3040 The basic steps for using NAND devices include:
3042 @item Declare via the command @command{nand device}
3043 @* Do this in a board-specific configuration file,
3044 passing parameters as needed by the controller.
3045 @item Configure each device using @command{nand probe}.
3046 @* Do this only after the associated target is set up,
3047 such as in its reset-init script or in procures defined
3048 to access that device.
3049 @item Operate on the flash via @command{nand subcommand}
3050 @* Often commands to manipulate the flash are typed by a human, or run
3051 via a script in some automated way. Common task include writing a
3052 boot loader, operating system, or other data needed to initialize or
3056 @b{NOTE:} At the time this text was written, the largest NAND
3057 flash fully supported by OpenOCD is 2 GiBytes (16 GiBits).
3058 This is because the variables used to hold offsets and lengths
3059 are only 32 bits wide.
3060 (Larger chips may work in some cases, unless an offset or length
3061 is larger than 0xffffffff, the largest 32-bit unsigned integer.)
3062 Some larger devices will work, since they are actually multi-chip
3063 modules with two smaller chips and individual chipselect lines.
3065 @section NAND Configuration Commands
3066 @cindex NAND configuration
3068 NAND chips must be declared in configuration scripts,
3069 plus some additional configuration that's done after
3070 OpenOCD has initialized.
3072 @deffn {Config Command} {nand device} controller target [configparams...]
3073 Declares a NAND device, which can be read and written to
3074 after it has been configured through @command{nand probe}.
3075 In OpenOCD, devices are single chips; this is unlike some
3076 operating systems, which may manage multiple chips as if
3077 they were a single (larger) device.
3078 In some cases, configuring a device will activate extra
3079 commands; see the controller-specific documentation.
3081 @b{NOTE:} This command is not available after OpenOCD
3082 initialization has completed. Use it in board specific
3083 configuration files, not interactively.
3086 @item @var{controller} ... identifies the controller driver
3087 associated with the NAND device being declared.
3088 @xref{NAND Driver List}.
3089 @item @var{target} ... names the target used when issuing
3090 commands to the NAND controller.
3091 @comment Actually, it's currently a controller-specific parameter...
3092 @item @var{configparams} ... controllers may support, or require,
3093 additional parameters. See the controller-specific documentation
3094 for more information.
3098 @deffn Command {nand list}
3099 Prints a one-line summary of each device declared
3100 using @command{nand device}, numbered from zero.
3101 Note that un-probed devices show no details.
3104 @deffn Command {nand probe} num
3105 Probes the specified device to determine key characteristics
3106 like its page and block sizes, and how many blocks it has.
3107 The @var{num} parameter is the value shown by @command{nand list}.
3108 You must (successfully) probe a device before you can use
3109 it with most other NAND commands.
3112 @section Erasing, Reading, Writing to NAND Flash
3114 @deffn Command {nand dump} num filename offset length [oob_option]
3115 @cindex NAND reading
3116 Reads binary data from the NAND device and writes it to the file,
3117 starting at the specified offset.
3118 The @var{num} parameter is the value shown by @command{nand list}.
3120 Use a complete path name for @var{filename}, so you don't depend
3121 on the directory used to start the OpenOCD server.
3123 The @var{offset} and @var{length} must be exact multiples of the
3124 device's page size. They describe a data region; the OOB data
3125 associated with each such page may also be accessed.
3127 @b{NOTE:} At the time this text was written, no error correction
3128 was done on the data that's read, unless raw access was disabled
3129 and the underlying NAND controller driver had a @code{read_page}
3130 method which handled that error correction.
3132 By default, only page data is saved to the specified file.
3133 Use an @var{oob_option} parameter to save OOB data:
3135 @item no oob_* parameter
3136 @*Output file holds only page data; OOB is discarded.
3137 @item @code{oob_raw}
3138 @*Output file interleaves page data and OOB data;
3139 the file will be longer than "length" by the size of the
3140 spare areas associated with each data page.
3141 Note that this kind of "raw" access is different from
3142 what's implied by @command{nand raw_access}, which just
3143 controls whether a hardware-aware access method is used.
3144 @item @code{oob_only}
3145 @*Output file has only raw OOB data, and will
3146 be smaller than "length" since it will contain only the
3147 spare areas associated with each data page.
3151 @deffn Command {nand erase} num offset length
3152 @cindex NAND erasing
3153 @cindex NAND programming
3154 Erases blocks on the specified NAND device, starting at the
3155 specified @var{offset} and continuing for @var{length} bytes.
3156 Both of those values must be exact multiples of the device's
3157 block size, and the region they specify must fit entirely in the chip.
3158 The @var{num} parameter is the value shown by @command{nand list}.
3160 @b{NOTE:} This command will try to erase bad blocks, when told
3161 to do so, which will probably invalidate the manufacturer's bad
3163 For the remainder of the current server session, @command{nand info}
3164 will still report that the block ``is'' bad.
3167 @deffn Command {nand write} num filename offset [option...]
3168 @cindex NAND writing
3169 @cindex NAND programming
3170 Writes binary data from the file into the specified NAND device,
3171 starting at the specified offset. Those pages should already
3172 have been erased; you can't change zero bits to one bits.
3173 The @var{num} parameter is the value shown by @command{nand list}.
3175 Use a complete path name for @var{filename}, so you don't depend
3176 on the directory used to start the OpenOCD server.
3178 The @var{offset} must be an exact multiple of the device's page size.
3179 All data in the file will be written, assuming it doesn't run
3180 past the end of the device.
3181 Only full pages are written, and any extra space in the last
3182 page will be filled with 0xff bytes. (That includes OOB data,
3183 if that's being written.)
3185 @b{NOTE:} At the time this text was written, bad blocks are
3186 ignored. That is, this routine will not skip bad blocks,
3187 but will instead try to write them. This can cause problems.
3189 Provide at most one @var{option} parameter. With some
3190 NAND drivers, the meanings of these parameters may change
3191 if @command{nand raw_access} was used to disable hardware ECC.
3193 @item no oob_* parameter
3194 @*File has only page data, which is written.
3195 If raw acccess is in use, the OOB area will not be written.
3196 Otherwise, if the underlying NAND controller driver has
3197 a @code{write_page} routine, that routine may write the OOB
3198 with hardware-computed ECC data.
3199 @item @code{oob_only}
3200 @*File has only raw OOB data, which is written to the OOB area.
3201 Each page's data area stays untouched. @i{This can be a dangerous
3202 option}, since it can invalidate the ECC data.
3203 You may need to force raw access to use this mode.
3204 @item @code{oob_raw}
3205 @*File interleaves data and OOB data, both of which are written
3206 If raw access is enabled, the data is written first, then the
3208 Otherwise, if the underlying NAND controller driver has
3209 a @code{write_page} routine, that routine may modify the OOB
3210 before it's written, to include hardware-computed ECC data.
3211 @item @code{oob_softecc}
3212 @*File has only page data, which is written.
3213 The OOB area is filled with 0xff, except for a standard 1-bit
3214 software ECC code stored in conventional locations.
3215 You might need to force raw access to use this mode, to prevent
3216 the underlying driver from applying hardware ECC.
3217 @item @code{oob_softecc_kw}
3218 @*File has only page data, which is written.
3219 The OOB area is filled with 0xff, except for a 4-bit software ECC
3220 specific to the boot ROM in Marvell Kirkwood SoCs.
3221 You might need to force raw access to use this mode, to prevent
3222 the underlying driver from applying hardware ECC.
3226 @section Other NAND commands
3227 @cindex NAND other commands
3229 @deffn Command {nand check_bad_blocks} [offset length]
3230 Checks for manufacturer bad block markers on the specified NAND
3231 device. If no parameters are provided, checks the whole
3232 device; otherwise, starts at the specified @var{offset} and
3233 continues for @var{length} bytes.
3234 Both of those values must be exact multiples of the device's
3235 block size, and the region they specify must fit entirely in the chip.
3236 The @var{num} parameter is the value shown by @command{nand list}.
3238 @b{NOTE:} Before using this command you should force raw access
3239 with @command{nand raw_access enable} to ensure that the underlying
3240 driver will not try to apply hardware ECC.
3243 @deffn Command {nand info} num
3244 The @var{num} parameter is the value shown by @command{nand list}.
3245 This prints the one-line summary from "nand list", plus for
3246 devices which have been probed this also prints any known
3247 status for each block.
3250 @deffn Command {nand raw_access} num <enable|disable>
3251 Sets or clears an flag affecting how page I/O is done.
3252 The @var{num} parameter is the value shown by @command{nand list}.
3254 This flag is cleared (disabled) by default, but changing that
3255 value won't affect all NAND devices. The key factor is whether
3256 the underlying driver provides @code{read_page} or @code{write_page}
3257 methods. If it doesn't provide those methods, the setting of
3258 this flag is irrelevant; all access is effectively ``raw''.
3260 When those methods exist, they are normally used when reading
3261 data (@command{nand dump} or reading bad block markers) or
3262 writing it (@command{nand write}). However, enabling
3263 raw access (setting the flag) prevents use of those methods,
3264 bypassing hardware ECC logic.
3265 @i{This can be a dangerous option}, since writing blocks
3266 with the wrong ECC data can cause them to be marked as bad.
3269 @section NAND Drivers, Options, and Commands
3270 @anchor{NAND Driver List}
3271 As noted above, the @command{nand device} command allows
3272 driver-specific options and behaviors.
3273 Some controllers also activate controller-specific commands.
3275 @deffn {NAND Driver} davinci
3276 This driver handles the NAND controllers found on DaVinci family
3277 chips from Texas Instruments.
3278 It takes three extra parameters:
3279 address of the NAND chip;
3280 hardware ECC mode to use (hwecc1, hwecc4, hwecc4_infix);
3281 address of the AEMIF controller on this processor.
3283 nand device davinci dm355.arm 0x02000000 hwecc4 0x01e10000
3285 All DaVinci processors support the single-bit ECC hardware,
3286 and newer ones also support the four-bit ECC hardware.
3287 The @code{write_page} and @code{read_page} methods are used
3288 to implement those ECC modes, unless they are disabled using
3289 the @command{nand raw_access} command.
3292 @deffn {NAND Driver} lpc3180
3293 These controllers require an extra @command{nand device}
3294 parameter: the clock rate used by the controller.
3295 @deffn Command {lpc3180 select} num [mlc|slc]
3296 Configures use of the MLC or SLC controller mode.
3297 MLC implies use of hardware ECC.
3298 The @var{num} parameter is the value shown by @command{nand list}.
3301 At this writing, this driver includes @code{write_page}
3302 and @code{read_page} methods. Using @command{nand raw_access}
3303 to disable those methods will prevent use of hardware ECC
3304 in the MLC controller mode, but won't change SLC behavior.
3306 @comment current lpc3180 code won't issue 5-byte address cycles
3308 @deffn {NAND Driver} orion
3309 These controllers require an extra @command{nand device}
3310 parameter: the address of the controller.
3312 nand device orion 0xd8000000
3314 These controllers don't define any specialized commands.
3315 At this writing, their drivers don't include @code{write_page}
3316 or @code{read_page} methods, so @command{nand raw_access} won't
3317 change any behavior.
3320 @deffn {NAND Driver} s3c2410
3321 @deffnx {NAND Driver} s3c2412
3322 @deffnx {NAND Driver} s3c2440
3323 @deffnx {NAND Driver} s3c2443
3324 These S3C24xx family controllers don't have any special
3325 @command{nand device} options, and don't define any
3326 specialized commands.
3327 At this writing, their drivers don't include @code{write_page}
3328 or @code{read_page} methods, so @command{nand raw_access} won't
3329 change any behavior.
3332 @node General Commands
3333 @chapter General Commands
3336 The commands documented in this chapter here are common commands that
3337 you, as a human, may want to type and see the output of. Configuration type
3338 commands are documented elsewhere.
3342 @item @b{Source Of Commands}
3343 @* OpenOCD commands can occur in a configuration script (discussed
3344 elsewhere) or typed manually by a human or supplied programatically,
3345 or via one of several TCP/IP Ports.
3347 @item @b{From the human}
3348 @* A human should interact with the telnet interface (default port: 4444)
3349 or via GDB (default port 3333).
3351 To issue commands from within a GDB session, use the @option{monitor}
3352 command, e.g. use @option{monitor poll} to issue the @option{poll}
3353 command. All output is relayed through the GDB session.
3355 @item @b{Machine Interface}
3356 The Tcl interface's intent is to be a machine interface. The default Tcl
3361 @section Daemon Commands
3363 @subsection sleep [@var{msec}]
3365 @*Wait for n milliseconds before resuming. Useful in connection with script files
3366 (@var{script} command and @var{target_script} configuration).
3368 @subsection shutdown
3370 @*Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, other).
3372 @subsection debug_level [@var{n}]
3374 @anchor{debug_level}
3375 @*Display or adjust debug level to n<0-3>
3377 @subsection fast [@var{enable|disable}]
3379 @*Default disabled. Set default behaviour of OpenOCD to be "fast and dangerous". For instance ARM7/9 DCC memory
3380 downloads and fast memory access will work if the JTAG interface isn't too fast and
3381 the core doesn't run at a too low frequency. Note that this option only changes the default
3382 and that the indvidual options, like DCC memory downloads, can be enabled and disabled
3385 The target specific "dangerous" optimisation tweaking options may come and go
3386 as more robust and user friendly ways are found to ensure maximum throughput
3387 and robustness with a minimum of configuration.
3389 Typically the "fast enable" is specified first on the command line:
3392 openocd -c "fast enable" -c "interface dummy" -f target/str710.cfg
3395 @subsection echo <@var{message}>
3397 @*Output message to stdio. e.g. echo "Programming - please wait"
3399 @subsection log_output <@var{file}>
3401 @*Redirect logging to <file> (default: stderr)
3403 @subsection script <@var{file}>
3405 @*Execute commands from <file>
3406 See also: ``source [find FILENAME]''
3408 @section Target state handling
3409 @subsection power <@var{on}|@var{off}>
3411 @*Turn power switch to target on/off.
3412 No arguments: print status.
3413 Not all interfaces support this.
3415 @subsection reg [@option{#}|@option{name}] [value]
3417 @*Access a single register by its number[@option{#}] or by its [@option{name}].
3418 No arguments: list all available registers for the current target.
3419 Number or name argument: display a register.
3420 Number or name and value arguments: set register value.
3422 @subsection poll [@option{on}|@option{off}]
3424 @*Poll the target for its current state. If the target is in debug mode, architecture
3425 specific information about the current state is printed. An optional parameter
3426 allows continuous polling to be enabled and disabled.
3428 @subsection halt [@option{ms}]
3430 @*Send a halt request to the target and wait for it to halt for up to [@option{ms}] milliseconds.
3431 Default [@option{ms}] is 5 seconds if no arg given.
3432 Optional arg @option{ms} is a timeout in milliseconds. Using 0 as the [@option{ms}]
3433 will stop OpenOCD from waiting.
3435 @subsection wait_halt [@option{ms}]
3437 @*Wait for the target to enter debug mode. Optional [@option{ms}] is
3438 a timeout in milliseconds. Default [@option{ms}] is 5 seconds if no
3441 @subsection resume [@var{address}]
3443 @*Resume the target at its current code position, or at an optional address.
3444 OpenOCD will wait 5 seconds for the target to resume.
3446 @subsection step [@var{address}]
3448 @*Single-step the target at its current code position, or at an optional address.
3450 @anchor{Reset Command}
3451 @subsection reset [@option{run}|@option{halt}|@option{init}]
3453 @*Perform a hard-reset. The optional parameter specifies what should
3454 happen after the reset.
3455 If there is no parameter, a @command{reset run} is executed.
3456 The other options will not work on all systems.
3457 @xref{Reset Configuration}.
3461 @*Let the target run.
3464 @*Immediately halt the target (works only with certain configurations).
3467 @*Immediately halt the target, and execute the reset script (works only with certain
3471 @subsection soft_reset_halt
3473 @*Requesting target halt and executing a soft reset. This is often used
3474 when a target cannot be reset and halted. The target, after reset is
3475 released begins to execute code. OpenOCD attempts to stop the CPU and
3476 then sets the program counter back to the reset vector. Unfortunately
3477 the code that was executed may have left the hardware in an unknown
3481 @section Memory access commands
3482 @anchor{Memory access}
3484 display available RAM memory.
3485 @subsection Memory peek/poke type commands
3486 These commands allow accesses of a specific size to the memory
3487 system. Often these are used to configure the current target in some
3488 special way. For example - one may need to write certian values to the
3489 SDRAM controller to enable SDRAM.
3492 @item To change the current target see the ``targets'' (plural) command
3493 @item In system level scripts these commands are deprecated, please use the TARGET object versions.
3497 @item @b{mdw} <@var{addr}> [@var{count}]
3499 @*display memory words (32bit)
3500 @item @b{mdh} <@var{addr}> [@var{count}]
3502 @*display memory half-words (16bit)
3503 @item @b{mdb} <@var{addr}> [@var{count}]
3505 @*display memory bytes (8bit)
3506 @item @b{mww} <@var{addr}> <@var{value}>
3508 @*write memory word (32bit)
3509 @item @b{mwh} <@var{addr}> <@var{value}>
3511 @*write memory half-word (16bit)
3512 @item @b{mwb} <@var{addr}> <@var{value}>
3514 @*write memory byte (8bit)
3517 @section Image loading commands
3518 @anchor{Image access}
3519 @subsection load_image
3520 @b{load_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
3523 @*Load image <@var{file}> to target memory at <@var{address}>
3524 @subsection fast_load_image
3525 @b{fast_load_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
3526 @cindex fast_load_image
3527 @anchor{fast_load_image}
3528 @*Normally you should be using @b{load_image} or GDB load. However, for
3529 testing purposes or when I/O overhead is significant(OpenOCD running on an embedded
3530 host), storing the image in memory and uploading the image to the target
3531 can be a way to upload e.g. multiple debug sessions when the binary does not change.
3532 Arguments are the same as @b{load_image}, but the image is stored in OpenOCD host
3533 memory, i.e. does not affect target. This approach is also useful when profiling
3534 target programming performance as I/O and target programming can easily be profiled
3536 @subsection fast_load
3540 @*Loads an image stored in memory by @b{fast_load_image} to the current target. Must be preceeded by fast_load_image.
3541 @subsection dump_image
3542 @b{dump_image} <@var{file}> <@var{address}> <@var{size}>
3545 @*Dump <@var{size}> bytes of target memory starting at <@var{address}> to a
3546 (binary) <@var{file}>.
3547 @subsection verify_image
3548 @b{verify_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
3549 @cindex verify_image
3550 @*Verify <@var{file}> against target memory starting at <@var{address}>.
3551 This will first attempt a comparison using a CRC checksum, if this fails it will try a binary compare.
3554 @section Breakpoint commands
3555 @cindex Breakpoint commands
3557 @item @b{bp} <@var{addr}> <@var{len}> [@var{hw}]
3559 @*set breakpoint <address> <length> [hw]
3560 @item @b{rbp} <@var{addr}>
3562 @*remove breakpoint <adress>
3563 @item @b{wp} <@var{addr}> <@var{len}> <@var{r}|@var{w}|@var{a}> [@var{value}] [@var{mask}]
3565 @*set watchpoint <address> <length> <r/w/a> [value] [mask]
3566 @item @b{rwp} <@var{addr}>
3568 @*remove watchpoint <adress>
3571 @section Misc Commands
3572 @cindex Other Target Commands
3574 @item @b{profile} <@var{seconds}> <@var{gmon.out}>
3576 Profiling samples the CPU's program counter as quickly as possible, which is useful for non-intrusive stochastic profiling.
3580 @section Architecture and Core Specific Commands
3581 @cindex Architecture Specific Commands
3582 @cindex Core Specific Commands
3584 Most CPUs have specialized JTAG operations to support debugging.
3585 OpenOCD packages most such operations in its standard command framework.
3586 Some of those operations don't fit well in that framework, so they are
3587 exposed here using architecture or implementation specific commands.
3589 @subsection ARMv4 and ARMv5 Architecture
3590 @cindex ARMv4 specific commands
3591 @cindex ARMv5 specific commands
3593 These commands are specific to ARM architecture v4 and v5,
3594 including all ARM7 or ARM9 systems and Intel XScale.
3595 They are available in addition to other core-specific
3596 commands that may be available.
3598 @deffn Command {armv4_5 core_state} [arm|thumb]
3599 Displays the core_state, optionally changing it to process
3600 either @option{arm} or @option{thumb} instructions.
3601 The target may later be resumed in the currently set core_state.
3602 (Processors may also support the Jazelle state, but
3603 that is not currently supported in OpenOCD.)
3606 @deffn Command {armv4_5 disassemble} address count [thumb]
3608 Disassembles @var{count} instructions starting at @var{address}.
3609 If @option{thumb} is specified, Thumb (16-bit) instructions are used;
3610 else ARM (32-bit) instructions are used.
3611 (Processors may also support the Jazelle state, but
3612 those instructions are not currently understood by OpenOCD.)
3615 @deffn Command {armv4_5 reg}
3616 Display a list of all banked core registers, fetching the current value from every
3617 core mode if necessary. OpenOCD versions before rev. 60 didn't fetch the current
3621 @subsubsection ARM7 and ARM9 specific commands
3622 @cindex ARM7 specific commands
3623 @cindex ARM9 specific commands
3625 These commands are specific to ARM7 and ARM9 cores, like ARM7TDMI, ARM720T,
3626 ARM9TDMI, ARM920T or ARM926EJ-S.
3627 They are available in addition to the ARMv4/5 commands,
3628 and any other core-specific commands that may be available.
3630 @deffn Command {arm7_9 dbgrq} (enable|disable)
3631 Control use of the EmbeddedIce DBGRQ signal to force entry into debug mode,
3632 instead of breakpoints. This should be
3633 safe for all but ARM7TDMI--S cores (like Philips LPC).
3636 @deffn Command {arm7_9 dcc_downloads} (enable|disable)
3638 Control the use of the debug communications channel (DCC) to write larger (>128 byte)
3639 amounts of memory. DCC downloads offer a huge speed increase, but might be
3640 unsafe, especially with targets running at very low speeds. This command was introduced
3641 with OpenOCD rev. 60, and requires a few bytes of working area.
3644 @anchor{arm7_9 fast_memory_access}
3645 @deffn Command {arm7_9 fast_memory_access} (enable|disable)
3646 Enable or disable memory writes and reads that don't check completion of
3647 the operation. This provides a huge speed increase, especially with USB JTAG
3648 cables (FT2232), but might be unsafe if used with targets running at very low
3649 speeds, like the 32kHz startup clock of an AT91RM9200.
3652 @deffn {Debug Command} {arm7_9 write_core_reg} num mode word
3653 @emph{This is intended for use while debugging OpenOCD; you probably
3656 Writes a 32-bit @var{word} to register @var{num} (from 0 to 16)
3657 as used in the specified @var{mode}
3658 (where e.g. mode 16 is "user" and mode 19 is "supervisor";
3659 the M4..M0 bits of the PSR).
3660 Registers 0..15 are the normal CPU registers such as r0(0), r1(1) ... pc(15).
3661 Register 16 is the mode-specific SPSR,
3662 unless the specified mode is 0xffffffff (32-bit all-ones)
3663 in which case register 16 is the CPSR.
3664 The write goes directly to the CPU, bypassing the register cache.
3667 @deffn {Debug Command} {arm7_9 write_xpsr} word (0|1)
3668 @emph{This is intended for use while debugging OpenOCD; you probably
3671 If the second parameter is zero, writes @var{word} to the
3672 Current Program Status register (CPSR).
3673 Else writes @var{word} to the current mode's Saved PSR (SPSR).
3674 In both cases, this bypasses the register cache.
3677 @deffn {Debug Command} {arm7_9 write_xpsr_im8} byte rotate (0|1)
3678 @emph{This is intended for use while debugging OpenOCD; you probably
3681 Writes eight bits to the CPSR or SPSR,
3682 first rotating them by @math{2*rotate} bits,
3683 and bypassing the register cache.
3684 This has lower JTAG overhead than writing the entire CPSR or SPSR
3685 with @command{arm7_9 write_xpsr}.
3688 @subsubsection ARM720T specific commands
3689 @cindex ARM720T specific commands
3691 These commands are available to ARM720T based CPUs,
3692 which are implementations of the ARMv4T architecture
3693 based on the ARM7TDMI-S integer core.
3694 They are available in addition to the ARMv4/5 and ARM7/ARM9 commands.
3696 @deffn Command {arm720t cp15} regnum [value]
3697 Display cp15 register @var{regnum};
3698 else if a @var{value} is provided, that value is written to that register.
3701 @deffn Command {arm720t mdw_phys} addr [count]
3702 @deffnx Command {arm720t mdh_phys} addr [count]
3703 @deffnx Command {arm720t mdb_phys} addr [count]
3704 Display contents of physical address @var{addr}, as
3705 32-bit words (@command{mdw_phys}), 16-bit halfwords (@command{mdh_phys}),
3706 or 8-bit bytes (@command{mdb_phys}).
3707 If @var{count} is specified, displays that many units.
3710 @deffn Command {arm720t mww_phys} addr word
3711 @deffnx Command {arm720t mwh_phys} addr halfword
3712 @deffnx Command {arm720t mwb_phys} addr byte
3713 Writes the specified @var{word} (32 bits),
3714 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3715 at the specified physical address @var{addr}.
3718 @deffn Command {arm720t virt2phys} va
3719 Translate a virtual address @var{va} to a physical address
3720 and display the result.
3723 @subsubsection ARM9TDMI specific commands
3724 @cindex ARM9TDMI specific commands
3726 Many ARM9-family CPUs are built around ARM9TDMI integer cores,
3727 or processors resembling ARM9TDMI, and can use these commands.
3728 Such cores include the ARM920T, ARM926EJ-S, and ARM966.
3730 @deffn Command {arm9tdmi vector_catch} (all|none|list)
3731 Catch arm9 interrupt vectors, can be @option{all}, @option{none},
3732 or a list with one or more of the following:
3733 @option{reset} @option{undef} @option{swi} @option{pabt} @option{dabt} @option{reserved}
3734 @option{irq} @option{fiq}.
3737 @subsubsection ARM920T specific commands
3738 @cindex ARM920T specific commands
3740 These commands are available to ARM920T based CPUs,
3741 which are implementations of the ARMv4T architecture
3742 built using the ARM9TDMI integer core.
3743 They are available in addition to the ARMv4/5, ARM7/ARM9,
3744 and ARM9TDMI commands.
3746 @deffn Command {arm920t cache_info}
3747 Print information about the caches found. This allows to see whether your target
3748 is an ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
3751 @deffn Command {arm920t cp15} regnum [value]
3752 Display cp15 register @var{regnum};
3753 else if a @var{value} is provided, that value is written to that register.
3756 @deffn Command {arm920t cp15i} opcode [value [address]]
3757 Interpreted access using cp15 @var{opcode}.
3758 If no @var{value} is provided, the result is displayed.
3759 Else if that value is written using the specified @var{address},
3760 or using zero if no other address is not provided.
3763 @deffn Command {arm920t mdw_phys} addr [count]
3764 @deffnx Command {arm920t mdh_phys} addr [count]
3765 @deffnx Command {arm920t mdb_phys} addr [count]
3766 Display contents of physical address @var{addr}, as
3767 32-bit words (@command{mdw_phys}), 16-bit halfwords (@command{mdh_phys}),
3768 or 8-bit bytes (@command{mdb_phys}).
3769 If @var{count} is specified, displays that many units.
3772 @deffn Command {arm920t mww_phys} addr word
3773 @deffnx Command {arm920t mwh_phys} addr halfword
3774 @deffnx Command {arm920t mwb_phys} addr byte
3775 Writes the specified @var{word} (32 bits),
3776 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3777 at the specified physical address @var{addr}.
3780 @deffn Command {arm920t read_cache} filename
3781 Dump the content of ICache and DCache to a file named @file{filename}.
3784 @deffn Command {arm920t read_mmu} filename
3785 Dump the content of the ITLB and DTLB to a file named @file{filename}.
3788 @deffn Command {arm920t virt2phys} @var{va}
3789 Translate a virtual address @var{va} to a physical address
3790 and display the result.
3793 @subsubsection ARM926EJ-S specific commands
3794 @cindex ARM926EJ-S specific commands
3796 These commands are available to ARM926EJ-S based CPUs,
3797 which are implementations of the ARMv5TEJ architecture
3798 based on the ARM9EJ-S integer core.
3799 They are available in addition to the ARMv4/5, ARM7/ARM9,
3800 and ARM9TDMI commands.
3802 @deffn Command {arm926ejs cache_info}
3803 Print information about the caches found.
3806 @deffn Command {arm926ejs cp15} opcode1 opcode2 CRn CRm regnum [value]
3807 Accesses cp15 register @var{regnum} using
3808 @var{opcode1}, @var{opcode2}, @var{CRn}, and @var{CRm}.
3809 If a @var{value} is provided, that value is written to that register.
3810 Else that register is read and displayed.
3813 @deffn Command {arm926ejs mdw_phys} addr [count]
3814 @deffnx Command {arm926ejs mdh_phys} addr [count]
3815 @deffnx Command {arm926ejs mdb_phys} addr [count]
3816 Display contents of physical address @var{addr}, as
3817 32-bit words (@command{mdw_phys}), 16-bit halfwords (@command{mdh_phys}),
3818 or 8-bit bytes (@command{mdb_phys}).
3819 If @var{count} is specified, displays that many units.
3822 @deffn Command {arm926ejs mww_phys} addr word
3823 @deffnx Command {arm926ejs mwh_phys} addr halfword
3824 @deffnx Command {arm926ejs mwb_phys} addr byte
3825 Writes the specified @var{word} (32 bits),
3826 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3827 at the specified physical address @var{addr}.
3830 @deffn Command {arm926ejs virt2phys} @var{va}
3831 Translate a virtual address @var{va} to a physical address
3832 and display the result.
3835 @subsubsection ARM966E specific commands
3836 @cindex ARM966E specific commands
3838 These commands are available to ARM966 based CPUs,
3839 which are implementations of the ARMv5TE architecture.
3840 They are available in addition to the ARMv4/5, ARM7/ARM9,
3841 and ARM9TDMI commands.
3843 @deffn Command {arm966e cp15} regnum [value]
3844 Display cp15 register @var{regnum};
3845 else if a @var{value} is provided, that value is written to that register.
3848 @subsubsection XScale specific commands
3849 @cindex XScale specific commands
3851 These commands are available to XScale based CPUs,
3852 which are implementations of the ARMv5TE architecture.
3854 @deffn Command {xscale analyze_trace}
3855 Displays the contents of the trace buffer.
3858 @deffn Command {xscale cache_clean_address} address
3859 Changes the address used when cleaning the data cache.
3862 @deffn Command {xscale cache_info}
3863 Displays information about the CPU caches.
3866 @deffn Command {xscale cp15} regnum [value]
3867 Display cp15 register @var{regnum};
3868 else if a @var{value} is provided, that value is written to that register.
3871 @deffn Command {xscale debug_handler} target address
3872 Changes the address used for the specified target's debug handler.
3875 @deffn Command {xscale dcache} (enable|disable)
3876 Enables or disable the CPU's data cache.
3879 @deffn Command {xscale dump_trace} filename
3880 Dumps the raw contents of the trace buffer to @file{filename}.
3883 @deffn Command {xscale icache} (enable|disable)
3884 Enables or disable the CPU's instruction cache.
3887 @deffn Command {xscale mmu} (enable|disable)
3888 Enables or disable the CPU's memory management unit.
3891 @deffn Command {xscale trace_buffer} (enable|disable) [fill [n] | wrap]
3892 Enables or disables the trace buffer,
3893 and controls how it is emptied.
3896 @deffn Command {xscale trace_image} filename [offset [type]]
3897 Opens a trace image from @file{filename}, optionally rebasing
3898 its segment addresses by @var{offset}.
3899 The image @var{type} may be one of
3900 @option{bin} (binary), @option{ihex} (Intel hex),
3901 @option{elf} (ELF file), @option{s19} (Motorola s19),
3902 @option{mem}, or @option{builder}.
3905 @deffn Command {xscale vector_catch} mask
3906 Provide a bitmask showing the vectors to catch.
3909 @subsection ARMv6 Architecture
3911 @subsubsection ARM11 specific commands
3912 @cindex ARM11 specific commands
3914 @deffn Command {arm11 mcr} p1 p2 p3 p4 p5
3915 Read coprocessor register
3918 @deffn Command {arm11 memwrite burst} [value]
3919 Displays the value of the memwrite burst-enable flag,
3920 which is enabled by default.
3921 If @var{value} is defined, first assigns that.
3924 @deffn Command {arm11 memwrite error_fatal} [value]
3925 Displays the value of the memwrite error_fatal flag,
3926 which is enabled by default.
3927 If @var{value} is defined, first assigns that.
3930 @deffn Command {arm11 mrc} p1 p2 p3 p4 p5 value
3931 Write coprocessor register
3934 @deffn Command {arm11 no_increment} [value]
3935 Displays the value of the flag controlling whether
3936 some read or write operations increment the pointer
3937 (the default behavior) or not (acting like a FIFO).
3938 If @var{value} is defined, first assigns that.
3941 @deffn Command {arm11 step_irq_enable} [value]
3942 Displays the value of the flag controlling whether
3943 IRQs are enabled during single stepping;
3944 they is disabled by default.
3945 If @var{value} is defined, first assigns that.
3948 @subsection ARMv7 Architecture
3950 @subsubsection Cortex-M3 specific commands
3951 @cindex Cortex-M3 specific commands
3953 @deffn Command {cortex_m3 maskisr} (on|off)
3954 Control masking (disabling) interrupts during target step/resume.
3957 @section Target DCC Requests
3958 @cindex Linux-ARM DCC support
3961 OpenOCD can handle certain target requests; currently debugmsgs
3962 @command{target_request debugmsgs}
3963 are only supported for arm7_9 and cortex_m3.
3965 See libdcc in the contrib dir for more details.
3966 Linux-ARM kernels have a ``Kernel low-level debugging
3967 via EmbeddedICE DCC channel'' option (CONFIG_DEBUG_ICEDCC,
3968 depends on CONFIG_DEBUG_LL) which uses this mechanism to
3969 deliver messages before a serial console can be activated.
3971 @deffn Command {target_request debugmsgs} [enable|disable|charmsg]
3972 Displays current handling of target DCC message requests.
3973 These messages may be sent to the debugger while the target is running.
3974 The optional @option{enable} and @option{charmsg} parameters are
3975 equivalent; both enable the messages, @option{disable} disables them.
3979 @chapter JTAG Commands
3980 @cindex JTAG Commands
3981 Generally most people will not use the bulk of these commands. They
3982 are mostly used by the OpenOCD developers or those who need to
3983 directly manipulate the JTAG taps.
3985 In general these commands control JTAG taps at a very low level. For
3986 example if you need to control a JTAG Route Controller (i.e.: the
3987 OMAP3530 on the Beagle Board has one) you might use these commands in
3988 a script or an event procedure.
3992 @item @b{scan_chain}
3994 @*Print current scan chain configuration.
3995 @item @b{jtag_reset} <@var{trst}> <@var{srst}>
3997 @*Toggle reset lines.
3998 @item @b{endstate} <@var{tap_state}>
4000 @*Finish JTAG operations in <@var{tap_state}>.
4001 @item @b{runtest} <@var{num_cycles}>
4003 @*Move to Run-Test/Idle, and execute <@var{num_cycles}>
4004 @item @b{statemove} [@var{tap_state}]
4006 @*Move to current endstate or [@var{tap_state}]
4007 @item @b{irscan} <@var{device}> <@var{instr}> [@var{dev2}] [@var{instr2}] ...
4009 @*Execute IR scan <@var{device}> <@var{instr}> [@var{dev2}] [@var{instr2}] ...
4010 @item @b{drscan} <@var{device}> [@var{dev2}] [@var{var2}] ...
4012 @*Execute DR scan <@var{device}> [@var{dev2}] [@var{var2}] ...
4013 @item @b{verify_ircapture} <@option{enable}|@option{disable}>
4014 @cindex verify_ircapture
4015 @*Verify value captured during Capture-IR. Default is enabled.
4016 @item @b{var} <@var{name}> [@var{num_fields}|@var{del}] [@var{size1}] ...
4018 @*Allocate, display or delete variable <@var{name}> [@var{num_fields}|@var{del}] [@var{size1}] ...
4019 @item @b{field} <@var{var}> <@var{field}> [@var{value}|@var{flip}]
4021 Display/modify variable field <@var{var}> <@var{field}> [@var{value}|@var{flip}].
4026 Available tap_states are:
4066 If OpenOCD runs on an embedded host(as ZY1000 does), then TFTP can
4067 be used to access files on PCs (either the developer's PC or some other PC).
4069 The way this works on the ZY1000 is to prefix a filename by
4070 "/tftp/ip/" and append the TFTP path on the TFTP
4071 server (tftpd). For example,
4074 load_image /tftp/10.0.0.96/c:\temp\abc.elf
4077 will load c:\temp\abc.elf from the developer pc (10.0.0.96) into memory as
4078 if the file was hosted on the embedded host.
4080 In order to achieve decent performance, you must choose a TFTP server
4081 that supports a packet size bigger than the default packet size (512 bytes). There
4082 are numerous TFTP servers out there (free and commercial) and you will have to do
4083 a bit of googling to find something that fits your requirements.
4085 @node Sample Scripts
4086 @chapter Sample Scripts
4089 This page shows how to use the Target Library.
4091 The configuration script can be divided into the following sections:
4093 @item Daemon configuration
4095 @item JTAG scan chain
4096 @item Target configuration
4097 @item Flash configuration
4100 Detailed information about each section can be found at OpenOCD configuration.
4102 @section AT91R40008 example
4103 @cindex AT91R40008 example
4104 To start OpenOCD with a target script for the AT91R40008 CPU and reset
4105 the CPU upon startup of the OpenOCD daemon.
4107 openocd -f interface/parport.cfg -f target/at91r40008.cfg \
4108 -c "init" -c "reset"
4112 @node GDB and OpenOCD
4113 @chapter GDB and OpenOCD
4115 OpenOCD complies with the remote gdbserver protocol, and as such can be used
4116 to debug remote targets.
4118 @section Connecting to GDB
4119 @cindex Connecting to GDB
4120 @anchor{Connecting to GDB}
4121 Use GDB 6.7 or newer with OpenOCD if you run into trouble. For
4122 instance GDB 6.3 has a known bug that produces bogus memory access
4123 errors, which has since been fixed: look up 1836 in
4124 @url{http://sourceware.org/cgi-bin/gnatsweb.pl?database=gdb}
4126 OpenOCD can communicate with GDB in two ways:
4130 A socket (TCP/IP) connection is typically started as follows:
4132 target remote localhost:3333
4134 This would cause GDB to connect to the gdbserver on the local pc using port 3333.
4136 A pipe connection is typically started as follows:
4138 target remote | openocd --pipe
4140 This would cause GDB to run OpenOCD and communicate using pipes (stdin/stdout).
4141 Using this method has the advantage of GDB starting/stopping OpenOCD for the debug
4145 To list the available OpenOCD commands type @command{monitor help} on the
4148 OpenOCD supports the gdb @option{qSupported} packet, this enables information
4149 to be sent by the GDB remote server (i.e. OpenOCD) to GDB. Typical information includes
4150 packet size and the device's memory map.
4152 Previous versions of OpenOCD required the following GDB options to increase
4153 the packet size and speed up GDB communication:
4155 set remote memory-write-packet-size 1024
4156 set remote memory-write-packet-size fixed
4157 set remote memory-read-packet-size 1024
4158 set remote memory-read-packet-size fixed
4160 This is now handled in the @option{qSupported} PacketSize and should not be required.
4162 @section Programming using GDB
4163 @cindex Programming using GDB
4165 By default the target memory map is sent to GDB. This can be disabled by
4166 the following OpenOCD configuration option:
4168 gdb_memory_map disable
4170 For this to function correctly a valid flash configuration must also be set
4171 in OpenOCD. For faster performance you should also configure a valid
4174 Informing GDB of the memory map of the target will enable GDB to protect any
4175 flash areas of the target and use hardware breakpoints by default. This means
4176 that the OpenOCD option @command{gdb_breakpoint_override} is not required when
4177 using a memory map. @xref{gdb_breakpoint_override}.
4179 To view the configured memory map in GDB, use the GDB command @option{info mem}
4180 All other unassigned addresses within GDB are treated as RAM.
4182 GDB 6.8 and higher set any memory area not in the memory map as inaccessible.
4183 This can be changed to the old behaviour by using the following GDB command
4185 set mem inaccessible-by-default off
4188 If @command{gdb_flash_program enable} is also used, GDB will be able to
4189 program any flash memory using the vFlash interface.
4191 GDB will look at the target memory map when a load command is given, if any
4192 areas to be programmed lie within the target flash area the vFlash packets
4195 If the target needs configuring before GDB programming, an event
4196 script can be executed:
4198 $_TARGETNAME configure -event EVENTNAME BODY
4201 To verify any flash programming the GDB command @option{compare-sections}
4204 @node Tcl Scripting API
4205 @chapter Tcl Scripting API
4206 @cindex Tcl Scripting API
4210 The commands are stateless. E.g. the telnet command line has a concept
4211 of currently active target, the Tcl API proc's take this sort of state
4212 information as an argument to each proc.
4214 There are three main types of return values: single value, name value
4215 pair list and lists.
4217 Name value pair. The proc 'foo' below returns a name/value pair
4223 > set foo(you) Oyvind
4224 > set foo(mouse) Micky
4225 > set foo(duck) Donald
4233 me Duane you Oyvind mouse Micky duck Donald
4235 Thus, to get the names of the associative array is easy:
4237 foreach { name value } [set foo] {
4238 puts "Name: $name, Value: $value"
4242 Lists returned must be relatively small. Otherwise a range
4243 should be passed in to the proc in question.
4245 @section Internal low-level Commands
4247 By low-level, the intent is a human would not directly use these commands.
4249 Low-level commands are (should be) prefixed with "ocd_", e.g.
4250 @command{ocd_flash_banks}
4251 is the low level API upon which @command{flash banks} is implemented.
4254 @item @b{ocd_mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
4256 Read memory and return as a Tcl array for script processing
4257 @item @b{ocd_array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
4259 Convert a Tcl array to memory locations and write the values
4260 @item @b{ocd_flash_banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...]
4262 Return information about the flash banks
4265 OpenOCD commands can consist of two words, e.g. "flash banks". The
4266 startup.tcl "unknown" proc will translate this into a Tcl proc
4267 called "flash_banks".
4269 @section OpenOCD specific Global Variables
4273 Real Tcl has ::tcl_platform(), and platform::identify, and many other
4274 variables. JimTCL, as implemented in OpenOCD creates $HostOS which
4275 holds one of the following values:
4278 @item @b{winxx} Built using Microsoft Visual Studio
4279 @item @b{linux} Linux is the underlying operating sytem
4280 @item @b{darwin} Darwin (mac-os) is the underlying operating sytem.
4281 @item @b{cygwin} Running under Cygwin
4282 @item @b{mingw32} Running under MingW32
4283 @item @b{other} Unknown, none of the above.
4286 Note: 'winxx' was choosen because today (March-2009) no distinction is made between Win32 and Win64.
4289 We should add support for a variable like Tcl variable
4290 @code{tcl_platform(platform)}, it should be called
4291 @code{jim_platform} (because it
4292 is jim, not real tcl).
4296 @chapter Deprecated/Removed Commands
4297 @cindex Deprecated/Removed Commands
4298 Certain OpenOCD commands have been deprecated/removed during the various revisions.
4301 @item @b{arm7_9 fast_writes}
4302 @cindex arm7_9 fast_writes
4303 @*Use @command{arm7_9 fast_memory_access} instead.
4304 @xref{arm7_9 fast_memory_access}.
4305 @item @b{arm7_9 force_hw_bkpts}
4306 @cindex arm7_9 force_hw_bkpts
4307 @*Use @command{gdb_breakpoint_override} instead. Note that GDB will use hardware breakpoints
4308 for flash if the GDB memory map has been set up(default when flash is declared in
4309 target configuration). @xref{gdb_breakpoint_override}.
4310 @item @b{arm7_9 sw_bkpts}
4311 @cindex arm7_9 sw_bkpts
4312 @*On by default. @xref{gdb_breakpoint_override}.
4313 @item @b{daemon_startup}
4314 @cindex daemon_startup
4315 @*this config option has been removed, simply adding @option{init} and @option{reset halt} to
4316 the end of your config script will give the same behaviour as using @option{daemon_startup reset}
4317 and @option{target cortex_m3 little reset_halt 0}.
4318 @item @b{dump_binary}
4320 @*use @option{dump_image} command with same args. @xref{dump_image}.
4321 @item @b{flash erase}
4323 @*use @option{flash erase_sector} command with same args. @xref{flash erase_sector}.
4324 @item @b{flash write}
4326 @*use @option{flash write_bank} command with same args. @xref{flash write_bank}.
4327 @item @b{flash write_binary}
4328 @cindex flash write_binary
4329 @*use @option{flash write_bank} command with same args. @xref{flash write_bank}.
4330 @item @b{flash auto_erase}
4331 @cindex flash auto_erase
4332 @*use @option{flash write_image} command passing @option{erase} as the first parameter. @xref{flash write_image}.
4334 @item @b{jtag_speed} value
4335 @*@xref{JTAG Speed}.
4336 Usually, a value of zero means maximum
4337 speed. The actual effect of this option depends on the JTAG interface used.
4339 @item wiggler: maximum speed / @var{number}
4340 @item ft2232: 6MHz / (@var{number}+1)
4341 @item amt jtagaccel: 8 / 2**@var{number}
4342 @item jlink: maximum speed in kHz (0-12000), 0 will use RTCK
4343 @item rlink: 24MHz / @var{number}, but only for certain values of @var{number}
4344 @comment end speed list.
4347 @item @b{load_binary}
4349 @*use @option{load_image} command with same args. @xref{load_image}.
4350 @item @b{run_and_halt_time}
4351 @cindex run_and_halt_time
4352 @*This command has been removed for simpler reset behaviour, it can be simulated with the
4359 @item @b{target} <@var{type}> <@var{endian}> <@var{jtag-position}>
4361 @*use the create subcommand of @option{target}.
4362 @item @b{target_script} <@var{target#}> <@var{eventname}> <@var{scriptname}>
4363 @cindex target_script
4364 @*use <@var{target_name}> configure -event <@var{eventname}> "script <@var{scriptname}>"
4365 @item @b{working_area}
4366 @cindex working_area
4367 @*use the @option{configure} subcommand of @option{target} to set the work-area-virt, work-area-phy, work-area-size, and work-area-backup properties of the target.
4374 @item @b{RTCK, also known as: Adaptive Clocking - What is it?}
4377 @cindex adaptive clocking
4380 In digital circuit design it is often refered to as ``clock
4381 synchronisation'' the JTAG interface uses one clock (TCK or TCLK)
4382 operating at some speed, your target is operating at another. The two
4383 clocks are not synchronised, they are ``asynchronous''
4385 In order for the two to work together they must be synchronised. Otherwise
4386 the two systems will get out of sync with each other and nothing will
4387 work. There are 2 basic options:
4390 Use a special circuit.
4392 One clock must be some multiple slower than the other.
4395 @b{Does this really matter?} For some chips and some situations, this
4396 is a non-issue (i.e.: A 500MHz ARM926) but for others - for example some
4397 Atmel SAM7 and SAM9 chips start operation from reset at 32kHz -
4398 program/enable the oscillators and eventually the main clock. It is in
4399 those critical times you must slow the JTAG clock to sometimes 1 to
4402 Imagine debugging a 500MHz ARM926 hand held battery powered device
4403 that ``deep sleeps'' at 32kHz between every keystroke. It can be
4406 @b{Solution #1 - A special circuit}
4408 In order to make use of this, your JTAG dongle must support the RTCK
4409 feature. Not all dongles support this - keep reading!
4411 The RTCK signal often found in some ARM chips is used to help with
4412 this problem. ARM has a good description of the problem described at
4413 this link: @url{http://www.arm.com/support/faqdev/4170.html} [checked
4414 28/nov/2008]. Link title: ``How does the JTAG synchronisation logic
4415 work? / how does adaptive clocking work?''.
4417 The nice thing about adaptive clocking is that ``battery powered hand
4418 held device example'' - the adaptiveness works perfectly all the
4419 time. One can set a break point or halt the system in the deep power
4420 down code, slow step out until the system speeds up.
4422 @b{Solution #2 - Always works - but may be slower}
4424 Often this is a perfectly acceptable solution.
4426 In most simple terms: Often the JTAG clock must be 1/10 to 1/12 of
4427 the target clock speed. But what that ``magic division'' is varies
4428 depending on the chips on your board. @b{ARM rule of thumb} Most ARM
4429 based systems require an 8:1 division. @b{Xilinx rule of thumb} is
4430 1/12 the clock speed.
4432 Note: Many FTDI2232C based JTAG dongles are limited to 6MHz.
4434 You can still debug the 'low power' situations - you just need to
4435 manually adjust the clock speed at every step. While painful and
4436 tedious, it is not always practical.
4438 It is however easy to ``code your way around it'' - i.e.: Cheat a little,
4439 have a special debug mode in your application that does a ``high power
4440 sleep''. If you are careful - 98% of your problems can be debugged
4443 To set the JTAG frequency use the command:
4451 @item @b{Win32 Pathnames} Why don't backslashes work in Windows paths?
4453 OpenOCD uses Tcl and a backslash is an escape char. Use @{ and @}
4454 around Windows filenames.
4467 @item @b{Missing: cygwin1.dll} OpenOCD complains about a missing cygwin1.dll.
4469 Make sure you have Cygwin installed, or at least a version of OpenOCD that
4470 claims to come with all the necessary DLLs. When using Cygwin, try launching
4471 OpenOCD from the Cygwin shell.
4473 @item @b{Breakpoint Issue} I'm trying to set a breakpoint using GDB (or a frontend like Insight or
4474 Eclipse), but OpenOCD complains that "Info: arm7_9_common.c:213
4475 arm7_9_add_breakpoint(): sw breakpoint requested, but software breakpoints not enabled".
4477 GDB issues software breakpoints when a normal breakpoint is requested, or to implement
4478 source-line single-stepping. On ARMv4T systems, like ARM7TDMI, ARM720T or ARM920T,
4479 software breakpoints consume one of the two available hardware breakpoints.
4481 @item @b{LPC2000 Flash} When erasing or writing LPC2000 on-chip flash, the operation fails at random.
4483 Make sure the core frequency specified in the @option{flash lpc2000} line matches the
4484 clock at the time you're programming the flash. If you've specified the crystal's
4485 frequency, make sure the PLL is disabled. If you've specified the full core speed
4486 (e.g. 60MHz), make sure the PLL is enabled.
4488 @item @b{Amontec Chameleon} When debugging using an Amontec Chameleon in its JTAG Accelerator configuration,
4489 I keep getting "Error: amt_jtagaccel.c:184 amt_wait_scan_busy(): amt_jtagaccel timed
4490 out while waiting for end of scan, rtck was disabled".
4492 Make sure your PC's parallel port operates in EPP mode. You might have to try several
4493 settings in your PC BIOS (ECP, EPP, and different versions of those).
4495 @item @b{Data Aborts} When debugging with OpenOCD and GDB (plain GDB, Insight, or Eclipse),
4496 I get lots of "Error: arm7_9_common.c:1771 arm7_9_read_memory():
4497 memory read caused data abort".
4499 The errors are non-fatal, and are the result of GDB trying to trace stack frames
4500 beyond the last valid frame. It might be possible to prevent this by setting up
4501 a proper "initial" stack frame, if you happen to know what exactly has to
4502 be done, feel free to add this here.
4504 @b{Simple:} In your startup code - push 8 registers of zeros onto the
4505 stack before calling main(). What GDB is doing is ``climbing'' the run
4506 time stack by reading various values on the stack using the standard
4507 call frame for the target. GDB keeps going - until one of 2 things
4508 happen @b{#1} an invalid frame is found, or @b{#2} some huge number of
4509 stackframes have been processed. By pushing zeros on the stack, GDB
4512 @b{Debugging Interrupt Service Routines} - In your ISR before you call
4513 your C code, do the same - artifically push some zeros onto the stack,
4514 remember to pop them off when the ISR is done.
4516 @b{Also note:} If you have a multi-threaded operating system, they
4517 often do not @b{in the intrest of saving memory} waste these few
4521 @item @b{JTAG Reset Config} I get the following message in the OpenOCD console (or log file):
4522 "Warning: arm7_9_common.c:679 arm7_9_assert_reset(): srst resets test logic, too".
4524 This warning doesn't indicate any serious problem, as long as you don't want to
4525 debug your core right out of reset. Your .cfg file specified @option{jtag_reset
4526 trst_and_srst srst_pulls_trst} to tell OpenOCD that either your board,
4527 your debugger or your target uC (e.g. LPC2000) can't assert the two reset signals
4528 independently. With this setup, it's not possible to halt the core right out of
4529 reset, everything else should work fine.
4531 @item @b{USB Power} When using OpenOCD in conjunction with Amontec JTAGkey and the Yagarto
4532 toolchain (Eclipse, arm-elf-gcc, arm-elf-gdb), the debugging seems to be
4533 unstable. When single-stepping over large blocks of code, GDB and OpenOCD
4534 quit with an error message. Is there a stability issue with OpenOCD?
4536 No, this is not a stability issue concerning OpenOCD. Most users have solved
4537 this issue by simply using a self-powered USB hub, which they connect their
4538 Amontec JTAGkey to. Apparently, some computers do not provide a USB power
4539 supply stable enough for the Amontec JTAGkey to be operated.
4541 @b{Laptops running on battery have this problem too...}
4543 @item @b{USB Power} When using the Amontec JTAGkey, sometimes OpenOCD crashes with the
4544 following error messages: "Error: ft2232.c:201 ft2232_read(): FT_Read returned:
4545 4" and "Error: ft2232.c:365 ft2232_send_and_recv(): couldn't read from FT2232".
4546 What does that mean and what might be the reason for this?
4548 First of all, the reason might be the USB power supply. Try using a self-powered
4549 hub instead of a direct connection to your computer. Secondly, the error code 4
4550 corresponds to an FT_IO_ERROR, which means that the driver for the FTDI USB
4551 chip ran into some sort of error - this points us to a USB problem.
4553 @item @b{GDB Disconnects} When using the Amontec JTAGkey, sometimes OpenOCD crashes with the following
4554 error message: "Error: gdb_server.c:101 gdb_get_char(): read: 10054".
4555 What does that mean and what might be the reason for this?
4557 Error code 10054 corresponds to WSAECONNRESET, which means that the debugger (GDB)
4558 has closed the connection to OpenOCD. This might be a GDB issue.
4560 @item @b{LPC2000 Flash} In the configuration file in the section where flash device configurations
4561 are described, there is a parameter for specifying the clock frequency
4562 for LPC2000 internal flash devices (e.g. @option{flash bank lpc2000
4563 0x0 0x40000 0 0 0 lpc2000_v1 14746 calc_checksum}), which must be
4564 specified in kilohertz. However, I do have a quartz crystal of a
4565 frequency that contains fractions of kilohertz (e.g. 14,745,600 Hz,
4566 i.e. 14,745.600 kHz). Is it possible to specify real numbers for the
4569 No. The clock frequency specified here must be given as an integral number.
4570 However, this clock frequency is used by the In-Application-Programming (IAP)
4571 routines of the LPC2000 family only, which seems to be very tolerant concerning
4572 the given clock frequency, so a slight difference between the specified clock
4573 frequency and the actual clock frequency will not cause any trouble.
4575 @item @b{Command Order} Do I have to keep a specific order for the commands in the configuration file?
4577 Well, yes and no. Commands can be given in arbitrary order, yet the
4578 devices listed for the JTAG scan chain must be given in the right
4579 order (jtag newdevice), with the device closest to the TDO-Pin being
4580 listed first. In general, whenever objects of the same type exist
4581 which require an index number, then these objects must be given in the
4582 right order (jtag newtap, targets and flash banks - a target
4583 references a jtag newtap and a flash bank references a target).
4585 You can use the ``scan_chain'' command to verify and display the tap order.
4587 Also, some commands can't execute until after @command{init} has been
4588 processed. Such commands include @command{nand probe} and everything
4589 else that needs to write to controller registers, perhaps for setting
4590 up DRAM and loading it with code.
4592 @item @b{JTAG Tap Order} JTAG tap order - command order
4594 Many newer devices have multiple JTAG taps. For example: ST
4595 Microsystems STM32 chips have two taps, a ``boundary scan tap'' and
4596 ``Cortex-M3'' tap. Example: The STM32 reference manual, Document ID:
4597 RM0008, Section 26.5, Figure 259, page 651/681, the ``TDI'' pin is
4598 connected to the boundary scan tap, which then connects to the
4599 Cortex-M3 tap, which then connects to the TDO pin.
4601 Thus, the proper order for the STM32 chip is: (1) The Cortex-M3, then
4602 (2) The boundary scan tap. If your board includes an additional JTAG
4603 chip in the scan chain (for example a Xilinx CPLD or FPGA) you could
4604 place it before or after the STM32 chip in the chain. For example:
4607 @item OpenOCD_TDI(output) -> STM32 TDI Pin (BS Input)
4608 @item STM32 BS TDO (output) -> STM32 Cortex-M3 TDI (input)
4609 @item STM32 Cortex-M3 TDO (output) -> SM32 TDO Pin
4610 @item STM32 TDO Pin (output) -> Xilinx TDI Pin (input)
4611 @item Xilinx TDO Pin -> OpenOCD TDO (input)
4614 The ``jtag device'' commands would thus be in the order shown below. Note:
4617 @item jtag newtap Xilinx tap -irlen ...
4618 @item jtag newtap stm32 cpu -irlen ...
4619 @item jtag newtap stm32 bs -irlen ...
4620 @item # Create the debug target and say where it is
4621 @item target create stm32.cpu -chain-position stm32.cpu ...
4625 @item @b{SYSCOMP} Sometimes my debugging session terminates with an error. When I look into the
4626 log file, I can see these error messages: Error: arm7_9_common.c:561
4627 arm7_9_execute_sys_speed(): timeout waiting for SYSCOMP
4633 @node Tcl Crash Course
4634 @chapter Tcl Crash Course
4637 Not everyone knows Tcl - this is not intended to be a replacement for
4638 learning Tcl, the intent of this chapter is to give you some idea of
4639 how the Tcl scripts work.
4641 This chapter is written with two audiences in mind. (1) OpenOCD users
4642 who need to understand a bit more of how JIM-Tcl works so they can do
4643 something useful, and (2) those that want to add a new command to
4646 @section Tcl Rule #1
4647 There is a famous joke, it goes like this:
4649 @item Rule #1: The wife is always correct
4650 @item Rule #2: If you think otherwise, See Rule #1
4653 The Tcl equal is this:
4656 @item Rule #1: Everything is a string
4657 @item Rule #2: If you think otherwise, See Rule #1
4660 As in the famous joke, the consequences of Rule #1 are profound. Once
4661 you understand Rule #1, you will understand Tcl.
4663 @section Tcl Rule #1b
4664 There is a second pair of rules.
4666 @item Rule #1: Control flow does not exist. Only commands
4667 @* For example: the classic FOR loop or IF statement is not a control
4668 flow item, they are commands, there is no such thing as control flow
4670 @item Rule #2: If you think otherwise, See Rule #1
4671 @* Actually what happens is this: There are commands that by
4672 convention, act like control flow key words in other languages. One of
4673 those commands is the word ``for'', another command is ``if''.
4676 @section Per Rule #1 - All Results are strings
4677 Every Tcl command results in a string. The word ``result'' is used
4678 deliberatly. No result is just an empty string. Remember: @i{Rule #1 -
4679 Everything is a string}
4681 @section Tcl Quoting Operators
4682 In life of a Tcl script, there are two important periods of time, the
4683 difference is subtle.
4686 @item Evaluation Time
4689 The two key items here are how ``quoted things'' work in Tcl. Tcl has
4690 three primary quoting constructs, the [square-brackets] the
4691 @{curly-braces@} and ``double-quotes''
4693 By now you should know $VARIABLES always start with a $DOLLAR
4694 sign. BTW: To set a variable, you actually use the command ``set'', as
4695 in ``set VARNAME VALUE'' much like the ancient BASIC langauge ``let x
4696 = 1'' statement, but without the equal sign.
4699 @item @b{[square-brackets]}
4700 @* @b{[square-brackets]} are command substitutions. It operates much
4701 like Unix Shell `back-ticks`. The result of a [square-bracket]
4702 operation is exactly 1 string. @i{Remember Rule #1 - Everything is a
4703 string}. These two statements are roughly identical:
4707 echo "The Date is: $X"
4710 puts "The Date is: $X"
4712 @item @b{``double-quoted-things''}
4713 @* @b{``double-quoted-things''} are just simply quoted
4714 text. $VARIABLES and [square-brackets] are expanded in place - the
4715 result however is exactly 1 string. @i{Remember Rule #1 - Everything
4719 puts "It is now \"[date]\", $x is in 1 hour"
4721 @item @b{@{Curly-Braces@}}
4722 @*@b{@{Curly-Braces@}} are magic: $VARIABLES and [square-brackets] are
4723 parsed, but are NOT expanded or executed. @{Curly-Braces@} are like
4724 'single-quote' operators in BASH shell scripts, with the added
4725 feature: @{curly-braces@} can be nested, single quotes can not. @{@{@{this is
4726 nested 3 times@}@}@} NOTE: [date] is perhaps a bad example, as of
4727 28/nov/2008, Jim/OpenOCD does not have a date command.
4730 @section Consequences of Rule 1/2/3/4
4732 The consequences of Rule 1 are profound.
4734 @subsection Tokenisation & Execution.
4736 Of course, whitespace, blank lines and #comment lines are handled in
4739 As a script is parsed, each (multi) line in the script file is
4740 tokenised and according to the quoting rules. After tokenisation, that
4741 line is immedatly executed.
4743 Multi line statements end with one or more ``still-open''
4744 @{curly-braces@} which - eventually - closes a few lines later.
4746 @subsection Command Execution
4748 Remember earlier: There are no ``control flow''
4749 statements in Tcl. Instead there are COMMANDS that simply act like
4750 control flow operators.
4752 Commands are executed like this:
4755 @item Parse the next line into (argc) and (argv[]).
4756 @item Look up (argv[0]) in a table and call its function.
4757 @item Repeat until End Of File.
4760 It sort of works like this:
4763 ReadAndParse( &argc, &argv );
4765 cmdPtr = LookupCommand( argv[0] );
4767 (*cmdPtr->Execute)( argc, argv );
4771 When the command ``proc'' is parsed (which creates a procedure
4772 function) it gets 3 parameters on the command line. @b{1} the name of
4773 the proc (function), @b{2} the list of parameters, and @b{3} the body
4774 of the function. Not the choice of words: LIST and BODY. The PROC
4775 command stores these items in a table somewhere so it can be found by
4778 @subsection The FOR command
4780 The most interesting command to look at is the FOR command. In Tcl,
4781 the FOR command is normally implemented in C. Remember, FOR is a
4782 command just like any other command.
4784 When the ascii text containing the FOR command is parsed, the parser
4785 produces 5 parameter strings, @i{(If in doubt: Refer to Rule #1)} they
4789 @item The ascii text 'for'
4790 @item The start text
4791 @item The test expression
4796 Sort of reminds you of ``main( int argc, char **argv )'' does it not?
4797 Remember @i{Rule #1 - Everything is a string.} The key point is this:
4798 Often many of those parameters are in @{curly-braces@} - thus the
4799 variables inside are not expanded or replaced until later.
4801 Remember that every Tcl command looks like the classic ``main( argc,
4802 argv )'' function in C. In JimTCL - they actually look like this:
4806 MyCommand( Jim_Interp *interp,
4808 Jim_Obj * const *argvs );
4811 Real Tcl is nearly identical. Although the newer versions have
4812 introduced a byte-code parser and intepreter, but at the core, it
4813 still operates in the same basic way.
4815 @subsection FOR command implementation
4817 To understand Tcl it is perhaps most helpful to see the FOR
4818 command. Remember, it is a COMMAND not a control flow structure.
4820 In Tcl there are two underlying C helper functions.
4822 Remember Rule #1 - You are a string.
4824 The @b{first} helper parses and executes commands found in an ascii
4825 string. Commands can be seperated by semicolons, or newlines. While
4826 parsing, variables are expanded via the quoting rules.
4828 The @b{second} helper evaluates an ascii string as a numerical
4829 expression and returns a value.
4831 Here is an example of how the @b{FOR} command could be
4832 implemented. The pseudo code below does not show error handling.
4834 void Execute_AsciiString( void *interp, const char *string );
4836 int Evaluate_AsciiExpression( void *interp, const char *string );
4839 MyForCommand( void *interp,
4844 SetResult( interp, "WRONG number of parameters");
4848 // argv[0] = the ascii string just like C
4850 // Execute the start statement.
4851 Execute_AsciiString( interp, argv[1] );
4855 i = Evaluate_AsciiExpression(interp, argv[2]);
4860 Execute_AsciiString( interp, argv[3] );
4862 // Execute the LOOP part
4863 Execute_AsciiString( interp, argv[4] );
4867 SetResult( interp, "" );
4872 Every other command IF, WHILE, FORMAT, PUTS, EXPR, everything works
4873 in the same basic way.
4875 @section OpenOCD Tcl Usage
4877 @subsection source and find commands
4878 @b{Where:} In many configuration files
4879 @* Example: @b{ source [find FILENAME] }
4880 @*Remember the parsing rules
4882 @item The FIND command is in square brackets.
4883 @* The FIND command is executed with the parameter FILENAME. It should
4884 find the full path to the named file. The RESULT is a string, which is
4885 substituted on the orginal command line.
4886 @item The command source is executed with the resulting filename.
4887 @* SOURCE reads a file and executes as a script.
4889 @subsection format command
4890 @b{Where:} Generally occurs in numerous places.
4891 @* Tcl has no command like @b{printf()}, instead it has @b{format}, which is really more like
4897 puts [format "The answer: %d" [expr $x * $y]]
4900 @item The SET command creates 2 variables, X and Y.
4901 @item The double [nested] EXPR command performs math
4902 @* The EXPR command produces numerical result as a string.
4904 @item The format command is executed, producing a single string
4905 @* Refer to Rule #1.
4906 @item The PUTS command outputs the text.
4908 @subsection Body or Inlined Text
4909 @b{Where:} Various TARGET scripts.
4912 proc someproc @{@} @{
4913 ... multiple lines of stuff ...
4915 $_TARGETNAME configure -event FOO someproc
4916 #2 Good - no variables
4917 $_TARGETNAME confgure -event foo "this ; that;"
4918 #3 Good Curly Braces
4919 $_TARGETNAME configure -event FOO @{
4922 #4 DANGER DANGER DANGER
4923 $_TARGETNAME configure -event foo "puts \"Time: [date]\""
4926 @item The $_TARGETNAME is an OpenOCD variable convention.
4927 @*@b{$_TARGETNAME} represents the last target created, the value changes
4928 each time a new target is created. Remember the parsing rules. When
4929 the ascii text is parsed, the @b{$_TARGETNAME} becomes a simple string,
4930 the name of the target which happens to be a TARGET (object)
4932 @item The 2nd parameter to the @option{-event} parameter is a TCBODY
4933 @*There are 4 examples:
4935 @item The TCLBODY is a simple string that happens to be a proc name
4936 @item The TCLBODY is several simple commands seperated by semicolons
4937 @item The TCLBODY is a multi-line @{curly-brace@} quoted string
4938 @item The TCLBODY is a string with variables that get expanded.
4941 In the end, when the target event FOO occurs the TCLBODY is
4942 evaluated. Method @b{#1} and @b{#2} are functionally identical. For
4943 Method @b{#3} and @b{#4} it is more interesting. What is the TCLBODY?
4945 Remember the parsing rules. In case #3, @{curly-braces@} mean the
4946 $VARS and [square-brackets] are expanded later, when the EVENT occurs,
4947 and the text is evaluated. In case #4, they are replaced before the
4948 ``Target Object Command'' is executed. This occurs at the same time
4949 $_TARGETNAME is replaced. In case #4 the date will never
4950 change. @{BTW: [date] is perhaps a bad example, as of 28/nov/2008,
4951 Jim/OpenOCD does not have a date command@}
4953 @subsection Global Variables
4954 @b{Where:} You might discover this when writing your own procs @* In
4955 simple terms: Inside a PROC, if you need to access a global variable
4956 you must say so. See also ``upvar''. Example:
4958 proc myproc @{ @} @{
4959 set y 0 #Local variable Y
4960 global x #Global variable X
4961 puts [format "X=%d, Y=%d" $x $y]
4964 @section Other Tcl Hacks
4965 @b{Dynamic variable creation}
4967 # Dynamically create a bunch of variables.
4968 for @{ set x 0 @} @{ $x < 32 @} @{ set x [expr $x + 1]@} @{
4970 set vn [format "BIT%d" $x]
4974 set $vn [expr (1 << $x)]
4977 @b{Dynamic proc/command creation}
4979 # One "X" function - 5 uart functions.
4980 foreach who @{A B C D E@}
4981 proc [format "show_uart%c" $who] @{ @} "show_UARTx $who"
4985 @node Target Library
4986 @chapter Target Library
4987 @cindex Target Library
4989 OpenOCD comes with a target configuration script library. These scripts can be
4990 used as-is or serve as a starting point.
4992 The target library is published together with the OpenOCD executable and
4993 the path to the target library is in the OpenOCD script search path.
4994 Similarly there are example scripts for configuring the JTAG interface.
4996 The command line below uses the example parport configuration script
4997 that ship with OpenOCD, then configures the str710.cfg target and
4998 finally issues the init and reset commands. The communication speed
4999 is set to 10kHz for reset and 8MHz for post reset.
5002 openocd -f interface/parport.cfg -f target/str710.cfg \
5003 -c "init" -c "reset"
5006 To list the target scripts available:
5009 $ ls /usr/local/lib/openocd/target
5011 arm7_fast.cfg lm3s6965.cfg pxa255.cfg stm32.cfg xba_revA3.cfg
5012 at91eb40a.cfg lpc2148.cfg pxa255_sst.cfg str710.cfg zy1000.cfg
5013 at91r40008.cfg lpc2294.cfg sam7s256.cfg str912.cfg
5014 at91sam9260.cfg nslu2.cfg sam7x256.cfg wi-9c.cfg
5019 @node OpenOCD Concept Index
5020 @comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
5021 @comment case issue with ``Index.html'' and ``index.html''
5022 @comment Occurs when creating ``--html --no-split'' output
5023 @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html
5024 @unnumbered OpenOCD Concept Index
5028 @node Command and Driver Index
5029 @unnumbered Command and Driver Index