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