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