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