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