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