Marcel Jost <marcel.jost@bfh.ch>:
[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{luminary_icdi}
543 @* See: @url{http://www.luminarymicro.com} - Luminary In-Circuit Debug Interface (ICDI) Board, included in the Stellaris LM3S9B90 and LM3S9B92 Evaluation Kits.
544 @item @b{olimex-jtag}
545 @* See: @url{http://www.olimex.com}
546 @item @b{flyswatter}
547 @* See: @url{http://www.tincantools.com}
548 @item @b{turtelizer2}
549 @* See:
550 @uref{http://www.ethernut.de/en/hardware/turtelizer/index.html, Turtelizer 2}, or
551 @url{http://www.ethernut.de}
552 @item @b{comstick}
553 @* Link: @url{http://www.hitex.com/index.php?id=383}
554 @item @b{stm32stick}
555 @* Link @url{http://www.hitex.com/stm32-stick}
556 @item @b{axm0432_jtag}
557 @* Axiom AXM-0432 Link @url{http://www.axman.com}
558 @item @b{cortino}
559 @* Link @url{http://www.hitex.com/index.php?id=cortino}
560 @end itemize
561
562 @section USB JLINK based
563 There are several OEM versions of the Segger @b{JLINK} adapter. It is
564 an example of a micro controller based JTAG adapter, it uses an
565 AT91SAM764 internally.
566
567 @itemize @bullet
568 @item @b{ATMEL SAMICE} Only works with ATMEL chips!
569 @* Link: @url{http://www.atmel.com/dyn/products/tools_card.asp?tool_id=3892}
570 @item @b{SEGGER JLINK}
571 @* Link: @url{http://www.segger.com/jlink.html}
572 @item @b{IAR J-Link}
573 @* Link: @url{http://www.iar.com/website1/1.0.1.0/369/1/index.php}
574 @end itemize
575
576 @section USB RLINK based
577 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.
578
579 @itemize @bullet
580 @item @b{Raisonance RLink}
581 @* Link: @url{http://www.raisonance.com/products/RLink.php}
582 @item @b{STM32 Primer}
583 @* Link: @url{http://www.stm32circle.com/resources/stm32primer.php}
584 @item @b{STM32 Primer2}
585 @* Link: @url{http://www.stm32circle.com/resources/stm32primer2.php}
586 @end itemize
587
588 @section USB Other
589 @itemize @bullet
590 @item @b{USBprog}
591 @* Link: @url{http://www.embedded-projects.net/usbprog} - which uses an Atmel MEGA32 and a UBN9604
592
593 @item @b{USB - Presto} 
594 @* Link: @url{http://tools.asix.net/prg_presto.htm}
595
596 @item @b{Versaloon-Link}
597 @* Link: @url{http://www.simonqian.com/en/Versaloon}
598
599 @item @b{ARM-JTAG-EW}
600 @* Link: @url{http://www.olimex.com/dev/arm-jtag-ew.html}
601 @end itemize
602
603 @section IBM PC Parallel Printer Port Based
604
605 The two well known ``JTAG Parallel Ports'' cables are the Xilnx DLC5
606 and the MacGraigor Wiggler. There are many clones and variations of
607 these on the market.
608
609 @itemize @bullet
610
611 @item @b{Wiggler} - There are many clones of this.
612 @* Link: @url{http://www.macraigor.com/wiggler.htm}
613
614 @item @b{DLC5} - From XILINX - There are many clones of this
615 @* Link: Search the web for: ``XILINX DLC5'' - it is no longer
616 produced, PDF schematics are easily found and it is easy to make.
617
618 @item @b{Amontec - JTAG Accelerator}
619 @* Link: @url{http://www.amontec.com/jtag_accelerator.shtml}
620
621 @item @b{GW16402}
622 @* Link: @url{http://www.gateworks.com/products/avila_accessories/gw16042.php}
623
624 @item @b{Wiggler2}
625 @*@uref{http://www.ccac.rwth-aachen.de/@/~michaels/@/index.php/hardware/@/armjtag,
626 Improved parallel-port wiggler-style JTAG adapter}
627
628 @item @b{Wiggler_ntrst_inverted}
629 @* Yet another variation - See the source code, src/jtag/parport.c
630
631 @item @b{old_amt_wiggler}
632 @* Unknown - probably not on the market today
633
634 @item @b{arm-jtag}
635 @* Link: Most likely @url{http://www.olimex.com/dev/arm-jtag.html} [another wiggler clone]
636
637 @item @b{chameleon}
638 @* Link: @url{http://www.amontec.com/chameleon.shtml}
639
640 @item @b{Triton}
641 @* Unknown.
642
643 @item @b{Lattice}
644 @* ispDownload from Lattice Semiconductor
645 @url{http://www.latticesemi.com/lit/docs/@/devtools/dlcable.pdf}
646
647 @item @b{flashlink}
648 @* From ST Microsystems;
649 @uref{http://www.st.com/stonline/@/products/literature/um/7889.pdf,
650 FlashLINK JTAG programing cable for PSD and uPSD}
651
652 @end itemize
653
654 @section Other...
655 @itemize @bullet
656
657 @item @b{ep93xx}
658 @* An EP93xx based Linux machine using the GPIO pins directly.
659
660 @item @b{at91rm9200}
661 @* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
662
663 @end itemize
664
665 @node About JIM-Tcl
666 @chapter About JIM-Tcl
667 @cindex JIM Tcl
668 @cindex tcl
669
670 OpenOCD includes a small ``Tcl Interpreter'' known as JIM-Tcl.
671 This programming language provides a simple and extensible
672 command interpreter.
673
674 All commands presented in this Guide are extensions to JIM-Tcl.
675 You can use them as simple commands, without needing to learn
676 much of anything about Tcl.
677 Alternatively, can write Tcl programs with them.
678
679 You can learn more about JIM at its website,  @url{http://jim.berlios.de}.
680
681 @itemize @bullet
682 @item @b{JIM vs. Tcl}
683 @* JIM-TCL is a stripped down version of the well known Tcl language,
684 which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
685 fewer features. JIM-Tcl is a single .C file and a single .H file and
686 implements the basic Tcl command set. In contrast: Tcl 8.6 is a
687 4.2 MB .zip file containing 1540 files.
688
689 @item @b{Missing Features}
690 @* Our practice has been: Add/clone the real Tcl feature if/when
691 needed. We welcome JIM Tcl improvements, not bloat.
692
693 @item @b{Scripts}
694 @* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
695 command interpreter today is a mixture of (newer)
696 JIM-Tcl commands, and (older) the orginal command interpreter.
697
698 @item @b{Commands}
699 @* At the OpenOCD telnet command line (or via the GDB mon command) one
700 can type a Tcl for() loop, set variables, etc.
701 Some of the commands documented in this guide are implemented
702 as Tcl scripts, from a @file{startup.tcl} file internal to the server.
703
704 @item @b{Historical Note}
705 @* JIM-Tcl was introduced to OpenOCD in spring 2008.
706
707 @item @b{Need a crash course in Tcl?}
708 @*@xref{Tcl Crash Course}.
709 @end itemize
710
711 @node Running
712 @chapter Running
713 @cindex command line options
714 @cindex logfile
715 @cindex directory search
716
717 The @option{--help} option shows:
718 @verbatim
719 bash$ openocd --help
720
721 --help       | -h       display this help
722 --version    | -v       display OpenOCD version
723 --file       | -f       use configuration file <name>
724 --search     | -s       dir to search for config files and scripts
725 --debug      | -d       set debug level <0-3>
726 --log_output | -l       redirect log output to file <name>
727 --command    | -c       run <command>
728 --pipe       | -p       use pipes when talking to gdb
729 @end verbatim
730
731 By default OpenOCD reads the file configuration file ``openocd.cfg''
732 in the current directory.  To specify a different (or multiple)
733 configuration file, you can use the ``-f'' option. For example:
734
735 @example
736   openocd -f config1.cfg -f config2.cfg -f config3.cfg
737 @end example
738
739 Once started, OpenOCD runs as a daemon, waiting for connections from
740 clients (Telnet, GDB, Other).
741
742 If you are having problems, you can enable internal debug messages via
743 the ``-d'' option.
744
745 Also it is possible to interleave JIM-Tcl commands w/config scripts using the
746 @option{-c} command line switch.
747
748 To enable debug output (when reporting problems or working on OpenOCD
749 itself), use the @option{-d} command line switch. This sets the
750 @option{debug_level} to "3", outputting the most information,
751 including debug messages. The default setting is "2", outputting only
752 informational messages, warnings and errors. You can also change this
753 setting from within a telnet or gdb session using @command{debug_level
754 <n>} (@pxref{debug_level}).
755
756 You can redirect all output from the daemon to a file using the
757 @option{-l <logfile>} switch.
758
759 Search paths for config/script files can be added to OpenOCD by using
760 the @option{-s <search>} switch. The current directory and the OpenOCD
761 target library is in the search path by default.
762
763 For details on the @option{-p} option. @xref{Connecting to GDB}.
764
765 Note! OpenOCD will launch the GDB & telnet server even if it can not
766 establish a connection with the target. In general, it is possible for
767 the JTAG controller to be unresponsive until the target is set up
768 correctly via e.g. GDB monitor commands in a GDB init script.
769
770 @node OpenOCD Project Setup
771 @chapter OpenOCD Project Setup
772
773 To use OpenOCD with your development projects, you need to do more than
774 just connecting the JTAG adapter hardware (dongle) to your development board
775 and then starting the OpenOCD server.
776 You also need to configure that server so that it knows
777 about that adapter and board, and helps your work.
778
779 @section Hooking up the JTAG Adapter
780
781 Today's most common case is a dongle with a JTAG cable on one side
782 (such as a ribbon cable with a 10-pin or 20-pin IDC connector)
783 and a USB cable on the other.
784 Instead of USB, some cables use Ethernet;
785 older ones may use a PC parallel port, or even a serial port.
786
787 @enumerate
788 @item @emph{Start with power to your target board turned off},
789 and nothing connected to your JTAG adapter.
790 If you're particularly paranoid, unplug power to the board.
791 It's important to have the ground signal properly set up,
792 unless you are using a JTAG adapter which provides
793 galvanic isolation between the target board and the
794 debugging host.
795
796 @item @emph{Be sure it's the right kind of JTAG connector.}
797 If your dongle has a 20-pin ARM connector, you need some kind
798 of adapter (or octopus, see below) to hook it up to
799 boards using 14-pin or 10-pin connectors ... or to 20-pin
800 connectors which don't use ARM's pinout.
801
802 In the same vein, make sure the voltage levels are compatible.
803 Not all JTAG adapters have the level shifters needed to work
804 with 1.2 Volt boards.
805
806 @item @emph{Be certain the cable is properly oriented} or you might
807 damage your board.  In most cases there are only two possible
808 ways to connect the cable.
809 Connect the JTAG cable from your adapter to the board.
810 Be sure it's firmly connected.
811
812 In the best case, the connector is keyed to physically
813 prevent you from inserting it wrong.
814 This is most often done using a slot on the board's male connector
815 housing, which must match a key on the JTAG cable's female connector.
816 If there's no housing, then you must look carefully and
817 make sure pin 1 on the cable hooks up to pin 1 on the board.
818 Ribbon cables are frequently all grey except for a wire on one
819 edge, which is red.  The red wire is pin 1.
820
821 Sometimes dongles provide cables where one end is an ``octopus'' of
822 color coded single-wire connectors, instead of a connector block.
823 These are great when converting from one JTAG pinout to another,
824 but are tedious to set up.
825 Use these with connector pinout diagrams to help you match up the
826 adapter signals to the right board pins.
827
828 @item @emph{Connect the adapter's other end} once the JTAG cable is connected.
829 A USB, parallel, or serial port connector will go to the host which
830 you are using to run OpenOCD.
831 For Ethernet, consult the documentation and your network administrator.
832
833 For USB based JTAG adapters you have an easy sanity check at this point:
834 does the host operating system see the JTAG adapter?
835
836 @item @emph{Connect the adapter's power supply, if needed.}
837 This step is primarily for non-USB adapters,
838 but sometimes USB adapters need extra power.
839
840 @item @emph{Power up the target board.}
841 Unless you just let the magic smoke escape,
842 you're now ready to set up the OpenOCD server
843 so you can use JTAG to work with that board.
844
845 @end enumerate
846
847 Talk with the OpenOCD server using
848 telnet (@code{telnet localhost 4444} on many systems) or GDB.
849 @xref{GDB and OpenOCD}.
850
851 @section Project Directory
852
853 There are many ways you can configure OpenOCD and start it up.
854
855 A simple way to organize them all involves keeping a
856 single directory for your work with a given board.
857 When you start OpenOCD from that directory,
858 it searches there first for configuration files, scripts,
859 and for code you upload to the target board.
860 It is also the natural place to write files,
861 such as log files and data you download from the board.
862
863 @section Configuration Basics
864
865 There are two basic ways of configuring OpenOCD, and
866 a variety of ways you can mix them.
867 Think of the difference as just being how you start the server:
868
869 @itemize
870 @item Many @option{-f file} or @option{-c command} options on the command line
871 @item No options, but a @dfn{user config file}
872 in the current directory named @file{openocd.cfg}
873 @end itemize
874
875 Here is an example @file{openocd.cfg} file for a setup
876 using a Signalyzer FT2232-based JTAG adapter to talk to
877 a board with an Atmel AT91SAM7X256 microcontroller:
878
879 @example
880 source [find interface/signalyzer.cfg]
881
882 # GDB can also flash my flash!
883 gdb_memory_map enable
884 gdb_flash_program enable
885
886 source [find target/sam7x256.cfg]
887 @end example
888
889 Here is the command line equivalent of that configuration:
890
891 @example
892 openocd -f interface/signalyzer.cfg \
893         -c "gdb_memory_map enable" \
894         -c "gdb_flash_program enable" \
895         -f target/sam7x256.cfg
896 @end example
897
898 You could wrap such long command lines in shell scripts,
899 each supporting a different development task.
900 One might re-flash the board with a specific firmware version.
901 Another might set up a particular debugging or run-time environment.
902
903 Here we will focus on the simpler solution:  one user config
904 file, including basic configuration plus any TCL procedures
905 to simplify your work.
906
907 @section User Config Files
908 @cindex config file, user
909 @cindex user config file
910 @cindex config file, overview
911
912 A user configuration file ties together all the parts of a project
913 in one place.
914 One of the following will match your situation best:
915
916 @itemize
917 @item Ideally almost everything comes from configuration files
918 provided by someone else.
919 For example, OpenOCD distributes a @file{scripts} directory
920 (probably in @file{/usr/share/openocd/scripts} on Linux).
921 Board and tool vendors can provide these too, as can individual
922 user sites; the @option{-s} command line option lets you say
923 where to find these files.  (@xref{Running}.)
924 The AT91SAM7X256 example above works this way.
925
926 Three main types of non-user configuration file each have their
927 own subdirectory in the @file{scripts} directory:
928
929 @enumerate
930 @item @b{interface} -- one for each kind of JTAG adapter/dongle
931 @item @b{board} -- one for each different board
932 @item @b{target} -- the chips which integrate CPUs and other JTAG TAPs
933 @end enumerate
934
935 Best case:  include just two files, and they handle everything else.
936 The first is an interface config file.
937 The second is board-specific, and it sets up the JTAG TAPs and
938 their GDB targets (by deferring to some @file{target.cfg} file),
939 declares all flash memory, and leaves you nothing to do except
940 meet your deadline:
941
942 @example
943 source [find interface/olimex-jtag-tiny.cfg]
944 source [find board/csb337.cfg]
945 @end example
946
947 Boards with a single microcontroller often won't need more
948 than the target config file, as in the AT91SAM7X256 example.
949 That's because there is no external memory (flash, DDR RAM), and
950 the board differences are encapsulated by application code.
951
952 @item You can often reuse some standard config files but
953 need to write a few new ones, probably a @file{board.cfg} file.
954 You will be using commands described later in this User's Guide,
955 and working with the guidelines in the next chapter.
956
957 For example, there may be configuration files for your JTAG adapter
958 and target chip, but you need a new board-specific config file
959 giving access to your particular flash chips.
960 Or you might need to write another target chip configuration file
961 for a new chip built around the Cortex M3 core.
962
963 @quotation Note
964 When you write new configuration files, please submit
965 them for inclusion in the next OpenOCD release.
966 For example, a @file{board/newboard.cfg} file will help the
967 next users of that board, and a @file{target/newcpu.cfg}
968 will help support users of any board using that chip.
969 @end quotation
970
971 @item
972 You may may need to write some C code.
973 It may be as simple as a supporting a new new ft2232 or parport
974 based dongle; a bit more involved, like a NAND or NOR flash
975 controller driver; or a big piece of work like supporting
976 a new chip architecture.
977 @end itemize
978
979 Reuse the existing config files when you can.
980 Look first in the @file{scripts/boards} area, then @file{scripts/targets}.
981 You may find a board configuration that's a good example to follow.
982
983 When you write config files, separate the reusable parts
984 (things every user of that interface, chip, or board needs)
985 from ones specific to your environment and debugging approach.
986
987 For example, a @code{gdb-attach} event handler that invokes
988 the @command{reset init} command will interfere with debugging
989 early boot code, which performs some of the same actions
990 that the @code{reset-init} event handler does.
991 Likewise, the @command{arm9tdmi vector_catch} command (or
992 its @command{xscale vector_catch} sibling) can be a timesaver
993 during some debug sessions, but don't make everyone use that either.
994 Keep those kinds of debugging aids in your user config file,
995 along with messaging and tracing setup.
996 (@xref{Software Debug Messages and Tracing}.)
997
998 TCP/IP port configuration is another example of something which
999 is environment-specific, and should only appear in
1000 a user config file.  @xref{TCP/IP Ports}.
1001
1002 @section Project-Specific Utilities
1003
1004 A few project-specific utility
1005 routines may well speed up your work.
1006 Write them, and keep them in your project's user config file.
1007
1008 For example, if you are making a boot loader work on a
1009 board, it's nice to be able to debug the ``after it's
1010 loaded to RAM'' parts separately from the finicky early
1011 code which sets up the DDR RAM controller and clocks.
1012 A script like this one, or a more GDB-aware sibling,
1013 may help:
1014
1015 @example
1016 proc ramboot @{ @} @{
1017     # Reset, running the target's "reset-init" scripts
1018     # to initialize clocks and the DDR RAM controller.
1019     # Leave the CPU halted.
1020     reset init
1021
1022     # Load CONFIG_SKIP_LOWLEVEL_INIT version into DDR RAM.
1023     load_image u-boot.bin 0x20000000
1024
1025     # Start running.
1026     resume 0x20000000
1027 @}
1028 @end example
1029
1030 Then once that code is working you will need to make it
1031 boot from NOR flash; a different utility would help.
1032 Alternatively, some developers write to flash using GDB.
1033 (You might use a similar script if you're working with a flash
1034 based microcontroller application instead of a boot loader.)
1035
1036 @example
1037 proc newboot @{ @} @{
1038     # Reset, leaving the CPU halted.  The "reset-init" event
1039     # proc gives faster access to the CPU and to NOR flash;
1040     # "reset halt" would be slower.
1041     reset init
1042
1043     # Write standard version of U-Boot into the first two
1044     # sectors of NOR flash ... the standard version should
1045     # do the same lowlevel init as "reset-init".
1046     flash protect 0 0 1 off
1047     flash erase_sector 0 0 1
1048     flash write_bank 0 u-boot.bin 0x0
1049     flash protect 0 0 1 on
1050
1051     # Reboot from scratch using that new boot loader.
1052     reset run
1053 @}
1054 @end example
1055
1056 You may need more complicated utility procedures when booting
1057 from NAND.
1058 That often involves an extra bootloader stage,
1059 running from on-chip SRAM to perform DDR RAM setup so it can load
1060 the main bootloader code (which won't fit into that SRAM).
1061
1062 Other helper scripts might be used to write production system images,
1063 involving considerably more than just a three stage bootloader.
1064
1065
1066 @node Config File Guidelines
1067 @chapter Config File Guidelines
1068
1069 This chapter is aimed at any user who needs to write a config file,
1070 including developers and integrators of OpenOCD and any user who
1071 needs to get a new board working smoothly.
1072 It provides guidelines for creating those files.
1073
1074 You should find the following directories under @t{$(INSTALLDIR)/scripts}:
1075
1076 @itemize @bullet
1077 @item @file{interface} ...
1078 think JTAG Dongle. Files that configure JTAG adapters go here.
1079 @item @file{board} ...
1080 think Circuit Board, PWA, PCB, they go by many names.  Board files
1081 contain initialization items that are specific to a board.  For
1082 example, the SDRAM initialization sequence for the board, or the type
1083 of external flash and what address it uses.  Any initialization
1084 sequence to enable that external flash or SDRAM should be found in the
1085 board file. Boards may also contain multiple targets:  two CPUs; or
1086 a CPU and an FPGA or CPLD.
1087 @item @file{target} ...
1088 think chip. The ``target'' directory represents the JTAG TAPs
1089 on a chip
1090 which OpenOCD should control, not a board. Two common types of targets
1091 are ARM chips and FPGA or CPLD chips.
1092 When a chip has multiple TAPs (maybe it has both ARM and DSP cores),
1093 the target config file defines all of them.
1094 @end itemize
1095
1096 The @file{openocd.cfg} user config
1097 file may override features in any of the above files by
1098 setting variables before sourcing the target file, or by adding
1099 commands specific to their situation.
1100
1101 @section Interface Config Files
1102
1103 The user config file
1104 should be able to source one of these files with a command like this:
1105
1106 @example
1107 source [find interface/FOOBAR.cfg]
1108 @end example
1109
1110 A preconfigured interface file should exist for every interface in use
1111 today, that said, perhaps some interfaces have only been used by the
1112 sole developer who created it.
1113
1114 A separate chapter gives information about how to set these up.
1115 @xref{Interface - Dongle Configuration}.
1116 Read the OpenOCD source code if you have a new kind of hardware interface
1117 and need to provide a driver for it.
1118
1119 @section Board Config Files
1120 @cindex config file, board
1121 @cindex board config file
1122
1123 The user config file
1124 should be able to source one of these files with a command like this:
1125
1126 @example
1127 source [find board/FOOBAR.cfg]
1128 @end example
1129
1130 The point of a board config file is to package everything
1131 about a given board that user config files need to know.
1132 In summary the board files should contain (if present)
1133
1134 @enumerate
1135 @item One or more @command{source [target/...cfg]} statements
1136 @item NOR flash configuration (@pxref{NOR Configuration})
1137 @item NAND flash configuration (@pxref{NAND Configuration})
1138 @item Target @code{reset} handlers for SDRAM and I/O configuration
1139 @item JTAG adapter reset configuration (@pxref{Reset Configuration})
1140 @item All things that are not ``inside a chip''
1141 @end enumerate
1142
1143 Generic things inside target chips belong in target config files,
1144 not board config files.  So for example a @code{reset-init} event
1145 handler should know board-specific oscillator and PLL parameters,
1146 which it passes to target-specific utility code.
1147
1148 The most complex task of a board config file is creating such a
1149 @code{reset-init} event handler.
1150 Define those handlers last, after you verify the rest of the board
1151 configuration works.
1152
1153 @subsection Communication Between Config files
1154
1155 In addition to target-specific utility code, another way that
1156 board and target config files communicate is by following a
1157 convention on how to use certain variables.
1158
1159 The full Tcl/Tk language supports ``namespaces'', but JIM-Tcl does not.
1160 Thus the rule we follow in OpenOCD is this: Variables that begin with
1161 a leading underscore are temporary in nature, and can be modified and
1162 used at will within a target configuration file.
1163
1164 Complex board config files can do the things like this,
1165 for a board with three chips:
1166
1167 @example
1168 # Chip #1: PXA270 for network side, big endian
1169 set CHIPNAME network
1170 set ENDIAN big
1171 source [find target/pxa270.cfg]
1172 # on return: _TARGETNAME = network.cpu
1173 # other commands can refer to the "network.cpu" target.
1174 $_TARGETNAME configure .... events for this CPU..
1175
1176 # Chip #2: PXA270 for video side, little endian
1177 set CHIPNAME video
1178 set ENDIAN little
1179 source [find target/pxa270.cfg]
1180 # on return: _TARGETNAME = video.cpu
1181 # other commands can refer to the "video.cpu" target.
1182 $_TARGETNAME configure .... events for this CPU..
1183
1184 # Chip #3: Xilinx FPGA for glue logic
1185 set CHIPNAME xilinx
1186 unset ENDIAN
1187 source [find target/spartan3.cfg]
1188 @end example
1189
1190 That example is oversimplified because it doesn't show any flash memory,
1191 or the @code{reset-init} event handlers to initialize external DRAM
1192 or (assuming it needs it) load a configuration into the FPGA.
1193 Such features are usually needed for low-level work with many boards,
1194 where ``low level'' implies that the board initialization software may
1195 not be working.  (That's a common reason to need JTAG tools.  Another
1196 is to enable working with microcontroller-based systems, which often
1197 have no debugging support except a JTAG connector.)
1198
1199 Target config files may also export utility functions to board and user
1200 config files.  Such functions should use name prefixes, to help avoid
1201 naming collisions.
1202
1203 Board files could also accept input variables from user config files.
1204 For example, there might be a @code{J4_JUMPER} setting used to identify
1205 what kind of flash memory a development board is using, or how to set
1206 up other clocks and peripherals.
1207
1208 @subsection Variable Naming Convention
1209 @cindex variable names
1210
1211 Most boards have only one instance of a chip.
1212 However, it should be easy to create a board with more than
1213 one such chip (as shown above).
1214 Accordingly, we encourage these conventions for naming
1215 variables associated with different @file{target.cfg} files,
1216 to promote consistency and
1217 so that board files can override target defaults.
1218
1219 Inputs to target config files include:
1220
1221 @itemize @bullet
1222 @item @code{CHIPNAME} ...
1223 This gives a name to the overall chip, and is used as part of
1224 tap identifier dotted names.
1225 While the default is normally provided by the chip manufacturer,
1226 board files may need to distinguish between instances of a chip.
1227 @item @code{ENDIAN} ...
1228 By default @option{little} - although chips may hard-wire @option{big}.
1229 Chips that can't change endianness don't need to use this variable.
1230 @item @code{CPUTAPID} ...
1231 When OpenOCD examines the JTAG chain, it can be told verify the
1232 chips against the JTAG IDCODE register.
1233 The target file will hold one or more defaults, but sometimes the
1234 chip in a board will use a different ID (perhaps a newer revision).
1235 @end itemize
1236
1237 Outputs from target config files include:
1238
1239 @itemize @bullet
1240 @item @code{_TARGETNAME} ...
1241 By convention, this variable is created by the target configuration
1242 script. The board configuration file may make use of this variable to
1243 configure things like a ``reset init'' script, or other things
1244 specific to that board and that target.
1245 If the chip has 2 targets, the names are @code{_TARGETNAME0},
1246 @code{_TARGETNAME1}, ... etc.
1247 @end itemize
1248
1249 @subsection The reset-init Event Handler
1250 @cindex event, reset-init
1251 @cindex reset-init handler
1252
1253 Board config files run in the OpenOCD configuration stage;
1254 they can't use TAPs or targets, since they haven't been
1255 fully set up yet.
1256 This means you can't write memory or access chip registers;
1257 you can't even verify that a flash chip is present.
1258 That's done later in event handlers, of which the target @code{reset-init}
1259 handler is one of the most important.
1260
1261 Except on microcontrollers, the basic job of @code{reset-init} event
1262 handlers is setting up flash and DRAM, as normally handled by boot loaders.
1263 Microcontrollers rarely use boot loaders; they run right out of their
1264 on-chip flash and SRAM memory.  But they may want to use one of these
1265 handlers too, if just for developer convenience.
1266
1267 @quotation Note
1268 Because this is so very board-specific, and chip-specific, no examples
1269 are included here.
1270 Instead, look at the board config files distributed with OpenOCD.
1271 If you have a boot loader, its source code may also be useful.
1272 @end quotation
1273
1274 Some of this code could probably be shared between different boards.
1275 For example, setting up a DRAM controller often doesn't differ by
1276 much except the bus width (16 bits or 32?) and memory timings, so a
1277 reusable TCL procedure loaded by the @file{target.cfg} file might take
1278 those as parameters.
1279 Similarly with oscillator, PLL, and clock setup;
1280 and disabling the watchdog.
1281 Structure the code cleanly, and provide comments to help
1282 the next developer doing such work.
1283 (@emph{You might be that next person} trying to reuse init code!)
1284
1285 The last thing normally done in a @code{reset-init} handler is probing
1286 whatever flash memory was configured.  For most chips that needs to be
1287 done while the associated target is halted, either because JTAG memory
1288 access uses the CPU or to prevent conflicting CPU access.
1289
1290 @subsection JTAG Clock Rate
1291
1292 Before your @code{reset-init} handler has set up
1293 the PLLs and clocking, you may need to use
1294 a low JTAG clock rate; then you'd increase it later.
1295 (The rule of thumb for ARM-based processors is 1/8 the CPU clock.)
1296 If the board supports adaptive clocking, use the @command{jtag_rclk}
1297 command, in case your board is used with JTAG adapter which
1298 also supports it.  Otherwise use @command{jtag_khz}.
1299 Set the slow rate at the beginning of the reset sequence,
1300 and the faster rate as soon as the clocks are at full speed.
1301
1302 @section Target Config Files
1303 @cindex config file, target
1304 @cindex target config file
1305
1306 Board config files communicate with target config files using
1307 naming conventions as described above, and may source one or
1308 more target config files like this:
1309
1310 @example
1311 source [find target/FOOBAR.cfg]
1312 @end example
1313
1314 The point of a target config file is to package everything
1315 about a given chip that board config files need to know.
1316 In summary the target files should contain
1317
1318 @enumerate
1319 @item Set defaults
1320 @item Add TAPs to the scan chain
1321 @item Add CPU targets (includes GDB support)
1322 @item CPU/Chip/CPU-Core specific features
1323 @item On-Chip flash
1324 @end enumerate
1325
1326 As a rule of thumb, a target file sets up only one chip.
1327 For a microcontroller, that will often include a single TAP,
1328 which is a CPU needing a GDB target, and its on-chip flash.
1329
1330 More complex chips may include multiple TAPs, and the target
1331 config file may need to define them all before OpenOCD
1332 can talk to the chip.
1333 For example, some phone chips have JTAG scan chains that include
1334 an ARM core for operating system use, a DSP,
1335 another ARM core embedded in an image processing engine,
1336 and other processing engines.
1337
1338 @subsection Default Value Boiler Plate Code
1339
1340 All target configuration files should start with code like this,
1341 letting board config files express environment-specific
1342 differences in how things should be set up.
1343
1344 @example
1345 # Boards may override chip names, perhaps based on role,
1346 # but the default should match what the vendor uses
1347 if @{ [info exists CHIPNAME] @} @{
1348    set  _CHIPNAME $CHIPNAME
1349 @} else @{
1350    set  _CHIPNAME sam7x256
1351 @}
1352
1353 # ONLY use ENDIAN with targets that can change it.
1354 if @{ [info exists ENDIAN] @} @{
1355    set  _ENDIAN $ENDIAN
1356 @} else @{
1357    set  _ENDIAN little
1358 @}
1359
1360 # TAP identifiers may change as chips mature, for example with
1361 # new revision fields (the "3" here).  Pick a good default; you
1362 # can pass several such identifiers to the "jtag newtap" command.
1363 if @{ [info exists CPUTAPID ] @} @{
1364    set _CPUTAPID $CPUTAPID
1365 @} else @{
1366    set _CPUTAPID 0x3f0f0f0f
1367 @}
1368 @end example
1369 @c but 0x3f0f0f0f is for an str73x part ...
1370
1371 @emph{Remember:} Board config files may include multiple target
1372 config files, or the same target file multiple times
1373 (changing at least @code{CHIPNAME}).
1374
1375 Likewise, the target configuration file should define
1376 @code{_TARGETNAME} (or @code{_TARGETNAME0} etc) and
1377 use it later on when defining debug targets:
1378
1379 @example
1380 set _TARGETNAME $_CHIPNAME.cpu
1381 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1382 @end example
1383
1384 @subsection Adding TAPs to the Scan Chain
1385 After the ``defaults'' are set up,
1386 add the TAPs on each chip to the JTAG scan chain.
1387 @xref{TAP Declaration}, and the naming convention
1388 for taps.
1389
1390 In the simplest case the chip has only one TAP,
1391 probably for a CPU or FPGA.
1392 The config file for the Atmel AT91SAM7X256
1393 looks (in part) like this:
1394
1395 @example
1396 jtag newtap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf \
1397         -expected-id $_CPUTAPID
1398 @end example
1399
1400 A board with two such at91sam7 chips would be able
1401 to source such a config file twice, with different
1402 values for @code{CHIPNAME}, so
1403 it adds a different TAP each time.
1404
1405 If there are one or more nonzero @option{-expected-id} values,
1406 OpenOCD attempts to verify the actual tap id against those values.
1407 It will issue error messages if there is mismatch, which
1408 can help to pinpoint problems in OpenOCD configurations.
1409
1410 @example
1411 JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f
1412                 (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
1413 ERROR: Tap: sam7x256.cpu - Expected id: 0x12345678, Got: 0x3f0f0f0f
1414 ERROR: expected: mfg: 0x33c, part: 0x2345, ver: 0x1
1415 ERROR:      got: mfg: 0x787, part: 0xf0f0, ver: 0x3
1416 @end example
1417
1418 There are more complex examples too, with chips that have
1419 multiple TAPs.  Ones worth looking at include:
1420
1421 @itemize
1422 @item @file{target/omap3530.cfg} -- with disabled ARM and DSP,
1423 plus a JRC to enable them
1424 @item @file{target/str912.cfg} -- with flash, CPU, and boundary scan
1425 @item @file{target/ti_dm355.cfg} -- with ETM, ARM, and JRC (this JRC
1426 is not currently used)
1427 @end itemize
1428
1429 @subsection Add CPU targets
1430
1431 After adding a TAP for a CPU, you should set it up so that
1432 GDB and other commands can use it.
1433 @xref{CPU Configuration}.
1434 For the at91sam7 example above, the command can look like this;
1435 note that @code{$_ENDIAN} is not needed, since OpenOCD defaults
1436 to little endian, and this chip doesn't support changing that.
1437
1438 @example
1439 set _TARGETNAME $_CHIPNAME.cpu
1440 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1441 @end example
1442
1443 Work areas are small RAM areas associated with CPU targets.
1444 They are used by OpenOCD to speed up downloads,
1445 and to download small snippets of code to program flash chips.
1446 If the chip includes a form of ``on-chip-ram'' - and many do - define
1447 a work area if you can.
1448 Again using the at91sam7 as an example, this can look like:
1449
1450 @example
1451 $_TARGETNAME configure -work-area-phys 0x00200000 \
1452              -work-area-size 0x4000 -work-area-backup 0
1453 @end example
1454
1455 @subsection Chip Reset Setup
1456
1457 As a rule, you should put the @command{reset_config} command
1458 into the board file.  Most things you think you know about a
1459 chip can be tweaked by the board.
1460
1461 Some chips have specific ways the TRST and SRST signals are
1462 managed. In the unusual case that these are @emph{chip specific}
1463 and can never be changed by board wiring, they could go here.
1464
1465 Some chips need special attention during reset handling if
1466 they're going to be used with JTAG.
1467 An example might be needing to send some commands right
1468 after the target's TAP has been reset, providing a
1469 @code{reset-deassert-post} event handler that writes a chip
1470 register to report that JTAG debugging is being done.
1471
1472 @subsection ARM Core Specific Hacks
1473
1474 If the chip has a DCC, enable it. If the chip is an ARM9 with some
1475 special high speed download features - enable it.
1476
1477 If present, the MMU, the MPU and the CACHE should be disabled.
1478
1479 Some ARM cores are equipped with trace support, which permits
1480 examination of the instruction and data bus activity.  Trace
1481 activity is controlled through an ``Embedded Trace Module'' (ETM)
1482 on one of the core's scan chains.  The ETM emits voluminous data
1483 through a ``trace port''.  (@xref{ARM Hardware Tracing}.)
1484 If you are using an external trace port,
1485 configure it in your board config file.
1486 If you are using an on-chip ``Embedded Trace Buffer'' (ETB),
1487 configure it in your target config file.
1488
1489 @example
1490 etm config $_TARGETNAME 16 normal full etb
1491 etb config $_TARGETNAME $_CHIPNAME.etb
1492 @end example
1493
1494 @subsection Internal Flash Configuration
1495
1496 This applies @b{ONLY TO MICROCONTROLLERS} that have flash built in.
1497
1498 @b{Never ever} in the ``target configuration file'' define any type of
1499 flash that is external to the chip. (For example a BOOT flash on
1500 Chip Select 0.) Such flash information goes in a board file - not
1501 the TARGET (chip) file.
1502
1503 Examples:
1504 @itemize @bullet
1505 @item at91sam7x256 - has 256K flash YES enable it.
1506 @item str912 - has flash internal YES enable it.
1507 @item imx27 - uses boot flash on CS0 - it goes in the board file.
1508 @item pxa270 - again - CS0 flash - it goes in the board file.
1509 @end itemize
1510
1511 @node Daemon Configuration
1512 @chapter Daemon Configuration
1513 @cindex initialization
1514 The commands here are commonly found in the openocd.cfg file and are
1515 used to specify what TCP/IP ports are used, and how GDB should be
1516 supported.
1517
1518 @section Configuration Stage
1519 @cindex configuration stage
1520 @cindex config command
1521
1522 When the OpenOCD server process starts up, it enters a
1523 @emph{configuration stage} which is the only time that
1524 certain commands, @emph{configuration commands}, may be issued.
1525 In this manual, the definition of a configuration command is
1526 presented as a @emph{Config Command}, not as a @emph{Command}
1527 which may be issued interactively.
1528
1529 Those configuration commands include declaration of TAPs,
1530 flash banks,
1531 the interface used for JTAG communication,
1532 and other basic setup.
1533 The server must leave the configuration stage before it
1534 may access or activate TAPs.
1535 After it leaves this stage, configuration commands may no
1536 longer be issued.
1537
1538 @deffn {Config Command} init
1539 This command terminates the configuration stage and
1540 enters the normal command mode. This can be useful to add commands to
1541 the startup scripts and commands such as resetting the target,
1542 programming flash, etc. To reset the CPU upon startup, add "init" and
1543 "reset" at the end of the config script or at the end of the OpenOCD
1544 command line using the @option{-c} command line switch.
1545
1546 If this command does not appear in any startup/configuration file
1547 OpenOCD executes the command for you after processing all
1548 configuration files and/or command line options.
1549
1550 @b{NOTE:} This command normally occurs at or near the end of your
1551 openocd.cfg file to force OpenOCD to ``initialize'' and make the
1552 targets ready. For example: If your openocd.cfg file needs to
1553 read/write memory on your target, @command{init} must occur before
1554 the memory read/write commands.  This includes @command{nand probe}.
1555 @end deffn
1556
1557 @anchor{TCP/IP Ports}
1558 @section TCP/IP Ports
1559 @cindex TCP port
1560 @cindex server
1561 @cindex port
1562 @cindex security
1563 The OpenOCD server accepts remote commands in several syntaxes.
1564 Each syntax uses a different TCP/IP port, which you may specify
1565 only during configuration (before those ports are opened).
1566
1567 For reasons including security, you may wish to prevent remote
1568 access using one or more of these ports.
1569 In such cases, just specify the relevant port number as zero.
1570 If you disable all access through TCP/IP, you will need to
1571 use the command line @option{-pipe} option.
1572
1573 @deffn {Command} gdb_port (number)
1574 @cindex GDB server
1575 Specify or query the first port used for incoming GDB connections.
1576 The GDB port for the
1577 first target will be gdb_port, the second target will listen on gdb_port + 1, and so on.
1578 When not specified during the configuration stage,
1579 the port @var{number} defaults to 3333.
1580 When specified as zero, this port is not activated.
1581 @end deffn
1582
1583 @deffn {Command} tcl_port (number)
1584 Specify or query the port used for a simplified RPC
1585 connection that can be used by clients to issue TCL commands and get the
1586 output from the Tcl engine.
1587 Intended as a machine interface.
1588 When not specified during the configuration stage,
1589 the port @var{number} defaults to 6666.
1590 When specified as zero, this port is not activated.
1591 @end deffn
1592
1593 @deffn {Command} telnet_port (number)
1594 Specify or query the
1595 port on which to listen for incoming telnet connections.
1596 This port is intended for interaction with one human through TCL commands.
1597 When not specified during the configuration stage,
1598 the port @var{number} defaults to 4444.
1599 When specified as zero, this port is not activated.
1600 @end deffn
1601
1602 @anchor{GDB Configuration}
1603 @section GDB Configuration
1604 @cindex GDB
1605 @cindex GDB configuration
1606 You can reconfigure some GDB behaviors if needed.
1607 The ones listed here are static and global.
1608 @xref{Target Configuration}, about configuring individual targets.
1609 @xref{Target Events}, about configuring target-specific event handling.
1610
1611 @anchor{gdb_breakpoint_override}
1612 @deffn {Command} gdb_breakpoint_override [@option{hard}|@option{soft}|@option{disable}]
1613 Force breakpoint type for gdb @command{break} commands.
1614 This option supports GDB GUIs which don't
1615 distinguish hard versus soft breakpoints, if the default OpenOCD and
1616 GDB behaviour is not sufficient.  GDB normally uses hardware
1617 breakpoints if the memory map has been set up for flash regions.
1618 @end deffn
1619
1620 @deffn {Config Command} gdb_detach (@option{resume}|@option{reset}|@option{halt}|@option{nothing})
1621 Configures what OpenOCD will do when GDB detaches from the daemon.
1622 Default behaviour is @option{resume}.
1623 @end deffn
1624
1625 @anchor{gdb_flash_program}
1626 @deffn {Config Command} gdb_flash_program (@option{enable}|@option{disable})
1627 Set to @option{enable} to cause OpenOCD to program the flash memory when a
1628 vFlash packet is received.
1629 The default behaviour is @option{enable}.
1630 @end deffn
1631
1632 @deffn {Config Command} gdb_memory_map (@option{enable}|@option{disable})
1633 Set to @option{enable} to cause OpenOCD to send the memory configuration to GDB when
1634 requested. GDB will then know when to set hardware breakpoints, and program flash
1635 using the GDB load command. @command{gdb_flash_program enable} must also be enabled
1636 for flash programming to work.
1637 Default behaviour is @option{enable}.
1638 @xref{gdb_flash_program}.
1639 @end deffn
1640
1641 @deffn {Config Command} gdb_report_data_abort (@option{enable}|@option{disable})
1642 Specifies whether data aborts cause an error to be reported
1643 by GDB memory read packets.
1644 The default behaviour is @option{disable};
1645 use @option{enable} see these errors reported.
1646 @end deffn
1647
1648 @anchor{Event Polling}
1649 @section Event Polling
1650
1651 Hardware debuggers are parts of asynchronous systems,
1652 where significant events can happen at any time.
1653 The OpenOCD server needs to detect some of these events,
1654 so it can report them to through TCL command line
1655 or to GDB.
1656
1657 Examples of such events include:
1658
1659 @itemize
1660 @item One of the targets can stop running ... maybe it triggers
1661 a code breakpoint or data watchpoint, or halts itself.
1662 @item Messages may be sent over ``debug message'' channels ... many
1663 targets support such messages sent over JTAG,
1664 for receipt by the person debugging or tools.
1665 @item Loss of power ... some adapters can detect these events.
1666 @item Resets not issued through JTAG ... such reset sources
1667 can include button presses or other system hardware, sometimes
1668 including the target itself (perhaps through a watchdog).
1669 @item Debug instrumentation sometimes supports event triggering
1670 such as ``trace buffer full'' (so it can quickly be emptied)
1671 or other signals (to correlate with code behavior).
1672 @end itemize
1673
1674 None of those events are signaled through standard JTAG signals.
1675 However, most conventions for JTAG connectors include voltage
1676 level and system reset (SRST) signal detection.
1677 Some connectors also include instrumentation signals, which
1678 can imply events when those signals are inputs.
1679
1680 In general, OpenOCD needs to periodically check for those events,
1681 either by looking at the status of signals on the JTAG connector
1682 or by sending synchronous ``tell me your status'' JTAG requests
1683 to the various active targets.
1684 There is a command to manage and monitor that polling,
1685 which is normally done in the background.
1686
1687 @deffn Command poll [@option{on}|@option{off}]
1688 Poll the current target for its current state.
1689 (Also, @pxref{target curstate}.)
1690 If that target is in debug mode, architecture
1691 specific information about the current state is printed.
1692 An optional parameter
1693 allows background polling to be enabled and disabled.
1694
1695 You could use this from the TCL command shell, or
1696 from GDB using @command{monitor poll} command.
1697 @example
1698 > poll
1699 background polling: on
1700 target state: halted
1701 target halted in ARM state due to debug-request, \
1702                current mode: Supervisor
1703 cpsr: 0x800000d3 pc: 0x11081bfc
1704 MMU: disabled, D-Cache: disabled, I-Cache: enabled
1705 >
1706 @end example
1707 @end deffn
1708
1709 @node Interface - Dongle Configuration
1710 @chapter Interface - Dongle Configuration
1711 @cindex config file, interface
1712 @cindex interface config file
1713
1714 JTAG Adapters/Interfaces/Dongles are normally configured
1715 through commands in an interface configuration
1716 file which is sourced by your @file{openocd.cfg} file, or
1717 through a command line @option{-f interface/....cfg} option.
1718
1719 @example
1720 source [find interface/olimex-jtag-tiny.cfg]
1721 @end example
1722
1723 These commands tell
1724 OpenOCD what type of JTAG adapter you have, and how to talk to it.
1725 A few cases are so simple that you only need to say what driver to use:
1726
1727 @example
1728 # jlink interface
1729 interface jlink
1730 @end example
1731
1732 Most adapters need a bit more configuration than that.
1733
1734
1735 @section Interface Configuration
1736
1737 The interface command tells OpenOCD what type of JTAG dongle you are
1738 using. Depending on the type of dongle, you may need to have one or
1739 more additional commands.
1740
1741 @deffn {Config Command} {interface} name
1742 Use the interface driver @var{name} to connect to the
1743 target.
1744 @end deffn
1745
1746 @deffn Command {interface_list}
1747 List the interface drivers that have been built into
1748 the running copy of OpenOCD.
1749 @end deffn
1750
1751 @deffn Command {jtag interface}
1752 Returns the name of the interface driver being used.
1753 @end deffn
1754
1755 @section Interface Drivers
1756
1757 Each of the interface drivers listed here must be explicitly
1758 enabled when OpenOCD is configured, in order to be made
1759 available at run time.
1760
1761 @deffn {Interface Driver} {amt_jtagaccel}
1762 Amontec Chameleon in its JTAG Accelerator configuration,
1763 connected to a PC's EPP mode parallel port.
1764 This defines some driver-specific commands:
1765
1766 @deffn {Config Command} {parport_port} number
1767 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
1768 the number of the @file{/dev/parport} device.
1769 @end deffn
1770
1771 @deffn {Config Command} rtck [@option{enable}|@option{disable}]
1772 Displays status of RTCK option.
1773 Optionally sets that option first.
1774 @end deffn
1775 @end deffn
1776
1777 @deffn {Interface Driver} {arm-jtag-ew}
1778 Olimex ARM-JTAG-EW USB adapter
1779 This has one driver-specific command:
1780
1781 @deffn Command {armjtagew_info}
1782 Logs some status
1783 @end deffn
1784 @end deffn
1785
1786 @deffn {Interface Driver} {at91rm9200}
1787 Supports bitbanged JTAG from the local system,
1788 presuming that system is an Atmel AT91rm9200
1789 and a specific set of GPIOs is used.
1790 @c command:     at91rm9200_device NAME
1791 @c chooses among list of bit configs ... only one option
1792 @end deffn
1793
1794 @deffn {Interface Driver} {dummy}
1795 A dummy software-only driver for debugging.
1796 @end deffn
1797
1798 @deffn {Interface Driver} {ep93xx}
1799 Cirrus Logic EP93xx based single-board computer bit-banging (in development)
1800 @end deffn
1801
1802 @deffn {Interface Driver} {ft2232}
1803 FTDI FT2232 (USB) based devices over one of the userspace libraries.
1804 These interfaces have several commands, used to configure the driver
1805 before initializing the JTAG scan chain:
1806
1807 @deffn {Config Command} {ft2232_device_desc} description
1808 Provides the USB device description (the @emph{iProduct string})
1809 of the FTDI FT2232 device. If not
1810 specified, the FTDI default value is used. This setting is only valid
1811 if compiled with FTD2XX support.
1812 @end deffn
1813
1814 @deffn {Config Command} {ft2232_serial} serial-number
1815 Specifies the @var{serial-number} of the FTDI FT2232 device to use,
1816 in case the vendor provides unique IDs and more than one FT2232 device
1817 is connected to the host.
1818 If not specified, serial numbers are not considered.
1819 (Note that USB serial numbers can be arbitrary Unicode strings,
1820 and are not restricted to containing only decimal digits.)
1821 @end deffn
1822
1823 @deffn {Config Command} {ft2232_layout} name
1824 Each vendor's FT2232 device can use different GPIO signals
1825 to control output-enables, reset signals, and LEDs.
1826 Currently valid layout @var{name} values include:
1827 @itemize @minus
1828 @item @b{axm0432_jtag} Axiom AXM-0432
1829 @item @b{comstick} Hitex STR9 comstick
1830 @item @b{cortino} Hitex Cortino JTAG interface
1831 @item @b{evb_lm3s811} Luminary Micro EVB_LM3S811 as a JTAG interface,
1832 either for the local Cortex-M3 (SRST only)
1833 or in a passthrough mode (neither SRST nor TRST)
1834 @item @b{luminary_icdi} Luminary In-Circuit Debug Interface (ICDI) Board
1835 @item @b{flyswatter} Tin Can Tools Flyswatter
1836 @item @b{icebear} ICEbear JTAG adapter from Section 5
1837 @item @b{jtagkey} Amontec JTAGkey and JTAGkey-Tiny (and compatibles)
1838 @item @b{m5960} American Microsystems M5960
1839 @item @b{olimex-jtag} Olimex ARM-USB-OCD and ARM-USB-Tiny
1840 @item @b{oocdlink} OOCDLink
1841 @c oocdlink ~= jtagkey_prototype_v1
1842 @item @b{sheevaplug} Marvell Sheevaplug development kit
1843 @item @b{signalyzer} Xverve Signalyzer
1844 @item @b{stm32stick} Hitex STM32 Performance Stick
1845 @item @b{turtelizer2} egnite Software turtelizer2
1846 @item @b{usbjtag} "USBJTAG-1" layout described in the OpenOCD diploma thesis
1847 @end itemize
1848 @end deffn
1849
1850 @deffn {Config Command} {ft2232_vid_pid} [vid pid]+
1851 The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
1852 default values are used.
1853 Currently, up to eight [@var{vid}, @var{pid}] pairs may be given, e.g.
1854 @example
1855 ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
1856 @end example
1857 @end deffn
1858
1859 @deffn {Config Command} {ft2232_latency} ms
1860 On some systems using FT2232 based JTAG interfaces the FT_Read function call in
1861 ft2232_read() fails to return the expected number of bytes. This can be caused by
1862 USB communication delays and has proved hard to reproduce and debug. Setting the
1863 FT2232 latency timer to a larger value increases delays for short USB packets but it
1864 also reduces the risk of timeouts before receiving the expected number of bytes.
1865 The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
1866 @end deffn
1867
1868 For example, the interface config file for a
1869 Turtelizer JTAG Adapter looks something like this:
1870
1871 @example
1872 interface ft2232
1873 ft2232_device_desc "Turtelizer JTAG/RS232 Adapter"
1874 ft2232_layout turtelizer2
1875 ft2232_vid_pid 0x0403 0xbdc8
1876 @end example
1877 @end deffn
1878
1879 @deffn {Interface Driver} {gw16012}
1880 Gateworks GW16012 JTAG programmer.
1881 This has one driver-specific command:
1882
1883 @deffn {Config Command} {parport_port} number
1884 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
1885 the number of the @file{/dev/parport} device.
1886 @end deffn
1887 @end deffn
1888
1889 @deffn {Interface Driver} {jlink}
1890 Segger jlink USB adapter
1891 @c command:     jlink_info
1892 @c     dumps status
1893 @c command:     jlink_hw_jtag (2|3)
1894 @c     sets version 2 or 3
1895 @end deffn
1896
1897 @deffn {Interface Driver} {parport}
1898 Supports PC parallel port bit-banging cables:
1899 Wigglers, PLD download cable, and more.
1900 These interfaces have several commands, used to configure the driver
1901 before initializing the JTAG scan chain:
1902
1903 @deffn {Config Command} {parport_cable} name
1904 The layout of the parallel port cable used to connect to the target.
1905 Currently valid cable @var{name} values include:
1906
1907 @itemize @minus
1908 @item @b{altium} Altium Universal JTAG cable.
1909 @item @b{arm-jtag} Same as original wiggler except SRST and
1910 TRST connections reversed and TRST is also inverted.
1911 @item @b{chameleon} The Amontec Chameleon's CPLD when operated
1912 in configuration mode. This is only used to
1913 program the Chameleon itself, not a connected target.
1914 @item @b{dlc5} The Xilinx Parallel cable III.
1915 @item @b{flashlink} The ST Parallel cable.
1916 @item @b{lattice} Lattice ispDOWNLOAD Cable
1917 @item @b{old_amt_wiggler} The Wiggler configuration that comes with
1918 some versions of
1919 Amontec's Chameleon Programmer. The new version available from
1920 the website uses the original Wiggler layout ('@var{wiggler}')
1921 @item @b{triton} The parallel port adapter found on the
1922 ``Karo Triton 1 Development Board''.
1923 This is also the layout used by the HollyGates design
1924 (see @uref{http://www.lartmaker.nl/projects/jtag/}).
1925 @item @b{wiggler} The original Wiggler layout, also supported by
1926 several clones, such as the Olimex ARM-JTAG
1927 @item @b{wiggler2} Same as original wiggler except an led is fitted on D5.
1928 @item @b{wiggler_ntrst_inverted} Same as original wiggler except TRST is inverted.
1929 @end itemize
1930 @end deffn
1931
1932 @deffn {Config Command} {parport_port} number
1933 Either the address of the I/O port (default: 0x378 for LPT1) or the number of
1934 the @file{/dev/parport} device
1935
1936 When using PPDEV to access the parallel port, use the number of the parallel port:
1937 @option{parport_port 0} (the default). If @option{parport_port 0x378} is specified
1938 you may encounter a problem.
1939 @end deffn
1940
1941 @deffn {Config Command} {parport_write_on_exit} (on|off)
1942 This will configure the parallel driver to write a known
1943 cable-specific value to the parallel interface on exiting OpenOCD
1944 @end deffn
1945
1946 For example, the interface configuration file for a
1947 classic ``Wiggler'' cable might look something like this:
1948
1949 @example
1950 interface parport
1951 parport_port 0xc8b8
1952 parport_cable wiggler
1953 @end example
1954 @end deffn
1955
1956 @deffn {Interface Driver} {presto}
1957 ASIX PRESTO USB JTAG programmer.
1958 @c command:     presto_serial str
1959 @c     sets serial number
1960 @end deffn
1961
1962 @deffn {Interface Driver} {rlink}
1963 Raisonance RLink USB adapter
1964 @end deffn
1965
1966 @deffn {Interface Driver} {usbprog}
1967 usbprog is a freely programmable USB adapter.
1968 @end deffn
1969
1970 @deffn {Interface Driver} {vsllink}
1971 vsllink is part of Versaloon which is a versatile USB programmer.
1972
1973 @quotation Note
1974 This defines quite a few driver-specific commands,
1975 which are not currently documented here.
1976 @end quotation
1977 @end deffn
1978
1979 @deffn {Interface Driver} {ZY1000}
1980 This is the Zylin ZY1000 JTAG debugger.
1981
1982 @quotation Note
1983 This defines some driver-specific commands,
1984 which are not currently documented here.
1985 @end quotation
1986
1987 @deffn Command power [@option{on}|@option{off}]
1988 Turn power switch to target on/off.
1989 No arguments: print status.
1990 @end deffn
1991
1992 @end deffn
1993
1994 @anchor{JTAG Speed}
1995 @section JTAG Speed
1996 JTAG clock setup is part of system setup.
1997 It @emph{does not belong with interface setup} since any interface
1998 only knows a few of the constraints for the JTAG clock speed.
1999 Sometimes the JTAG speed is
2000 changed during the target initialization process: (1) slow at
2001 reset, (2) program the CPU clocks, (3) run fast.
2002 Both the "slow" and "fast" clock rates are functions of the
2003 oscillators used, the chip, the board design, and sometimes
2004 power management software that may be active.
2005
2006 The speed used during reset can be adjusted using pre_reset
2007 and post_reset event handlers.
2008 @xref{Target Events}.
2009
2010 If your system supports adaptive clocking (RTCK), configuring
2011 JTAG to use that is probably the most robust approach.
2012 However, it introduces delays to synchronize clocks; so it
2013 may not be the fastest solution.
2014
2015 @b{NOTE:} Script writers should consider using @command{jtag_rclk}
2016 instead of @command{jtag_khz}.
2017
2018 @deffn {Command} jtag_khz max_speed_kHz
2019 A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
2020 JTAG interfaces usually support a limited number of
2021 speeds.  The speed actually used won't be faster
2022 than the speed specified.
2023
2024 As a rule of thumb, if you specify a clock rate make
2025 sure the JTAG clock is no more than @math{1/6th CPU-Clock}.
2026 This is especially true for synthesized cores (ARMxxx-S).
2027
2028 Speed 0 (khz) selects RTCK method.
2029 @xref{FAQ RTCK}.
2030 If your system uses RTCK, you won't need to change the
2031 JTAG clocking after setup.
2032 Not all interfaces, boards, or targets support ``rtck''.
2033 If the interface device can not
2034 support it, an error is returned when you try to use RTCK.
2035 @end deffn
2036
2037 @defun jtag_rclk fallback_speed_kHz
2038 @cindex RTCK
2039 This Tcl proc (defined in @file{startup.tcl}) attempts to enable RTCK/RCLK.
2040 If that fails (maybe the interface, board, or target doesn't
2041 support it), falls back to the specified frequency.
2042 @example
2043 # Fall back to 3mhz if RTCK is not supported
2044 jtag_rclk 3000
2045 @end example
2046 @end defun
2047
2048 @node Reset Configuration
2049 @chapter Reset Configuration
2050 @cindex Reset Configuration
2051
2052 Every system configuration may require a different reset
2053 configuration. This can also be quite confusing.
2054 Resets also interact with @var{reset-init} event handlers,
2055 which do things like setting up clocks and DRAM, and
2056 JTAG clock rates.  (@xref{JTAG Speed}.)
2057 They can also interact with JTAG routers.
2058 Please see the various board files for examples.
2059
2060 @quotation Note
2061 To maintainers and integrators:
2062 Reset configuration touches several things at once.
2063 Normally the board configuration file
2064 should define it and assume that the JTAG adapter supports
2065 everything that's wired up to the board's JTAG connector.
2066
2067 However, the target configuration file could also make note
2068 of something the silicon vendor has done inside the chip,
2069 which will be true for most (or all) boards using that chip.
2070 And when the JTAG adapter doesn't support everything, the
2071 user configuration file will need to override parts of
2072 the reset configuration provided by other files.
2073 @end quotation
2074
2075 @section Types of Reset
2076
2077 There are many kinds of reset possible through JTAG, but
2078 they may not all work with a given board and adapter.
2079 That's part of why reset configuration can be error prone.
2080
2081 @itemize @bullet
2082 @item
2083 @emph{System Reset} ... the @emph{SRST} hardware signal
2084 resets all chips connected to the JTAG adapter, such as processors,
2085 power management chips, and I/O controllers.  Normally resets triggered
2086 with this signal behave exactly like pressing a RESET button.
2087 @item
2088 @emph{JTAG TAP Reset} ... the @emph{TRST} hardware signal resets
2089 just the TAP controllers connected to the JTAG adapter.
2090 Such resets should not be visible to the rest of the system; resetting a
2091 device's the TAP controller just puts that controller into a known state.
2092 @item
2093 @emph{Emulation Reset} ... many devices can be reset through JTAG
2094 commands.  These resets are often distinguishable from system
2095 resets, either explicitly (a "reset reason" register says so)
2096 or implicitly (not all parts of the chip get reset).
2097 @item
2098 @emph{Other Resets} ... system-on-chip devices often support
2099 several other types of reset.
2100 You may need to arrange that a watchdog timer stops
2101 while debugging, preventing a watchdog reset.
2102 There may be individual module resets.
2103 @end itemize
2104
2105 In the best case, OpenOCD can hold SRST, then reset
2106 the TAPs via TRST and send commands through JTAG to halt the
2107 CPU at the reset vector before the 1st instruction is executed.
2108 Then when it finally releases the SRST signal, the system is
2109 halted under debugger control before any code has executed.
2110 This is the behavior required to support the @command{reset halt}
2111 and @command{reset init} commands; after @command{reset init} a
2112 board-specific script might do things like setting up DRAM.
2113 (@xref{Reset Command}.)
2114
2115 @anchor{SRST and TRST Issues}
2116 @section SRST and TRST Issues
2117
2118 Because SRST and TRST are hardware signals, they can have a
2119 variety of system-specific constraints.  Some of the most
2120 common issues are:
2121
2122 @itemize @bullet
2123
2124 @item @emph{Signal not available} ... Some boards don't wire
2125 SRST or TRST to the JTAG connector.  Some JTAG adapters don't
2126 support such signals even if they are wired up.
2127 Use the @command{reset_config} @var{signals} options to say
2128 when either of those signals is not connected.
2129 When SRST is not available, your code might not be able to rely
2130 on controllers having been fully reset during code startup.
2131 Missing TRST is not a problem, since JTAG level resets can
2132 be triggered using with TMS signaling.
2133
2134 @item @emph{Signals shorted} ... Sometimes a chip, board, or
2135 adapter will connect SRST to TRST, instead of keeping them separate.
2136 Use the @command{reset_config} @var{combination} options to say
2137 when those signals aren't properly independent.
2138
2139 @item @emph{Timing} ... Reset circuitry like a resistor/capacitor
2140 delay circuit, reset supervisor, or on-chip features can extend
2141 the effect of a JTAG adapter's reset for some time after the adapter
2142 stops issuing the reset.  For example, there may be chip or board
2143 requirements that all reset pulses last for at least a
2144 certain amount of time; and reset buttons commonly have
2145 hardware debouncing.
2146 Use the @command{jtag_nsrst_delay} and @command{jtag_ntrst_delay}
2147 commands to say when extra delays are needed.
2148
2149 @item @emph{Drive type} ... Reset lines often have a pullup
2150 resistor, letting the JTAG interface treat them as open-drain
2151 signals.  But that's not a requirement, so the adapter may need
2152 to use push/pull output drivers.
2153 Also, with weak pullups it may be advisable to drive
2154 signals to both levels (push/pull) to minimize rise times.
2155 Use the @command{reset_config} @var{trst_type} and
2156 @var{srst_type} parameters to say how to drive reset signals.
2157
2158 @item @emph{Special initialization} ...  Targets sometimes need
2159 special JTAG initialization sequences to handle chip-specific
2160 issues (not limited to errata).
2161 For example, certain JTAG commands might need to be issued while
2162 the system as a whole is in a reset state (SRST active)
2163 but the JTAG scan chain is usable (TRST inactive).
2164 (@xref{JTAG Commands}, where the @command{jtag_reset}
2165 command is presented.)
2166 @end itemize
2167
2168 There can also be other issues.
2169 Some devices don't fully conform to the JTAG specifications.
2170 Trivial system-specific differences are common, such as
2171 SRST and TRST using slightly different names.
2172 There are also vendors who distribute key JTAG documentation for
2173 their chips only to developers who have signed a Non-Disclosure
2174 Agreement (NDA).
2175
2176 Sometimes there are chip-specific extensions like a requirement to use
2177 the normally-optional TRST signal (precluding use of JTAG adapters which
2178 don't pass TRST through), or needing extra steps to complete a TAP reset.
2179
2180 In short, SRST and especially TRST handling may be very finicky,
2181 needing to cope with both architecture and board specific constraints.
2182
2183 @section Commands for Handling Resets
2184
2185 @deffn {Command} jtag_nsrst_delay milliseconds
2186 How long (in milliseconds) OpenOCD should wait after deasserting
2187 nSRST (active-low system reset) before starting new JTAG operations.
2188 When a board has a reset button connected to SRST line it will
2189 probably have hardware debouncing, implying you should use this.
2190 @end deffn
2191
2192 @deffn {Command} jtag_ntrst_delay milliseconds
2193 How long (in milliseconds) OpenOCD should wait after deasserting
2194 nTRST (active-low JTAG TAP reset) before starting new JTAG operations.
2195 @end deffn
2196
2197 @deffn {Command} reset_config mode_flag ...
2198 This command tells OpenOCD the reset configuration
2199 of your combination of JTAG board and target in target
2200 configuration scripts.
2201
2202 Information earlier in this section describes the kind of problems
2203 the command is intended to address (@pxref{SRST and TRST Issues}).
2204 As a rule this command belongs only in board config files,
2205 describing issues like @emph{board doesn't connect TRST};
2206 or in user config files, addressing limitations derived
2207 from a particular combination of interface and board.
2208 (An unlikely example would be using a TRST-only adapter
2209 with a board that only wires up SRST.)
2210
2211 The @var{mode_flag} options can be specified in any order, but only one
2212 of each type -- @var{signals}, @var{combination}, @var{trst_type},
2213 and @var{srst_type} -- may be specified at a time.
2214 If you don't provide a new value for a given type, its previous
2215 value (perhaps the default) is unchanged.
2216 For example, this means that you don't need to say anything at all about
2217 TRST just to declare that if the JTAG adapter should want to drive SRST,
2218 it must explicitly be driven high (@option{srst_push_pull}).
2219
2220 @var{signals} can specify which of the reset signals are connected.
2221 For example, If the JTAG interface provides SRST, but the board doesn't
2222 connect that signal properly, then OpenOCD can't use it.
2223 Possible values are @option{none} (the default), @option{trst_only},
2224 @option{srst_only} and @option{trst_and_srst}.
2225
2226 @quotation Tip
2227 If your board provides SRST or TRST through the JTAG connector,
2228 you must declare that or else those signals will not be used.
2229 @end quotation
2230
2231 The @var{combination} is an optional value specifying broken reset
2232 signal implementations.
2233 The default behaviour if no option given is @option{separate},
2234 indicating everything behaves normally.
2235 @option{srst_pulls_trst} states that the
2236 test logic is reset together with the reset of the system (e.g. Philips
2237 LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
2238 the system is reset together with the test logic (only hypothetical, I
2239 haven't seen hardware with such a bug, and can be worked around).
2240 @option{combined} implies both @option{srst_pulls_trst} and
2241 @option{trst_pulls_srst}.
2242
2243 The optional @var{trst_type} and @var{srst_type} parameters allow the
2244 driver mode of each reset line to be specified.  These values only affect
2245 JTAG interfaces with support for different driver modes, like the Amontec
2246 JTAGkey and JTAGAccelerator.  Also, they are necessarily ignored if the
2247 relevant signal (TRST or SRST) is not connected.
2248
2249 Possible @var{trst_type} driver modes for the test reset signal (TRST)
2250 are @option{trst_push_pull} (default) and @option{trst_open_drain}.
2251 Most boards connect this signal to a pulldown, so the JTAG TAPs
2252 never leave reset unless they are hooked up to a JTAG adapter.
2253
2254 Possible @var{srst_type} driver modes for the system reset signal (SRST)
2255 are the default @option{srst_open_drain}, and @option{srst_push_pull}.
2256 Most boards connect this signal to a pullup, and allow the
2257 signal to be pulled low by various events including system
2258 powerup and pressing a reset button.
2259 @end deffn
2260
2261
2262 @node TAP Declaration
2263 @chapter TAP Declaration
2264 @cindex TAP declaration
2265 @cindex TAP configuration
2266
2267 @emph{Test Access Ports} (TAPs) are the core of JTAG.
2268 TAPs serve many roles, including:
2269
2270 @itemize @bullet
2271 @item @b{Debug Target} A CPU TAP can be used as a GDB debug target
2272 @item @b{Flash Programing} Some chips program the flash directly via JTAG.
2273 Others do it indirectly, making a CPU do it.
2274 @item @b{Program Download} Using the same CPU support GDB uses,
2275 you can initialize a DRAM controller, download code to DRAM, and then
2276 start running that code.
2277 @item @b{Boundary Scan} Most chips support boundary scan, which
2278 helps test for board assembly problems like solder bridges
2279 and missing connections
2280 @end itemize
2281
2282 OpenOCD must know about the active TAPs on your board(s).
2283 Setting up the TAPs is the core task of your configuration files.
2284 Once those TAPs are set up, you can pass their names to code
2285 which sets up CPUs and exports them as GDB targets,
2286 probes flash memory, performs low-level JTAG operations, and more.
2287
2288 @section Scan Chains
2289 @cindex scan chain
2290
2291 TAPs are part of a hardware @dfn{scan chain},
2292 which is daisy chain of TAPs.
2293 They also need to be added to
2294 OpenOCD's software mirror of that hardware list,
2295 giving each member a name and associating other data with it.
2296 Simple scan chains, with a single TAP, are common in
2297 systems with a single microcontroller or microprocessor.
2298 More complex chips may have several TAPs internally.
2299 Very complex scan chains might have a dozen or more TAPs:
2300 several in one chip, more in the next, and connecting
2301 to other boards with their own chips and TAPs.
2302
2303 You can display the list with the @command{scan_chain} command.
2304 (Don't confuse this with the list displayed by the @command{targets}
2305 command, presented in the next chapter.
2306 That only displays TAPs for CPUs which are configured as
2307 debugging targets.)
2308 Here's what the scan chain might look like for a chip more than one TAP:
2309
2310 @verbatim
2311    TapName            Enabled IdCode     Expected   IrLen IrCap IrMask Instr
2312 -- ------------------ ------- ---------- ---------- ----- ----- ------ -----
2313  0 omap5912.dsp          Y    0x03df1d81 0x03df1d81 38    0     0      0x...
2314  1 omap5912.arm          Y    0x0692602f 0x0692602f 4     0x1   0      0xc
2315  2 omap5912.unknown      Y    0x00000000 0x00000000 8     0     0      0xff
2316 @end verbatim
2317
2318 Unfortunately those TAPs can't always be autoconfigured,
2319 because not all devices provide good support for that.
2320 JTAG doesn't require supporting IDCODE instructions, and
2321 chips with JTAG routers may not link TAPs into the chain
2322 until they are told to do so.
2323
2324 The configuration mechanism currently supported by OpenOCD
2325 requires explicit configuration of all TAP devices using
2326 @command{jtag newtap} commands, as detailed later in this chapter.
2327 A command like this would declare one tap and name it @code{chip1.cpu}:
2328
2329 @example
2330 jtag newtap chip1 cpu -irlen 7 -ircapture 0x01 -irmask 0x55
2331 @end example
2332
2333 Each target configuration file lists the TAPs provided
2334 by a given chip.
2335 Board configuration files combine all the targets on a board,
2336 and so forth.
2337 Note that @emph{the order in which TAPs are declared is very important.}
2338 It must match the order in the JTAG scan chain, both inside
2339 a single chip and between them.
2340 @xref{FAQ TAP Order}.
2341
2342 For example, the ST Microsystems STR912 chip has
2343 three separate TAPs@footnote{See the ST
2344 document titled: @emph{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
2345 28/102, Figure 3: JTAG chaining inside the STR91xFA}.
2346 @url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}}.
2347 To configure those taps, @file{target/str912.cfg}
2348 includes commands something like this:
2349
2350 @example
2351 jtag newtap str912 flash ... params ...
2352 jtag newtap str912 cpu ... params ...
2353 jtag newtap str912 bs ... params ...
2354 @end example
2355
2356 Actual config files use a variable instead of literals like
2357 @option{str912}, to support more than one chip of each type.
2358 @xref{Config File Guidelines}.
2359
2360 @deffn Command {jtag names}
2361 Returns the names of all current TAPs in the scan chain.
2362 Use @command{jtag cget} or @command{jtag tapisenabled}
2363 to examine attributes and state of each TAP.
2364 @example
2365 foreach t [jtag names] @{
2366     puts [format "TAP: %s\n" $t]
2367 @}
2368 @end example
2369 @end deffn
2370
2371 @deffn Command {scan_chain}
2372 Displays the TAPs in the scan chain configuration,
2373 and their status.
2374 The set of TAPs listed by this command is fixed by
2375 exiting the OpenOCD configuration stage,
2376 but systems with a JTAG router can
2377 enable or disable TAPs dynamically.
2378 In addition to the enable/disable status, the contents of
2379 each TAP's instruction register can also change.
2380 @end deffn
2381
2382 @c FIXME!  "jtag cget" should be able to return all TAP
2383 @c attributes, like "$target_name cget" does for targets.
2384
2385 @c Probably want "jtag eventlist", and a "tap-reset" event
2386 @c (on entry to RESET state).
2387
2388 @section TAP Names
2389 @cindex dotted name
2390
2391 When TAP objects are declared with @command{jtag newtap},
2392 a @dfn{dotted.name} is created for the TAP, combining the
2393 name of a module (usually a chip) and a label for the TAP.
2394 For example: @code{xilinx.tap}, @code{str912.flash},
2395 @code{omap3530.jrc}, @code{dm6446.dsp}, or @code{stm32.cpu}.
2396 Many other commands use that dotted.name to manipulate or
2397 refer to the TAP.  For example, CPU configuration uses the
2398 name, as does declaration of NAND or NOR flash banks.
2399
2400 The components of a dotted name should follow ``C'' symbol
2401 name rules:  start with an alphabetic character, then numbers
2402 and underscores are OK; while others (including dots!) are not.
2403
2404 @quotation Tip
2405 In older code, JTAG TAPs were numbered from 0..N.
2406 This feature is still present.
2407 However its use is highly discouraged, and
2408 should not be relied on; it will be removed by mid-2010.
2409 Update all of your scripts to use TAP names rather than numbers,
2410 by paying attention to the runtime warnings they trigger.
2411 Using TAP numbers in target configuration scripts prevents
2412 reusing those scripts on boards with multiple targets.
2413 @end quotation
2414
2415 @section TAP Declaration Commands
2416
2417 @c shouldn't this be(come) a {Config Command}?
2418 @anchor{jtag newtap}
2419 @deffn Command {jtag newtap} chipname tapname configparams...
2420 Declares a new TAP with the dotted name @var{chipname}.@var{tapname},
2421 and configured according to the various @var{configparams}.
2422
2423 The @var{chipname} is a symbolic name for the chip.
2424 Conventionally target config files use @code{$_CHIPNAME},
2425 defaulting to the model name given by the chip vendor but
2426 overridable.
2427
2428 @cindex TAP naming convention
2429 The @var{tapname} reflects the role of that TAP,
2430 and should follow this convention:
2431
2432 @itemize @bullet
2433 @item @code{bs} -- For boundary scan if this is a seperate TAP;
2434 @item @code{cpu} -- The main CPU of the chip, alternatively
2435 @code{arm} and @code{dsp} on chips with both ARM and DSP CPUs,
2436 @code{arm1} and @code{arm2} on chips two ARMs, and so forth;
2437 @item @code{etb} -- For an embedded trace buffer (example: an ARM ETB11);
2438 @item @code{flash} -- If the chip has a flash TAP, like the str912;
2439 @item @code{jrc} -- For JTAG route controller (example: the ICEpick modules
2440 on many Texas Instruments chips, like the OMAP3530 on Beagleboards);
2441 @item @code{tap} -- Should be used only FPGA or CPLD like devices
2442 with a single TAP;
2443 @item @code{unknownN} -- If you have no idea what the TAP is for (N is a number);
2444 @item @emph{when in doubt} -- Use the chip maker's name in their data sheet.
2445 For example, the Freescale IMX31 has a SDMA (Smart DMA) with
2446 a JTAG TAP; that TAP should be named @code{sdma}.
2447 @end itemize
2448
2449 Every TAP requires at least the following @var{configparams}:
2450
2451 @itemize @bullet
2452 @item @code{-ircapture} @var{NUMBER}
2453 @*The IDCODE capture command, such as 0x01.
2454 @item @code{-irlen} @var{NUMBER}
2455 @*The length in bits of the
2456 instruction register, such as 4 or 5 bits.
2457 @item @code{-irmask} @var{NUMBER}
2458 @*A mask for the IR register.
2459 For some devices, there are bits in the IR that aren't used.
2460 This lets OpenOCD mask them off when doing IDCODE comparisons.
2461 In general, this should just be all ones for the size of the IR.
2462 @end itemize
2463
2464 A TAP may also provide optional @var{configparams}:
2465
2466 @itemize @bullet
2467 @item @code{-disable} (or @code{-enable})
2468 @*Use the @code{-disable} parameter to flag a TAP which is not
2469 linked in to the scan chain after a reset using either TRST
2470 or the JTAG state machine's @sc{reset} state.
2471 You may use @code{-enable} to highlight the default state
2472 (the TAP is linked in).
2473 @xref{Enabling and Disabling TAPs}.
2474 @item @code{-expected-id} @var{number}
2475 @*A non-zero value represents the expected 32-bit IDCODE
2476 found when the JTAG chain is examined.
2477 These codes are not required by all JTAG devices.
2478 @emph{Repeat the option} as many times as required if more than one
2479 ID code could appear (for example, multiple versions).
2480 @end itemize
2481 @end deffn
2482
2483 @c @deffn Command {jtag arp_init-reset}
2484 @c ... more or less "init" ?
2485
2486 @anchor{Enabling and Disabling TAPs}
2487 @section Enabling and Disabling TAPs
2488 @cindex TAP events
2489 @cindex JTAG Route Controller
2490 @cindex jrc
2491
2492 In some systems, a @dfn{JTAG Route Controller} (JRC)
2493 is used to enable and/or disable specific JTAG TAPs.
2494 Many ARM based chips from Texas Instruments include
2495 an ``ICEpick'' module, which is a JRC.
2496 Such chips include DaVinci and OMAP3 processors.
2497
2498 A given TAP may not be visible until the JRC has been
2499 told to link it into the scan chain; and if the JRC
2500 has been told to unlink that TAP, it will no longer
2501 be visible.
2502 Such routers address problems that JTAG ``bypass mode''
2503 ignores, such as:
2504
2505 @itemize
2506 @item The scan chain can only go as fast as its slowest TAP.
2507 @item Having many TAPs slows instruction scans, since all
2508 TAPs receive new instructions.
2509 @item TAPs in the scan chain must be powered up, which wastes
2510 power and prevents debugging some power management mechanisms.
2511 @end itemize
2512
2513 The IEEE 1149.1 JTAG standard has no concept of a ``disabled'' tap,
2514 as implied by the existence of JTAG routers.
2515 However, the upcoming IEEE 1149.7 framework (layered on top of JTAG)
2516 does include a kind of JTAG router functionality.
2517
2518 @c (a) currently the event handlers don't seem to be able to
2519 @c     fail in a way that could lead to no-change-of-state.
2520 @c (b) eventually non-event configuration should be possible,
2521 @c     in which case some this documentation must move.
2522
2523 @deffn Command {jtag cget} dotted.name @option{-event} name
2524 @deffnx Command {jtag configure} dotted.name @option{-event} name string
2525 At this writing this mechanism is used only for event handling,
2526 and the only two events relate to TAP enabling and disabling.
2527
2528 The @code{configure} subcommand assigns an event handler,
2529 a TCL string which is evaluated when the event is triggered.
2530 The @code{cget} subcommand returns that handler.
2531 The two possible values for an event @var{name}
2532 are @option{tap-disable} and @option{tap-enable}.
2533
2534 So for example, when defining a TAP for a CPU connected to
2535 a JTAG router, you should define TAP event handlers using
2536 code that looks something like this:
2537
2538 @example
2539 jtag configure CHIP.cpu -event tap-enable @{
2540   echo "Enabling CPU TAP"
2541   ... jtag operations using CHIP.jrc
2542 @}
2543 jtag configure CHIP.cpu -event tap-disable @{
2544   echo "Disabling CPU TAP"
2545   ... jtag operations using CHIP.jrc
2546 @}
2547 @end example
2548 @end deffn
2549
2550 @deffn Command {jtag tapdisable} dotted.name
2551 @deffnx Command {jtag tapenable} dotted.name
2552 @deffnx Command {jtag tapisenabled} dotted.name
2553 These three commands all return the string "1" if the tap
2554 specified by @var{dotted.name} is enabled,
2555 and "0" if it is disbabled.
2556 The @command{tapenable} variant first enables the tap
2557 by sending it a @option{tap-enable} event.
2558 The @command{tapdisable} variant first disables the tap
2559 by sending it a @option{tap-disable} event.
2560
2561 @quotation Note
2562 Humans will find the @command{scan_chain} command more helpful
2563 than the script-oriented @command{tapisenabled}
2564 for querying the state of the JTAG taps.
2565 @end quotation
2566 @end deffn
2567
2568 @node CPU Configuration
2569 @chapter CPU Configuration
2570 @cindex GDB target
2571
2572 This chapter discusses how to set up GDB debug targets for CPUs.
2573 You can also access these targets without GDB
2574 (@pxref{Architecture and Core Commands},
2575 and @ref{Target State handling}) and
2576 through various kinds of NAND and NOR flash commands.
2577 If you have multiple CPUs you can have multiple such targets.
2578
2579 We'll start by looking at how to examine the targets you have,
2580 then look at how to add one more target and how to configure it.
2581
2582 @section Target List
2583 @cindex target, current
2584 @cindex target, list
2585
2586 All targets that have been set up are part of a list,
2587 where each member has a name.
2588 That name should normally be the same as the TAP name.
2589 You can display the list with the @command{targets}
2590 (plural!) command.
2591 This display often has only one CPU; here's what it might
2592 look like with more than one:
2593 @verbatim
2594     TargetName         Type       Endian TapName            State
2595 --  ------------------ ---------- ------ ------------------ ------------
2596  0* at91rm9200.cpu     arm920t    little at91rm9200.cpu     running
2597  1  MyTarget           cortex_m3  little mychip.foo         tap-disabled
2598 @end verbatim
2599
2600 One member of that list is the @dfn{current target}, which
2601 is implicitly referenced by many commands.
2602 It's the one marked with a @code{*} near the target name.
2603 In particular, memory addresses often refer to the address
2604 space seen by that current target.
2605 Commands like @command{mdw} (memory display words)
2606 and @command{flash erase_address} (erase NOR flash blocks)
2607 are examples; and there are many more.
2608
2609 Several commands let you examine the list of targets:
2610
2611 @deffn Command {target count}
2612 Returns the number of targets, @math{N}.
2613 The highest numbered target is @math{N - 1}.
2614 @example
2615 set c [target count]
2616 for @{ set x 0 @} @{ $x < $c @} @{ incr x @} @{
2617     # Assuming you have created this function
2618     print_target_details $x
2619 @}
2620 @end example
2621 @end deffn
2622
2623 @deffn Command {target current}
2624 Returns the name of the current target.
2625 @end deffn
2626
2627 @deffn Command {target names}
2628 Lists the names of all current targets in the list.
2629 @example
2630 foreach t [target names] @{
2631     puts [format "Target: %s\n" $t]
2632 @}
2633 @end example
2634 @end deffn
2635
2636 @deffn Command {target number} number
2637 The list of targets is numbered starting at zero.
2638 This command returns the name of the target at index @var{number}.
2639 @example
2640 set thename [target number $x]
2641 puts [format "Target %d is: %s\n" $x $thename]
2642 @end example
2643 @end deffn
2644
2645 @c yep, "target list" would have been better.
2646 @c plus maybe "target setdefault".
2647
2648 @deffn Command targets [name]
2649 @emph{Note: the name of this command is plural.  Other target
2650 command names are singular.}
2651
2652 With no parameter, this command displays a table of all known
2653 targets in a user friendly form.
2654
2655 With a parameter, this command sets the current target to
2656 the given target with the given @var{name}; this is
2657 only relevant on boards which have more than one target.
2658 @end deffn
2659
2660 @section Target CPU Types and Variants
2661 @cindex target type
2662 @cindex CPU type
2663 @cindex CPU variant
2664
2665 Each target has a @dfn{CPU type}, as shown in the output of
2666 the @command{targets} command.  You need to specify that type
2667 when calling @command{target create}.
2668 The CPU type indicates more than just the instruction set.
2669 It also indicates how that instruction set is implemented,
2670 what kind of debug support it integrates,
2671 whether it has an MMU (and if so, what kind),
2672 what core-specific commands may be available
2673 (@pxref{Architecture and Core Commands}),
2674 and more.
2675
2676 For some CPU types, OpenOCD also defines @dfn{variants} which
2677 indicate differences that affect their handling.
2678 For example, a particular implementation bug might need to be
2679 worked around in some chip versions.
2680
2681 It's easy to see what target types are supported,
2682 since there's a command to list them.
2683 However, there is currently no way to list what target variants
2684 are supported (other than by reading the OpenOCD source code).
2685
2686 @anchor{target types}
2687 @deffn Command {target types}
2688 Lists all supported target types.
2689 At this writing, the supported CPU types and variants are:
2690
2691 @itemize @bullet
2692 @item @code{arm11} -- this is a generation of ARMv6 cores
2693 @item @code{arm720t} -- this is an ARMv4 core
2694 @item @code{arm7tdmi} -- this is an ARMv4 core
2695 @item @code{arm920t} -- this is an ARMv5 core
2696 @item @code{arm926ejs} -- this is an ARMv5 core
2697 @item @code{arm966e} -- this is an ARMv5 core
2698 @item @code{arm9tdmi} -- this is an ARMv4 core
2699 @item @code{avr} -- implements Atmel's 8-bit AVR instruction set.
2700 (Support for this is preliminary and incomplete.)
2701 @item @code{cortex_a8} -- this is an ARMv7 core
2702 @item @code{cortex_m3} -- this is an ARMv7 core, supporting only the
2703 compact Thumb2 instruction set.  It supports one variant:
2704 @itemize @minus
2705 @item @code{lm3s} ... Use this when debugging older Stellaris LM3S targets.
2706 This will cause OpenOCD to use a software reset rather than asserting
2707 SRST, to avoid a issue with clearing the debug registers.
2708 This is fixed in Fury Rev B, DustDevil Rev B, Tempest; these revisions will
2709 be detected and the normal reset behaviour used.
2710 @end itemize
2711 @item @code{fa526} -- resembles arm920 (w/o Thumb)
2712 @item @code{feroceon} -- resembles arm926
2713 @item @code{mips_m4k} -- a MIPS core.  This supports one variant:
2714 @itemize @minus
2715 @item @code{ejtag_srst} ... Use this when debugging targets that do not
2716 provide a functional SRST line on the EJTAG connector.  This causes
2717 OpenOCD to instead use an EJTAG software reset command to reset the
2718 processor.
2719 You still need to enable @option{srst} on the @command{reset_config}
2720 command to enable OpenOCD hardware reset functionality.
2721 @end itemize
2722 @item @code{xscale} -- this is actually an architecture,
2723 not a CPU type.  It is based on the ARMv5 architecture.
2724 There are several variants defined:
2725 @itemize @minus
2726 @item @code{ixp42x}, @code{ixp45x}, @code{ixp46x},
2727 @code{pxa27x} ... instruction register length is 7 bits
2728 @item @code{pxa250}, @code{pxa255},
2729 @code{pxa26x} ... instruction register length is 5 bits
2730 @end itemize
2731 @end itemize
2732 @end deffn
2733
2734 To avoid being confused by the variety of ARM based cores, remember
2735 this key point: @emph{ARM is a technology licencing company}.
2736 (See: @url{http://www.arm.com}.)
2737 The CPU name used by OpenOCD will reflect the CPU design that was
2738 licenced, not a vendor brand which incorporates that design.
2739 Name prefixes like arm7, arm9, arm11, and cortex
2740 reflect design generations;
2741 while names like ARMv4, ARMv5, ARMv6, and ARMv7
2742 reflect an architecture version implemented by a CPU design.
2743
2744 @anchor{Target Configuration}
2745 @section Target Configuration
2746
2747 Before creating a ``target'', you must have added its TAP to the scan chain.
2748 When you've added that TAP, you will have a @code{dotted.name}
2749 which is used to set up the CPU support.
2750 The chip-specific configuration file will normally configure its CPU(s)
2751 right after it adds all of the chip's TAPs to the scan chain.
2752
2753 Although you can set up a target in one step, it's often clearer if you
2754 use shorter commands and do it in two steps:  create it, then configure
2755 optional parts.
2756 All operations on the target after it's created will use a new
2757 command, created as part of target creation.
2758
2759 The two main things to configure after target creation are
2760 a work area, which usually has target-specific defaults even
2761 if the board setup code overrides them later;
2762 and event handlers (@pxref{Target Events}), which tend
2763 to be much more board-specific.
2764 The key steps you use might look something like this
2765
2766 @example
2767 target create MyTarget cortex_m3 -chain-position mychip.cpu
2768 $MyTarget configure -work-area-phys 0x08000 -work-area-size 8096
2769 $MyTarget configure -event reset-deassert-pre @{ jtag_rclk 5 @}
2770 $MyTarget configure -event reset-init @{ myboard_reinit @}
2771 @end example
2772
2773 You should specify a working area if you can; typically it uses some
2774 on-chip SRAM.
2775 Such a working area can speed up many things, including bulk
2776 writes to target memory;
2777 flash operations like checking to see if memory needs to be erased;
2778 GDB memory checksumming;
2779 and more.
2780
2781 @quotation Warning
2782 On more complex chips, the work area can become
2783 inaccessible when application code
2784 (such as an operating system)
2785 enables or disables the MMU.
2786 For example, the particular MMU context used to acess the virtual
2787 address will probably matter ... and that context might not have
2788 easy access to other addresses needed.
2789 At this writing, OpenOCD doesn't have much MMU intelligence.
2790 @end quotation
2791
2792 It's often very useful to define a @code{reset-init} event handler.
2793 For systems that are normally used with a boot loader,
2794 common tasks include updating clocks and initializing memory
2795 controllers.
2796 That may be needed to let you write the boot loader into flash,
2797 in order to ``de-brick'' your board; or to load programs into
2798 external DDR memory without having run the boot loader.
2799
2800 @deffn Command {target create} target_name type configparams...
2801 This command creates a GDB debug target that refers to a specific JTAG tap.
2802 It enters that target into a list, and creates a new
2803 command (@command{@var{target_name}}) which is used for various
2804 purposes including additional configuration.
2805
2806 @itemize @bullet
2807 @item @var{target_name} ...  is the name of the debug target.
2808 By convention this should be the same as the @emph{dotted.name}
2809 of the TAP associated with this target, which must be specified here
2810 using the @code{-chain-position @var{dotted.name}} configparam.
2811
2812 This name is also used to create the target object command,
2813 referred to here as @command{$target_name},
2814 and in other places the target needs to be identified.
2815 @item @var{type} ... specifies the target type.  @xref{target types}.
2816 @item @var{configparams} ...  all parameters accepted by
2817 @command{$target_name configure} are permitted.
2818 If the target is big-endian, set it here with @code{-endian big}.
2819 If the variant matters, set it here with @code{-variant}.
2820
2821 You @emph{must} set the @code{-chain-position @var{dotted.name}} here.
2822 @end itemize
2823 @end deffn
2824
2825 @deffn Command {$target_name configure} configparams...
2826 The options accepted by this command may also be
2827 specified as parameters to @command{target create}.
2828 Their values can later be queried one at a time by
2829 using the @command{$target_name cget} command.
2830
2831 @emph{Warning:} changing some of these after setup is dangerous.
2832 For example, moving a target from one TAP to another;
2833 and changing its endianness or variant.
2834
2835 @itemize @bullet
2836
2837 @item @code{-chain-position} @var{dotted.name} -- names the TAP
2838 used to access this target.
2839
2840 @item @code{-endian} (@option{big}|@option{little}) -- specifies
2841 whether the CPU uses big or little endian conventions
2842
2843 @item @code{-event} @var{event_name} @var{event_body} --
2844 @xref{Target Events}.
2845 Note that this updates a list of named event handlers.
2846 Calling this twice with two different event names assigns
2847 two different handlers, but calling it twice with the
2848 same event name assigns only one handler.
2849
2850 @item @code{-variant} @var{name} -- specifies a variant of the target,
2851 which OpenOCD needs to know about.
2852
2853 @item @code{-work-area-backup} (@option{0}|@option{1}) -- says
2854 whether the work area gets backed up; by default, it doesn't.
2855 When possible, use a working_area that doesn't need to be backed up,
2856 since performing a backup slows down operations.
2857
2858 @item @code{-work-area-size} @var{size} -- specify/set the work area
2859
2860 @item @code{-work-area-phys} @var{address} -- set the work area
2861 base @var{address} to be used when no MMU is active.
2862
2863 @item @code{-work-area-virt} @var{address} -- set the work area
2864 base @var{address} to be used when an MMU is active.
2865
2866 @end itemize
2867 @end deffn
2868
2869 @section Other $target_name Commands
2870 @cindex object command
2871
2872 The Tcl/Tk language has the concept of object commands,
2873 and OpenOCD adopts that same model for targets.
2874
2875 A good Tk example is a on screen button.
2876 Once a button is created a button
2877 has a name (a path in Tk terms) and that name is useable as a first
2878 class command. For example in Tk, one can create a button and later
2879 configure it like this:
2880
2881 @example
2882 # Create
2883 button .foobar -background red -command @{ foo @}
2884 # Modify
2885 .foobar configure -foreground blue
2886 # Query
2887 set x [.foobar cget -background]
2888 # Report
2889 puts [format "The button is %s" $x]
2890 @end example
2891
2892 In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
2893 button, and its object commands are invoked the same way.
2894
2895 @example
2896 str912.cpu    mww 0x1234 0x42
2897 omap3530.cpu  mww 0x5555 123
2898 @end example
2899
2900 The commands supported by OpenOCD target objects are:
2901
2902 @deffn Command {$target_name arp_examine}
2903 @deffnx Command {$target_name arp_halt}
2904 @deffnx Command {$target_name arp_poll}
2905 @deffnx Command {$target_name arp_reset}
2906 @deffnx Command {$target_name arp_waitstate}
2907 Internal OpenOCD scripts (most notably @file{startup.tcl})
2908 use these to deal with specific reset cases.
2909 They are not otherwise documented here.
2910 @end deffn
2911
2912 @deffn Command {$target_name array2mem} arrayname width address count
2913 @deffnx Command {$target_name mem2array} arrayname width address count
2914 These provide an efficient script-oriented interface to memory.
2915 The @code{array2mem} primitive writes bytes, halfwords, or words;
2916 while @code{mem2array} reads them.
2917 In both cases, the TCL side uses an array, and
2918 the target side uses raw memory.
2919
2920 The efficiency comes from enabling the use of
2921 bulk JTAG data transfer operations.
2922 The script orientation comes from working with data
2923 values that are packaged for use by TCL scripts;
2924 @command{mdw} type primitives only print data they retrieve,
2925 and neither store nor return those values.
2926
2927 @itemize
2928 @item @var{arrayname} ... is the name of an array variable
2929 @item @var{width} ... is 8/16/32 - indicating the memory access size
2930 @item @var{address} ... is the target memory address
2931 @item @var{count} ... is the number of elements to process
2932 @end itemize
2933 @end deffn
2934
2935 @deffn Command {$target_name cget} queryparm
2936 Each configuration parameter accepted by
2937 @command{$target_name configure}
2938 can be individually queried, to return its current value.
2939 The @var{queryparm} is a parameter name
2940 accepted by that command, such as @code{-work-area-phys}.
2941 There are a few special cases:
2942
2943 @itemize @bullet
2944 @item @code{-event} @var{event_name} -- returns the handler for the
2945 event named @var{event_name}.
2946 This is a special case because setting a handler requires
2947 two parameters.
2948 @item @code{-type} -- returns the target type.
2949 This is a special case because this is set using
2950 @command{target create} and can't be changed
2951 using @command{$target_name configure}.
2952 @end itemize
2953
2954 For example, if you wanted to summarize information about
2955 all the targets you might use something like this:
2956
2957 @example
2958 for @{ set x 0 @} @{ $x < [target count] @} @{ incr x @} @{
2959     set name [target number $x]
2960     set y [$name cget -endian]
2961     set z [$name cget -type]
2962     puts [format "Chip %d is %s, Endian: %s, type: %s" \
2963                  $x $name $y $z]
2964 @}
2965 @end example
2966 @end deffn
2967
2968 @anchor{target curstate}
2969 @deffn Command {$target_name curstate}
2970 Displays the current target state:
2971 @code{debug-running},
2972 @code{halted},
2973 @code{reset},
2974 @code{running}, or @code{unknown}.
2975 (Also, @pxref{Event Polling}.)
2976 @end deffn
2977
2978 @deffn Command {$target_name eventlist}
2979 Displays a table listing all event handlers
2980 currently associated with this target.
2981 @xref{Target Events}.
2982 @end deffn
2983
2984 @deffn Command {$target_name invoke-event} event_name
2985 Invokes the handler for the event named @var{event_name}.
2986 (This is primarily intended for use by OpenOCD framework
2987 code, for example by the reset code in @file{startup.tcl}.)
2988 @end deffn
2989
2990 @deffn Command {$target_name mdw} addr [count]
2991 @deffnx Command {$target_name mdh} addr [count]
2992 @deffnx Command {$target_name mdb} addr [count]
2993 Display contents of address @var{addr}, as
2994 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
2995 or 8-bit bytes (@command{mdb}).
2996 If @var{count} is specified, displays that many units.
2997 (If you want to manipulate the data instead of displaying it,
2998 see the @code{mem2array} primitives.)
2999 @end deffn
3000
3001 @deffn Command {$target_name mww} addr word
3002 @deffnx Command {$target_name mwh} addr halfword
3003 @deffnx Command {$target_name mwb} addr byte
3004 Writes the specified @var{word} (32 bits),
3005 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3006 at the specified address @var{addr}.
3007 @end deffn
3008
3009 @anchor{Target Events}
3010 @section Target Events
3011 @cindex events
3012 At various times, certain things can happen, or you want them to happen.
3013 For example:
3014 @itemize @bullet
3015 @item What should happen when GDB connects? Should your target reset?
3016 @item When GDB tries to flash the target, do you need to enable the flash via a special command?
3017 @item During reset, do you need to write to certain memory locations
3018 to set up system clocks or
3019 to reconfigure the SDRAM?
3020 @end itemize
3021
3022 All of the above items can be addressed by target event handlers.
3023 These are set up by @command{$target_name configure -event} or
3024 @command{target create ... -event}.
3025
3026 The programmer's model matches the @code{-command} option used in Tcl/Tk
3027 buttons and events.  The two examples below act the same, but one creates
3028 and invokes a small procedure while the other inlines it.
3029
3030 @example
3031 proc my_attach_proc @{ @} @{
3032     echo "Reset..."
3033     reset halt
3034 @}
3035 mychip.cpu configure -event gdb-attach my_attach_proc
3036 mychip.cpu configure -event gdb-attach @{
3037     echo "Reset..."
3038     reset halt
3039 @}
3040 @end example
3041
3042 The following target events are defined:
3043
3044 @itemize @bullet
3045 @item @b{debug-halted}
3046 @* The target has halted for debug reasons (i.e.: breakpoint)
3047 @item @b{debug-resumed}
3048 @* The target has resumed (i.e.: gdb said run)
3049 @item @b{early-halted}
3050 @* Occurs early in the halt process
3051 @ignore
3052 @item @b{examine-end}
3053 @* Currently not used (goal: when JTAG examine completes)
3054 @item @b{examine-start}
3055 @* Currently not used (goal: when JTAG examine starts)
3056 @end ignore
3057 @item @b{gdb-attach}
3058 @* When GDB connects
3059 @item @b{gdb-detach}
3060 @* When GDB disconnects
3061 @item @b{gdb-end}
3062 @* When the target has halted and GDB is not doing anything (see early halt)
3063 @item @b{gdb-flash-erase-start}
3064 @* Before the GDB flash process tries to erase the flash
3065 @item @b{gdb-flash-erase-end}
3066 @* After the GDB flash process has finished erasing the flash
3067 @item @b{gdb-flash-write-start}
3068 @* Before GDB writes to the flash
3069 @item @b{gdb-flash-write-end}
3070 @* After GDB writes to the flash
3071 @item @b{gdb-start}
3072 @* Before the target steps, gdb is trying to start/resume the target
3073 @item @b{halted}
3074 @* The target has halted
3075 @ignore
3076 @item @b{old-gdb_program_config}
3077 @* DO NOT USE THIS: Used internally
3078 @item @b{old-pre_resume}
3079 @* DO NOT USE THIS: Used internally
3080 @end ignore
3081 @item @b{reset-assert-pre}
3082 @* Issued as part of @command{reset} processing
3083 after SRST and/or TRST were activated and deactivated,
3084 but before reset is asserted on the tap.
3085 @item @b{reset-assert-post}
3086 @* Issued as part of @command{reset} processing
3087 when reset is asserted on the tap.
3088 @item @b{reset-deassert-pre}
3089 @* Issued as part of @command{reset} processing
3090 when reset is about to be released on the tap.
3091
3092 For some chips, this may be a good place to make sure
3093 the JTAG clock is slow enough to work before the PLL
3094 has been set up to allow faster JTAG speeds.
3095 @item @b{reset-deassert-post}
3096 @* Issued as part of @command{reset} processing
3097 when reset has been released on the tap.
3098 @item @b{reset-end}
3099 @* Issued as the final step in @command{reset} processing.
3100 @ignore
3101 @item @b{reset-halt-post}
3102 @* Currently not used
3103 @item @b{reset-halt-pre}
3104 @* Currently not used
3105 @end ignore
3106 @item @b{reset-init}
3107 @* Used by @b{reset init} command for board-specific initialization.
3108 This event fires after @emph{reset-deassert-post}.
3109
3110 This is where you would configure PLLs and clocking, set up DRAM so
3111 you can download programs that don't fit in on-chip SRAM, set up pin
3112 multiplexing, and so on.
3113 @item @b{reset-start}
3114 @* Issued as part of @command{reset} processing
3115 before either SRST or TRST are activated.
3116 @ignore
3117 @item @b{reset-wait-pos}
3118 @* Currently not used
3119 @item @b{reset-wait-pre}
3120 @* Currently not used
3121 @end ignore
3122 @item @b{resume-start}
3123 @* Before any target is resumed
3124 @item @b{resume-end}
3125 @* After all targets have resumed
3126 @item @b{resume-ok}
3127 @* Success
3128 @item @b{resumed}
3129 @* Target has resumed
3130 @end itemize
3131
3132
3133 @node Flash Commands
3134 @chapter Flash Commands
3135
3136 OpenOCD has different commands for NOR and NAND flash;
3137 the ``flash'' command works with NOR flash, while
3138 the ``nand'' command works with NAND flash.
3139 This partially reflects different hardware technologies:
3140 NOR flash usually supports direct CPU instruction and data bus access,
3141 while data from a NAND flash must be copied to memory before it can be
3142 used.  (SPI flash must also be copied to memory before use.)
3143 However, the documentation also uses ``flash'' as a generic term;
3144 for example, ``Put flash configuration in board-specific files''.
3145
3146 Flash Steps:
3147 @enumerate
3148 @item Configure via the command @command{flash bank}
3149 @* Do this in a board-specific configuration file,
3150 passing parameters as needed by the driver.
3151 @item Operate on the flash via @command{flash subcommand}
3152 @* Often commands to manipulate the flash are typed by a human, or run
3153 via a script in some automated way.  Common tasks include writing a
3154 boot loader, operating system, or other data.
3155 @item GDB Flashing
3156 @* Flashing via GDB requires the flash be configured via ``flash
3157 bank'', and the GDB flash features be enabled.
3158 @xref{GDB Configuration}.
3159 @end enumerate
3160
3161 Many CPUs have the ablity to ``boot'' from the first flash bank.
3162 This means that misprogramming that bank can ``brick'' a system,
3163 so that it can't boot.
3164 JTAG tools, like OpenOCD, are often then used to ``de-brick'' the
3165 board by (re)installing working boot firmware.
3166
3167 @anchor{NOR Configuration}
3168 @section Flash Configuration Commands
3169 @cindex flash configuration
3170
3171 @deffn {Config Command} {flash bank} driver base size chip_width bus_width target [driver_options]
3172 Configures a flash bank which provides persistent storage
3173 for addresses from @math{base} to @math{base + size - 1}.
3174 These banks will often be visible to GDB through the target's memory map.
3175 In some cases, configuring a flash bank will activate extra commands;
3176 see the driver-specific documentation.
3177
3178 @itemize @bullet
3179 @item @var{driver} ... identifies the controller driver
3180 associated with the flash bank being declared.
3181 This is usually @code{cfi} for external flash, or else
3182 the name of a microcontroller with embedded flash memory.
3183 @xref{Flash Driver List}.
3184 @item @var{base} ... Base address of the flash chip.
3185 @item @var{size} ... Size of the chip, in bytes.
3186 For some drivers, this value is detected from the hardware.
3187 @item @var{chip_width} ... Width of the flash chip, in bytes;
3188 ignored for most microcontroller drivers.
3189 @item @var{bus_width} ... Width of the data bus used to access the
3190 chip, in bytes; ignored for most microcontroller drivers.
3191 @item @var{target} ... Names the target used to issue
3192 commands to the flash controller.
3193 @comment Actually, it's currently a controller-specific parameter...
3194 @item @var{driver_options} ... drivers may support, or require,
3195 additional parameters.  See the driver-specific documentation
3196 for more information.
3197 @end itemize
3198 @quotation Note
3199 This command is not available after OpenOCD initialization has completed.
3200 Use it in board specific configuration files, not interactively.
3201 @end quotation
3202 @end deffn
3203
3204 @comment the REAL name for this command is "ocd_flash_banks"
3205 @comment less confusing would be:  "flash list" (like "nand list")
3206 @deffn Command {flash banks}
3207 Prints a one-line summary of each device declared
3208 using @command{flash bank}, numbered from zero.
3209 Note that this is the @emph{plural} form;
3210 the @emph{singular} form is a very different command.
3211 @end deffn
3212
3213 @deffn Command {flash probe} num
3214 Identify the flash, or validate the parameters of the configured flash. Operation
3215 depends on the flash type.
3216 The @var{num} parameter is a value shown by @command{flash banks}.
3217 Most flash commands will implicitly @emph{autoprobe} the bank;
3218 flash drivers can distinguish between probing and autoprobing,
3219 but most don't bother.
3220 @end deffn
3221
3222 @section Erasing, Reading, Writing to Flash
3223 @cindex flash erasing
3224 @cindex flash reading
3225 @cindex flash writing
3226 @cindex flash programming
3227
3228 One feature distinguishing NOR flash from NAND or serial flash technologies
3229 is that for read access, it acts exactly like any other addressible memory.
3230 This means you can use normal memory read commands like @command{mdw} or
3231 @command{dump_image} with it, with no special @command{flash} subcommands.
3232 @xref{Memory access}, and @ref{Image access}.
3233
3234 Write access works differently.  Flash memory normally needs to be erased
3235 before it's written.  Erasing a sector turns all of its bits to ones, and
3236 writing can turn ones into zeroes.  This is why there are special commands
3237 for interactive erasing and writing, and why GDB needs to know which parts
3238 of the address space hold NOR flash memory.
3239
3240 @quotation Note
3241 Most of these erase and write commands leverage the fact that NOR flash
3242 chips consume target address space.  They implicitly refer to the current
3243 JTAG target, and map from an address in that target's address space
3244 back to a flash bank.
3245 @comment In May 2009, those mappings may fail if any bank associated
3246 @comment with that target doesn't succesfuly autoprobe ... bug worth fixing?
3247 A few commands use abstract addressing based on bank and sector numbers,
3248 and don't depend on searching the current target and its address space.
3249 Avoid confusing the two command models.
3250 @end quotation
3251
3252 Some flash chips implement software protection against accidental writes,
3253 since such buggy writes could in some cases ``brick'' a system.
3254 For such systems, erasing and writing may require sector protection to be
3255 disabled first.
3256 Examples include CFI flash such as ``Intel Advanced Bootblock flash'',
3257 and AT91SAM7 on-chip flash.
3258 @xref{flash protect}.
3259
3260 @anchor{flash erase_sector}
3261 @deffn Command {flash erase_sector} num first last
3262 Erase sectors in bank @var{num}, starting at sector @var{first} up to and including
3263 @var{last}. Sector numbering starts at 0.
3264 The @var{num} parameter is a value shown by @command{flash banks}.
3265 @end deffn
3266
3267 @deffn Command {flash erase_address} address length
3268 Erase sectors starting at @var{address} for @var{length} bytes.
3269 The flash bank to use is inferred from the @var{address}, and
3270 the specified length must stay within that bank.
3271 As a special case, when @var{length} is zero and @var{address} is
3272 the start of the bank, the whole flash is erased.
3273 @end deffn
3274
3275 @deffn Command {flash fillw} address word length
3276 @deffnx Command {flash fillh} address halfword length
3277 @deffnx Command {flash fillb} address byte length
3278 Fills flash memory with the specified @var{word} (32 bits),
3279 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3280 starting at @var{address} and continuing
3281 for @var{length} units (word/halfword/byte).
3282 No erasure is done before writing; when needed, that must be done
3283 before issuing this command.
3284 Writes are done in blocks of up to 1024 bytes, and each write is
3285 verified by reading back the data and comparing it to what was written.
3286 The flash bank to use is inferred from the @var{address} of
3287 each block, and the specified length must stay within that bank.
3288 @end deffn
3289 @comment no current checks for errors if fill blocks touch multiple banks!
3290
3291 @anchor{flash write_bank}
3292 @deffn Command {flash write_bank} num filename offset
3293 Write the binary @file{filename} to flash bank @var{num},
3294 starting at @var{offset} bytes from the beginning of the bank.
3295 The @var{num} parameter is a value shown by @command{flash banks}.
3296 @end deffn
3297
3298 @anchor{flash write_image}
3299 @deffn Command {flash write_image} [erase] filename [offset] [type]
3300 Write the image @file{filename} to the current target's flash bank(s).
3301 A relocation @var{offset} may be specified, in which case it is added
3302 to the base address for each section in the image.
3303 The file [@var{type}] can be specified
3304 explicitly as @option{bin} (binary), @option{ihex} (Intel hex),
3305 @option{elf} (ELF file), @option{s19} (Motorola s19).
3306 @option{mem}, or @option{builder}.
3307 The relevant flash sectors will be erased prior to programming
3308 if the @option{erase} parameter is given.
3309 The flash bank to use is inferred from the @var{address} of
3310 each image segment.
3311 @end deffn
3312
3313 @section Other Flash commands
3314 @cindex flash protection
3315
3316 @deffn Command {flash erase_check} num
3317 Check erase state of sectors in flash bank @var{num},
3318 and display that status.
3319 The @var{num} parameter is a value shown by @command{flash banks}.
3320 This is the only operation that
3321 updates the erase state information displayed by @option{flash info}. That means you have
3322 to issue an @command{flash erase_check} command after erasing or programming the device
3323 to get updated information.
3324 (Code execution may have invalidated any state records kept by OpenOCD.)
3325 @end deffn
3326
3327 @deffn Command {flash info} num
3328 Print info about flash bank @var{num}
3329 The @var{num} parameter is a value shown by @command{flash banks}.
3330 The information includes per-sector protect status.
3331 @end deffn
3332
3333 @anchor{flash protect}
3334 @deffn Command {flash protect} num first last (on|off)
3335 Enable (@var{on}) or disable (@var{off}) protection of flash sectors
3336 @var{first} to @var{last} of flash bank @var{num}.
3337 The @var{num} parameter is a value shown by @command{flash banks}.
3338 @end deffn
3339
3340 @deffn Command {flash protect_check} num
3341 Check protection state of sectors in flash bank @var{num}.
3342 The @var{num} parameter is a value shown by @command{flash banks}.
3343 @comment @option{flash erase_sector} using the same syntax.
3344 @end deffn
3345
3346 @anchor{Flash Driver List}
3347 @section Flash Drivers, Options, and Commands
3348 As noted above, the @command{flash bank} command requires a driver name,
3349 and allows driver-specific options and behaviors.
3350 Some drivers also activate driver-specific commands.
3351
3352 @subsection External Flash
3353
3354 @deffn {Flash Driver} cfi
3355 @cindex Common Flash Interface
3356 @cindex CFI
3357 The ``Common Flash Interface'' (CFI) is the main standard for
3358 external NOR flash chips, each of which connects to a
3359 specific external chip select on the CPU.
3360 Frequently the first such chip is used to boot the system.
3361 Your board's @code{reset-init} handler might need to
3362 configure additional chip selects using other commands (like: @command{mww} to
3363 configure a bus and its timings) , or
3364 perhaps configure a GPIO pin that controls the ``write protect'' pin
3365 on the flash chip.
3366 The CFI driver can use a target-specific working area to significantly
3367 speed up operation.
3368
3369 The CFI driver can accept the following optional parameters, in any order:
3370
3371 @itemize
3372 @item @var{jedec_probe} ... is used to detect certain non-CFI flash ROMs,
3373 like AM29LV010 and similar types.
3374 @item @var{x16_as_x8} ... when a 16-bit flash is hooked up to an 8-bit bus.
3375 @end itemize
3376
3377 To configure two adjacent banks of 16 MBytes each, both sixteen bits (two bytes)
3378 wide on a sixteen bit bus:
3379
3380 @example
3381 flash bank cfi 0x00000000 0x01000000 2 2 $_TARGETNAME
3382 flash bank cfi 0x01000000 0x01000000 2 2 $_TARGETNAME
3383 @end example
3384 @c "cfi part_id" disabled
3385 @end deffn
3386
3387 @subsection Internal Flash (Microcontrollers)
3388
3389 @deffn {Flash Driver} aduc702x
3390 The ADUC702x analog microcontrollers from ST Micro
3391 include internal flash and use ARM7TDMI cores.
3392 The aduc702x flash driver works with models ADUC7019 through ADUC7028.
3393 The setup command only requires the @var{target} argument
3394 since all devices in this family have the same memory layout.
3395
3396 @example
3397 flash bank aduc702x 0 0 0 0 $_TARGETNAME
3398 @end example
3399 @end deffn
3400
3401 @deffn {Flash Driver} at91sam3
3402 @cindex at91sam3
3403 All members of the AT91SAM3 microcontroller family from
3404 Atmel include internal flash and use ARM's Cortex-M3 core. The driver
3405 currently (6/22/09) recognizes the AT91SAM3U[1/2/4][C/E] chips. Note
3406 that the driver was orginaly developed and tested using the
3407 AT91SAM3U4E, using a SAM3U-EK eval board. Support for other chips in
3408 the family was cribbed from the data sheet. @emph{Note to future
3409 readers/updaters: Please remove this worrysome comment after other
3410 chips are confirmed.}
3411
3412 The AT91SAM3U4[E/C] (256K) chips have 2 flash banks, the other chips
3413 (3U[1/2][E/C]) have 1 flash bank.  In all cases the flash banks are at
3414 the following fixed locations:
3415
3416 @example
3417 # Flash bank 0 - all chips
3418 flash bank at91sam3 0x00080000 0 1 1 $_TARGETNAME
3419 # Flash bank 1 - only 256K chips
3420 flash bank at91sam3 0x00100000 0 1 1 $_TARGETNAME
3421 @end example
3422
3423 Internally, the AT91SAM3 flash memory is organized as follows.
3424 Unlike the AT91SAM7 chips, these are not used as parameters
3425 to the @command{flash bank} command:
3426
3427 @itemize
3428 @item @emph{N-Banks:} 256K chips have 2 banks, others have 1 bank.
3429 @item @emph{Bank Size:}  128K/64K Per flash bank
3430 @item @emph{Sectors:} 16 or 8 per bank
3431 @item @emph{SectorSize:} 8K Per Sector
3432 @item @emph{PageSize:} 256 bytes per page. Note that OpenOCD operates on 'sector' sizes, not page sizes.
3433 @end itemize
3434
3435 The AT91SAM3 driver adds some additional commands:
3436
3437 @deffn Command {at91sam3 gpnvm}
3438 @deffnx Command {at91sam3 gpnvm clear} number
3439 @deffnx Command {at91sam3 gpnvm set} number
3440 @deffnx Command {at91sam3 gpnvm show} [@option{all}|number]
3441 With no parameters, @command{show} or @command{show all},
3442 shows the status of all GPNVM bits.
3443 With @command{show} @var{number}, displays that bit.
3444
3445 With @command{set} @var{number} or @command{clear} @var{number},
3446 modifies that GPNVM bit.
3447 @end deffn
3448
3449 @deffn Command {at91sam3 info}
3450 This command attempts to display information about the AT91SAM3
3451 chip. @emph{First} it read the @code{CHIPID_CIDR} [address 0x400e0740, see
3452 Section 28.2.1, page 505 of the AT91SAM3U 29/may/2009 datasheet,
3453 document id: doc6430A] and decodes the values. @emph{Second} it reads the
3454 various clock configuration registers and attempts to display how it
3455 believes the chip is configured. By default, the SLOWCLK is assumed to
3456 be 32768 Hz, see the command @command{at91sam3 slowclk}.
3457 @end deffn
3458
3459 @deffn Command {at91sam3 slowclk} [value]
3460 This command shows/sets the slow clock frequency used in the
3461 @command{at91sam3 info} command calculations above.
3462 @end deffn
3463 @end deffn
3464
3465 @deffn {Flash Driver} at91sam7
3466 All members of the AT91SAM7 microcontroller family from Atmel include
3467 internal flash and use ARM7TDMI cores.  The driver automatically
3468 recognizes a number of these chips using the chip identification
3469 register, and autoconfigures itself.
3470
3471 @example
3472 flash bank at91sam7 0 0 0 0 $_TARGETNAME
3473 @end example
3474
3475 For chips which are not recognized by the controller driver, you must
3476 provide additional parameters in the following order:
3477
3478 @itemize
3479 @item @var{chip_model} ... label used with @command{flash info}
3480 @item @var{banks}
3481 @item @var{sectors_per_bank}
3482 @item @var{pages_per_sector}
3483 @item @var{pages_size}
3484 @item @var{num_nvm_bits}
3485 @item @var{freq_khz} ... required if an external clock is provided,
3486 optional (but recommended) when the oscillator frequency is known
3487 @end itemize
3488
3489 It is recommended that you provide zeroes for all of those values
3490 except the clock frequency, so that everything except that frequency
3491 will be autoconfigured.
3492 Knowing the frequency helps ensure correct timings for flash access.
3493
3494 The flash controller handles erases automatically on a page (128/256 byte)
3495 basis, so explicit erase commands are not necessary for flash programming.
3496 However, there is an ``EraseAll`` command that can erase an entire flash
3497 plane (of up to 256KB), and it will be used automatically when you issue
3498 @command{flash erase_sector} or @command{flash erase_address} commands.
3499
3500 @deffn Command {at91sam7 gpnvm} bitnum (@option{set}|@option{clear})
3501 Set or clear a ``General Purpose Non-Volatle Memory'' (GPNVM)
3502 bit for the processor.   Each processor has a number of such bits,
3503 used for controlling features such as brownout detection (so they
3504 are not truly general purpose).
3505 @quotation Note
3506 This assumes that the first flash bank (number 0) is associated with
3507 the appropriate at91sam7 target.
3508 @end quotation
3509 @end deffn
3510 @end deffn
3511
3512 @deffn {Flash Driver} avr
3513 The AVR 8-bit microcontrollers from Atmel integrate flash memory.
3514 @emph{The current implementation is incomplete.}
3515 @comment - defines mass_erase ... pointless given flash_erase_address
3516 @end deffn
3517
3518 @deffn {Flash Driver} ecosflash
3519 @emph{No idea what this is...}
3520 The @var{ecosflash} driver defines one mandatory parameter,
3521 the name of a modules of target code which is downloaded
3522 and executed.
3523 @end deffn
3524
3525 @deffn {Flash Driver} lpc2000
3526 Most members of the LPC2000 microcontroller family from NXP
3527 include internal flash and use ARM7TDMI cores.
3528 The @var{lpc2000} driver defines two mandatory and one optional parameters,
3529 which must appear in the following order:
3530
3531 @itemize
3532 @item @var{variant} ... required, may be
3533 @var{lpc2000_v1} (older LPC21xx and LPC22xx)
3534 or @var{lpc2000_v2} (LPC213x, LPC214x, LPC210[123], LPC23xx and LPC24xx)
3535 @item @var{clock_kHz} ... the frequency, in kiloHertz,
3536 at which the core is running
3537 @item @var{calc_checksum} ... optional (but you probably want to provide this!),
3538 telling the driver to calculate a valid checksum for the exception vector table.
3539 @end itemize
3540
3541 LPC flashes don't require the chip and bus width to be specified.
3542
3543 @example
3544 flash bank lpc2000 0x0 0x7d000 0 0 $_TARGETNAME \
3545       lpc2000_v2 14765 calc_checksum
3546 @end example
3547
3548 @deffn {Command} {lpc2000 part_id} bank
3549 Displays the four byte part identifier associated with
3550 the specified flash @var{bank}.
3551 @end deffn
3552 @end deffn
3553
3554 @deffn {Flash Driver} lpc288x
3555 The LPC2888 microcontroller from NXP needs slightly different flash
3556 support from its lpc2000 siblings.
3557 The @var{lpc288x} driver defines one mandatory parameter,
3558 the programming clock rate in Hz.
3559 LPC flashes don't require the chip and bus width to be specified.
3560
3561 @example
3562 flash bank lpc288x 0 0 0 0 $_TARGETNAME 12000000
3563 @end example
3564 @end deffn
3565
3566 @deffn {Flash Driver} ocl
3567 @emph{No idea what this is, other than using some arm7/arm9 core.}
3568
3569 @example
3570 flash bank ocl 0 0 0 0 $_TARGETNAME
3571 @end example
3572 @end deffn
3573
3574 @deffn {Flash Driver} pic32mx
3575 The PIC32MX microcontrollers are based on the MIPS 4K cores,
3576 and integrate flash memory.
3577 @emph{The current implementation is incomplete.}
3578
3579 @example
3580 flash bank pix32mx 0 0 0 0 $_TARGETNAME
3581 @end example
3582
3583 @comment numerous *disabled* commands are defined:
3584 @comment - chip_erase ... pointless given flash_erase_address
3585 @comment - lock, unlock ... pointless given protect on/off (yes?)
3586 @comment - pgm_word ... shouldn't bank be deduced from address??
3587 Some pic32mx-specific commands are defined:
3588 @deffn Command {pic32mx pgm_word} address value bank
3589 Programs the specified 32-bit @var{value} at the given @var{address}
3590 in the specified chip @var{bank}.
3591 @end deffn
3592 @end deffn
3593
3594 @deffn {Flash Driver} stellaris
3595 All members of the Stellaris LM3Sxxx microcontroller family from
3596 Texas Instruments
3597 include internal flash and use ARM Cortex M3 cores.
3598 The driver automatically recognizes a number of these chips using
3599 the chip identification register, and autoconfigures itself.
3600 @footnote{Currently there is a @command{stellaris mass_erase} command.
3601 That seems pointless since the same effect can be had using the
3602 standard @command{flash erase_address} command.}
3603
3604 @example
3605 flash bank stellaris 0 0 0 0 $_TARGETNAME
3606 @end example
3607 @end deffn
3608
3609 @deffn {Flash Driver} stm32x
3610 All members of the STM32 microcontroller family from ST Microelectronics
3611 include internal flash and use ARM Cortex M3 cores.
3612 The driver automatically recognizes a number of these chips using
3613 the chip identification register, and autoconfigures itself.
3614
3615 @example
3616 flash bank stm32x 0 0 0 0 $_TARGETNAME
3617 @end example
3618
3619 Some stm32x-specific commands
3620 @footnote{Currently there is a @command{stm32x mass_erase} command.
3621 That seems pointless since the same effect can be had using the
3622 standard @command{flash erase_address} command.}
3623 are defined:
3624
3625 @deffn Command {stm32x lock} num
3626 Locks the entire stm32 device.
3627 The @var{num} parameter is a value shown by @command{flash banks}.
3628 @end deffn
3629
3630 @deffn Command {stm32x unlock} num
3631 Unlocks the entire stm32 device.
3632 The @var{num} parameter is a value shown by @command{flash banks}.
3633 @end deffn
3634
3635 @deffn Command {stm32x options_read} num
3636 Read and display the stm32 option bytes written by
3637 the @command{stm32x options_write} command.
3638 The @var{num} parameter is a value shown by @command{flash banks}.
3639 @end deffn
3640
3641 @deffn Command {stm32x options_write} num (@option{SWWDG}|@option{HWWDG}) (@option{RSTSTNDBY}|@option{NORSTSTNDBY}) (@option{RSTSTOP}|@option{NORSTSTOP})
3642 Writes the stm32 option byte with the specified values.
3643 The @var{num} parameter is a value shown by @command{flash banks}.
3644 @end deffn
3645 @end deffn
3646
3647 @deffn {Flash Driver} str7x
3648 All members of the STR7 microcontroller family from ST Microelectronics
3649 include internal flash and use ARM7TDMI cores.
3650 The @var{str7x} driver defines one mandatory parameter, @var{variant},
3651 which is either @code{STR71x}, @code{STR73x} or @code{STR75x}.
3652
3653 @example
3654 flash bank str7x 0x40000000 0x00040000 0 0 $_TARGETNAME STR71x
3655 @end example
3656
3657 @deffn Command {str7x disable_jtag} bank
3658 Activate the Debug/Readout protection mechanism
3659 for the specified flash bank.
3660 @end deffn
3661 @end deffn
3662
3663 @deffn {Flash Driver} str9x
3664 Most members of the STR9 microcontroller family from ST Microelectronics
3665 include internal flash and use ARM966E cores.
3666 The str9 needs the flash controller to be configured using
3667 the @command{str9x flash_config} command prior to Flash programming.
3668
3669 @example
3670 flash bank str9x 0x40000000 0x00040000 0 0 $_TARGETNAME
3671 str9x flash_config 0 4 2 0 0x80000
3672 @end example
3673
3674 @deffn Command {str9x flash_config} num bbsr nbbsr bbadr nbbadr
3675 Configures the str9 flash controller.
3676 The @var{num} parameter is a value shown by @command{flash banks}.
3677
3678 @itemize @bullet
3679 @item @var{bbsr} - Boot Bank Size register
3680 @item @var{nbbsr} - Non Boot Bank Size register
3681 @item @var{bbadr} - Boot Bank Start Address register
3682 @item @var{nbbadr} - Boot Bank Start Address register
3683 @end itemize
3684 @end deffn
3685
3686 @end deffn
3687
3688 @deffn {Flash Driver} tms470
3689 Most members of the TMS470 microcontroller family from Texas Instruments
3690 include internal flash and use ARM7TDMI cores.
3691 This driver doesn't require the chip and bus width to be specified.
3692
3693 Some tms470-specific commands are defined:
3694
3695 @deffn Command {tms470 flash_keyset} key0 key1 key2 key3
3696 Saves programming keys in a register, to enable flash erase and write commands.
3697 @end deffn
3698
3699 @deffn Command {tms470 osc_mhz} clock_mhz
3700 Reports the clock speed, which is used to calculate timings.
3701 @end deffn
3702
3703 @deffn Command {tms470 plldis} (0|1)
3704 Disables (@var{1}) or enables (@var{0}) use of the PLL to speed up
3705 the flash clock.
3706 @end deffn
3707 @end deffn
3708
3709 @subsection str9xpec driver
3710 @cindex str9xpec
3711
3712 Here is some background info to help
3713 you better understand how this driver works. OpenOCD has two flash drivers for
3714 the str9:
3715 @enumerate
3716 @item
3717 Standard driver @option{str9x} programmed via the str9 core. Normally used for
3718 flash programming as it is faster than the @option{str9xpec} driver.
3719 @item
3720 Direct programming @option{str9xpec} using the flash controller. This is an
3721 ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
3722 core does not need to be running to program using this flash driver. Typical use
3723 for this driver is locking/unlocking the target and programming the option bytes.
3724 @end enumerate
3725
3726 Before we run any commands using the @option{str9xpec} driver we must first disable
3727 the str9 core. This example assumes the @option{str9xpec} driver has been
3728 configured for flash bank 0.
3729 @example
3730 # assert srst, we do not want core running
3731 # while accessing str9xpec flash driver
3732 jtag_reset 0 1
3733 # turn off target polling
3734 poll off
3735 # disable str9 core
3736 str9xpec enable_turbo 0
3737 # read option bytes
3738 str9xpec options_read 0
3739 # re-enable str9 core
3740 str9xpec disable_turbo 0
3741 poll on
3742 reset halt
3743 @end example
3744 The above example will read the str9 option bytes.
3745 When performing a unlock remember that you will not be able to halt the str9 - it
3746 has been locked. Halting the core is not required for the @option{str9xpec} driver
3747 as mentioned above, just issue the commands above manually or from a telnet prompt.
3748
3749 @deffn {Flash Driver} str9xpec
3750 Only use this driver for locking/unlocking the device or configuring the option bytes.
3751 Use the standard str9 driver for programming.
3752 Before using the flash commands the turbo mode must be enabled using the
3753 @command{str9xpec enable_turbo} command.
3754
3755 Several str9xpec-specific commands are defined:
3756
3757 @deffn Command {str9xpec disable_turbo} num
3758 Restore the str9 into JTAG chain.
3759 @end deffn
3760
3761 @deffn Command {str9xpec enable_turbo} num
3762 Enable turbo mode, will simply remove the str9 from the chain and talk
3763 directly to the embedded flash controller.
3764 @end deffn
3765
3766 @deffn Command {str9xpec lock} num
3767 Lock str9 device. The str9 will only respond to an unlock command that will
3768 erase the device.
3769 @end deffn
3770
3771 @deffn Command {str9xpec part_id} num
3772 Prints the part identifier for bank @var{num}.
3773 @end deffn
3774
3775 @deffn Command {str9xpec options_cmap} num (@option{bank0}|@option{bank1})
3776 Configure str9 boot bank.
3777 @end deffn
3778
3779 @deffn Command {str9xpec options_lvdsel} num (@option{vdd}|@option{vdd_vddq})
3780 Configure str9 lvd source.
3781 @end deffn
3782
3783 @deffn Command {str9xpec options_lvdthd} num (@option{2.4v}|@option{2.7v})
3784 Configure str9 lvd threshold.
3785 @end deffn
3786
3787 @deffn Command {str9xpec options_lvdwarn} bank (@option{vdd}|@option{vdd_vddq})
3788 Configure str9 lvd reset warning source.
3789 @end deffn
3790
3791 @deffn Command {str9xpec options_read} num
3792 Read str9 option bytes.
3793 @end deffn
3794
3795 @deffn Command {str9xpec options_write} num
3796 Write str9 option bytes.
3797 @end deffn
3798
3799 @deffn Command {str9xpec unlock} num
3800 unlock str9 device.
3801 @end deffn
3802
3803 @end deffn
3804
3805
3806 @section mFlash
3807
3808 @subsection mFlash Configuration
3809 @cindex mFlash Configuration
3810
3811 @deffn {Config Command} {mflash bank} soc base RST_pin target
3812 Configures a mflash for @var{soc} host bank at
3813 address @var{base}.
3814 The pin number format depends on the host GPIO naming convention.
3815 Currently, the mflash driver supports s3c2440 and pxa270.
3816
3817 Example for s3c2440 mflash where @var{RST pin} is GPIO B1:
3818
3819 @example
3820 mflash bank s3c2440 0x10000000 1b 0
3821 @end example
3822
3823 Example for pxa270 mflash where @var{RST pin} is GPIO 43:
3824
3825 @example
3826 mflash bank pxa270 0x08000000 43 0
3827 @end example
3828 @end deffn
3829
3830 @subsection mFlash commands
3831 @cindex mFlash commands
3832
3833 @deffn Command {mflash config pll} frequency
3834 Configure mflash PLL.
3835 The @var{frequency} is the mflash input frequency, in Hz.
3836 Issuing this command will erase mflash's whole internal nand and write new pll.
3837 After this command, mflash needs power-on-reset for normal operation.
3838 If pll was newly configured, storage and boot(optional) info also need to be update.
3839 @end deffn
3840
3841 @deffn Command {mflash config boot}
3842 Configure bootable option.
3843 If bootable option is set, mflash offer the first 8 sectors
3844 (4kB) for boot.
3845 @end deffn
3846
3847 @deffn Command {mflash config storage}
3848 Configure storage information.
3849 For the normal storage operation, this information must be
3850 written.
3851 @end deffn
3852
3853 @deffn Command {mflash dump} num filename offset size
3854 Dump @var{size} bytes, starting at @var{offset} bytes from the
3855 beginning of the bank @var{num}, to the file named @var{filename}.
3856 @end deffn
3857
3858 @deffn Command {mflash probe}
3859 Probe mflash.
3860 @end deffn
3861
3862 @deffn Command {mflash write} num filename offset
3863 Write the binary file @var{filename} to mflash bank @var{num}, starting at
3864 @var{offset} bytes from the beginning of the bank.
3865 @end deffn