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