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