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