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