7a6b948dcb59b3f32714642ed6e2e5b4511f1f48
[openocd.git] / doc / openocd.texi
1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename openocd.info
4 @settitle OpenOCD User's Guide
5 @dircategory Development
6 @direntry
7 * OpenOCD: (openocd).      OpenOCD User's Guide
8 @end direntry
9 @paragraphindent 0
10 @c %**end of header
11
12 @include version.texi
13
14 @copying
15
16 This User's Guide documents
17 release @value{VERSION},
18 dated @value{UPDATED},
19 of the Open On-Chip Debugger (OpenOCD).
20
21 @itemize @bullet
22 @item Copyright @copyright{} 2008 The OpenOCD Project
23 @item Copyright @copyright{} 2007-2008 Spencer Oliver @email{spen@@spen-soft.co.uk}
24 @item Copyright @copyright{} 2008 Oyvind Harboe @email{oyvind.harboe@@zylin.com}
25 @item Copyright @copyright{} 2008 Duane Ellis @email{openocd@@duaneellis.com}
26 @item Copyright @copyright{} 2009 David Brownell
27 @end itemize
28
29 @quotation
30 Permission is granted to copy, distribute and/or modify this document
31 under the terms of the GNU Free Documentation License, Version 1.2 or
32 any later version published by the Free Software Foundation; with no
33 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
34 Texts.  A copy of the license is included in the section entitled ``GNU
35 Free Documentation License''.
36 @end quotation
37 @end copying
38
39 @titlepage
40 @titlefont{@emph{Open On-Chip Debugger:}}
41 @sp 1
42 @title OpenOCD User's Guide
43 @subtitle for release @value{VERSION}
44 @subtitle @value{UPDATED}
45
46 @page
47 @vskip 0pt plus 1filll
48 @insertcopying
49 @end titlepage
50
51 @summarycontents
52 @contents
53
54 @ifnottex
55 @node Top
56 @top OpenOCD User's Guide
57
58 @insertcopying
59 @end ifnottex
60
61 @menu
62 * About::                            About OpenOCD
63 * Developers::                       OpenOCD Developers
64 * Building OpenOCD::                 Building OpenOCD From SVN
65 * JTAG Hardware Dongles::            JTAG Hardware Dongles
66 * About JIM-Tcl::                    About JIM-Tcl
67 * Running::                          Running OpenOCD
68 * OpenOCD Project Setup::            OpenOCD Project Setup
69 * Config File Guidelines::           Config File Guidelines
70 * Daemon Configuration::             Daemon Configuration
71 * Interface - Dongle Configuration:: Interface - Dongle Configuration
72 * Reset Configuration::              Reset Configuration
73 * TAP Declaration::                  TAP Declaration
74 * CPU Configuration::                CPU Configuration
75 * Flash Commands::                   Flash Commands
76 * NAND Flash Commands::              NAND Flash Commands
77 * PLD/FPGA Commands::                PLD/FPGA Commands
78 * General Commands::                 General Commands
79 * Architecture and Core Commands::   Architecture and Core Commands
80 * JTAG Commands::                    JTAG Commands
81 * TFTP::                             TFTP
82 * GDB and OpenOCD::                  Using GDB and OpenOCD
83 * Tcl Scripting API::                Tcl Scripting API
84 * Upgrading::                        Deprecated/Removed Commands
85 * Target Library::                   Target Library
86 * FAQ::                              Frequently Asked Questions
87 * Tcl Crash Course::                 Tcl Crash Course
88 * License::                          GNU Free Documentation License
89
90 @comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
91 @comment case issue with ``Index.html'' and ``index.html''
92 @comment Occurs when creating ``--html --no-split'' output
93 @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html
94 * OpenOCD Concept Index::            Concept Index
95 * Command and Driver Index::         Command and Driver Index
96 @end menu
97
98 @node About
99 @unnumbered About
100 @cindex about
101
102 OpenOCD was created by Dominic Rath as part of a diploma thesis written at the
103 University of Applied Sciences Augsburg (@uref{http://www.fh-augsburg.de}).
104 Since that time, the project has grown into an active open-source project,
105 supported by a diverse community of software and hardware developers from
106 around the world.
107
108 @section What is OpenOCD?
109 @cindex TAP
110 @cindex JTAG
111
112 The Open On-Chip Debugger (OpenOCD) aims to provide debugging,
113 in-system programming and boundary-scan testing for embedded target
114 devices.
115
116 @b{JTAG:} OpenOCD uses a ``hardware interface dongle'' to communicate
117 with the JTAG (IEEE 1149.1) compliant TAPs on your target board.
118 A @dfn{TAP} is a ``Test Access Port'', a module which processes
119 special instructions and data.  TAPs are daisy-chained within and
120 between chips and boards.
121
122 @b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB
123 based, parallel port based, and other standalone boxes that run
124 OpenOCD internally. @xref{JTAG Hardware Dongles}.
125
126 @b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
127 ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
128 Cortex-M3 (Stellaris LM3 and ST STM32) based cores to be
129 debugged via the GDB protocol.
130
131 @b{Flash Programing:} Flash writing is supported for external CFI
132 compatible NOR flashes (Intel and AMD/Spansion command set) and several
133 internal flashes (LPC2000, AT91SAM7, STR7x, STR9x, LM3, and
134 STM32x). Preliminary support for various NAND flash controllers
135 (LPC3180, Orion, S3C24xx, more) controller is included.
136
137 @section OpenOCD Web Site
138
139 The OpenOCD web site provides the latest public news from the community:
140
141 @uref{http://openocd.berlios.de/web/}
142
143 @section Latest User's Guide:
144
145 The user's guide you are now reading may not be the latest one
146 available.  A version for more recent code may be available.
147 Its HTML form is published irregularly at:
148
149 @uref{http://openocd.berlios.de/doc/html/index.html}
150
151 PDF form is likewise published at:
152
153 @uref{http://openocd.berlios.de/doc/pdf/openocd.pdf}
154
155 @section OpenOCD User's Forum
156
157 There is an OpenOCD forum (phpBB) hosted by SparkFun:
158
159 @uref{http://forum.sparkfun.com/viewforum.php?f=18}
160
161
162 @node Developers
163 @chapter OpenOCD Developer Resources
164 @cindex developers
165
166 If you are interested in improving the state of OpenOCD's debugging and
167 testing support, new contributions will be welcome.  Motivated developers
168 can produce new target, flash or interface drivers, improve the
169 documentation, as well as more conventional bug fixes and enhancements.
170
171 The resources in this chapter are available for developers wishing to explore
172 or expand the OpenOCD source code.
173
174 @section OpenOCD Subversion Repository
175
176 The ``Building From Source'' section provides instructions to retrieve
177 and and build the latest version of the OpenOCD source code.
178 @xref{Building OpenOCD}.
179
180 Developers that want to contribute patches to the OpenOCD system are
181 @b{strongly} encouraged to base their work off of the most recent trunk
182 revision.  Patches created against older versions may require additional
183 work from their submitter in order to be updated for newer releases.
184
185 @section Doxygen Developer Manual
186
187 During the development of the 0.2.0 release, the OpenOCD project began
188 providing a Doxygen reference manual.  This document contains more
189 technical information about the software internals, development
190 processes, and similar documentation:
191
192 @uref{http://openocd.berlios.de/doc/doxygen/index.html}
193
194 This document is a work-in-progress, but contributions would be welcome
195 to fill in the gaps.  All of the source files are provided in-tree,
196 listed in the Doxyfile configuration in the top of the repository trunk.
197
198 @section OpenOCD Developer Mailing List
199
200 The OpenOCD Developer Mailing List provides the primary means of
201 communication between developers:
202
203 @uref{https://lists.berlios.de/mailman/listinfo/openocd-development}
204
205 All drivers developers are enouraged to also subscribe to the list of
206 SVN commits to keep pace with the ongoing changes:
207
208 @uref{https://lists.berlios.de/mailman/listinfo/openocd-svn}
209
210
211 @node Building OpenOCD
212 @chapter Building OpenOCD
213 @cindex building
214
215 @section Pre-Built Tools
216 If you are interested in getting actual work done rather than building
217 OpenOCD, then check if your interface supplier provides binaries for
218 you. Chances are that that binary is from some SVN version that is more
219 stable than SVN trunk where bleeding edge development takes place.
220
221 @section Packagers Please Read!
222
223 You are a @b{PACKAGER} of OpenOCD if you
224
225 @enumerate
226 @item @b{Sell dongles} and include pre-built binaries
227 @item @b{Supply tools} i.e.: A complete development solution
228 @item @b{Supply IDEs} like Eclipse, or RHIDE, etc.
229 @item @b{Build packages} i.e.: RPM files, or DEB files for a Linux Distro
230 @end enumerate
231
232 As a @b{PACKAGER}, you will experience first reports of most issues.
233 When you fix those problems for your users, your solution may help
234 prevent hundreds (if not thousands) of other questions from other users.
235
236 If something does not work for you, please work to inform the OpenOCD
237 developers know how to improve the system or documentation to avoid
238 future problems, and follow-up to help us ensure the issue will be fully
239 resolved in our future releases.
240
241 That said, the OpenOCD developers would also like you to follow a few
242 suggestions:
243
244 @enumerate
245 @item Send patches, including config files, upstream.
246 @item Always build with printer ports enabled.
247 @item Use libftdi + libusb for FT2232 support.
248 @end enumerate
249
250 @section Building From Source
251
252 You can download the current SVN version with an SVN client of your choice from the
253 following repositories:
254
255  @uref{svn://svn.berlios.de/openocd/trunk}
256
257 or
258
259  @uref{http://svn.berlios.de/svnroot/repos/openocd/trunk}
260
261 Using the SVN command line client, you can use the following command to fetch the
262 latest version (make sure there is no (non-svn) directory called "openocd" in the
263 current directory):
264
265 @example
266  svn checkout svn://svn.berlios.de/openocd/trunk openocd
267 @end example
268
269 If you prefer GIT based tools, the @command{git-svn} package works too:
270
271 @example
272  git svn clone -s svn://svn.berlios.de/openocd
273 @end example
274
275 Building OpenOCD from a repository requires a recent version of the
276 GNU autotools (autoconf >= 2.59 and automake >= 1.9).
277 For building on Windows,
278 you have to use Cygwin. Make sure that your @env{PATH} environment variable contains no
279 other locations with Unix utils (like UnxUtils) - these can't handle the Cygwin
280 paths, resulting in obscure dependency errors (This is an observation I've gathered
281 from the logs of one user - correct me if I'm wrong).
282
283 You further need the appropriate driver files, if you want to build support for
284 a FTDI FT2232 based interface:
285
286 @itemize @bullet
287 @item @b{ftdi2232} libftdi (@uref{http://www.intra2net.com/opensource/ftdi/})
288 @item @b{ftd2xx} libftd2xx (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}),
289 or the Amontec version (from @uref{http://www.amontec.com}),
290 for easier support of JTAGkey's vendor and product IDs.
291 @end itemize
292
293 libftdi is supported under Windows. Do not use versions earlier than 0.14.
294 To use the newer FT2232H chips, supporting RTCK and USB high speed (480 Mbps),
295 you need libftdi version 0.16 or newer.
296
297 Some people say that FTDI's libftd2xx code provides better performance.
298 However, it is binary-only, while OpenOCD is licenced according
299 to GNU GPLv2 without any exceptions.
300 That means that @emph{distributing} copies of OpenOCD built with
301 the FTDI code would violate the OpenOCD licensing terms.
302 You may, however, build such copies for personal use.
303
304 To build OpenOCD (on both Linux and Cygwin), use the following commands:
305
306 @example
307  ./bootstrap 
308 @end example
309
310 Bootstrap generates the configure script, and prepares building on your system.
311
312 @example
313  ./configure [options, see below]
314 @end example
315
316 Configure generates the Makefiles used to build OpenOCD.
317
318 @example
319  make 
320  make install
321 @end example
322
323 Make builds OpenOCD, and places the final executable in ./src/, the last step, ``make install'' is optional.
324
325 The configure script takes several options, specifying which JTAG interfaces
326 should be included (among other things):
327
328 @itemize @bullet
329 @item
330 @option{--enable-parport} - Enable building the PC parallel port driver.
331 @item
332 @option{--enable-parport_ppdev} - Enable use of ppdev (/dev/parportN) for parport.
333 @item
334 @option{--enable-parport_giveio} - Enable use of giveio for parport instead of ioperm.
335 @item
336 @option{--enable-amtjtagaccel} - Enable building the Amontec JTAG-Accelerator driver.
337 @item
338 @option{--enable-ecosboard} - Enable building support for eCosBoard based JTAG debugger.
339 @item
340 @option{--enable-ioutil} - Enable ioutil functions - useful for standalone OpenOCD implementations.
341 @item
342 @option{--enable-httpd} - Enable builtin httpd server - useful for standalone OpenOCD implementations.
343 @item
344 @option{--enable-ep93xx} - Enable building support for EP93xx based SBCs.
345 @item
346 @option{--enable-at91rm9200} - Enable building support for AT91RM9200 based SBCs.
347 @item
348 @option{--enable-gw16012} - Enable building support for the Gateworks GW16012 JTAG programmer.
349 @item
350 @option{--enable-ft2232_ftd2xx} - Support FT2232-family chips using
351 the closed-source library from FTDICHIP.COM
352 (result not for re-distribution).
353 @item
354 @option{--enable-ft2232_libftdi} - Support FT2232-family chips using
355 a GPL'd ft2232 support library (result OK for re-distribution).
356 @item
357 @option{--with-ftd2xx-win32-zipdir=PATH} - If using FTDICHIP.COM ft2232c driver,
358 give the directory where the Win32 FTDICHIP.COM 'CDM' driver zip file was unpacked.
359 @item
360 @option{--with-ftd2xx-linux-tardir=PATH} - If using FTDICHIP.COM ft2232c driver
361 on Linux, give the directory where the Linux driver's TAR.GZ file was unpacked.
362 @item
363 @option{--with-ftd2xx-lib=shared|static} - Linux only. Default: static.
364 Specifies how the FTDICHIP.COM libftd2xx driver should be linked.
365 Note: 'static' only works in conjunction with @option{--with-ftd2xx-linux-tardir}.
366 The 'shared' value is supported, however you must manually install the required
367 header files and shared libraries in an appropriate place.
368 @item
369 @option{--enable-presto_libftdi} - Enable building support for ASIX Presto programmer using the libftdi driver.
370 @item
371 @option{--enable-presto_ftd2xx} - Enable building support for ASIX Presto programmer using the FTD2XX driver.
372 @item
373 @option{--enable-usbprog} - Enable building support for the USBprog JTAG programmer.
374 @item
375 @option{--enable-oocd_trace} - Enable building support for the OpenOCD+trace ETM capture device.
376 @item
377 @option{--enable-jlink} - Enable building support for the Segger J-Link JTAG programmer.
378 @item
379 @option{--enable-vsllink} - Enable building support for the Versaloon-Link JTAG programmer.
380 @item
381 @option{--enable-rlink} - Enable building support for the Raisonance RLink JTAG programmer.
382 @item
383 @option{--enable-arm-jtag-ew} - Enable building support for the Olimex ARM-JTAG-EW programmer.
384 @item
385 @option{--enable-dummy} - Enable building the dummy port driver.
386 @end itemize
387
388 @section Parallel Port Dongles
389
390 If you want to access the parallel port using the PPDEV interface you have to specify
391 both the @option{--enable-parport} AND the @option{--enable-parport_ppdev} option since
392 the @option{--enable-parport_ppdev} option actually is an option to the parport driver
393 (see @uref{http://forum.sparkfun.com/viewtopic.php?t=3795} for more info).
394
395 The same is true for the @option{--enable-parport_giveio} option, you have to
396 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.
397
398 @section FT2232C Based USB Dongles 
399
400 There are 2 methods of using the FTD2232, either (1) using the
401 FTDICHIP.COM closed source driver, or (2) the open (and free) driver
402 libftdi. Some claim the (closed) FTDICHIP.COM solution is faster,
403 which is the motivation for supporting it even though its licensing
404 restricts it to non-redistributable OpenOCD binaries, and it is
405 not available for all operating systems used with OpenOCD.
406
407 The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
408 TAR.GZ file. You must unpack them ``some where'' convient. As of this
409 writing FTDICHIP does not supply means to install these
410 files ``in an appropriate place''.
411 As a result, there are two
412 ``./configure'' options that help. 
413
414 Below is an example build process:
415
416 @enumerate
417 @item Check out the latest version of ``openocd'' from SVN.
418
419 @item If you are using the FTDICHIP.COM driver, download
420 and unpack the Windows or Linux FTD2xx drivers
421 (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}).
422 If you are using the libftdi driver, install that package
423 (e.g. @command{apt-get install libftdi} on systems with APT).
424
425 @example
426 /home/duane/ftd2xx.win32    => the Cygwin/Win32 ZIP file contents
427 /home/duane/libftd2xx0.4.16 => the Linux TAR.GZ file contents
428 @end example
429
430 @item Configure with options resembling the following.
431
432 @enumerate a
433 @item Cygwin FTDICHIP solution:
434 @example
435 ./configure --prefix=/home/duane/mytools \
436         --enable-ft2232_ftd2xx \
437         --with-ftd2xx-win32-zipdir=/home/duane/ftd2xx.win32
438 @end example
439
440 @item Linux FTDICHIP solution:
441 @example
442 ./configure --prefix=/home/duane/mytools \
443         --enable-ft2232_ftd2xx \
444         --with-ft2xx-linux-tardir=/home/duane/libftd2xx0.4.16
445 @end example
446
447 @item Cygwin/Linux LIBFTDI solution ... assuming that
448 @itemize
449 @item For Windows -- that the Windows port of LIBUSB is in place.
450 @item For Linux -- that libusb has been built/installed and is in place.
451 @item That libftdi has been built and installed (relies on libusb).
452 @end itemize
453
454 Then configure the libftdi solution like this:
455
456 @example
457 ./configure --prefix=/home/duane/mytools \
458         --enable-ft2232_libftdi
459 @end example
460 @end enumerate
461
462 @item Then just type ``make'', and perhaps ``make install''.
463 @end enumerate
464
465
466 @section Miscellaneous Configure Options
467
468 @itemize @bullet
469 @item
470 @option{--disable-option-checking} - Ignore unrecognized @option{--enable} and @option{--with} options.
471 @item
472 @option{--enable-gccwarnings} - Enable extra gcc warnings during build.
473 Default is enabled.
474 @item
475 @option{--enable-release} - Enable building of an OpenOCD release, generally
476 this is for developers. It simply omits the svn version string when the
477 openocd @option{-v} is executed.
478 @end itemize
479
480 @node JTAG Hardware Dongles
481 @chapter JTAG Hardware Dongles
482 @cindex dongles
483 @cindex FTDI
484 @cindex wiggler
485 @cindex zy1000
486 @cindex printer port
487 @cindex USB Adapter
488 @cindex RTCK
489
490 Defined: @b{dongle}: A small device that plugins into a computer and serves as
491 an adapter .... [snip]
492
493 In the OpenOCD case, this generally refers to @b{a small adapater} one
494 attaches to your computer via USB or the Parallel Printer Port.  The
495 execption being the Zylin ZY1000 which is a small box you attach via
496 an ethernet cable. The Zylin ZY1000 has the advantage that it does not
497 require any drivers to be installed on the developer PC. It also has
498 a built in web interface. It supports RTCK/RCLK or adaptive clocking
499 and has a built in relay to power cycle targets remotely.
500
501
502 @section Choosing a Dongle
503
504 There are three things you should keep in mind when choosing a dongle. 
505
506 @enumerate 
507 @item @b{Voltage} What voltage is your target? 1.8, 2.8, 3.3, or 5V? Does your dongle support it?
508 @item @b{Connection} Printer Ports - Does your computer have one?
509 @item @b{Connection} Is that long printer bit-bang cable practical? 
510 @item @b{RTCK} Do you require RTCK? Also known as ``adaptive clocking'' 
511 @end enumerate
512
513 @section Stand alone Systems
514
515 @b{ZY1000} See: @url{http://www.zylin.com/zy1000.html} Technically, not a
516 dongle, but a standalone box. The ZY1000 has the advantage that it does
517 not require any drivers installed on the developer PC. It also has
518 a built in web interface. It supports RTCK/RCLK or adaptive clocking
519 and has a built in relay to power cycle targets remotely.
520
521 @section USB FT2232 Based
522
523 There are many USB JTAG dongles on the market, many of them are based
524 on a chip from ``Future Technology Devices International'' (FTDI)
525 known as the FTDI FT2232; this is a USB full speed (12 Mbps) chip.
526 See: @url{http://www.ftdichip.com} for more information.
527 In summer 2009, USB high speed (480 Mbps) versions of these FTDI
528 chips are starting to become available in JTAG adapters.
529
530 @itemize @bullet
531 @item @b{usbjtag}
532 @* Link @url{http://www.hs-augsburg.de/~hhoegl/proj/usbjtag/usbjtag.html}
533 @item @b{jtagkey}
534 @* See: @url{http://www.amontec.com/jtagkey.shtml}
535 @item @b{oocdlink}
536 @* See: @url{http://www.oocdlink.com} By Joern Kaipf
537 @item @b{signalyzer}
538 @* See: @url{http://www.signalyzer.com}
539 @item @b{evb_lm3s811}
540 @* See: @url{http://www.luminarymicro.com} - The Stellaris LM3S811 eval board has an FTD2232C chip built in.
541 @item @b{olimex-jtag}
542 @* See: @url{http://www.olimex.com}
543 @item @b{flyswatter}
544 @* See: @url{http://www.tincantools.com}
545 @item @b{turtelizer2}
546 @* See:
547 @uref{http://www.ethernut.de/en/hardware/turtelizer/index.html, Turtelizer 2}, or
548 @url{http://www.ethernut.de}
549 @item @b{comstick}
550 @* Link: @url{http://www.hitex.com/index.php?id=383}
551 @item @b{stm32stick}
552 @* Link @url{http://www.hitex.com/stm32-stick}
553 @item @b{axm0432_jtag}
554 @* Axiom AXM-0432 Link @url{http://www.axman.com}
555 @item @b{cortino}
556 @* Link @url{http://www.hitex.com/index.php?id=cortino}
557 @end itemize
558
559 @section USB JLINK based
560 There are several OEM versions of the Segger @b{JLINK} adapter. It is
561 an example of a micro controller based JTAG adapter, it uses an
562 AT91SAM764 internally.
563
564 @itemize @bullet
565 @item @b{ATMEL SAMICE} Only works with ATMEL chips!
566 @* Link: @url{http://www.atmel.com/dyn/products/tools_card.asp?tool_id=3892}
567 @item @b{SEGGER JLINK}
568 @* Link: @url{http://www.segger.com/jlink.html}
569 @item @b{IAR J-Link}
570 @* Link: @url{http://www.iar.com/website1/1.0.1.0/369/1/index.php}
571 @end itemize
572
573 @section USB RLINK based
574 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.
575
576 @itemize @bullet
577 @item @b{Raisonance RLink}
578 @* Link: @url{http://www.raisonance.com/products/RLink.php}
579 @item @b{STM32 Primer}
580 @* Link: @url{http://www.stm32circle.com/resources/stm32primer.php}
581 @item @b{STM32 Primer2}
582 @* Link: @url{http://www.stm32circle.com/resources/stm32primer2.php}
583 @end itemize
584
585 @section USB Other
586 @itemize @bullet
587 @item @b{USBprog}
588 @* Link: @url{http://www.embedded-projects.net/usbprog} - which uses an Atmel MEGA32 and a UBN9604
589
590 @item @b{USB - Presto} 
591 @* Link: @url{http://tools.asix.net/prg_presto.htm}
592
593 @item @b{Versaloon-Link}
594 @* Link: @url{http://www.simonqian.com/en/Versaloon}
595
596 @item @b{ARM-JTAG-EW}
597 @* Link: @url{http://www.olimex.com/dev/arm-jtag-ew.html}
598 @end itemize
599
600 @section IBM PC Parallel Printer Port Based
601
602 The two well known ``JTAG Parallel Ports'' cables are the Xilnx DLC5
603 and the MacGraigor Wiggler. There are many clones and variations of
604 these on the market.
605
606 @itemize @bullet
607
608 @item @b{Wiggler} - There are many clones of this.
609 @* Link: @url{http://www.macraigor.com/wiggler.htm}
610
611 @item @b{DLC5} - From XILINX - There are many clones of this
612 @* Link: Search the web for: ``XILINX DLC5'' - it is no longer
613 produced, PDF schematics are easily found and it is easy to make.
614
615 @item @b{Amontec - JTAG Accelerator}
616 @* Link: @url{http://www.amontec.com/jtag_accelerator.shtml}
617
618 @item @b{GW16402}
619 @* Link: @url{http://www.gateworks.com/products/avila_accessories/gw16042.php}
620
621 @item @b{Wiggler2}
622 @*@uref{http://www.ccac.rwth-aachen.de/@/~michaels/@/index.php/hardware/@/armjtag,
623 Improved parallel-port wiggler-style JTAG adapter}
624
625 @item @b{Wiggler_ntrst_inverted}
626 @* Yet another variation - See the source code, src/jtag/parport.c
627
628 @item @b{old_amt_wiggler}
629 @* Unknown - probably not on the market today
630
631 @item @b{arm-jtag}
632 @* Link: Most likely @url{http://www.olimex.com/dev/arm-jtag.html} [another wiggler clone]
633
634 @item @b{chameleon}
635 @* Link: @url{http://www.amontec.com/chameleon.shtml}
636
637 @item @b{Triton}
638 @* Unknown.
639
640 @item @b{Lattice}
641 @* ispDownload from Lattice Semiconductor
642 @url{http://www.latticesemi.com/lit/docs/@/devtools/dlcable.pdf}
643
644 @item @b{flashlink}
645 @* From ST Microsystems;
646 @uref{http://www.st.com/stonline/@/products/literature/um/7889.pdf,
647 FlashLINK JTAG programing cable for PSD and uPSD}
648
649 @end itemize
650
651 @section Other...
652 @itemize @bullet
653
654 @item @b{ep93xx}
655 @* An EP93xx based Linux machine using the GPIO pins directly.
656
657 @item @b{at91rm9200}
658 @* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
659
660 @end itemize
661
662 @node About JIM-Tcl
663 @chapter About JIM-Tcl
664 @cindex JIM Tcl
665 @cindex tcl
666
667 OpenOCD includes a small ``Tcl Interpreter'' known as JIM-Tcl.
668 This programming language provides a simple and extensible
669 command interpreter.
670
671 All commands presented in this Guide are extensions to JIM-Tcl.
672 You can use them as simple commands, without needing to learn
673 much of anything about Tcl.
674 Alternatively, can write Tcl programs with them.
675
676 You can learn more about JIM at its website,  @url{http://jim.berlios.de}.
677
678 @itemize @bullet
679 @item @b{JIM vs. Tcl}
680 @* JIM-TCL is a stripped down version of the well known Tcl language,
681 which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
682 fewer features. JIM-Tcl is a single .C file and a single .H file and
683 implements the basic Tcl command set. In contrast: Tcl 8.6 is a
684 4.2 MB .zip file containing 1540 files.
685
686 @item @b{Missing Features}
687 @* Our practice has been: Add/clone the real Tcl feature if/when
688 needed. We welcome JIM Tcl improvements, not bloat.
689
690 @item @b{Scripts}
691 @* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
692 command interpreter today is a mixture of (newer)
693 JIM-Tcl commands, and (older) the orginal command interpreter.
694
695 @item @b{Commands}
696 @* At the OpenOCD telnet command line (or via the GDB mon command) one
697 can type a Tcl for() loop, set variables, etc.
698
699 @item @b{Historical Note}
700 @* JIM-Tcl was introduced to OpenOCD in spring 2008.
701
702 @item @b{Need a crash course in Tcl?}
703 @*@xref{Tcl Crash Course}.
704 @end itemize
705
706 @node Running
707 @chapter Running
708 @cindex command line options
709 @cindex logfile
710 @cindex directory search
711
712 The @option{--help} option shows:
713 @verbatim
714 bash$ openocd --help
715
716 --help       | -h       display this help
717 --version    | -v       display OpenOCD version
718 --file       | -f       use configuration file <name>
719 --search     | -s       dir to search for config files and scripts
720 --debug      | -d       set debug level <0-3>
721 --log_output | -l       redirect log output to file <name>
722 --command    | -c       run <command>
723 --pipe       | -p       use pipes when talking to gdb
724 @end verbatim
725
726 By default OpenOCD reads the file configuration file ``openocd.cfg''
727 in the current directory.  To specify a different (or multiple)
728 configuration file, you can use the ``-f'' option. For example:
729
730 @example
731   openocd -f config1.cfg -f config2.cfg -f config3.cfg
732 @end example
733
734 Once started, OpenOCD runs as a daemon, waiting for connections from
735 clients (Telnet, GDB, Other).
736
737 If you are having problems, you can enable internal debug messages via
738 the ``-d'' option.
739
740 Also it is possible to interleave JIM-Tcl commands w/config scripts using the
741 @option{-c} command line switch.
742
743 To enable debug output (when reporting problems or working on OpenOCD
744 itself), use the @option{-d} command line switch. This sets the
745 @option{debug_level} to "3", outputting the most information,
746 including debug messages. The default setting is "2", outputting only
747 informational messages, warnings and errors. You can also change this
748 setting from within a telnet or gdb session using @command{debug_level
749 <n>} (@pxref{debug_level}).
750
751 You can redirect all output from the daemon to a file using the
752 @option{-l <logfile>} switch.
753
754 Search paths for config/script files can be added to OpenOCD by using
755 the @option{-s <search>} switch. The current directory and the OpenOCD
756 target library is in the search path by default.
757
758 For details on the @option{-p} option. @xref{Connecting to GDB}.
759
760 Note! OpenOCD will launch the GDB & telnet server even if it can not
761 establish a connection with the target. In general, it is possible for
762 the JTAG controller to be unresponsive until the target is set up
763 correctly via e.g. GDB monitor commands in a GDB init script.
764
765 @node OpenOCD Project Setup
766 @chapter OpenOCD Project Setup
767
768 To use OpenOCD with your development projects, you need to do more than
769 just connecting the JTAG adapter hardware (dongle) to your development board
770 and then starting the OpenOCD server.
771 You also need to configure that server so that it knows
772 about that adapter and board, and helps your work.
773
774 @section Hooking up the JTAG Adapter
775
776 Today's most common case is a dongle with a JTAG cable on one side
777 (such as a ribbon cable with a 10-pin or 20-pin IDC connector)
778 and a USB cable on the other.
779 Instead of USB, some cables use Ethernet;
780 older ones may use a PC parallel port, or even a serial port.
781
782 @enumerate
783 @item @emph{Start with power to your target board turned off},
784 and nothing connected to your JTAG adapter.
785 If you're particularly paranoid, unplug power to the board.
786 It's important to have the ground signal properly set up,
787 unless you are using a JTAG adapter which provides
788 galvanic isolation between the target board and the
789 debugging host.
790
791 @item @emph{Be sure it's the right kind of JTAG connector.}
792 If your dongle has a 20-pin ARM connector, you need some kind
793 of adapter (or octopus, see below) to hook it up to
794 boards using 14-pin or 10-pin connectors ... or to 20-pin
795 connectors which don't use ARM's pinout.
796
797 In the same vein, make sure the voltage levels are compatible.
798 Not all JTAG adapters have the level shifters needed to work
799 with 1.2 Volt boards.
800
801 @item @emph{Be certain the cable is properly oriented} or you might
802 damage your board.  In most cases there are only two possible
803 ways to connect the cable.
804 Connect the JTAG cable from your adapter to the board.
805 Be sure it's firmly connected.
806
807 In the best case, the connector is keyed to physically
808 prevent you from inserting it wrong.
809 This is most often done using a slot on the board's male connector
810 housing, which must match a key on the JTAG cable's female connector.
811 If there's no housing, then you must look carefully and
812 make sure pin 1 on the cable hooks up to pin 1 on the board.
813 Ribbon cables are frequently all grey except for a wire on one
814 edge, which is red.  The red wire is pin 1.
815
816 Sometimes dongles provide cables where one end is an ``octopus'' of
817 color coded single-wire connectors, instead of a connector block.
818 These are great when converting from one JTAG pinout to another,
819 but are tedious to set up.
820 Use these with connector pinout diagrams to help you match up the
821 adapter signals to the right board pins.
822
823 @item @emph{Connect the adapter's other end} once the JTAG cable is connected.
824 A USB, parallel, or serial port connector will go to the host which
825 you are using to run OpenOCD.
826 For Ethernet, consult the documentation and your network administrator.
827
828 For USB based JTAG adapters you have an easy sanity check at this point:
829 does the host operating system see the JTAG adapter?
830
831 @item @emph{Connect the adapter's power supply, if needed.}
832 This step is primarily for non-USB adapters,
833 but sometimes USB adapters need extra power.
834
835 @item @emph{Power up the target board.}
836 Unless you just let the magic smoke escape,
837 you're now ready to set up the OpenOCD server
838 so you can use JTAG to work with that board.
839
840 @end enumerate
841
842 Talk with the OpenOCD server using
843 telnet (@code{telnet localhost 4444} on many systems) or GDB.
844 @xref{GDB and OpenOCD}.
845
846 @section Project Directory
847
848 There are many ways you can configure OpenOCD and start it up.
849
850 A simple way to organize them all involves keeping a
851 single directory for your work with a given board.
852 When you start OpenOCD from that directory,
853 it searches there first for configuration files
854 and for code you upload to the target board.
855 It is also the natural place to write files,
856 such as log files and data you download from the board.
857
858 @section Configuration Basics
859
860 There are two basic ways of configuring OpenOCD, and
861 a variety of ways you can mix them.
862 Think of the difference as just being how you start the server:
863
864 @itemize
865 @item Many @option{-f file} or @option{-c command} options on the command line
866 @item No options, but a @dfn{user config file}
867 in the current directory named @file{openocd.cfg}
868 @end itemize
869
870 Here is an example @file{openocd.cfg} file for a setup
871 using a Signalyzer FT2232-based JTAG adapter to talk to
872 a board with an Atmel AT91SAM7X256 microcontroller:
873
874 @example
875 source [find interface/signalyzer.cfg]
876
877 # GDB can also flash my flash!
878 gdb_memory_map enable
879 gdb_flash_program enable
880
881 source [find target/sam7x256.cfg]
882 @end example
883
884 Here is the command line equivalent of that configuration:
885
886 @example
887 openocd -f interface/signalyzer.cfg \
888         -c "gdb_memory_map enable" \
889         -c "gdb_flash_program enable" \
890         -f target/sam7x256.cfg
891 @end example
892
893 You could wrap such long command lines in shell scripts,
894 each supporting a different development task.
895 One might re-flash the board with a specific firmware version.
896 Another might set up a particular debugging or run-time environment.
897
898 Here we will focus on the simpler solution:  one user config
899 file, including basic configuration plus any TCL procedures
900 to simplify your work.
901
902 @section User Config Files
903 @cindex config file, user
904 @cindex user config file
905 @cindex config file, overview
906
907 A user configuration file ties together all the parts of a project
908 in one place.
909 One of the following will match your situation best:
910
911 @itemize
912 @item Ideally almost everything comes from configuration files
913 provided by someone else.
914 For example, OpenOCD distributes a @file{scripts} directory
915 (probably in @file{/usr/share/openocd/scripts} on Linux).
916 Board and tool vendors can provide these too, as can individual
917 user sites; the @option{-s} command line option lets you say
918 where to find these files.  (@xref{Running}.)
919 The AT91SAM7X256 example above works this way.
920
921 Three main types of non-user configuration file each have their
922 own subdirectory in the @file{scripts} directory:
923
924 @enumerate
925 @item @b{interface} -- one for each kind of JTAG adapter/dongle
926 @item @b{board} -- one for each different board
927 @item @b{target} -- the chips which integrate CPUs and other JTAG TAPs
928 @end enumerate
929
930 Best case:  include just two files, and they handle everything else.
931 The first is an interface config file.
932 The second is board-specific, and it sets up the JTAG TAPs and
933 their GDB targets (by deferring to some @file{target.cfg} file),
934 declares all flash memory, and leaves you nothing to do except
935 meet your deadline:
936
937 @example
938 source [find interface/olimex-jtag-tiny.cfg]
939 source [find board/csb337.cfg]
940 @end example
941
942 Boards with a single microcontroller often won't need more
943 than the target config file, as in the AT91SAM7X256 example.
944 That's because there is no external memory (flash, DDR RAM), and
945 the board differences are encapsulated by application code.
946
947 @item You can often reuse some standard config files but
948 need to write a few new ones, probably a @file{board.cfg} file.
949 You will be using commands described later in this User's Guide,
950 and working with the guidelines in the next chapter.
951
952 For example, there may be configuration files for your JTAG adapter
953 and target chip, but you need a new board-specific config file
954 giving access to your particular flash chips.
955 Or you might need to write another target chip configuration file
956 for a new chip built around the Cortex M3 core.
957
958 @quotation Note
959 When you write new configuration files, please submit
960 them for inclusion in the next OpenOCD release.
961 For example, a @file{board/newboard.cfg} file will help the
962 next users of that board, and a @file{target/newcpu.cfg}
963 will help support users of any board using that chip.
964 @end quotation
965
966 @item
967 You may may need to write some C code.
968 It may be as simple as a supporting a new new ft2232 or parport
969 based dongle; a bit more involved, like a NAND or NOR flash
970 controller driver; or a big piece of work like supporting
971 a new chip architecture.
972 @end itemize
973
974 Reuse the existing config files when you can.
975 Look first in the @file{scripts/boards} area, then @file{scripts/targets}.
976 You may find a board configuration that's a good example to follow.
977
978 When you write config files, separate the reusable parts
979 (things every user of that interface, chip, or board needs)
980 from ones specific to your environment and debugging approach.
981
982 For example, a @code{gdb-attach} event handler that invokes
983 the @command{reset init} command will interfere with debugging
984 early boot code, which performs some of the same actions
985 that the @code{reset-init} event handler does.
986 Likewise, the @command{arm9tdmi vector_catch} command (or
987 its @command{xscale vector_catch} sibling) can be a timesaver
988 during some debug sessions, but don't make everyone use that either.
989 Keep those kinds of debugging aids in your user config file.
990
991 TCP/IP port configuration is another example of something which
992 is environment-specific, and should only appear in
993 a user config file.  @xref{TCP/IP Ports}.
994
995 @section Project-Specific Utilities
996
997 A few project-specific utility
998 routines may well speed up your work.
999 Write them, and keep them in your project's user config file.
1000
1001 For example, if you are making a boot loader work on a
1002 board, it's nice to be able to debug the ``after it's
1003 loaded to RAM'' parts separately from the finicky early
1004 code which sets up the DDR RAM controller and clocks.
1005 A script like this one, or a more GDB-aware sibling,
1006 may help:
1007
1008 @example
1009 proc ramboot @{ @} @{
1010     # Reset, running the target's "reset-init" scripts
1011     # to initialize clocks and the DDR RAM controller.
1012     # Leave the CPU halted.
1013     reset init
1014
1015     # Load CONFIG_SKIP_LOWLEVEL_INIT version into DDR RAM.
1016     load_image u-boot.bin 0x20000000
1017
1018     # Start running.
1019     resume 0x20000000
1020 @}
1021 @end example
1022
1023 Then once that code is working you will need to make it
1024 boot from NOR flash; a different utility would help.
1025 Alternatively, some developers write to flash using GDB.
1026 (You might use a similar script if you're working with a flash
1027 based microcontroller application instead of a boot loader.)
1028
1029 @example
1030 proc newboot @{ @} @{
1031     # Reset, leaving the CPU halted.  The "reset-init" event
1032     # proc gives faster access to the CPU and to NOR flash;
1033     # "reset halt" would be slower.
1034     reset init
1035
1036     # Write standard version of U-Boot into the first two
1037     # sectors of NOR flash ... the standard version should
1038     # do the same lowlevel init as "reset-init".
1039     flash protect 0 0 1 off
1040     flash erase_sector 0 0 1
1041     flash write_bank 0 u-boot.bin 0x0
1042     flash protect 0 0 1 on
1043
1044     # Reboot from scratch using that new boot loader.
1045     reset run
1046 @}
1047 @end example
1048
1049 You may need more complicated utility procedures when booting
1050 from NAND.
1051 That often involves an extra bootloader stage,
1052 running from on-chip SRAM to perform DDR RAM setup so it can load
1053 the main bootloader code (which won't fit into that SRAM).
1054
1055 Other helper scripts might be used to write production system images,
1056 involving considerably more than just a three stage bootloader.
1057
1058
1059 @node Config File Guidelines
1060 @chapter Config File Guidelines
1061
1062 This chapter is aimed at any user who needs to write a config file,
1063 including developers and integrators of OpenOCD and any user who
1064 needs to get a new board working smoothly.
1065 It provides guidelines for creating those files.
1066
1067 You should find the following directories under @t{$(INSTALLDIR)/scripts}:
1068
1069 @itemize @bullet
1070 @item @file{interface} ...
1071 think JTAG Dongle. Files that configure JTAG adapters go here.
1072 @item @file{board} ...
1073 think Circuit Board, PWA, PCB, they go by many names.  Board files
1074 contain initialization items that are specific to a board.  For
1075 example, the SDRAM initialization sequence for the board, or the type
1076 of external flash and what address it uses.  Any initialization
1077 sequence to enable that external flash or SDRAM should be found in the
1078 board file. Boards may also contain multiple targets:  two CPUs; or
1079 a CPU and an FPGA or CPLD.
1080 @item @file{target} ...
1081 think chip. The ``target'' directory represents the JTAG TAPs
1082 on a chip
1083 which OpenOCD should control, not a board. Two common types of targets
1084 are ARM chips and FPGA or CPLD chips.
1085 When a chip has multiple TAPs (maybe it has both ARM and DSP cores),
1086 the target config file defines all of them.
1087 @end itemize
1088
1089 The @file{openocd.cfg} user config
1090 file may override features in any of the above files by
1091 setting variables before sourcing the target file, or by adding
1092 commands specific to their situation.
1093
1094 @section Interface Config Files
1095
1096 The user config file
1097 should be able to source one of these files with a command like this:
1098
1099 @example
1100 source [find interface/FOOBAR.cfg]
1101 @end example
1102
1103 A preconfigured interface file should exist for every interface in use
1104 today, that said, perhaps some interfaces have only been used by the
1105 sole developer who created it.
1106
1107 A separate chapter gives information about how to set these up.
1108 @xref{Interface - Dongle Configuration}.
1109 Read the OpenOCD source code if you have a new kind of hardware interface
1110 and need to provide a driver for it.
1111
1112 @section Board Config Files
1113 @cindex config file, board
1114 @cindex board config file
1115
1116 The user config file
1117 should be able to source one of these files with a command like this:
1118
1119 @example
1120 source [find board/FOOBAR.cfg]
1121 @end example
1122
1123 The point of a board config file is to package everything
1124 about a given board that user config files need to know.
1125 In summary the board files should contain (if present)
1126
1127 @enumerate
1128 @item One or more @command{source [target/...cfg]} statements
1129 @item NOR flash configuration (@pxref{NOR Configuration})
1130 @item NAND flash configuration (@pxref{NAND Configuration})
1131 @item Target @code{reset} handlers for SDRAM and I/O configuration
1132 @item JTAG adapter reset configuration (@pxref{Reset Configuration})
1133 @item All things that are not ``inside a chip''
1134 @end enumerate
1135
1136 Generic things inside target chips belong in target config files,
1137 not board config files.  So for example a @code{reset-init} event
1138 handler should know board-specific oscillator and PLL parameters,
1139 which it passes to target-specific utility code.
1140
1141 The most complex task of a board config file is creating such a
1142 @code{reset-init} event handler.
1143 Define those handlers last, after you verify the rest of the board
1144 configuration works.
1145
1146 @subsection Communication Between Config files
1147
1148 In addition to target-specific utility code, another way that
1149 board and target config files communicate is by following a
1150 convention on how to use certain variables.
1151
1152 The full Tcl/Tk language supports ``namespaces'', but JIM-Tcl does not.
1153 Thus the rule we follow in OpenOCD is this: Variables that begin with
1154 a leading underscore are temporary in nature, and can be modified and
1155 used at will within a target configuration file.
1156
1157 Complex board config files can do the things like this,
1158 for a board with three chips:
1159
1160 @example
1161 # Chip #1: PXA270 for network side, big endian
1162 set CHIPNAME network
1163 set ENDIAN big
1164 source [find target/pxa270.cfg]
1165 # on return: _TARGETNAME = network.cpu
1166 # other commands can refer to the "network.cpu" target.
1167 $_TARGETNAME configure .... events for this CPU..
1168
1169 # Chip #2: PXA270 for video side, little endian
1170 set CHIPNAME video
1171 set ENDIAN little
1172 source [find target/pxa270.cfg]
1173 # on return: _TARGETNAME = video.cpu
1174 # other commands can refer to the "video.cpu" target.
1175 $_TARGETNAME configure .... events for this CPU..
1176
1177 # Chip #3: Xilinx FPGA for glue logic
1178 set CHIPNAME xilinx
1179 unset ENDIAN
1180 source [find target/spartan3.cfg]
1181 @end example
1182
1183 That example is oversimplified because it doesn't show any flash memory,
1184 or the @code{reset-init} event handlers to initialize external DRAM
1185 or (assuming it needs it) load a configuration into the FPGA.
1186 Such features are usually needed for low-level work with many boards,
1187 where ``low level'' implies that the board initialization software may
1188 not be working.  (That's a common reason to need JTAG tools.  Another
1189 is to enable working with microcontroller-based systems, which often
1190 have no debugging support except a JTAG connector.)
1191
1192 Target config files may also export utility functions to board and user
1193 config files.  Such functions should use name prefixes, to help avoid
1194 naming collisions.
1195
1196 Board files could also accept input variables from user config files.
1197 For example, there might be a @code{J4_JUMPER} setting used to identify
1198 what kind of flash memory a development board is using, or how to set
1199 up other clocks and peripherals.
1200
1201 @subsection Variable Naming Convention
1202 @cindex variable names
1203
1204 Most boards have only one instance of a chip.
1205 However, it should be easy to create a board with more than
1206 one such chip (as shown above).
1207 Accordingly, we encourage these conventions for naming
1208 variables associated with different @file{target.cfg} files,
1209 to promote consistency and
1210 so that board files can override target defaults.
1211
1212 Inputs to target config files include:
1213
1214 @itemize @bullet
1215 @item @code{CHIPNAME} ...
1216 This gives a name to the overall chip, and is used as part of
1217 tap identifier dotted names.
1218 While the default is normally provided by the chip manufacturer,
1219 board files may need to distinguish between instances of a chip.
1220 @item @code{ENDIAN} ...
1221 By default @option{little} - although chips may hard-wire @option{big}.
1222 Chips that can't change endianness don't need to use this variable.
1223 @item @code{CPUTAPID} ...
1224 When OpenOCD examines the JTAG chain, it can be told verify the
1225 chips against the JTAG IDCODE register.
1226 The target file will hold one or more defaults, but sometimes the
1227 chip in a board will use a different ID (perhaps a newer revision).
1228 @end itemize
1229
1230 Outputs from target config files include:
1231
1232 @itemize @bullet
1233 @item @code{_TARGETNAME} ...
1234 By convention, this variable is created by the target configuration
1235 script. The board configuration file may make use of this variable to
1236 configure things like a ``reset init'' script, or other things
1237 specific to that board and that target.
1238 If the chip has 2 targets, the names are @code{_TARGETNAME0},
1239 @code{_TARGETNAME1}, ... etc.
1240 @end itemize
1241
1242 @subsection The reset-init Event Handler
1243 @cindex event, reset-init
1244 @cindex reset-init handler
1245
1246 Board config files run in the OpenOCD configuration stage;
1247 they can't use TAPs or targets, since they haven't been
1248 fully set up yet.
1249 This means you can't write memory or access chip registers;
1250 you can't even verify that a flash chip is present.
1251 That's done later in event handlers, of which the target @code{reset-init}
1252 handler is one of the most important.
1253
1254 Except on microcontrollers, the basic job of @code{reset-init} event
1255 handlers is setting up flash and DRAM, as normally handled by boot loaders.
1256 Microcontrollers rarely use boot loaders; they run right out of their
1257 on-chip flash and SRAM memory.  But they may want to use one of these
1258 handlers too, if just for developer convenience.
1259
1260 @quotation Note
1261 Because this is so very board-specific, and chip-specific, no examples
1262 are included here.
1263 Instead, look at the board config files distributed with OpenOCD.
1264 If you have a boot loader, its source code may also be useful.
1265 @end quotation
1266
1267 Some of this code could probably be shared between different boards.
1268 For example, setting up a DRAM controller often doesn't differ by
1269 much except the bus width (16 bits or 32?) and memory timings, so a
1270 reusable TCL procedure loaded by the @file{target.cfg} file might take
1271 those as parameters.
1272 Similarly with oscillator, PLL, and clock setup;
1273 and disabling the watchdog.
1274 Structure the code cleanly, and provide comments to help
1275 the next developer doing such work.
1276 (@emph{You might be that next person} trying to reuse init code!)
1277
1278 The last thing normally done in a @code{reset-init} handler is probing
1279 whatever flash memory was configured.  For most chips that needs to be
1280 done while the associated target is halted, either because JTAG memory
1281 access uses the CPU or to prevent conflicting CPU access.
1282
1283 @subsection JTAG Clock Rate
1284
1285 Before your @code{reset-init} handler has set up
1286 the PLLs and clocking, you may need to use
1287 a low JTAG clock rate; then you'd increase it later.
1288 (The rule of thumb for ARM-based processors is 1/8 the CPU clock.)
1289 If the board supports adaptive clocking, use the @command{jtag_rclk}
1290 command, in case your board is used with JTAG adapter which
1291 also supports it.  Otherwise use @command{jtag_khz}.
1292 Set the slow rate at the beginning of the reset sequence,
1293 and the faster rate as soon as the clocks are at full speed.
1294
1295 @section Target Config Files
1296 @cindex config file, target
1297 @cindex target config file
1298
1299 Board config files communicate with target config files using
1300 naming conventions as described above, and may source one or
1301 more target config files like this:
1302
1303 @example
1304 source [find target/FOOBAR.cfg]
1305 @end example
1306
1307 The point of a target config file is to package everything
1308 about a given chip that board config files need to know.
1309 In summary the target files should contain
1310
1311 @enumerate
1312 @item Set defaults
1313 @item Add TAPs to the scan chain
1314 @item Add CPU targets (includes GDB support)
1315 @item CPU/Chip/CPU-Core specific features
1316 @item On-Chip flash
1317 @end enumerate
1318
1319 As a rule of thumb, a target file sets up only one chip.
1320 For a microcontroller, that will often include a single TAP,
1321 which is a CPU needing a GDB target, and its on-chip flash.
1322
1323 More complex chips may include multiple TAPs, and the target
1324 config file may need to define them all before OpenOCD
1325 can talk to the chip.
1326 For example, some phone chips have JTAG scan chains that include
1327 an ARM core for operating system use, a DSP,
1328 another ARM core embedded in an image processing engine,
1329 and other processing engines.
1330
1331 @subsection Default Value Boiler Plate Code
1332
1333 All target configuration files should start with code like this,
1334 letting board config files express environment-specific
1335 differences in how things should be set up.
1336
1337 @example
1338 # Boards may override chip names, perhaps based on role,
1339 # but the default should match what the vendor uses
1340 if @{ [info exists CHIPNAME] @} @{
1341    set  _CHIPNAME $CHIPNAME
1342 @} else @{
1343    set  _CHIPNAME sam7x256
1344 @}
1345
1346 # ONLY use ENDIAN with targets that can change it.
1347 if @{ [info exists ENDIAN] @} @{
1348    set  _ENDIAN $ENDIAN
1349 @} else @{
1350    set  _ENDIAN little
1351 @}
1352
1353 # TAP identifiers may change as chips mature, for example with
1354 # new revision fields (the "3" here).  Pick a good default; you
1355 # can pass several such identifiers to the "jtag newtap" command.
1356 if @{ [info exists CPUTAPID ] @} @{
1357    set _CPUTAPID $CPUTAPID
1358 @} else @{
1359    set _CPUTAPID 0x3f0f0f0f
1360 @}
1361 @end example
1362
1363 @emph{Remember:} Board config files may include multiple target
1364 config files, or the same target file multiple times
1365 (changing at least @code{CHIPNAME}).
1366
1367 Likewise, the target configuration file should define
1368 @code{_TARGETNAME} (or @code{_TARGETNAME0} etc) and
1369 use it later on when defining debug targets:
1370
1371 @example
1372 set _TARGETNAME $_CHIPNAME.cpu
1373 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1374 @end example
1375
1376 @subsection Adding TAPs to the Scan Chain
1377 After the ``defaults'' are set up,
1378 add the TAPs on each chip to the JTAG scan chain.
1379 @xref{TAP Declaration}, and the naming convention
1380 for taps.
1381
1382 In the simplest case the chip has only one TAP,
1383 probably for a CPU or FPGA.
1384 The config file for the Atmel AT91SAM7X256
1385 looks (in part) like this:
1386
1387 @example
1388 jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf \
1389         -expected-id $_CPUTAPID
1390 @end example
1391
1392 A board with two such at91sam7 chips would be able
1393 to source such a config file twice, with different
1394 values for @code{CHIPNAME}, so
1395 it adds a different TAP each time.
1396
1397 If there are one or more nonzero @option{-expected-id} values,
1398 OpenOCD attempts to verify the actual tap id against those values.
1399 It will issue error messages if there is mismatch, which
1400 can help to pinpoint problems in OpenOCD configurations.
1401
1402 @example
1403 JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f
1404                 (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
1405 ERROR: Tap: sam7x256.cpu - Expected id: 0x12345678, Got: 0x3f0f0f0f
1406 ERROR: expected: mfg: 0x33c, part: 0x2345, ver: 0x1
1407 ERROR:      got: mfg: 0x787, part: 0xf0f0, ver: 0x3
1408 @end example
1409
1410 There are more complex examples too, with chips that have
1411 multiple TAPs.  Ones worth looking at include:
1412
1413 @itemize
1414 @item @file{target/omap3530.cfg} -- with disabled ARM and DSP,
1415 plus a JRC to enable them
1416 @item @file{target/str912.cfg} -- with flash, CPU, and boundary scan
1417 @item @file{target/ti_dm355.cfg} -- with ETM, ARM, and JRC (this JRC
1418 is not currently used)
1419 @end itemize
1420
1421 @subsection Add CPU targets
1422
1423 After adding a TAP for a CPU, you should set it up so that
1424 GDB and other commands can use it.
1425 @xref{CPU Configuration}.
1426 For the at91sam7 example above, the command can look like this;
1427 note that @code{$_ENDIAN} is not needed, since OpenOCD defaults
1428 to little endian, and this chip doesn't support changing that.
1429
1430 @example
1431 set _TARGETNAME $_CHIPNAME.cpu
1432 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1433 @end example
1434
1435 Work areas are small RAM areas associated with CPU targets.
1436 They are used by OpenOCD to speed up downloads,
1437 and to download small snippets of code to program flash chips.
1438 If the chip includes a form of ``on-chip-ram'' - and many do - define
1439 a work area if you can.
1440 Again using the at91sam7 as an example, this can look like:
1441
1442 @example
1443 $_TARGETNAME configure -work-area-phys 0x00200000 \
1444              -work-area-size 0x4000 -work-area-backup 0
1445 @end example
1446
1447 @subsection Chip Reset Setup
1448
1449 As a rule, you should put the @command{reset_config} command
1450 into the board file.  Most things you think you know about a
1451 chip can be tweaked by the board.
1452
1453 Some chips have specific ways the TRST and SRST signals are
1454 managed. In the unusual case that these are @emph{chip specific}
1455 and can never be changed by board wiring, they could go here.
1456
1457 Some chips need special attention during reset handling if
1458 they're going to be used with JTAG.
1459 An example might be needing to send some commands right
1460 after the target's TAP has been reset, providing a
1461 @code{reset-deassert-post} event handler that writes a chip
1462 register to report that JTAG debugging is being done.
1463
1464 @subsection ARM Core Specific Hacks
1465
1466 If the chip has a DCC, enable it. If the chip is an ARM9 with some
1467 special high speed download features - enable it.
1468
1469 If present, the MMU, the MPU and the CACHE should be disabled.
1470
1471 Some ARM cores are equipped with trace support, which permits
1472 examination of the instruction and data bus activity.  Trace
1473 activity is controlled through an ``Embedded Trace Module'' (ETM)
1474 on one of the core's scan chains.  The ETM emits voluminous data
1475 through a ``trace port''.  (@xref{ARM Tracing}.)
1476 If you are using an external trace port,
1477 configure it in your board config file.
1478 If you are using an on-chip ``Embedded Trace Buffer'' (ETB),
1479 configure it in your target config file.
1480
1481 @example
1482 etm config $_TARGETNAME 16 normal full etb
1483 etb config $_TARGETNAME $_CHIPNAME.etb
1484 @end example
1485
1486 @subsection Internal Flash Configuration
1487
1488 This applies @b{ONLY TO MICROCONTROLLERS} that have flash built in.
1489
1490 @b{Never ever} in the ``target configuration file'' define any type of
1491 flash that is external to the chip. (For example a BOOT flash on
1492 Chip Select 0.) Such flash information goes in a board file - not
1493 the TARGET (chip) file.
1494
1495 Examples:
1496 @itemize @bullet
1497 @item at91sam7x256 - has 256K flash YES enable it.
1498 @item str912 - has flash internal YES enable it.
1499 @item imx27 - uses boot flash on CS0 - it goes in the board file.
1500 @item pxa270 - again - CS0 flash - it goes in the board file.
1501 @end itemize
1502
1503 @node Daemon Configuration
1504 @chapter Daemon Configuration
1505 @cindex initialization
1506 The commands here are commonly found in the openocd.cfg file and are
1507 used to specify what TCP/IP ports are used, and how GDB should be
1508 supported.
1509
1510 @section Configuration Stage
1511 @cindex configuration stage
1512 @cindex configuration command
1513
1514 When the OpenOCD server process starts up, it enters a
1515 @emph{configuration stage} which is the only time that
1516 certain commands, @emph{configuration commands}, may be issued.
1517 Those configuration commands include declaration of TAPs
1518 and other basic setup.
1519 The server must leave the configuration stage before it
1520 may access or activate TAPs.
1521 After it leaves this stage, configuration commands may no
1522 longer be issued.
1523
1524 @deffn {Config Command} init
1525 This command terminates the configuration stage and
1526 enters the normal command mode. This can be useful to add commands to
1527 the startup scripts and commands such as resetting the target,
1528 programming flash, etc. To reset the CPU upon startup, add "init" and
1529 "reset" at the end of the config script or at the end of the OpenOCD
1530 command line using the @option{-c} command line switch.
1531
1532 If this command does not appear in any startup/configuration file
1533 OpenOCD executes the command for you after processing all
1534 configuration files and/or command line options.
1535
1536 @b{NOTE:} This command normally occurs at or near the end of your
1537 openocd.cfg file to force OpenOCD to ``initialize'' and make the
1538 targets ready. For example: If your openocd.cfg file needs to
1539 read/write memory on your target, @command{init} must occur before
1540 the memory read/write commands.  This includes @command{nand probe}.
1541 @end deffn
1542
1543 @anchor{TCP/IP Ports}
1544 @section TCP/IP Ports
1545 @cindex TCP port
1546 @cindex server
1547 @cindex port
1548 @cindex security
1549 The OpenOCD server accepts remote commands in several syntaxes.
1550 Each syntax uses a different TCP/IP port, which you may specify
1551 only during configuration (before those ports are opened).
1552
1553 For reasons including security, you may wish to prevent remote
1554 access using one or more of these ports.
1555 In such cases, just specify the relevant port number as zero.
1556 If you disable all access through TCP/IP, you will need to
1557 use the command line @option{-pipe} option.
1558
1559 @deffn {Command} gdb_port (number)
1560 @cindex GDB server
1561 Specify or query the first port used for incoming GDB connections.
1562 The GDB port for the
1563 first target will be gdb_port, the second target will listen on gdb_port + 1, and so on.
1564 When not specified during the configuration stage,
1565 the port @var{number} defaults to 3333.
1566 When specified as zero, this port is not activated.
1567 @end deffn
1568
1569 @deffn {Command} tcl_port (number)
1570 Specify or query the port used for a simplified RPC
1571 connection that can be used by clients to issue TCL commands and get the
1572 output from the Tcl engine.
1573 Intended as a machine interface.
1574 When not specified during the configuration stage,
1575 the port @var{number} defaults to 6666.
1576 When specified as zero, this port is not activated.
1577 @end deffn
1578
1579 @deffn {Command} telnet_port (number)
1580 Specify or query the
1581 port on which to listen for incoming telnet connections.
1582 This port is intended for interaction with one human through TCL commands.
1583 When not specified during the configuration stage,
1584 the port @var{number} defaults to 4444.
1585 When specified as zero, this port is not activated.
1586 @end deffn
1587
1588 @anchor{GDB Configuration}
1589 @section GDB Configuration
1590 @cindex GDB
1591 @cindex GDB configuration
1592 You can reconfigure some GDB behaviors if needed.
1593 The ones listed here are static and global.
1594 @xref{Target Configuration}, about configuring individual targets.
1595 @xref{Target Events}, about configuring target-specific event handling.
1596
1597 @anchor{gdb_breakpoint_override}
1598 @deffn {Command} gdb_breakpoint_override [@option{hard}|@option{soft}|@option{disable}]
1599 Force breakpoint type for gdb @command{break} commands.
1600 This option supports GDB GUIs which don't
1601 distinguish hard versus soft breakpoints, if the default OpenOCD and
1602 GDB behaviour is not sufficient.  GDB normally uses hardware
1603 breakpoints if the memory map has been set up for flash regions.
1604 @end deffn
1605
1606 @deffn {Config command} gdb_detach (@option{resume}|@option{reset}|@option{halt}|@option{nothing})
1607 Configures what OpenOCD will do when GDB detaches from the daemon.
1608 Default behaviour is @option{resume}.
1609 @end deffn
1610
1611 @anchor{gdb_flash_program}
1612 @deffn {Config command} gdb_flash_program (@option{enable}|@option{disable})
1613 Set to @option{enable} to cause OpenOCD to program the flash memory when a
1614 vFlash packet is received.
1615 The default behaviour is @option{enable}.
1616 @end deffn
1617
1618 @deffn {Config command} gdb_memory_map (@option{enable}|@option{disable})
1619 Set to @option{enable} to cause OpenOCD to send the memory configuration to GDB when
1620 requested. GDB will then know when to set hardware breakpoints, and program flash
1621 using the GDB load command. @command{gdb_flash_program enable} must also be enabled
1622 for flash programming to work.
1623 Default behaviour is @option{enable}.
1624 @xref{gdb_flash_program}.
1625 @end deffn
1626
1627 @deffn {Config command} gdb_report_data_abort (@option{enable}|@option{disable})
1628 Specifies whether data aborts cause an error to be reported
1629 by GDB memory read packets.
1630 The default behaviour is @option{disable};
1631 use @option{enable} see these errors reported.
1632 @end deffn
1633
1634 @anchor{Event Polling}
1635 @section Event Polling
1636
1637 Hardware debuggers are parts of asynchronous systems,
1638 where significant events can happen at any time.
1639 The OpenOCD server needs to detect some of these events,
1640 so it can report them to through TCL command line
1641 or to GDB.
1642
1643 Examples of such events include:
1644
1645 @itemize
1646 @item One of the targets can stop running ... maybe it triggers
1647 a code breakpoint or data watchpoint, or halts itself.
1648 @item Messages may be sent over ``debug message'' channels ... many
1649 targets support such messages sent over JTAG,
1650 for receipt by the person debugging or tools.
1651 @item Loss of power ... some adapters can detect these events.
1652 @item Resets not issued through JTAG ... such reset sources
1653 can include button presses or other system hardware, sometimes
1654 including the target itself (perhaps through a watchdog).
1655 @item Debug instrumentation sometimes supports event triggering
1656 such as ``trace buffer full'' (so it can quickly be emptied)
1657 or other signals (to correlate with code behavior).
1658 @end itemize
1659
1660 None of those events are signaled through standard JTAG signals.
1661 However, most conventions for JTAG connectors include voltage
1662 level and system reset (SRST) signal detection.
1663 Some connectors also include instrumentation signals, which
1664 can imply events when those signals are inputs.
1665
1666 In general, OpenOCD needs to periodically check for those events,
1667 either by looking at the status of signals on the JTAG connector
1668 or by sending synchronous ``tell me your status'' JTAG requests
1669 to the various active targets.
1670 There is a command to manage and monitor that polling,
1671 which is normally done in the background.
1672
1673 @deffn Command poll [@option{on}|@option{off}]
1674 Poll the current target for its current state.
1675 (Also, @pxref{target curstate}.)
1676 If that target is in debug mode, architecture
1677 specific information about the current state is printed.
1678 An optional parameter
1679 allows background polling to be enabled and disabled.
1680
1681 You could use this from the TCL command shell, or
1682 from GDB using @command{monitor poll} command.
1683 @example
1684 > poll
1685 background polling: on
1686 target state: halted
1687 target halted in ARM state due to debug-request, \
1688                current mode: Supervisor
1689 cpsr: 0x800000d3 pc: 0x11081bfc
1690 MMU: disabled, D-Cache: disabled, I-Cache: enabled
1691 >
1692 @end example
1693 @end deffn
1694
1695 @node Interface - Dongle Configuration
1696 @chapter Interface - Dongle Configuration
1697 @cindex config file, interface
1698 @cindex interface config file
1699
1700 JTAG Adapters/Interfaces/Dongles are normally configured
1701 through commands in an interface configuration
1702 file which is sourced by your @file{openocd.cfg} file, or
1703 through a command line @option{-f interface/....cfg} option.
1704
1705 @example
1706 source [find interface/olimex-jtag-tiny.cfg]
1707 @end example
1708
1709 These commands tell
1710 OpenOCD what type of JTAG adapter you have, and how to talk to it.
1711 A few cases are so simple that you only need to say what driver to use:
1712
1713 @example
1714 # jlink interface
1715 interface jlink
1716 @end example
1717
1718 Most adapters need a bit more configuration than that.
1719
1720
1721 @section Interface Configuration
1722
1723 The interface command tells OpenOCD what type of JTAG dongle you are
1724 using. Depending on the type of dongle, you may need to have one or
1725 more additional commands.
1726
1727 @deffn {Config Command} {interface} name
1728 Use the interface driver @var{name} to connect to the
1729 target.
1730 @end deffn
1731
1732 @deffn Command {interface_list}
1733 List the interface drivers that have been built into
1734 the running copy of OpenOCD.
1735 @end deffn
1736
1737 @deffn Command {jtag interface}
1738 Returns the name of the interface driver being used.
1739 @end deffn
1740
1741 @section Interface Drivers
1742
1743 Each of the interface drivers listed here must be explicitly
1744 enabled when OpenOCD is configured, in order to be made
1745 available at run time.
1746
1747 @deffn {Interface Driver} {amt_jtagaccel}
1748 Amontec Chameleon in its JTAG Accelerator configuration,
1749 connected to a PC's EPP mode parallel port.
1750 This defines some driver-specific commands:
1751
1752 @deffn {Config Command} {parport_port} number
1753 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
1754 the number of the @file{/dev/parport} device.
1755 @end deffn
1756
1757 @deffn {Config Command} rtck [@option{enable}|@option{disable}]
1758 Displays status of RTCK option.
1759 Optionally sets that option first.
1760 @end deffn
1761 @end deffn
1762
1763 @deffn {Interface Driver} {arm-jtag-ew}
1764 Olimex ARM-JTAG-EW USB adapter
1765 This has one driver-specific command:
1766
1767 @deffn Command {armjtagew_info}
1768 Logs some status
1769 @end deffn
1770 @end deffn
1771
1772 @deffn {Interface Driver} {at91rm9200}
1773 Supports bitbanged JTAG from the local system,
1774 presuming that system is an Atmel AT91rm9200
1775 and a specific set of GPIOs is used.
1776 @c command:     at91rm9200_device NAME
1777 @c chooses among list of bit configs ... only one option
1778 @end deffn
1779
1780 @deffn {Interface Driver} {dummy}
1781 A dummy software-only driver for debugging.
1782 @end deffn
1783
1784 @deffn {Interface Driver} {ep93xx}
1785 Cirrus Logic EP93xx based single-board computer bit-banging (in development)
1786 @end deffn
1787
1788 @deffn {Interface Driver} {ft2232}
1789 FTDI FT2232 (USB) based devices over one of the userspace libraries.
1790 These interfaces have several commands, used to configure the driver
1791 before initializing the JTAG scan chain:
1792
1793 @deffn {Config Command} {ft2232_device_desc} description
1794 Provides the USB device description (the @emph{iProduct string})
1795 of the FTDI FT2232 device. If not
1796 specified, the FTDI default value is used. This setting is only valid
1797 if compiled with FTD2XX support.
1798 @end deffn
1799
1800 @deffn {Config Command} {ft2232_serial} serial-number
1801 Specifies the @var{serial-number} of the FTDI FT2232 device to use,
1802 in case the vendor provides unique IDs and more than one FT2232 device
1803 is connected to the host.
1804 If not specified, serial numbers are not considered.
1805 @end deffn
1806
1807 @deffn {Config Command} {ft2232_layout} name
1808 Each vendor's FT2232 device can use different GPIO signals
1809 to control output-enables, reset signals, and LEDs.
1810 Currently valid layout @var{name} values include:
1811 @itemize @minus
1812 @item @b{axm0432_jtag} Axiom AXM-0432
1813 @item @b{comstick} Hitex STR9 comstick
1814 @item @b{cortino} Hitex Cortino JTAG interface
1815 @item @b{evb_lm3s811} Luminary Micro EVB_LM3S811 as a JTAG interface,
1816 either for the local Cortex-M3 (SRST only)
1817 or in a passthrough mode (neither SRST nor TRST)
1818 @item @b{flyswatter} Tin Can Tools Flyswatter
1819 @item @b{icebear} ICEbear JTAG adapter from Section 5
1820 @item @b{jtagkey} Amontec JTAGkey and JTAGkey-Tiny (and compatibles)
1821 @item @b{m5960} American Microsystems M5960
1822 @item @b{olimex-jtag} Olimex ARM-USB-OCD and ARM-USB-Tiny
1823 @item @b{oocdlink} OOCDLink
1824 @c oocdlink ~= jtagkey_prototype_v1
1825 @item @b{sheevaplug} Marvell Sheevaplug development kit
1826 @item @b{signalyzer} Xverve Signalyzer
1827 @item @b{stm32stick} Hitex STM32 Performance Stick
1828 @item @b{turtelizer2} egnite Software turtelizer2
1829 @item @b{usbjtag} "USBJTAG-1" layout described in the OpenOCD diploma thesis
1830 @end itemize
1831 @end deffn
1832
1833 @deffn {Config Command} {ft2232_vid_pid} [vid pid]+
1834 The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
1835 default values are used.
1836 Currently, up to eight [@var{vid}, @var{pid}] pairs may be given, e.g.
1837 @example
1838 ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
1839 @end example
1840 @end deffn
1841
1842 @deffn {Config Command} {ft2232_latency} ms
1843 On some systems using FT2232 based JTAG interfaces the FT_Read function call in
1844 ft2232_read() fails to return the expected number of bytes. This can be caused by
1845 USB communication delays and has proved hard to reproduce and debug. Setting the
1846 FT2232 latency timer to a larger value increases delays for short USB packets but it
1847 also reduces the risk of timeouts before receiving the expected number of bytes.
1848 The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
1849 @end deffn
1850
1851 For example, the interface config file for a
1852 Turtelizer JTAG Adapter looks something like this:
1853
1854 @example
1855 interface ft2232
1856 ft2232_device_desc "Turtelizer JTAG/RS232 Adapter"
1857 ft2232_layout turtelizer2
1858 ft2232_vid_pid 0x0403 0xbdc8
1859 @end example
1860 @end deffn
1861
1862 @deffn {Interface Driver} {gw16012}
1863 Gateworks GW16012 JTAG programmer.
1864 This has one driver-specific command:
1865
1866 @deffn {Config Command} {parport_port} number
1867 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
1868 the number of the @file{/dev/parport} device.
1869 @end deffn
1870 @end deffn
1871
1872 @deffn {Interface Driver} {jlink}
1873 Segger jlink USB adapter
1874 @c command:     jlink_info
1875 @c     dumps status
1876 @c command:     jlink_hw_jtag (2|3)
1877 @c     sets version 2 or 3
1878 @end deffn
1879
1880 @deffn {Interface Driver} {parport}
1881 Supports PC parallel port bit-banging cables:
1882 Wigglers, PLD download cable, and more.
1883 These interfaces have several commands, used to configure the driver
1884 before initializing the JTAG scan chain:
1885
1886 @deffn {Config Command} {parport_cable} name
1887 The layout of the parallel port cable used to connect to the target.
1888 Currently valid cable @var{name} values include:
1889
1890 @itemize @minus
1891 @item @b{altium} Altium Universal JTAG cable.
1892 @item @b{arm-jtag} Same as original wiggler except SRST and
1893 TRST connections reversed and TRST is also inverted.
1894 @item @b{chameleon} The Amontec Chameleon's CPLD when operated
1895 in configuration mode. This is only used to
1896 program the Chameleon itself, not a connected target.
1897 @item @b{dlc5} The Xilinx Parallel cable III.
1898 @item @b{flashlink} The ST Parallel cable.
1899 @item @b{lattice} Lattice ispDOWNLOAD Cable
1900 @item @b{old_amt_wiggler} The Wiggler configuration that comes with
1901 some versions of
1902 Amontec's Chameleon Programmer. The new version available from
1903 the website uses the original Wiggler layout ('@var{wiggler}')
1904 @item @b{triton} The parallel port adapter found on the
1905 ``Karo Triton 1 Development Board''.
1906 This is also the layout used by the HollyGates design
1907 (see @uref{http://www.lartmaker.nl/projects/jtag/}).
1908 @item @b{wiggler} The original Wiggler layout, also supported by
1909 several clones, such as the Olimex ARM-JTAG
1910 @item @b{wiggler2} Same as original wiggler except an led is fitted on D5.
1911 @item @b{wiggler_ntrst_inverted} Same as original wiggler except TRST is inverted.
1912 @end itemize
1913 @end deffn
1914
1915 @deffn {Config Command} {parport_port} number
1916 Either the address of the I/O port (default: 0x378 for LPT1) or the number of
1917 the @file{/dev/parport} device
1918
1919 When using PPDEV to access the parallel port, use the number of the parallel port:
1920 @option{parport_port 0} (the default). If @option{parport_port 0x378} is specified
1921 you may encounter a problem.
1922 @end deffn
1923
1924 @deffn {Config Command} {parport_write_on_exit} (on|off)
1925 This will configure the parallel driver to write a known
1926 cable-specific value to the parallel interface on exiting OpenOCD
1927 @end deffn
1928
1929 For example, the interface configuration file for a
1930 classic ``Wiggler'' cable might look something like this:
1931
1932 @example
1933 interface parport
1934 parport_port 0xc8b8
1935 parport_cable wiggler
1936 @end example
1937 @end deffn
1938
1939 @deffn {Interface Driver} {presto}
1940 ASIX PRESTO USB JTAG programmer.
1941 @c command:     presto_serial str
1942 @c     sets serial number
1943 @end deffn
1944
1945 @deffn {Interface Driver} {rlink}
1946 Raisonance RLink USB adapter
1947 @end deffn
1948
1949 @deffn {Interface Driver} {usbprog}
1950 usbprog is a freely programmable USB adapter.
1951 @end deffn
1952
1953 @deffn {Interface Driver} {vsllink}
1954 vsllink is part of Versaloon which is a versatile USB programmer.
1955
1956 @quotation Note
1957 This defines quite a few driver-specific commands,
1958 which are not currently documented here.
1959 @end quotation
1960 @end deffn
1961
1962 @deffn {Interface Driver} {ZY1000}
1963 This is the Zylin ZY1000 JTAG debugger.
1964
1965 @quotation Note
1966 This defines some driver-specific commands,
1967 which are not currently documented here.
1968 @end quotation
1969
1970 @deffn Command power [@option{on}|@option{off}]
1971 Turn power switch to target on/off.
1972 No arguments: print status.
1973 @end deffn
1974
1975 @end deffn
1976
1977 @anchor{JTAG Speed}
1978 @section JTAG Speed
1979 JTAG clock setup is part of system setup.
1980 It @emph{does not belong with interface setup} since any interface
1981 only knows a few of the constraints for the JTAG clock speed.
1982 Sometimes the JTAG speed is
1983 changed during the target initialization process: (1) slow at
1984 reset, (2) program the CPU clocks, (3) run fast.
1985 Both the "slow" and "fast" clock rates are functions of the
1986 oscillators used, the chip, the board design, and sometimes
1987 power management software that may be active.
1988
1989 The speed used during reset can be adjusted using pre_reset
1990 and post_reset event handlers.
1991 @xref{Target Events}.
1992
1993 If your system supports adaptive clocking (RTCK), configuring
1994 JTAG to use that is probably the most robust approach.
1995 However, it introduces delays to synchronize clocks; so it
1996 may not be the fastest solution.
1997
1998 @b{NOTE:} Script writers should consider using @command{jtag_rclk}
1999 instead of @command{jtag_khz}.
2000
2001 @deffn {Command} jtag_khz max_speed_kHz
2002 A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
2003 JTAG interfaces usually support a limited number of
2004 speeds.  The speed actually used won't be faster
2005 than the speed specified.
2006
2007 As a rule of thumb, if you specify a clock rate make
2008 sure the JTAG clock is no more than @math{1/6th CPU-Clock}.
2009 This is especially true for synthesized cores (ARMxxx-S).
2010
2011 Speed 0 (khz) selects RTCK method.
2012 @xref{FAQ RTCK}.
2013 If your system uses RTCK, you won't need to change the
2014 JTAG clocking after setup.
2015 Not all interfaces, boards, or targets support ``rtck''.
2016 If the interface device can not
2017 support it, an error is returned when you try to use RTCK.
2018 @end deffn
2019
2020 @defun jtag_rclk fallback_speed_kHz
2021 @cindex RTCK
2022 This Tcl proc (defined in startup.tcl) attempts to enable RTCK/RCLK.
2023 If that fails (maybe the interface, board, or target doesn't
2024 support it), falls back to the specified frequency.
2025 @example
2026 # Fall back to 3mhz if RTCK is not supported
2027 jtag_rclk 3000
2028 @end example
2029 @end defun
2030
2031 @node Reset Configuration
2032 @chapter Reset Configuration
2033 @cindex Reset Configuration
2034
2035 Every system configuration may require a different reset
2036 configuration. This can also be quite confusing.
2037 Resets also interact with @var{reset-init} event handlers,
2038 which do things like setting up clocks and DRAM, and
2039 JTAG clock rates.  (@xref{JTAG Speed}.)
2040 They can also interact with JTAG routers.
2041 Please see the various board files for examples.
2042
2043 @quotation Note
2044 To maintainers and integrators:
2045 Reset configuration touches several things at once.
2046 Normally the board configuration file
2047 should define it and assume that the JTAG adapter supports
2048 everything that's wired up to the board's JTAG connector.
2049
2050 However, the target configuration file could also make note
2051 of something the silicon vendor has done inside the chip,
2052 which will be true for most (or all) boards using that chip.
2053 And when the JTAG adapter doesn't support everything, the
2054 user configuration file will need to override parts of
2055 the reset configuration provided by other files.
2056 @end quotation
2057
2058 @section Types of Reset
2059
2060 There are many kinds of reset possible through JTAG, but
2061 they may not all work with a given board and adapter.
2062 That's part of why reset configuration can be error prone.
2063
2064 @itemize @bullet
2065 @item
2066 @emph{System Reset} ... the @emph{SRST} hardware signal
2067 resets all chips connected to the JTAG adapter, such as processors,
2068 power management chips, and I/O controllers.  Normally resets triggered
2069 with this signal behave exactly like pressing a RESET button.
2070 @item
2071 @emph{JTAG TAP Reset} ... the @emph{TRST} hardware signal resets
2072 just the TAP controllers connected to the JTAG adapter.
2073 Such resets should not be visible to the rest of the system; resetting a
2074 device's the TAP controller just puts that controller into a known state.
2075 @item
2076 @emph{Emulation Reset} ... many devices can be reset through JTAG
2077 commands.  These resets are often distinguishable from system
2078 resets, either explicitly (a "reset reason" register says so)
2079 or implicitly (not all parts of the chip get reset).
2080 @item
2081 @emph{Other Resets} ... system-on-chip devices often support
2082 several other types of reset.
2083 You may need to arrange that a watchdog timer stops
2084 while debugging, preventing a watchdog reset.
2085 There may be individual module resets.
2086 @end itemize
2087
2088 In the best case, OpenOCD can hold SRST, then reset
2089 the TAPs via TRST and send commands through JTAG to halt the
2090 CPU at the reset vector before the 1st instruction is executed.
2091 Then when it finally releases the SRST signal, the system is
2092 halted under debugger control before any code has executed.
2093 This is the behavior required to support the @command{reset halt}
2094 and @command{reset init} commands; after @command{reset init} a
2095 board-specific script might do things like setting up DRAM.
2096 (@xref{Reset Command}.)
2097
2098 @anchor{SRST and TRST Issues}
2099 @section SRST and TRST Issues
2100
2101 Because SRST and TRST are hardware signals, they can have a
2102 variety of system-specific constraints.  Some of the most
2103 common issues are:
2104
2105 @itemize @bullet
2106
2107 @item @emph{Signal not available} ... Some boards don't wire
2108 SRST or TRST to the JTAG connector.  Some JTAG adapters don't
2109 support such signals even if they are wired up.
2110 Use the @command{reset_config} @var{signals} options to say
2111 when either of those signals is not connected.
2112 When SRST is not available, your code might not be able to rely
2113 on controllers having been fully reset during code startup.
2114 Missing TRST is not a problem, since JTAG level resets can
2115 be triggered using with TMS signaling.
2116
2117 @item @emph{Signals shorted} ... Sometimes a chip, board, or
2118 adapter will connect SRST to TRST, instead of keeping them separate.
2119 Use the @command{reset_config} @var{combination} options to say
2120 when those signals aren't properly independent.
2121
2122 @item @emph{Timing} ... Reset circuitry like a resistor/capacitor
2123 delay circuit, reset supervisor, or on-chip features can extend
2124 the effect of a JTAG adapter's reset for some time after the adapter
2125 stops issuing the reset.  For example, there may be chip or board
2126 requirements that all reset pulses last for at least a
2127 certain amount of time; and reset buttons commonly have
2128 hardware debouncing.
2129 Use the @command{jtag_nsrst_delay} and @command{jtag_ntrst_delay}
2130 commands to say when extra delays are needed.
2131
2132 @item @emph{Drive type} ... Reset lines often have a pullup
2133 resistor, letting the JTAG interface treat them as open-drain
2134 signals.  But that's not a requirement, so the adapter may need
2135 to use push/pull output drivers.
2136 Also, with weak pullups it may be advisable to drive
2137 signals to both levels (push/pull) to minimize rise times.
2138 Use the @command{reset_config} @var{trst_type} and
2139 @var{srst_type} parameters to say how to drive reset signals.
2140
2141 @item @emph{Special initialization} ...  Targets sometimes need
2142 special JTAG initialization sequences to handle chip-specific
2143 issues (not limited to errata).
2144 For example, certain JTAG commands might need to be issued while
2145 the system as a whole is in a reset state (SRST active)
2146 but the JTAG scan chain is usable (TRST inactive).
2147 (@xref{JTAG Commands}, where the @command{jtag_reset}
2148 command is presented.)
2149 @end itemize
2150
2151 There can also be other issues.
2152 Some devices don't fully conform to the JTAG specifications.
2153 Trivial system-specific differences are common, such as
2154 SRST and TRST using slightly different names.
2155 There are also vendors who distribute key JTAG documentation for
2156 their chips only to developers who have signed a Non-Disclosure
2157 Agreement (NDA).
2158
2159 Sometimes there are chip-specific extensions like a requirement to use
2160 the normally-optional TRST signal (precluding use of JTAG adapters which
2161 don't pass TRST through), or needing extra steps to complete a TAP reset.
2162
2163 In short, SRST and especially TRST handling may be very finicky,
2164 needing to cope with both architecture and board specific constraints.
2165
2166 @section Commands for Handling Resets
2167
2168 @deffn {Command} jtag_nsrst_delay milliseconds
2169 How long (in milliseconds) OpenOCD should wait after deasserting
2170 nSRST (active-low system reset) before starting new JTAG operations.
2171 When a board has a reset button connected to SRST line it will
2172 probably have hardware debouncing, implying you should use this.
2173 @end deffn
2174
2175 @deffn {Command} jtag_ntrst_delay milliseconds
2176 How long (in milliseconds) OpenOCD should wait after deasserting
2177 nTRST (active-low JTAG TAP reset) before starting new JTAG operations.
2178 @end deffn
2179
2180 @deffn {Command} reset_config mode_flag ...
2181 This command tells OpenOCD the reset configuration
2182 of your combination of JTAG board and target in target
2183 configuration scripts.
2184
2185 Information earlier in this section describes the kind of problems
2186 the command is intended to address (@pxref{SRST and TRST Issues}).
2187 As a rule this command belongs only in board config files,
2188 describing issues like @emph{board doesn't connect TRST};
2189 or in user config files, addressing limitations derived
2190 from a particular combination of interface and board.
2191 (An unlikely example would be using a TRST-only adapter
2192 with a board that only wires up SRST.)
2193
2194 The @var{mode_flag} options can be specified in any order, but only one
2195 of each type -- @var{signals}, @var{combination}, @var{trst_type},
2196 and @var{srst_type} -- may be specified at a time.
2197 If you don't provide a new value for a given type, its previous
2198 value (perhaps the default) is unchanged.
2199 For example, this means that you don't need to say anything at all about
2200 TRST just to declare that if the JTAG adapter should want to drive SRST,
2201 it must explicitly be driven high (@option{srst_push_pull}).
2202
2203 @var{signals} can specify which of the reset signals are connected.
2204 For example, If the JTAG interface provides SRST, but the board doesn't
2205 connect that signal properly, then OpenOCD can't use it.
2206 Possible values are @option{none} (the default), @option{trst_only},
2207 @option{srst_only} and @option{trst_and_srst}.
2208
2209 @quotation Tip
2210 If your board provides SRST or TRST through the JTAG connector,
2211 you must declare that or else those signals will not be used.
2212 @end quotation
2213
2214 The @var{combination} is an optional value specifying broken reset
2215 signal implementations.
2216 The default behaviour if no option given is @option{separate},
2217 indicating everything behaves normally.
2218 @option{srst_pulls_trst} states that the
2219 test logic is reset together with the reset of the system (e.g. Philips
2220 LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
2221 the system is reset together with the test logic (only hypothetical, I
2222 haven't seen hardware with such a bug, and can be worked around).
2223 @option{combined} implies both @option{srst_pulls_trst} and
2224 @option{trst_pulls_srst}.
2225
2226 The optional @var{trst_type} and @var{srst_type} parameters allow the
2227 driver mode of each reset line to be specified.  These values only affect
2228 JTAG interfaces with support for different driver modes, like the Amontec
2229 JTAGkey and JTAGAccelerator.  Also, they are necessarily ignored if the
2230 relevant signal (TRST or SRST) is not connected.
2231
2232 Possible @var{trst_type} driver modes for the test reset signal (TRST)
2233 are @option{trst_push_pull} (default) and @option{trst_open_drain}.
2234 Most boards connect this signal to a pulldown, so the JTAG TAPs
2235 never leave reset unless they are hooked up to a JTAG adapter.
2236
2237 Possible @var{srst_type} driver modes for the system reset signal (SRST)
2238 are the default @option{srst_open_drain}, and @option{srst_push_pull}.
2239 Most boards connect this signal to a pullup, and allow the
2240 signal to be pulled low by various events including system
2241 powerup and pressing a reset button.
2242 @end deffn
2243
2244
2245 @node TAP Declaration
2246 @chapter TAP Declaration
2247 @cindex TAP declaration
2248 @cindex TAP configuration
2249
2250 @emph{Test Access Ports} (TAPs) are the core of JTAG.
2251 TAPs serve many roles, including:
2252
2253 @itemize @bullet
2254 @item @b{Debug Target} A CPU TAP can be used as a GDB debug target
2255 @item @b{Flash Programing} Some chips program the flash directly via JTAG.
2256 Others do it indirectly, making a CPU do it.
2257 @item @b{Program Download} Using the same CPU support GDB uses,
2258 you can initialize a DRAM controller, download code to DRAM, and then
2259 start running that code.
2260 @item @b{Boundary Scan} Most chips support boundary scan, which
2261 helps test for board assembly problems like solder bridges
2262 and missing connections
2263 @end itemize
2264
2265 OpenOCD must know about the active TAPs on your board(s).
2266 Setting up the TAPs is the core task of your configuration files.
2267 Once those TAPs are set up, you can pass their names to code
2268 which sets up CPUs and exports them as GDB targets,
2269 probes flash memory, performs low-level JTAG operations, and more.
2270
2271 @section Scan Chains
2272 @cindex scan chain
2273
2274 TAPs are part of a hardware @dfn{scan chain},
2275 which is daisy chain of TAPs.
2276 They also need to be added to
2277 OpenOCD's software mirror of that hardware list,
2278 giving each member a name and associating other data with it.
2279 Simple scan chains, with a single TAP, are common in
2280 systems with a single microcontroller or microprocessor.
2281 More complex chips may have several TAPs internally.
2282 Very complex scan chains might have a dozen or more TAPs:
2283 several in one chip, more in the next, and connecting
2284 to other boards with their own chips and TAPs.
2285
2286 You can display the list with the @command{scan_chain} command.
2287 (Don't confuse this with the list displayed by the @command{targets}
2288 command, presented in the next chapter.
2289 That only displays TAPs for CPUs which are configured as
2290 debugging targets.)
2291 Here's what the scan chain might look like for a chip more than one TAP:
2292
2293 @verbatim
2294    TapName            Enabled IdCode     Expected   IrLen IrCap IrMask Instr
2295 -- ------------------ ------- ---------- ---------- ----- ----- ------ -----
2296  0 omap5912.dsp          Y    0x03df1d81 0x03df1d81 38    0     0      0x...
2297  1 omap5912.arm          Y    0x0692602f 0x0692602f 4     0x1   0      0xc
2298  2 omap5912.unknown      Y    0x00000000 0x00000000 8     0     0      0xff
2299 @end verbatim
2300
2301 Unfortunately those TAPs can't always be autoconfigured,
2302 because not all devices provide good support for that.
2303 JTAG doesn't require supporting IDCODE instructions, and
2304 chips with JTAG routers may not link TAPs into the chain
2305 until they are told to do so.
2306
2307 The configuration mechanism currently supported by OpenOCD
2308 requires explicit configuration of all TAP devices using
2309 @command{jtag newtap} commands, as detailed later in this chapter.
2310 A command like this would declare one tap and name it @code{chip1.cpu}:
2311
2312 @example
2313 jtag newtap chip1 cpu -irlen 7 -ircapture 0x01 -irmask 0x55
2314 @end example
2315
2316 Each target configuration file lists the TAPs provided
2317 by a given chip.
2318 Board configuration files combine all the targets on a board,
2319 and so forth.
2320 Note that @emph{the order in which TAPs are declared is very important.}
2321 It must match the order in the JTAG scan chain, both inside
2322 a single chip and between them.
2323 @xref{FAQ TAP Order}.
2324
2325 For example, the ST Microsystems STR912 chip has
2326 three separate TAPs@footnote{See the ST
2327 document titled: @emph{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
2328 28/102, Figure 3: JTAG chaining inside the STR91xFA}.
2329 @url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}}.
2330 To configure those taps, @file{target/str912.cfg}
2331 includes commands something like this:
2332
2333 @example
2334 jtag newtap str912 flash ... params ...
2335 jtag newtap str912 cpu ... params ...
2336 jtag newtap str912 bs ... params ...
2337 @end example
2338
2339 Actual config files use a variable instead of literals like
2340 @option{str912}, to support more than one chip of each type.
2341 @xref{Config File Guidelines}.
2342
2343 At this writing there is only a single command to work with
2344 scan chains, and there is no support for enumerating
2345 TAPs or examining their attributes.
2346
2347 @deffn Command {scan_chain}
2348 Displays the TAPs in the scan chain configuration,
2349 and their status.
2350 The set of TAPs listed by this command is fixed by
2351 exiting the OpenOCD configuration stage,
2352 but systems with a JTAG router can
2353 enable or disable TAPs dynamically.
2354 In addition to the enable/disable status, the contents of
2355 each TAP's instruction register can also change.
2356 @end deffn
2357
2358 @c FIXME!  there should be commands to enumerate TAPs
2359 @c and get their attributes, like there are for targets.
2360 @c "jtag cget ..." will handle attributes.
2361 @c "jtag names" for enumerating TAPs, maybe.
2362
2363 @c Probably want "jtag eventlist", and a "tap-reset" event
2364 @c (on entry to RESET state).
2365
2366 @section TAP Names
2367 @cindex dotted name
2368
2369 When TAP objects are declared with @command{jtag newtap},
2370 a @dfn{dotted.name} is created for the TAP, combining the
2371 name of a module (usually a chip) and a label for the TAP.
2372 For example: @code{xilinx.tap}, @code{str912.flash},
2373 @code{omap3530.jrc}, @code{dm6446.dsp}, or @code{stm32.cpu}.
2374 Many other commands use that dotted.name to manipulate or
2375 refer to the TAP.  For example, CPU configuration uses the
2376 name, as does declaration of NAND or NOR flash banks.
2377
2378 The components of a dotted name should follow ``C'' symbol
2379 name rules:  start with an alphabetic character, then numbers
2380 and underscores are OK; while others (including dots!) are not.
2381
2382 @quotation Tip
2383 In older code, JTAG TAPs were numbered from 0..N.
2384 This feature is still present.
2385 However its use is highly discouraged, and
2386 should not be counted upon.
2387 Update all of your scripts to use TAP names rather than numbers.
2388 Using TAP numbers in target configuration scripts prevents
2389 reusing those scripts on boards with multiple targets.
2390 @end quotation
2391
2392 @section TAP Declaration Commands
2393
2394 @c shouldn't this be(come) a {Config Command}?
2395 @anchor{jtag newtap}
2396 @deffn Command {jtag newtap} chipname tapname configparams...
2397 Declares a new TAP with the dotted name @var{chipname}.@var{tapname},
2398 and configured according to the various @var{configparams}.
2399
2400 The @var{chipname} is a symbolic name for the chip.
2401 Conventionally target config files use @code{$_CHIPNAME},
2402 defaulting to the model name given by the chip vendor but
2403 overridable.
2404
2405 @cindex TAP naming convention
2406 The @var{tapname} reflects the role of that TAP,
2407 and should follow this convention:
2408
2409 @itemize @bullet
2410 @item @code{bs} -- For boundary scan if this is a seperate TAP;
2411 @item @code{cpu} -- The main CPU of the chip, alternatively
2412 @code{arm} and @code{dsp} on chips with both ARM and DSP CPUs,
2413 @code{arm1} and @code{arm2} on chips two ARMs, and so forth;
2414 @item @code{etb} -- For an embedded trace buffer (example: an ARM ETB11);
2415 @item @code{flash} -- If the chip has a flash TAP, like the str912;
2416 @item @code{jrc} -- For JTAG route controller (example: the ICEpick modules
2417 on many Texas Instruments chips, like the OMAP3530 on Beagleboards);
2418 @item @code{tap} -- Should be used only FPGA or CPLD like devices
2419 with a single TAP;
2420 @item @code{unknownN} -- If you have no idea what the TAP is for (N is a number);
2421 @item @emph{when in doubt} -- Use the chip maker's name in their data sheet.
2422 For example, the Freescale IMX31 has a SDMA (Smart DMA) with
2423 a JTAG TAP; that TAP should be named @code{sdma}.
2424 @end itemize
2425
2426 Every TAP requires at least the following @var{configparams}:
2427
2428 @itemize @bullet
2429 @item @code{-ircapture} @var{NUMBER}
2430 @*The IDCODE capture command, such as 0x01.
2431 @item @code{-irlen} @var{NUMBER}
2432 @*The length in bits of the
2433 instruction register, such as 4 or 5 bits.
2434 @item @code{-irmask} @var{NUMBER}
2435 @*A mask for the IR register.
2436 For some devices, there are bits in the IR that aren't used.
2437 This lets OpenOCD mask them off when doing IDCODE comparisons.
2438 In general, this should just be all ones for the size of the IR.
2439 @end itemize
2440
2441 A TAP may also provide optional @var{configparams}:
2442
2443 @itemize @bullet
2444 @item @code{-disable} (or @code{-enable})
2445 @*Use the @code{-disable} parameter to flag a TAP which is not
2446 linked in to the scan chain after a reset using either TRST
2447 or the JTAG state machine's @sc{reset} state.
2448 You may use @code{-enable} to highlight the default state
2449 (the TAP is linked in).
2450 @xref{Enabling and Disabling TAPs}.
2451 @item @code{-expected-id} @var{number}
2452 @*A non-zero value represents the expected 32-bit IDCODE
2453 found when the JTAG chain is examined.
2454 These codes are not required by all JTAG devices.
2455 @emph{Repeat the option} as many times as required if more than one
2456 ID code could appear (for example, multiple versions).
2457 @end itemize
2458 @end deffn
2459
2460 @c @deffn Command {jtag arp_init-reset}
2461 @c ... more or less "init" ?
2462
2463 @anchor{Enabling and Disabling TAPs}
2464 @section Enabling and Disabling TAPs
2465 @cindex TAP events
2466 @cindex JTAG Route Controller
2467 @cindex jrc
2468
2469 In some systems, a @dfn{JTAG Route Controller} (JRC)
2470 is used to enable and/or disable specific JTAG TAPs.
2471 Many ARM based chips from Texas Instruments include
2472 an ``ICEpick'' module, which is a JRC.
2473 Such chips include DaVinci and OMAP3 processors.
2474
2475 A given TAP may not be visible until the JRC has been
2476 told to link it into the scan chain; and if the JRC
2477 has been told to unlink that TAP, it will no longer
2478 be visible.
2479 Such routers address problems that JTAG ``bypass mode''
2480 ignores, such as:
2481
2482 @itemize
2483 @item The scan chain can only go as fast as its slowest TAP.
2484 @item Having many TAPs slows instruction scans, since all
2485 TAPs receive new instructions.
2486 @item TAPs in the scan chain must be powered up, which wastes
2487 power and prevents debugging some power management mechanisms.
2488 @end itemize
2489
2490 The IEEE 1149.1 JTAG standard has no concept of a ``disabled'' tap,
2491 as implied by the existence of JTAG routers.
2492 However, the upcoming IEEE 1149.7 framework (layered on top of JTAG)
2493 does include a kind of JTAG router functionality.
2494
2495 @c (a) currently the event handlers don't seem to be able to
2496 @c     fail in a way that could lead to no-change-of-state.
2497 @c (b) eventually non-event configuration should be possible,
2498 @c     in which case some this documentation must move.
2499
2500 @deffn Command {jtag cget} dotted.name @option{-event} name
2501 @deffnx Command {jtag configure} dotted.name @option{-event} name string
2502 At this writing this mechanism is used only for event handling,
2503 and the only two events relate to TAP enabling and disabling.
2504
2505 The @code{configure} subcommand assigns an event handler,
2506 a TCL string which is evaluated when the event is triggered.
2507 The @code{cget} subcommand returns that handler.
2508 The two possible values for an event @var{name}
2509 are @option{tap-disable} and @option{tap-enable}.
2510
2511 So for example, when defining a TAP for a CPU connected to
2512 a JTAG router, you should define TAP event handlers using
2513 code that looks something like this:
2514
2515 @example
2516 jtag configure CHIP.cpu -event tap-enable @{
2517   echo "Enabling CPU TAP"
2518   ... jtag operations using CHIP.jrc
2519 @}
2520 jtag configure CHIP.cpu -event tap-disable @{
2521   echo "Disabling CPU TAP"
2522   ... jtag operations using CHIP.jrc
2523 @}
2524 @end example
2525 @end deffn
2526
2527 @deffn Command {jtag tapdisable} dotted.name
2528 @deffnx Command {jtag tapenable} dotted.name
2529 @deffnx Command {jtag tapisenabled} dotted.name
2530 These three commands all return the string "1" if the tap
2531 specified by @var{dotted.name} is enabled,
2532 and "0" if it is disbabled.
2533 The @command{tapenable} variant first enables the tap
2534 by sending it a @option{tap-enable} event.
2535 The @command{tapdisable} variant first disables the tap
2536 by sending it a @option{tap-disable} event.
2537
2538 @quotation Note
2539 Humans will find the @command{scan_chain} command more helpful
2540 than the script-oriented @command{tapisenabled}
2541 for querying the state of the JTAG taps.
2542 @end quotation
2543 @end deffn
2544
2545 @node CPU Configuration
2546 @chapter CPU Configuration
2547 @cindex GDB target
2548
2549 This chapter discusses how to set up GDB debug targets for CPUs.
2550 You can also access these targets without GDB
2551 (@pxref{Architecture and Core Commands},
2552 and @ref{Target State handling}) and
2553 through various kinds of NAND and NOR flash commands.
2554 If you have multiple CPUs you can have multiple such targets.
2555
2556 We'll start by looking at how to examine the targets you have,
2557 then look at how to add one more target and how to configure it.
2558
2559 @section Target List
2560 @cindex target, current
2561 @cindex target, list
2562
2563 All targets that have been set up are part of a list,
2564 where each member has a name.
2565 That name should normally be the same as the TAP name.
2566 You can display the list with the @command{targets}
2567 (plural!) command.
2568 This display often has only one CPU; here's what it might
2569 look like with more than one:
2570 @verbatim
2571     TargetName         Type       Endian TapName            State
2572 --  ------------------ ---------- ------ ------------------ ------------
2573  0* at91rm9200.cpu     arm920t    little at91rm9200.cpu     running
2574  1  MyTarget           cortex_m3  little mychip.foo         tap-disabled
2575 @end verbatim
2576
2577 One member of that list is the @dfn{current target}, which
2578 is implicitly referenced by many commands.
2579 It's the one marked with a @code{*} near the target name.
2580 In particular, memory addresses often refer to the address
2581 space seen by that current target.
2582 Commands like @command{mdw} (memory display words)
2583 and @command{flash erase_address} (erase NOR flash blocks)
2584 are examples; and there are many more.
2585
2586 Several commands let you examine the list of targets:
2587
2588 @deffn Command {target count}
2589 Returns the number of targets, @math{N}.
2590 The highest numbered target is @math{N - 1}.
2591 @example
2592 set c [target count]
2593 for @{ set x 0 @} @{ $x < $c @} @{ incr x @} @{
2594     # Assuming you have created this function
2595     print_target_details $x
2596 @}
2597 @end example
2598 @end deffn
2599
2600 @deffn Command {target current}
2601 Returns the name of the current target.
2602 @end deffn
2603
2604 @deffn Command {target names}
2605 Lists the names of all current targets in the list.
2606 @example
2607 foreach t [target names] @{
2608     puts [format "Target: %s\n" $t]
2609 @}
2610 @end example
2611 @end deffn
2612
2613 @deffn Command {target number} number
2614 The list of targets is numbered starting at zero.
2615 This command returns the name of the target at index @var{number}.
2616 @example
2617 set thename [target number $x]
2618 puts [format "Target %d is: %s\n" $x $thename]
2619 @end example
2620 @end deffn
2621
2622 @c yep, "target list" would have been better.
2623 @c plus maybe "target setdefault".
2624
2625 @deffn Command targets [name]
2626 @emph{Note: the name of this command is plural.  Other target
2627 command names are singular.}
2628
2629 With no parameter, this command displays a table of all known
2630 targets in a user friendly form.
2631
2632 With a parameter, this command sets the current target to
2633 the given target with the given @var{name}; this is
2634 only relevant on boards which have more than one target.
2635 @end deffn
2636
2637 @section Target CPU Types and Variants
2638 @cindex target type
2639 @cindex CPU type
2640 @cindex CPU variant
2641
2642 Each target has a @dfn{CPU type}, as shown in the output of
2643 the @command{targets} command.  You need to specify that type
2644 when calling @command{target create}.
2645 The CPU type indicates more than just the instruction set.
2646 It also indicates how that instruction set is implemented,
2647 what kind of debug support it integrates,
2648 whether it has an MMU (and if so, what kind),
2649 what core-specific commands may be available
2650 (@pxref{Architecture and Core Commands}),
2651 and more.
2652
2653 For some CPU types, OpenOCD also defines @dfn{variants} which
2654 indicate differences that affect their handling.
2655 For example, a particular implementation bug might need to be
2656 worked around in some chip versions.
2657
2658 It's easy to see what target types are supported,
2659 since there's a command to list them.
2660 However, there is currently no way to list what target variants
2661 are supported (other than by reading the OpenOCD source code).
2662
2663 @anchor{target types}
2664 @deffn Command {target types}
2665 Lists all supported target types.
2666 At this writing, the supported CPU types and variants are:
2667
2668 @itemize @bullet
2669 @item @code{arm11} -- this is a generation of ARMv6 cores
2670 @item @code{arm720t} -- this is an ARMv4 core
2671 @item @code{arm7tdmi} -- this is an ARMv4 core
2672 @item @code{arm920t} -- this is an ARMv5 core
2673 @item @code{arm926ejs} -- this is an ARMv5 core
2674 @item @code{arm966e} -- this is an ARMv5 core
2675 @item @code{arm9tdmi} -- this is an ARMv4 core
2676 @item @code{avr} -- implements Atmel's 8-bit AVR instruction set.
2677 (Support for this is preliminary and incomplete.)
2678 @item @code{cortex_a8} -- this is an ARMv7 core
2679 @item @code{cortex_m3} -- this is an ARMv7 core, supporting only the
2680 compact Thumb2 instruction set.  It supports one variant:
2681 @itemize @minus
2682 @item @code{lm3s} ... Use this when debugging older Stellaris LM3S targets.
2683 This will cause OpenOCD to use a software reset rather than asserting
2684 SRST, to avoid a issue with clearing the debug registers.
2685 This is fixed in Fury Rev B, DustDevil Rev B, Tempest; these revisions will
2686 be detected and the normal reset behaviour used.
2687 @end itemize
2688 @item @code{fa526} -- resembles arm920 (w/o Thumb)
2689 @item @code{feroceon} -- resembles arm926
2690 @item @code{mips_m4k} -- a MIPS core.  This supports one variant:
2691 @itemize @minus
2692 @item @code{ejtag_srst} ... Use this when debugging targets that do not
2693 provide a functional SRST line on the EJTAG connector.  This causes
2694 OpenOCD to instead use an EJTAG software reset command to reset the
2695 processor.
2696 You still need to enable @option{srst} on the @command{reset_config}
2697 command to enable OpenOCD hardware reset functionality.
2698 @end itemize
2699 @item @code{xscale} -- this is actually an architecture,
2700 not a CPU type.  It is based on the ARMv5 architecture.
2701 There are several variants defined:
2702 @itemize @minus
2703 @item @code{ixp42x}, @code{ixp45x}, @code{ixp46x},
2704 @code{pxa27x} ... instruction register length is 7 bits
2705 @item @code{pxa250}, @code{pxa255},
2706 @code{pxa26x} ... instruction register length is 5 bits
2707 @end itemize
2708 @end itemize
2709 @end deffn
2710
2711 To avoid being confused by the variety of ARM based cores, remember
2712 this key point: @emph{ARM is a technology licencing company}.
2713 (See: @url{http://www.arm.com}.)
2714 The CPU name used by OpenOCD will reflect the CPU design that was
2715 licenced, not a vendor brand which incorporates that design.
2716 Name prefixes like arm7, arm9, arm11, and cortex
2717 reflect design generations;
2718 while names like ARMv4, ARMv5, ARMv6, and ARMv7
2719 reflect an architecture version implemented by a CPU design.
2720
2721 @anchor{Target Configuration}
2722 @section Target Configuration
2723
2724 Before creating a ``target'', you must have added its TAP to the scan chain.
2725 When you've added that TAP, you will have a @code{dotted.name}
2726 which is used to set up the CPU support.
2727 The chip-specific configuration file will normally configure its CPU(s)
2728 right after it adds all of the chip's TAPs to the scan chain.
2729
2730 Although you can set up a target in one step, it's often clearer if you
2731 use shorter commands and do it in two steps:  create it, then configure
2732 optional parts.
2733 All operations on the target after it's created will use a new
2734 command, created as part of target creation.
2735
2736 The two main things to configure after target creation are
2737 a work area, which usually has target-specific defaults even
2738 if the board setup code overrides them later;
2739 and event handlers (@pxref{Target Events}), which tend
2740 to be much more board-specific.
2741 The key steps you use might look something like this
2742
2743 @example
2744 target create MyTarget cortex_m3 -chain-position mychip.cpu
2745 $MyTarget configure -work-area-phys 0x08000 -work-area-size 8096
2746 $MyTarget configure -event reset-deassert-pre @{ jtag_rclk 5 @}
2747 $MyTarget configure -event reset-init @{ myboard_reinit @}
2748 @end example
2749
2750 You should specify a working area if you can; typically it uses some
2751 on-chip SRAM.
2752 Such a working area can speed up many things, including bulk
2753 writes to target memory;
2754 flash operations like checking to see if memory needs to be erased;
2755 GDB memory checksumming;
2756 and more.
2757
2758 @quotation Warning
2759 On more complex chips, the work area can become
2760 inaccessible when application code
2761 (such as an operating system)
2762 enables or disables the MMU.
2763 For example, the particular MMU context used to acess the virtual
2764 address will probably matter ... and that context might not have
2765 easy access to other addresses needed.
2766 At this writing, OpenOCD doesn't have much MMU intelligence.
2767 @end quotation
2768
2769 It's often very useful to define a @code{reset-init} event handler.
2770 For systems that are normally used with a boot loader,
2771 common tasks include updating clocks and initializing memory
2772 controllers.
2773 That may be needed to let you write the boot loader into flash,
2774 in order to ``de-brick'' your board; or to load programs into
2775 external DDR memory without having run the boot loader.
2776
2777 @deffn Command {target create} target_name type configparams...
2778 This command creates a GDB debug target that refers to a specific JTAG tap.
2779 It enters that target into a list, and creates a new
2780 command (@command{@var{target_name}}) which is used for various
2781 purposes including additional configuration.
2782
2783 @itemize @bullet
2784 @item @var{target_name} ...  is the name of the debug target.
2785 By convention this should be the same as the @emph{dotted.name}
2786 of the TAP associated with this target, which must be specified here
2787 using the @code{-chain-position @var{dotted.name}} configparam.
2788
2789 This name is also used to create the target object command,
2790 referred to here as @command{$target_name},
2791 and in other places the target needs to be identified.
2792 @item @var{type} ... specifies the target type.  @xref{target types}.
2793 @item @var{configparams} ...  all parameters accepted by
2794 @command{$target_name configure} are permitted.
2795 If the target is big-endian, set it here with @code{-endian big}.
2796 If the variant matters, set it here with @code{-variant}.
2797
2798 You @emph{must} set the @code{-chain-position @var{dotted.name}} here.
2799 @end itemize
2800 @end deffn
2801
2802 @deffn Command {$target_name configure} configparams...
2803 The options accepted by this command may also be
2804 specified as parameters to @command{target create}.
2805 Their values can later be queried one at a time by
2806 using the @command{$target_name cget} command.
2807
2808 @emph{Warning:} changing some of these after setup is dangerous.
2809 For example, moving a target from one TAP to another;
2810 and changing its endianness or variant.
2811
2812 @itemize @bullet
2813
2814 @item @code{-chain-position} @var{dotted.name} -- names the TAP
2815 used to access this target.
2816
2817 @item @code{-endian} (@option{big}|@option{little}) -- specifies
2818 whether the CPU uses big or little endian conventions
2819
2820 @item @code{-event} @var{event_name} @var{event_body} --
2821 @xref{Target Events}.
2822 Note that this updates a list of named event handlers.
2823 Calling this twice with two different event names assigns
2824 two different handlers, but calling it twice with the
2825 same event name assigns only one handler.
2826
2827 @item @code{-variant} @var{name} -- specifies a variant of the target,
2828 which OpenOCD needs to know about.
2829
2830 @item @code{-work-area-backup} (@option{0}|@option{1}) -- says
2831 whether the work area gets backed up; by default, it doesn't.
2832 When possible, use a working_area that doesn't need to be backed up,
2833 since performing a backup slows down operations.
2834
2835 @item @code{-work-area-size} @var{size} -- specify/set the work area
2836
2837 @item @code{-work-area-phys} @var{address} -- set the work area
2838 base @var{address} to be used when no MMU is active.
2839
2840 @item @code{-work-area-virt} @var{address} -- set the work area
2841 base @var{address} to be used when an MMU is active.
2842
2843 @end itemize
2844 @end deffn
2845
2846 @section Other $target_name Commands
2847 @cindex object command
2848
2849 The Tcl/Tk language has the concept of object commands,
2850 and OpenOCD adopts that same model for targets.
2851
2852 A good Tk example is a on screen button.
2853 Once a button is created a button
2854 has a name (a path in Tk terms) and that name is useable as a first
2855 class command. For example in Tk, one can create a button and later
2856 configure it like this:
2857
2858 @example
2859 # Create
2860 button .foobar -background red -command @{ foo @}
2861 # Modify
2862 .foobar configure -foreground blue
2863 # Query
2864 set x [.foobar cget -background]
2865 # Report
2866 puts [format "The button is %s" $x]
2867 @end example
2868
2869 In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
2870 button, and its object commands are invoked the same way.
2871
2872 @example
2873 str912.cpu    mww 0x1234 0x42
2874 omap3530.cpu  mww 0x5555 123
2875 @end example
2876
2877 The commands supported by OpenOCD target objects are:
2878
2879 @deffn Command {$target_name arp_examine}
2880 @deffnx Command {$target_name arp_halt}
2881 @deffnx Command {$target_name arp_poll}
2882 @deffnx Command {$target_name arp_reset}
2883 @deffnx Command {$target_name arp_waitstate}
2884 Internal OpenOCD scripts (most notably @file{startup.tcl})
2885 use these to deal with specific reset cases.
2886 They are not otherwise documented here.
2887 @end deffn
2888
2889 @deffn Command {$target_name array2mem} arrayname width address count
2890 @deffnx Command {$target_name mem2array} arrayname width address count
2891 These provide an efficient script-oriented interface to memory.
2892 The @code{array2mem} primitive writes bytes, halfwords, or words;
2893 while @code{mem2array} reads them.
2894 In both cases, the TCL side uses an array, and
2895 the target side uses raw memory.
2896
2897 The efficiency comes from enabling the use of
2898 bulk JTAG data transfer operations.
2899 The script orientation comes from working with data
2900 values that are packaged for use by TCL scripts;
2901 @command{mdw} type primitives only print data they retrieve,
2902 and neither store nor return those values.
2903
2904 @itemize
2905 @item @var{arrayname} ... is the name of an array variable
2906 @item @var{width} ... is 8/16/32 - indicating the memory access size
2907 @item @var{address} ... is the target memory address
2908 @item @var{count} ... is the number of elements to process
2909 @end itemize
2910 @end deffn
2911
2912 @deffn Command {$target_name cget} queryparm
2913 Each configuration parameter accepted by
2914 @command{$target_name configure}
2915 can be individually queried, to return its current value.
2916 The @var{queryparm} is a parameter name
2917 accepted by that command, such as @code{-work-area-phys}.
2918 There are a few special cases:
2919
2920 @itemize @bullet
2921 @item @code{-event} @var{event_name} -- returns the handler for the
2922 event named @var{event_name}.
2923 This is a special case because setting a handler requires
2924 two parameters.
2925 @item @code{-type} -- returns the target type.
2926 This is a special case because this is set using
2927 @command{target create} and can't be changed
2928 using @command{$target_name configure}.
2929 @end itemize
2930
2931 For example, if you wanted to summarize information about
2932 all the targets you might use something like this:
2933
2934 @example
2935 for @{ set x 0 @} @{ $x < [target count] @} @{ incr x @} @{
2936     set name [target number $x]
2937     set y [$name cget -endian]
2938     set z [$name cget -type]
2939     puts [format "Chip %d is %s, Endian: %s, type: %s" \
2940                  $x $name $y $z]
2941 @}
2942 @end example
2943 @end deffn
2944
2945 @anchor{target curstate}
2946 @deffn Command {$target_name curstate}
2947 Displays the current target state:
2948 @code{debug-running},
2949 @code{halted},
2950 @code{reset},
2951 @code{running}, or @code{unknown}.
2952 (Also, @pxref{Event Polling}.)
2953 @end deffn
2954
2955 @deffn Command {$target_name eventlist}
2956 Displays a table listing all event handlers
2957 currently associated with this target.
2958 @xref{Target Events}.
2959 @end deffn
2960
2961 @deffn Command {$target_name invoke-event} event_name
2962 Invokes the handler for the event named @var{event_name}.
2963 (This is primarily intended for use by OpenOCD framework
2964 code, for example by the reset code in @file{startup.tcl}.)
2965 @end deffn
2966
2967 @deffn Command {$target_name mdw} addr [count]
2968 @deffnx Command {$target_name mdh} addr [count]
2969 @deffnx Command {$target_name mdb} addr [count]
2970 Display contents of address @var{addr}, as
2971 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
2972 or 8-bit bytes (@command{mdb}).
2973 If @var{count} is specified, displays that many units.
2974 (If you want to manipulate the data instead of displaying it,
2975 see the @code{mem2array} primitives.)
2976 @end deffn
2977
2978 @deffn Command {$target_name mww} addr word
2979 @deffnx Command {$target_name mwh} addr halfword
2980 @deffnx Command {$target_name mwb} addr byte
2981 Writes the specified @var{word} (32 bits),
2982 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
2983 at the specified address @var{addr}.
2984 @end deffn
2985
2986 @anchor{Target Events}
2987 @section Target Events
2988 @cindex events
2989 At various times, certain things can happen, or you want them to happen.
2990 For example:
2991 @itemize @bullet
2992 @item What should happen when GDB connects? Should your target reset?
2993 @item When GDB tries to flash the target, do you need to enable the flash via a special command?
2994 @item During reset, do you need to write to certain memory locations
2995 to set up system clocks or
2996 to reconfigure the SDRAM?
2997 @end itemize
2998
2999 All of the above items can be addressed by target event handlers.
3000 These are set up by @command{$target_name configure -event} or
3001 @command{target create ... -event}.
3002
3003 The programmer's model matches the @code{-command} option used in Tcl/Tk
3004 buttons and events.  The two examples below act the same, but one creates
3005 and invokes a small procedure while the other inlines it.
3006
3007 @example
3008 proc my_attach_proc @{ @} @{
3009     echo "Reset..."
3010     reset halt
3011 @}
3012 mychip.cpu configure -event gdb-attach my_attach_proc
3013 mychip.cpu configure -event gdb-attach @{
3014     echo "Reset..."
3015     reset halt
3016 @}
3017 @end example
3018
3019 The following target events are defined:
3020
3021 @itemize @bullet
3022 @item @b{debug-halted}
3023 @* The target has halted for debug reasons (i.e.: breakpoint)
3024 @item @b{debug-resumed}
3025 @* The target has resumed (i.e.: gdb said run)
3026 @item @b{early-halted}
3027 @* Occurs early in the halt process
3028 @ignore
3029 @item @b{examine-end}
3030 @* Currently not used (goal: when JTAG examine completes)
3031 @item @b{examine-start}
3032 @* Currently not used (goal: when JTAG examine starts)
3033 @end ignore
3034 @item @b{gdb-attach}
3035 @* When GDB connects
3036 @item @b{gdb-detach}
3037 @* When GDB disconnects
3038 @item @b{gdb-end}
3039 @* When the target has halted and GDB is not doing anything (see early halt)
3040 @item @b{gdb-flash-erase-start}
3041 @* Before the GDB flash process tries to erase the flash
3042 @item @b{gdb-flash-erase-end}
3043 @* After the GDB flash process has finished erasing the flash
3044 @item @b{gdb-flash-write-start}
3045 @* Before GDB writes to the flash
3046 @item @b{gdb-flash-write-end}
3047 @* After GDB writes to the flash
3048 @item @b{gdb-start}
3049 @* Before the target steps, gdb is trying to start/resume the target
3050 @item @b{halted}
3051 @* The target has halted
3052 @ignore
3053 @item @b{old-gdb_program_config}
3054 @* DO NOT USE THIS: Used internally
3055 @item @b{old-pre_resume}
3056 @* DO NOT USE THIS: Used internally
3057 @end ignore
3058 @item @b{reset-assert-pre}
3059 @* Issued as part of @command{reset} processing
3060 after SRST and/or TRST were activated and deactivated,
3061 but before reset is asserted on the tap.
3062 @item @b{reset-assert-post}
3063 @* Issued as part of @command{reset} processing
3064 when reset is asserted on the tap.
3065 @item @b{reset-deassert-pre}
3066 @* Issued as part of @command{reset} processing
3067 when reset is about to be released on the tap.
3068
3069 For some chips, this may be a good place to make sure
3070 the JTAG clock is slow enough to work before the PLL
3071 has been set up to allow faster JTAG speeds.
3072 @item @b{reset-deassert-post}
3073 @* Issued as part of @command{reset} processing
3074 when reset has been released on the tap.
3075 @item @b{reset-end}
3076 @* Issued as the final step in @command{reset} processing.
3077 @ignore
3078 @item @b{reset-halt-post}
3079 @* Currently not used
3080 @item @b{reset-halt-pre}
3081 @* Currently not used
3082 @end ignore
3083 @item @b{reset-init}
3084 @* Used by @b{reset init} command for board-specific initialization.
3085 This event fires after @emph{reset-deassert-post}.
3086
3087 This is where you would configure PLLs and clocking, set up DRAM so
3088 you can download programs that don't fit in on-chip SRAM, set up pin
3089 multiplexing, and so on.
3090 @item @b{reset-start}
3091 @* Issued as part of @command{reset} processing
3092 before either SRST or TRST are activated.
3093 @ignore
3094 @item @b{reset-wait-pos}
3095 @* Currently not used
3096 @item @b{reset-wait-pre}
3097 @* Currently not used
3098 @end ignore
3099 @item @b{resume-start}
3100 @* Before any target is resumed
3101 @item @b{resume-end}
3102 @* After all targets have resumed
3103 @item @b{resume-ok}
3104 @* Success
3105 @item @b{resumed}
3106 @* Target has resumed
3107 @end itemize
3108
3109
3110 @node Flash Commands
3111 @chapter Flash Commands
3112
3113 OpenOCD has different commands for NOR and NAND flash;
3114 the ``flash'' command works with NOR flash, while
3115 the ``nand'' command works with NAND flash.
3116 This partially reflects different hardware technologies:
3117 NOR flash usually supports direct CPU instruction and data bus access,
3118 while data from a NAND flash must be copied to memory before it can be
3119 used.  (SPI flash must also be copied to memory before use.)
3120 However, the documentation also uses ``flash'' as a generic term;
3121 for example, ``Put flash configuration in board-specific files''.
3122
3123 Flash Steps:
3124 @enumerate
3125 @item Configure via the command @command{flash bank}
3126 @* Do this in a board-specific configuration file,
3127 passing parameters as needed by the driver.
3128 @item Operate on the flash via @command{flash subcommand}
3129 @* Often commands to manipulate the flash are typed by a human, or run
3130 via a script in some automated way.  Common tasks include writing a
3131 boot loader, operating system, or other data.
3132 @item GDB Flashing
3133 @* Flashing via GDB requires the flash be configured via ``flash
3134 bank'', and the GDB flash features be enabled.
3135 @xref{GDB Configuration}.
3136 @end enumerate
3137
3138 Many CPUs have the ablity to ``boot'' from the first flash bank.
3139 This means that misprogramming that bank can ``brick'' a system,
3140 so that it can't boot.
3141 JTAG tools, like OpenOCD, are often then used to ``de-brick'' the
3142 board by (re)installing working boot firmware.
3143
3144 @anchor{NOR Configuration}
3145 @section Flash Configuration Commands
3146 @cindex flash configuration
3147
3148 @deffn {Config Command} {flash bank} driver base size chip_width bus_width target [driver_options]
3149 Configures a flash bank which provides persistent storage
3150 for addresses from @math{base} to @math{base + size - 1}.
3151 These banks will often be visible to GDB through the target's memory map.
3152 In some cases, configuring a flash bank will activate extra commands;
3153 see the driver-specific documentation.
3154
3155 @itemize @bullet
3156 @item @var{driver} ... identifies the controller driver
3157 associated with the flash bank being declared.
3158 This is usually @code{cfi} for external flash, or else
3159 the name of a microcontroller with embedded flash memory.
3160 @xref{Flash Driver List}.
3161 @item @var{base} ... Base address of the flash chip.
3162 @item @var{size} ... Size of the chip, in bytes.
3163 For some drivers, this value is detected from the hardware.
3164 @item @var{chip_width} ... Width of the flash chip, in bytes;
3165 ignored for most microcontroller drivers.
3166 @item @var{bus_width} ... Width of the data bus used to access the
3167 chip, in bytes; ignored for most microcontroller drivers.
3168 @item @var{target} ... Names the target used to issue
3169 commands to the flash controller.
3170 @comment Actually, it's currently a controller-specific parameter...
3171 @item @var{driver_options} ... drivers may support, or require,
3172 additional parameters.  See the driver-specific documentation
3173 for more information.
3174 @end itemize
3175 @quotation Note
3176 This command is not available after OpenOCD initialization has completed.
3177 Use it in board specific configuration files, not interactively.
3178 @end quotation
3179 @end deffn
3180
3181 @comment the REAL name for this command is "ocd_flash_banks"
3182 @comment less confusing would be:  "flash list" (like "nand list")
3183 @deffn Command {flash banks}
3184 Prints a one-line summary of each device declared
3185 using @command{flash bank}, numbered from zero.
3186 Note that this is the @emph{plural} form;
3187 the @emph{singular} form is a very different command.
3188 @end deffn
3189
3190 @deffn Command {flash probe} num
3191 Identify the flash, or validate the parameters of the configured flash. Operation
3192 depends on the flash type.
3193 The @var{num} parameter is a value shown by @command{flash banks}.
3194 Most flash commands will implicitly @emph{autoprobe} the bank;
3195 flash drivers can distinguish between probing and autoprobing,
3196 but most don't bother.
3197 @end deffn
3198
3199 @section Erasing, Reading, Writing to Flash
3200 @cindex flash erasing
3201 @cindex flash reading
3202 @cindex flash writing
3203 @cindex flash programming
3204
3205 One feature distinguishing NOR flash from NAND or serial flash technologies
3206 is that for read access, it acts exactly like any other addressible memory.
3207 This means you can use normal memory read commands like @command{mdw} or
3208 @command{dump_image} with it, with no special @command{flash} subcommands.
3209 @xref{Memory access}, and @ref{Image access}.
3210
3211 Write access works differently.  Flash memory normally needs to be erased
3212 before it's written.  Erasing a sector turns all of its bits to ones, and
3213 writing can turn ones into zeroes.  This is why there are special commands
3214 for interactive erasing and writing, and why GDB needs to know which parts
3215 of the address space hold NOR flash memory.
3216
3217 @quotation Note
3218 Most of these erase and write commands leverage the fact that NOR flash
3219 chips consume target address space.  They implicitly refer to the current
3220 JTAG target, and map from an address in that target's address space
3221 back to a flash bank.
3222 @comment In May 2009, those mappings may fail if any bank associated
3223 @comment with that target doesn't succesfuly autoprobe ... bug worth fixing?
3224 A few commands use abstract addressing based on bank and sector numbers,
3225 and don't depend on searching the current target and its address space.
3226 Avoid confusing the two command models.
3227 @end quotation
3228
3229 Some flash chips implement software protection against accidental writes,
3230 since such buggy writes could in some cases ``brick'' a system.
3231 For such systems, erasing and writing may require sector protection to be
3232 disabled first.
3233 Examples include CFI flash such as ``Intel Advanced Bootblock flash'',
3234 and AT91SAM7 on-chip flash.
3235 @xref{flash protect}.
3236
3237 @anchor{flash erase_sector}
3238 @deffn Command {flash erase_sector} num first last
3239 Erase sectors in bank @var{num}, starting at sector @var{first} up to and including
3240 @var{last}. Sector numbering starts at 0.
3241 The @var{num} parameter is a value shown by @command{flash banks}.
3242 @end deffn
3243
3244 @deffn Command {flash erase_address} address length
3245 Erase sectors starting at @var{address} for @var{length} bytes.
3246 The flash bank to use is inferred from the @var{address}, and
3247 the specified length must stay within that bank.
3248 As a special case, when @var{length} is zero and @var{address} is
3249 the start of the bank, the whole flash is erased.
3250 @end deffn
3251
3252 @deffn Command {flash fillw} address word length
3253 @deffnx Command {flash fillh} address halfword length
3254 @deffnx Command {flash fillb} address byte length
3255 Fills flash memory with the specified @var{word} (32 bits),
3256 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3257 starting at @var{address} and continuing
3258 for @var{length} units (word/halfword/byte).
3259 No erasure is done before writing; when needed, that must be done
3260 before issuing this command.
3261 Writes are done in blocks of up to 1024 bytes, and each write is
3262 verified by reading back the data and comparing it to what was written.
3263 The flash bank to use is inferred from the @var{address} of
3264 each block, and the specified length must stay within that bank.
3265 @end deffn
3266 @comment no current checks for errors if fill blocks touch multiple banks!
3267
3268 @anchor{flash write_bank}
3269 @deffn Command {flash write_bank} num filename offset
3270 Write the binary @file{filename} to flash bank @var{num},
3271 starting at @var{offset} bytes from the beginning of the bank.
3272 The @var{num} parameter is a value shown by @command{flash banks}.
3273 @end deffn
3274
3275 @anchor{flash write_image}
3276 @deffn Command {flash write_image} [erase] filename [offset] [type]
3277 Write the image @file{filename} to the current target's flash bank(s).
3278 A relocation @var{offset} may be specified, in which case it is added
3279 to the base address for each section in the image.
3280 The file [@var{type}] can be specified
3281 explicitly as @option{bin} (binary), @option{ihex} (Intel hex),
3282 @option{elf} (ELF file), @option{s19} (Motorola s19).
3283 @option{mem}, or @option{builder}.
3284 The relevant flash sectors will be erased prior to programming
3285 if the @option{erase} parameter is given.
3286 The flash bank to use is inferred from the @var{address} of
3287 each image segment.
3288 @end deffn
3289
3290 @section Other Flash commands
3291 @cindex flash protection
3292
3293 @deffn Command {flash erase_check} num
3294 Check erase state of sectors in flash bank @var{num},
3295 and display that status.
3296 The @var{num} parameter is a value shown by @command{flash banks}.
3297 This is the only operation that
3298 updates the erase state information displayed by @option{flash info}. That means you have
3299 to issue an @command{flash erase_check} command after erasing or programming the device
3300 to get updated information.
3301 (Code execution may have invalidated any state records kept by OpenOCD.)
3302 @end deffn
3303
3304 @deffn Command {flash info} num
3305 Print info about flash bank @var{num}
3306 The @var{num} parameter is a value shown by @command{flash banks}.
3307 The information includes per-sector protect status.
3308 @end deffn
3309
3310 @anchor{flash protect}
3311 @deffn Command {flash protect} num first last (on|off)
3312 Enable (@var{on}) or disable (@var{off}) protection of flash sectors
3313 @var{first} to @var{last} of flash bank @var{num}.
3314 The @var{num} parameter is a value shown by @command{flash banks}.
3315 @end deffn
3316
3317 @deffn Command {flash protect_check} num
3318 Check protection state of sectors in flash bank @var{num}.
3319 The @var{num} parameter is a value shown by @command{flash banks}.
3320 @comment @option{flash erase_sector} using the same syntax.
3321 @end deffn
3322
3323 @anchor{Flash Driver List}
3324 @section Flash Drivers, Options, and Commands
3325 As noted above, the @command{flash bank} command requires a driver name,
3326 and allows driver-specific options and behaviors.
3327 Some drivers also activate driver-specific commands.
3328
3329 @subsection External Flash
3330
3331 @deffn {Flash Driver} cfi
3332 @cindex Common Flash Interface
3333 @cindex CFI
3334 The ``Common Flash Interface'' (CFI) is the main standard for
3335 external NOR flash chips, each of which connects to a
3336 specific external chip select on the CPU.
3337 Frequently the first such chip is used to boot the system.
3338 Your board's @code{reset-init} handler might need to
3339 configure additional chip selects using other commands (like: @command{mww} to
3340 configure a bus and its timings) , or
3341 perhaps configure a GPIO pin that controls the ``write protect'' pin
3342 on the flash chip.
3343 The CFI driver can use a target-specific working area to significantly
3344 speed up operation.
3345
3346 The CFI driver can accept the following optional parameters, in any order:
3347
3348 @itemize
3349 @item @var{jedec_probe} ... is used to detect certain non-CFI flash ROMs,
3350 like AM29LV010 and similar types.
3351 @item @var{x16_as_x8} ... when a 16-bit flash is hooked up to an 8-bit bus.
3352 @end itemize
3353
3354 To configure two adjacent banks of 16 MBytes each, both sixteen bits (two bytes)
3355 wide on a sixteen bit bus:
3356
3357 @example
3358 flash bank cfi 0x00000000 0x01000000 2 2 $_TARGETNAME
3359 flash bank cfi 0x01000000 0x01000000 2 2 $_TARGETNAME
3360 @end example
3361 @end deffn
3362
3363 @subsection Internal Flash (Microcontrollers)
3364
3365 @deffn {Flash Driver} aduc702x
3366 The ADUC702x analog microcontrollers from ST Micro
3367 include internal flash and use ARM7TDMI cores.
3368 The aduc702x flash driver works with models ADUC7019 through ADUC7028.
3369 The setup command only requires the @var{target} argument
3370 since all devices in this family have the same memory layout.
3371
3372 @example
3373 flash bank aduc702x 0 0 0 0 $_TARGETNAME
3374 @end example
3375 @end deffn
3376
3377 @deffn {Flash Driver} at91sam7
3378 All members of the AT91SAM7 microcontroller family from Atmel
3379 include internal flash and use ARM7TDMI cores.
3380 The driver automatically recognizes a number of these chips using
3381 the chip identification register, and autoconfigures itself.
3382
3383 @example
3384 flash bank at91sam7 0 0 0 0 $_TARGETNAME
3385 @end example
3386
3387 For chips which are not recognized by the controller driver, you must
3388 provide additional parameters in the following order:
3389
3390 @itemize
3391 @item @var{chip_model} ... label used with @command{flash info}
3392 @item @var{banks}
3393 @item @var{sectors_per_bank}
3394 @item @var{pages_per_sector}
3395 @item @var{pages_size}
3396 @item @var{num_nvm_bits}
3397 @item @var{freq_khz} ... required if an external clock is provided,
3398 optional (but recommended) when the oscillator frequency is known
3399 @end itemize
3400
3401 It is recommended that you provide zeroes for all of those values
3402 except the clock frequency, so that everything except that frequency
3403 will be autoconfigured.
3404 Knowing the frequency helps ensure correct timings for flash access.
3405
3406 The flash controller handles erases automatically on a page (128/256 byte)
3407 basis, so explicit erase commands are not necessary for flash programming.
3408 However, there is an ``EraseAll`` command that can erase an entire flash
3409 plane (of up to 256KB), and it will be used automatically when you issue
3410 @command{flash erase_sector} or @command{flash erase_address} commands.
3411
3412 @deffn Command {at91sam7 gpnvm} bitnum (set|clear)
3413 Set or clear a ``General Purpose Non-Volatle Memory'' (GPNVM)
3414 bit for the processor.   Each processor has a number of such bits,
3415 used for controlling features such as brownout detection (so they
3416 are not truly general purpose).
3417 @quotation Note
3418 This assumes that the first flash bank (number 0) is associated with
3419 the appropriate at91sam7 target.
3420 @end quotation
3421 @end deffn
3422 @end deffn
3423
3424 @deffn {Flash Driver} avr
3425 The AVR 8-bit microcontrollers from Atmel integrate flash memory.
3426 @emph{The current implementation is incomplete.}
3427 @comment - defines mass_erase ... pointless given flash_erase_address
3428 @end deffn
3429
3430 @deffn {Flash Driver} ecosflash
3431 @emph{No idea what this is...}
3432 The @var{ecosflash} driver defines one mandatory parameter,
3433 the name of a modules of target code which is downloaded
3434 and executed.
3435 @end deffn
3436
3437 @deffn {Flash Driver} lpc2000
3438 Most members of the LPC2000 microcontroller family from NXP
3439 include internal flash and use ARM7TDMI cores.
3440 The @var{lpc2000} driver defines two mandatory and one optional parameters,
3441 which must appear in the following order:
3442
3443 @itemize
3444 @item @var{variant} ... required, may be
3445 @var{lpc2000_v1} (older LPC21xx and LPC22xx)
3446 or @var{lpc2000_v2} (LPC213x, LPC214x, LPC210[123], LPC23xx and LPC24xx)
3447 @item @var{clock_kHz} ... the frequency, in kiloHertz,
3448 at which the core is running
3449 @item @var{calc_checksum} ... optional (but you probably want to provide this!),
3450 telling the driver to calculate a valid checksum for the exception vector table.
3451 @end itemize
3452
3453 LPC flashes don't require the chip and bus width to be specified.
3454
3455 @example
3456 flash bank lpc2000 0x0 0x7d000 0 0 $_TARGETNAME \
3457       lpc2000_v2 14765 calc_checksum
3458 @end example
3459 @end deffn
3460
3461 @deffn {Flash Driver} lpc288x
3462 The LPC2888 microcontroller from NXP needs slightly different flash
3463 support from its lpc2000 siblings.
3464 The @var{lpc288x} driver defines one mandatory parameter,
3465 the programming clock rate in Hz.
3466 LPC flashes don't require the chip and bus width to be specified.
3467
3468 @example
3469 flash bank lpc288x 0 0 0 0 $_TARGETNAME 12000000
3470 @end example
3471 @end deffn
3472
3473 @deffn {Flash Driver} ocl
3474 @emph{No idea what this is, other than using some arm7/arm9 core.}
3475
3476 @example
3477 flash bank ocl 0 0 0 0 $_TARGETNAME
3478 @end example
3479 @end deffn
3480
3481 @deffn {Flash Driver} pic32mx
3482 The PIC32MX microcontrollers are based on the MIPS 4K cores,
3483 and integrate flash memory.
3484 @emph{The current implementation is incomplete.}
3485
3486 @example
3487 flash bank pix32mx 0 0 0 0 $_TARGETNAME
3488 @end example
3489
3490 @comment numerous *disabled* commands are defined:
3491 @comment - chip_erase ... pointless given flash_erase_address
3492 @comment - lock, unlock ... pointless given protect on/off (yes?)
3493 @comment - pgm_word ... shouldn't bank be deduced from address??
3494 Some pic32mx-specific commands are defined:
3495 @deffn Command {pic32mx pgm_word} address value bank
3496 Programs the specified 32-bit @var{value} at the given @var{address}
3497 in the specified chip @var{bank}.
3498 @end deffn
3499 @end deffn
3500
3501 @deffn {Flash Driver} stellaris
3502 All members of the Stellaris LM3Sxxx microcontroller family from
3503 Texas Instruments
3504 include internal flash and use ARM Cortex M3 cores.
3505 The driver automatically recognizes a number of these chips using
3506 the chip identification register, and autoconfigures itself.
3507 @footnote{Currently there is a @command{stellaris mass_erase} command.
3508 That seems pointless since the same effect can be had using the
3509 standard @command{flash erase_address} command.}
3510
3511 @example
3512 flash bank stellaris 0 0 0 0 $_TARGETNAME
3513 @end example
3514 @end deffn
3515
3516 @deffn {Flash Driver} stm32x
3517 All members of the STM32 microcontroller family from ST Microelectronics
3518 include internal flash and use ARM Cortex M3 cores.
3519 The driver automatically recognizes a number of these chips using
3520 the chip identification register, and autoconfigures itself.
3521
3522 @example
3523 flash bank stm32x 0 0 0 0 $_TARGETNAME
3524 @end example
3525
3526 Some stm32x-specific commands
3527 @footnote{Currently there is a @command{stm32x mass_erase} command.
3528 That seems pointless since the same effect can be had using the
3529 standard @command{flash erase_address} command.}
3530 are defined:
3531
3532 @deffn Command {stm32x lock} num
3533 Locks the entire stm32 device.
3534 The @var{num} parameter is a value shown by @command{flash banks}.
3535 @end deffn
3536
3537 @deffn Command {stm32x unlock} num
3538 Unlocks the entire stm32 device.
3539 The @var{num} parameter is a value shown by @command{flash banks}.
3540 @end deffn
3541
3542 @deffn Command {stm32x options_read} num
3543 Read and display the stm32 option bytes written by
3544 the @command{stm32x options_write} command.
3545 The @var{num} parameter is a value shown by @command{flash banks}.
3546 @end deffn
3547
3548 @deffn Command {stm32x options_write} num (SWWDG|HWWDG) (RSTSTNDBY|NORSTSTNDBY) (RSTSTOP|NORSTSTOP)
3549 Writes the stm32 option byte with the specified values.
3550 The @var{num} parameter is a value shown by @command{flash banks}.
3551 @end deffn
3552 @end deffn
3553
3554 @deffn {Flash Driver} str7x
3555 All members of the STR7 microcontroller family from ST Microelectronics
3556 include internal flash and use ARM7TDMI cores.
3557 The @var{str7x} driver defines one mandatory parameter, @var{variant},
3558 which is either @code{STR71x}, @code{STR73x} or @code{STR75x}.
3559
3560 @example
3561 flash bank str7x 0x40000000 0x00040000 0 0 $_TARGETNAME STR71x
3562 @end example
3563 @end deffn
3564
3565 @deffn {Flash Driver} str9x
3566 Most members of the STR9 microcontroller family from ST Microelectronics
3567 include internal flash and use ARM966E cores.
3568 The str9 needs the flash controller to be configured using
3569 the @command{str9x flash_config} command prior to Flash programming.
3570
3571 @example
3572 flash bank str9x 0x40000000 0x00040000 0 0 $_TARGETNAME
3573 str9x flash_config 0 4 2 0 0x80000
3574 @end example
3575
3576 @deffn Command {str9x flash_config} num bbsr nbbsr bbadr nbbadr
3577 Configures the str9 flash controller.
3578 The @var{num} parameter is a value shown by @command{flash banks}.
3579
3580 @itemize @bullet
3581 @item @var{bbsr} - Boot Bank Size register
3582 @item @var{nbbsr} - Non Boot Bank Size register
3583 @item @var{bbadr} - Boot Bank Start Address register
3584 @item @var{nbbadr} - Boot Bank Start Address register
3585 @end itemize
3586 @end deffn
3587
3588 @end deffn
3589
3590 @deffn {Flash Driver} tms470
3591 Most members of the TMS470 microcontroller family from Texas Instruments
3592 include internal flash and use ARM7TDMI cores.
3593 This driver doesn't require the chip and bus width to be specified.
3594
3595 Some tms470-specific commands are defined:
3596
3597 @deffn Command {tms470 flash_keyset} key0 key1 key2 key3
3598 Saves programming keys in a register, to enable flash erase and write commands.
3599 @end deffn
3600
3601 @deffn Command {tms470 osc_mhz} clock_mhz
3602 Reports the clock speed, which is used to calculate timings.
3603 @end deffn
3604
3605 @deffn Command {tms470 plldis} (0|1)
3606 Disables (@var{1}) or enables (@var{0}) use of the PLL to speed up
3607 the flash clock.
3608 @end deffn
3609 @end deffn
3610
3611 @subsection str9xpec driver
3612 @cindex str9xpec
3613
3614 Here is some background info to help
3615 you better understand how this driver works. OpenOCD has two flash drivers for
3616 the str9:
3617 @enumerate
3618 @item
3619 Standard driver @option{str9x} programmed via the str9 core. Normally used for
3620 flash programming as it is faster than the @option{str9xpec} driver.
3621 @item
3622 Direct programming @option{str9xpec} using the flash controller. This is an
3623 ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
3624 core does not need to be running to program using this flash driver. Typical use
3625 for this driver is locking/unlocking the target and programming the option bytes.
3626 @end enumerate
3627
3628 Before we run any commands using the @option{str9xpec} driver we must first disable
3629 the str9 core. This example assumes the @option{str9xpec} driver has been
3630 configured for flash bank 0.
3631 @example
3632 # assert srst, we do not want core running
3633 # while accessing str9xpec flash driver
3634 jtag_reset 0 1
3635 # turn off target polling
3636 poll off
3637 # disable str9 core
3638 str9xpec enable_turbo 0
3639 # read option bytes
3640 str9xpec options_read 0
3641 # re-enable str9 core
3642 str9xpec disable_turbo 0
3643 poll on
3644 reset halt
3645 @end example
3646 The above example will read the str9 option bytes.
3647 When performing a unlock remember that you will not be able to halt the str9 - it
3648 has been locked. Halting the core is not required for the @option{str9xpec} driver
3649 as mentioned above, just issue the commands above manually or from a telnet prompt.
3650
3651 @deffn {Flash Driver} str9xpec
3652 Only use this driver for locking/unlocking the device or configuring the option bytes.
3653 Use the standard str9 driver for programming.
3654 Before using the flash commands the turbo mode must be enabled using the
3655 @command{str9xpec enable_turbo} command.
3656
3657 Several str9xpec-specific commands are defined:
3658
3659 @deffn Command {str9xpec disable_turbo} num
3660 Restore the str9 into JTAG chain.
3661 @end deffn
3662
3663 @deffn Command {str9xpec enable_turbo} num
3664 Enable turbo mode, will simply remove the str9 from the chain and talk
3665 directly to the embedded flash controller.
3666 @end deffn
3667
3668 @deffn Command {str9xpec lock} num
3669 Lock str9 device. The str9 will only respond to an unlock command that will
3670 erase the device.
3671 @end deffn
3672
3673 @deffn Command {str9xpec part_id} num
3674 Prints the part identifier for bank @var{num}.
3675 @end deffn
3676
3677 @deffn Command {str9xpec options_cmap} num (@option{bank0}|@option{bank1})
3678 Configure str9 boot bank.
3679 @end deffn
3680
3681 @deffn Command {str9xpec options_lvdsel} num (@option{vdd}|@option{vdd_vddq})
3682 Configure str9 lvd source.
3683 @end deffn
3684
3685 @deffn Command {str9xpec options_lvdthd} num (@option{2.4v}|@option{2.7v})
3686 Configure str9 lvd threshold.
3687 @end deffn
3688
3689 @deffn Command {str9xpec options_lvdwarn} bank (@option{vdd}|@option{vdd_vddq})
3690 Configure str9 lvd reset warning source.
3691 @end deffn
3692
3693 @deffn Command {str9xpec options_read} num
3694 Read str9 option bytes.
3695 @end deffn
3696
3697 @deffn Command {str9xpec options_write} num
3698 Write str9 option bytes.
3699 @end deffn
3700
3701 @deffn Command {str9xpec unlock} num
3702 unlock str9 device.
3703 @end deffn
3704
3705 @end deffn
3706
3707
3708 @section mFlash
3709
3710 @subsection mFlash Configuration
3711 @cindex mFlash Configuration
3712
3713 @deffn {Config Command} {mflash bank} soc base RST_pin target
3714 Configures a mflash for @var{soc} host bank at
3715 address @var{base}.
3716 The pin number format depends on the host GPIO naming convention.
3717 Currently, the mflash driver supports s3c2440 and pxa270.
3718
3719 Example for s3c2440 mflash where @var{RST pin} is GPIO B1:
3720
3721 @example
3722 mflash bank s3c2440 0x10000000 1b 0
3723 @end example
3724
3725 Example for pxa270 mflash where @var{RST pin} is GPIO 43:
3726
3727 @example
3728 mflash bank pxa270 0x08000000 43 0
3729 @end example
3730 @end deffn
3731
3732 @subsection mFlash commands
3733 @cindex mFlash commands
3734
3735 @deffn Command {mflash config pll} frequency
3736 Configure mflash PLL.
3737 The @var{frequency} is the mflash input frequency, in Hz.
3738 Issuing this command will erase mflash's whole internal nand and write new pll.
3739 After this command, mflash needs power-on-reset for normal operation.
3740 If pll was newly configured, storage and boot(optional) info also need to be update.
3741 @end deffn
3742
3743 @deffn Command {mflash config boot}
3744 Configure bootable option.
3745 If bootable option is set, mflash offer the first 8 sectors
3746 (4kB) for boot.
3747 @end deffn
3748
3749 @deffn Command {mflash config storage}
3750 Configure storage information.
3751 For the normal storage operation, this information must be
3752 written.
3753 @end deffn
3754
3755 @deffn Command {mflash dump} num filename offset size
3756 Dump @var{size} bytes, starting at @var{offset} bytes from the
3757 beginning of the bank @var{num}, to the file named @var{filename}.
3758 @end deffn
3759
3760 @deffn Command {mflash probe}
3761 Probe mflash.
3762 @end deffn
3763
3764 @deffn Command {mflash write} num filename offset
3765 Write the binary file @var{filename} to mflash bank @var{num}, starting at
3766 @var{offset} bytes from the beginning of the bank.
3767 @end deffn
3768
3769 @node NAND Flash Commands
3770 @chapter NAND Flash Commands
3771 @cindex NAND
3772
3773 Compared to NOR or SPI flash, NAND devices are inexpensive
3774 and high density.  Today's NAND chips, and multi-chip modules,
3775 commonly hold multiple GigaBytes of data.
3776
3777 NAND chips consist of a number of ``erase blocks'' of a given
3778 size (such as 128 KBytes), each of which is divided into a
3779 number of pages (of perhaps 512 or 2048 bytes each).  Each
3780 page of a NAND flash has an ``out of band'' (OOB) area to hold
3781 Error Correcting Code (ECC) and other metadata, usually 16 bytes
3782 of OOB for every 512 bytes of page data.
3783
3784 One key characteristic of NAND flash is that its error rate
3785 is higher than that of NOR flash.  In normal operation, that
3786 ECC is used to correct and detect errors.  However, NAND
3787 blocks can also wear out and become unusable; those blocks
3788 are then marked "bad".  NAND chips are even shipped from the
3789 manufacturer with a few bad blocks.  The highest density chips
3790 use a technology (MLC) that wears out more quickly, so ECC
3791 support is increasingly important as a way to detect blocks
3792 that have begun to fail, and help to preserve data integrity
3793 with techniques such as wear leveling.
3794
3795 Software is used to manage the ECC.  Some controllers don't
3796 support ECC directly; in those cases, software ECC is used.
3797 Other controllers speed up the ECC calculations with hardware.
3798 Single-bit error correction hardware is routine.  Controllers
3799 geared for newer MLC chips may correct 4 or more errors for
3800 every 512 bytes of data.
3801
3802 You will need to make sure that any data you write using
3803 OpenOCD includes the apppropriate kind of ECC.  For example,
3804 that may mean passing the @code{oob_softecc} flag when
3805 writing NAND data, or ensuring that the correct hardware
3806 ECC mode is used.
3807
3808 The basic steps for using NAND devices include:
3809 @enumerate
3810 @item Declare via the command @command{nand device}
3811 @* Do this in a board-specific configuration file,
3812 passing parameters as needed by the controller.
3813 @item Configure each device using @command{nand probe}.
3814 @* Do this only after the associated target is set up,
3815 such as in its reset-init script or in procures defined
3816 to access that device.
3817 @item Operate on the flash via @command{nand subcommand}
3818 @* Often commands to manipulate the flash are typed by a human, or run
3819 via a script in some automated way.  Common task include writing a
3820 boot loader, operating system, or other data needed to initialize or
3821 de-brick a board.
3822 @end enumerate
3823
3824 @b{NOTE:} At the time this text was written, the largest NAND
3825 flash fully supported by OpenOCD is 2 GiBytes (16 GiBits).
3826 This is because the variables used to hold offsets and lengths
3827 are only 32 bits wide.
3828 (Larger chips may work in some cases, unless an offset or length
3829 is larger than 0xffffffff, the largest 32-bit unsigned integer.)
3830 Some larger devices will work, since they are actually multi-chip
3831 modules with two smaller chips and individual chipselect lines.
3832
3833 @anchor{NAND Configuration}
3834 @section NAND Configuration Commands
3835 @cindex NAND configuration
3836
3837 NAND chips must be declared in configuration scripts,
3838 plus some additional configuration that's done after
3839 OpenOCD has initialized.
3840
3841 @deffn {Config Command} {nand device} controller target [configparams...]
3842 Declares a NAND device, which can be read and written to
3843 after it has been configured through @command{nand probe}.
3844 In OpenOCD, devices are single chips; this is unlike some
3845 operating systems, which may manage multiple chips as if
3846 they were a single (larger) device.
3847 In some cases, configuring a device will activate extra
3848 commands; see the controller-specific documentation.
3849
3850 @b{NOTE:} This command is not available after OpenOCD
3851 initialization has completed.  Use it in board specific
3852 configuration files, not interactively.
3853
3854 @itemize @bullet
3855 @item @var{controller} ... identifies the controller driver
3856 associated with the NAND device being declared.
3857 @xref{NAND Driver List}.
3858 @item @var{target} ... names the target used when issuing
3859 commands to the NAND controller.
3860 @comment Actually, it's currently a controller-specific parameter...
3861 @item @var{configparams} ... controllers may support, or require,
3862 additional parameters.  See the controller-specific documentation
3863 for more information.
3864 @end itemize
3865 @end deffn
3866
3867 @deffn Command {nand list}
3868 Prints a one-line summary of each device declared
3869 using @command{nand device}, numbered from zero.
3870 Note that un-probed devices show no details.
3871 @end deffn
3872
3873 @deffn Command {nand probe} num
3874 Probes the specified device to determine key characteristics
3875 like its page and block sizes, and how many blocks it has.
3876 The @var{num} parameter is the value shown by @command{nand list}.
3877 You must (successfully) probe a device before you can use
3878 it with most other NAND commands.
3879 @end deffn
3880
3881 @section Erasing, Reading, Writing to NAND Flash
3882
3883 @deffn Command {nand dump} num filename offset length [oob_option]
3884 @cindex NAND reading
3885 Reads binary data from the NAND device and writes it to the file,
3886 starting at the specified offset.
3887 The @var{num} parameter is the value shown by @command{nand list}.
3888
3889 Use a complete path name for @var{filename}, so you don't depend
3890 on the directory used to start the OpenOCD server.
3891
3892 The @var{offset} and @var{length} must be exact multiples of the
3893 device's page size.  They describe a data region; the OOB data
3894 associated with each such page may also be accessed.
3895
3896 @b{NOTE:} At the time this text was written, no error correction
3897 was done on the data that's read, unless raw access was disabled
3898 and the underlying NAND controller driver had a @code{read_page}
3899 method which handled that error correction.
3900
3901 By default, only page data is saved to the specified file.
3902 Use an @var{oob_option} parameter to save OOB data:
3903 @itemize @bullet
3904 @item no oob_* parameter
3905 @*Output file holds only page data; OOB is discarded.
3906 @item @code{oob_raw}
3907 @*Output file interleaves page data and OOB data;
3908 the file will be longer than "length" by the size of the
3909 spare areas associated with each data page.
3910 Note that this kind of "raw" access is different from
3911 what's implied by @command{nand raw_access}, which just
3912 controls whether a hardware-aware access method is used.
3913 @item @code{oob_only}
3914 @*Output file has only raw OOB data, and will
3915 be smaller than "length" since it will contain only the
3916 spare areas associated with each data page.
3917 @end itemize
3918 @end deffn
3919
3920 @deffn Command {nand erase} num offset length
3921 @cindex NAND erasing
3922 @cindex NAND programming
3923 Erases blocks on the specified NAND device, starting at the
3924 specified @var{offset} and continuing for @var{length} bytes.
3925 Both of those values must be exact multiples of the device's
3926 block size, and the region they specify must fit entirely in the chip.
3927 The @var{num} parameter is the value shown by @command{nand list}.
3928
3929 @b{NOTE:} This command will try to erase bad blocks, when told
3930 to do so, which will probably invalidate the manufacturer's bad
3931 block marker.
3932 For the remainder of the current server session, @command{nand info}
3933 will still report that the block ``is'' bad.
3934 @end deffn
3935
3936 @deffn Command {nand write} num filename offset [option...]
3937 @cindex NAND writing
3938 @cindex NAND programming
3939 Writes binary data from the file into the specified NAND device,
3940 starting at the specified offset.  Those pages should already
3941 have been erased; you can't change zero bits to one bits.
3942 The @var{num} parameter is the value shown by @command{nand list}.
3943
3944 Use a complete path name for @var{filename}, so you don't depend
3945 on the directory used to start the OpenOCD server.
3946
3947 The @var{offset} must be an exact multiple of the device's page size.
3948 All data in the file will be written, assuming it doesn't run
3949 past the end of the device.
3950 Only full pages are written, and any extra space in the last
3951 page will be filled with 0xff bytes.  (That includes OOB data,
3952 if that's being written.)
3953
3954 @b{NOTE:} At the time this text was written, bad blocks are
3955 ignored.  That is, this routine will not skip bad blocks,
3956 but will instead try to write them.  This can cause problems.
3957
3958 Provide at most one @var{option} parameter.  With some
3959 NAND drivers, the meanings of these parameters may change
3960 if @command{nand raw_access} was used to disable hardware ECC.
3961 @itemize @bullet
3962 @item no oob_* parameter
3963 @*File has only page data, which is written.
3964 If raw acccess is in use, the OOB area will not be written.
3965 Otherwise, if the underlying NAND controller driver has
3966 a @code{write_page} routine, that routine may write the OOB
3967 with hardware-computed ECC data.
3968 @item @code{oob_only}
3969 @*File has only raw OOB data, which is written to the OOB area.
3970 Each page's data area stays untouched.  @i{This can be a dangerous
3971 option}, since it can invalidate the ECC data.
3972 You may need to force raw access to use this mode.
3973 @item @code{oob_raw}
3974 @*File interleaves data and OOB data, both of which are written
3975 If raw access is enabled, the data is written first, then the
3976 un-altered OOB.
3977 Otherwise, if the underlying NAND controller driver has
3978 a @code{write_page} routine, that routine may modify the OOB
3979 before it's written, to include hardware-computed ECC data.
3980 @item @code{oob_softecc}
3981 @*File has only page data, which is written.
3982 The OOB area is filled with 0xff, except for a standard 1-bit
3983 software ECC code stored in conventional locations.
3984 You might need to force raw access to use this mode, to prevent
3985 the underlying driver from applying hardware ECC.
3986 @item @code{oob_softecc_kw}
3987 @*File has only page data, which is written.
3988 The OOB area is filled with 0xff, except for a 4-bit software ECC
3989 specific to the boot ROM in Marvell Kirkwood SoCs.
3990 You might need to force raw access to use this mode, to prevent
3991 the underlying driver from applying hardware ECC.
3992 @end itemize
3993 @end deffn
3994
3995 @section Other NAND commands
3996 @cindex NAND other commands
3997
3998 @deffn Command {nand check_bad_blocks} [offset length]
3999 Checks for manufacturer bad block markers on the specified NAND
4000 device.  If no parameters are provided, checks the whole
4001 device; otherwise, starts at the specified @var{offset} and
4002 continues for @var{length} bytes.
4003 Both of those values must be exact multiples of the device's
4004 block size, and the region they specify must fit entirely in the chip.
4005 The @var{num} parameter is the value shown by @command{nand list}.
4006
4007 @b{NOTE:} Before using this command you should force raw access
4008 with @command{nand raw_access enable} to ensure that the underlying
4009 driver will not try to apply hardware ECC.
4010 @end deffn
4011
4012 @deffn Command {nand info} num
4013 The @var{num} parameter is the value shown by @command{nand list}.
4014 This prints the one-line summary from "nand list", plus for
4015 devices which have been probed this also prints any known
4016 status for each block.
4017 @end deffn
4018
4019 @deffn Command {nand raw_access} num (@option{enable}|@option{disable})
4020 Sets or clears an flag affecting how page I/O is done.
4021 The @var{num} parameter is the value shown by @command{nand list}.
4022
4023 This flag is cleared (disabled) by default, but changing that
4024 value won't affect all NAND devices.  The key factor is whether
4025 the underlying driver provides @code{read_page} or @code{write_page}
4026 methods.  If it doesn't provide those methods, the setting of
4027 this flag is irrelevant; all access is effectively ``raw''.
4028
4029 When those methods exist, they are normally used when reading
4030 data (@command{nand dump} or reading bad block markers) or
4031 writing it (@command{nand write}).  However, enabling
4032 raw access (setting the flag) prevents use of those methods,
4033 bypassing hardware ECC logic.
4034 @i{This can be a dangerous option}, since writing blocks
4035 with the wrong ECC data can cause them to be marked as bad.
4036 @end deffn
4037
4038 @anchor{NAND Driver List}
4039 @section NAND Drivers, Options, and Commands
4040 As noted above, the @command{nand device} command allows
4041 driver-specific options and behaviors.
4042 Some controllers also activate controller-specific commands.
4043
4044 @deffn {NAND Driver} davinci
4045 This driver handles the NAND controllers found on DaVinci family
4046 chips from Texas Instruments.
4047 It takes three extra parameters:
4048 address of the NAND chip;
4049 hardware ECC mode to use (hwecc1, hwecc4, hwecc4_infix);
4050 address of the AEMIF controller on this processor.
4051 @example
4052 nand device davinci dm355.arm 0x02000000 hwecc4 0x01e10000
4053 @end example
4054 All DaVinci processors support the single-bit ECC hardware,
4055 and newer ones also support the four-bit ECC hardware.
4056 The @code{write_page} and @code{read_page} methods are used
4057 to implement those ECC modes, unless they are disabled using
4058 the @command{nand raw_access} command.
4059 @end deffn
4060
4061 @deffn {NAND Driver} lpc3180
4062 These controllers require an extra @command{nand device}
4063 parameter:  the clock rate used by the controller.
4064 @deffn Command {lpc3180 select} num [mlc|slc]
4065 Configures use of the MLC or SLC controller mode.
4066 MLC implies use of hardware ECC.
4067 The @var{num} parameter is the value shown by @command{nand list}.
4068 @end deffn
4069
4070 At this writing, this driver includes @code{write_page}
4071 and @code{read_page} methods.  Using @command{nand raw_access}
4072 to disable those methods will prevent use of hardware ECC
4073 in the MLC controller mode, but won't change SLC behavior.
4074 @end deffn
4075 @comment current lpc3180 code won't issue 5-byte address cycles
4076
4077 @deffn {NAND Driver} orion
4078 These controllers require an extra @command{nand device}
4079 parameter:  the address of the controller.
4080 @example
4081 nand device orion 0xd8000000
4082 @end example
4083 These controllers don't define any specialized commands.
4084 At this writing, their drivers don't include @code{write_page}
4085 or @code{read_page} methods, so @command{nand raw_access} won't
4086 change any behavior.
4087 @end deffn
4088
4089 @deffn {NAND Driver} s3c2410
4090 @deffnx {NAND Driver} s3c2412
4091 @deffnx {NAND Driver} s3c2440
4092 @deffnx {NAND Driver} s3c2443
4093 These S3C24xx family controllers don't have any special
4094 @command{nand device} options, and don't define any
4095 specialized commands.
4096 At this writing, their drivers don't include @code{write_page}
4097 or @code{read_page} methods, so @command{nand raw_access} won't
4098 change any behavior.
4099 @end deffn
4100
4101 @node PLD/FPGA Commands
4102 @chapter PLD/FPGA Commands
4103 @cindex PLD
4104 @cindex FPGA
4105
4106 Programmable Logic Devices (PLDs) and the more flexible
4107 Field Programmable Gate Arrays (FPGAs) are both types of programmable hardware.
4108 OpenOCD can support programming them.
4109 Although PLDs are generally restrictive (cells are less functional, and
4110 there are no special purpose cells for memory or computational tasks),
4111 they share the same OpenOCD infrastructure.
4112 Accordingly, both are called PLDs here.
4113
4114 @section PLD/FPGA Configuration and Commands
4115
4116 As it does for JTAG TAPs, debug targets, and flash chips (both NOR and NAND),
4117 OpenOCD maintains a list of PLDs available for use in various commands.
4118 Also, each such PLD requires a driver.
4119
4120 They are referenced by the number shown by the @command{pld devices} command,
4121 and new PLDs are defined by @command{pld device driver_name}.
4122
4123 @deffn {Config Command} {pld device} driver_name tap_name [driver_options]
4124 Defines a new PLD device, supported by driver @var{driver_name},
4125 using the TAP named @var{tap_name}.
4126 The driver may make use of any @var{driver_options} to configure its
4127 behavior.
4128 @end deffn
4129
4130 @deffn {Command} {pld devices}
4131 Lists the PLDs and their numbers.
4132 @end deffn
4133
4134 @deffn {Command} {pld load} num filename
4135 Loads the file @file{filename} into the PLD identified by @var{num}.
4136 The file format must be inferred by the driver.
4137 @end deffn
4138
4139 @section PLD/FPGA Drivers, Options, and Commands
4140
4141 Drivers may support PLD-specific options to the @command{pld device}
4142 definition command, and may also define commands usable only with
4143 that particular type of PLD.
4144
4145 @deffn {FPGA Driver} virtex2
4146 Virtex-II is a family of FPGAs sold by Xilinx.
4147 It supports the IEEE 1532 standard for In-System Configuration (ISC).
4148 No driver-specific PLD definition options are used,
4149 and one driver-specific command is defined.
4150
4151 @deffn {Command} {virtex2 read_stat} num
4152 Reads and displays the Virtex-II status register (STAT)
4153 for FPGA @var{num}.
4154 @end deffn
4155 @end deffn
4156
4157 @node General Commands
4158 @chapter General Commands
4159 @cindex commands
4160
4161 The commands documented in this chapter here are common commands that
4162 you, as a human, may want to type and see the output of. Configuration type
4163 commands are documented elsewhere.
4164
4165 Intent:
4166 @itemize @bullet
4167 @item @b{Source Of Commands}
4168 @* OpenOCD commands can occur in a configuration script (discussed
4169 elsewhere) or typed manually by a human or supplied programatically,
4170 or via one of several TCP/IP Ports.
4171
4172 @item @b{From the human}
4173 @* A human should interact with the telnet interface (default port: 4444)
4174 or via GDB (default port 3333).
4175
4176 To issue commands from within a GDB session, use the @option{monitor}
4177 command, e.g. use @option{monitor poll} to issue the @option{poll}
4178 command. All output is relayed through the GDB session.
4179
4180 @item @b{Machine Interface}
4181 The Tcl interface's intent is to be a machine interface. The default Tcl
4182 port is 5555.
4183 @end itemize
4184
4185
4186 @section Daemon Commands
4187
4188 @deffn Command sleep msec [@option{busy}]
4189 Wait for at least @var{msec} milliseconds before resuming.
4190 If @option{busy} is passed, busy-wait instead of sleeping.
4191 (This option is strongly discouraged.)
4192 Useful in connection with script files
4193 (@command{script} command and @command{target_name} configuration).
4194 @end deffn
4195
4196 @deffn Command shutdown
4197 Close the OpenOCD daemon, disconnecting all clients (GDB, telnet, other).
4198 @end deffn
4199
4200 @anchor{debug_level}
4201 @deffn Command debug_level [n]
4202 @cindex message level
4203 Display debug level.
4204 If @var{n} (from 0..3) is provided, then set it to that level.
4205 This affects the kind of messages sent to the server log.
4206 Level 0 is error messages only;
4207 level 1 adds warnings;
4208 level 2 adds informational messages;
4209 and level 3 adds debugging messages.
4210 The default is level 2, but that can be overridden on
4211 the command line along with the location of that log
4212 file (which is normally the server's standard output).
4213 @xref{Running}.
4214 @end deffn
4215
4216 @deffn Command fast (@option{enable}|@option{disable})
4217 Default disabled.
4218 Set default behaviour of OpenOCD to be "fast and dangerous".
4219
4220 At this writing, this only affects the defaults for two ARM7/ARM9 parameters:
4221 fast memory access, and DCC downloads.  Those parameters may still be
4222 individually overridden.
4223
4224 The target specific "dangerous" optimisation tweaking options may come and go
4225 as more robust and user friendly ways are found to ensure maximum throughput
4226 and robustness with a minimum of configuration. 
4227
4228 Typically the "fast enable" is specified first on the command line:
4229
4230 @example
4231 openocd -c "fast enable" -c "interface dummy" -f target/str710.cfg
4232 @end example
4233 @end deffn
4234
4235 @deffn Command echo message
4236 Logs a message at "user" priority.
4237 Output @var{message} to stdout.
4238 @example
4239 echo "Downloading kernel -- please wait"
4240 @end example
4241 @end deffn
4242
4243 @deffn Command log_output [filename]
4244 Redirect logging to @var{filename};
4245 the initial log output channel is stderr.
4246 @end deffn
4247
4248 @anchor{Target State handling}
4249 @section Target State handling
4250 @cindex reset
4251 @cindex halt
4252 @cindex target initialization
4253
4254 In this section ``target'' refers to a CPU configured as
4255 shown earlier (@pxref{CPU Configuration}).
4256 These commands, like many, implicitly refer to
4257 a current target which is used to perform the
4258 various operations.  The current target may be changed
4259 by using @command{targets} command with the name of the
4260 target which should become current.
4261
4262 @deffn Command reg [(number|name) [value]]
4263 Access a single register by @var{number} or by its @var{name}.
4264
4265 @emph{With no arguments}:
4266 list all available registers for the current target,
4267 showing number, name, size, value, and cache status.
4268
4269 @emph{With number/name}: display that register's value.
4270
4271 @emph{With both number/name and value}: set register's value.
4272
4273 Cores may have surprisingly many registers in their
4274 Debug and trace infrastructure:
4275
4276 @example
4277 > reg
4278 (0) r0 (/32): 0x0000D3C2 (dirty: 1, valid: 1)
4279 (1) r1 (/32): 0xFD61F31C (dirty: 0, valid: 1)
4280 (2) r2 (/32): 0x00022551 (dirty: 0, valid: 1)
4281 ...
4282 (164) ETM_CONTEXTID_COMPARATOR_MASK (/32): \
4283               0x00000000 (dirty: 0, valid: 0)
4284 >
4285 @end example
4286 @end deffn
4287
4288 @deffn Command halt [ms]
4289 @deffnx Command wait_halt [ms]
4290 The @command{halt} command first sends a halt request to the target,
4291 which @command{wait_halt} doesn't.
4292 Otherwise these behave the same:  wait up to @var{ms} milliseconds,
4293 or 5 seconds if there is no parameter, for the target to halt
4294 (and enter debug mode).
4295 Using 0 as the @var{ms} parameter prevents OpenOCD from waiting.
4296 @end deffn
4297
4298 @deffn Command resume [address]
4299 Resume the target at its current code position,
4300 or the optional @var{address} if it is provided.
4301 OpenOCD will wait 5 seconds for the target to resume.
4302 @end deffn
4303
4304 @deffn Command step [address]
4305 Single-step the target at its current code position,
4306 or the optional @var{address} if it is provided.
4307 @end deffn
4308
4309 @anchor{Reset Command}
4310 @deffn Command reset
4311 @deffnx Command {reset run}
4312 @deffnx Command {reset halt}
4313 @deffnx Command {reset init}
4314 Perform as hard a reset as possible, using SRST if possible.
4315 @emph{All defined targets will be reset, and target
4316 events will fire during the reset sequence.}
4317
4318 The optional parameter specifies what should
4319 happen after the reset.
4320 If there is no parameter, a @command{reset run} is executed.
4321 The other options will not work on all systems.
4322 @xref{Reset Configuration}.
4323
4324 @itemize @minus
4325 @item @b{run} Let the target run
4326 @item @b{halt} Immediately halt the target
4327 @item @b{init} Immediately halt the target, and execute the reset-init script
4328 @end itemize
4329 @end deffn
4330
4331 @deffn Command soft_reset_halt
4332 Requesting target halt and executing a soft reset. This is often used
4333 when a target cannot be reset and halted. The target, after reset is
4334 released begins to execute code. OpenOCD attempts to stop the CPU and
4335 then sets the program counter back to the reset vector. Unfortunately
4336 the code that was executed may have left the hardware in an unknown
4337 state.
4338 @end deffn
4339
4340 @section I/O Utilities
4341
4342 These commands are available when
4343 OpenOCD is built with @option{--enable-ioutil}.
4344 They are mainly useful on embedded targets;
4345 PC type hosts have complementary tools.
4346
4347 @emph{Note:} there are several more such commands.
4348
4349 @deffn Command  meminfo
4350 Display available RAM memory on OpenOCD host.
4351 Used in OpenOCD regression testing scripts.
4352 @end deffn
4353
4354 @anchor{Memory access}
4355 @section Memory access commands
4356 @cindex memory access
4357
4358 These commands allow accesses of a specific size to the memory
4359 system. Often these are used to configure the current target in some
4360 special way. For example - one may need to write certain values to the
4361 SDRAM controller to enable SDRAM.
4362
4363 @enumerate
4364 @item Use the @command{targets} (plural) command
4365 to change the current target.
4366 @item In system level scripts these commands are deprecated.
4367 Please use their TARGET object siblings to avoid making assumptions
4368 about what TAP is the current target, or about MMU configuration.
4369 @end enumerate
4370
4371 @deffn Command mdw addr [count]
4372 @deffnx Command mdh addr [count]
4373 @deffnx Command mdb addr [count]
4374 Display contents of address @var{addr}, as
4375 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
4376 or 8-bit bytes (@command{mdb}).
4377 If @var{count} is specified, displays that many units.
4378 (If you want to manipulate the data instead of displaying it,
4379 see the @code{mem2array} primitives.)
4380 @end deffn
4381
4382 @deffn Command mww addr word
4383 @deffnx Command mwh addr halfword
4384 @deffnx Command mwb addr byte
4385 Writes the specified @var{word} (32 bits),
4386 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
4387 at the specified address @var{addr}.
4388 @end deffn
4389
4390
4391 @anchor{Image access}
4392 @section Image loading commands
4393 @cindex image loading
4394 @cindex image dumping
4395
4396 @anchor{dump_image}
4397 @deffn Command {dump_image} filename address size
4398 Dump @var{size} bytes of target memory starting at @var{address} to the
4399 binary file named @var{filename}.
4400 @end deffn
4401
4402 @deffn Command {fast_load}
4403 Loads an image stored in memory by @command{fast_load_image} to the
4404 current target. Must be preceeded by fast_load_image.
4405 @end deffn
4406
4407 @deffn Command {fast_load_image} filename address [@option{bin}|@option{ihex}|@option{elf}]
4408 Normally you should be using @command{load_image} or GDB load. However, for
4409 testing purposes or when I/O overhead is significant(OpenOCD running on an embedded
4410 host), storing the image in memory and uploading the image to the target
4411 can be a way to upload e.g. multiple debug sessions when the binary does not change.
4412 Arguments are the same as @command{load_image}, but the image is stored in OpenOCD host
4413 memory, i.e. does not affect target.  This approach is also useful when profiling
4414 target programming performance as I/O and target programming can easily be profiled
4415 separately.
4416 @end deffn
4417
4418 @anchor{load_image}
4419 @deffn Command {load_image} filename address [@option{bin}|@option{ihex}|@option{elf}]
4420 Load image from file @var{filename} to target memory at @var{address}.
4421 The file format may optionally be specified
4422 (@option{bin}, @option{ihex}, or @option{elf})
4423 @end deffn
4424
4425 @deffn Command {verify_image} filename address [@option{bin}|@option{ihex}|@option{elf}]
4426 Verify @var{filename} against target memory starting at @var{address}.
4427 The file format may optionally be specified
4428 (@option{bin}, @option{ihex}, or @option{elf})
4429 This will first attempt a comparison using a CRC checksum, if this fails it will try a binary compare.
4430 @end deffn
4431
4432
4433 @section Breakpoint and Watchpoint commands
4434 @cindex breakpoint
4435 @cindex watchpoint
4436
4437 CPUs often make debug modules accessible through JTAG, with
4438 hardware support for a handful of code breakpoints and data
4439 watchpoints.
4440 In addition, CPUs almost always support software breakpoints.
4441
4442 @deffn Command {bp} [address len [@option{hw}]]
4443 With no parameters, lists all active breakpoints.
4444 Else sets a breakpoint on code execution starting
4445 at @var{address} for @var{length} bytes.
4446 This is a software breakpoint, unless @option{hw} is specified
4447 in which case it will be a hardware breakpoint.
4448
4449 (@xref{arm9tdmi vector_catch}, or @pxref{xscale vector_catch},
4450 for similar mechanisms that do not consume hardware breakpoints.)
4451 @end deffn
4452
4453 @deffn Command {rbp} address
4454 Remove the breakpoint at @var{address}.
4455 @end deffn
4456
4457 @deffn Command {rwp} address
4458 Remove data watchpoint on @var{address}
4459 @end deffn
4460
4461 @deffn Command {wp} [address len [(@option{r}|@option{w}|@option{a}) [value [mask]]]]
4462 With no parameters, lists all active watchpoints.
4463 Else sets a data watchpoint on data from @var{address} for @var{length} bytes.
4464 The watch point is an "access" watchpoint unless
4465 the @option{r} or @option{w} parameter is provided,
4466 defining it as respectively a read or write watchpoint.
4467 If a @var{value} is provided, that value is used when determining if
4468 the watchpoint should trigger.  The value may be first be masked
4469 using @var{mask} to mark ``don't care'' fields.
4470 @end deffn
4471
4472 @section Misc Commands
4473 @cindex profiling
4474
4475 @deffn Command {profile} seconds filename
4476 Profiling samples the CPU's program counter as quickly as possible,
4477 which is useful for non-intrusive stochastic profiling.
4478 Saves up to 10000 sampines in @file{filename} using ``gmon.out'' format.
4479 @end deffn
4480
4481 @node Architecture and Core Commands
4482 @chapter Architecture and Core Commands
4483 @cindex Architecture Specific Commands
4484 @cindex Core Specific Commands
4485
4486 Most CPUs have specialized JTAG operations to support debugging.
4487 OpenOCD packages most such operations in its standard command framework.
4488 Some of those operations don't fit well in that framework, so they are
4489 exposed here as architecture or implementation (core) specific commands.
4490
4491 @anchor{ARM Tracing}
4492 @section ARM Tracing
4493 @cindex ETM
4494 @cindex ETB
4495
4496 CPUs based on ARM cores may include standard tracing interfaces,
4497 based on an ``Embedded Trace Module'' (ETM) which sends voluminous
4498 address and data bus trace records to a ``Trace Port''.
4499
4500 @itemize
4501 @item
4502 Development-oriented boards will sometimes provide a high speed
4503 trace connector for collecting that data, when the particular CPU
4504 supports such an interface.
4505 (The standard connector is a 38-pin Mictor, with both JTAG
4506 and trace port support.)
4507 Those trace connectors are supported by higher end JTAG adapters
4508 and some logic analyzer modules; frequently those modules can
4509 buffer several megabytes of trace data.
4510 Configuring an ETM coupled to such an external trace port belongs
4511 in the board-specific configuration file.
4512 @item
4513 If the CPU doesn't provide an external interface, it probably
4514 has an ``Embedded Trace Buffer'' (ETB) on the chip, which is a
4515 dedicated SRAM.  4KBytes is one common ETB size.
4516 Configuring an ETM coupled only to an ETB belongs in the CPU-specific
4517 (target) configuration file, since it works the same on all boards.
4518 @end itemize
4519
4520 ETM support in OpenOCD doesn't seem to be widely used yet.
4521
4522 @quotation Issues
4523 ETM support may be buggy, and at least some @command{etm config}
4524 parameters should be detected by asking the ETM for them.
4525 It seems like a GDB hookup should be possible,
4526 as well as triggering trace on specific events
4527 (perhaps @emph{handling IRQ 23} or @emph{calls foo()}).
4528 There should be GUI tools to manipulate saved trace data and help
4529 analyse it in conjunction with the source code.
4530 It's unclear how much of a common interface is shared
4531 with the current XScale trace support, or should be
4532 shared with eventual Nexus-style trace module support.
4533 @end quotation
4534
4535 @subsection ETM Configuration
4536 ETM setup is coupled with the trace port driver configuration.
4537
4538 @deffn {Config Command} {etm config} target width mode clocking driver
4539 Declares the ETM associated with @var{target}, and associates it
4540 with a given trace port @var{driver}.  @xref{Trace Port Drivers}.
4541
4542 Several of the parameters must reflect the trace port configuration.
4543 The @var{width} must be either 4, 8, or 16.
4544 The @var{mode} must be @option{normal}, @option{multiplexted},
4545 or @option{demultiplexted}.
4546 The @var{clocking} must be @option{half} or @option{full}.
4547
4548 @quotation Note
4549 You can see the ETM registers using the @command{reg} command, although
4550 not all of those possible registers are present in every ETM.
4551 @end quotation
4552 @end deffn
4553
4554 @deffn Command {etm info}
4555 Displays information about the current target's ETM.
4556 @end deffn
4557
4558 @deffn Command {etm status}
4559 Displays status of the current target's ETM:
4560 is the ETM idle, or is it collecting data?
4561 Did trace data overflow?
4562 Was it triggered?
4563 @end deffn
4564
4565 @deffn Command {etm tracemode} [type context_id_bits cycle_accurate branch_output]
4566 Displays what data that ETM will collect.
4567 If arguments are provided, first configures that data.
4568 When the configuration changes, tracing is stopped
4569 and any buffered trace data is invalidated.
4570
4571 @itemize
4572 @item @var{type} ... one of
4573 @option{none} (save nothing),
4574 @option{data} (save data),
4575 @option{address} (save addresses),
4576 @option{all} (save data and addresses)
4577 @item @var{context_id_bits} ... 0, 8, 16, or 32
4578 @item @var{cycle_accurate} ...  @option{enable} or @option{disable}
4579 @item @var{branch_output} ...  @option{enable} or @option{disable}
4580 @end itemize
4581 @end deffn
4582
4583 @deffn Command {etm trigger_percent} percent
4584 @emph{Buggy and effectively a NOP ... @var{percent} from 2..100}
4585 @end deffn
4586
4587 @subsection ETM Trace Operation
4588
4589 After setting up the ETM, you can use it to collect data.
4590 That data can be exported to files for later analysis.
4591 It can also be parsed with OpenOCD, for basic sanity checking.
4592
4593 @deffn Command {etm analyze}
4594 Reads trace data into memory, if it wasn't already present.
4595 Decodes and prints the data that was collected.
4596 @end deffn
4597
4598 @deffn Command {etm dump} filename
4599 Stores the captured trace data in @file{filename}.
4600 @end deffn
4601
4602 @deffn Command {etm image} filename [base_address] [type]
4603 Opens an image file.
4604 @end deffn
4605
4606 @deffn Command {etm load} filename
4607 Loads captured trace data from @file{filename}.
4608 @end deffn
4609
4610 @deffn Command {etm start}
4611 Starts trace data collection.
4612 @end deffn
4613
4614 @deffn Command {etm stop}
4615 Stops trace data collection.
4616 @end deffn
4617
4618 @anchor{Trace Port Drivers}
4619 @subsection Trace Port Drivers
4620
4621 To use an ETM trace port it must be associated with a driver.
4622
4623 @deffn {Trace Port Driver} dummy
4624 Use the @option{dummy} driver if you are configuring an ETM that's