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