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