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