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