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