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