Driver for USB-JTAG, Altera USB-Blaster and compatibles
[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 * JTAG Hardware Dongles::            JTAG Hardware Dongles
65 * About JIM-Tcl::                    About JIM-Tcl
66 * Running::                          Running OpenOCD
67 * OpenOCD Project Setup::            OpenOCD Project Setup
68 * Config File Guidelines::           Config File Guidelines
69 * Daemon Configuration::             Daemon Configuration
70 * Interface - Dongle Configuration:: Interface - Dongle Configuration
71 * Reset Configuration::              Reset Configuration
72 * TAP Declaration::                  TAP Declaration
73 * CPU Configuration::                CPU Configuration
74 * Flash Commands::                   Flash Commands
75 * NAND Flash Commands::              NAND Flash Commands
76 * PLD/FPGA Commands::                PLD/FPGA Commands
77 * General Commands::                 General Commands
78 * Architecture and Core Commands::   Architecture and Core Commands
79 * JTAG Commands::                    JTAG Commands
80 * Boundary Scan Commands::           Boundary Scan Commands
81 * TFTP::                             TFTP
82 * GDB and OpenOCD::                  Using GDB and OpenOCD
83 * Tcl Scripting API::                Tcl Scripting API
84 * FAQ::                              Frequently Asked Questions
85 * Tcl Crash Course::                 Tcl Crash Course
86 * License::                          GNU Free Documentation License
87
88 @comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
89 @comment case issue with ``Index.html'' and ``index.html''
90 @comment Occurs when creating ``--html --no-split'' output
91 @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html
92 * OpenOCD Concept Index::            Concept Index
93 * Command and Driver Index::         Command and Driver Index
94 @end menu
95
96 @node About
97 @unnumbered About
98 @cindex about
99
100 OpenOCD was created by Dominic Rath as part of a diploma thesis written at the
101 University of Applied Sciences Augsburg (@uref{http://www.fh-augsburg.de}).
102 Since that time, the project has grown into an active open-source project,
103 supported by a diverse community of software and hardware developers from
104 around the world.
105
106 @section What is OpenOCD?
107 @cindex TAP
108 @cindex JTAG
109
110 The Open On-Chip Debugger (OpenOCD) aims to provide debugging,
111 in-system programming and boundary-scan testing for embedded target
112 devices.
113
114 @b{JTAG:} OpenOCD uses a ``hardware interface dongle'' to communicate
115 with the JTAG (IEEE 1149.1) compliant TAPs on your target board.
116 A @dfn{TAP} is a ``Test Access Port'', a module which processes
117 special instructions and data.  TAPs are daisy-chained within and
118 between chips and boards.
119
120 @b{Dongles:} OpenOCD currently supports many types of hardware dongles: USB
121 based, parallel port based, and other standalone boxes that run
122 OpenOCD internally. @xref{JTAG Hardware Dongles}.
123
124 @b{GDB Debug:} It allows ARM7 (ARM7TDMI and ARM720t), ARM9 (ARM920T,
125 ARM922T, ARM926EJ--S, ARM966E--S), XScale (PXA25x, IXP42x) and
126 Cortex-M3 (Stellaris LM3 and ST STM32) based cores to be
127 debugged via the GDB protocol.
128
129 @b{Flash Programing:} Flash writing is supported for external CFI
130 compatible NOR flashes (Intel and AMD/Spansion command set) and several
131 internal flashes (LPC1700, LPC2000, AT91SAM7, AT91SAM3U, STR7x, STR9x, LM3, and
132 STM32x). Preliminary support for various NAND flash controllers
133 (LPC3180, Orion, S3C24xx, more) controller is included.
134
135 @section OpenOCD Web Site
136
137 The OpenOCD web site provides the latest public news from the community:
138
139 @uref{http://openocd.berlios.de/web/}
140
141 @section Latest User's Guide:
142
143 The user's guide you are now reading may not be the latest one
144 available.  A version for more recent code may be available.
145 Its HTML form is published irregularly at:
146
147 @uref{http://openocd.berlios.de/doc/html/index.html}
148
149 PDF form is likewise published at:
150
151 @uref{http://openocd.berlios.de/doc/pdf/openocd.pdf}
152
153 @section OpenOCD User's Forum
154
155 There is an OpenOCD forum (phpBB) hosted by SparkFun:
156
157 @uref{http://forum.sparkfun.com/viewforum.php?f=18}
158
159
160 @node Developers
161 @chapter OpenOCD Developer Resources
162 @cindex developers
163
164 If you are interested in improving the state of OpenOCD's debugging and
165 testing support, new contributions will be welcome.  Motivated developers
166 can produce new target, flash or interface drivers, improve the
167 documentation, as well as more conventional bug fixes and enhancements.
168
169 The resources in this chapter are available for developers wishing to explore
170 or expand the OpenOCD source code.
171
172 @section OpenOCD GIT Repository
173
174 During the 0.3.x release cycle, OpenOCD switched from Subversion to
175 a GIT repository hosted at SourceForge.  The repository URL is:
176
177 @uref{git://openocd.git.sourceforge.net/gitroot/openocd/openocd}
178
179 You may prefer to use a mirror and the HTTP protocol:
180
181 @uref{http://repo.or.cz/r/openocd.git}
182
183 With standard GIT tools, use @command{git clone} to initialize
184 a local repository, and @command{git pull} to update it.
185 There are also gitweb pages letting you browse the repository
186 with a web browser, or download arbitrary snapshots without
187 needing a GIT client:
188
189 @uref{http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd}
190
191 @uref{http://repo.or.cz/w/openocd.git}
192
193 The @file{README} file contains the instructions for building the project
194 from the repository or a snapshot.
195
196 Developers that want to contribute patches to the OpenOCD system are
197 @b{strongly} encouraged to work against mainline.
198 Patches created against older versions may require additional
199 work from their submitter in order to be updated for newer releases.
200
201 @section Doxygen Developer Manual
202
203 During the 0.2.x release cycle, the OpenOCD project began
204 providing a Doxygen reference manual.  This document contains more
205 technical information about the software internals, development
206 processes, and similar documentation:
207
208 @uref{http://openocd.berlios.de/doc/doxygen/index.html}
209
210 This document is a work-in-progress, but contributions would be welcome
211 to fill in the gaps.  All of the source files are provided in-tree,
212 listed in the Doxyfile configuration in the top of the source tree.
213
214 @section OpenOCD Developer Mailing List
215
216 The OpenOCD Developer Mailing List provides the primary means of
217 communication between developers:
218
219 @uref{https://lists.berlios.de/mailman/listinfo/openocd-development}
220
221 Discuss and submit patches to this list.
222 The @file{PATCHES} file contains basic information about how
223 to prepare patches.
224
225
226 @node JTAG Hardware Dongles
227 @chapter JTAG Hardware Dongles
228 @cindex dongles
229 @cindex FTDI
230 @cindex wiggler
231 @cindex zy1000
232 @cindex printer port
233 @cindex USB Adapter
234 @cindex RTCK
235
236 Defined: @b{dongle}: A small device that plugins into a computer and serves as
237 an adapter .... [snip]
238
239 In the OpenOCD case, this generally refers to @b{a small adapater} one
240 attaches to your computer via USB or the Parallel Printer Port.  The
241 execption being the Zylin ZY1000 which is a small box you attach via
242 an ethernet cable. The Zylin ZY1000 has the advantage that it does not
243 require any drivers to be installed on the developer PC. It also has
244 a built in web interface. It supports RTCK/RCLK or adaptive clocking
245 and has a built in relay to power cycle targets remotely.
246
247
248 @section Choosing a Dongle
249
250 There are several things you should keep in mind when choosing a dongle.
251
252 @enumerate
253 @item @b{Voltage} What voltage is your target - 1.8, 2.8, 3.3, or 5V?
254 Does your dongle support it?  You might need a level converter.
255 @item @b{Pinout} What pinout does your target board use?
256 Does your dongle support it?  You may be able to use jumper
257 wires, or an "octopus" connector, to convert pinouts.
258 @item @b{Connection} Does your computer have the USB, printer, or
259 Ethernet port needed?
260 @item @b{RTCK} Do you require RTCK? Also known as ``adaptive clocking''
261 @end enumerate
262
263 @section Stand alone Systems
264
265 @b{ZY1000} See: @url{http://www.zylin.com/zy1000.html} Technically, not a
266 dongle, but a standalone box. The ZY1000 has the advantage that it does
267 not require any drivers installed on the developer PC. It also has
268 a built in web interface. It supports RTCK/RCLK or adaptive clocking
269 and has a built in relay to power cycle targets remotely.
270
271 @section USB FT2232 Based
272
273 There are many USB JTAG dongles on the market, many of them are based
274 on a chip from ``Future Technology Devices International'' (FTDI)
275 known as the FTDI FT2232; this is a USB full speed (12 Mbps) chip.
276 See: @url{http://www.ftdichip.com} for more information.
277 In summer 2009, USB high speed (480 Mbps) versions of these FTDI
278 chips are starting to become available in JTAG adapters.
279
280 @itemize @bullet
281 @item @b{usbjtag}
282 @* Link @url{http://www.hs-augsburg.de/~hhoegl/proj/usbjtag/usbjtag.html}
283 @item @b{jtagkey}
284 @* See: @url{http://www.amontec.com/jtagkey.shtml}
285 @item @b{jtagkey2}
286 @* See: @url{http://www.amontec.com/jtagkey2.shtml}
287 @item @b{oocdlink}
288 @* See: @url{http://www.oocdlink.com} By Joern Kaipf
289 @item @b{signalyzer}
290 @* See: @url{http://www.signalyzer.com}
291 @item @b{evb_lm3s811}
292 @* See: @url{http://www.luminarymicro.com} - The Stellaris LM3S811 eval board has an FTD2232C chip built in.
293 @item @b{luminary_icdi}
294 @* See: @url{http://www.luminarymicro.com} - Luminary In-Circuit Debug Interface (ICDI) Board, included in the Stellaris LM3S9B90 and LM3S9B92 Evaluation Kits.
295 @item @b{olimex-jtag}
296 @* See: @url{http://www.olimex.com}
297 @item @b{flyswatter}
298 @* See: @url{http://www.tincantools.com}
299 @item @b{turtelizer2}
300 @* See:
301 @uref{http://www.ethernut.de/en/hardware/turtelizer/index.html, Turtelizer 2}, or
302 @url{http://www.ethernut.de}
303 @item @b{comstick}
304 @* Link: @url{http://www.hitex.com/index.php?id=383}
305 @item @b{stm32stick}
306 @* Link @url{http://www.hitex.com/stm32-stick}
307 @item @b{axm0432_jtag}
308 @* Axiom AXM-0432 Link @url{http://www.axman.com}
309 @item @b{cortino}
310 @* Link @url{http://www.hitex.com/index.php?id=cortino}
311 @end itemize
312
313 @section USB-JTAG / Altera USB-Blaster compatibles
314
315 These devices also show up as FTDI devices, but are not
316 protocol-compatible with the FT2232 devices. They are, however,
317 protocol-compatible among themselves.  USB-JTAG devices typically consist
318 of a FT245 followed by a CPLD that understands a particular protocol,
319 or emulate this protocol using some other hardware.
320
321 They may appear under different USB VID/PID depending on the particular
322 product.  The driver can be configured to search for any VID/PID pair
323 (see the section on driver commands).
324
325 @itemize
326 @item @b{USB-JTAG} Kolja Waschk's USB Blaster-compatible adapter
327 @* Link: @url{http://www.ixo.de/info/usb_jtag/}
328 @item @b{Altera USB-Blaster}
329 @* Link: @url{http://www.altera.com/literature/ug/ug_usb_blstr.pdf}
330 @end itemize
331
332 @section USB JLINK based
333 There are several OEM versions of the Segger @b{JLINK} adapter. It is
334 an example of a micro controller based JTAG adapter, it uses an
335 AT91SAM764 internally.
336
337 @itemize @bullet
338 @item @b{ATMEL SAMICE} Only works with ATMEL chips!
339 @* Link: @url{http://www.atmel.com/dyn/products/tools_card.asp?tool_id=3892}
340 @item @b{SEGGER JLINK}
341 @* Link: @url{http://www.segger.com/jlink.html}
342 @item @b{IAR J-Link}
343 @* Link: @url{http://www.iar.com/website1/1.0.1.0/369/1/index.php}
344 @end itemize
345
346 @section USB RLINK based
347 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.
348
349 @itemize @bullet
350 @item @b{Raisonance RLink}
351 @* Link: @url{http://www.raisonance.com/products/RLink.php}
352 @item @b{STM32 Primer}
353 @* Link: @url{http://www.stm32circle.com/resources/stm32primer.php}
354 @item @b{STM32 Primer2}
355 @* Link: @url{http://www.stm32circle.com/resources/stm32primer2.php}
356 @end itemize
357
358 @section USB Other
359 @itemize @bullet
360 @item @b{USBprog}
361 @* Link: @url{http://www.embedded-projects.net/usbprog} - which uses an Atmel MEGA32 and a UBN9604
362
363 @item @b{USB - Presto}
364 @* Link: @url{http://tools.asix.net/prg_presto.htm}
365
366 @item @b{Versaloon-Link}
367 @* Link: @url{http://www.simonqian.com/en/Versaloon}
368
369 @item @b{ARM-JTAG-EW}
370 @* Link: @url{http://www.olimex.com/dev/arm-jtag-ew.html}
371 @end itemize
372
373 @section IBM PC Parallel Printer Port Based
374
375 The two well known ``JTAG Parallel Ports'' cables are the Xilnx DLC5
376 and the MacGraigor Wiggler. There are many clones and variations of
377 these on the market.
378
379 Note that parallel ports are becoming much less common, so if you
380 have the choice you should probably avoid these adapters in favor
381 of USB-based ones.
382
383 @itemize @bullet
384
385 @item @b{Wiggler} - There are many clones of this.
386 @* Link: @url{http://www.macraigor.com/wiggler.htm}
387
388 @item @b{DLC5} - From XILINX - There are many clones of this
389 @* Link: Search the web for: ``XILINX DLC5'' - it is no longer
390 produced, PDF schematics are easily found and it is easy to make.
391
392 @item @b{Amontec - JTAG Accelerator}
393 @* Link: @url{http://www.amontec.com/jtag_accelerator.shtml}
394
395 @item @b{GW16402}
396 @* Link: @url{http://www.gateworks.com/products/avila_accessories/gw16042.php}
397
398 @item @b{Wiggler2}
399 @*@uref{http://www.ccac.rwth-aachen.de/@/~michaels/@/index.php/hardware/@/armjtag,
400 Improved parallel-port wiggler-style JTAG adapter}
401
402 @item @b{Wiggler_ntrst_inverted}
403 @* Yet another variation - See the source code, src/jtag/parport.c
404
405 @item @b{old_amt_wiggler}
406 @* Unknown - probably not on the market today
407
408 @item @b{arm-jtag}
409 @* Link: Most likely @url{http://www.olimex.com/dev/arm-jtag.html} [another wiggler clone]
410
411 @item @b{chameleon}
412 @* Link: @url{http://www.amontec.com/chameleon.shtml}
413
414 @item @b{Triton}
415 @* Unknown.
416
417 @item @b{Lattice}
418 @* ispDownload from Lattice Semiconductor
419 @url{http://www.latticesemi.com/lit/docs/@/devtools/dlcable.pdf}
420
421 @item @b{flashlink}
422 @* From ST Microsystems;
423 @uref{http://www.st.com/stonline/@/products/literature/um/7889.pdf,
424 FlashLINK JTAG programing cable for PSD and uPSD}
425
426 @end itemize
427
428 @section Other...
429 @itemize @bullet
430
431 @item @b{ep93xx}
432 @* An EP93xx based Linux machine using the GPIO pins directly.
433
434 @item @b{at91rm9200}
435 @* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
436
437 @end itemize
438
439 @node About JIM-Tcl
440 @chapter About JIM-Tcl
441 @cindex JIM Tcl
442 @cindex tcl
443
444 OpenOCD includes a small ``Tcl Interpreter'' known as JIM-Tcl.
445 This programming language provides a simple and extensible
446 command interpreter.
447
448 All commands presented in this Guide are extensions to JIM-Tcl.
449 You can use them as simple commands, without needing to learn
450 much of anything about Tcl.
451 Alternatively, can write Tcl programs with them.
452
453 You can learn more about JIM at its website,  @url{http://jim.berlios.de}.
454
455 @itemize @bullet
456 @item @b{JIM vs. Tcl}
457 @* JIM-TCL is a stripped down version of the well known Tcl language,
458 which can be found here: @url{http://www.tcl.tk}. JIM-Tcl has far
459 fewer features. JIM-Tcl is a single .C file and a single .H file and
460 implements the basic Tcl command set. In contrast: Tcl 8.6 is a
461 4.2 MB .zip file containing 1540 files.
462
463 @item @b{Missing Features}
464 @* Our practice has been: Add/clone the real Tcl feature if/when
465 needed. We welcome JIM Tcl improvements, not bloat.
466
467 @item @b{Scripts}
468 @* OpenOCD configuration scripts are JIM Tcl Scripts. OpenOCD's
469 command interpreter today is a mixture of (newer)
470 JIM-Tcl commands, and (older) the orginal command interpreter.
471
472 @item @b{Commands}
473 @* At the OpenOCD telnet command line (or via the GDB mon command) one
474 can type a Tcl for() loop, set variables, etc.
475 Some of the commands documented in this guide are implemented
476 as Tcl scripts, from a @file{startup.tcl} file internal to the server.
477
478 @item @b{Historical Note}
479 @* JIM-Tcl was introduced to OpenOCD in spring 2008.
480
481 @item @b{Need a crash course in Tcl?}
482 @*@xref{Tcl Crash Course}.
483 @end itemize
484
485 @node Running
486 @chapter Running
487 @cindex command line options
488 @cindex logfile
489 @cindex directory search
490
491 The @option{--help} option shows:
492 @verbatim
493 bash$ openocd --help
494
495 --help       | -h       display this help
496 --version    | -v       display OpenOCD version
497 --file       | -f       use configuration file <name>
498 --search     | -s       dir to search for config files and scripts
499 --debug      | -d       set debug level <0-3>
500 --log_output | -l       redirect log output to file <name>
501 --command    | -c       run <command>
502 --pipe       | -p       use pipes when talking to gdb
503 @end verbatim
504
505 By default OpenOCD reads the configuration file @file{openocd.cfg}.
506 To specify a different (or multiple)
507 configuration file, you can use the @option{-f} option. For example:
508
509 @example
510 openocd -f config1.cfg -f config2.cfg -f config3.cfg
511 @end example
512
513 Configuration files and scripts are searched for in
514 @enumerate
515 @item the current directory,
516 @item any search dir specified on the command line using the @option{-s} option,
517 @item @file{$HOME/.openocd} (not on Windows),
518 @item the site wide script library @file{$pkgdatadir/site} and
519 @item the OpenOCD-supplied script library @file{$pkgdatadir/scripts}.
520 @end enumerate
521 The first found file with a matching file name will be used.
522
523 @section Simple setup, no customization
524
525 In the best case, you can use two scripts from one of the script
526 libraries, hook up your JTAG adapter, and start the server ... and
527 your JTAG setup will just work "out of the box".  Always try to
528 start by reusing those scripts, but assume you'll need more
529 customization even if this works.  @xref{OpenOCD Project Setup}.
530
531 If you find a script for your JTAG adapter, and for your board or
532 target, you may be able to hook up your JTAG adapter then start
533 the server like:
534
535 @example
536 openocd -f interface/ADAPTER.cfg -f board/MYBOARD.cfg
537 @end example
538
539 You might also need to configure which reset signals are present,
540 using @option{-c 'reset_config trst_and_srst'} or something similar.
541 If all goes well you'll see output something like
542
543 @example
544 Open On-Chip Debugger 0.4.0 (2010-01-14-15:06)
545 For bug reports, read
546         http://openocd.berlios.de/doc/doxygen/bugs.html
547 Info : JTAG tap: lm3s.cpu tap/device found: 0x3ba00477
548        (mfg: 0x23b, part: 0xba00, ver: 0x3)
549 @end example
550
551 Seeing that "tap/device found" message, and no warnings, means
552 the JTAG communication is working.  That's a key milestone, but
553 you'll probably need more project-specific setup.
554
555 @section What OpenOCD does as it starts
556
557 OpenOCD starts by processing the configuration commands provided
558 on the command line or, if there were no @option{-c command} or
559 @option{-f file.cfg} options given, in @file{openocd.cfg}.
560 @xref{Configuration Stage}.
561 At the end of the configuration stage it verifies the JTAG scan
562 chain defined using those commands; your configuration should
563 ensure that this always succeeds.
564 Normally, OpenOCD then starts running as a daemon.
565 Alternatively, commands may be used to terminate the configuration
566 stage early, perform work (such as updating some flash memory),
567 and then shut down without acting as a daemon.
568
569 Once OpenOCD starts running as a daemon, it waits for connections from
570 clients (Telnet, GDB, Other) and processes the commands issued through
571 those channels.
572
573 If you are having problems, you can enable internal debug messages via
574 the @option{-d} option.
575
576 Also it is possible to interleave JIM-Tcl commands w/config scripts using the
577 @option{-c} command line switch.
578
579 To enable debug output (when reporting problems or working on OpenOCD
580 itself), use the @option{-d} command line switch. This sets the
581 @option{debug_level} to "3", outputting the most information,
582 including debug messages. The default setting is "2", outputting only
583 informational messages, warnings and errors. You can also change this
584 setting from within a telnet or gdb session using @command{debug_level
585 <n>} (@pxref{debug_level}).
586
587 You can redirect all output from the daemon to a file using the
588 @option{-l <logfile>} switch.
589
590 For details on the @option{-p} option. @xref{Connecting to GDB}.
591
592 Note! OpenOCD will launch the GDB & telnet server even if it can not
593 establish a connection with the target. In general, it is possible for
594 the JTAG controller to be unresponsive until the target is set up
595 correctly via e.g. GDB monitor commands in a GDB init script.
596
597 @node OpenOCD Project Setup
598 @chapter OpenOCD Project Setup
599
600 To use OpenOCD with your development projects, you need to do more than
601 just connecting the JTAG adapter hardware (dongle) to your development board
602 and then starting the OpenOCD server.
603 You also need to configure that server so that it knows
604 about that adapter and board, and helps your work.
605 You may also want to connect OpenOCD to GDB, possibly
606 using Eclipse or some other GUI.
607
608 @section Hooking up the JTAG Adapter
609
610 Today's most common case is a dongle with a JTAG cable on one side
611 (such as a ribbon cable with a 10-pin or 20-pin IDC connector)
612 and a USB cable on the other.
613 Instead of USB, some cables use Ethernet;
614 older ones may use a PC parallel port, or even a serial port.
615
616 @enumerate
617 @item @emph{Start with power to your target board turned off},
618 and nothing connected to your JTAG adapter.
619 If you're particularly paranoid, unplug power to the board.
620 It's important to have the ground signal properly set up,
621 unless you are using a JTAG adapter which provides
622 galvanic isolation between the target board and the
623 debugging host.
624
625 @item @emph{Be sure it's the right kind of JTAG connector.}
626 If your dongle has a 20-pin ARM connector, you need some kind
627 of adapter (or octopus, see below) to hook it up to
628 boards using 14-pin or 10-pin connectors ... or to 20-pin
629 connectors which don't use ARM's pinout.
630
631 In the same vein, make sure the voltage levels are compatible.
632 Not all JTAG adapters have the level shifters needed to work
633 with 1.2 Volt boards.
634
635 @item @emph{Be certain the cable is properly oriented} or you might
636 damage your board.  In most cases there are only two possible
637 ways to connect the cable.
638 Connect the JTAG cable from your adapter to the board.
639 Be sure it's firmly connected.
640
641 In the best case, the connector is keyed to physically
642 prevent you from inserting it wrong.
643 This is most often done using a slot on the board's male connector
644 housing, which must match a key on the JTAG cable's female connector.
645 If there's no housing, then you must look carefully and
646 make sure pin 1 on the cable hooks up to pin 1 on the board.
647 Ribbon cables are frequently all grey except for a wire on one
648 edge, which is red.  The red wire is pin 1.
649
650 Sometimes dongles provide cables where one end is an ``octopus'' of
651 color coded single-wire connectors, instead of a connector block.
652 These are great when converting from one JTAG pinout to another,
653 but are tedious to set up.
654 Use these with connector pinout diagrams to help you match up the
655 adapter signals to the right board pins.
656
657 @item @emph{Connect the adapter's other end} once the JTAG cable is connected.
658 A USB, parallel, or serial port connector will go to the host which
659 you are using to run OpenOCD.
660 For Ethernet, consult the documentation and your network administrator.
661
662 For USB based JTAG adapters you have an easy sanity check at this point:
663 does the host operating system see the JTAG adapter?  If that host is an
664 MS-Windows host, you'll need to install a driver before OpenOCD works.
665
666 @item @emph{Connect the adapter's power supply, if needed.}
667 This step is primarily for non-USB adapters,
668 but sometimes USB adapters need extra power.
669
670 @item @emph{Power up the target board.}
671 Unless you just let the magic smoke escape,
672 you're now ready to set up the OpenOCD server
673 so you can use JTAG to work with that board.
674
675 @end enumerate
676
677 Talk with the OpenOCD server using
678 telnet (@code{telnet localhost 4444} on many systems) or GDB.
679 @xref{GDB and OpenOCD}.
680
681 @section Project Directory
682
683 There are many ways you can configure OpenOCD and start it up.
684
685 A simple way to organize them all involves keeping a
686 single directory for your work with a given board.
687 When you start OpenOCD from that directory,
688 it searches there first for configuration files, scripts,
689 files accessed through semihosting,
690 and for code you upload to the target board.
691 It is also the natural place to write files,
692 such as log files and data you download from the board.
693
694 @section Configuration Basics
695
696 There are two basic ways of configuring OpenOCD, and
697 a variety of ways you can mix them.
698 Think of the difference as just being how you start the server:
699
700 @itemize
701 @item Many @option{-f file} or @option{-c command} options on the command line
702 @item No options, but a @dfn{user config file}
703 in the current directory named @file{openocd.cfg}
704 @end itemize
705
706 Here is an example @file{openocd.cfg} file for a setup
707 using a Signalyzer FT2232-based JTAG adapter to talk to
708 a board with an Atmel AT91SAM7X256 microcontroller:
709
710 @example
711 source [find interface/signalyzer.cfg]
712
713 # GDB can also flash my flash!
714 gdb_memory_map enable
715 gdb_flash_program enable
716
717 source [find target/sam7x256.cfg]
718 @end example
719
720 Here is the command line equivalent of that configuration:
721
722 @example
723 openocd -f interface/signalyzer.cfg \
724         -c "gdb_memory_map enable" \
725         -c "gdb_flash_program enable" \
726         -f target/sam7x256.cfg
727 @end example
728
729 You could wrap such long command lines in shell scripts,
730 each supporting a different development task.
731 One might re-flash the board with a specific firmware version.
732 Another might set up a particular debugging or run-time environment.
733
734 @quotation Important
735 At this writing (October 2009) the command line method has
736 problems with how it treats variables.
737 For example, after @option{-c "set VAR value"}, or doing the
738 same in a script, the variable @var{VAR} will have no value
739 that can be tested in a later script.
740 @end quotation
741
742 Here we will focus on the simpler solution:  one user config
743 file, including basic configuration plus any TCL procedures
744 to simplify your work.
745
746 @section User Config Files
747 @cindex config file, user
748 @cindex user config file
749 @cindex config file, overview
750
751 A user configuration file ties together all the parts of a project
752 in one place.
753 One of the following will match your situation best:
754
755 @itemize
756 @item Ideally almost everything comes from configuration files
757 provided by someone else.
758 For example, OpenOCD distributes a @file{scripts} directory
759 (probably in @file{/usr/share/openocd/scripts} on Linux).
760 Board and tool vendors can provide these too, as can individual
761 user sites; the @option{-s} command line option lets you say
762 where to find these files.  (@xref{Running}.)
763 The AT91SAM7X256 example above works this way.
764
765 Three main types of non-user configuration file each have their
766 own subdirectory in the @file{scripts} directory:
767
768 @enumerate
769 @item @b{interface} -- one for each kind of JTAG adapter/dongle
770 @item @b{board} -- one for each different board
771 @item @b{target} -- the chips which integrate CPUs and other JTAG TAPs
772 @end enumerate
773
774 Best case:  include just two files, and they handle everything else.
775 The first is an interface config file.
776 The second is board-specific, and it sets up the JTAG TAPs and
777 their GDB targets (by deferring to some @file{target.cfg} file),
778 declares all flash memory, and leaves you nothing to do except
779 meet your deadline:
780
781 @example
782 source [find interface/olimex-jtag-tiny.cfg]
783 source [find board/csb337.cfg]
784 @end example
785
786 Boards with a single microcontroller often won't need more
787 than the target config file, as in the AT91SAM7X256 example.
788 That's because there is no external memory (flash, DDR RAM), and
789 the board differences are encapsulated by application code.
790
791 @item Maybe you don't know yet what your board looks like to JTAG.
792 Once you know the @file{interface.cfg} file to use, you may
793 need help from OpenOCD to discover what's on the board.
794 Once you find the TAPs, you can just search for appropriate
795 configuration files ... or write your own, from the bottom up.
796 @xref{Autoprobing}.
797
798 @item You can often reuse some standard config files but
799 need to write a few new ones, probably a @file{board.cfg} file.
800 You will be using commands described later in this User's Guide,
801 and working with the guidelines in the next chapter.
802
803 For example, there may be configuration files for your JTAG adapter
804 and target chip, but you need a new board-specific config file
805 giving access to your particular flash chips.
806 Or you might need to write another target chip configuration file
807 for a new chip built around the Cortex M3 core.
808
809 @quotation Note
810 When you write new configuration files, please submit
811 them for inclusion in the next OpenOCD release.
812 For example, a @file{board/newboard.cfg} file will help the
813 next users of that board, and a @file{target/newcpu.cfg}
814 will help support users of any board using that chip.
815 @end quotation
816
817 @item
818 You may may need to write some C code.
819 It may be as simple as a supporting a new ft2232 or parport
820 based dongle; a bit more involved, like a NAND or NOR flash
821 controller driver; or a big piece of work like supporting
822 a new chip architecture.
823 @end itemize
824
825 Reuse the existing config files when you can.
826 Look first in the @file{scripts/boards} area, then @file{scripts/targets}.
827 You may find a board configuration that's a good example to follow.
828
829 When you write config files, separate the reusable parts
830 (things every user of that interface, chip, or board needs)
831 from ones specific to your environment and debugging approach.
832 @itemize
833
834 @item
835 For example, a @code{gdb-attach} event handler that invokes
836 the @command{reset init} command will interfere with debugging
837 early boot code, which performs some of the same actions
838 that the @code{reset-init} event handler does.
839
840 @item
841 Likewise, the @command{arm9 vector_catch} command (or
842 @cindex vector_catch
843 its siblings @command{xscale vector_catch}
844 and @command{cortex_m3 vector_catch}) can be a timesaver
845 during some debug sessions, but don't make everyone use that either.
846 Keep those kinds of debugging aids in your user config file,
847 along with messaging and tracing setup.
848 (@xref{Software Debug Messages and Tracing}.)
849
850 @item
851 You might need to override some defaults.
852 For example, you might need to move, shrink, or back up the target's
853 work area if your application needs much SRAM.
854
855 @item
856 TCP/IP port configuration is another example of something which
857 is environment-specific, and should only appear in
858 a user config file.  @xref{TCP/IP Ports}.
859 @end itemize
860
861 @section Project-Specific Utilities
862
863 A few project-specific utility
864 routines may well speed up your work.
865 Write them, and keep them in your project's user config file.
866
867 For example, if you are making a boot loader work on a
868 board, it's nice to be able to debug the ``after it's
869 loaded to RAM'' parts separately from the finicky early
870 code which sets up the DDR RAM controller and clocks.
871 A script like this one, or a more GDB-aware sibling,
872 may help:
873
874 @example
875 proc ramboot @{ @} @{
876     # Reset, running the target's "reset-init" scripts
877     # to initialize clocks and the DDR RAM controller.
878     # Leave the CPU halted.
879     reset init
880
881     # Load CONFIG_SKIP_LOWLEVEL_INIT version into DDR RAM.
882     load_image u-boot.bin 0x20000000
883
884     # Start running.
885     resume 0x20000000
886 @}
887 @end example
888
889 Then once that code is working you will need to make it
890 boot from NOR flash; a different utility would help.
891 Alternatively, some developers write to flash using GDB.
892 (You might use a similar script if you're working with a flash
893 based microcontroller application instead of a boot loader.)
894
895 @example
896 proc newboot @{ @} @{
897     # Reset, leaving the CPU halted.  The "reset-init" event
898     # proc gives faster access to the CPU and to NOR flash;
899     # "reset halt" would be slower.
900     reset init
901
902     # Write standard version of U-Boot into the first two
903     # sectors of NOR flash ... the standard version should
904     # do the same lowlevel init as "reset-init".
905     flash protect 0 0 1 off
906     flash erase_sector 0 0 1
907     flash write_bank 0 u-boot.bin 0x0
908     flash protect 0 0 1 on
909
910     # Reboot from scratch using that new boot loader.
911     reset run
912 @}
913 @end example
914
915 You may need more complicated utility procedures when booting
916 from NAND.
917 That often involves an extra bootloader stage,
918 running from on-chip SRAM to perform DDR RAM setup so it can load
919 the main bootloader code (which won't fit into that SRAM).
920
921 Other helper scripts might be used to write production system images,
922 involving considerably more than just a three stage bootloader.
923
924 @section Target Software Changes
925
926 Sometimes you may want to make some small changes to the software
927 you're developing, to help make JTAG debugging work better.
928 For example, in C or assembly language code you might
929 use @code{#ifdef JTAG_DEBUG} (or its converse) around code
930 handling issues like:
931
932 @itemize @bullet
933
934 @item @b{ARM Semihosting}...
935 @cindex ARM semihosting
936 When linked with a special runtime library provided with many
937 toolchains@footnote{See chapter 8 "Semihosting" in
938 @uref{http://infocenter.arm.com/help/topic/com.arm.doc.dui0203i/DUI0203I_rvct_developer_guide.pdf,
939 ARM DUI 0203I}, the "RealView Compilation Tools Developer Guide".
940 The CodeSourcery EABI toolchain also includes a semihosting library.},
941 your target code can use I/O facilities on the debug host.  That library
942 provides a small set of system calls which are handled by OpenOCD.
943 It can let the debugger provide your system console and a file system,
944 helping with early debugging or providing a more capable environment
945 for sometimes-complex tasks like installing system firmware onto
946 NAND or SPI flash.
947
948 @item @b{ARM Wait-For-Interrupt}...
949 Many ARM chips synchronize the JTAG clock using the core clock.
950 Low power states which stop that core clock thus prevent JTAG access.
951 Idle loops in tasking environments often enter those low power states
952 via the @code{WFI} instruction (or its coprocessor equivalent, before ARMv7).
953
954 You may want to @emph{disable that instruction} in source code,
955 or otherwise prevent using that state,
956 to ensure you can get JTAG access at any time.
957 For example, the OpenOCD @command{halt} command may not
958 work for an idle processor otherwise.
959
960 @item @b{Delay after reset}...
961 Not all chips have good support for debugger access
962 right after reset; many LPC2xxx chips have issues here.
963 Similarly, applications that reconfigure pins used for
964 JTAG access as they start will also block debugger access.
965
966 To work with boards like this, @emph{enable a short delay loop}
967 the first thing after reset, before "real" startup activities.
968 For example, one second's delay is usually more than enough
969 time for a JTAG debugger to attach, so that
970 early code execution can be debugged
971 or firmware can be replaced.
972
973 @item @b{Debug Communications Channel (DCC)}...
974 Some processors include mechanisms to send messages over JTAG.
975 Many ARM cores support these, as do some cores from other vendors.
976 (OpenOCD may be able to use this DCC internally, speeding up some
977 operations like writing to memory.)
978
979 Your application may want to deliver various debugging messages
980 over JTAG, by @emph{linking with a small library of code}
981 provided with OpenOCD and using the utilities there to send
982 various kinds of message.
983 @xref{Software Debug Messages and Tracing}.
984
985 @end itemize
986
987 @node Config File Guidelines
988 @chapter Config File Guidelines
989
990 This chapter is aimed at any user who needs to write a config file,
991 including developers and integrators of OpenOCD and any user who
992 needs to get a new board working smoothly.
993 It provides guidelines for creating those files.
994
995 You should find the following directories under @t{$(INSTALLDIR)/scripts},
996 with files including the ones listed here.
997 Use them as-is where you can; or as models for new files.
998 @itemize @bullet
999 @item @file{interface} ...
1000 think JTAG Dongle. Files that configure JTAG adapters go here.
1001 @example
1002 $ ls interface
1003 arm-jtag-ew.cfg          hitex_str9-comstick.cfg  oocdlink.cfg
1004 arm-usb-ocd.cfg          icebear.cfg              openocd-usb.cfg
1005 at91rm9200.cfg           jlink.cfg                parport.cfg
1006 axm0432.cfg              jtagkey2.cfg             parport_dlc5.cfg
1007 calao-usb-a9260-c01.cfg  jtagkey.cfg              rlink.cfg
1008 calao-usb-a9260-c02.cfg  jtagkey-tiny.cfg         sheevaplug.cfg
1009 calao-usb-a9260.cfg      luminary.cfg             signalyzer.cfg
1010 chameleon.cfg            luminary-icdi.cfg        stm32-stick.cfg
1011 cortino.cfg              luminary-lm3s811.cfg     turtelizer2.cfg
1012 dummy.cfg                olimex-arm-usb-ocd.cfg   usbprog.cfg
1013 flyswatter.cfg           olimex-jtag-tiny.cfg     vsllink.cfg
1014 $
1015 @end example
1016 @item @file{board} ...
1017 think Circuit Board, PWA, PCB, they go by many names.  Board files
1018 contain initialization items that are specific to a board.
1019 They reuse target configuration files, since the same
1020 microprocessor chips are used on many boards,
1021 but support for external parts varies widely.  For
1022 example, the SDRAM initialization sequence for the board, or the type
1023 of external flash and what address it uses.  Any initialization
1024 sequence to enable that external flash or SDRAM should be found in the
1025 board file. Boards may also contain multiple targets:  two CPUs; or
1026 a CPU and an FPGA.
1027 @example
1028 $ ls board
1029 arm_evaluator7t.cfg               keil_mcb1700.cfg
1030 at91rm9200-dk.cfg                 keil_mcb2140.cfg
1031 at91sam9g20-ek.cfg                linksys_nslu2.cfg
1032 atmel_at91sam7s-ek.cfg            logicpd_imx27.cfg
1033 atmel_at91sam9260-ek.cfg          mini2440.cfg
1034 atmel_sam3u_ek.cfg                olimex_LPC2378STK.cfg
1035 crossbow_tech_imote2.cfg          olimex_lpc_h2148.cfg
1036 csb337.cfg                        olimex_sam7_ex256.cfg
1037 csb732.cfg                        olimex_sam9_l9260.cfg
1038 digi_connectcore_wi-9c.cfg        olimex_stm32_h103.cfg
1039 dm355evm.cfg                      omap2420_h4.cfg
1040 dm365evm.cfg                      osk5912.cfg
1041 dm6446evm.cfg                     pic-p32mx.cfg
1042 eir.cfg                           propox_mmnet1001.cfg
1043 ek-lm3s1968.cfg                   pxa255_sst.cfg
1044 ek-lm3s3748.cfg                   sheevaplug.cfg
1045 ek-lm3s811.cfg                    stm3210e_eval.cfg
1046 ek-lm3s9b9x.cfg                   stm32f10x_128k_eval.cfg
1047 hammer.cfg                        str910-eval.cfg
1048 hitex_lpc2929.cfg                 telo.cfg
1049 hitex_stm32-performancestick.cfg  ti_beagleboard.cfg
1050 hitex_str9-comstick.cfg           topas910.cfg
1051 iar_str912_sk.cfg                 topasa900.cfg
1052 imx27ads.cfg                      unknown_at91sam9260.cfg
1053 imx27lnst.cfg                     x300t.cfg
1054 imx31pdk.cfg                      zy1000.cfg
1055 $
1056 @end example
1057 @item @file{target} ...
1058 think chip. The ``target'' directory represents the JTAG TAPs
1059 on a chip
1060 which OpenOCD should control, not a board. Two common types of targets
1061 are ARM chips and FPGA or CPLD chips.
1062 When a chip has multiple TAPs (maybe it has both ARM and DSP cores),
1063 the target config file defines all of them.
1064 @example
1065 $ ls target
1066 aduc702x.cfg     imx27.cfg     pxa255.cfg
1067 ar71xx.cfg       imx31.cfg     pxa270.cfg
1068 at91eb40a.cfg    imx35.cfg     readme.txt
1069 at91r40008.cfg   is5114.cfg    sam7se512.cfg
1070 at91rm9200.cfg   ixp42x.cfg    sam7x256.cfg
1071 at91sam3u1c.cfg  lm3s1968.cfg  samsung_s3c2410.cfg
1072 at91sam3u1e.cfg  lm3s3748.cfg  samsung_s3c2440.cfg
1073 at91sam3u2c.cfg  lm3s6965.cfg  samsung_s3c2450.cfg
1074 at91sam3u2e.cfg  lm3s811.cfg   samsung_s3c4510.cfg
1075 at91sam3u4c.cfg  lm3s9b9x.cfg  samsung_s3c6410.cfg
1076 at91sam3u4e.cfg  lpc1768.cfg   sharp_lh79532.cfg
1077 at91sam3uXX.cfg  lpc2103.cfg   smdk6410.cfg
1078 at91sam7sx.cfg   lpc2124.cfg   smp8634.cfg
1079 at91sam9260.cfg  lpc2129.cfg   stm32.cfg
1080 c100.cfg         lpc2148.cfg   str710.cfg
1081 c100config.tcl   lpc2294.cfg   str730.cfg
1082 c100helper.tcl   lpc2378.cfg   str750.cfg
1083 c100regs.tcl     lpc2478.cfg   str912.cfg
1084 cs351x.cfg       lpc2900.cfg   telo.cfg
1085 davinci.cfg      mega128.cfg   ti_dm355.cfg
1086 dragonite.cfg    netx500.cfg   ti_dm365.cfg
1087 epc9301.cfg      omap2420.cfg  ti_dm6446.cfg
1088 feroceon.cfg     omap3530.cfg  tmpa900.cfg
1089 icepick.cfg      omap5912.cfg  tmpa910.cfg
1090 imx21.cfg        pic32mx.cfg   xba_revA3.cfg
1091 $
1092 @end example
1093 @item @emph{more} ... browse for other library files which may be useful.
1094 For example, there are various generic and CPU-specific utilities.
1095 @end itemize
1096
1097 The @file{openocd.cfg} user config
1098 file may override features in any of the above files by
1099 setting variables before sourcing the target file, or by adding
1100 commands specific to their situation.
1101
1102 @section Interface Config Files
1103
1104 The user config file
1105 should be able to source one of these files with a command like this:
1106
1107 @example
1108 source [find interface/FOOBAR.cfg]
1109 @end example
1110
1111 A preconfigured interface file should exist for every interface in use
1112 today, that said, perhaps some interfaces have only been used by the
1113 sole developer who created it.
1114
1115 A separate chapter gives information about how to set these up.
1116 @xref{Interface - Dongle Configuration}.
1117 Read the OpenOCD source code if you have a new kind of hardware interface
1118 and need to provide a driver for it.
1119
1120 @section Board Config Files
1121 @cindex config file, board
1122 @cindex board config file
1123
1124 The user config file
1125 should be able to source one of these files with a command like this:
1126
1127 @example
1128 source [find board/FOOBAR.cfg]
1129 @end example
1130
1131 The point of a board config file is to package everything
1132 about a given board that user config files need to know.
1133 In summary the board files should contain (if present)
1134
1135 @enumerate
1136 @item One or more @command{source [target/...cfg]} statements
1137 @item NOR flash configuration (@pxref{NOR Configuration})
1138 @item NAND flash configuration (@pxref{NAND Configuration})
1139 @item Target @code{reset} handlers for SDRAM and I/O configuration
1140 @item JTAG adapter reset configuration (@pxref{Reset Configuration})
1141 @item All things that are not ``inside a chip''
1142 @end enumerate
1143
1144 Generic things inside target chips belong in target config files,
1145 not board config files.  So for example a @code{reset-init} event
1146 handler should know board-specific oscillator and PLL parameters,
1147 which it passes to target-specific utility code.
1148
1149 The most complex task of a board config file is creating such a
1150 @code{reset-init} event handler.
1151 Define those handlers last, after you verify the rest of the board
1152 configuration works.
1153
1154 @subsection Communication Between Config files
1155
1156 In addition to target-specific utility code, another way that
1157 board and target config files communicate is by following a
1158 convention on how to use certain variables.
1159
1160 The full Tcl/Tk language supports ``namespaces'', but JIM-Tcl does not.
1161 Thus the rule we follow in OpenOCD is this: Variables that begin with
1162 a leading underscore are temporary in nature, and can be modified and
1163 used at will within a target configuration file.
1164
1165 Complex board config files can do the things like this,
1166 for a board with three chips:
1167
1168 @example
1169 # Chip #1: PXA270 for network side, big endian
1170 set CHIPNAME network
1171 set ENDIAN big
1172 source [find target/pxa270.cfg]
1173 # on return: _TARGETNAME = network.cpu
1174 # other commands can refer to the "network.cpu" target.
1175 $_TARGETNAME configure .... events for this CPU..
1176
1177 # Chip #2: PXA270 for video side, little endian
1178 set CHIPNAME video
1179 set ENDIAN little
1180 source [find target/pxa270.cfg]
1181 # on return: _TARGETNAME = video.cpu
1182 # other commands can refer to the "video.cpu" target.
1183 $_TARGETNAME configure .... events for this CPU..
1184
1185 # Chip #3: Xilinx FPGA for glue logic
1186 set CHIPNAME xilinx
1187 unset ENDIAN
1188 source [find target/spartan3.cfg]
1189 @end example
1190
1191 That example is oversimplified because it doesn't show any flash memory,
1192 or the @code{reset-init} event handlers to initialize external DRAM
1193 or (assuming it needs it) load a configuration into the FPGA.
1194 Such features are usually needed for low-level work with many boards,
1195 where ``low level'' implies that the board initialization software may
1196 not be working.  (That's a common reason to need JTAG tools.  Another
1197 is to enable working with microcontroller-based systems, which often
1198 have no debugging support except a JTAG connector.)
1199
1200 Target config files may also export utility functions to board and user
1201 config files.  Such functions should use name prefixes, to help avoid
1202 naming collisions.
1203
1204 Board files could also accept input variables from user config files.
1205 For example, there might be a @code{J4_JUMPER} setting used to identify
1206 what kind of flash memory a development board is using, or how to set
1207 up other clocks and peripherals.
1208
1209 @subsection Variable Naming Convention
1210 @cindex variable names
1211
1212 Most boards have only one instance of a chip.
1213 However, it should be easy to create a board with more than
1214 one such chip (as shown above).
1215 Accordingly, we encourage these conventions for naming
1216 variables associated with different @file{target.cfg} files,
1217 to promote consistency and
1218 so that board files can override target defaults.
1219
1220 Inputs to target config files include:
1221
1222 @itemize @bullet
1223 @item @code{CHIPNAME} ...
1224 This gives a name to the overall chip, and is used as part of
1225 tap identifier dotted names.
1226 While the default is normally provided by the chip manufacturer,
1227 board files may need to distinguish between instances of a chip.
1228 @item @code{ENDIAN} ...
1229 By default @option{little} - although chips may hard-wire @option{big}.
1230 Chips that can't change endianness don't need to use this variable.
1231 @item @code{CPUTAPID} ...
1232 When OpenOCD examines the JTAG chain, it can be told verify the
1233 chips against the JTAG IDCODE register.
1234 The target file will hold one or more defaults, but sometimes the
1235 chip in a board will use a different ID (perhaps a newer revision).
1236 @end itemize
1237
1238 Outputs from target config files include:
1239
1240 @itemize @bullet
1241 @item @code{_TARGETNAME} ...
1242 By convention, this variable is created by the target configuration
1243 script. The board configuration file may make use of this variable to
1244 configure things like a ``reset init'' script, or other things
1245 specific to that board and that target.
1246 If the chip has 2 targets, the names are @code{_TARGETNAME0},
1247 @code{_TARGETNAME1}, ... etc.
1248 @end itemize
1249
1250 @subsection The reset-init Event Handler
1251 @cindex event, reset-init
1252 @cindex reset-init handler
1253
1254 Board config files run in the OpenOCD configuration stage;
1255 they can't use TAPs or targets, since they haven't been
1256 fully set up yet.
1257 This means you can't write memory or access chip registers;
1258 you can't even verify that a flash chip is present.
1259 That's done later in event handlers, of which the target @code{reset-init}
1260 handler is one of the most important.
1261
1262 Except on microcontrollers, the basic job of @code{reset-init} event
1263 handlers is setting up flash and DRAM, as normally handled by boot loaders.
1264 Microcontrollers rarely use boot loaders; they run right out of their
1265 on-chip flash and SRAM memory.  But they may want to use one of these
1266 handlers too, if just for developer convenience.
1267
1268 @quotation Note
1269 Because this is so very board-specific, and chip-specific, no examples
1270 are included here.
1271 Instead, look at the board config files distributed with OpenOCD.
1272 If you have a boot loader, its source code will help; so will
1273 configuration files for other JTAG tools
1274 (@pxref{Translating Configuration Files}).
1275 @end quotation
1276
1277 Some of this code could probably be shared between different boards.
1278 For example, setting up a DRAM controller often doesn't differ by
1279 much except the bus width (16 bits or 32?) and memory timings, so a
1280 reusable TCL procedure loaded by the @file{target.cfg} file might take
1281 those as parameters.
1282 Similarly with oscillator, PLL, and clock setup;
1283 and disabling the watchdog.
1284 Structure the code cleanly, and provide comments to help
1285 the next developer doing such work.
1286 (@emph{You might be that next person} trying to reuse init code!)
1287
1288 The last thing normally done in a @code{reset-init} handler is probing
1289 whatever flash memory was configured.  For most chips that needs to be
1290 done while the associated target is halted, either because JTAG memory
1291 access uses the CPU or to prevent conflicting CPU access.
1292
1293 @subsection JTAG Clock Rate
1294
1295 Before your @code{reset-init} handler has set up
1296 the PLLs and clocking, you may need to run with
1297 a low JTAG clock rate.
1298 @xref{JTAG Speed}.
1299 Then you'd increase that rate after your handler has
1300 made it possible to use the faster JTAG clock.
1301 When the initial low speed is board-specific, for example
1302 because it depends on a board-specific oscillator speed, then
1303 you should probably set it up in the board config file;
1304 if it's target-specific, it belongs in the target config file.
1305
1306 For most ARM-based processors the fastest JTAG clock@footnote{A FAQ
1307 @uref{http://www.arm.com/support/faqdev/4170.html} gives details.}
1308 is one sixth of the CPU clock; or one eighth for ARM11 cores.
1309 Consult chip documentation to determine the peak JTAG clock rate,
1310 which might be less than that.
1311
1312 @quotation Warning
1313 On most ARMs, JTAG clock detection is coupled to the core clock, so
1314 software using a @option{wait for interrupt} operation blocks JTAG access.
1315 Adaptive clocking provides a partial workaround, but a more complete
1316 solution just avoids using that instruction with JTAG debuggers.
1317 @end quotation
1318
1319 If the board supports adaptive clocking, use the @command{jtag_rclk}
1320 command, in case your board is used with JTAG adapter which
1321 also supports it.  Otherwise use @command{jtag_khz}.
1322 Set the slow rate at the beginning of the reset sequence,
1323 and the faster rate as soon as the clocks are at full speed.
1324
1325 @section Target Config Files
1326 @cindex config file, target
1327 @cindex target config file
1328
1329 Board config files communicate with target config files using
1330 naming conventions as described above, and may source one or
1331 more target config files like this:
1332
1333 @example
1334 source [find target/FOOBAR.cfg]
1335 @end example
1336
1337 The point of a target config file is to package everything
1338 about a given chip that board config files need to know.
1339 In summary the target files should contain
1340
1341 @enumerate
1342 @item Set defaults
1343 @item Add TAPs to the scan chain
1344 @item Add CPU targets (includes GDB support)
1345 @item CPU/Chip/CPU-Core specific features
1346 @item On-Chip flash
1347 @end enumerate
1348
1349 As a rule of thumb, a target file sets up only one chip.
1350 For a microcontroller, that will often include a single TAP,
1351 which is a CPU needing a GDB target, and its on-chip flash.
1352
1353 More complex chips may include multiple TAPs, and the target
1354 config file may need to define them all before OpenOCD
1355 can talk to the chip.
1356 For example, some phone chips have JTAG scan chains that include
1357 an ARM core for operating system use, a DSP,
1358 another ARM core embedded in an image processing engine,
1359 and other processing engines.
1360
1361 @subsection Default Value Boiler Plate Code
1362
1363 All target configuration files should start with code like this,
1364 letting board config files express environment-specific
1365 differences in how things should be set up.
1366
1367 @example
1368 # Boards may override chip names, perhaps based on role,
1369 # but the default should match what the vendor uses
1370 if @{ [info exists CHIPNAME] @} @{
1371    set  _CHIPNAME $CHIPNAME
1372 @} else @{
1373    set  _CHIPNAME sam7x256
1374 @}
1375
1376 # ONLY use ENDIAN with targets that can change it.
1377 if @{ [info exists ENDIAN] @} @{
1378    set  _ENDIAN $ENDIAN
1379 @} else @{
1380    set  _ENDIAN little
1381 @}
1382
1383 # TAP identifiers may change as chips mature, for example with
1384 # new revision fields (the "3" here).  Pick a good default; you
1385 # can pass several such identifiers to the "jtag newtap" command.
1386 if @{ [info exists CPUTAPID ] @} @{
1387    set _CPUTAPID $CPUTAPID
1388 @} else @{
1389    set _CPUTAPID 0x3f0f0f0f
1390 @}
1391 @end example
1392 @c but 0x3f0f0f0f is for an str73x part ...
1393
1394 @emph{Remember:} Board config files may include multiple target
1395 config files, or the same target file multiple times
1396 (changing at least @code{CHIPNAME}).
1397
1398 Likewise, the target configuration file should define
1399 @code{_TARGETNAME} (or @code{_TARGETNAME0} etc) and
1400 use it later on when defining debug targets:
1401
1402 @example
1403 set _TARGETNAME $_CHIPNAME.cpu
1404 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1405 @end example
1406
1407 @subsection Adding TAPs to the Scan Chain
1408 After the ``defaults'' are set up,
1409 add the TAPs on each chip to the JTAG scan chain.
1410 @xref{TAP Declaration}, and the naming convention
1411 for taps.
1412
1413 In the simplest case the chip has only one TAP,
1414 probably for a CPU or FPGA.
1415 The config file for the Atmel AT91SAM7X256
1416 looks (in part) like this:
1417
1418 @example
1419 jtag newtap $_CHIPNAME cpu -irlen 4 -expected-id $_CPUTAPID
1420 @end example
1421
1422 A board with two such at91sam7 chips would be able
1423 to source such a config file twice, with different
1424 values for @code{CHIPNAME}, so
1425 it adds a different TAP each time.
1426
1427 If there are nonzero @option{-expected-id} values,
1428 OpenOCD attempts to verify the actual tap id against those values.
1429 It will issue error messages if there is mismatch, which
1430 can help to pinpoint problems in OpenOCD configurations.
1431
1432 @example
1433 JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f
1434                 (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
1435 ERROR: Tap: sam7x256.cpu - Expected id: 0x12345678, Got: 0x3f0f0f0f
1436 ERROR: expected: mfg: 0x33c, part: 0x2345, ver: 0x1
1437 ERROR:      got: mfg: 0x787, part: 0xf0f0, ver: 0x3
1438 @end example
1439
1440 There are more complex examples too, with chips that have
1441 multiple TAPs.  Ones worth looking at include:
1442
1443 @itemize
1444 @item @file{target/omap3530.cfg} -- with disabled ARM and DSP,
1445 plus a JRC to enable them
1446 @item @file{target/str912.cfg} -- with flash, CPU, and boundary scan
1447 @item @file{target/ti_dm355.cfg} -- with ETM, ARM, and JRC (this JRC
1448 is not currently used)
1449 @end itemize
1450
1451 @subsection Add CPU targets
1452
1453 After adding a TAP for a CPU, you should set it up so that
1454 GDB and other commands can use it.
1455 @xref{CPU Configuration}.
1456 For the at91sam7 example above, the command can look like this;
1457 note that @code{$_ENDIAN} is not needed, since OpenOCD defaults
1458 to little endian, and this chip doesn't support changing that.
1459
1460 @example
1461 set _TARGETNAME $_CHIPNAME.cpu
1462 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1463 @end example
1464
1465 Work areas are small RAM areas associated with CPU targets.
1466 They are used by OpenOCD to speed up downloads,
1467 and to download small snippets of code to program flash chips.
1468 If the chip includes a form of ``on-chip-ram'' - and many do - define
1469 a work area if you can.
1470 Again using the at91sam7 as an example, this can look like:
1471
1472 @example
1473 $_TARGETNAME configure -work-area-phys 0x00200000 \
1474              -work-area-size 0x4000 -work-area-backup 0
1475 @end example
1476
1477 @subsection Chip Reset Setup
1478
1479 As a rule, you should put the @command{reset_config} command
1480 into the board file.  Most things you think you know about a
1481 chip can be tweaked by the board.
1482
1483 Some chips have specific ways the TRST and SRST signals are
1484 managed. In the unusual case that these are @emph{chip specific}
1485 and can never be changed by board wiring, they could go here.
1486 For example, some chips can't support JTAG debugging without
1487 both signals.
1488
1489 Provide a @code{reset-assert} event handler if you can.
1490 Such a handler uses JTAG operations to reset the target,
1491 letting this target config be used in systems which don't
1492 provide the optional SRST signal, or on systems where you
1493 don't want to reset all targets at once.
1494 Such a handler might write to chip registers to force a reset,
1495 use a JRC to do that (preferable -- the target may be wedged!),
1496 or force a watchdog timer to trigger.
1497 (For Cortex-M3 targets, this is not necessary.  The target
1498 driver knows how to use trigger an NVIC reset when SRST is
1499 not available.)
1500
1501 Some chips need special attention during reset handling if
1502 they're going to be used with JTAG.
1503 An example might be needing to send some commands right
1504 after the target's TAP has been reset, providing a
1505 @code{reset-deassert-post} event handler that writes a chip
1506 register to report that JTAG debugging is being done.
1507 Another would be reconfiguring the watchdog so that it stops
1508 counting while the core is halted in the debugger.
1509
1510 JTAG clocking constraints often change during reset, and in
1511 some cases target config files (rather than board config files)
1512 are the right places to handle some of those issues.
1513 For example, immediately after reset most chips run using a
1514 slower clock than they will use later.
1515 That means that after reset (and potentially, as OpenOCD
1516 first starts up) they must use a slower JTAG clock rate
1517 than they will use later.
1518 @xref{JTAG Speed}.
1519
1520 @quotation Important
1521 When you are debugging code that runs right after chip
1522 reset, getting these issues right is critical.
1523 In particular, if you see intermittent failures when
1524 OpenOCD verifies the scan chain after reset,
1525 look at how you are setting up JTAG clocking.
1526 @end quotation
1527
1528 @subsection ARM Core Specific Hacks
1529
1530 If the chip has a DCC, enable it. If the chip is an ARM9 with some
1531 special high speed download features - enable it.
1532
1533 If present, the MMU, the MPU and the CACHE should be disabled.
1534
1535 Some ARM cores are equipped with trace support, which permits
1536 examination of the instruction and data bus activity.  Trace
1537 activity is controlled through an ``Embedded Trace Module'' (ETM)
1538 on one of the core's scan chains.  The ETM emits voluminous data
1539 through a ``trace port''.  (@xref{ARM Hardware Tracing}.)
1540 If you are using an external trace port,
1541 configure it in your board config file.
1542 If you are using an on-chip ``Embedded Trace Buffer'' (ETB),
1543 configure it in your target config file.
1544
1545 @example
1546 etm config $_TARGETNAME 16 normal full etb
1547 etb config $_TARGETNAME $_CHIPNAME.etb
1548 @end example
1549
1550 @subsection Internal Flash Configuration
1551
1552 This applies @b{ONLY TO MICROCONTROLLERS} that have flash built in.
1553
1554 @b{Never ever} in the ``target configuration file'' define any type of
1555 flash that is external to the chip. (For example a BOOT flash on
1556 Chip Select 0.) Such flash information goes in a board file - not
1557 the TARGET (chip) file.
1558
1559 Examples:
1560 @itemize @bullet
1561 @item at91sam7x256 - has 256K flash YES enable it.
1562 @item str912 - has flash internal YES enable it.
1563 @item imx27 - uses boot flash on CS0 - it goes in the board file.
1564 @item pxa270 - again - CS0 flash - it goes in the board file.
1565 @end itemize
1566
1567 @anchor{Translating Configuration Files}
1568 @section Translating Configuration Files
1569 @cindex translation
1570 If you have a configuration file for another hardware debugger
1571 or toolset (Abatron, BDI2000, BDI3000, CCS,
1572 Lauterbach, Segger, Macraigor, etc.), translating
1573 it into OpenOCD syntax is often quite straightforward. The most tricky
1574 part of creating a configuration script is oftentimes the reset init
1575 sequence where e.g. PLLs, DRAM and the like is set up.
1576
1577 One trick that you can use when translating is to write small
1578 Tcl procedures to translate the syntax into OpenOCD syntax. This
1579 can avoid manual translation errors and make it easier to
1580 convert other scripts later on.
1581
1582 Example of transforming quirky arguments to a simple search and
1583 replace job:
1584
1585 @example
1586 #   Lauterbach syntax(?)
1587 #
1588 #       Data.Set c15:0x042f %long 0x40000015
1589 #
1590 #   OpenOCD syntax when using procedure below.
1591 #
1592 #       setc15 0x01 0x00050078
1593
1594 proc setc15 @{regs value@} @{
1595     global TARGETNAME
1596
1597     echo [format "set p15 0x%04x, 0x%08x" $regs $value]
1598
1599     arm mcr 15 [expr ($regs>>12)&0x7] \
1600         [expr ($regs>>0)&0xf] [expr ($regs>>4)&0xf] \
1601         [expr ($regs>>8)&0x7] $value
1602 @}
1603 @end example
1604
1605
1606
1607 @node Daemon Configuration
1608 @chapter Daemon Configuration
1609 @cindex initialization
1610 The commands here are commonly found in the openocd.cfg file and are
1611 used to specify what TCP/IP ports are used, and how GDB should be
1612 supported.
1613
1614 @anchor{Configuration Stage}
1615 @section Configuration Stage
1616 @cindex configuration stage
1617 @cindex config command
1618
1619 When the OpenOCD server process starts up, it enters a
1620 @emph{configuration stage} which is the only time that
1621 certain commands, @emph{configuration commands}, may be issued.
1622 In this manual, the definition of a configuration command is
1623 presented as a @emph{Config Command}, not as a @emph{Command}
1624 which may be issued interactively.
1625
1626 Those configuration commands include declaration of TAPs,
1627 flash banks,
1628 the interface used for JTAG communication,
1629 and other basic setup.
1630 The server must leave the configuration stage before it
1631 may access or activate TAPs.
1632 After it leaves this stage, configuration commands may no
1633 longer be issued.
1634
1635 @section Entering the Run Stage
1636
1637 The first thing OpenOCD does after leaving the configuration
1638 stage is to verify that it can talk to the scan chain
1639 (list of TAPs) which has been configured.
1640 It will warn if it doesn't find TAPs it expects to find,
1641 or finds TAPs that aren't supposed to be there.
1642 You should see no errors at this point.
1643 If you see errors, resolve them by correcting the
1644 commands you used to configure the server.
1645 Common errors include using an initial JTAG speed that's too
1646 fast, and not providing the right IDCODE values for the TAPs
1647 on the scan chain.
1648
1649 Once OpenOCD has entered the run stage, a number of commands
1650 become available.
1651 A number of these relate to the debug targets you may have declared.
1652 For example, the @command{mww} command will not be available until
1653 a target has been successfuly instantiated.
1654 If you want to use those commands, you may need to force
1655 entry to the run stage.
1656
1657 @deffn {Config Command} init
1658 This command terminates the configuration stage and
1659 enters the run stage.  This helps when you need to have
1660 the startup scripts manage tasks such as resetting the target,
1661 programming flash, etc. To reset the CPU upon startup, add "init" and
1662 "reset" at the end of the config script or at the end of the OpenOCD
1663 command line using the @option{-c} command line switch.
1664
1665 If this command does not appear in any startup/configuration file
1666 OpenOCD executes the command for you after processing all
1667 configuration files and/or command line options.
1668
1669 @b{NOTE:} This command normally occurs at or near the end of your
1670 openocd.cfg file to force OpenOCD to ``initialize'' and make the
1671 targets ready. For example: If your openocd.cfg file needs to
1672 read/write memory on your target, @command{init} must occur before
1673 the memory read/write commands.  This includes @command{nand probe}.
1674 @end deffn
1675
1676 @deffn {Overridable Procedure} jtag_init
1677 This is invoked at server startup to verify that it can talk
1678 to the scan chain (list of TAPs) which has been configured.
1679
1680 The default implementation first tries @command{jtag arp_init},
1681 which uses only a lightweight JTAG reset before examining the
1682 scan chain.
1683 If that fails, it tries again, using a harder reset
1684 from the overridable procedure @command{init_reset}.
1685
1686 Implementations must have verified the JTAG scan chain before
1687 they return.
1688 This is done by calling @command{jtag arp_init}
1689 (or @command{jtag arp_init-reset}).
1690 @end deffn
1691
1692 @anchor{TCP/IP Ports}
1693 @section TCP/IP Ports
1694 @cindex TCP port
1695 @cindex server
1696 @cindex port
1697 @cindex security
1698 The OpenOCD server accepts remote commands in several syntaxes.
1699 Each syntax uses a different TCP/IP port, which you may specify
1700 only during configuration (before those ports are opened).
1701
1702 For reasons including security, you may wish to prevent remote
1703 access using one or more of these ports.
1704 In such cases, just specify the relevant port number as zero.
1705 If you disable all access through TCP/IP, you will need to
1706 use the command line @option{-pipe} option.
1707
1708 @deffn {Command} gdb_port (number)
1709 @cindex GDB server
1710 Specify or query the first port used for incoming GDB connections.
1711 The GDB port for the
1712 first target will be gdb_port, the second target will listen on gdb_port + 1, and so on.
1713 When not specified during the configuration stage,
1714 the port @var{number} defaults to 3333.
1715 When specified as zero, this port is not activated.
1716 @end deffn
1717
1718 @deffn {Command} tcl_port (number)
1719 Specify or query the port used for a simplified RPC
1720 connection that can be used by clients to issue TCL commands and get the
1721 output from the Tcl engine.
1722 Intended as a machine interface.
1723 When not specified during the configuration stage,
1724 the port @var{number} defaults to 6666.
1725 When specified as zero, this port is not activated.
1726 @end deffn
1727
1728 @deffn {Command} telnet_port (number)
1729 Specify or query the
1730 port on which to listen for incoming telnet connections.
1731 This port is intended for interaction with one human through TCL commands.
1732 When not specified during the configuration stage,
1733 the port @var{number} defaults to 4444.
1734 When specified as zero, this port is not activated.
1735 @end deffn
1736
1737 @anchor{GDB Configuration}
1738 @section GDB Configuration
1739 @cindex GDB
1740 @cindex GDB configuration
1741 You can reconfigure some GDB behaviors if needed.
1742 The ones listed here are static and global.
1743 @xref{Target Configuration}, about configuring individual targets.
1744 @xref{Target Events}, about configuring target-specific event handling.
1745
1746 @anchor{gdb_breakpoint_override}
1747 @deffn {Command} gdb_breakpoint_override [@option{hard}|@option{soft}|@option{disable}]
1748 Force breakpoint type for gdb @command{break} commands.
1749 This option supports GDB GUIs which don't
1750 distinguish hard versus soft breakpoints, if the default OpenOCD and
1751 GDB behaviour is not sufficient.  GDB normally uses hardware
1752 breakpoints if the memory map has been set up for flash regions.
1753 @end deffn
1754
1755 @anchor{gdb_flash_program}
1756 @deffn {Config Command} gdb_flash_program (@option{enable}|@option{disable})
1757 Set to @option{enable} to cause OpenOCD to program the flash memory when a
1758 vFlash packet is received.
1759 The default behaviour is @option{enable}.
1760 @end deffn
1761
1762 @deffn {Config Command} gdb_memory_map (@option{enable}|@option{disable})
1763 Set to @option{enable} to cause OpenOCD to send the memory configuration to GDB when
1764 requested. GDB will then know when to set hardware breakpoints, and program flash
1765 using the GDB load command. @command{gdb_flash_program enable} must also be enabled
1766 for flash programming to work.
1767 Default behaviour is @option{enable}.
1768 @xref{gdb_flash_program}.
1769 @end deffn
1770
1771 @deffn {Config Command} gdb_report_data_abort (@option{enable}|@option{disable})
1772 Specifies whether data aborts cause an error to be reported
1773 by GDB memory read packets.
1774 The default behaviour is @option{disable};
1775 use @option{enable} see these errors reported.
1776 @end deffn
1777
1778 @anchor{Event Polling}
1779 @section Event Polling
1780
1781 Hardware debuggers are parts of asynchronous systems,
1782 where significant events can happen at any time.
1783 The OpenOCD server needs to detect some of these events,
1784 so it can report them to through TCL command line
1785 or to GDB.
1786
1787 Examples of such events include:
1788
1789 @itemize
1790 @item One of the targets can stop running ... maybe it triggers
1791 a code breakpoint or data watchpoint, or halts itself.
1792 @item Messages may be sent over ``debug message'' channels ... many
1793 targets support such messages sent over JTAG,
1794 for receipt by the person debugging or tools.
1795 @item Loss of power ... some adapters can detect these events.
1796 @item Resets not issued through JTAG ... such reset sources
1797 can include button presses or other system hardware, sometimes
1798 including the target itself (perhaps through a watchdog).
1799 @item Debug instrumentation sometimes supports event triggering
1800 such as ``trace buffer full'' (so it can quickly be emptied)
1801 or other signals (to correlate with code behavior).
1802 @end itemize
1803
1804 None of those events are signaled through standard JTAG signals.
1805 However, most conventions for JTAG connectors include voltage
1806 level and system reset (SRST) signal detection.
1807 Some connectors also include instrumentation signals, which
1808 can imply events when those signals are inputs.
1809
1810 In general, OpenOCD needs to periodically check for those events,
1811 either by looking at the status of signals on the JTAG connector
1812 or by sending synchronous ``tell me your status'' JTAG requests
1813 to the various active targets.
1814 There is a command to manage and monitor that polling,
1815 which is normally done in the background.
1816
1817 @deffn Command poll [@option{on}|@option{off}]
1818 Poll the current target for its current state.
1819 (Also, @pxref{target curstate}.)
1820 If that target is in debug mode, architecture
1821 specific information about the current state is printed.
1822 An optional parameter
1823 allows background polling to be enabled and disabled.
1824
1825 You could use this from the TCL command shell, or
1826 from GDB using @command{monitor poll} command.
1827 Leave background polling enabled while you're using GDB.
1828 @example
1829 > poll
1830 background polling: on
1831 target state: halted
1832 target halted in ARM state due to debug-request, \
1833                current mode: Supervisor
1834 cpsr: 0x800000d3 pc: 0x11081bfc
1835 MMU: disabled, D-Cache: disabled, I-Cache: enabled
1836 >
1837 @end example
1838 @end deffn
1839
1840 @node Interface - Dongle Configuration
1841 @chapter Interface - Dongle Configuration
1842 @cindex config file, interface
1843 @cindex interface config file
1844
1845 JTAG Adapters/Interfaces/Dongles are normally configured
1846 through commands in an interface configuration
1847 file which is sourced by your @file{openocd.cfg} file, or
1848 through a command line @option{-f interface/....cfg} option.
1849
1850 @example
1851 source [find interface/olimex-jtag-tiny.cfg]
1852 @end example
1853
1854 These commands tell
1855 OpenOCD what type of JTAG adapter you have, and how to talk to it.
1856 A few cases are so simple that you only need to say what driver to use:
1857
1858 @example
1859 # jlink interface
1860 interface jlink
1861 @end example
1862
1863 Most adapters need a bit more configuration than that.
1864
1865
1866 @section Interface Configuration
1867
1868 The interface command tells OpenOCD what type of JTAG dongle you are
1869 using. Depending on the type of dongle, you may need to have one or
1870 more additional commands.
1871
1872 @deffn {Config Command} {interface} name
1873 Use the interface driver @var{name} to connect to the
1874 target.
1875 @end deffn
1876
1877 @deffn Command {interface_list}
1878 List the interface drivers that have been built into
1879 the running copy of OpenOCD.
1880 @end deffn
1881
1882 @deffn Command {jtag interface}
1883 Returns the name of the interface driver being used.
1884 @end deffn
1885
1886 @section Interface Drivers
1887
1888 Each of the interface drivers listed here must be explicitly
1889 enabled when OpenOCD is configured, in order to be made
1890 available at run time.
1891
1892 @deffn {Interface Driver} {amt_jtagaccel}
1893 Amontec Chameleon in its JTAG Accelerator configuration,
1894 connected to a PC's EPP mode parallel port.
1895 This defines some driver-specific commands:
1896
1897 @deffn {Config Command} {parport_port} number
1898 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
1899 the number of the @file{/dev/parport} device.
1900 @end deffn
1901
1902 @deffn {Config Command} rtck [@option{enable}|@option{disable}]
1903 Displays status of RTCK option.
1904 Optionally sets that option first.
1905 @end deffn
1906 @end deffn
1907
1908 @deffn {Interface Driver} {arm-jtag-ew}
1909 Olimex ARM-JTAG-EW USB adapter
1910 This has one driver-specific command:
1911
1912 @deffn Command {armjtagew_info}
1913 Logs some status
1914 @end deffn
1915 @end deffn
1916
1917 @deffn {Interface Driver} {at91rm9200}
1918 Supports bitbanged JTAG from the local system,
1919 presuming that system is an Atmel AT91rm9200
1920 and a specific set of GPIOs is used.
1921 @c command:     at91rm9200_device NAME
1922 @c chooses among list of bit configs ... only one option
1923 @end deffn
1924
1925 @deffn {Interface Driver} {dummy}
1926 A dummy software-only driver for debugging.
1927 @end deffn
1928
1929 @deffn {Interface Driver} {ep93xx}
1930 Cirrus Logic EP93xx based single-board computer bit-banging (in development)
1931 @end deffn
1932
1933 @deffn {Interface Driver} {ft2232}
1934 FTDI FT2232 (USB) based devices over one of the userspace libraries.
1935 These interfaces have several commands, used to configure the driver
1936 before initializing the JTAG scan chain:
1937
1938 @deffn {Config Command} {ft2232_device_desc} description
1939 Provides the USB device description (the @emph{iProduct string})
1940 of the FTDI FT2232 device. If not
1941 specified, the FTDI default value is used. This setting is only valid
1942 if compiled with FTD2XX support.
1943 @end deffn
1944
1945 @deffn {Config Command} {ft2232_serial} serial-number
1946 Specifies the @var{serial-number} of the FTDI FT2232 device to use,
1947 in case the vendor provides unique IDs and more than one FT2232 device
1948 is connected to the host.
1949 If not specified, serial numbers are not considered.
1950 (Note that USB serial numbers can be arbitrary Unicode strings,
1951 and are not restricted to containing only decimal digits.)
1952 @end deffn
1953
1954 @deffn {Config Command} {ft2232_layout} name
1955 Each vendor's FT2232 device can use different GPIO signals
1956 to control output-enables, reset signals, and LEDs.
1957 Currently valid layout @var{name} values include:
1958 @itemize @minus
1959 @item @b{axm0432_jtag} Axiom AXM-0432
1960 @item @b{comstick} Hitex STR9 comstick
1961 @item @b{cortino} Hitex Cortino JTAG interface
1962 @item @b{evb_lm3s811} Luminary Micro EVB_LM3S811 as a JTAG interface,
1963 either for the local Cortex-M3 (SRST only)
1964 or in a passthrough mode (neither SRST nor TRST)
1965 @item @b{luminary_icdi} Luminary In-Circuit Debug Interface (ICDI) Board
1966 @item @b{flyswatter} Tin Can Tools Flyswatter
1967 @item @b{icebear} ICEbear JTAG adapter from Section 5
1968 @item @b{jtagkey} Amontec JTAGkey and JTAGkey-Tiny (and compatibles)
1969 @item @b{jtagkey2} Amontec JTAGkey2 (and compatibles)
1970 @item @b{m5960} American Microsystems M5960
1971 @item @b{olimex-jtag} Olimex ARM-USB-OCD and ARM-USB-Tiny
1972 @item @b{oocdlink} OOCDLink
1973 @c oocdlink ~= jtagkey_prototype_v1
1974 @item @b{sheevaplug} Marvell Sheevaplug development kit
1975 @item @b{signalyzer} Xverve Signalyzer
1976 @item @b{stm32stick} Hitex STM32 Performance Stick
1977 @item @b{turtelizer2} egnite Software turtelizer2
1978 @item @b{usbjtag} "USBJTAG-1" layout described in the OpenOCD diploma thesis
1979 @end itemize
1980 @end deffn
1981
1982 @deffn {Config Command} {ft2232_vid_pid} [vid pid]+
1983 The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
1984 default values are used.
1985 Currently, up to eight [@var{vid}, @var{pid}] pairs may be given, e.g.
1986 @example
1987 ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
1988 @end example
1989 @end deffn
1990
1991 @deffn {Config Command} {ft2232_latency} ms
1992 On some systems using FT2232 based JTAG interfaces the FT_Read function call in
1993 ft2232_read() fails to return the expected number of bytes. This can be caused by
1994 USB communication delays and has proved hard to reproduce and debug. Setting the
1995 FT2232 latency timer to a larger value increases delays for short USB packets but it
1996 also reduces the risk of timeouts before receiving the expected number of bytes.
1997 The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
1998 @end deffn
1999
2000 For example, the interface config file for a
2001 Turtelizer JTAG Adapter looks something like this:
2002
2003 @example
2004 interface ft2232
2005 ft2232_device_desc "Turtelizer JTAG/RS232 Adapter"
2006 ft2232_layout turtelizer2
2007 ft2232_vid_pid 0x0403 0xbdc8
2008 @end example
2009 @end deffn
2010
2011 @deffn {Interface Driver} {usb_blaster}
2012 USB JTAG/USB-Blaster compatibles over one of the userspace libraries
2013 for FTDI chips.  These interfaces have several commands, used to
2014 configure the driver before initializing the JTAG scan chain:
2015
2016 @deffn {Config Command} {usb_blaster_device_desc} description
2017 Provides the USB device description (the @emph{iProduct string})
2018 of the FTDI FT245 device. If not
2019 specified, the FTDI default value is used. This setting is only valid
2020 if compiled with FTD2XX support.
2021 @end deffn
2022
2023 @deffn {Config Command} {usb_blaster_vid_pid} vid pid
2024 The vendor ID and product ID of the FTDI FT245 device. If not specified,
2025 default values are used.
2026 Currently, only one @var{vid}, @var{pid} pair may be given, e.g. for
2027 Altera USB-Blaster (default):
2028 @example
2029 ft2232_vid_pid 0x09FB 0x6001
2030 @end example
2031 The following VID/PID is for Kolja Waschk's USB JTAG:
2032 @example
2033 ft2232_vid_pid 0x16C0 0x06AD
2034 @end example
2035 @end deffn
2036
2037 @deffn {Command} {usb_blaster} (@option{pin6}|@option{pin8}) (@option{0}|@option{1})
2038 Sets the state of the unused GPIO pins on USB-Blasters (pins 6 and 8 on the
2039 female JTAG header). These pins can be used as SRST and/or TRST provided the
2040 appropriate connections are made on the target board.
2041
2042 For example, to use pin 6 as SRST (as with an AVR board):
2043 @example
2044 $_TARGETNAME configure -event reset-assert \
2045       "usb_blaster pin6 1; wait 1; usb_blaster pin6 0"
2046 @end example
2047 @end deffn
2048
2049 @end deffn
2050
2051 @deffn {Interface Driver} {gw16012}
2052 Gateworks GW16012 JTAG programmer.
2053 This has one driver-specific command:
2054
2055 @deffn {Config Command} {parport_port} number
2056 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
2057 the number of the @file{/dev/parport} device.
2058 @end deffn
2059 @end deffn
2060
2061 @deffn {Interface Driver} {jlink}
2062 Segger jlink USB adapter
2063 @c command:     jlink_info
2064 @c     dumps status
2065 @c command:     jlink_hw_jtag (2|3)
2066 @c     sets version 2 or 3
2067 @end deffn
2068
2069 @deffn {Interface Driver} {parport}
2070 Supports PC parallel port bit-banging cables:
2071 Wigglers, PLD download cable, and more.
2072 These interfaces have several commands, used to configure the driver
2073 before initializing the JTAG scan chain:
2074
2075 @deffn {Config Command} {parport_cable} name
2076 The layout of the parallel port cable used to connect to the target.
2077 Currently valid cable @var{name} values include:
2078
2079 @itemize @minus
2080 @item @b{altium} Altium Universal JTAG cable.
2081 @item @b{arm-jtag} Same as original wiggler except SRST and
2082 TRST connections reversed and TRST is also inverted.
2083 @item @b{chameleon} The Amontec Chameleon's CPLD when operated
2084 in configuration mode. This is only used to
2085 program the Chameleon itself, not a connected target.
2086 @item @b{dlc5} The Xilinx Parallel cable III.
2087 @item @b{flashlink} The ST Parallel cable.
2088 @item @b{lattice} Lattice ispDOWNLOAD Cable
2089 @item @b{old_amt_wiggler} The Wiggler configuration that comes with
2090 some versions of
2091 Amontec's Chameleon Programmer. The new version available from
2092 the website uses the original Wiggler layout ('@var{wiggler}')
2093 @item @b{triton} The parallel port adapter found on the
2094 ``Karo Triton 1 Development Board''.
2095 This is also the layout used by the HollyGates design
2096 (see @uref{http://www.lartmaker.nl/projects/jtag/}).
2097 @item @b{wiggler} The original Wiggler layout, also supported by
2098 several clones, such as the Olimex ARM-JTAG
2099 @item @b{wiggler2} Same as original wiggler except an led is fitted on D5.
2100 @item @b{wiggler_ntrst_inverted} Same as original wiggler except TRST is inverted.
2101 @end itemize
2102 @end deffn
2103
2104 @deffn {Config Command} {parport_port} number
2105 Either the address of the I/O port (default: 0x378 for LPT1) or the number of
2106 the @file{/dev/parport} device
2107
2108 When using PPDEV to access the parallel port, use the number of the parallel port:
2109 @option{parport_port 0} (the default). If @option{parport_port 0x378} is specified
2110 you may encounter a problem.
2111 @end deffn
2112
2113 @deffn Command {parport_toggling_time} [nanoseconds]
2114 Displays how many nanoseconds the hardware needs to toggle TCK;
2115 the parport driver uses this value to obey the
2116 @command{jtag_khz} configuration.
2117 When the optional @var{nanoseconds} parameter is given,
2118 that setting is changed before displaying the current value.
2119
2120 The default setting should work reasonably well on commodity PC hardware.
2121 However, you may want to calibrate for your specific hardware.
2122 @quotation Tip
2123 To measure the toggling time with a logic analyzer or a digital storage
2124 oscilloscope, follow the procedure below:
2125 @example
2126 > parport_toggling_time 1000
2127 > jtag_khz 500
2128 @end example
2129 This sets the maximum JTAG clock speed of the hardware, but
2130 the actual speed probably deviates from the requested 500 kHz.
2131 Now, measure the time between the two closest spaced TCK transitions.
2132 You can use @command{runtest 1000} or something similar to generate a
2133 large set of samples.
2134 Update the setting to match your measurement:
2135 @example
2136 > parport_toggling_time <measured nanoseconds>
2137 @end example
2138 Now the clock speed will be a better match for @command{jtag_khz rate}
2139 commands given in OpenOCD scripts and event handlers.
2140
2141 You can do something similar with many digital multimeters, but note
2142 that you'll probably need to run the clock continuously for several
2143 seconds before it decides what clock rate to show.  Adjust the
2144 toggling time up or down until the measured clock rate is a good
2145 match for the jtag_khz rate you specified; be conservative.
2146 @end quotation
2147 @end deffn
2148
2149 @deffn {Config Command} {parport_write_on_exit} (on|off)
2150 This will configure the parallel driver to write a known
2151 cable-specific value to the parallel interface on exiting OpenOCD
2152 @end deffn
2153
2154 For example, the interface configuration file for a
2155 classic ``Wiggler'' cable might look something like this:
2156
2157 @example
2158 interface parport
2159 parport_port 0xc8b8
2160 parport_cable wiggler
2161 @end example
2162 @end deffn
2163
2164 @deffn {Interface Driver} {presto}
2165 ASIX PRESTO USB JTAG programmer.
2166 @c command:     presto_serial str
2167 @c     sets serial number
2168 @end deffn
2169
2170 @deffn {Interface Driver} {rlink}
2171 Raisonance RLink USB adapter
2172 @end deffn
2173
2174 @deffn {Interface Driver} {usbprog}
2175 usbprog is a freely programmable USB adapter.
2176 @end deffn
2177
2178 @deffn {Interface Driver} {vsllink}
2179 vsllink is part of Versaloon which is a versatile USB programmer.
2180
2181 @quotation Note
2182 This defines quite a few driver-specific commands,
2183 which are not currently documented here.
2184 @end quotation
2185 @end deffn
2186
2187 @deffn {Interface Driver} {ZY1000}
2188 This is the Zylin ZY1000 JTAG debugger.
2189
2190 @quotation Note
2191 This defines some driver-specific commands,
2192 which are not currently documented here.
2193 @end quotation
2194
2195 @deffn Command power [@option{on}|@option{off}]
2196 Turn power switch to target on/off.
2197 No arguments: print status.
2198 @end deffn
2199
2200 @end deffn
2201
2202 @anchor{JTAG Speed}
2203 @section JTAG Speed
2204 JTAG clock setup is part of system setup.
2205 It @emph{does not belong with interface setup} since any interface
2206 only knows a few of the constraints for the JTAG clock speed.
2207 Sometimes the JTAG speed is
2208 changed during the target initialization process: (1) slow at
2209 reset, (2) program the CPU clocks, (3) run fast.
2210 Both the "slow" and "fast" clock rates are functions of the
2211 oscillators used, the chip, the board design, and sometimes
2212 power management software that may be active.
2213
2214 The speed used during reset, and the scan chain verification which
2215 follows reset, can be adjusted using a @code{reset-start}
2216 target event handler.
2217 It can then be reconfigured to a faster speed by a
2218 @code{reset-init} target event handler after it reprograms those
2219 CPU clocks, or manually (if something else, such as a boot loader,
2220 sets up those clocks).
2221 @xref{Target Events}.
2222 When the initial low JTAG speed is a chip characteristic, perhaps
2223 because of a required oscillator speed, provide such a handler
2224 in the target config file.
2225 When that speed is a function of a board-specific characteristic
2226 such as which speed oscillator is used, it belongs in the board
2227 config file instead.
2228 In both cases it's safest to also set the initial JTAG clock rate
2229 to that same slow speed, so that OpenOCD never starts up using a
2230 clock speed that's faster than the scan chain can support.
2231
2232 @example
2233 jtag_rclk 3000
2234 $_TARGET.cpu configure -event reset-start @{ jtag_rclk 3000 @}
2235 @end example
2236
2237 If your system supports adaptive clocking (RTCK), configuring
2238 JTAG to use that is probably the most robust approach.
2239 However, it introduces delays to synchronize clocks; so it
2240 may not be the fastest solution.
2241
2242 @b{NOTE:} Script writers should consider using @command{jtag_rclk}
2243 instead of @command{jtag_khz}.
2244
2245 @deffn {Command} jtag_khz max_speed_kHz
2246 A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
2247 JTAG interfaces usually support a limited number of
2248 speeds.  The speed actually used won't be faster
2249 than the speed specified.
2250
2251 Chip data sheets generally include a top JTAG clock rate.
2252 The actual rate is often a function of a CPU core clock,
2253 and is normally less than that peak rate.
2254 For example, most ARM cores accept at most one sixth of the CPU clock.
2255
2256 Speed 0 (khz) selects RTCK method.
2257 @xref{FAQ RTCK}.
2258 If your system uses RTCK, you won't need to change the
2259 JTAG clocking after setup.
2260 Not all interfaces, boards, or targets support ``rtck''.
2261 If the interface device can not
2262 support it, an error is returned when you try to use RTCK.
2263 @end deffn
2264
2265 @defun jtag_rclk fallback_speed_kHz
2266 @cindex adaptive clocking
2267 @cindex RTCK
2268 This Tcl proc (defined in @file{startup.tcl}) attempts to enable RTCK/RCLK.
2269 If that fails (maybe the interface, board, or target doesn't
2270 support it), falls back to the specified frequency.
2271 @example
2272 # Fall back to 3mhz if RTCK is not supported
2273 jtag_rclk 3000
2274 @end example
2275 @end defun
2276
2277 @node Reset Configuration
2278 @chapter Reset Configuration
2279 @cindex Reset Configuration
2280
2281 Every system configuration may require a different reset
2282 configuration. This can also be quite confusing.
2283 Resets also interact with @var{reset-init} event handlers,
2284 which do things like setting up clocks and DRAM, and
2285 JTAG clock rates.  (@xref{JTAG Speed}.)
2286 They can also interact with JTAG routers.
2287 Please see the various board files for examples.
2288
2289 @quotation Note
2290 To maintainers and integrators:
2291 Reset configuration touches several things at once.
2292 Normally the board configuration file
2293 should define it and assume that the JTAG adapter supports
2294 everything that's wired up to the board's JTAG connector.
2295
2296 However, the target configuration file could also make note
2297 of something the silicon vendor has done inside the chip,
2298 which will be true for most (or all) boards using that chip.
2299 And when the JTAG adapter doesn't support everything, the
2300 user configuration file will need to override parts of
2301 the reset configuration provided by other files.
2302 @end quotation
2303
2304 @section Types of Reset
2305
2306 There are many kinds of reset possible through JTAG, but
2307 they may not all work with a given board and adapter.
2308 That's part of why reset configuration can be error prone.
2309
2310 @itemize @bullet
2311 @item
2312 @emph{System Reset} ... the @emph{SRST} hardware signal
2313 resets all chips connected to the JTAG adapter, such as processors,
2314 power management chips, and I/O controllers.  Normally resets triggered
2315 with this signal behave exactly like pressing a RESET button.
2316 @item
2317 @emph{JTAG TAP Reset} ... the @emph{TRST} hardware signal resets
2318 just the TAP controllers connected to the JTAG adapter.
2319 Such resets should not be visible to the rest of the system; resetting a
2320 device's the TAP controller just puts that controller into a known state.
2321 @item
2322 @emph{Emulation Reset} ... many devices can be reset through JTAG
2323 commands.  These resets are often distinguishable from system
2324 resets, either explicitly (a "reset reason" register says so)
2325 or implicitly (not all parts of the chip get reset).
2326 @item
2327 @emph{Other Resets} ... system-on-chip devices often support
2328 several other types of reset.
2329 You may need to arrange that a watchdog timer stops
2330 while debugging, preventing a watchdog reset.
2331 There may be individual module resets.
2332 @end itemize
2333
2334 In the best case, OpenOCD can hold SRST, then reset
2335 the TAPs via TRST and send commands through JTAG to halt the
2336 CPU at the reset vector before the 1st instruction is executed.
2337 Then when it finally releases the SRST signal, the system is
2338 halted under debugger control before any code has executed.
2339 This is the behavior required to support the @command{reset halt}
2340 and @command{reset init} commands; after @command{reset init} a
2341 board-specific script might do things like setting up DRAM.
2342 (@xref{Reset Command}.)
2343
2344 @anchor{SRST and TRST Issues}
2345 @section SRST and TRST Issues
2346
2347 Because SRST and TRST are hardware signals, they can have a
2348 variety of system-specific constraints.  Some of the most
2349 common issues are:
2350
2351 @itemize @bullet
2352
2353 @item @emph{Signal not available} ... Some boards don't wire
2354 SRST or TRST to the JTAG connector.  Some JTAG adapters don't
2355 support such signals even if they are wired up.
2356 Use the @command{reset_config} @var{signals} options to say
2357 when either of those signals is not connected.
2358 When SRST is not available, your code might not be able to rely
2359 on controllers having been fully reset during code startup.
2360 Missing TRST is not a problem, since JTAG level resets can
2361 be triggered using with TMS signaling.
2362
2363 @item @emph{Signals shorted} ... Sometimes a chip, board, or
2364 adapter will connect SRST to TRST, instead of keeping them separate.
2365 Use the @command{reset_config} @var{combination} options to say
2366 when those signals aren't properly independent.
2367
2368 @item @emph{Timing} ... Reset circuitry like a resistor/capacitor
2369 delay circuit, reset supervisor, or on-chip features can extend
2370 the effect of a JTAG adapter's reset for some time after the adapter
2371 stops issuing the reset.  For example, there may be chip or board
2372 requirements that all reset pulses last for at least a
2373 certain amount of time; and reset buttons commonly have
2374 hardware debouncing.
2375 Use the @command{jtag_nsrst_delay} and @command{jtag_ntrst_delay}
2376 commands to say when extra delays are needed.
2377
2378 @item @emph{Drive type} ... Reset lines often have a pullup
2379 resistor, letting the JTAG interface treat them as open-drain
2380 signals.  But that's not a requirement, so the adapter may need
2381 to use push/pull output drivers.
2382 Also, with weak pullups it may be advisable to drive
2383 signals to both levels (push/pull) to minimize rise times.
2384 Use the @command{reset_config} @var{trst_type} and
2385 @var{srst_type} parameters to say how to drive reset signals.
2386
2387 @item @emph{Special initialization} ...  Targets sometimes need
2388 special JTAG initialization sequences to handle chip-specific
2389 issues (not limited to errata).
2390 For example, certain JTAG commands might need to be issued while
2391 the system as a whole is in a reset state (SRST active)
2392 but the JTAG scan chain is usable (TRST inactive).
2393 Many systems treat combined assertion of SRST and TRST as a
2394 trigger for a harder reset than SRST alone.
2395 Such custom reset handling is discussed later in this chapter.
2396 @end itemize
2397
2398 There can also be other issues.
2399 Some devices don't fully conform to the JTAG specifications.
2400 Trivial system-specific differences are common, such as
2401 SRST and TRST using slightly different names.
2402 There are also vendors who distribute key JTAG documentation for
2403 their chips only to developers who have signed a Non-Disclosure
2404 Agreement (NDA).
2405
2406 Sometimes there are chip-specific extensions like a requirement to use
2407 the normally-optional TRST signal (precluding use of JTAG adapters which
2408 don't pass TRST through), or needing extra steps to complete a TAP reset.
2409
2410 In short, SRST and especially TRST handling may be very finicky,
2411 needing to cope with both architecture and board specific constraints.
2412
2413 @section Commands for Handling Resets
2414
2415 @deffn {Command} jtag_nsrst_assert_width milliseconds
2416 Minimum amount of time (in milliseconds) OpenOCD should wait
2417 after asserting nSRST (active-low system reset) before
2418 allowing it to be deasserted.
2419 @end deffn
2420
2421 @deffn {Command} jtag_nsrst_delay milliseconds
2422 How long (in milliseconds) OpenOCD should wait after deasserting
2423 nSRST (active-low system reset) before starting new JTAG operations.
2424 When a board has a reset button connected to SRST line it will
2425 probably have hardware debouncing, implying you should use this.
2426 @end deffn
2427
2428 @deffn {Command} jtag_ntrst_assert_width milliseconds
2429 Minimum amount of time (in milliseconds) OpenOCD should wait
2430 after asserting nTRST (active-low JTAG TAP reset) before
2431 allowing it to be deasserted.
2432 @end deffn
2433
2434 @deffn {Command} jtag_ntrst_delay milliseconds
2435 How long (in milliseconds) OpenOCD should wait after deasserting
2436 nTRST (active-low JTAG TAP reset) before starting new JTAG operations.
2437 @end deffn
2438
2439 @deffn {Command} reset_config mode_flag ...
2440 This command displays or modifies the reset configuration
2441 of your combination of JTAG board and target in target
2442 configuration scripts.
2443
2444 Information earlier in this section describes the kind of problems
2445 the command is intended to address (@pxref{SRST and TRST Issues}).
2446 As a rule this command belongs only in board config files,
2447 describing issues like @emph{board doesn't connect TRST};
2448 or in user config files, addressing limitations derived
2449 from a particular combination of interface and board.
2450 (An unlikely example would be using a TRST-only adapter
2451 with a board that only wires up SRST.)
2452
2453 The @var{mode_flag} options can be specified in any order, but only one
2454 of each type -- @var{signals}, @var{combination},
2455 @var{gates},
2456 @var{trst_type},
2457 and @var{srst_type} -- may be specified at a time.
2458 If you don't provide a new value for a given type, its previous
2459 value (perhaps the default) is unchanged.
2460 For example, this means that you don't need to say anything at all about
2461 TRST just to declare that if the JTAG adapter should want to drive SRST,
2462 it must explicitly be driven high (@option{srst_push_pull}).
2463
2464 @itemize
2465 @item
2466 @var{signals} can specify which of the reset signals are connected.
2467 For example, If the JTAG interface provides SRST, but the board doesn't
2468 connect that signal properly, then OpenOCD can't use it.
2469 Possible values are @option{none} (the default), @option{trst_only},
2470 @option{srst_only} and @option{trst_and_srst}.
2471
2472 @quotation Tip
2473 If your board provides SRST and/or TRST through the JTAG connector,
2474 you must declare that so those signals can be used.
2475 @end quotation
2476
2477 @item
2478 The @var{combination} is an optional value specifying broken reset
2479 signal implementations.
2480 The default behaviour if no option given is @option{separate},
2481 indicating everything behaves normally.
2482 @option{srst_pulls_trst} states that the
2483 test logic is reset together with the reset of the system (e.g. Philips
2484 LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
2485 the system is reset together with the test logic (only hypothetical, I
2486 haven't seen hardware with such a bug, and can be worked around).
2487 @option{combined} implies both @option{srst_pulls_trst} and
2488 @option{trst_pulls_srst}.
2489
2490 @item
2491 The @var{gates} tokens control flags that describe some cases where
2492 JTAG may be unvailable during reset.
2493 @option{srst_gates_jtag} (default)
2494 indicates that asserting SRST gates the
2495 JTAG clock. This means that no communication can happen on JTAG
2496 while SRST is asserted.
2497 Its converse is @option{srst_nogate}, indicating that JTAG commands
2498 can safely be issued while SRST is active.
2499 @end itemize
2500
2501 The optional @var{trst_type} and @var{srst_type} parameters allow the
2502 driver mode of each reset line to be specified.  These values only affect
2503 JTAG interfaces with support for different driver modes, like the Amontec
2504 JTAGkey and JTAG Accelerator.  Also, they are necessarily ignored if the
2505 relevant signal (TRST or SRST) is not connected.
2506
2507 @itemize
2508 @item
2509 Possible @var{trst_type} driver modes for the test reset signal (TRST)
2510 are the default @option{trst_push_pull}, and @option{trst_open_drain}.
2511 Most boards connect this signal to a pulldown, so the JTAG TAPs
2512 never leave reset unless they are hooked up to a JTAG adapter.
2513
2514 @item
2515 Possible @var{srst_type} driver modes for the system reset signal (SRST)
2516 are the default @option{srst_open_drain}, and @option{srst_push_pull}.
2517 Most boards connect this signal to a pullup, and allow the
2518 signal to be pulled low by various events including system
2519 powerup and pressing a reset button.
2520 @end itemize
2521 @end deffn
2522
2523 @section Custom Reset Handling
2524 @cindex events
2525
2526 OpenOCD has several ways to help support the various reset
2527 mechanisms provided by chip and board vendors.
2528 The commands shown in the previous section give standard parameters.
2529 There are also @emph{event handlers} associated with TAPs or Targets.
2530 Those handlers are Tcl procedures you can provide, which are invoked
2531 at particular points in the reset sequence.
2532
2533 @emph{When SRST is not an option} you must set
2534 up a @code{reset-assert} event handler for your target.
2535 For example, some JTAG adapters don't include the SRST signal;
2536 and some boards have multiple targets, and you won't always
2537 want to reset everything at once.
2538
2539 After configuring those mechanisms, you might still
2540 find your board doesn't start up or reset correctly.
2541 For example, maybe it needs a slightly different sequence
2542 of SRST and/or TRST manipulations, because of quirks that
2543 the @command{reset_config} mechanism doesn't address;
2544 or asserting both might trigger a stronger reset, which
2545 needs special attention.
2546
2547 Experiment with lower level operations, such as @command{jtag_reset}
2548 and the @command{jtag arp_*} operations shown here,
2549 to find a sequence of operations that works.
2550 @xref{JTAG Commands}.
2551 When you find a working sequence, it can be used to override
2552 @command{jtag_init}, which fires during OpenOCD startup
2553 (@pxref{Configuration Stage});
2554 or @command{init_reset}, which fires during reset processing.
2555
2556 You might also want to provide some project-specific reset
2557 schemes.  For example, on a multi-target board the standard
2558 @command{reset} command would reset all targets, but you
2559 may need the ability to reset only one target at time and
2560 thus want to avoid using the board-wide SRST signal.
2561
2562 @deffn {Overridable Procedure} init_reset mode
2563 This is invoked near the beginning of the @command{reset} command,
2564 usually to provide as much of a cold (power-up) reset as practical.
2565 By default it is also invoked from @command{jtag_init} if
2566 the scan chain does not respond to pure JTAG operations.
2567 The @var{mode} parameter is the parameter given to the
2568 low level reset command (@option{halt},
2569 @option{init}, or @option{run}), @option{setup},
2570 or potentially some other value.
2571
2572 The default implementation just invokes @command{jtag arp_init-reset}.
2573 Replacements will normally build on low level JTAG
2574 operations such as @command{jtag_reset}.
2575 Operations here must not address individual TAPs
2576 (or their associated targets)
2577 until the JTAG scan chain has first been verified to work.
2578
2579 Implementations must have verified the JTAG scan chain before
2580 they return.
2581 This is done by calling @command{jtag arp_init}
2582 (or @command{jtag arp_init-reset}).
2583 @end deffn
2584
2585 @deffn Command {jtag arp_init}
2586 This validates the scan chain using just the four
2587 standard JTAG signals (TMS, TCK, TDI, TDO).
2588 It starts by issuing a JTAG-only reset.
2589 Then it performs checks to verify that the scan chain configuration
2590 matches the TAPs it can observe.
2591 Those checks include checking IDCODE values for each active TAP,
2592 and verifying the length of their instruction registers using
2593 TAP @code{-ircapture} and @code{-irmask} values.
2594 If these tests all pass, TAP @code{setup} events are
2595 issued to all TAPs with handlers for that event.
2596 @end deffn
2597
2598 @deffn Command {jtag arp_init-reset}
2599 This uses TRST and SRST to try resetting
2600 everything on the JTAG scan chain
2601 (and anything else connected to SRST).
2602 It then invokes the logic of @command{jtag arp_init}.
2603 @end deffn
2604
2605
2606 @node TAP Declaration
2607 @chapter TAP Declaration
2608 @cindex TAP declaration
2609 @cindex TAP configuration
2610
2611 @emph{Test Access Ports} (TAPs) are the core of JTAG.
2612 TAPs serve many roles, including:
2613
2614 @itemize @bullet
2615 @item @b{Debug Target} A CPU TAP can be used as a GDB debug target
2616 @item @b{Flash Programing} Some chips program the flash directly via JTAG.
2617 Others do it indirectly, making a CPU do it.
2618 @item @b{Program Download} Using the same CPU support GDB uses,
2619 you can initialize a DRAM controller, download code to DRAM, and then
2620 start running that code.
2621 @item @b{Boundary Scan} Most chips support boundary scan, which
2622 helps test for board assembly problems like solder bridges
2623 and missing connections
2624 @end itemize
2625
2626 OpenOCD must know about the active TAPs on your board(s).
2627 Setting up the TAPs is the core task of your configuration files.
2628 Once those TAPs are set up, you can pass their names to code
2629 which sets up CPUs and exports them as GDB targets,
2630 probes flash memory, performs low-level JTAG operations, and more.
2631
2632 @section Scan Chains
2633 @cindex scan chain
2634
2635 TAPs are part of a hardware @dfn{scan chain},
2636 which is daisy chain of TAPs.
2637 They also need to be added to
2638 OpenOCD's software mirror of that hardware list,
2639 giving each member a name and associating other data with it.
2640 Simple scan chains, with a single TAP, are common in
2641 systems with a single microcontroller or microprocessor.
2642 More complex chips may have several TAPs internally.
2643 Very complex scan chains might have a dozen or more TAPs:
2644 several in one chip, more in the next, and connecting
2645 to other boards with their own chips and TAPs.
2646
2647 You can display the list with the @command{scan_chain} command.
2648 (Don't confuse this with the list displayed by the @command{targets}
2649 command, presented in the next chapter.
2650 That only displays TAPs for CPUs which are configured as
2651 debugging targets.)
2652 Here's what the scan chain might look like for a chip more than one TAP:
2653
2654 @verbatim
2655    TapName            Enabled IdCode     Expected   IrLen IrCap IrMask
2656 -- ------------------ ------- ---------- ---------- ----- ----- ------
2657  0 omap5912.dsp          Y    0x03df1d81 0x03df1d81    38 0x01  0x03
2658  1 omap5912.arm          Y    0x0692602f 0x0692602f     4 0x01  0x0f
2659  2 omap5912.unknown      Y    0x00000000 0x00000000     8 0x01  0x03
2660 @end verbatim
2661
2662 OpenOCD can detect some of that information, but not all
2663 of it.  @xref{Autoprobing}.
2664 Unfortunately those TAPs can't always be autoconfigured,
2665 because not all devices provide good support for that.
2666 JTAG doesn't require supporting IDCODE instructions, and
2667 chips with JTAG routers may not link TAPs into the chain
2668 until they are told to do so.
2669
2670 The configuration mechanism currently supported by OpenOCD
2671 requires explicit configuration of all TAP devices using
2672 @command{jtag newtap} commands, as detailed later in this chapter.
2673 A command like this would declare one tap and name it @code{chip1.cpu}:
2674
2675 @example
2676 jtag newtap chip1 cpu -irlen 4 -expected-id 0x3ba00477
2677 @end example
2678
2679 Each target configuration file lists the TAPs provided
2680 by a given chip.
2681 Board configuration files combine all the targets on a board,
2682 and so forth.
2683 Note that @emph{the order in which TAPs are declared is very important.}
2684 It must match the order in the JTAG scan chain, both inside
2685 a single chip and between them.
2686 @xref{FAQ TAP Order}.
2687
2688 For example, the ST Microsystems STR912 chip has
2689 three separate TAPs@footnote{See the ST
2690 document titled: @emph{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
2691 28/102, Figure 3: JTAG chaining inside the STR91xFA}.
2692 @url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}}.
2693 To configure those taps, @file{target/str912.cfg}
2694 includes commands something like this:
2695
2696 @example
2697 jtag newtap str912 flash ... params ...
2698 jtag newtap str912 cpu ... params ...
2699 jtag newtap str912 bs ... params ...
2700 @end example
2701
2702 Actual config files use a variable instead of literals like
2703 @option{str912}, to support more than one chip of each type.
2704 @xref{Config File Guidelines}.
2705
2706 @deffn Command {jtag names}
2707 Returns the names of all current TAPs in the scan chain.
2708 Use @command{jtag cget} or @command{jtag tapisenabled}
2709 to examine attributes and state of each TAP.
2710 @example
2711 foreach t [jtag names] @{
2712     puts [format "TAP: %s\n" $t]
2713 @}
2714 @end example
2715 @end deffn
2716
2717 @deffn Command {scan_chain}
2718 Displays the TAPs in the scan chain configuration,
2719 and their status.
2720 The set of TAPs listed by this command is fixed by
2721 exiting the OpenOCD configuration stage,
2722 but systems with a JTAG router can
2723 enable or disable TAPs dynamically.
2724 @end deffn
2725
2726 @c FIXME!  "jtag cget" should be able to return all TAP
2727 @c attributes, like "$target_name cget" does for targets.
2728
2729 @c Probably want "jtag eventlist", and a "tap-reset" event
2730 @c (on entry to RESET state).
2731
2732 @section TAP Names
2733 @cindex dotted name
2734
2735 When TAP objects are declared with @command{jtag newtap},
2736 a @dfn{dotted.name} is created for the TAP, combining the
2737 name of a module (usually a chip) and a label for the TAP.
2738 For example: @code{xilinx.tap}, @code{str912.flash},
2739 @code{omap3530.jrc}, @code{dm6446.dsp}, or @code{stm32.cpu}.
2740 Many other commands use that dotted.name to manipulate or
2741 refer to the TAP.  For example, CPU configuration uses the
2742 name, as does declaration of NAND or NOR flash banks.
2743
2744 The components of a dotted name should follow ``C'' symbol
2745 name rules:  start with an alphabetic character, then numbers
2746 and underscores are OK; while others (including dots!) are not.
2747
2748 @quotation Tip
2749 In older code, JTAG TAPs were numbered from 0..N.
2750 This feature is still present.
2751 However its use is highly discouraged, and
2752 should not be relied on; it will be removed by mid-2010.
2753 Update all of your scripts to use TAP names rather than numbers,
2754 by paying attention to the runtime warnings they trigger.
2755 Using TAP numbers in target configuration scripts prevents
2756 reusing those scripts on boards with multiple targets.
2757 @end quotation
2758
2759 @section TAP Declaration Commands
2760
2761 @c shouldn't this be(come) a {Config Command}?
2762 @anchor{jtag newtap}
2763 @deffn Command {jtag newtap} chipname tapname configparams...
2764 Declares a new TAP with the dotted name @var{chipname}.@var{tapname},
2765 and configured according to the various @var{configparams}.
2766
2767 The @var{chipname} is a symbolic name for the chip.
2768 Conventionally target config files use @code{$_CHIPNAME},
2769 defaulting to the model name given by the chip vendor but
2770 overridable.
2771
2772 @cindex TAP naming convention
2773 The @var{tapname} reflects the role of that TAP,
2774 and should follow this convention:
2775
2776 @itemize @bullet
2777 @item @code{bs} -- For boundary scan if this is a seperate TAP;
2778 @item @code{cpu} -- The main CPU of the chip, alternatively
2779 @code{arm} and @code{dsp} on chips with both ARM and DSP CPUs,
2780 @code{arm1} and @code{arm2} on chips two ARMs, and so forth;
2781 @item @code{etb} -- For an embedded trace buffer (example: an ARM ETB11);
2782 @item @code{flash} -- If the chip has a flash TAP, like the str912;
2783 @item @code{jrc} -- For JTAG route controller (example: the ICEpick modules
2784 on many Texas Instruments chips, like the OMAP3530 on Beagleboards);
2785 @item @code{tap} -- Should be used only FPGA or CPLD like devices
2786 with a single TAP;
2787 @item @code{unknownN} -- If you have no idea what the TAP is for (N is a number);
2788 @item @emph{when in doubt} -- Use the chip maker's name in their data sheet.
2789 For example, the Freescale IMX31 has a SDMA (Smart DMA) with
2790 a JTAG TAP; that TAP should be named @code{sdma}.
2791 @end itemize
2792
2793 Every TAP requires at least the following @var{configparams}:
2794
2795 @itemize @bullet
2796 @item @code{-irlen} @var{NUMBER}
2797 @*The length in bits of the
2798 instruction register, such as 4 or 5 bits.
2799 @end itemize
2800
2801 A TAP may also provide optional @var{configparams}:
2802
2803 @itemize @bullet
2804 @item @code{-disable} (or @code{-enable})
2805 @*Use the @code{-disable} parameter to flag a TAP which is not
2806 linked in to the scan chain after a reset using either TRST
2807 or the JTAG state machine's @sc{reset} state.
2808 You may use @code{-enable} to highlight the default state
2809 (the TAP is linked in).
2810 @xref{Enabling and Disabling TAPs}.
2811 @item @code{-expected-id} @var{number}
2812 @*A non-zero @var{number} represents a 32-bit IDCODE
2813 which you expect to find when the scan chain is examined.
2814 These codes are not required by all JTAG devices.
2815 @emph{Repeat the option} as many times as required if more than one
2816 ID code could appear (for example, multiple versions).
2817 Specify @var{number} as zero to suppress warnings about IDCODE
2818 values that were found but not included in the list.
2819
2820 Provide this value if at all possible, since it lets OpenOCD
2821 tell when the scan chain it sees isn't right.  These values
2822 are provided in vendors' chip documentation, usually a technical
2823 reference manual.  Sometimes you may need to probe the JTAG
2824 hardware to find these values.
2825 @xref{Autoprobing}.
2826 @item @code{-ignore-version}
2827 @*Specify this to ignore the JTAG version field in the @code{-expected-id}
2828 option.  When vendors put out multiple versions of a chip, or use the same
2829 JTAG-level ID for several largely-compatible chips, it may be more practical
2830 to ignore the version field than to update config files to handle all of
2831 the various chip IDs.
2832 @item @code{-ircapture} @var{NUMBER}
2833 @*The bit pattern loaded by the TAP into the JTAG shift register
2834 on entry to the @sc{ircapture} state, such as 0x01.
2835 JTAG requires the two LSBs of this value to be 01.
2836 By default, @code{-ircapture} and @code{-irmask} are set
2837 up to verify that two-bit value.  You may provide
2838 additional bits, if you know them, or indicate that
2839 a TAP doesn't conform to the JTAG specification.
2840 @item @code{-irmask} @var{NUMBER}
2841 @*A mask used with @code{-ircapture}
2842 to verify that instruction scans work correctly.
2843 Such scans are not used by OpenOCD except to verify that
2844 there seems to be no problems with JTAG scan chain operations.
2845 @end itemize
2846 @end deffn
2847
2848 @section Other TAP commands
2849
2850 @deffn Command {jtag cget} dotted.name @option{-event} name
2851 @deffnx Command {jtag configure} dotted.name @option{-event} name string
2852 At this writing this TAP attribute
2853 mechanism is used only for event handling.
2854 (It is not a direct analogue of the @code{cget}/@code{configure}
2855 mechanism for debugger targets.)
2856 See the next section for information about the available events.
2857
2858 The @code{configure} subcommand assigns an event handler,
2859 a TCL string which is evaluated when the event is triggered.
2860 The @code{cget} subcommand returns that handler.
2861 @end deffn
2862
2863 @anchor{TAP Events}
2864 @section TAP Events
2865 @cindex events
2866 @cindex TAP events
2867
2868 OpenOCD includes two event mechanisms.
2869 The one presented here applies to all JTAG TAPs.
2870 The other applies to debugger targets,
2871 which are associated with certain TAPs.
2872
2873 The TAP events currently defined are:
2874
2875 @itemize @bullet
2876 @item @b{post-reset}
2877 @* The TAP has just completed a JTAG reset.
2878 The tap may still be in the JTAG @sc{reset} state.
2879 Handlers for these events might perform initialization sequences
2880 such as issuing TCK cycles, TMS sequences to ensure
2881 exit from the ARM SWD mode, and more.
2882
2883 Because the scan chain has not yet been verified, handlers for these events
2884 @emph{should not issue commands which scan the JTAG IR or DR registers}
2885 of any particular target.
2886 @b{NOTE:} As this is written (September 2009), nothing prevents such access.
2887 @item @b{setup}
2888 @* The scan chain has been reset and verified.
2889 This handler may enable TAPs as needed.
2890 @item @b{tap-disable}
2891 @* The TAP needs to be disabled.  This handler should
2892 implement @command{jtag tapdisable}
2893 by issuing the relevant JTAG commands.
2894 @item @b{tap-enable}
2895 @* The TAP needs to be enabled.  This handler should
2896 implement @command{jtag tapenable}
2897 by issuing the relevant JTAG commands.
2898 @end itemize
2899
2900 If you need some action after each JTAG reset, which isn't actually
2901 specific to any TAP (since you can't yet trust the scan chain's
2902 contents to be accurate), you might:
2903
2904 @example
2905 jtag configure CHIP.jrc -event post-reset @{
2906   echo "JTAG Reset done"
2907   ... non-scan jtag operations to be done after reset
2908 @}
2909 @end example
2910
2911
2912 @anchor{Enabling and Disabling TAPs}
2913 @section Enabling and Disabling TAPs
2914 @cindex JTAG Route Controller
2915 @cindex jrc
2916
2917 In some systems, a @dfn{JTAG Route Controller} (JRC)
2918 is used to enable and/or disable specific JTAG TAPs.
2919 Many ARM based chips from Texas Instruments include
2920 an ``ICEpick'' module, which is a JRC.
2921 Such chips include DaVinci and OMAP3 processors.
2922
2923 A given TAP may not be visible until the JRC has been
2924 told to link it into the scan chain; and if the JRC
2925 has been told to unlink that TAP, it will no longer
2926 be visible.
2927 Such routers address problems that JTAG ``bypass mode''
2928 ignores, such as:
2929
2930 @itemize
2931 @item The scan chain can only go as fast as its slowest TAP.
2932 @item Having many TAPs slows instruction scans, since all
2933 TAPs receive new instructions.
2934 @item TAPs in the scan chain must be powered up, which wastes
2935 power and prevents debugging some power management mechanisms.
2936 @end itemize
2937
2938 The IEEE 1149.1 JTAG standard has no concept of a ``disabled'' tap,
2939 as implied by the existence of JTAG routers.
2940 However, the upcoming IEEE 1149.7 framework (layered on top of JTAG)
2941 does include a kind of JTAG router functionality.
2942
2943 @c (a) currently the event handlers don't seem to be able to
2944 @c     fail in a way that could lead to no-change-of-state.
2945
2946 In OpenOCD, tap enabling/disabling is invoked by the Tcl commands
2947 shown below, and is implemented using TAP event handlers.
2948 So for example, when defining a TAP for a CPU connected to
2949 a JTAG router, your @file{target.cfg} file
2950 should define TAP event handlers using
2951 code that looks something like this:
2952
2953 @example
2954 jtag configure CHIP.cpu -event tap-enable @{
2955   ... jtag operations using CHIP.jrc
2956 @}
2957 jtag configure CHIP.cpu -event tap-disable @{
2958   ... jtag operations using CHIP.jrc
2959 @}
2960 @end example
2961
2962 Then you might want that CPU's TAP enabled almost all the time:
2963
2964 @example
2965 jtag configure $CHIP.jrc -event setup "jtag tapenable $CHIP.cpu"
2966 @end example
2967
2968 Note how that particular setup event handler declaration
2969 uses quotes to evaluate @code{$CHIP} when the event is configured.
2970 Using brackets @{ @} would cause it to be evaluated later,
2971 at runtime, when it might have a different value.
2972
2973 @deffn Command {jtag tapdisable} dotted.name
2974 If necessary, disables the tap
2975 by sending it a @option{tap-disable} event.
2976 Returns the string "1" if the tap
2977 specified by @var{dotted.name} is enabled,
2978 and "0" if it is disabled.
2979 @end deffn
2980
2981 @deffn Command {jtag tapenable} dotted.name
2982 If necessary, enables the tap
2983 by sending it a @option{tap-enable} event.
2984 Returns the string "1" if the tap
2985 specified by @var{dotted.name} is enabled,
2986 and "0" if it is disabled.
2987 @end deffn
2988
2989 @deffn Command {jtag tapisenabled} dotted.name
2990 Returns the string "1" if the tap
2991 specified by @var{dotted.name} is enabled,
2992 and "0" if it is disabled.
2993
2994 @quotation Note
2995 Humans will find the @command{scan_chain} command more helpful
2996 for querying the state of the JTAG taps.
2997 @end quotation
2998 @end deffn
2999
3000 @anchor{Autoprobing}
3001 @section Autoprobing
3002 @cindex autoprobe
3003 @cindex JTAG autoprobe
3004
3005 TAP configuration is the first thing that needs to be done
3006 after interface and reset configuration.  Sometimes it's
3007 hard finding out what TAPs exist, or how they are identified.
3008 Vendor documentation is not always easy to find and use.
3009
3010 To help you get past such problems, OpenOCD has a limited
3011 @emph{autoprobing} ability to look at the scan chain, doing
3012 a @dfn{blind interrogation} and then reporting the TAPs it finds.
3013 To use this mechanism, start the OpenOCD server with only data
3014 that configures your JTAG interface, and arranges to come up
3015 with a slow clock (many devices don't support fast JTAG clocks
3016 right when they come out of reset).
3017
3018 For example, your @file{openocd.cfg} file might have:
3019
3020 @example
3021 source [find interface/olimex-arm-usb-tiny-h.cfg]
3022 reset_config trst_and_srst
3023 jtag_rclk 8
3024 @end example
3025
3026 When you start the server without any TAPs configured, it will
3027 attempt to autoconfigure the TAPs.  There are two parts to this:
3028
3029 @enumerate
3030 @item @emph{TAP discovery} ...
3031 After a JTAG reset (sometimes a system reset may be needed too),
3032 each TAP's data registers will hold the contents of either the
3033 IDCODE or BYPASS register.
3034 If JTAG communication is working, OpenOCD will see each TAP,
3035 and report what @option{-expected-id} to use with it.
3036 @item @emph{IR Length discovery} ...
3037 Unfortunately JTAG does not provide a reliable way to find out
3038 the value of the @option{-irlen} parameter to use with a TAP
3039 that is discovered.
3040 If OpenOCD can discover the length of a TAP's instruction
3041 register, it will report it.
3042 Otherwise you may need to consult vendor documentation, such
3043 as chip data sheets or BSDL files.
3044 @end enumerate
3045
3046 In many cases your board will have a simple scan chain with just
3047 a single device.  Here's what OpenOCD reported with one board
3048 that's a bit more complex:
3049
3050 @example
3051 clock speed 8 kHz
3052 There are no enabled taps.  AUTO PROBING MIGHT NOT WORK!!
3053 AUTO auto0.tap - use "jtag newtap auto0 tap -expected-id 0x2b900f0f ..."
3054 AUTO auto1.tap - use "jtag newtap auto1 tap -expected-id 0x07926001 ..."
3055 AUTO auto2.tap - use "jtag newtap auto2 tap -expected-id 0x0b73b02f ..."
3056 AUTO auto0.tap - use "... -irlen 4"
3057 AUTO auto1.tap - use "... -irlen 4"
3058 AUTO auto2.tap - use "... -irlen 6"
3059 no gdb ports allocated as no target has been specified
3060 @end example
3061
3062 Given that information, you should be able to either find some existing
3063 config files to use, or create your own.  If you create your own, you
3064 would configure from the bottom up:  first a @file{target.cfg} file
3065 with these TAPs, any targets associated with them, and any on-chip
3066 resources; then a @file{board.cfg} with off-chip resources, clocking,
3067 and so forth.
3068
3069 @node CPU Configuration
3070 @chapter CPU Configuration
3071 @cindex GDB target
3072
3073 This chapter discusses how to set up GDB debug targets for CPUs.
3074 You can also access these targets without GDB
3075 (@pxref{Architecture and Core Commands},
3076 and @ref{Target State handling}) and
3077 through various kinds of NAND and NOR flash commands.
3078 If you have multiple CPUs you can have multiple such targets.
3079
3080 We'll start by looking at how to examine the targets you have,
3081 then look at how to add one more target and how to configure it.
3082
3083 @section Target List
3084 @cindex target, current
3085 @cindex target, list
3086
3087 All targets that have been set up are part of a list,
3088 where each member has a name.
3089 That name should normally be the same as the TAP name.
3090 You can display the list with the @command{targets}
3091 (plural!) command.
3092 This display often has only one CPU; here's what it might
3093 look like with more than one:
3094 @verbatim
3095     TargetName         Type       Endian TapName            State
3096 --  ------------------ ---------- ------ ------------------ ------------
3097  0* at91rm9200.cpu     arm920t    little at91rm9200.cpu     running
3098  1  MyTarget           cortex_m3  little mychip.foo         tap-disabled
3099 @end verbatim
3100
3101 One member of that list is the @dfn{current target}, which
3102 is implicitly referenced by many commands.
3103 It's the one marked with a @code{*} near the target name.
3104 In particular, memory addresses often refer to the address
3105 space seen by that current target.
3106 Commands like @command{mdw} (memory display words)
3107 and @command{flash erase_address} (erase NOR flash blocks)
3108 are examples; and there are many more.
3109
3110 Several commands let you examine the list of targets:
3111
3112 @deffn Command {target count}
3113 @emph{Note: target numbers are deprecated; don't use them.
3114 They will be removed shortly after August 2010, including this command.
3115 Iterate target using @command{target names}, not by counting.}
3116
3117 Returns the number of targets, @math{N}.
3118 The highest numbered target is @math{N - 1}.
3119 @example
3120 set c [target count]
3121 for @{ set x 0 @} @{ $x < $c @} @{ incr x @} @{
3122     # Assuming you have created this function
3123     print_target_details $x
3124 @}
3125 @end example
3126 @end deffn
3127
3128 @deffn Command {target current}
3129 Returns the name of the current target.
3130 @end deffn
3131
3132 @deffn Command {target names}
3133 Lists the names of all current targets in the list.
3134 @example
3135 foreach t [target names] @{
3136     puts [format "Target: %s\n" $t]
3137 @}
3138 @end example
3139 @end deffn
3140
3141 @deffn Command {target number} number
3142 @emph{Note: target numbers are deprecated; don't use them.
3143 They will be removed shortly after August 2010, including this command.}
3144
3145 The list of targets is numbered starting at zero.
3146 This command returns the name of the target at index @var{number}.
3147 @example
3148 set thename [target number $x]
3149 puts [format "Target %d is: %s\n" $x $thename]
3150 @end example
3151 @end deffn
3152
3153 @c yep, "target list" would have been better.
3154 @c plus maybe "target setdefault".
3155
3156 @deffn Command targets [name]
3157 @emph{Note: the name of this command is plural.  Other target
3158 command names are singular.}
3159
3160 With no parameter, this command displays a table of all known
3161 targets in a user friendly form.
3162
3163 With a parameter, this command sets the current target to
3164 the given target with the given @var{name}; this is
3165 only relevant on boards which have more than one target.
3166 @end deffn
3167
3168 @section Target CPU Types and Variants
3169 @cindex target type
3170 @cindex CPU type
3171 @cindex CPU variant
3172
3173 Each target has a @dfn{CPU type}, as shown in the output of
3174 the @command{targets} command.  You need to specify that type
3175 when calling @command{target create}.
3176 The CPU type indicates more than just the instruction set.
3177 It also indicates how that instruction set is implemented,
3178 what kind of debug support it integrates,
3179 whether it has an MMU (and if so, what kind),
3180 what core-specific commands may be available
3181 (@pxref{Architecture and Core Commands}),
3182 and more.
3183
3184 For some CPU types, OpenOCD also defines @dfn{variants} which
3185 indicate differences that affect their handling.
3186 For example, a particular implementation bug might need to be
3187 worked around in some chip versions.
3188
3189 It's easy to see what target types are supported,
3190 since there's a command to list them.
3191 However, there is currently no way to list what target variants
3192 are supported (other than by reading the OpenOCD source code).
3193
3194 @anchor{target types}
3195 @deffn Command {target types}
3196 Lists all supported target types.
3197 At this writing, the supported CPU types and variants are:
3198
3199 @itemize @bullet
3200 @item @code{arm11} -- this is a generation of ARMv6 cores
3201 @item @code{arm720t} -- this is an ARMv4 core with an MMU
3202 @item @code{arm7tdmi} -- this is an ARMv4 core
3203 @item @code{arm920t} -- this is an ARMv5 core with an MMU
3204 @item @code{arm926ejs} -- this is an ARMv5 core with an MMU
3205 @item @code{arm966e} -- this is an ARMv5 core
3206 @item @code{arm9tdmi} -- this is an ARMv4 core
3207 @item @code{avr} -- implements Atmel's 8-bit AVR instruction set.
3208 (Support for this is preliminary and incomplete.)
3209 @item @code{cortex_a8} -- this is an ARMv7 core with an MMU
3210 @item @code{cortex_m3} -- this is an ARMv7 core, supporting only the
3211 compact Thumb2 instruction set.  It supports one variant:
3212 @itemize @minus
3213 @item @code{lm3s} ... Use this when debugging older Stellaris LM3S targets.
3214 This will cause OpenOCD to use a software reset rather than asserting
3215 SRST, to avoid a issue with clearing the debug registers.
3216 This is fixed in Fury Rev B, DustDevil Rev B, Tempest; these revisions will
3217 be detected and the normal reset behaviour used.
3218 @end itemize
3219 @item @code{dragonite} -- resembles arm966e
3220 @item @code{dsp563xx} -- implements Freescale's 24-bit DSP.
3221 (Support for this is still incomplete.)
3222 @item @code{fa526} -- resembles arm920 (w/o Thumb)
3223 @item @code{feroceon} -- resembles arm926
3224 @item @code{mips_m4k} -- a MIPS core.  This supports one variant:
3225 @itemize @minus
3226 @item @code{ejtag_srst} ... Use this when debugging targets that do not
3227 provide a functional SRST line on the EJTAG connector.  This causes
3228 OpenOCD to instead use an EJTAG software reset command to reset the
3229 processor.
3230 You still need to enable @option{srst} on the @command{reset_config}
3231 command to enable OpenOCD hardware reset functionality.
3232 @end itemize
3233 @item @code{xscale} -- this is actually an architecture,
3234 not a CPU type.  It is based on the ARMv5 architecture.
3235 There are several variants defined:
3236 @itemize @minus
3237 @item @code{ixp42x}, @code{ixp45x}, @code{ixp46x},
3238 @code{pxa27x} ... instruction register length is 7 bits
3239 @item @code{pxa250}, @code{pxa255},
3240 @code{pxa26x} ... instruction register length is 5 bits
3241 @item @code{pxa3xx} ... instruction register length is 11 bits
3242 @end itemize
3243 @end itemize
3244 @end deffn
3245
3246 To avoid being confused by the variety of ARM based cores, remember
3247 this key point: @emph{ARM is a technology licencing company}.
3248 (See: @url{http://www.arm.com}.)
3249 The CPU name used by OpenOCD will reflect the CPU design that was
3250 licenced, not a vendor brand which incorporates that design.
3251 Name prefixes like arm7, arm9, arm11, and cortex
3252 reflect design generations;
3253 while names like ARMv4, ARMv5, ARMv6, and ARMv7
3254 reflect an architecture version implemented by a CPU design.
3255
3256 @anchor{Target Configuration}
3257 @section Target Configuration
3258
3259 Before creating a ``target'', you must have added its TAP to the scan chain.
3260 When you've added that TAP, you will have a @code{dotted.name}
3261 which is used to set up the CPU support.
3262 The chip-specific configuration file will normally configure its CPU(s)
3263 right after it adds all of the chip's TAPs to the scan chain.
3264
3265 Although you can set up a target in one step, it's often clearer if you
3266 use shorter commands and do it in two steps:  create it, then configure
3267 optional parts.
3268 All operations on the target after it's created will use a new
3269 command, created as part of target creation.
3270
3271 The two main things to configure after target creation are
3272 a work area, which usually has target-specific defaults even
3273 if the board setup code overrides them later;
3274 and event handlers (@pxref{Target Events}), which tend
3275 to be much more board-specific.
3276 The key steps you use might look something like this
3277
3278 @example
3279 target create MyTarget cortex_m3 -chain-position mychip.cpu
3280 $MyTarget configure -work-area-phys 0x08000 -work-area-size 8096
3281 $MyTarget configure -event reset-deassert-pre @{ jtag_rclk 5 @}
3282 $MyTarget configure -event reset-init @{ myboard_reinit @}
3283 @end example
3284
3285 You should specify a working area if you can; typically it uses some
3286 on-chip SRAM.
3287 Such a working area can speed up many things, including bulk
3288 writes to target memory;
3289 flash operations like checking to see if memory needs to be erased;
3290 GDB memory checksumming;
3291 and more.
3292
3293 @quotation Warning
3294 On more complex chips, the work area can become
3295 inaccessible when application code
3296 (such as an operating system)
3297 enables or disables the MMU.
3298 For example, the particular MMU context used to acess the virtual
3299 address will probably matter ... and that context might not have
3300 easy access to other addresses needed.
3301 At this writing, OpenOCD doesn't have much MMU intelligence.
3302 @end quotation
3303
3304 It's often very useful to define a @code{reset-init} event handler.
3305 For systems that are normally used with a boot loader,
3306 common tasks include updating clocks and initializing memory
3307 controllers.
3308 That may be needed to let you write the boot loader into flash,
3309 in order to ``de-brick'' your board; or to load programs into
3310 external DDR memory without having run the boot loader.
3311
3312 @deffn Command {target create} target_name type configparams...
3313 This command creates a GDB debug target that refers to a specific JTAG tap.
3314 It enters that target into a list, and creates a new
3315 command (@command{@var{target_name}}) which is used for various
3316 purposes including additional configuration.
3317
3318 @itemize @bullet
3319 @item @var{target_name} ...  is the name of the debug target.
3320 By convention this should be the same as the @emph{dotted.name}
3321 of the TAP associated with this target, which must be specified here
3322 using the @code{-chain-position @var{dotted.name}} configparam.
3323
3324 This name is also used to create the target object command,
3325 referred to here as @command{$target_name},
3326 and in other places the target needs to be identified.
3327 @item @var{type} ... specifies the target type.  @xref{target types}.
3328 @item @var{configparams} ...  all parameters accepted by
3329 @command{$target_name configure} are permitted.
3330 If the target is big-endian, set it here with @code{-endian big}.
3331 If the variant matters, set it here with @code{-variant}.
3332
3333 You @emph{must} set the @code{-chain-position @var{dotted.name}} here.
3334 @end itemize
3335 @end deffn
3336
3337 @deffn Command {$target_name configure} configparams...
3338 The options accepted by this command may also be
3339 specified as parameters to @command{target create}.
3340 Their values can later be queried one at a time by
3341 using the @command{$target_name cget} command.
3342
3343 @emph{Warning:} changing some of these after setup is dangerous.
3344 For example, moving a target from one TAP to another;
3345 and changing its endianness or variant.
3346
3347 @itemize @bullet
3348
3349 @item @code{-chain-position} @var{dotted.name} -- names the TAP
3350 used to access this target.
3351
3352 @item @code{-endian} (@option{big}|@option{little}) -- specifies
3353 whether the CPU uses big or little endian conventions
3354
3355 @item @code{-event} @var{event_name} @var{event_body} --
3356 @xref{Target Events}.
3357 Note that this updates a list of named event handlers.
3358 Calling this twice with two different event names assigns
3359 two different handlers, but calling it twice with the
3360 same event name assigns only one handler.
3361
3362 @item @code{-variant} @var{name} -- specifies a variant of the target,
3363 which OpenOCD needs to know about.
3364
3365 @item @code{-work-area-backup} (@option{0}|@option{1}) -- says
3366 whether the work area gets backed up; by default,
3367 @emph{it is not backed up.}
3368 When possible, use a working_area that doesn't need to be backed up,
3369 since performing a backup slows down operations.
3370 For example, the beginning of an SRAM block is likely to
3371 be used by most build systems, but the end is often unused.
3372
3373 @item @code{-work-area-size} @var{size} -- specify work are size,
3374 in bytes.  The same size applies regardless of whether its physical
3375 or virtual address is being used.
3376
3377 @item @code{-work-area-phys} @var{address} -- set the work area
3378 base @var{address} to be used when no MMU is active.
3379
3380 @item @code{-work-area-virt} @var{address} -- set the work area
3381 base @var{address} to be used when an MMU is active.
3382 @emph{Do not specify a value for this except on targets with an MMU.}
3383 The value should normally correspond to a static mapping for the
3384 @code{-work-area-phys} address, set up by the current operating system.
3385
3386 @end itemize
3387 @end deffn
3388
3389 @section Other $target_name Commands
3390 @cindex object command
3391
3392 The Tcl/Tk language has the concept of object commands,
3393 and OpenOCD adopts that same model for targets.
3394
3395 A good Tk example is a on screen button.
3396 Once a button is created a button
3397 has a name (a path in Tk terms) and that name is useable as a first
3398 class command. For example in Tk, one can create a button and later
3399 configure it like this:
3400
3401 @example
3402 # Create
3403 button .foobar -background red -command @{ foo @}
3404 # Modify
3405 .foobar configure -foreground blue
3406 # Query
3407 set x [.foobar cget -background]
3408 # Report
3409 puts [format "The button is %s" $x]
3410 @end example
3411
3412 In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
3413 button, and its object commands are invoked the same way.
3414
3415 @example
3416 str912.cpu    mww 0x1234 0x42
3417 omap3530.cpu  mww 0x5555 123
3418 @end example
3419
3420 The commands supported by OpenOCD target objects are:
3421
3422 @deffn Command {$target_name arp_examine}
3423 @deffnx Command {$target_name arp_halt}
3424 @deffnx Command {$target_name arp_poll}
3425 @deffnx Command {$target_name arp_reset}
3426 @deffnx Command {$target_name arp_waitstate}
3427 Internal OpenOCD scripts (most notably @file{startup.tcl})
3428 use these to deal with specific reset cases.
3429 They are not otherwise documented here.
3430 @end deffn
3431
3432 @deffn Command {$target_name array2mem} arrayname width address count
3433 @deffnx Command {$target_name mem2array} arrayname width address count
3434 These provide an efficient script-oriented interface to memory.
3435 The @code{array2mem} primitive writes bytes, halfwords, or words;
3436 while @code{mem2array} reads them.
3437 In both cases, the TCL side uses an array, and
3438 the target side uses raw memory.
3439
3440 The efficiency comes from enabling the use of
3441 bulk JTAG data transfer operations.
3442 The script orientation comes from working with data
3443 values that are packaged for use by TCL scripts;
3444 @command{mdw} type primitives only print data they retrieve,
3445 and neither store nor return those values.
3446
3447 @itemize
3448 @item @var{arrayname} ... is the name of an array variable
3449 @item @var{width} ... is 8/16/32 - indicating the memory access size
3450 @item @var{address} ... is the target memory address
3451 @item @var{count} ... is the number of elements to process
3452 @end itemize
3453 @end deffn
3454
3455 @deffn Command {$target_name cget} queryparm
3456 Each configuration parameter accepted by
3457 @command{$target_name configure}
3458 can be individually queried, to return its current value.
3459 The @var{queryparm} is a parameter name
3460 accepted by that command, such as @code{-work-area-phys}.
3461 There are a few special cases:
3462
3463 @itemize @bullet
3464 @item @code{-event} @var{event_name} -- returns the handler for the
3465 event named @var{event_name}.
3466 This is a special case because setting a handler requires
3467 two parameters.
3468 @item @code{-type} -- returns the target type.
3469 This is a special case because this is set using
3470 @command{target create} and can't be changed
3471 using @command{$target_name configure}.
3472 @end itemize
3473
3474 For example, if you wanted to summarize information about
3475 all the targets you might use something like this:
3476
3477 @example
3478 foreach name [target names] @{
3479     set y [$name cget -endian]
3480     set z [$name cget -type]
3481     puts [format "Chip %d is %s, Endian: %s, type: %s" \
3482                  $x $name $y $z]
3483 @}
3484 @end example
3485 @end deffn
3486
3487 @anchor{target curstate}
3488 @deffn Command {$target_name curstate}
3489 Displays the current target state:
3490 @code{debug-running},
3491 @code{halted},
3492 @code{reset},
3493 @code{running}, or @code{unknown}.
3494 (Also, @pxref{Event Polling}.)
3495 @end deffn
3496
3497 @deffn Command {$target_name eventlist}
3498 Displays a table listing all event handlers
3499 currently associated with this target.
3500 @xref{Target Events}.
3501 @end deffn
3502
3503 @deffn Command {$target_name invoke-event} event_name
3504 Invokes the handler for the event named @var{event_name}.
3505 (This is primarily intended for use by OpenOCD framework
3506 code, for example by the reset code in @file{startup.tcl}.)
3507 @end deffn
3508
3509 @deffn Command {$target_name mdw} addr [count]
3510 @deffnx Command {$target_name mdh} addr [count]
3511 @deffnx Command {$target_name mdb} addr [count]
3512 Display contents of address @var{addr}, as
3513 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
3514 or 8-bit bytes (@command{mdb}).
3515 If @var{count} is specified, displays that many units.
3516 (If you want to manipulate the data instead of displaying it,
3517 see the @code{mem2array} primitives.)
3518 @end deffn
3519
3520 @deffn Command {$target_name mww} addr word
3521 @deffnx Command {$target_name mwh} addr halfword
3522 @deffnx Command {$target_name mwb} addr byte
3523 Writes the specified @var{word} (32 bits),
3524 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3525 at the specified address @var{addr}.
3526 @end deffn
3527
3528 @anchor{Target Events}
3529 @section Target Events
3530 @cindex target events
3531 @cindex events
3532 At various times, certain things can happen, or you want them to happen.
3533 For example:
3534 @itemize @bullet
3535 @item What should happen when GDB connects? Should your target reset?
3536 @item When GDB tries to flash the target, do you need to enable the flash via a special command?
3537 @item Is using SRST appropriate (and possible) on your system?
3538 Or instead of that, do you need to issue JTAG commands to trigger reset?
3539 SRST usually resets everything on the scan chain, which can be inappropriate.
3540 @item During reset, do you need to write to certain memory locations
3541 to set up system clocks or
3542 to reconfigure the SDRAM?
3543 How about configuring the watchdog timer, or other peripherals,
3544 to stop running while you hold the core stopped for debugging?
3545 @end itemize
3546
3547 All of the above items can be addressed by target event handlers.
3548 These are set up by @command{$target_name configure -event} or
3549 @command{target create ... -event}.
3550
3551 The programmer's model matches the @code{-command} option used in Tcl/Tk
3552 buttons and events.  The two examples below act the same, but one creates
3553 and invokes a small procedure while the other inlines it.
3554
3555 @example
3556 proc my_attach_proc @{ @} @{
3557     echo "Reset..."
3558     reset halt
3559 @}
3560 mychip.cpu configure -event gdb-attach my_attach_proc
3561 mychip.cpu configure -event gdb-attach @{
3562     echo "Reset..."
3563     reset halt
3564 @}
3565 @end example
3566
3567 The following target events are defined:
3568
3569 @itemize @bullet
3570 @item @b{debug-halted}
3571 @* The target has halted for debug reasons (i.e.: breakpoint)
3572 @item @b{debug-resumed}
3573 @* The target has resumed (i.e.: gdb said run)
3574 @item @b{early-halted}
3575 @* Occurs early in the halt process
3576 @ignore
3577 @item @b{examine-end}
3578 @* Currently not used (goal: when JTAG examine completes)
3579 @item @b{examine-start}
3580 @* Currently not used (goal: when JTAG examine starts)
3581 @end ignore
3582 @item @b{gdb-attach}
3583 @* When GDB connects
3584 @item @b{gdb-detach}
3585 @* When GDB disconnects
3586 @item @b{gdb-end}
3587 @* When the target has halted and GDB is not doing anything (see early halt)
3588 @item @b{gdb-flash-erase-start}
3589 @* Before the GDB flash process tries to erase the flash
3590 @item @b{gdb-flash-erase-end}
3591 @* After the GDB flash process has finished erasing the flash
3592 @item @b{gdb-flash-write-start}
3593 @* Before GDB writes to the flash
3594 @item @b{gdb-flash-write-end}
3595 @* After GDB writes to the flash
3596 @item @b{gdb-start}
3597 @* Before the target steps, gdb is trying to start/resume the target
3598 @item @b{halted}
3599 @* The target has halted
3600 @ignore
3601 @item @b{old-gdb_program_config}
3602 @* DO NOT USE THIS: Used internally
3603 @item @b{old-pre_resume}
3604 @* DO NOT USE THIS: Used internally
3605 @end ignore
3606 @item @b{reset-assert-pre}
3607 @* Issued as part of @command{reset} processing
3608 after @command{reset_init} was triggered
3609 but before either SRST alone is re-asserted on the scan chain,
3610 or @code{reset-assert} is triggered.
3611 @item @b{reset-assert}
3612 @* Issued as part of @command{reset} processing
3613 after @command{reset-assert-pre} was triggered.
3614 When such a handler is present, cores which support this event will use
3615 it instead of asserting SRST.
3616 This support is essential for debugging with JTAG interfaces which
3617 don't include an SRST line (JTAG doesn't require SRST), and for
3618 selective reset on scan chains that have multiple targets.
3619 @item @b{reset-assert-post}
3620 @* Issued as part of @command{reset} processing
3621 after @code{reset-assert} has been triggered.
3622 or the target asserted SRST on the entire scan chain.
3623 @item @b{reset-deassert-pre}
3624 @* Issued as part of @command{reset} processing
3625 after @code{reset-assert-post} has been triggered.
3626 @item @b{reset-deassert-post}
3627 @* Issued as part of @command{reset} processing
3628 after @code{reset-deassert-pre} has been triggered
3629 and (if the target is using it) after SRST has been
3630 released on the scan chain.
3631 @item @b{reset-end}
3632 @* Issued as the final step in @command{reset} processing.
3633 @ignore
3634 @item @b{reset-halt-post}
3635 @* Currently not used
3636 @item @b{reset-halt-pre}
3637 @* Currently not used
3638 @end ignore
3639 @item @b{reset-init}
3640 @* Used by @b{reset init} command for board-specific initialization.
3641 This event fires after @emph{reset-deassert-post}.
3642
3643 This is where you would configure PLLs and clocking, set up DRAM so
3644 you can download programs that don't fit in on-chip SRAM, set up pin
3645 multiplexing, and so on.
3646 (You may be able to switch to a fast JTAG clock rate here, after
3647 the target clocks are fully set up.)
3648 @item @b{reset-start}
3649 @* Issued as part of @command{reset} processing
3650 before @command{reset_init} is called.
3651
3652 This is the most robust place to use @command{jtag_rclk}
3653 or @command{jtag_khz} to switch to a low JTAG clock rate,
3654 when reset disables PLLs needed to use a fast clock.
3655 @ignore
3656 @item @b{reset-wait-pos}
3657 @* Currently not used
3658 @item @b{reset-wait-pre}
3659 @* Currently not used
3660 @end ignore
3661 @item @b{resume-start}
3662 @* Before any target is resumed
3663 @item @b{resume-end}
3664 @* After all targets have resumed
3665 @item @b{resume-ok}
3666 @* Success
3667 @item @b{resumed}
3668 @* Target has resumed
3669 @end itemize
3670
3671
3672 @node Flash Commands
3673 @chapter Flash Commands
3674
3675 OpenOCD has different commands for NOR and NAND flash;
3676 the ``flash'' command works with NOR flash, while
3677 the ``nand'' command works with NAND flash.
3678 This partially reflects different hardware technologies:
3679 NOR flash usually supports direct CPU instruction and data bus access,
3680 while data from a NAND flash must be copied to memory before it can be
3681 used.  (SPI flash must also be copied to memory before use.)
3682 However, the documentation also uses ``flash'' as a generic term;
3683 for example, ``Put flash configuration in board-specific files''.
3684
3685 Flash Steps:
3686 @enumerate
3687 @item Configure via the command @command{flash bank}
3688 @* Do this in a board-specific configuration file,
3689 passing parameters as needed by the driver.
3690 @item Operate on the flash via @command{flash subcommand}
3691 @* Often commands to manipulate the flash are typed by a human, or run
3692 via a script in some automated way.  Common tasks include writing a
3693 boot loader, operating system, or other data.
3694 @item GDB Flashing
3695 @* Flashing via GDB requires the flash be configured via ``flash
3696 bank'', and the GDB flash features be enabled.
3697 @xref{GDB Configuration}.
3698 @end enumerate
3699
3700 Many CPUs have the ablity to ``boot'' from the first flash bank.
3701 This means that misprogramming that bank can ``brick'' a system,
3702 so that it can't boot.
3703 JTAG tools, like OpenOCD, are often then used to ``de-brick'' the
3704 board by (re)installing working boot firmware.
3705
3706 @anchor{NOR Configuration}
3707 @section Flash Configuration Commands
3708 @cindex flash configuration
3709
3710 @deffn {Config Command} {flash bank} name driver base size chip_width bus_width target [driver_options]
3711 Configures a flash bank which provides persistent storage
3712 for addresses from @math{base} to @math{base + size - 1}.
3713 These banks will often be visible to GDB through the target's memory map.
3714 In some cases, configuring a flash bank will activate extra commands;
3715 see the driver-specific documentation.
3716
3717 @itemize @bullet
3718 @item @var{name} ... may be used to reference the flash bank
3719 in other flash commands.
3720 @item @var{driver} ... identifies the controller driver
3721 associated with the flash bank being declared.
3722 This is usually @code{cfi} for external flash, or else
3723 the name of a microcontroller with embedded flash memory.
3724 @xref{Flash Driver List}.
3725 @item @var{base} ... Base address of the flash chip.
3726 @item @var{size} ... Size of the chip, in bytes.
3727 For some drivers, this value is detected from the hardware.
3728 @item @var{chip_width} ... Width of the flash chip, in bytes;
3729 ignored for most microcontroller drivers.
3730 @item @var{bus_width} ... Width of the data bus used to access the
3731 chip, in bytes; ignored for most microcontroller drivers.
3732 @item @var{target} ... Names the target used to issue
3733 commands to the flash controller.
3734 @comment Actually, it's currently a controller-specific parameter...
3735 @item @var{driver_options} ... drivers may support, or require,
3736 additional parameters.  See the driver-specific documentation
3737 for more information.
3738 @end itemize
3739 @quotation Note
3740 This command is not available after OpenOCD initialization has completed.
3741 Use it in board specific configuration files, not interactively.
3742 @end quotation
3743 @end deffn
3744
3745 @comment the REAL name for this command is "ocd_flash_banks"
3746 @comment less confusing would be:  "flash list" (like "nand list")
3747 @deffn Command {flash banks}
3748 Prints a one-line summary of each device that was 
3749 declared using @command{flash bank}, numbered from zero.
3750 Note that this is the @emph{plural} form;
3751 the @emph{singular} form is a very different command.
3752 @end deffn
3753
3754 @deffn Command {flash list}
3755 Retrieves a list of associative arrays for each device that was 
3756 declared using @command{flash bank}, numbered from zero.
3757 This returned list can be manipulated easily from within scripts.
3758 @end deffn
3759
3760 @deffn Command {flash probe} num
3761 Identify the flash, or validate the parameters of the configured flash. Operation
3762 depends on the flash type.
3763 The @var{num} parameter is a value shown by @command{flash banks}.
3764 Most flash commands will implicitly @emph{autoprobe} the bank;
3765 flash drivers can distinguish between probing and autoprobing,
3766 but most don't bother.
3767 @end deffn
3768
3769 @section Erasing, Reading, Writing to Flash
3770 @cindex flash erasing
3771 @cindex flash reading
3772 @cindex flash writing
3773 @cindex flash programming
3774
3775 One feature distinguishing NOR flash from NAND or serial flash technologies
3776 is that for read access, it acts exactly like any other addressible memory.
3777 This means you can use normal memory read commands like @command{mdw} or
3778 @command{dump_image} with it, with no special @command{flash} subcommands.
3779 @xref{Memory access}, and @ref{Image access}.
3780
3781 Write access works differently.  Flash memory normally needs to be erased
3782 before it's written.  Erasing a sector turns all of its bits to ones, and
3783 writing can turn ones into zeroes.  This is why there are special commands
3784 for interactive erasing and writing, and why GDB needs to know which parts
3785 of the address space hold NOR flash memory.
3786
3787 @quotation Note
3788 Most of these erase and write commands leverage the fact that NOR flash
3789 chips consume target address space.  They implicitly refer to the current
3790 JTAG target, and map from an address in that target's address space
3791 back to a flash bank.
3792 @comment In May 2009, those mappings may fail if any bank associated
3793 @comment with that target doesn't succesfuly autoprobe ... bug worth fixing?
3794 A few commands use abstract addressing based on bank and sector numbers,
3795 and don't depend on searching the current target and its address space.
3796 Avoid confusing the two command models.
3797 @end quotation
3798
3799 Some flash chips implement software protection against accidental writes,
3800 since such buggy writes could in some cases ``brick'' a system.
3801 For such systems, erasing and writing may require sector protection to be
3802 disabled first.
3803 Examples include CFI flash such as ``Intel Advanced Bootblock flash'',
3804 and AT91SAM7 on-chip flash.
3805 @xref{flash protect}.
3806
3807 @anchor{flash erase_sector}
3808 @deffn Command {flash erase_sector} num first last
3809 Erase sectors in bank @var{num}, starting at sector @var{first}
3810 up to and including @var{last}.
3811 Sector numbering starts at 0.
3812 Providing a @var{last} sector of @option{last}
3813 specifies "to the end of the flash bank".
3814 The @var{num} parameter is a value shown by @command{flash banks}.
3815 @end deffn
3816
3817 @deffn Command {flash erase_address} address length
3818 Erase sectors starting at @var{address} for @var{length} bytes.
3819 The flash bank to use is inferred from the @var{address}, and
3820 the specified length must stay within that bank.
3821 As a special case, when @var{length} is zero and @var{address} is
3822 the start of the bank, the whole flash is erased.
3823 @end deffn
3824
3825 @deffn Command {flash fillw} address word length
3826 @deffnx Command {flash fillh} address halfword length
3827 @deffnx Command {flash fillb} address byte length
3828 Fills flash memory with the specified @var{word} (32 bits),
3829 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
3830 starting at @var{address} and continuing
3831 for @var{length} units (word/halfword/byte).