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