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