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