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