doc: make gdb-attach description understandable
[openocd.git] / doc / openocd.texi
blob4cc051ee440a2e9466fc6eb26c5fc9e310d1d6b4
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
12 @include version.texi
14 @copying
16 This User's Guide documents
17 release @value{VERSION},
18 dated @value{UPDATED},
19 of the Open On-Chip Debugger (OpenOCD).
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
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
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}
46 @page
47 @vskip 0pt plus 1filll
48 @insertcopying
49 @end titlepage
51 @summarycontents
52 @contents
54 @ifnottex
55 @node Top
56 @top OpenOCD User's Guide
58 @insertcopying
59 @end ifnottex
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
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
97 @node About
98 @unnumbered About
99 @cindex about
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.
107 @section What is OpenOCD?
108 @cindex TAP
109 @cindex JTAG
111 The Open On-Chip Debugger (OpenOCD) aims to provide debugging,
112 in-system programming and boundary-scan testing for embedded target
113 devices.
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.
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.)
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).
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.
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.
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.)
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}.
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, ST STM32 and Energy Micro EFM32) and Intel Quark (x10xx)
160 based cores to be debugged via the GDB protocol.
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.
168 @section OpenOCD Web Site
170 The OpenOCD web site provides the latest public news from the community:
172 @uref{http://openocd.org/}
174 @section Latest User's Guide:
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:
180 @uref{http://openocd.org/doc/html/index.html}
182 PDF form is likewise published at:
184 @uref{http://openocd.org/doc/pdf/openocd.pdf}
186 @section OpenOCD User's Forum
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.
194 @uref{http://forum.sparkfun.com/viewforum.php?f=18}
196 @section OpenOCD User's Mailing List
198 The OpenOCD User Mailing List provides the primary means of
199 communication between users:
201 @uref{https://lists.sourceforge.net/mailman/listinfo/openocd-user}
203 @section OpenOCD IRC
205 Support can also be found on irc:
206 @uref{irc://irc.freenode.net/openocd}
208 @node Developers
209 @chapter OpenOCD Developer Resources
210 @cindex developers
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.
217 The resources in this chapter are available for developers wishing to explore
218 or expand the OpenOCD source code.
220 @section OpenOCD Git Repository
222 During the 0.3.x release cycle, OpenOCD switched from Subversion to
223 a Git repository hosted at SourceForge. The repository URL is:
225 @uref{git://git.code.sf.net/p/openocd/code}
227 or via http
229 @uref{http://git.code.sf.net/p/openocd/code}
231 You may prefer to use a mirror and the HTTP protocol:
233 @uref{http://repo.or.cz/r/openocd.git}
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:
241 @uref{http://repo.or.cz/w/openocd.git}
243 The @file{README} file contains the instructions for building the project
244 from the repository or a snapshot.
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.
251 @section Doxygen Developer Manual
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:
258 @uref{http://openocd.org/doc/doxygen/html/index.html}
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.
264 @section Gerrit Review System
266 All changes in the OpenOCD Git repository go through the web-based Gerrit
267 Code Review System:
269 @uref{http://openocd.zylin.com/}
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.
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.
283 @section OpenOCD Developer Mailing List
285 The OpenOCD Developer Mailing List provides the primary means of
286 communication between developers:
288 @uref{https://lists.sourceforge.net/mailman/listinfo/openocd-devel}
290 @section OpenOCD Bug Tracker
292 The OpenOCD Bug Tracker is hosted on SourceForge:
294 @uref{http://bugs.openocd.org/}
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
307 Defined: @b{dongle}: A small device that plugs into a computer and serves as
308 an adapter .... [snip]
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.
319 @section Choosing a Dongle
321 There are several things you should keep in mind when choosing a dongle.
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
338 @section Stand-alone JTAG Probe
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.
354 For more information, visit:
356 @b{ZY1000} See: @url{http://www.ultsol.com/index.php/component/content/article/8/210-zylin-zy1000-main}
358 @section USB FT2232 Based
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.)
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.
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.
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
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
432 @end itemize
433 @section USB-JTAG / Altera USB-Blaster compatibles
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.
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).
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
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.
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
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.
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
479 @section USB ST-LINK based
480 ST Micro has an adapter called @b{ST-LINK}.
481 They only work with ST Micro chips, notably STM32 and STM8.
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 @end itemize
492 For info the original ST-LINK enumerates using the mass storage usb class; however,
493 its implementation is completely broken. The result is this causes issues under Linux.
494 The simplest solution is to get Linux to ignore the ST-LINK using one of the following methods:
495 @itemize @bullet
496 @item modprobe -r usb-storage && modprobe usb-storage quirks=483:3744:i
497 @item add "options usb-storage quirks=483:3744:i" to /etc/modprobe.conf
498 @end itemize
500 @section USB TI/Stellaris ICDI based
501 Texas Instruments has an adapter called @b{ICDI}.
502 It is not to be confused with the FTDI based adapters that were originally fitted to their
503 evaluation boards. This is the adapter fitted to the Stellaris LaunchPad.
505 @section USB CMSIS-DAP based
506 ARM has released a interface standard called CMSIS-DAP that simplifies connecting
507 debuggers to ARM Cortex based targets @url{http://www.keil.com/support/man/docs/dapdebug/dapdebug_introduction.htm}.
509 @section USB Other
510 @itemize @bullet
511 @item @b{USBprog}
512 @* Link: @url{http://shop.embedded-projects.net/} - which uses an Atmel MEGA32 and a UBN9604
514 @item @b{USB - Presto}
515 @* Link: @url{http://tools.asix.net/prg_presto.htm}
517 @item @b{Versaloon-Link}
518 @* Link: @url{http://www.versaloon.com}
520 @item @b{ARM-JTAG-EW}
521 @* Link: @url{http://www.olimex.com/dev/arm-jtag-ew.html}
523 @item @b{Buspirate}
524 @* Link: @url{http://dangerousprototypes.com/bus-pirate-manual/}
526 @item @b{opendous}
527 @* Link: @url{http://code.google.com/p/opendous-jtag/} - which uses an AT90USB162
529 @item @b{estick}
530 @* Link: @url{http://code.google.com/p/estick-jtag/}
532 @item @b{Keil ULINK v1}
533 @* Link: @url{http://www.keil.com/ulink1/}
534 @end itemize
536 @section IBM PC Parallel Printer Port Based
538 The two well-known ``JTAG Parallel Ports'' cables are the Xilinx DLC5
539 and the Macraigor Wiggler. There are many clones and variations of
540 these on the market.
542 Note that parallel ports are becoming much less common, so if you
543 have the choice you should probably avoid these adapters in favor
544 of USB-based ones.
546 @itemize @bullet
548 @item @b{Wiggler} - There are many clones of this.
549 @* Link: @url{http://www.macraigor.com/wiggler.htm}
551 @item @b{DLC5} - From XILINX - There are many clones of this
552 @* Link: Search the web for: ``XILINX DLC5'' - it is no longer
553 produced, PDF schematics are easily found and it is easy to make.
555 @item @b{Amontec - JTAG Accelerator}
556 @* Link: @url{http://www.amontec.com/jtag_accelerator.shtml}
558 @item @b{Wiggler2}
559 @* Link: @url{http://www.ccac.rwth-aachen.de/~michaels/index.php/hardware/armjtag}
561 @item @b{Wiggler_ntrst_inverted}
562 @* Yet another variation - See the source code, src/jtag/parport.c
564 @item @b{old_amt_wiggler}
565 @* Unknown - probably not on the market today
567 @item @b{arm-jtag}
568 @* Link: Most likely @url{http://www.olimex.com/dev/arm-jtag.html} [another wiggler clone]
570 @item @b{chameleon}
571 @* Link: @url{http://www.amontec.com/chameleon.shtml}
573 @item @b{Triton}
574 @* Unknown.
576 @item @b{Lattice}
577 @* ispDownload from Lattice Semiconductor
578 @url{http://www.latticesemi.com/lit/docs/@/devtools/dlcable.pdf}
580 @item @b{flashlink}
581 @* From ST Microsystems;
582 @* Link: @url{http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/DATA_BRIEF/DM00039500.pdf}
584 @end itemize
586 @section Other...
587 @itemize @bullet
589 @item @b{ep93xx}
590 @* An EP93xx based Linux machine using the GPIO pins directly.
592 @item @b{at91rm9200}
593 @* Like the EP93xx - but an ATMEL AT91RM9200 based solution using the GPIO pins on the chip.
595 @item @b{bcm2835gpio}
596 @* A BCM2835-based board (e.g. Raspberry Pi) using the GPIO pins of the expansion header.
598 @item @b{imx_gpio}
599 @* A NXP i.MX-based board (e.g. Wandboard) using the GPIO pins (should work on any i.MX processor).
601 @item @b{jtag_vpi}
602 @* A JTAG driver acting as a client for the JTAG VPI server interface.
603 @* Link: @url{http://github.com/fjullien/jtag_vpi}
605 @end itemize
607 @node About Jim-Tcl
608 @chapter About Jim-Tcl
609 @cindex Jim-Tcl
610 @cindex tcl
612 OpenOCD uses a small ``Tcl Interpreter'' known as Jim-Tcl.
613 This programming language provides a simple and extensible
614 command interpreter.
616 All commands presented in this Guide are extensions to Jim-Tcl.
617 You can use them as simple commands, without needing to learn
618 much of anything about Tcl.
619 Alternatively, you can write Tcl programs with them.
621 You can learn more about Jim at its website, @url{http://jim.tcl.tk}.
622 There is an active and responsive community, get on the mailing list
623 if you have any questions. Jim-Tcl maintainers also lurk on the
624 OpenOCD mailing list.
626 @itemize @bullet
627 @item @b{Jim vs. Tcl}
628 @* Jim-Tcl is a stripped down version of the well known Tcl language,
629 which can be found here: @url{http://www.tcl.tk}. Jim-Tcl has far
630 fewer features. Jim-Tcl is several dozens of .C files and .H files and
631 implements the basic Tcl command set. In contrast: Tcl 8.6 is a
632 4.2 MB .zip file containing 1540 files.
634 @item @b{Missing Features}
635 @* Our practice has been: Add/clone the real Tcl feature if/when
636 needed. We welcome Jim-Tcl improvements, not bloat. Also there
637 are a large number of optional Jim-Tcl features that are not
638 enabled in OpenOCD.
640 @item @b{Scripts}
641 @* OpenOCD configuration scripts are Jim-Tcl Scripts. OpenOCD's
642 command interpreter today is a mixture of (newer)
643 Jim-Tcl commands, and the (older) original command interpreter.
645 @item @b{Commands}
646 @* At the OpenOCD telnet command line (or via the GDB monitor command) one
647 can type a Tcl for() loop, set variables, etc.
648 Some of the commands documented in this guide are implemented
649 as Tcl scripts, from a @file{startup.tcl} file internal to the server.
651 @item @b{Historical Note}
652 @* Jim-Tcl was introduced to OpenOCD in spring 2008. Fall 2010,
653 before OpenOCD 0.5 release, OpenOCD switched to using Jim-Tcl
654 as a Git submodule, which greatly simplified upgrading Jim-Tcl
655 to benefit from new features and bugfixes in Jim-Tcl.
657 @item @b{Need a crash course in Tcl?}
658 @*@xref{Tcl Crash Course}.
659 @end itemize
661 @node Running
662 @chapter Running
663 @cindex command line options
664 @cindex logfile
665 @cindex directory search
667 Properly installing OpenOCD sets up your operating system to grant it access
668 to the debug adapters. On Linux, this usually involves installing a file
669 in @file{/etc/udev/rules.d,} so OpenOCD has permissions. An example rules file
670 that works for many common adapters is shipped with OpenOCD in the
671 @file{contrib} directory. MS-Windows needs
672 complex and confusing driver configuration for every peripheral. Such issues
673 are unique to each operating system, and are not detailed in this User's Guide.
675 Then later you will invoke the OpenOCD server, with various options to
676 tell it how each debug session should work.
677 The @option{--help} option shows:
678 @verbatim
679 bash$ openocd --help
681 --help       | -h       display this help
682 --version    | -v       display OpenOCD version
683 --file       | -f       use configuration file <name>
684 --search     | -s       dir to search for config files and scripts
685 --debug      | -d       set debug level to 3
686              | -d<n>    set debug level to <level>
687 --log_output | -l       redirect log output to file <name>
688 --command    | -c       run <command>
689 @end verbatim
691 If you don't give any @option{-f} or @option{-c} options,
692 OpenOCD tries to read the configuration file @file{openocd.cfg}.
693 To specify one or more different
694 configuration files, use @option{-f} options. For example:
696 @example
697 openocd -f config1.cfg -f config2.cfg -f config3.cfg
698 @end example
700 Configuration files and scripts are searched for in
701 @enumerate
702 @item the current directory,
703 @item any search dir specified on the command line using the @option{-s} option,
704 @item any search dir specified using the @command{add_script_search_dir} command,
705 @item @file{$HOME/.openocd} (not on Windows),
706 @item a directory in the @env{OPENOCD_SCRIPTS} environment variable (if set),
707 @item the site wide script library @file{$pkgdatadir/site} and
708 @item the OpenOCD-supplied script library @file{$pkgdatadir/scripts}.
709 @end enumerate
710 The first found file with a matching file name will be used.
712 @quotation Note
713 Don't try to use configuration script names or paths which
714 include the "#" character. That character begins Tcl comments.
715 @end quotation
717 @section Simple setup, no customization
719 In the best case, you can use two scripts from one of the script
720 libraries, hook up your JTAG adapter, and start the server ... and
721 your JTAG setup will just work "out of the box". Always try to
722 start by reusing those scripts, but assume you'll need more
723 customization even if this works. @xref{OpenOCD Project Setup}.
725 If you find a script for your JTAG adapter, and for your board or
726 target, you may be able to hook up your JTAG adapter then start
727 the server with some variation of one of the following:
729 @example
730 openocd -f interface/ADAPTER.cfg -f board/MYBOARD.cfg
731 openocd -f interface/ftdi/ADAPTER.cfg -f board/MYBOARD.cfg
732 @end example
734 You might also need to configure which reset signals are present,
735 using @option{-c 'reset_config trst_and_srst'} or something similar.
736 If all goes well you'll see output something like
738 @example
739 Open On-Chip Debugger 0.4.0 (2010-01-14-15:06)
740 For bug reports, read
741         http://openocd.org/doc/doxygen/bugs.html
742 Info : JTAG tap: lm3s.cpu tap/device found: 0x3ba00477
743        (mfg: 0x23b, part: 0xba00, ver: 0x3)
744 @end example
746 Seeing that "tap/device found" message, and no warnings, means
747 the JTAG communication is working. That's a key milestone, but
748 you'll probably need more project-specific setup.
750 @section What OpenOCD does as it starts
752 OpenOCD starts by processing the configuration commands provided
753 on the command line or, if there were no @option{-c command} or
754 @option{-f file.cfg} options given, in @file{openocd.cfg}.
755 @xref{configurationstage,,Configuration Stage}.
756 At the end of the configuration stage it verifies the JTAG scan
757 chain defined using those commands; your configuration should
758 ensure that this always succeeds.
759 Normally, OpenOCD then starts running as a server.
760 Alternatively, commands may be used to terminate the configuration
761 stage early, perform work (such as updating some flash memory),
762 and then shut down without acting as a server.
764 Once OpenOCD starts running as a server, it waits for connections from
765 clients (Telnet, GDB, RPC) and processes the commands issued through
766 those channels.
768 If you are having problems, you can enable internal debug messages via
769 the @option{-d} option.
771 Also it is possible to interleave Jim-Tcl commands w/config scripts using the
772 @option{-c} command line switch.
774 To enable debug output (when reporting problems or working on OpenOCD
775 itself), use the @option{-d} command line switch. This sets the
776 @option{debug_level} to "3", outputting the most information,
777 including debug messages. The default setting is "2", outputting only
778 informational messages, warnings and errors. You can also change this
779 setting from within a telnet or gdb session using @command{debug_level<n>}
780 (@pxref{debuglevel,,debug_level}).
782 You can redirect all output from the server to a file using the
783 @option{-l <logfile>} switch.
785 Note! OpenOCD will launch the GDB & telnet server even if it can not
786 establish a connection with the target. In general, it is possible for
787 the JTAG controller to be unresponsive until the target is set up
788 correctly via e.g. GDB monitor commands in a GDB init script.
790 @node OpenOCD Project Setup
791 @chapter OpenOCD Project Setup
793 To use OpenOCD with your development projects, you need to do more than
794 just connect the JTAG adapter hardware (dongle) to your development board
795 and start the OpenOCD server.
796 You also need to configure your OpenOCD server so that it knows
797 about your adapter and board, and helps your work.
798 You may also want to connect OpenOCD to GDB, possibly
799 using Eclipse or some other GUI.
801 @section Hooking up the JTAG Adapter
803 Today's most common case is a dongle with a JTAG cable on one side
804 (such as a ribbon cable with a 10-pin or 20-pin IDC connector)
805 and a USB cable on the other.
806 Instead of USB, some cables use Ethernet;
807 older ones may use a PC parallel port, or even a serial port.
809 @enumerate
810 @item @emph{Start with power to your target board turned off},
811 and nothing connected to your JTAG adapter.
812 If you're particularly paranoid, unplug power to the board.
813 It's important to have the ground signal properly set up,
814 unless you are using a JTAG adapter which provides
815 galvanic isolation between the target board and the
816 debugging host.
818 @item @emph{Be sure it's the right kind of JTAG connector.}
819 If your dongle has a 20-pin ARM connector, you need some kind
820 of adapter (or octopus, see below) to hook it up to
821 boards using 14-pin or 10-pin connectors ... or to 20-pin
822 connectors which don't use ARM's pinout.
824 In the same vein, make sure the voltage levels are compatible.
825 Not all JTAG adapters have the level shifters needed to work
826 with 1.2 Volt boards.
828 @item @emph{Be certain the cable is properly oriented} or you might
829 damage your board. In most cases there are only two possible
830 ways to connect the cable.
831 Connect the JTAG cable from your adapter to the board.
832 Be sure it's firmly connected.
834 In the best case, the connector is keyed to physically
835 prevent you from inserting it wrong.
836 This is most often done using a slot on the board's male connector
837 housing, which must match a key on the JTAG cable's female connector.
838 If there's no housing, then you must look carefully and
839 make sure pin 1 on the cable hooks up to pin 1 on the board.
840 Ribbon cables are frequently all grey except for a wire on one
841 edge, which is red. The red wire is pin 1.
843 Sometimes dongles provide cables where one end is an ``octopus'' of
844 color coded single-wire connectors, instead of a connector block.
845 These are great when converting from one JTAG pinout to another,
846 but are tedious to set up.
847 Use these with connector pinout diagrams to help you match up the
848 adapter signals to the right board pins.
850 @item @emph{Connect the adapter's other end} once the JTAG cable is connected.
851 A USB, parallel, or serial port connector will go to the host which
852 you are using to run OpenOCD.
853 For Ethernet, consult the documentation and your network administrator.
855 For USB-based JTAG adapters you have an easy sanity check at this point:
856 does the host operating system see the JTAG adapter? If you're running
857 Linux, try the @command{lsusb} command. If that host is an
858 MS-Windows host, you'll need to install a driver before OpenOCD works.
860 @item @emph{Connect the adapter's power supply, if needed.}
861 This step is primarily for non-USB adapters,
862 but sometimes USB adapters need extra power.
864 @item @emph{Power up the target board.}
865 Unless you just let the magic smoke escape,
866 you're now ready to set up the OpenOCD server
867 so you can use JTAG to work with that board.
869 @end enumerate
871 Talk with the OpenOCD server using
872 telnet (@code{telnet localhost 4444} on many systems) or GDB.
873 @xref{GDB and OpenOCD}.
875 @section Project Directory
877 There are many ways you can configure OpenOCD and start it up.
879 A simple way to organize them all involves keeping a
880 single directory for your work with a given board.
881 When you start OpenOCD from that directory,
882 it searches there first for configuration files, scripts,
883 files accessed through semihosting,
884 and for code you upload to the target board.
885 It is also the natural place to write files,
886 such as log files and data you download from the board.
888 @section Configuration Basics
890 There are two basic ways of configuring OpenOCD, and
891 a variety of ways you can mix them.
892 Think of the difference as just being how you start the server:
894 @itemize
895 @item Many @option{-f file} or @option{-c command} options on the command line
896 @item No options, but a @dfn{user config file}
897 in the current directory named @file{openocd.cfg}
898 @end itemize
900 Here is an example @file{openocd.cfg} file for a setup
901 using a Signalyzer FT2232-based JTAG adapter to talk to
902 a board with an Atmel AT91SAM7X256 microcontroller:
904 @example
905 source [find interface/ftdi/signalyzer.cfg]
907 # GDB can also flash my flash!
908 gdb_memory_map enable
909 gdb_flash_program enable
911 source [find target/sam7x256.cfg]
912 @end example
914 Here is the command line equivalent of that configuration:
916 @example
917 openocd -f interface/ftdi/signalyzer.cfg \
918         -c "gdb_memory_map enable" \
919         -c "gdb_flash_program enable" \
920         -f target/sam7x256.cfg
921 @end example
923 You could wrap such long command lines in shell scripts,
924 each supporting a different development task.
925 One might re-flash the board with a specific firmware version.
926 Another might set up a particular debugging or run-time environment.
928 @quotation Important
929 At this writing (October 2009) the command line method has
930 problems with how it treats variables.
931 For example, after @option{-c "set VAR value"}, or doing the
932 same in a script, the variable @var{VAR} will have no value
933 that can be tested in a later script.
934 @end quotation
936 Here we will focus on the simpler solution: one user config
937 file, including basic configuration plus any TCL procedures
938 to simplify your work.
940 @section User Config Files
941 @cindex config file, user
942 @cindex user config file
943 @cindex config file, overview
945 A user configuration file ties together all the parts of a project
946 in one place.
947 One of the following will match your situation best:
949 @itemize
950 @item Ideally almost everything comes from configuration files
951 provided by someone else.
952 For example, OpenOCD distributes a @file{scripts} directory
953 (probably in @file{/usr/share/openocd/scripts} on Linux).
954 Board and tool vendors can provide these too, as can individual
955 user sites; the @option{-s} command line option lets you say
956 where to find these files. (@xref{Running}.)
957 The AT91SAM7X256 example above works this way.
959 Three main types of non-user configuration file each have their
960 own subdirectory in the @file{scripts} directory:
962 @enumerate
963 @item @b{interface} -- one for each different debug adapter;
964 @item @b{board} -- one for each different board
965 @item @b{target} -- the chips which integrate CPUs and other JTAG TAPs
966 @end enumerate
968 Best case: include just two files, and they handle everything else.
969 The first is an interface config file.
970 The second is board-specific, and it sets up the JTAG TAPs and
971 their GDB targets (by deferring to some @file{target.cfg} file),
972 declares all flash memory, and leaves you nothing to do except
973 meet your deadline:
975 @example
976 source [find interface/olimex-jtag-tiny.cfg]
977 source [find board/csb337.cfg]
978 @end example
980 Boards with a single microcontroller often won't need more
981 than the target config file, as in the AT91SAM7X256 example.
982 That's because there is no external memory (flash, DDR RAM), and
983 the board differences are encapsulated by application code.
985 @item Maybe you don't know yet what your board looks like to JTAG.
986 Once you know the @file{interface.cfg} file to use, you may
987 need help from OpenOCD to discover what's on the board.
988 Once you find the JTAG TAPs, you can just search for appropriate
989 target and board
990 configuration files ... or write your own, from the bottom up.
991 @xref{autoprobing,,Autoprobing}.
993 @item You can often reuse some standard config files but
994 need to write a few new ones, probably a @file{board.cfg} file.
995 You will be using commands described later in this User's Guide,
996 and working with the guidelines in the next chapter.
998 For example, there may be configuration files for your JTAG adapter
999 and target chip, but you need a new board-specific config file
1000 giving access to your particular flash chips.
1001 Or you might need to write another target chip configuration file
1002 for a new chip built around the Cortex-M3 core.
1004 @quotation Note
1005 When you write new configuration files, please submit
1006 them for inclusion in the next OpenOCD release.
1007 For example, a @file{board/newboard.cfg} file will help the
1008 next users of that board, and a @file{target/newcpu.cfg}
1009 will help support users of any board using that chip.
1010 @end quotation
1012 @item
1013 You may may need to write some C code.
1014 It may be as simple as supporting a new FT2232 or parport
1015 based adapter; a bit more involved, like a NAND or NOR flash
1016 controller driver; or a big piece of work like supporting
1017 a new chip architecture.
1018 @end itemize
1020 Reuse the existing config files when you can.
1021 Look first in the @file{scripts/boards} area, then @file{scripts/targets}.
1022 You may find a board configuration that's a good example to follow.
1024 When you write config files, separate the reusable parts
1025 (things every user of that interface, chip, or board needs)
1026 from ones specific to your environment and debugging approach.
1027 @itemize
1029 @item
1030 For example, a @code{gdb-attach} event handler that invokes
1031 the @command{reset init} command will interfere with debugging
1032 early boot code, which performs some of the same actions
1033 that the @code{reset-init} event handler does.
1035 @item
1036 Likewise, the @command{arm9 vector_catch} command (or
1037 @cindex vector_catch
1038 its siblings @command{xscale vector_catch}
1039 and @command{cortex_m vector_catch}) can be a timesaver
1040 during some debug sessions, but don't make everyone use that either.
1041 Keep those kinds of debugging aids in your user config file,
1042 along with messaging and tracing setup.
1043 (@xref{softwaredebugmessagesandtracing,,Software Debug Messages and Tracing}.)
1045 @item
1046 You might need to override some defaults.
1047 For example, you might need to move, shrink, or back up the target's
1048 work area if your application needs much SRAM.
1050 @item
1051 TCP/IP port configuration is another example of something which
1052 is environment-specific, and should only appear in
1053 a user config file. @xref{tcpipports,,TCP/IP Ports}.
1054 @end itemize
1056 @section Project-Specific Utilities
1058 A few project-specific utility
1059 routines may well speed up your work.
1060 Write them, and keep them in your project's user config file.
1062 For example, if you are making a boot loader work on a
1063 board, it's nice to be able to debug the ``after it's
1064 loaded to RAM'' parts separately from the finicky early
1065 code which sets up the DDR RAM controller and clocks.
1066 A script like this one, or a more GDB-aware sibling,
1067 may help:
1069 @example
1070 proc ramboot @{ @} @{
1071     # Reset, running the target's "reset-init" scripts
1072     # to initialize clocks and the DDR RAM controller.
1073     # Leave the CPU halted.
1074     reset init
1076     # Load CONFIG_SKIP_LOWLEVEL_INIT version into DDR RAM.
1077     load_image u-boot.bin 0x20000000
1079     # Start running.
1080     resume 0x20000000
1082 @end example
1084 Then once that code is working you will need to make it
1085 boot from NOR flash; a different utility would help.
1086 Alternatively, some developers write to flash using GDB.
1087 (You might use a similar script if you're working with a flash
1088 based microcontroller application instead of a boot loader.)
1090 @example
1091 proc newboot @{ @} @{
1092     # Reset, leaving the CPU halted. The "reset-init" event
1093     # proc gives faster access to the CPU and to NOR flash;
1094     # "reset halt" would be slower.
1095     reset init
1097     # Write standard version of U-Boot into the first two
1098     # sectors of NOR flash ... the standard version should
1099     # do the same lowlevel init as "reset-init".
1100     flash protect 0 0 1 off
1101     flash erase_sector 0 0 1
1102     flash write_bank 0 u-boot.bin 0x0
1103     flash protect 0 0 1 on
1105     # Reboot from scratch using that new boot loader.
1106     reset run
1108 @end example
1110 You may need more complicated utility procedures when booting
1111 from NAND.
1112 That often involves an extra bootloader stage,
1113 running from on-chip SRAM to perform DDR RAM setup so it can load
1114 the main bootloader code (which won't fit into that SRAM).
1116 Other helper scripts might be used to write production system images,
1117 involving considerably more than just a three stage bootloader.
1119 @section Target Software Changes
1121 Sometimes you may want to make some small changes to the software
1122 you're developing, to help make JTAG debugging work better.
1123 For example, in C or assembly language code you might
1124 use @code{#ifdef JTAG_DEBUG} (or its converse) around code
1125 handling issues like:
1127 @itemize @bullet
1129 @item @b{Watchdog Timers}...
1130 Watchog timers are typically used to automatically reset systems if
1131 some application task doesn't periodically reset the timer. (The
1132 assumption is that the system has locked up if the task can't run.)
1133 When a JTAG debugger halts the system, that task won't be able to run
1134 and reset the timer ... potentially causing resets in the middle of
1135 your debug sessions.
1137 It's rarely a good idea to disable such watchdogs, since their usage
1138 needs to be debugged just like all other parts of your firmware.
1139 That might however be your only option.
1141 Look instead for chip-specific ways to stop the watchdog from counting
1142 while the system is in a debug halt state. It may be simplest to set
1143 that non-counting mode in your debugger startup scripts. You may however
1144 need a different approach when, for example, a motor could be physically
1145 damaged by firmware remaining inactive in a debug halt state. That might
1146 involve a type of firmware mode where that "non-counting" mode is disabled
1147 at the beginning then re-enabled at the end; a watchdog reset might fire
1148 and complicate the debug session, but hardware (or people) would be
1149 protected.@footnote{Note that many systems support a "monitor mode" debug
1150 that is a somewhat cleaner way to address such issues. You can think of
1151 it as only halting part of the system, maybe just one task,
1152 instead of the whole thing.
1153 At this writing, January 2010, OpenOCD based debugging does not support
1154 monitor mode debug, only "halt mode" debug.}
1156 @item @b{ARM Semihosting}...
1157 @cindex ARM semihosting
1158 When linked with a special runtime library provided with many
1159 toolchains@footnote{See chapter 8 "Semihosting" in
1160 @uref{http://infocenter.arm.com/help/topic/com.arm.doc.dui0203i/DUI0203I_rvct_developer_guide.pdf,
1161 ARM DUI 0203I}, the "RealView Compilation Tools Developer Guide".
1162 The CodeSourcery EABI toolchain also includes a semihosting library.},
1163 your target code can use I/O facilities on the debug host. That library
1164 provides a small set of system calls which are handled by OpenOCD.
1165 It can let the debugger provide your system console and a file system,
1166 helping with early debugging or providing a more capable environment
1167 for sometimes-complex tasks like installing system firmware onto
1168 NAND or SPI flash.
1170 @item @b{ARM Wait-For-Interrupt}...
1171 Many ARM chips synchronize the JTAG clock using the core clock.
1172 Low power states which stop that core clock thus prevent JTAG access.
1173 Idle loops in tasking environments often enter those low power states
1174 via the @code{WFI} instruction (or its coprocessor equivalent, before ARMv7).
1176 You may want to @emph{disable that instruction} in source code,
1177 or otherwise prevent using that state,
1178 to ensure you can get JTAG access at any time.@footnote{As a more
1179 polite alternative, some processors have special debug-oriented
1180 registers which can be used to change various features including
1181 how the low power states are clocked while debugging.
1182 The STM32 DBGMCU_CR register is an example; at the cost of extra
1183 power consumption, JTAG can be used during low power states.}
1184 For example, the OpenOCD @command{halt} command may not
1185 work for an idle processor otherwise.
1187 @item @b{Delay after reset}...
1188 Not all chips have good support for debugger access
1189 right after reset; many LPC2xxx chips have issues here.
1190 Similarly, applications that reconfigure pins used for
1191 JTAG access as they start will also block debugger access.
1193 To work with boards like this, @emph{enable a short delay loop}
1194 the first thing after reset, before "real" startup activities.
1195 For example, one second's delay is usually more than enough
1196 time for a JTAG debugger to attach, so that
1197 early code execution can be debugged
1198 or firmware can be replaced.
1200 @item @b{Debug Communications Channel (DCC)}...
1201 Some processors include mechanisms to send messages over JTAG.
1202 Many ARM cores support these, as do some cores from other vendors.
1203 (OpenOCD may be able to use this DCC internally, speeding up some
1204 operations like writing to memory.)
1206 Your application may want to deliver various debugging messages
1207 over JTAG, by @emph{linking with a small library of code}
1208 provided with OpenOCD and using the utilities there to send
1209 various kinds of message.
1210 @xref{softwaredebugmessagesandtracing,,Software Debug Messages and Tracing}.
1212 @end itemize
1214 @section Target Hardware Setup
1216 Chip vendors often provide software development boards which
1217 are highly configurable, so that they can support all options
1218 that product boards may require. @emph{Make sure that any
1219 jumpers or switches match the system configuration you are
1220 working with.}
1222 Common issues include:
1224 @itemize @bullet
1226 @item @b{JTAG setup} ...
1227 Boards may support more than one JTAG configuration.
1228 Examples include jumpers controlling pullups versus pulldowns
1229 on the nTRST and/or nSRST signals, and choice of connectors
1230 (e.g. which of two headers on the base board,
1231 or one from a daughtercard).
1232 For some Texas Instruments boards, you may need to jumper the
1233 EMU0 and EMU1 signals (which OpenOCD won't currently control).
1235 @item @b{Boot Modes} ...
1236 Complex chips often support multiple boot modes, controlled
1237 by external jumpers. Make sure this is set up correctly.
1238 For example many i.MX boards from NXP need to be jumpered
1239 to "ATX mode" to start booting using the on-chip ROM, when
1240 using second stage bootloader code stored in a NAND flash chip.
1242 Such explicit configuration is common, and not limited to
1243 booting from NAND. You might also need to set jumpers to
1244 start booting using code loaded from an MMC/SD card; external
1245 SPI flash; Ethernet, UART, or USB links; NOR flash; OneNAND
1246 flash; some external host; or various other sources.
1249 @item @b{Memory Addressing} ...
1250 Boards which support multiple boot modes may also have jumpers
1251 to configure memory addressing. One board, for example, jumpers
1252 external chipselect 0 (used for booting) to address either
1253 a large SRAM (which must be pre-loaded via JTAG), NOR flash,
1254 or NAND flash. When it's jumpered to address NAND flash, that
1255 board must also be told to start booting from on-chip ROM.
1257 Your @file{board.cfg} file may also need to be told this jumper
1258 configuration, so that it can know whether to declare NOR flash
1259 using @command{flash bank} or instead declare NAND flash with
1260 @command{nand device}; and likewise which probe to perform in
1261 its @code{reset-init} handler.
1263 A closely related issue is bus width. Jumpers might need to
1264 distinguish between 8 bit or 16 bit bus access for the flash
1265 used to start booting.
1267 @item @b{Peripheral Access} ...
1268 Development boards generally provide access to every peripheral
1269 on the chip, sometimes in multiple modes (such as by providing
1270 multiple audio codec chips).
1271 This interacts with software
1272 configuration of pin multiplexing, where for example a
1273 given pin may be routed either to the MMC/SD controller
1274 or the GPIO controller. It also often interacts with
1275 configuration jumpers. One jumper may be used to route
1276 signals to an MMC/SD card slot or an expansion bus (which
1277 might in turn affect booting); others might control which
1278 audio or video codecs are used.
1280 @end itemize
1282 Plus you should of course have @code{reset-init} event handlers
1283 which set up the hardware to match that jumper configuration.
1284 That includes in particular any oscillator or PLL used to clock
1285 the CPU, and any memory controllers needed to access external
1286 memory and peripherals. Without such handlers, you won't be
1287 able to access those resources without working target firmware
1288 which can do that setup ... this can be awkward when you're
1289 trying to debug that target firmware. Even if there's a ROM
1290 bootloader which handles a few issues, it rarely provides full
1291 access to all board-specific capabilities.
1294 @node Config File Guidelines
1295 @chapter Config File Guidelines
1297 This chapter is aimed at any user who needs to write a config file,
1298 including developers and integrators of OpenOCD and any user who
1299 needs to get a new board working smoothly.
1300 It provides guidelines for creating those files.
1302 You should find the following directories under
1303 @t{$(INSTALLDIR)/scripts}, with config files maintained upstream. Use
1304 them as-is where you can; or as models for new files.
1305 @itemize @bullet
1306 @item @file{interface} ...
1307 These are for debug adapters. Files that specify configuration to use
1308 specific JTAG, SWD and other adapters go here.
1309 @item @file{board} ...
1310 Think Circuit Board, PWA, PCB, they go by many names. Board files
1311 contain initialization items that are specific to a board.
1313 They reuse target configuration files, since the same
1314 microprocessor chips are used on many boards,
1315 but support for external parts varies widely. For
1316 example, the SDRAM initialization sequence for the board, or the type
1317 of external flash and what address it uses. Any initialization
1318 sequence to enable that external flash or SDRAM should be found in the
1319 board file. Boards may also contain multiple targets: two CPUs; or
1320 a CPU and an FPGA.
1321 @item @file{target} ...
1322 Think chip. The ``target'' directory represents the JTAG TAPs
1323 on a chip
1324 which OpenOCD should control, not a board. Two common types of targets
1325 are ARM chips and FPGA or CPLD chips.
1326 When a chip has multiple TAPs (maybe it has both ARM and DSP cores),
1327 the target config file defines all of them.
1328 @item @emph{more} ... browse for other library files which may be useful.
1329 For example, there are various generic and CPU-specific utilities.
1330 @end itemize
1332 The @file{openocd.cfg} user config
1333 file may override features in any of the above files by
1334 setting variables before sourcing the target file, or by adding
1335 commands specific to their situation.
1337 @section Interface Config Files
1339 The user config file
1340 should be able to source one of these files with a command like this:
1342 @example
1343 source [find interface/FOOBAR.cfg]
1344 @end example
1346 A preconfigured interface file should exist for every debug adapter
1347 in use today with OpenOCD.
1348 That said, perhaps some of these config files
1349 have only been used by the developer who created it.
1351 A separate chapter gives information about how to set these up.
1352 @xref{Debug Adapter Configuration}.
1353 Read the OpenOCD source code (and Developer's Guide)
1354 if you have a new kind of hardware interface
1355 and need to provide a driver for it.
1357 @section Board Config Files
1358 @cindex config file, board
1359 @cindex board config file
1361 The user config file
1362 should be able to source one of these files with a command like this:
1364 @example
1365 source [find board/FOOBAR.cfg]
1366 @end example
1368 The point of a board config file is to package everything
1369 about a given board that user config files need to know.
1370 In summary the board files should contain (if present)
1372 @enumerate
1373 @item One or more @command{source [find target/...cfg]} statements
1374 @item NOR flash configuration (@pxref{norconfiguration,,NOR Configuration})
1375 @item NAND flash configuration (@pxref{nandconfiguration,,NAND Configuration})
1376 @item Target @code{reset} handlers for SDRAM and I/O configuration
1377 @item JTAG adapter reset configuration (@pxref{Reset Configuration})
1378 @item All things that are not ``inside a chip''
1379 @end enumerate
1381 Generic things inside target chips belong in target config files,
1382 not board config files. So for example a @code{reset-init} event
1383 handler should know board-specific oscillator and PLL parameters,
1384 which it passes to target-specific utility code.
1386 The most complex task of a board config file is creating such a
1387 @code{reset-init} event handler.
1388 Define those handlers last, after you verify the rest of the board
1389 configuration works.
1391 @subsection Communication Between Config files
1393 In addition to target-specific utility code, another way that
1394 board and target config files communicate is by following a
1395 convention on how to use certain variables.
1397 The full Tcl/Tk language supports ``namespaces'', but Jim-Tcl does not.
1398 Thus the rule we follow in OpenOCD is this: Variables that begin with
1399 a leading underscore are temporary in nature, and can be modified and
1400 used at will within a target configuration file.
1402 Complex board config files can do the things like this,
1403 for a board with three chips:
1405 @example
1406 # Chip #1: PXA270 for network side, big endian
1407 set CHIPNAME network
1408 set ENDIAN big
1409 source [find target/pxa270.cfg]
1410 # on return: _TARGETNAME = network.cpu
1411 # other commands can refer to the "network.cpu" target.
1412 $_TARGETNAME configure .... events for this CPU..
1414 # Chip #2: PXA270 for video side, little endian
1415 set CHIPNAME video
1416 set ENDIAN little
1417 source [find target/pxa270.cfg]
1418 # on return: _TARGETNAME = video.cpu
1419 # other commands can refer to the "video.cpu" target.
1420 $_TARGETNAME configure .... events for this CPU..
1422 # Chip #3: Xilinx FPGA for glue logic
1423 set CHIPNAME xilinx
1424 unset ENDIAN
1425 source [find target/spartan3.cfg]
1426 @end example
1428 That example is oversimplified because it doesn't show any flash memory,
1429 or the @code{reset-init} event handlers to initialize external DRAM
1430 or (assuming it needs it) load a configuration into the FPGA.
1431 Such features are usually needed for low-level work with many boards,
1432 where ``low level'' implies that the board initialization software may
1433 not be working. (That's a common reason to need JTAG tools. Another
1434 is to enable working with microcontroller-based systems, which often
1435 have no debugging support except a JTAG connector.)
1437 Target config files may also export utility functions to board and user
1438 config files. Such functions should use name prefixes, to help avoid
1439 naming collisions.
1441 Board files could also accept input variables from user config files.
1442 For example, there might be a @code{J4_JUMPER} setting used to identify
1443 what kind of flash memory a development board is using, or how to set
1444 up other clocks and peripherals.
1446 @subsection Variable Naming Convention
1447 @cindex variable names
1449 Most boards have only one instance of a chip.
1450 However, it should be easy to create a board with more than
1451 one such chip (as shown above).
1452 Accordingly, we encourage these conventions for naming
1453 variables associated with different @file{target.cfg} files,
1454 to promote consistency and
1455 so that board files can override target defaults.
1457 Inputs to target config files include:
1459 @itemize @bullet
1460 @item @code{CHIPNAME} ...
1461 This gives a name to the overall chip, and is used as part of
1462 tap identifier dotted names.
1463 While the default is normally provided by the chip manufacturer,
1464 board files may need to distinguish between instances of a chip.
1465 @item @code{ENDIAN} ...
1466 By default @option{little} - although chips may hard-wire @option{big}.
1467 Chips that can't change endianness don't need to use this variable.
1468 @item @code{CPUTAPID} ...
1469 When OpenOCD examines the JTAG chain, it can be told verify the
1470 chips against the JTAG IDCODE register.
1471 The target file will hold one or more defaults, but sometimes the
1472 chip in a board will use a different ID (perhaps a newer revision).
1473 @end itemize
1475 Outputs from target config files include:
1477 @itemize @bullet
1478 @item @code{_TARGETNAME} ...
1479 By convention, this variable is created by the target configuration
1480 script. The board configuration file may make use of this variable to
1481 configure things like a ``reset init'' script, or other things
1482 specific to that board and that target.
1483 If the chip has 2 targets, the names are @code{_TARGETNAME0},
1484 @code{_TARGETNAME1}, ... etc.
1485 @end itemize
1487 @subsection The reset-init Event Handler
1488 @cindex event, reset-init
1489 @cindex reset-init handler
1491 Board config files run in the OpenOCD configuration stage;
1492 they can't use TAPs or targets, since they haven't been
1493 fully set up yet.
1494 This means you can't write memory or access chip registers;
1495 you can't even verify that a flash chip is present.
1496 That's done later in event handlers, of which the target @code{reset-init}
1497 handler is one of the most important.
1499 Except on microcontrollers, the basic job of @code{reset-init} event
1500 handlers is setting up flash and DRAM, as normally handled by boot loaders.
1501 Microcontrollers rarely use boot loaders; they run right out of their
1502 on-chip flash and SRAM memory. But they may want to use one of these
1503 handlers too, if just for developer convenience.
1505 @quotation Note
1506 Because this is so very board-specific, and chip-specific, no examples
1507 are included here.
1508 Instead, look at the board config files distributed with OpenOCD.
1509 If you have a boot loader, its source code will help; so will
1510 configuration files for other JTAG tools
1511 (@pxref{translatingconfigurationfiles,,Translating Configuration Files}).
1512 @end quotation
1514 Some of this code could probably be shared between different boards.
1515 For example, setting up a DRAM controller often doesn't differ by
1516 much except the bus width (16 bits or 32?) and memory timings, so a
1517 reusable TCL procedure loaded by the @file{target.cfg} file might take
1518 those as parameters.
1519 Similarly with oscillator, PLL, and clock setup;
1520 and disabling the watchdog.
1521 Structure the code cleanly, and provide comments to help
1522 the next developer doing such work.
1523 (@emph{You might be that next person} trying to reuse init code!)
1525 The last thing normally done in a @code{reset-init} handler is probing
1526 whatever flash memory was configured. For most chips that needs to be
1527 done while the associated target is halted, either because JTAG memory
1528 access uses the CPU or to prevent conflicting CPU access.
1530 @subsection JTAG Clock Rate
1532 Before your @code{reset-init} handler has set up
1533 the PLLs and clocking, you may need to run with
1534 a low JTAG clock rate.
1535 @xref{jtagspeed,,JTAG Speed}.
1536 Then you'd increase that rate after your handler has
1537 made it possible to use the faster JTAG clock.
1538 When the initial low speed is board-specific, for example
1539 because it depends on a board-specific oscillator speed, then
1540 you should probably set it up in the board config file;
1541 if it's target-specific, it belongs in the target config file.
1543 For most ARM-based processors the fastest JTAG clock@footnote{A FAQ
1544 @uref{http://www.arm.com/support/faqdev/4170.html} gives details.}
1545 is one sixth of the CPU clock; or one eighth for ARM11 cores.
1546 Consult chip documentation to determine the peak JTAG clock rate,
1547 which might be less than that.
1549 @quotation Warning
1550 On most ARMs, JTAG clock detection is coupled to the core clock, so
1551 software using a @option{wait for interrupt} operation blocks JTAG access.
1552 Adaptive clocking provides a partial workaround, but a more complete
1553 solution just avoids using that instruction with JTAG debuggers.
1554 @end quotation
1556 If both the chip and the board support adaptive clocking,
1557 use the @command{jtag_rclk}
1558 command, in case your board is used with JTAG adapter which
1559 also supports it. Otherwise use @command{adapter_khz}.
1560 Set the slow rate at the beginning of the reset sequence,
1561 and the faster rate as soon as the clocks are at full speed.
1563 @anchor{theinitboardprocedure}
1564 @subsection The init_board procedure
1565 @cindex init_board procedure
1567 The concept of @code{init_board} procedure is very similar to @code{init_targets}
1568 (@xref{theinittargetsprocedure,,The init_targets procedure}.) - it's a replacement of ``linear''
1569 configuration scripts. This procedure is meant to be executed when OpenOCD enters run stage
1570 (@xref{enteringtherunstage,,Entering the Run Stage},) after @code{init_targets}. The idea to have
1571 separate @code{init_targets} and @code{init_board} procedures is to allow the first one to configure
1572 everything target specific (internal flash, internal RAM, etc.) and the second one to configure
1573 everything board specific (reset signals, chip frequency, reset-init event handler, external memory, etc.).
1574 Additionally ``linear'' board config file will most likely fail when target config file uses
1575 @code{init_targets} scheme (``linear'' script is executed before @code{init} and @code{init_targets} - after),
1576 so separating these two configuration stages is very convenient, as the easiest way to overcome this
1577 problem is to convert board config file to use @code{init_board} procedure. Board config scripts don't
1578 need to override @code{init_targets} defined in target config files when they only need to add some specifics.
1580 Just as @code{init_targets}, the @code{init_board} procedure can be overridden by ``next level'' script (which sources
1581 the original), allowing greater code reuse.
1583 @example
1584 ### board_file.cfg ###
1586 # source target file that does most of the config in init_targets
1587 source [find target/target.cfg]
1589 proc enable_fast_clock @{@} @{
1590     # enables fast on-board clock source
1591     # configures the chip to use it
1594 # initialize only board specifics - reset, clock, adapter frequency
1595 proc init_board @{@} @{
1596     reset_config trst_and_srst trst_pulls_srst
1598     $_TARGETNAME configure -event reset-start @{
1599         adapter_khz 100
1600     @}
1602     $_TARGETNAME configure -event reset-init @{
1603         enable_fast_clock
1604         adapter_khz 10000
1605     @}
1607 @end example
1609 @section Target Config Files
1610 @cindex config file, target
1611 @cindex target config file
1613 Board config files communicate with target config files using
1614 naming conventions as described above, and may source one or
1615 more target config files like this:
1617 @example
1618 source [find target/FOOBAR.cfg]
1619 @end example
1621 The point of a target config file is to package everything
1622 about a given chip that board config files need to know.
1623 In summary the target files should contain
1625 @enumerate
1626 @item Set defaults
1627 @item Add TAPs to the scan chain
1628 @item Add CPU targets (includes GDB support)
1629 @item CPU/Chip/CPU-Core specific features
1630 @item On-Chip flash
1631 @end enumerate
1633 As a rule of thumb, a target file sets up only one chip.
1634 For a microcontroller, that will often include a single TAP,
1635 which is a CPU needing a GDB target, and its on-chip flash.
1637 More complex chips may include multiple TAPs, and the target
1638 config file may need to define them all before OpenOCD
1639 can talk to the chip.
1640 For example, some phone chips have JTAG scan chains that include
1641 an ARM core for operating system use, a DSP,
1642 another ARM core embedded in an image processing engine,
1643 and other processing engines.
1645 @subsection Default Value Boiler Plate Code
1647 All target configuration files should start with code like this,
1648 letting board config files express environment-specific
1649 differences in how things should be set up.
1651 @example
1652 # Boards may override chip names, perhaps based on role,
1653 # but the default should match what the vendor uses
1654 if @{ [info exists CHIPNAME] @} @{
1655    set  _CHIPNAME $CHIPNAME
1656 @} else @{
1657    set  _CHIPNAME sam7x256
1660 # ONLY use ENDIAN with targets that can change it.
1661 if @{ [info exists ENDIAN] @} @{
1662    set  _ENDIAN $ENDIAN
1663 @} else @{
1664    set  _ENDIAN little
1667 # TAP identifiers may change as chips mature, for example with
1668 # new revision fields (the "3" here). Pick a good default; you
1669 # can pass several such identifiers to the "jtag newtap" command.
1670 if @{ [info exists CPUTAPID ] @} @{
1671    set _CPUTAPID $CPUTAPID
1672 @} else @{
1673    set _CPUTAPID 0x3f0f0f0f
1675 @end example
1676 @c but 0x3f0f0f0f is for an str73x part ...
1678 @emph{Remember:} Board config files may include multiple target
1679 config files, or the same target file multiple times
1680 (changing at least @code{CHIPNAME}).
1682 Likewise, the target configuration file should define
1683 @code{_TARGETNAME} (or @code{_TARGETNAME0} etc) and
1684 use it later on when defining debug targets:
1686 @example
1687 set _TARGETNAME $_CHIPNAME.cpu
1688 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1689 @end example
1691 @subsection Adding TAPs to the Scan Chain
1692 After the ``defaults'' are set up,
1693 add the TAPs on each chip to the JTAG scan chain.
1694 @xref{TAP Declaration}, and the naming convention
1695 for taps.
1697 In the simplest case the chip has only one TAP,
1698 probably for a CPU or FPGA.
1699 The config file for the Atmel AT91SAM7X256
1700 looks (in part) like this:
1702 @example
1703 jtag newtap $_CHIPNAME cpu -irlen 4 -expected-id $_CPUTAPID
1704 @end example
1706 A board with two such at91sam7 chips would be able
1707 to source such a config file twice, with different
1708 values for @code{CHIPNAME}, so
1709 it adds a different TAP each time.
1711 If there are nonzero @option{-expected-id} values,
1712 OpenOCD attempts to verify the actual tap id against those values.
1713 It will issue error messages if there is mismatch, which
1714 can help to pinpoint problems in OpenOCD configurations.
1716 @example
1717 JTAG tap: sam7x256.cpu tap/device found: 0x3f0f0f0f
1718                 (Manufacturer: 0x787, Part: 0xf0f0, Version: 0x3)
1719 ERROR: Tap: sam7x256.cpu - Expected id: 0x12345678, Got: 0x3f0f0f0f
1720 ERROR: expected: mfg: 0x33c, part: 0x2345, ver: 0x1
1721 ERROR:      got: mfg: 0x787, part: 0xf0f0, ver: 0x3
1722 @end example
1724 There are more complex examples too, with chips that have
1725 multiple TAPs. Ones worth looking at include:
1727 @itemize
1728 @item @file{target/omap3530.cfg} -- with disabled ARM and DSP,
1729 plus a JRC to enable them
1730 @item @file{target/str912.cfg} -- with flash, CPU, and boundary scan
1731 @item @file{target/ti_dm355.cfg} -- with ETM, ARM, and JRC (this JRC
1732 is not currently used)
1733 @end itemize
1735 @subsection Add CPU targets
1737 After adding a TAP for a CPU, you should set it up so that
1738 GDB and other commands can use it.
1739 @xref{CPU Configuration}.
1740 For the at91sam7 example above, the command can look like this;
1741 note that @code{$_ENDIAN} is not needed, since OpenOCD defaults
1742 to little endian, and this chip doesn't support changing that.
1744 @example
1745 set _TARGETNAME $_CHIPNAME.cpu
1746 target create $_TARGETNAME arm7tdmi -chain-position $_TARGETNAME
1747 @end example
1749 Work areas are small RAM areas associated with CPU targets.
1750 They are used by OpenOCD to speed up downloads,
1751 and to download small snippets of code to program flash chips.
1752 If the chip includes a form of ``on-chip-ram'' - and many do - define
1753 a work area if you can.
1754 Again using the at91sam7 as an example, this can look like:
1756 @example
1757 $_TARGETNAME configure -work-area-phys 0x00200000 \
1758              -work-area-size 0x4000 -work-area-backup 0
1759 @end example
1761 @anchor{definecputargetsworkinginsmp}
1762 @subsection Define CPU targets working in SMP
1763 @cindex SMP
1764 After setting targets, you can define a list of targets working in SMP.
1766 @example
1767 set _TARGETNAME_1 $_CHIPNAME.cpu1
1768 set _TARGETNAME_2 $_CHIPNAME.cpu2
1769 target create $_TARGETNAME_1 cortex_a -chain-position $_CHIPNAME.dap \
1770 -coreid 0 -dbgbase $_DAP_DBG1
1771 target create $_TARGETNAME_2 cortex_a -chain-position $_CHIPNAME.dap \
1772 -coreid 1 -dbgbase $_DAP_DBG2
1773 #define 2 targets working in smp.
1774 target smp $_CHIPNAME.cpu2 $_CHIPNAME.cpu1
1775 @end example
1776 In the above example on cortex_a, 2 cpus are working in SMP.
1777 In SMP only one GDB instance is created and :
1778 @itemize @bullet
1779 @item a set of hardware breakpoint sets the same breakpoint on all targets in the list.
1780 @item halt command triggers the halt of all targets in the list.
1781 @item resume command triggers the write context and the restart of all targets in the list.
1782 @item following a breakpoint: the target stopped by the breakpoint is displayed to the GDB session.
1783 @item dedicated GDB serial protocol packets are implemented for switching/retrieving the target
1784 displayed by the GDB session @pxref{usingopenocdsmpwithgdb,,Using OpenOCD SMP with GDB}.
1785 @end itemize
1787 The SMP behaviour can be disabled/enabled dynamically. On cortex_a following
1788 command have been implemented.
1789 @itemize @bullet
1790 @item cortex_a smp_on : enable SMP mode, behaviour is as described above.
1791 @item cortex_a smp_off : disable SMP mode, the current target is the one
1792 displayed in the GDB session, only this target is now controlled by GDB
1793 session. This behaviour is useful during system boot up.
1794 @item cortex_a smp_gdb : display/fix the core id displayed in GDB session see
1795 following example.
1796 @end itemize
1798 @example
1799 >cortex_a smp_gdb
1800 gdb coreid  0 -> -1
1801 #0 : coreid 0 is displayed to GDB ,
1802 #-> -1 : next resume triggers a real resume
1803 > cortex_a smp_gdb 1
1804 gdb coreid  0 -> 1
1805 #0 :coreid 0 is displayed to GDB ,
1806 #->1  : next resume displays coreid 1 to GDB
1807 > resume
1808 > cortex_a smp_gdb
1809 gdb coreid  1 -> 1
1810 #1 :coreid 1 is displayed to GDB ,
1811 #->1 : next resume displays coreid 1 to GDB
1812 > cortex_a smp_gdb -1
1813 gdb coreid  1 -> -1
1814 #1 :coreid 1 is displayed to GDB,
1815 #->-1 : next resume triggers a real resume
1816 @end example
1819 @subsection Chip Reset Setup
1821 As a rule, you should put the @command{reset_config} command
1822 into the board file. Most things you think you know about a
1823 chip can be tweaked by the board.
1825 Some chips have specific ways the TRST and SRST signals are
1826 managed. In the unusual case that these are @emph{chip specific}
1827 and can never be changed by board wiring, they could go here.
1828 For example, some chips can't support JTAG debugging without
1829 both signals.
1831 Provide a @code{reset-assert} event handler if you can.
1832 Such a handler uses JTAG operations to reset the target,
1833 letting this target config be used in systems which don't
1834 provide the optional SRST signal, or on systems where you
1835 don't want to reset all targets at once.
1836 Such a handler might write to chip registers to force a reset,
1837 use a JRC to do that (preferable -- the target may be wedged!),
1838 or force a watchdog timer to trigger.
1839 (For Cortex-M targets, this is not necessary.  The target
1840 driver knows how to use trigger an NVIC reset when SRST is
1841 not available.)
1843 Some chips need special attention during reset handling if
1844 they're going to be used with JTAG.
1845 An example might be needing to send some commands right
1846 after the target's TAP has been reset, providing a
1847 @code{reset-deassert-post} event handler that writes a chip
1848 register to report that JTAG debugging is being done.
1849 Another would be reconfiguring the watchdog so that it stops
1850 counting while the core is halted in the debugger.
1852 JTAG clocking constraints often change during reset, and in
1853 some cases target config files (rather than board config files)
1854 are the right places to handle some of those issues.
1855 For example, immediately after reset most chips run using a
1856 slower clock than they will use later.
1857 That means that after reset (and potentially, as OpenOCD
1858 first starts up) they must use a slower JTAG clock rate
1859 than they will use later.
1860 @xref{jtagspeed,,JTAG Speed}.
1862 @quotation Important
1863 When you are debugging code that runs right after chip
1864 reset, getting these issues right is critical.
1865 In particular, if you see intermittent failures when
1866 OpenOCD verifies the scan chain after reset,
1867 look at how you are setting up JTAG clocking.
1868 @end quotation
1870 @anchor{theinittargetsprocedure}
1871 @subsection The init_targets procedure
1872 @cindex init_targets procedure
1874 Target config files can either be ``linear'' (script executed line-by-line when parsed in
1875 configuration stage, @xref{configurationstage,,Configuration Stage},) or they can contain a special
1876 procedure called @code{init_targets}, which will be executed when entering run stage
1877 (after parsing all config files or after @code{init} command, @xref{enteringtherunstage,,Entering the Run Stage}.)
1878 Such procedure can be overriden by ``next level'' script (which sources the original).
1879 This concept faciliates code reuse when basic target config files provide generic configuration
1880 procedures and @code{init_targets} procedure, which can then be sourced and enchanced or changed in
1881 a ``more specific'' target config file. This is not possible with ``linear'' config scripts,
1882 because sourcing them executes every initialization commands they provide.
1884 @example
1885 ### generic_file.cfg ###
1887 proc setup_my_chip @{chip_name flash_size ram_size@} @{
1888     # basic initialization procedure ...
1891 proc init_targets @{@} @{
1892     # initializes generic chip with 4kB of flash and 1kB of RAM
1893     setup_my_chip MY_GENERIC_CHIP 4096 1024
1896 ### specific_file.cfg ###
1898 source [find target/generic_file.cfg]
1900 proc init_targets @{@} @{
1901     # initializes specific chip with 128kB of flash and 64kB of RAM
1902     setup_my_chip MY_CHIP_WITH_128K_FLASH_64KB_RAM 131072 65536
1904 @end example
1906 The easiest way to convert ``linear'' config files to @code{init_targets} version is to
1907 enclose every line of ``code'' (i.e. not @code{source} commands, procedures, etc.) in this procedure.
1909 For an example of this scheme see LPC2000 target config files.
1911 The @code{init_boards} procedure is a similar concept concerning board config files
1912 (@xref{theinitboardprocedure,,The init_board procedure}.)
1914 @anchor{theinittargeteventsprocedure}
1915 @subsection The init_target_events procedure
1916 @cindex init_target_events procedure
1918 A special procedure called @code{init_target_events} is run just after
1919 @code{init_targets} (@xref{theinittargetsprocedure,,The init_targets
1920 procedure}.) and before @code{init_board}
1921 (@xref{theinitboardprocedure,,The init_board procedure}.) It is used
1922 to set up default target events for the targets that do not have those
1923 events already assigned.
1925 @subsection ARM Core Specific Hacks
1927 If the chip has a DCC, enable it. If the chip is an ARM9 with some
1928 special high speed download features - enable it.
1930 If present, the MMU, the MPU and the CACHE should be disabled.
1932 Some ARM cores are equipped with trace support, which permits
1933 examination of the instruction and data bus activity. Trace
1934 activity is controlled through an ``Embedded Trace Module'' (ETM)
1935 on one of the core's scan chains. The ETM emits voluminous data
1936 through a ``trace port''. (@xref{armhardwaretracing,,ARM Hardware Tracing}.)
1937 If you are using an external trace port,
1938 configure it in your board config file.
1939 If you are using an on-chip ``Embedded Trace Buffer'' (ETB),
1940 configure it in your target config file.
1942 @example
1943 etm config $_TARGETNAME 16 normal full etb
1944 etb config $_TARGETNAME $_CHIPNAME.etb
1945 @end example
1947 @subsection Internal Flash Configuration
1949 This applies @b{ONLY TO MICROCONTROLLERS} that have flash built in.
1951 @b{Never ever} in the ``target configuration file'' define any type of
1952 flash that is external to the chip. (For example a BOOT flash on
1953 Chip Select 0.) Such flash information goes in a board file - not
1954 the TARGET (chip) file.
1956 Examples:
1957 @itemize @bullet
1958 @item at91sam7x256 - has 256K flash YES enable it.
1959 @item str912 - has flash internal YES enable it.
1960 @item imx27 - uses boot flash on CS0 - it goes in the board file.
1961 @item pxa270 - again - CS0 flash - it goes in the board file.
1962 @end itemize
1964 @anchor{translatingconfigurationfiles}
1965 @section Translating Configuration Files
1966 @cindex translation
1967 If you have a configuration file for another hardware debugger
1968 or toolset (Abatron, BDI2000, BDI3000, CCS,
1969 Lauterbach, SEGGER, Macraigor, etc.), translating
1970 it into OpenOCD syntax is often quite straightforward. The most tricky
1971 part of creating a configuration script is oftentimes the reset init
1972 sequence where e.g. PLLs, DRAM and the like is set up.
1974 One trick that you can use when translating is to write small
1975 Tcl procedures to translate the syntax into OpenOCD syntax. This
1976 can avoid manual translation errors and make it easier to
1977 convert other scripts later on.
1979 Example of transforming quirky arguments to a simple search and
1980 replace job:
1982 @example
1983 #   Lauterbach syntax(?)
1985 #       Data.Set c15:0x042f %long 0x40000015
1987 #   OpenOCD syntax when using procedure below.
1989 #       setc15 0x01 0x00050078
1991 proc setc15 @{regs value@} @{
1992     global TARGETNAME
1994     echo [format "set p15 0x%04x, 0x%08x" $regs $value]
1996     arm mcr 15 [expr ($regs>>12)&0x7] \
1997         [expr ($regs>>0)&0xf] [expr ($regs>>4)&0xf] \
1998         [expr ($regs>>8)&0x7] $value
2000 @end example
2004 @node Server Configuration
2005 @chapter Server Configuration
2006 @cindex initialization
2007 The commands here are commonly found in the openocd.cfg file and are
2008 used to specify what TCP/IP ports are used, and how GDB should be
2009 supported.
2011 @anchor{configurationstage}
2012 @section Configuration Stage
2013 @cindex configuration stage
2014 @cindex config command
2016 When the OpenOCD server process starts up, it enters a
2017 @emph{configuration stage} which is the only time that
2018 certain commands, @emph{configuration commands}, may be issued.
2019 Normally, configuration commands are only available
2020 inside startup scripts.
2022 In this manual, the definition of a configuration command is
2023 presented as a @emph{Config Command}, not as a @emph{Command}
2024 which may be issued interactively.
2025 The runtime @command{help} command also highlights configuration
2026 commands, and those which may be issued at any time.
2028 Those configuration commands include declaration of TAPs,
2029 flash banks,
2030 the interface used for JTAG communication,
2031 and other basic setup.
2032 The server must leave the configuration stage before it
2033 may access or activate TAPs.
2034 After it leaves this stage, configuration commands may no
2035 longer be issued.
2037 @anchor{enteringtherunstage}
2038 @section Entering the Run Stage
2040 The first thing OpenOCD does after leaving the configuration
2041 stage is to verify that it can talk to the scan chain
2042 (list of TAPs) which has been configured.
2043 It will warn if it doesn't find TAPs it expects to find,
2044 or finds TAPs that aren't supposed to be there.
2045 You should see no errors at this point.
2046 If you see errors, resolve them by correcting the
2047 commands you used to configure the server.
2048 Common errors include using an initial JTAG speed that's too
2049 fast, and not providing the right IDCODE values for the TAPs
2050 on the scan chain.
2052 Once OpenOCD has entered the run stage, a number of commands
2053 become available.
2054 A number of these relate to the debug targets you may have declared.
2055 For example, the @command{mww} command will not be available until
2056 a target has been successfuly instantiated.
2057 If you want to use those commands, you may need to force
2058 entry to the run stage.
2060 @deffn {Config Command} init
2061 This command terminates the configuration stage and
2062 enters the run stage. This helps when you need to have
2063 the startup scripts manage tasks such as resetting the target,
2064 programming flash, etc. To reset the CPU upon startup, add "init" and
2065 "reset" at the end of the config script or at the end of the OpenOCD
2066 command line using the @option{-c} command line switch.
2068 If this command does not appear in any startup/configuration file
2069 OpenOCD executes the command for you after processing all
2070 configuration files and/or command line options.
2072 @b{NOTE:} This command normally occurs at or near the end of your
2073 openocd.cfg file to force OpenOCD to ``initialize'' and make the
2074 targets ready. For example: If your openocd.cfg file needs to
2075 read/write memory on your target, @command{init} must occur before
2076 the memory read/write commands. This includes @command{nand probe}.
2077 @end deffn
2079 @deffn {Overridable Procedure} jtag_init
2080 This is invoked at server startup to verify that it can talk
2081 to the scan chain (list of TAPs) which has been configured.
2083 The default implementation first tries @command{jtag arp_init},
2084 which uses only a lightweight JTAG reset before examining the
2085 scan chain.
2086 If that fails, it tries again, using a harder reset
2087 from the overridable procedure @command{init_reset}.
2089 Implementations must have verified the JTAG scan chain before
2090 they return.
2091 This is done by calling @command{jtag arp_init}
2092 (or @command{jtag arp_init-reset}).
2093 @end deffn
2095 @anchor{tcpipports}
2096 @section TCP/IP Ports
2097 @cindex TCP port
2098 @cindex server
2099 @cindex port
2100 @cindex security
2101 The OpenOCD server accepts remote commands in several syntaxes.
2102 Each syntax uses a different TCP/IP port, which you may specify
2103 only during configuration (before those ports are opened).
2105 For reasons including security, you may wish to prevent remote
2106 access using one or more of these ports.
2107 In such cases, just specify the relevant port number as "disabled".
2108 If you disable all access through TCP/IP, you will need to
2109 use the command line @option{-pipe} option.
2111 @deffn {Command} gdb_port [number]
2112 @cindex GDB server
2113 Normally gdb listens to a TCP/IP port, but GDB can also
2114 communicate via pipes(stdin/out or named pipes). The name
2115 "gdb_port" stuck because it covers probably more than 90% of
2116 the normal use cases.
2118 No arguments reports GDB port. "pipe" means listen to stdin
2119 output to stdout, an integer is base port number, "disabled"
2120 disables the gdb server.
2122 When using "pipe", also use log_output to redirect the log
2123 output to a file so as not to flood the stdin/out pipes.
2125 The -p/--pipe option is deprecated and a warning is printed
2126 as it is equivalent to passing in -c "gdb_port pipe; log_output openocd.log".
2128 Any other string is interpreted as named pipe to listen to.
2129 Output pipe is the same name as input pipe, but with 'o' appended,
2130 e.g. /var/gdb, /var/gdbo.
2132 The GDB port for the first target will be the base port, the
2133 second target will listen on gdb_port + 1, and so on.
2134 When not specified during the configuration stage,
2135 the port @var{number} defaults to 3333.
2137 Note: when using "gdb_port pipe", increasing the default remote timeout in
2138 gdb (with 'set remotetimeout') is recommended. An insufficient timeout may
2139 cause initialization to fail with "Unknown remote qXfer reply: OK".
2141 @end deffn
2143 @deffn {Command} tcl_port [number]
2144 Specify or query the port used for a simplified RPC
2145 connection that can be used by clients to issue TCL commands and get the
2146 output from the Tcl engine.
2147 Intended as a machine interface.
2148 When not specified during the configuration stage,
2149 the port @var{number} defaults to 6666.
2150 When specified as "disabled", this service is not activated.
2151 @end deffn
2153 @deffn {Command} telnet_port [number]
2154 Specify or query the
2155 port on which to listen for incoming telnet connections.
2156 This port is intended for interaction with one human through TCL commands.
2157 When not specified during the configuration stage,
2158 the port @var{number} defaults to 4444.
2159 When specified as "disabled", this service is not activated.
2160 @end deffn
2162 @anchor{gdbconfiguration}
2163 @section GDB Configuration
2164 @cindex GDB
2165 @cindex GDB configuration
2166 You can reconfigure some GDB behaviors if needed.
2167 The ones listed here are static and global.
2168 @xref{targetconfiguration,,Target Configuration}, about configuring individual targets.
2169 @xref{targetevents,,Target Events}, about configuring target-specific event handling.
2171 @anchor{gdbbreakpointoverride}
2172 @deffn {Command} gdb_breakpoint_override [@option{hard}|@option{soft}|@option{disable}]
2173 Force breakpoint type for gdb @command{break} commands.
2174 This option supports GDB GUIs which don't
2175 distinguish hard versus soft breakpoints, if the default OpenOCD and
2176 GDB behaviour is not sufficient. GDB normally uses hardware
2177 breakpoints if the memory map has been set up for flash regions.
2178 @end deffn
2180 @anchor{gdbflashprogram}
2181 @deffn {Config Command} gdb_flash_program (@option{enable}|@option{disable})
2182 Set to @option{enable} to cause OpenOCD to program the flash memory when a
2183 vFlash packet is received.
2184 The default behaviour is @option{enable}.
2185 @end deffn
2187 @deffn {Config Command} gdb_memory_map (@option{enable}|@option{disable})
2188 Set to @option{enable} to cause OpenOCD to send the memory configuration to GDB when
2189 requested. GDB will then know when to set hardware breakpoints, and program flash
2190 using the GDB load command. @command{gdb_flash_program enable} must also be enabled
2191 for flash programming to work.
2192 Default behaviour is @option{enable}.
2193 @xref{gdbflashprogram,,gdb_flash_program}.
2194 @end deffn
2196 @deffn {Config Command} gdb_report_data_abort (@option{enable}|@option{disable})
2197 Specifies whether data aborts cause an error to be reported
2198 by GDB memory read packets.
2199 The default behaviour is @option{disable};
2200 use @option{enable} see these errors reported.
2201 @end deffn
2203 @deffn {Config Command} gdb_target_description (@option{enable}|@option{disable})
2204 Set to @option{enable} to cause OpenOCD to send the target descriptions to gdb via qXfer:features:read packet.
2205 The default behaviour is @option{enable}.
2206 @end deffn
2208 @deffn {Command} gdb_save_tdesc
2209 Saves the target descripton file to the local file system.
2211 The file name is @i{target_name}.xml.
2212 @end deffn
2214 @anchor{eventpolling}
2215 @section Event Polling
2217 Hardware debuggers are parts of asynchronous systems,
2218 where significant events can happen at any time.
2219 The OpenOCD server needs to detect some of these events,
2220 so it can report them to through TCL command line
2221 or to GDB.
2223 Examples of such events include:
2225 @itemize
2226 @item One of the targets can stop running ... maybe it triggers
2227 a code breakpoint or data watchpoint, or halts itself.
2228 @item Messages may be sent over ``debug message'' channels ... many
2229 targets support such messages sent over JTAG,
2230 for receipt by the person debugging or tools.
2231 @item Loss of power ... some adapters can detect these events.
2232 @item Resets not issued through JTAG ... such reset sources
2233 can include button presses or other system hardware, sometimes
2234 including the target itself (perhaps through a watchdog).
2235 @item Debug instrumentation sometimes supports event triggering
2236 such as ``trace buffer full'' (so it can quickly be emptied)
2237 or other signals (to correlate with code behavior).
2238 @end itemize
2240 None of those events are signaled through standard JTAG signals.
2241 However, most conventions for JTAG connectors include voltage
2242 level and system reset (SRST) signal detection.
2243 Some connectors also include instrumentation signals, which
2244 can imply events when those signals are inputs.
2246 In general, OpenOCD needs to periodically check for those events,
2247 either by looking at the status of signals on the JTAG connector
2248 or by sending synchronous ``tell me your status'' JTAG requests
2249 to the various active targets.
2250 There is a command to manage and monitor that polling,
2251 which is normally done in the background.
2253 @deffn Command poll [@option{on}|@option{off}]
2254 Poll the current target for its current state.
2255 (Also, @pxref{targetcurstate,,target curstate}.)
2256 If that target is in debug mode, architecture
2257 specific information about the current state is printed.
2258 An optional parameter
2259 allows background polling to be enabled and disabled.
2261 You could use this from the TCL command shell, or
2262 from GDB using @command{monitor poll} command.
2263 Leave background polling enabled while you're using GDB.
2264 @example
2265 > poll
2266 background polling: on
2267 target state: halted
2268 target halted in ARM state due to debug-request, \
2269                current mode: Supervisor
2270 cpsr: 0x800000d3 pc: 0x11081bfc
2271 MMU: disabled, D-Cache: disabled, I-Cache: enabled
2273 @end example
2274 @end deffn
2276 @node Debug Adapter Configuration
2277 @chapter Debug Adapter Configuration
2278 @cindex config file, interface
2279 @cindex interface config file
2281 Correctly installing OpenOCD includes making your operating system give
2282 OpenOCD access to debug adapters. Once that has been done, Tcl commands
2283 are used to select which one is used, and to configure how it is used.
2285 @quotation Note
2286 Because OpenOCD started out with a focus purely on JTAG, you may find
2287 places where it wrongly presumes JTAG is the only transport protocol
2288 in use. Be aware that recent versions of OpenOCD are removing that
2289 limitation. JTAG remains more functional than most other transports.
2290 Other transports do not support boundary scan operations, or may be
2291 specific to a given chip vendor. Some might be usable only for
2292 programming flash memory, instead of also for debugging.
2293 @end quotation
2295 Debug Adapters/Interfaces/Dongles are normally configured
2296 through commands in an interface configuration
2297 file which is sourced by your @file{openocd.cfg} file, or
2298 through a command line @option{-f interface/....cfg} option.
2300 @example
2301 source [find interface/olimex-jtag-tiny.cfg]
2302 @end example
2304 These commands tell
2305 OpenOCD what type of JTAG adapter you have, and how to talk to it.
2306 A few cases are so simple that you only need to say what driver to use:
2308 @example
2309 # jlink interface
2310 interface jlink
2311 @end example
2313 Most adapters need a bit more configuration than that.
2316 @section Interface Configuration
2318 The interface command tells OpenOCD what type of debug adapter you are
2319 using. Depending on the type of adapter, you may need to use one or
2320 more additional commands to further identify or configure the adapter.
2322 @deffn {Config Command} {interface} name
2323 Use the interface driver @var{name} to connect to the
2324 target.
2325 @end deffn
2327 @deffn Command {interface_list}
2328 List the debug adapter drivers that have been built into
2329 the running copy of OpenOCD.
2330 @end deffn
2331 @deffn Command {interface transports} transport_name+
2332 Specifies the transports supported by this debug adapter.
2333 The adapter driver builds-in similar knowledge; use this only
2334 when external configuration (such as jumpering) changes what
2335 the hardware can support.
2336 @end deffn
2340 @deffn Command {adapter_name}
2341 Returns the name of the debug adapter driver being used.
2342 @end deffn
2344 @section Interface Drivers
2346 Each of the interface drivers listed here must be explicitly
2347 enabled when OpenOCD is configured, in order to be made
2348 available at run time.
2350 @deffn {Interface Driver} {amt_jtagaccel}
2351 Amontec Chameleon in its JTAG Accelerator configuration,
2352 connected to a PC's EPP mode parallel port.
2353 This defines some driver-specific commands:
2355 @deffn {Config Command} {parport_port} number
2356 Specifies either the address of the I/O port (default: 0x378 for LPT1) or
2357 the number of the @file{/dev/parport} device.
2358 @end deffn
2360 @deffn {Config Command} rtck [@option{enable}|@option{disable}]
2361 Displays status of RTCK option.
2362 Optionally sets that option first.
2363 @end deffn
2364 @end deffn
2366 @deffn {Interface Driver} {arm-jtag-ew}
2367 Olimex ARM-JTAG-EW USB adapter
2368 This has one driver-specific command:
2370 @deffn Command {armjtagew_info}
2371 Logs some status
2372 @end deffn
2373 @end deffn
2375 @deffn {Interface Driver} {at91rm9200}
2376 Supports bitbanged JTAG from the local system,
2377 presuming that system is an Atmel AT91rm9200
2378 and a specific set of GPIOs is used.
2379 @c command:     at91rm9200_device NAME
2380 @c chooses among list of bit configs ... only one option
2381 @end deffn
2383 @deffn {Interface Driver} {cmsis-dap}
2384 ARM CMSIS-DAP compliant based adapter.
2386 @deffn {Config Command} {cmsis_dap_vid_pid} [vid pid]+
2387 The vendor ID and product ID of the CMSIS-DAP device. If not specified
2388 the driver will attempt to auto detect the CMSIS-DAP device.
2389 Currently, up to eight [@var{vid}, @var{pid}] pairs may be given, e.g.
2390 @example
2391 cmsis_dap_vid_pid 0xc251 0xf001 0x0d28 0x0204
2392 @end example
2393 @end deffn
2395 @deffn {Config Command} {cmsis_dap_serial} [serial]
2396 Specifies the @var{serial} of the CMSIS-DAP device to use.
2397 If not specified, serial numbers are not considered.
2398 @end deffn
2400 @deffn {Command} {cmsis-dap info}
2401 Display various device information, like hardware version, firmware version, current bus status.
2402 @end deffn
2403 @end deffn
2405 @deffn {Interface Driver} {dummy}
2406 A dummy software-only driver for debugging.
2407 @end deffn
2409 @deffn {Interface Driver} {ep93xx}
2410 Cirrus Logic EP93xx based single-board computer bit-banging (in development)
2411 @end deffn
2413 @deffn {Interface Driver} {ftdi}
2414 This driver is for adapters using the MPSSE (Multi-Protocol Synchronous Serial
2415 Engine) mode built into many FTDI chips, such as the FT2232, FT4232 and FT232H.
2417 The driver is using libusb-1.0 in asynchronous mode to talk to the FTDI device,
2418 bypassing intermediate libraries like libftdi or D2XX.
2420 Support for new FTDI based adapters can be added competely through
2421 configuration files, without the need to patch and rebuild OpenOCD.
2423 The driver uses a signal abstraction to enable Tcl configuration files to
2424 define outputs for one or several FTDI GPIO. These outputs can then be
2425 controlled using the @command{ftdi_set_signal} command. Special signal names
2426 are reserved for nTRST, nSRST and LED (for blink) so that they, if defined,
2427 will be used for their customary purpose. Inputs can be read using the
2428 @command{ftdi_get_signal} command.
2430 To support SWD, a signal named SWD_EN must be defined. It is set to 1 when the
2431 SWD protocol is selected. When set, the adapter should route the SWDIO pin to
2432 the data input. An SWDIO_OE signal, if defined, will be set to 1 or 0 as
2433 required by the protocol, to tell the adapter to drive the data output onto
2434 the SWDIO pin or keep the SWDIO pin Hi-Z, respectively.
2436 Depending on the type of buffer attached to the FTDI GPIO, the outputs have to
2437 be controlled differently. In order to support tristateable signals such as
2438 nSRST, both a data GPIO and an output-enable GPIO can be specified for each
2439 signal. The following output buffer configurations are supported:
2441 @itemize @minus
2442 @item Push-pull with one FTDI output as (non-)inverted data line
2443 @item Open drain with one FTDI output as (non-)inverted output-enable
2444 @item Tristate with one FTDI output as (non-)inverted data line and another
2445       FTDI output as (non-)inverted output-enable
2446 @item Unbuffered, using the FTDI GPIO as a tristate output directly by
2447       switching data and direction as necessary
2448 @end itemize
2450 These interfaces have several commands, used to configure the driver
2451 before initializing the JTAG scan chain:
2453 @deffn {Config Command} {ftdi_vid_pid} [vid pid]+
2454 The vendor ID and product ID of the adapter. Up to eight
2455 [@var{vid}, @var{pid}] pairs may be given, e.g.
2456 @example
2457 ftdi_vid_pid 0x0403 0xcff8 0x15ba 0x0003
2458 @end example
2459 @end deffn
2461 @deffn {Config Command} {ftdi_device_desc} description
2462 Provides the USB device description (the @emph{iProduct string})
2463 of the adapter. If not specified, the device description is ignored
2464 during device selection.
2465 @end deffn
2467 @deffn {Config Command} {ftdi_serial} serial-number
2468 Specifies the @var{serial-number} of the adapter to use,
2469 in case the vendor provides unique IDs and more than one adapter
2470 is connected to the host.
2471 If not specified, serial numbers are not considered.
2472 (Note that USB serial numbers can be arbitrary Unicode strings,
2473 and are not restricted to containing only decimal digits.)
2474 @end deffn
2476 @deffn {Config Command} {ftdi_location} <bus>:<port>[,<port>]...
2477 Specifies the physical USB port of the adapter to use. The path
2478 roots at @var{bus} and walks down the physical ports, with each
2479 @var{port} option specifying a deeper level in the bus topology, the last
2480 @var{port} denoting where the target adapter is actually plugged.
2481 The USB bus topology can be queried with the command @emph{lsusb -t}.
2483 This command is only available if your libusb1 is at least version 1.0.16.
2484 @end deffn
2486 @deffn {Config Command} {ftdi_channel} channel
2487 Selects the channel of the FTDI device to use for MPSSE operations. Most
2488 adapters use the default, channel 0, but there are exceptions.
2489 @end deffn
2491 @deffn {Config Command} {ftdi_layout_init} data direction
2492 Specifies the initial values of the FTDI GPIO data and direction registers.
2493 Each value is a 16-bit number corresponding to the concatenation of the high
2494 and low FTDI GPIO registers. The values should be selected based on the
2495 schematics of the adapter, such that all signals are set to safe levels with
2496 minimal impact on the target system. Avoid floating inputs, conflicting outputs
2497 and initially asserted reset signals.
2498 @end deffn
2500 @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]
2501 Creates a signal with the specified @var{name}, controlled by one or more FTDI
2502 GPIO pins via a range of possible buffer connections. The masks are FTDI GPIO
2503 register bitmasks to tell the driver the connection and type of the output
2504 buffer driving the respective signal. @var{data_mask} is the bitmask for the
2505 pin(s) connected to the data input of the output buffer. @option{-ndata} is
2506 used with inverting data inputs and @option{-data} with non-inverting inputs.
2507 The @option{-oe} (or @option{-noe}) option tells where the output-enable (or
2508 not-output-enable) input to the output buffer is connected. The options
2509 @option{-input} and @option{-ninput} specify the bitmask for pins to be read
2510 with the method @command{ftdi_get_signal}.
2512 Both @var{data_mask} and @var{oe_mask} need not be specified. For example, a
2513 simple open-collector transistor driver would be specified with @option{-oe}
2514 only. In that case the signal can only be set to drive low or to Hi-Z and the
2515 driver will complain if the signal is set to drive high. Which means that if
2516 it's a reset signal, @command{reset_config} must be specified as
2517 @option{srst_open_drain}, not @option{srst_push_pull}.
2519 A special case is provided when @option{-data} and @option{-oe} is set to the
2520 same bitmask. Then the FTDI pin is considered being connected straight to the
2521 target without any buffer. The FTDI pin is then switched between output and
2522 input as necessary to provide the full set of low, high and Hi-Z
2523 characteristics. In all other cases, the pins specified in a signal definition
2524 are always driven by the FTDI.
2526 If @option{-alias} or @option{-nalias} is used, the signal is created
2527 identical (or with data inverted) to an already specified signal
2528 @var{name}.
2529 @end deffn
2531 @deffn {Command} {ftdi_set_signal} name @option{0}|@option{1}|@option{z}
2532 Set a previously defined signal to the specified level.
2533 @itemize @minus
2534 @item @option{0}, drive low
2535 @item @option{1}, drive high
2536 @item @option{z}, set to high-impedance
2537 @end itemize
2538 @end deffn
2540 @deffn {Command} {ftdi_get_signal} name
2541 Get the value of a previously defined signal.
2542 @end deffn
2544 @deffn {Command} {ftdi_tdo_sample_edge} @option{rising}|@option{falling}
2545 Configure TCK edge at which the adapter samples the value of the TDO signal
2547 Due to signal propagation delays, sampling TDO on rising TCK can become quite
2548 peculiar at high JTAG clock speeds. However, FTDI chips offer a possiblity to sample
2549 TDO on falling edge of TCK. With some board/adapter configurations, this may increase
2550 stability at higher JTAG clocks.
2551 @itemize @minus
2552 @item @option{rising}, sample TDO on rising edge of TCK - this is the default
2553 @item @option{falling}, sample TDO on falling edge of TCK
2554 @end itemize
2555 @end deffn
2557 For example adapter definitions, see the configuration files shipped in the
2558 @file{interface/ftdi} directory.
2560 @end deffn
2562 @deffn {Interface Driver} {ft232r}
2563 This driver is implementing synchronous bitbang mode of an FTDI FT232R
2564 USB UART bridge IC.
2566 List of connections (pin numbers for SSOP):
2567 @itemize @minus
2568 @item RXD(5) - TDI
2569 @item TXD(1) - TCK
2570 @item RTS(3) - TDO
2571 @item CTS(11) - TMS
2572 @item DTR(2) - TRST
2573 @item DCD(10) - SRST
2574 @end itemize
2576 These interfaces have several commands, used to configure the driver
2577 before initializing the JTAG scan chain:
2579 @deffn {Config Command} {ft232r_vid_pid} @var{vid} @var{pid}
2580 The vendor ID and product ID of the adapter. If not specified, default
2581 0x0403:0x6001 is used.
2582 @end deffn
2584 @deffn {Config Command} {ft232r_serial_desc} @var{serial}
2585 Specifies the @var{serial} of the adapter to use, in case the
2586 vendor provides unique IDs and more than one adapter is connected to
2587 the host. If not specified, serial numbers are not considered.
2588 @end deffn
2590 @end deffn
2592 @deffn {Interface Driver} {remote_bitbang}
2593 Drive JTAG from a remote process. This sets up a UNIX or TCP socket connection
2594 with a remote process and sends ASCII encoded bitbang requests to that process
2595 instead of directly driving JTAG.
2597 The remote_bitbang driver is useful for debugging software running on
2598 processors which are being simulated.
2600 @deffn {Config Command} {remote_bitbang_port} number
2601 Specifies the TCP port of the remote process to connect to or 0 to use UNIX
2602 sockets instead of TCP.
2603 @end deffn
2605 @deffn {Config Command} {remote_bitbang_host} hostname
2606 Specifies the hostname of the remote process to connect to using TCP, or the
2607 name of the UNIX socket to use if remote_bitbang_port is 0.
2608 @end deffn
2610 For example, to connect remotely via TCP to the host foobar you might have
2611 something like:
2613 @example
2614 interface remote_bitbang
2615 remote_bitbang_port 3335
2616 remote_bitbang_host foobar
2617 @end example
2619 To connect to another process running locally via UNIX sockets with socket
2620 named mysocket:
2622 @example
2623 interface remote_bitbang
2624 remote_bitbang_port 0
2625 remote_bitbang_host mysocket
2626 @end example
2627 @end deffn
2629 @deffn {Interface Driver} {usb_blaster}
2630 USB JTAG/USB-Blaster compatibles over one of the userspace libraries
2631 for FTDI chips. These interfaces have several commands, used to
2632 configure the driver before initializing the JTAG scan chain:
2634 @deffn {Config Command} {usb_blaster_device_desc} description
2635 Provides the USB device description (the @emph{iProduct string})
2636 of the FTDI FT245 device. If not
2637 specified, the FTDI default value is used. This setting is only valid
2638 if compiled with FTD2XX support.
2639 @end deffn
2641 @deffn {Config Command} {usb_blaster_vid_pid} vid pid
2642 The vendor ID and product ID of the FTDI FT245 device. If not specified,
2643 default values are used.
2644 Currently, only one @var{vid}, @var{pid} pair may be given, e.g. for
2645 Altera USB-Blaster (default):
2646 @example
2647 usb_blaster_vid_pid 0x09FB 0x6001
2648 @end example
2649 The following VID/PID is for Kolja Waschk's USB JTAG:
2650 @example
2651 usb_blaster_vid_pid 0x16C0 0x06AD
2652 @end example
2653 @end deffn
2655 @deffn {Command} {usb_blaster_pin} (@option{pin6}|@option{pin8}) (@option{0}|@option{1}|@option{s}|@option{t})
2656 Sets the state or function of the unused GPIO pins on USB-Blasters
2657 (pins 6 and 8 on the female JTAG header). These pins can be used as
2658 SRST and/or TRST provided the appropriate connections are made on the
2659 target board.
2661 For example, to use pin 6 as SRST:
2662 @example
2663 usb_blaster_pin pin6 s
2664 reset_config srst_only
2665 @end example
2666 @end deffn
2668 @deffn {Command} {usb_blaster_lowlevel_driver} (@option{ftdi}|@option{ublast2})
2669 Chooses the low level access method for the adapter. If not specified,
2670 @option{ftdi} is selected unless it wasn't enabled during the
2671 configure stage. USB-Blaster II needs @option{ublast2}.
2672 @end deffn
2674 @deffn {Command} {usb_blaster_firmware} @var{path}
2675 This command specifies @var{path} to access USB-Blaster II firmware
2676 image. To be used with USB-Blaster II only.
2677 @end deffn
2679 @end deffn
2681 @deffn {Interface Driver} {gw16012}
2682 Gateworks GW16012 JTAG programmer.
2683 This has one driver-specific command:
2685 @deffn {Config Command} {parport_port} [port_number]
2686 Display either the address of the I/O port
2687 (default: 0x378 for LPT1) or the number of the @file{/dev/parport} device.
2688 If a parameter is provided, first switch to use that port.
2689 This is a write-once setting.
2690 @end deffn
2691 @end deffn
2693 @deffn {Interface Driver} {jlink}
2694 SEGGER J-Link family of USB adapters. It currently supports JTAG and SWD
2695 transports.
2697 @quotation Compatibility Note
2698 SEGGER released many firmware versions for the many harware versions they
2699 produced. OpenOCD was extensively tested and intended to run on all of them,
2700 but some combinations were reported as incompatible. As a general
2701 recommendation, it is advisable to use the latest firmware version
2702 available for each hardware version. However the current V8 is a moving
2703 target, and SEGGER firmware versions released after the OpenOCD was
2704 released may not be compatible. In such cases it is recommended to
2705 revert to the last known functional version. For 0.5.0, this is from
2706 "Feb  8 2012 14:30:39", packed with 4.42c. For 0.6.0, the last known
2707 version is from "May  3 2012 18:36:22", packed with 4.46f.
2708 @end quotation
2710 @deffn {Command} {jlink hwstatus}
2711 Display various hardware related information, for example target voltage and pin
2712 states.
2713 @end deffn
2714 @deffn {Command} {jlink freemem}
2715 Display free device internal memory.
2716 @end deffn
2717 @deffn {Command} {jlink jtag} [@option{2}|@option{3}]
2718 Set the JTAG command version to be used. Without argument, show the actual JTAG
2719 command version.
2720 @end deffn
2721 @deffn {Command} {jlink config}
2722 Display the device configuration.
2723 @end deffn
2724 @deffn {Command} {jlink config targetpower} [@option{on}|@option{off}]
2725 Set the target power state on JTAG-pin 19. Without argument, show the target
2726 power state.
2727 @end deffn
2728 @deffn {Command} {jlink config mac} [@option{ff:ff:ff:ff:ff:ff}]
2729 Set the MAC address of the device. Without argument, show the MAC address.
2730 @end deffn
2731 @deffn {Command} {jlink config ip} [@option{A.B.C.D}(@option{/E}|@option{F.G.H.I})]
2732 Set the IP configuration of the device, where A.B.C.D is the IP address, E the
2733 bit of the subnet mask and F.G.H.I the subnet mask. Without arguments, show the
2734 IP configuration.
2735 @end deffn
2736 @deffn {Command} {jlink config usb} [@option{0} to @option{3}]
2737 Set the USB address of the device. This will also change the USB Product ID
2738 (PID) of the device. Without argument, show the USB address.
2739 @end deffn
2740 @deffn {Command} {jlink config reset}
2741 Reset the current configuration.
2742 @end deffn
2743 @deffn {Command} {jlink config write}
2744 Write the current configuration to the internal persistent storage.
2745 @end deffn
2746 @deffn {Command} {jlink emucom write <channel> <data>}
2747 Write data to an EMUCOM channel. The data needs to be encoded as hexadecimal
2748 pairs.
2750 The following example shows how to write the three bytes 0xaa, 0x0b and 0x23 to
2751 the EMUCOM channel 0x10:
2752 @example
2753 > jlink emucom write 0x10 aa0b23
2754 @end example
2755 @end deffn
2756 @deffn {Command} {jlink emucom read <channel> <length>}
2757 Read data from an EMUCOM channel. The read data is encoded as hexadecimal
2758 pairs.
2760 The following example shows how to read 4 bytes from the EMUCOM channel 0x0:
2761 @example
2762 > jlink emucom read 0x0 4
2763 77a90000
2764 @end example
2765 @end deffn
2766 @deffn {Config} {jlink usb} <@option{0} to @option{3}>
2767 Set the USB address of the interface, in case more than one adapter is connected
2768 to the host. If not specified, USB addresses are not considered. Device
2769 selection via USB address is deprecated and the serial number should be used
2770 instead.
2772 As a configuration command, it can be used only before 'init'.
2773 @end deffn
2774 @deffn {Config} {jlink serial} <serial number>
2775 Set the serial number of the interface, in case more than one adapter is
2776 connected to the host. If not specified, serial numbers are not considered.
2778 As a configuration command, it can be used only before 'init'.
2779 @end deffn
2780 @end deffn
2782 @deffn {Interface Driver} {kitprog}
2783 This driver is for Cypress Semiconductor's KitProg adapters. The KitProg is an
2784 SWD-only adapter that is designed to be used with Cypress's PSoC and PRoC device
2785 families, but it is possible to use it with some other devices. If you are using
2786 this adapter with a PSoC or a PRoC, you may need to add
2787 @command{kitprog_init_acquire_psoc} or @command{kitprog acquire_psoc} to your
2788 configuration script.
2790 Note that this driver is for the proprietary KitProg protocol, not the CMSIS-DAP
2791 mode introduced in firmware 2.14. If the KitProg is in CMSIS-DAP mode, it cannot
2792 be used with this driver, and must either be used with the cmsis-dap driver or
2793 switched back to KitProg mode. See the Cypress KitProg User Guide for
2794 instructions on how to switch KitProg modes.
2796 Known limitations:
2797 @itemize @bullet
2798 @item The frequency of SWCLK cannot be configured, and varies between 1.6 MHz
2799 and 2.7 MHz.
2800 @item For firmware versions below 2.14, "JTAG to SWD" sequences are replaced by
2801 "SWD line reset" in the driver. This is for two reasons. First, the KitProg does
2802 not support sending arbitrary SWD sequences, and only firmware 2.14 and later
2803 implement both "JTAG to SWD" and "SWD line reset" in firmware. Earlier firmware
2804 versions only implement "SWD line reset". Second, due to a firmware quirk, an
2805 SWD sequence must be sent after every target reset in order to re-establish
2806 communications with the target.
2807 @item Due in part to the limitation above, KitProg devices with firmware below
2808 version 2.14 will need to use @command{kitprog_init_acquire_psoc} in order to
2809 communicate with PSoC 5LP devices. This is because, assuming debug is not
2810 disabled on the PSoC, the PSoC 5LP needs its JTAG interface switched to SWD
2811 mode before communication can begin, but prior to firmware 2.14, "JTAG to SWD"
2812 could only be sent with an acquisition sequence.
2813 @end itemize
2815 @deffn {Config Command} {kitprog_init_acquire_psoc}
2816 Indicate that a PSoC acquisition sequence needs to be run during adapter init.
2817 Please be aware that the acquisition sequence hard-resets the target.
2818 @end deffn
2820 @deffn {Config Command} {kitprog_serial} serial
2821 Select a KitProg device by its @var{serial}. If left unspecified, the first
2822 device detected by OpenOCD will be used.
2823 @end deffn
2825 @deffn {Command} {kitprog acquire_psoc}
2826 Run a PSoC acquisition sequence immediately. Typically, this should not be used
2827 outside of the target-specific configuration scripts since it hard-resets the
2828 target as a side-effect.
2829 This is necessary for "reset halt" on some PSoC 4 series devices.
2830 @end deffn
2832 @deffn {Command} {kitprog info}
2833 Display various adapter information, such as the hardware version, firmware
2834 version, and target voltage.
2835 @end deffn
2836 @end deffn
2838 @deffn {Interface Driver} {parport}
2839 Supports PC parallel port bit-banging cables:
2840 Wigglers, PLD download cable, and more.
2841 These interfaces have several commands, used to configure the driver
2842 before initializing the JTAG scan chain:
2844 @deffn {Config Command} {parport_cable} name
2845 Set the layout of the parallel port cable used to connect to the target.
2846 This is a write-once setting.
2847 Currently valid cable @var{name} values include:
2849 @itemize @minus
2850 @item @b{altium} Altium Universal JTAG cable.
2851 @item @b{arm-jtag} Same as original wiggler except SRST and
2852 TRST connections reversed and TRST is also inverted.
2853 @item @b{chameleon} The Amontec Chameleon's CPLD when operated
2854 in configuration mode. This is only used to
2855 program the Chameleon itself, not a connected target.
2856 @item @b{dlc5} The Xilinx Parallel cable III.
2857 @item @b{flashlink} The ST Parallel cable.
2858 @item @b{lattice} Lattice ispDOWNLOAD Cable
2859 @item @b{old_amt_wiggler} The Wiggler configuration that comes with
2860 some versions of
2861 Amontec's Chameleon Programmer. The new version available from
2862 the website uses the original Wiggler layout ('@var{wiggler}')
2863 @item @b{triton} The parallel port adapter found on the
2864 ``Karo Triton 1 Development Board''.
2865 This is also the layout used by the HollyGates design
2866 (see @uref{http://www.lartmaker.nl/projects/jtag/}).
2867 @item @b{wiggler} The original Wiggler layout, also supported by
2868 several clones, such as the Olimex ARM-JTAG
2869 @item @b{wiggler2} Same as original wiggler except an led is fitted on D5.
2870 @item @b{wiggler_ntrst_inverted} Same as original wiggler except TRST is inverted.
2871 @end itemize
2872 @end deffn
2874 @deffn {Config Command} {parport_port} [port_number]
2875 Display either the address of the I/O port
2876 (default: 0x378 for LPT1) or the number of the @file{/dev/parport} device.
2877 If a parameter is provided, first switch to use that port.
2878 This is a write-once setting.
2880 When using PPDEV to access the parallel port, use the number of the parallel port:
2881 @option{parport_port 0} (the default). If @option{parport_port 0x378} is specified
2882 you may encounter a problem.
2883 @end deffn
2885 @deffn Command {parport_toggling_time} [nanoseconds]
2886 Displays how many nanoseconds the hardware needs to toggle TCK;
2887 the parport driver uses this value to obey the
2888 @command{adapter_khz} configuration.
2889 When the optional @var{nanoseconds} parameter is given,
2890 that setting is changed before displaying the current value.
2892 The default setting should work reasonably well on commodity PC hardware.
2893 However, you may want to calibrate for your specific hardware.
2894 @quotation Tip
2895 To measure the toggling time with a logic analyzer or a digital storage
2896 oscilloscope, follow the procedure below:
2897 @example
2898 > parport_toggling_time 1000
2899 > adapter_khz 500
2900 @end example
2901 This sets the maximum JTAG clock speed of the hardware, but
2902 the actual speed probably deviates from the requested 500 kHz.
2903 Now, measure the time between the two closest spaced TCK transitions.
2904 You can use @command{runtest 1000} or something similar to generate a
2905 large set of samples.
2906 Update the setting to match your measurement:
2907 @example
2908 > parport_toggling_time <measured nanoseconds>
2909 @end example
2910 Now the clock speed will be a better match for @command{adapter_khz rate}
2911 commands given in OpenOCD scripts and event handlers.
2913 You can do something similar with many digital multimeters, but note
2914 that you'll probably need to run the clock continuously for several
2915 seconds before it decides what clock rate to show. Adjust the
2916 toggling time up or down until the measured clock rate is a good
2917 match for the adapter_khz rate you specified; be conservative.
2918 @end quotation
2919 @end deffn
2921 @deffn {Config Command} {parport_write_on_exit} (@option{on}|@option{off})
2922 This will configure the parallel driver to write a known
2923 cable-specific value to the parallel interface on exiting OpenOCD.
2924 @end deffn
2926 For example, the interface configuration file for a
2927 classic ``Wiggler'' cable on LPT2 might look something like this:
2929 @example
2930 interface parport
2931 parport_port 0x278
2932 parport_cable wiggler
2933 @end example
2934 @end deffn
2936 @deffn {Interface Driver} {presto}
2937 ASIX PRESTO USB JTAG programmer.
2938 @deffn {Config Command} {presto_serial} serial_string
2939 Configures the USB serial number of the Presto device to use.
2940 @end deffn
2941 @end deffn
2943 @deffn {Interface Driver} {rlink}
2944 Raisonance RLink USB adapter
2945 @end deffn
2947 @deffn {Interface Driver} {usbprog}
2948 usbprog is a freely programmable USB adapter.
2949 @end deffn
2951 @deffn {Interface Driver} {vsllink}
2952 vsllink is part of Versaloon which is a versatile USB programmer.
2954 @quotation Note
2955 This defines quite a few driver-specific commands,
2956 which are not currently documented here.
2957 @end quotation
2958 @end deffn
2960 @anchor{hla_interface}
2961 @deffn {Interface Driver} {hla}
2962 This is a driver that supports multiple High Level Adapters.
2963 This type of adapter does not expose some of the lower level api's
2964 that OpenOCD would normally use to access the target.
2966 Currently supported adapters include the ST STLINK and TI ICDI.
2967 STLINK firmware version >= V2.J21.S4 recommended due to issues with earlier
2968 versions of firmware where serial number is reset after first use.  Suggest
2969 using ST firmware update utility to upgrade STLINK firmware even if current
2970 version reported is V2.J21.S4.
2972 @deffn {Config Command} {hla_device_desc} description
2973 Currently Not Supported.
2974 @end deffn
2976 @deffn {Config Command} {hla_serial} serial
2977 Specifies the serial number of the adapter.
2978 @end deffn
2980 @deffn {Config Command} {hla_layout} (@option{stlink}|@option{icdi})
2981 Specifies the adapter layout to use.
2982 @end deffn
2984 @deffn {Config Command} {hla_vid_pid} [vid pid]+
2985 Pairs of vendor IDs and product IDs of the device.
2986 @end deffn
2988 @deffn {Command} {hla_command} command
2989 Execute a custom adapter-specific command. The @var{command} string is
2990 passed as is to the underlying adapter layout handler.
2991 @end deffn
2992 @end deffn
2994 @deffn {Interface Driver} {opendous}
2995 opendous-jtag is a freely programmable USB adapter.
2996 @end deffn
2998 @deffn {Interface Driver} {ulink}
2999 This is the Keil ULINK v1 JTAG debugger.
3000 @end deffn
3002 @deffn {Interface Driver} {ZY1000}
3003 This is the Zylin ZY1000 JTAG debugger.
3004 @end deffn
3006 @quotation Note
3007 This defines some driver-specific commands,
3008 which are not currently documented here.
3009 @end quotation
3011 @deffn Command power [@option{on}|@option{off}]
3012 Turn power switch to target on/off.
3013 No arguments: print status.
3014 @end deffn
3016 @deffn {Interface Driver} {bcm2835gpio}
3017 This SoC is present in Raspberry Pi which is a cheap single-board computer
3018 exposing some GPIOs on its expansion header.
3020 The driver accesses memory-mapped GPIO peripheral registers directly
3021 for maximum performance, but the only possible race condition is for
3022 the pins' modes/muxing (which is highly unlikely), so it should be
3023 able to coexist nicely with both sysfs bitbanging and various
3024 peripherals' kernel drivers. The driver restores the previous
3025 configuration on exit.
3027 See @file{interface/raspberrypi-native.cfg} for a sample config and
3028 pinout.
3030 @end deffn
3032 @deffn {Interface Driver} {imx_gpio}
3033 i.MX SoC is present in many community boards. Wandboard is an example
3034 of the one which is most popular.
3036 This driver is mostly the same as bcm2835gpio.
3038 See @file{interface/imx-native.cfg} for a sample config and
3039 pinout.
3041 @end deffn
3044 @deffn {Interface Driver} {openjtag}
3045 OpenJTAG compatible USB adapter.
3046 This defines some driver-specific commands:
3048 @deffn {Config Command} {openjtag_variant} variant
3049 Specifies the variant of the OpenJTAG adapter (see @uref{http://www.openjtag.org/}).
3050 Currently valid @var{variant} values include:
3052 @itemize @minus
3053 @item @b{standard} Standard variant (default).
3054 @item @b{cy7c65215} Cypress CY7C65215 Dual Channel USB-Serial Bridge Controller
3055 (see @uref{http://www.cypress.com/?rID=82870}).
3056 @end itemize
3057 @end deffn
3059 @deffn {Config Command} {openjtag_device_desc} string
3060 The USB device description string of the adapter.
3061 This value is only used with the standard variant.
3062 @end deffn
3063 @end deffn
3065 @section Transport Configuration
3066 @cindex Transport
3067 As noted earlier, depending on the version of OpenOCD you use,
3068 and the debug adapter you are using,
3069 several transports may be available to
3070 communicate with debug targets (or perhaps to program flash memory).
3071 @deffn Command {transport list}
3072 displays the names of the transports supported by this
3073 version of OpenOCD.
3074 @end deffn
3076 @deffn Command {transport select} @option{transport_name}
3077 Select which of the supported transports to use in this OpenOCD session.
3079 When invoked with @option{transport_name}, attempts to select the named
3080 transport.  The transport must be supported by the debug adapter
3081 hardware and by the version of OpenOCD you are using (including the
3082 adapter's driver).
3084 If no transport has been selected and no @option{transport_name} is
3085 provided, @command{transport select} auto-selects the first transport
3086 supported by the debug adapter.
3088 @command{transport select} always returns the name of the session's selected
3089 transport, if any.
3090 @end deffn
3092 @subsection JTAG Transport
3093 @cindex JTAG
3094 JTAG is the original transport supported by OpenOCD, and most
3095 of the OpenOCD commands support it.
3096 JTAG transports expose a chain of one or more Test Access Points (TAPs),
3097 each of which must be explicitly declared.
3098 JTAG supports both debugging and boundary scan testing.
3099 Flash programming support is built on top of debug support.
3101 JTAG transport is selected with the command @command{transport select
3102 jtag}. Unless your adapter uses @ref{hla_interface,the hla interface
3103 driver}, in which case the command is @command{transport select
3104 hla_jtag}.
3106 @subsection SWD Transport
3107 @cindex SWD
3108 @cindex Serial Wire Debug
3109 SWD (Serial Wire Debug) is an ARM-specific transport which exposes one
3110 Debug Access Point (DAP, which must be explicitly declared.
3111 (SWD uses fewer signal wires than JTAG.)
3112 SWD is debug-oriented, and does not support boundary scan testing.
3113 Flash programming support is built on top of debug support.
3114 (Some processors support both JTAG and SWD.)
3116 SWD transport is selected with the command @command{transport select
3117 swd}. Unless your adapter uses @ref{hla_interface,the hla interface
3118 driver}, in which case the command is @command{transport select
3119 hla_swd}.
3121 @deffn Command {swd newdap} ...
3122 Declares a single DAP which uses SWD transport.
3123 Parameters are currently the same as "jtag newtap" but this is
3124 expected to change.
3125 @end deffn
3126 @deffn Command {swd wcr trn prescale}
3127 Updates TRN (turnaraound delay) and prescaling.fields of the
3128 Wire Control Register (WCR).
3129 No parameters: displays current settings.
3130 @end deffn
3132 @subsection SPI Transport
3133 @cindex SPI
3134 @cindex Serial Peripheral Interface
3135 The Serial Peripheral Interface (SPI) is a general purpose transport
3136 which uses four wire signaling. Some processors use it as part of a
3137 solution for flash programming.
3139 @anchor{jtagspeed}
3140 @section JTAG Speed
3141 JTAG clock setup is part of system setup.
3142 It @emph{does not belong with interface setup} since any interface
3143 only knows a few of the constraints for the JTAG clock speed.
3144 Sometimes the JTAG speed is
3145 changed during the target initialization process: (1) slow at
3146 reset, (2) program the CPU clocks, (3) run fast.
3147 Both the "slow" and "fast" clock rates are functions of the
3148 oscillators used, the chip, the board design, and sometimes
3149 power management software that may be active.
3151 The speed used during reset, and the scan chain verification which
3152 follows reset, can be adjusted using a @code{reset-start}
3153 target event handler.
3154 It can then be reconfigured to a faster speed by a
3155 @code{reset-init} target event handler after it reprograms those
3156 CPU clocks, or manually (if something else, such as a boot loader,
3157 sets up those clocks).
3158 @xref{targetevents,,Target Events}.
3159 When the initial low JTAG speed is a chip characteristic, perhaps
3160 because of a required oscillator speed, provide such a handler
3161 in the target config file.
3162 When that speed is a function of a board-specific characteristic
3163 such as which speed oscillator is used, it belongs in the board
3164 config file instead.
3165 In both cases it's safest to also set the initial JTAG clock rate
3166 to that same slow speed, so that OpenOCD never starts up using a
3167 clock speed that's faster than the scan chain can support.
3169 @example
3170 jtag_rclk 3000
3171 $_TARGET.cpu configure -event reset-start @{ jtag_rclk 3000 @}
3172 @end example
3174 If your system supports adaptive clocking (RTCK), configuring
3175 JTAG to use that is probably the most robust approach.
3176 However, it introduces delays to synchronize clocks; so it
3177 may not be the fastest solution.
3179 @b{NOTE:} Script writers should consider using @command{jtag_rclk}
3180 instead of @command{adapter_khz}, but only for (ARM) cores and boards
3181 which support adaptive clocking.
3183 @deffn {Command} adapter_khz max_speed_kHz
3184 A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
3185 JTAG interfaces usually support a limited number of
3186 speeds. The speed actually used won't be faster
3187 than the speed specified.
3189 Chip data sheets generally include a top JTAG clock rate.
3190 The actual rate is often a function of a CPU core clock,
3191 and is normally less than that peak rate.
3192 For example, most ARM cores accept at most one sixth of the CPU clock.
3194 Speed 0 (khz) selects RTCK method.
3195 @xref{faqrtck,,FAQ RTCK}.
3196 If your system uses RTCK, you won't need to change the
3197 JTAG clocking after setup.
3198 Not all interfaces, boards, or targets support ``rtck''.
3199 If the interface device can not
3200 support it, an error is returned when you try to use RTCK.
3201 @end deffn
3203 @defun jtag_rclk fallback_speed_kHz
3204 @cindex adaptive clocking
3205 @cindex RTCK
3206 This Tcl proc (defined in @file{startup.tcl}) attempts to enable RTCK/RCLK.
3207 If that fails (maybe the interface, board, or target doesn't
3208 support it), falls back to the specified frequency.
3209 @example
3210 # Fall back to 3mhz if RTCK is not supported
3211 jtag_rclk 3000
3212 @end example
3213 @end defun
3215 @node Reset Configuration
3216 @chapter Reset Configuration
3217 @cindex Reset Configuration
3219 Every system configuration may require a different reset
3220 configuration. This can also be quite confusing.
3221 Resets also interact with @var{reset-init} event handlers,
3222 which do things like setting up clocks and DRAM, and
3223 JTAG clock rates. (@xref{jtagspeed,,JTAG Speed}.)
3224 They can also interact with JTAG routers.
3225 Please see the various board files for examples.
3227 @quotation Note
3228 To maintainers and integrators:
3229 Reset configuration touches several things at once.
3230 Normally the board configuration file
3231 should define it and assume that the JTAG adapter supports
3232 everything that's wired up to the board's JTAG connector.
3234 However, the target configuration file could also make note
3235 of something the silicon vendor has done inside the chip,
3236 which will be true for most (or all) boards using that chip.
3237 And when the JTAG adapter doesn't support everything, the
3238 user configuration file will need to override parts of
3239 the reset configuration provided by other files.
3240 @end quotation
3242 @section Types of Reset
3244 There are many kinds of reset possible through JTAG, but
3245 they may not all work with a given board and adapter.
3246 That's part of why reset configuration can be error prone.
3248 @itemize @bullet
3249 @item
3250 @emph{System Reset} ... the @emph{SRST} hardware signal
3251 resets all chips connected to the JTAG adapter, such as processors,
3252 power management chips, and I/O controllers. Normally resets triggered
3253 with this signal behave exactly like pressing a RESET button.
3254 @item
3255 @emph{JTAG TAP Reset} ... the @emph{TRST} hardware signal resets
3256 just the TAP controllers connected to the JTAG adapter.
3257 Such resets should not be visible to the rest of the system; resetting a
3258 device's TAP controller just puts that controller into a known state.
3259 @item
3260 @emph{Emulation Reset} ... many devices can be reset through JTAG
3261 commands. These resets are often distinguishable from system
3262 resets, either explicitly (a "reset reason" register says so)
3263 or implicitly (not all parts of the chip get reset).
3264 @item
3265 @emph{Other Resets} ... system-on-chip devices often support
3266 several other types of reset.
3267 You may need to arrange that a watchdog timer stops
3268 while debugging, preventing a watchdog reset.
3269 There may be individual module resets.
3270 @end itemize
3272 In the best case, OpenOCD can hold SRST, then reset
3273 the TAPs via TRST and send commands through JTAG to halt the
3274 CPU at the reset vector before the 1st instruction is executed.
3275 Then when it finally releases the SRST signal, the system is
3276 halted under debugger control before any code has executed.
3277 This is the behavior required to support the @command{reset halt}
3278 and @command{reset init} commands; after @command{reset init} a
3279 board-specific script might do things like setting up DRAM.
3280 (@xref{resetcommand,,Reset Command}.)
3282 @anchor{srstandtrstissues}
3283 @section SRST and TRST Issues
3285 Because SRST and TRST are hardware signals, they can have a
3286 variety of system-specific constraints. Some of the most
3287 common issues are:
3289 @itemize @bullet
3291 @item @emph{Signal not available} ... Some boards don't wire
3292 SRST or TRST to the JTAG connector. Some JTAG adapters don't
3293 support such signals even if they are wired up.
3294 Use the @command{reset_config} @var{signals} options to say
3295 when either of those signals is not connected.
3296 When SRST is not available, your code might not be able to rely
3297 on controllers having been fully reset during code startup.
3298 Missing TRST is not a problem, since JTAG-level resets can
3299 be triggered using with TMS signaling.
3301 @item @emph{Signals shorted} ... Sometimes a chip, board, or
3302 adapter will connect SRST to TRST, instead of keeping them separate.
3303 Use the @command{reset_config} @var{combination} options to say
3304 when those signals aren't properly independent.
3306 @item @emph{Timing} ... Reset circuitry like a resistor/capacitor
3307 delay circuit, reset supervisor, or on-chip features can extend
3308 the effect of a JTAG adapter's reset for some time after the adapter
3309 stops issuing the reset. For example, there may be chip or board
3310 requirements that all reset pulses last for at least a
3311 certain amount of time; and reset buttons commonly have
3312 hardware debouncing.
3313 Use the @command{adapter_nsrst_delay} and @command{jtag_ntrst_delay}
3314 commands to say when extra delays are needed.
3316 @item @emph{Drive type} ... Reset lines often have a pullup
3317 resistor, letting the JTAG interface treat them as open-drain
3318 signals. But that's not a requirement, so the adapter may need
3319 to use push/pull output drivers.
3320 Also, with weak pullups it may be advisable to drive
3321 signals to both levels (push/pull) to minimize rise times.
3322 Use the @command{reset_config} @var{trst_type} and
3323 @var{srst_type} parameters to say how to drive reset signals.
3325 @item @emph{Special initialization} ... Targets sometimes need
3326 special JTAG initialization sequences to handle chip-specific
3327 issues (not limited to errata).
3328 For example, certain JTAG commands might need to be issued while
3329 the system as a whole is in a reset state (SRST active)
3330 but the JTAG scan chain is usable (TRST inactive).
3331 Many systems treat combined assertion of SRST and TRST as a
3332 trigger for a harder reset than SRST alone.
3333 Such custom reset handling is discussed later in this chapter.
3334 @end itemize
3336 There can also be other issues.
3337 Some devices don't fully conform to the JTAG specifications.
3338 Trivial system-specific differences are common, such as
3339 SRST and TRST using slightly different names.
3340 There are also vendors who distribute key JTAG documentation for
3341 their chips only to developers who have signed a Non-Disclosure
3342 Agreement (NDA).
3344 Sometimes there are chip-specific extensions like a requirement to use
3345 the normally-optional TRST signal (precluding use of JTAG adapters which
3346 don't pass TRST through), or needing extra steps to complete a TAP reset.
3348 In short, SRST and especially TRST handling may be very finicky,
3349 needing to cope with both architecture and board specific constraints.
3351 @section Commands for Handling Resets
3353 @deffn {Command} adapter_nsrst_assert_width milliseconds
3354 Minimum amount of time (in milliseconds) OpenOCD should wait
3355 after asserting nSRST (active-low system reset) before
3356 allowing it to be deasserted.
3357 @end deffn
3359 @deffn {Command} adapter_nsrst_delay milliseconds
3360 How long (in milliseconds) OpenOCD should wait after deasserting
3361 nSRST (active-low system reset) before starting new JTAG operations.
3362 When a board has a reset button connected to SRST line it will
3363 probably have hardware debouncing, implying you should use this.
3364 @end deffn
3366 @deffn {Command} jtag_ntrst_assert_width milliseconds
3367 Minimum amount of time (in milliseconds) OpenOCD should wait
3368 after asserting nTRST (active-low JTAG TAP reset) before
3369 allowing it to be deasserted.
3370 @end deffn
3372 @deffn {Command} jtag_ntrst_delay milliseconds
3373 How long (in milliseconds) OpenOCD should wait after deasserting
3374 nTRST (active-low JTAG TAP reset) before starting new JTAG operations.
3375 @end deffn
3377 @deffn {Command} reset_config mode_flag ...
3378 This command displays or modifies the reset configuration
3379 of your combination of JTAG board and target in target
3380 configuration scripts.
3382 Information earlier in this section describes the kind of problems
3383 the command is intended to address (@pxref{srstandtrstissues,,SRST and TRST Issues}).
3384 As a rule this command belongs only in board config files,
3385 describing issues like @emph{board doesn't connect TRST};
3386 or in user config files, addressing limitations derived
3387 from a particular combination of interface and board.
3388 (An unlikely example would be using a TRST-only adapter
3389 with a board that only wires up SRST.)
3391 The @var{mode_flag} options can be specified in any order, but only one
3392 of each type -- @var{signals}, @var{combination}, @var{gates},
3393 @var{trst_type}, @var{srst_type} and @var{connect_type}
3394 -- may be specified at a time.
3395 If you don't provide a new value for a given type, its previous
3396 value (perhaps the default) is unchanged.
3397 For example, this means that you don't need to say anything at all about
3398 TRST just to declare that if the JTAG adapter should want to drive SRST,
3399 it must explicitly be driven high (@option{srst_push_pull}).
3401 @itemize
3402 @item
3403 @var{signals} can specify which of the reset signals are connected.
3404 For example, If the JTAG interface provides SRST, but the board doesn't
3405 connect that signal properly, then OpenOCD can't use it.
3406 Possible values are @option{none} (the default), @option{trst_only},
3407 @option{srst_only} and @option{trst_and_srst}.
3409 @quotation Tip
3410 If your board provides SRST and/or TRST through the JTAG connector,
3411 you must declare that so those signals can be used.
3412 @end quotation
3414 @item
3415 The @var{combination} is an optional value specifying broken reset
3416 signal implementations.
3417 The default behaviour if no option given is @option{separate},
3418 indicating everything behaves normally.
3419 @option{srst_pulls_trst} states that the
3420 test logic is reset together with the reset of the system (e.g. NXP
3421 LPC2000, "broken" board layout), @option{trst_pulls_srst} says that
3422 the system is reset together with the test logic (only hypothetical, I
3423 haven't seen hardware with such a bug, and can be worked around).
3424 @option{combined} implies both @option{srst_pulls_trst} and
3425 @option{trst_pulls_srst}.
3427 @item
3428 The @var{gates} tokens control flags that describe some cases where
3429 JTAG may be unvailable during reset.
3430 @option{srst_gates_jtag} (default)
3431 indicates that asserting SRST gates the
3432 JTAG clock. This means that no communication can happen on JTAG
3433 while SRST is asserted.
3434 Its converse is @option{srst_nogate}, indicating that JTAG commands
3435 can safely be issued while SRST is active.
3437 @item
3438 The @var{connect_type} tokens control flags that describe some cases where
3439 SRST is asserted while connecting to the target. @option{srst_nogate}
3440 is required to use this option.
3441 @option{connect_deassert_srst} (default)
3442 indicates that SRST will not be asserted while connecting to the target.
3443 Its converse is @option{connect_assert_srst}, indicating that SRST will
3444 be asserted before any target connection.
3445 Only some targets support this feature, STM32 and STR9 are examples.
3446 This feature is useful if you are unable to connect to your target due
3447 to incorrect options byte config or illegal program execution.
3448 @end itemize
3450 The optional @var{trst_type} and @var{srst_type} parameters allow the
3451 driver mode of each reset line to be specified. These values only affect
3452 JTAG interfaces with support for different driver modes, like the Amontec
3453 JTAGkey and JTAG Accelerator. Also, they are necessarily ignored if the
3454 relevant signal (TRST or SRST) is not connected.
3456 @itemize
3457 @item
3458 Possible @var{trst_type} driver modes for the test reset signal (TRST)
3459 are the default @option{trst_push_pull}, and @option{trst_open_drain}.
3460 Most boards connect this signal to a pulldown, so the JTAG TAPs
3461 never leave reset unless they are hooked up to a JTAG adapter.
3463 @item
3464 Possible @var{srst_type} driver modes for the system reset signal (SRST)
3465 are the default @option{srst_open_drain}, and @option{srst_push_pull}.
3466 Most boards connect this signal to a pullup, and allow the
3467 signal to be pulled low by various events including system
3468 powerup and pressing a reset button.
3469 @end itemize
3470 @end deffn
3472 @section Custom Reset Handling
3473 @cindex events
3475 OpenOCD has several ways to help support the various reset
3476 mechanisms provided by chip and board vendors.
3477 The commands shown in the previous section give standard parameters.
3478 There are also @emph{event handlers} associated with TAPs or Targets.
3479 Those handlers are Tcl procedures you can provide, which are invoked
3480 at particular points in the reset sequence.
3482 @emph{When SRST is not an option} you must set
3483 up a @code{reset-assert} event handler for your target.
3484 For example, some JTAG adapters don't include the SRST signal;
3485 and some boards have multiple targets, and you won't always
3486 want to reset everything at once.
3488 After configuring those mechanisms, you might still
3489 find your board doesn't start up or reset correctly.
3490 For example, maybe it needs a slightly different sequence
3491 of SRST and/or TRST manipulations, because of quirks that
3492 the @command{reset_config} mechanism doesn't address;
3493 or asserting both might trigger a stronger reset, which
3494 needs special attention.
3496 Experiment with lower level operations, such as @command{jtag_reset}
3497 and the @command{jtag arp_*} operations shown here,
3498 to find a sequence of operations that works.
3499 @xref{JTAG Commands}.
3500 When you find a working sequence, it can be used to override
3501 @command{jtag_init}, which fires during OpenOCD startup
3502 (@pxref{configurationstage,,Configuration Stage});
3503 or @command{init_reset}, which fires during reset processing.
3505 You might also want to provide some project-specific reset
3506 schemes. For example, on a multi-target board the standard
3507 @command{reset} command would reset all targets, but you
3508 may need the ability to reset only one target at time and
3509 thus want to avoid using the board-wide SRST signal.
3511 @deffn {Overridable Procedure} init_reset mode
3512 This is invoked near the beginning of the @command{reset} command,
3513 usually to provide as much of a cold (power-up) reset as practical.
3514 By default it is also invoked from @command{jtag_init} if
3515 the scan chain does not respond to pure JTAG operations.
3516 The @var{mode} parameter is the parameter given to the
3517 low level reset command (@option{halt},
3518 @option{init}, or @option{run}), @option{setup},
3519 or potentially some other value.
3521 The default implementation just invokes @command{jtag arp_init-reset}.
3522 Replacements will normally build on low level JTAG
3523 operations such as @command{jtag_reset}.
3524 Operations here must not address individual TAPs
3525 (or their associated targets)
3526 until the JTAG scan chain has first been verified to work.
3528 Implementations must have verified the JTAG scan chain before
3529 they return.
3530 This is done by calling @command{jtag arp_init}
3531 (or @command{jtag arp_init-reset}).
3532 @end deffn
3534 @deffn Command {jtag arp_init}
3535 This validates the scan chain using just the four
3536 standard JTAG signals (TMS, TCK, TDI, TDO).
3537 It starts by issuing a JTAG-only reset.
3538 Then it performs checks to verify that the scan chain configuration
3539 matches the TAPs it can observe.
3540 Those checks include checking IDCODE values for each active TAP,
3541 and verifying the length of their instruction registers using
3542 TAP @code{-ircapture} and @code{-irmask} values.
3543 If these tests all pass, TAP @code{setup} events are
3544 issued to all TAPs with handlers for that event.
3545 @end deffn
3547 @deffn Command {jtag arp_init-reset}
3548 This uses TRST and SRST to try resetting
3549 everything on the JTAG scan chain
3550 (and anything else connected to SRST).
3551 It then invokes the logic of @command{jtag arp_init}.
3552 @end deffn
3555 @node TAP Declaration
3556 @chapter TAP Declaration
3557 @cindex TAP declaration
3558 @cindex TAP configuration
3560 @emph{Test Access Ports} (TAPs) are the core of JTAG.
3561 TAPs serve many roles, including:
3563 @itemize @bullet
3564 @item @b{Debug Target} A CPU TAP can be used as a GDB debug target.
3565 @item @b{Flash Programming} Some chips program the flash directly via JTAG.
3566 Others do it indirectly, making a CPU do it.
3567 @item @b{Program Download} Using the same CPU support GDB uses,
3568 you can initialize a DRAM controller, download code to DRAM, and then
3569 start running that code.
3570 @item @b{Boundary Scan} Most chips support boundary scan, which
3571 helps test for board assembly problems like solder bridges
3572 and missing connections.
3573 @end itemize
3575 OpenOCD must know about the active TAPs on your board(s).
3576 Setting up the TAPs is the core task of your configuration files.
3577 Once those TAPs are set up, you can pass their names to code
3578 which sets up CPUs and exports them as GDB targets,
3579 probes flash memory, performs low-level JTAG operations, and more.
3581 @section Scan Chains
3582 @cindex scan chain
3584 TAPs are part of a hardware @dfn{scan chain},
3585 which is a daisy chain of TAPs.
3586 They also need to be added to
3587 OpenOCD's software mirror of that hardware list,
3588 giving each member a name and associating other data with it.
3589 Simple scan chains, with a single TAP, are common in
3590 systems with a single microcontroller or microprocessor.
3591 More complex chips may have several TAPs internally.
3592 Very complex scan chains might have a dozen or more TAPs:
3593 several in one chip, more in the next, and connecting
3594 to other boards with their own chips and TAPs.
3596 You can display the list with the @command{scan_chain} command.
3597 (Don't confuse this with the list displayed by the @command{targets}
3598 command, presented in the next chapter.
3599 That only displays TAPs for CPUs which are configured as
3600 debugging targets.)
3601 Here's what the scan chain might look like for a chip more than one TAP:
3603 @verbatim
3604    TapName            Enabled IdCode     Expected   IrLen IrCap IrMask
3605 -- ------------------ ------- ---------- ---------- ----- ----- ------
3606  0 omap5912.dsp          Y    0x03df1d81 0x03df1d81    38 0x01  0x03
3607  1 omap5912.arm          Y    0x0692602f 0x0692602f     4 0x01  0x0f
3608  2 omap5912.unknown      Y    0x00000000 0x00000000     8 0x01  0x03
3609 @end verbatim
3611 OpenOCD can detect some of that information, but not all
3612 of it. @xref{autoprobing,,Autoprobing}.
3613 Unfortunately, those TAPs can't always be autoconfigured,
3614 because not all devices provide good support for that.
3615 JTAG doesn't require supporting IDCODE instructions, and
3616 chips with JTAG routers may not link TAPs into the chain
3617 until they are told to do so.
3619 The configuration mechanism currently supported by OpenOCD
3620 requires explicit configuration of all TAP devices using
3621 @command{jtag newtap} commands, as detailed later in this chapter.
3622 A command like this would declare one tap and name it @code{chip1.cpu}:
3624 @example
3625 jtag newtap chip1 cpu -irlen 4 -expected-id 0x3ba00477
3626 @end example
3628 Each target configuration file lists the TAPs provided
3629 by a given chip.
3630 Board configuration files combine all the targets on a board,
3631 and so forth.
3632 Note that @emph{the order in which TAPs are declared is very important.}
3633 That declaration order must match the order in the JTAG scan chain,
3634 both inside a single chip and between them.
3635 @xref{faqtaporder,,FAQ TAP Order}.
3637 For example, the ST Microsystems STR912 chip has
3638 three separate TAPs@footnote{See the ST
3639 document titled: @emph{STR91xFAxxx, Section 3.15 Jtag Interface, Page:
3640 28/102, Figure 3: JTAG chaining inside the STR91xFA}.
3641 @url{http://eu.st.com/stonline/products/literature/ds/13495.pdf}}.
3642 To configure those taps, @file{target/str912.cfg}
3643 includes commands something like this:
3645 @example
3646 jtag newtap str912 flash ... params ...
3647 jtag newtap str912 cpu ... params ...
3648 jtag newtap str912 bs ... params ...
3649 @end example
3651 Actual config files typically use a variable such as @code{$_CHIPNAME}
3652 instead of literals like @option{str912}, to support more than one chip
3653 of each type.  @xref{Config File Guidelines}.
3655 @deffn Command {jtag names}
3656 Returns the names of all current TAPs in the scan chain.
3657 Use @command{jtag cget} or @command{jtag tapisenabled}
3658 to examine attributes and state of each TAP.
3659 @example
3660 foreach t [jtag names] @{
3661     puts [format "TAP: %s\n" $t]
3663 @end example
3664 @end deffn
3666 @deffn Command {scan_chain}
3667 Displays the TAPs in the scan chain configuration,
3668 and their status.
3669 The set of TAPs listed by this command is fixed by
3670 exiting the OpenOCD configuration stage,
3671 but systems with a JTAG router can
3672 enable or disable TAPs dynamically.
3673 @end deffn
3675 @c FIXME! "jtag cget" should be able to return all TAP
3676 @c attributes, like "$target_name cget" does for targets.
3678 @c Probably want "jtag eventlist", and a "tap-reset" event
3679 @c (on entry to RESET state).
3681 @section TAP Names
3682 @cindex dotted name
3684 When TAP objects are declared with @command{jtag newtap},
3685 a @dfn{dotted.name} is created for the TAP, combining the
3686 name of a module (usually a chip) and a label for the TAP.
3687 For example: @code{xilinx.tap}, @code{str912.flash},
3688 @code{omap3530.jrc}, @code{dm6446.dsp}, or @code{stm32.cpu}.
3689 Many other commands use that dotted.name to manipulate or
3690 refer to the TAP. For example, CPU configuration uses the
3691 name, as does declaration of NAND or NOR flash banks.
3693 The components of a dotted name should follow ``C'' symbol
3694 name rules: start with an alphabetic character, then numbers
3695 and underscores are OK; while others (including dots!) are not.
3697 @section TAP Declaration Commands
3699 @c shouldn't this be(come) a {Config Command}?
3700 @deffn Command {jtag newtap} chipname tapname configparams...
3701 Declares a new TAP with the dotted name @var{chipname}.@var{tapname},
3702 and configured according to the various @var{configparams}.
3704 The @var{chipname} is a symbolic name for the chip.
3705 Conventionally target config files use @code{$_CHIPNAME},
3706 defaulting to the model name given by the chip vendor but
3707 overridable.
3709 @cindex TAP naming convention
3710 The @var{tapname} reflects the role of that TAP,
3711 and should follow this convention:
3713 @itemize @bullet
3714 @item @code{bs} -- For boundary scan if this is a separate TAP;
3715 @item @code{cpu} -- The main CPU of the chip, alternatively
3716 @code{arm} and @code{dsp} on chips with both ARM and DSP CPUs,
3717 @code{arm1} and @code{arm2} on chips with two ARMs, and so forth;
3718 @item @code{etb} -- For an embedded trace buffer (example: an ARM ETB11);
3719 @item @code{flash} -- If the chip has a flash TAP, like the str912;
3720 @item @code{jrc} -- For JTAG route controller (example: the ICEPick modules
3721 on many Texas Instruments chips, like the OMAP3530 on Beagleboards);
3722 @item @code{tap} -- Should be used only for FPGA- or CPLD-like devices
3723 with a single TAP;
3724 @item @code{unknownN} -- If you have no idea what the TAP is for (N is a number);
3725 @item @emph{when in doubt} -- Use the chip maker's name in their data sheet.
3726 For example, the Freescale i.MX31 has a SDMA (Smart DMA) with
3727 a JTAG TAP; that TAP should be named @code{sdma}.
3728 @end itemize
3730 Every TAP requires at least the following @var{configparams}:
3732 @itemize @bullet
3733 @item @code{-irlen} @var{NUMBER}
3734 @*The length in bits of the
3735 instruction register, such as 4 or 5 bits.
3736 @end itemize
3738 A TAP may also provide optional @var{configparams}:
3740 @itemize @bullet
3741 @item @code{-disable} (or @code{-enable})
3742 @*Use the @code{-disable} parameter to flag a TAP which is not
3743 linked into the scan chain after a reset using either TRST
3744 or the JTAG state machine's @sc{reset} state.
3745 You may use @code{-enable} to highlight the default state
3746 (the TAP is linked in).
3747 @xref{enablinganddisablingtaps,,Enabling and Disabling TAPs}.
3748 @item @code{-expected-id} @var{NUMBER}
3749 @*A non-zero @var{number} represents a 32-bit IDCODE
3750 which you expect to find when the scan chain is examined.
3751 These codes are not required by all JTAG devices.
3752 @emph{Repeat the option} as many times as required if more than one
3753 ID code could appear (for example, multiple versions).
3754 Specify @var{number} as zero to suppress warnings about IDCODE
3755 values that were found but not included in the list.
3757 Provide this value if at all possible, since it lets OpenOCD
3758 tell when the scan chain it sees isn't right. These values
3759 are provided in vendors' chip documentation, usually a technical
3760 reference manual. Sometimes you may need to probe the JTAG
3761 hardware to find these values.
3762 @xref{autoprobing,,Autoprobing}.
3763 @item @code{-ignore-version}
3764 @*Specify this to ignore the JTAG version field in the @code{-expected-id}
3765 option. When vendors put out multiple versions of a chip, or use the same
3766 JTAG-level ID for several largely-compatible chips, it may be more practical
3767 to ignore the version field than to update config files to handle all of
3768 the various chip IDs. The version field is defined as bit 28-31 of the IDCODE.
3769 @item @code{-ircapture} @var{NUMBER}
3770 @*The bit pattern loaded by the TAP into the JTAG shift register
3771 on entry to the @sc{ircapture} state, such as 0x01.
3772 JTAG requires the two LSBs of this value to be 01.
3773 By default, @code{-ircapture} and @code{-irmask} are set
3774 up to verify that two-bit value. You may provide
3775 additional bits if you know them, or indicate that
3776 a TAP doesn't conform to the JTAG specification.
3777 @item @code{-irmask} @var{NUMBER}
3778 @*A mask used with @code{-ircapture}
3779 to verify that instruction scans work correctly.
3780 Such scans are not used by OpenOCD except to verify that
3781 there seems to be no problems with JTAG scan chain operations.
3782 @end itemize
3783 @end deffn
3785 @section Other TAP commands
3787 @deffn Command {jtag cget} dotted.name @option{-event} event_name
3788 @deffnx Command {jtag configure} dotted.name @option{-event} event_name handler
3789 At this writing this TAP attribute
3790 mechanism is used only for event handling.
3791 (It is not a direct analogue of the @code{cget}/@code{configure}
3792 mechanism for debugger targets.)
3793 See the next section for information about the available events.
3795 The @code{configure} subcommand assigns an event handler,
3796 a TCL string which is evaluated when the event is triggered.
3797 The @code{cget} subcommand returns that handler.
3798 @end deffn
3800 @section TAP Events
3801 @cindex events
3802 @cindex TAP events
3804 OpenOCD includes two event mechanisms.
3805 The one presented here applies to all JTAG TAPs.
3806 The other applies to debugger targets,
3807 which are associated with certain TAPs.
3809 The TAP events currently defined are:
3811 @itemize @bullet
3812 @item @b{post-reset}
3813 @* The TAP has just completed a JTAG reset.
3814 The tap may still be in the JTAG @sc{reset} state.
3815 Handlers for these events might perform initialization sequences
3816 such as issuing TCK cycles, TMS sequences to ensure
3817 exit from the ARM SWD mode, and more.
3819 Because the scan chain has not yet been verified, handlers for these events
3820 @emph{should not issue commands which scan the JTAG IR or DR registers}
3821 of any particular target.
3822 @b{NOTE:} As this is written (September 2009), nothing prevents such access.
3823 @item @b{setup}
3824 @* The scan chain has been reset and verified.
3825 This handler may enable TAPs as needed.
3826 @item @b{tap-disable}
3827 @* The TAP needs to be disabled. This handler should
3828 implement @command{jtag tapdisable}
3829 by issuing the relevant JTAG commands.
3830 @item @b{tap-enable}
3831 @* The TAP needs to be enabled. This handler should
3832 implement @command{jtag tapenable}
3833 by issuing the relevant JTAG commands.
3834 @end itemize
3836 If you need some action after each JTAG reset which isn't actually
3837 specific to any TAP (since you can't yet trust the scan chain's
3838 contents to be accurate), you might:
3840 @example
3841 jtag configure CHIP.jrc -event post-reset @{
3842   echo "JTAG Reset done"
3843   ... non-scan jtag operations to be done after reset
3845 @end example
3848 @anchor{enablinganddisablingtaps}
3849 @section Enabling and Disabling TAPs
3850 @cindex JTAG Route Controller
3851 @cindex jrc
3853 In some systems, a @dfn{JTAG Route Controller} (JRC)
3854 is used to enable and/or disable specific JTAG TAPs.
3855 Many ARM-based chips from Texas Instruments include
3856 an ``ICEPick'' module, which is a JRC.
3857 Such chips include DaVinci and OMAP3 processors.
3859 A given TAP may not be visible until the JRC has been
3860 told to link it into the scan chain; and if the JRC
3861 has been told to unlink that TAP, it will no longer
3862 be visible.
3863 Such routers address problems that JTAG ``bypass mode''
3864 ignores, such as:
3866 @itemize
3867 @item The scan chain can only go as fast as its slowest TAP.
3868 @item Having many TAPs slows instruction scans, since all
3869 TAPs receive new instructions.
3870 @item TAPs in the scan chain must be powered up, which wastes
3871 power and prevents debugging some power management mechanisms.
3872 @end itemize
3874 The IEEE 1149.1 JTAG standard has no concept of a ``disabled'' tap,
3875 as implied by the existence of JTAG routers.
3876 However, the upcoming IEEE 1149.7 framework (layered on top of JTAG)
3877 does include a kind of JTAG router functionality.
3879 @c (a) currently the event handlers don't seem to be able to
3880 @c     fail in a way that could lead to no-change-of-state.
3882 In OpenOCD, tap enabling/disabling is invoked by the Tcl commands
3883 shown below, and is implemented using TAP event handlers.
3884 So for example, when defining a TAP for a CPU connected to
3885 a JTAG router, your @file{target.cfg} file
3886 should define TAP event handlers using
3887 code that looks something like this:
3889 @example
3890 jtag configure CHIP.cpu -event tap-enable @{
3891   ... jtag operations using CHIP.jrc
3893 jtag configure CHIP.cpu -event tap-disable @{
3894   ... jtag operations using CHIP.jrc
3896 @end example
3898 Then you might want that CPU's TAP enabled almost all the time:
3900 @example
3901 jtag configure $CHIP.jrc -event setup "jtag tapenable $CHIP.cpu"
3902 @end example
3904 Note how that particular setup event handler declaration
3905 uses quotes to evaluate @code{$CHIP} when the event is configured.
3906 Using brackets @{ @} would cause it to be evaluated later,
3907 at runtime, when it might have a different value.
3909 @deffn Command {jtag tapdisable} dotted.name
3910 If necessary, disables the tap
3911 by sending it a @option{tap-disable} event.
3912 Returns the string "1" if the tap
3913 specified by @var{dotted.name} is enabled,
3914 and "0" if it is disabled.
3915 @end deffn
3917 @deffn Command {jtag tapenable} dotted.name
3918 If necessary, enables the tap
3919 by sending it a @option{tap-enable} event.
3920 Returns the string "1" if the tap
3921 specified by @var{dotted.name} is enabled,
3922 and "0" if it is disabled.
3923 @end deffn
3925 @deffn Command {jtag tapisenabled} dotted.name
3926 Returns the string "1" if the tap
3927 specified by @var{dotted.name} is enabled,
3928 and "0" if it is disabled.
3930 @quotation Note
3931 Humans will find the @command{scan_chain} command more helpful
3932 for querying the state of the JTAG taps.
3933 @end quotation
3934 @end deffn
3936 @anchor{autoprobing}
3937 @section Autoprobing
3938 @cindex autoprobe
3939 @cindex JTAG autoprobe
3941 TAP configuration is the first thing that needs to be done
3942 after interface and reset configuration. Sometimes it's
3943 hard finding out what TAPs exist, or how they are identified.
3944 Vendor documentation is not always easy to find and use.
3946 To help you get past such problems, OpenOCD has a limited
3947 @emph{autoprobing} ability to look at the scan chain, doing
3948 a @dfn{blind interrogation} and then reporting the TAPs it finds.
3949 To use this mechanism, start the OpenOCD server with only data
3950 that configures your JTAG interface, and arranges to come up
3951 with a slow clock (many devices don't support fast JTAG clocks
3952 right when they come out of reset).
3954 For example, your @file{openocd.cfg} file might have:
3956 @example
3957 source [find interface/olimex-arm-usb-tiny-h.cfg]
3958 reset_config trst_and_srst
3959 jtag_rclk 8
3960 @end example
3962 When you start the server without any TAPs configured, it will
3963 attempt to autoconfigure the TAPs. There are two parts to this:
3965 @enumerate
3966 @item @emph{TAP discovery} ...
3967 After a JTAG reset (sometimes a system reset may be needed too),
3968 each TAP's data registers will hold the contents of either the
3969 IDCODE or BYPASS register.
3970 If JTAG communication is working, OpenOCD will see each TAP,
3971 and report what @option{-expected-id} to use with it.
3972 @item @emph{IR Length discovery} ...
3973 Unfortunately JTAG does not provide a reliable way to find out
3974 the value of the @option{-irlen} parameter to use with a TAP
3975 that is discovered.
3976 If OpenOCD can discover the length of a TAP's instruction
3977 register, it will report it.
3978 Otherwise you may need to consult vendor documentation, such
3979 as chip data sheets or BSDL files.
3980 @end enumerate
3982 In many cases your board will have a simple scan chain with just
3983 a single device. Here's what OpenOCD reported with one board
3984 that's a bit more complex:
3986 @example
3987 clock speed 8 kHz
3988 There are no enabled taps. AUTO PROBING MIGHT NOT WORK!!
3989 AUTO auto0.tap - use "jtag newtap auto0 tap -expected-id 0x2b900f0f ..."
3990 AUTO auto1.tap - use "jtag newtap auto1 tap -expected-id 0x07926001 ..."
3991 AUTO auto2.tap - use "jtag newtap auto2 tap -expected-id 0x0b73b02f ..."
3992 AUTO auto0.tap - use "... -irlen 4"
3993 AUTO auto1.tap - use "... -irlen 4"
3994 AUTO auto2.tap - use "... -irlen 6"
3995 no gdb ports allocated as no target has been specified
3996 @end example
3998 Given that information, you should be able to either find some existing
3999 config files to use, or create your own. If you create your own, you
4000 would configure from the bottom up: first a @file{target.cfg} file
4001 with these TAPs, any targets associated with them, and any on-chip
4002 resources; then a @file{board.cfg} with off-chip resources, clocking,
4003 and so forth.
4005 @node CPU Configuration
4006 @chapter CPU Configuration
4007 @cindex GDB target
4009 This chapter discusses how to set up GDB debug targets for CPUs.
4010 You can also access these targets without GDB
4011 (@pxref{Architecture and Core Commands},
4012 and @ref{targetstatehandling,,Target State handling}) and
4013 through various kinds of NAND and NOR flash commands.
4014 If you have multiple CPUs you can have multiple such targets.
4016 We'll start by looking at how to examine the targets you have,
4017 then look at how to add one more target and how to configure it.
4019 @section Target List
4020 @cindex target, current
4021 @cindex target, list
4023 All targets that have been set up are part of a list,
4024 where each member has a name.
4025 That name should normally be the same as the TAP name.
4026 You can display the list with the @command{targets}
4027 (plural!) command.
4028 This display often has only one CPU; here's what it might
4029 look like with more than one:
4030 @verbatim
4031     TargetName         Type       Endian TapName            State
4032 --  ------------------ ---------- ------ ------------------ ------------
4033  0* at91rm9200.cpu     arm920t    little at91rm9200.cpu     running
4034  1  MyTarget           cortex_m   little mychip.foo         tap-disabled
4035 @end verbatim
4037 One member of that list is the @dfn{current target}, which
4038 is implicitly referenced by many commands.
4039 It's the one marked with a @code{*} near the target name.
4040 In particular, memory addresses often refer to the address
4041 space seen by that current target.
4042 Commands like @command{mdw} (memory display words)
4043 and @command{flash erase_address} (erase NOR flash blocks)
4044 are examples; and there are many more.
4046 Several commands let you examine the list of targets:
4048 @deffn Command {target current}
4049 Returns the name of the current target.
4050 @end deffn
4052 @deffn Command {target names}
4053 Lists the names of all current targets in the list.
4054 @example
4055 foreach t [target names] @{
4056     puts [format "Target: %s\n" $t]
4058 @end example
4059 @end deffn
4061 @c yep, "target list" would have been better.
4062 @c plus maybe "target setdefault".
4064 @deffn Command targets [name]
4065 @emph{Note: the name of this command is plural. Other target
4066 command names are singular.}
4068 With no parameter, this command displays a table of all known
4069 targets in a user friendly form.
4071 With a parameter, this command sets the current target to
4072 the given target with the given @var{name}; this is
4073 only relevant on boards which have more than one target.
4074 @end deffn
4076 @section Target CPU Types
4077 @cindex target type
4078 @cindex CPU type
4080 Each target has a @dfn{CPU type}, as shown in the output of
4081 the @command{targets} command. You need to specify that type
4082 when calling @command{target create}.
4083 The CPU type indicates more than just the instruction set.
4084 It also indicates how that instruction set is implemented,
4085 what kind of debug support it integrates,
4086 whether it has an MMU (and if so, what kind),
4087 what core-specific commands may be available
4088 (@pxref{Architecture and Core Commands}),
4089 and more.
4091 It's easy to see what target types are supported,
4092 since there's a command to list them.
4094 @anchor{targettypes}
4095 @deffn Command {target types}
4096 Lists all supported target types.
4097 At this writing, the supported CPU types are:
4099 @itemize @bullet
4100 @item @code{arm11} -- this is a generation of ARMv6 cores
4101 @item @code{arm720t} -- this is an ARMv4 core with an MMU
4102 @item @code{arm7tdmi} -- this is an ARMv4 core
4103 @item @code{arm920t} -- this is an ARMv4 core with an MMU
4104 @item @code{arm926ejs} -- this is an ARMv5 core with an MMU
4105 @item @code{arm966e} -- this is an ARMv5 core
4106 @item @code{arm9tdmi} -- this is an ARMv4 core
4107 @item @code{avr} -- implements Atmel's 8-bit AVR instruction set.
4108 (Support for this is preliminary and incomplete.)
4109 @item @code{cortex_a} -- this is an ARMv7 core with an MMU
4110 @item @code{cortex_m} -- this is an ARMv7 core, supporting only the
4111 compact Thumb2 instruction set.
4112 @item @code{aarch64} -- this is an ARMv8-A core with an MMU
4113 @item @code{dragonite} -- resembles arm966e
4114 @item @code{dsp563xx} -- implements Freescale's 24-bit DSP.
4115 (Support for this is still incomplete.)
4116 @item @code{fa526} -- resembles arm920 (w/o Thumb)
4117 @item @code{feroceon} -- resembles arm926
4118 @item @code{mips_m4k} -- a MIPS core
4119 @item @code{xscale} -- this is actually an architecture,
4120 not a CPU type. It is based on the ARMv5 architecture.
4121 @item @code{openrisc} -- this is an OpenRISC 1000 core.
4122 The current implementation supports three JTAG TAP cores:
4123 @item @code{ls1_sap} -- this is the SAP on NXP LS102x CPUs,
4124 allowing access to physical memory addresses independently of CPU cores.
4125 @itemize @minus
4126 @item @code{OpenCores TAP} (See: @url{http://opencores.org/project,jtag})
4127 @item @code{Altera Virtual JTAG TAP} (See: @url{http://www.altera.com/literature/ug/ug_virtualjtag.pdf})
4128 @item @code{Xilinx BSCAN_* virtual JTAG interface} (See: @url{http://www.xilinx.com/support/documentation/sw_manuals/xilinx14_2/spartan6_hdl.pdf})
4129 @end itemize
4130 And two debug interfaces cores:
4131 @itemize @minus
4132 @item @code{Advanced debug interface} (See: @url{http://opencores.org/project,adv_debug_sys})
4133 @item @code{SoC Debug Interface} (See: @url{http://opencores.org/project,dbg_interface})
4134 @end itemize
4135 @end itemize
4136 @end deffn
4138 To avoid being confused by the variety of ARM based cores, remember
4139 this key point: @emph{ARM is a technology licencing company}.
4140 (See: @url{http://www.arm.com}.)
4141 The CPU name used by OpenOCD will reflect the CPU design that was
4142 licenced, not a vendor brand which incorporates that design.
4143 Name prefixes like arm7, arm9, arm11, and cortex
4144 reflect design generations;
4145 while names like ARMv4, ARMv5, ARMv6, ARMv7 and ARMv8
4146 reflect an architecture version implemented by a CPU design.
4148 @anchor{targetconfiguration}
4149 @section Target Configuration
4151 Before creating a ``target'', you must have added its TAP to the scan chain.
4152 When you've added that TAP, you will have a @code{dotted.name}
4153 which is used to set up the CPU support.
4154 The chip-specific configuration file will normally configure its CPU(s)
4155 right after it adds all of the chip's TAPs to the scan chain.
4157 Although you can set up a target in one step, it's often clearer if you
4158 use shorter commands and do it in two steps: create it, then configure
4159 optional parts.
4160 All operations on the target after it's created will use a new
4161 command, created as part of target creation.
4163 The two main things to configure after target creation are
4164 a work area, which usually has target-specific defaults even
4165 if the board setup code overrides them later;
4166 and event handlers (@pxref{targetevents,,Target Events}), which tend
4167 to be much more board-specific.
4168 The key steps you use might look something like this
4170 @example
4171 target create MyTarget cortex_m -chain-position mychip.cpu
4172 $MyTarget configure -work-area-phys 0x08000 -work-area-size 8096
4173 $MyTarget configure -event reset-deassert-pre @{ jtag_rclk 5 @}
4174 $MyTarget configure -event reset-init @{ myboard_reinit @}
4175 @end example
4177 You should specify a working area if you can; typically it uses some
4178 on-chip SRAM.
4179 Such a working area can speed up many things, including bulk
4180 writes to target memory;
4181 flash operations like checking to see if memory needs to be erased;
4182 GDB memory checksumming;
4183 and more.
4185 @quotation Warning
4186 On more complex chips, the work area can become
4187 inaccessible when application code
4188 (such as an operating system)
4189 enables or disables the MMU.
4190 For example, the particular MMU context used to acess the virtual
4191 address will probably matter ... and that context might not have
4192 easy access to other addresses needed.
4193 At this writing, OpenOCD doesn't have much MMU intelligence.
4194 @end quotation
4196 It's often very useful to define a @code{reset-init} event handler.
4197 For systems that are normally used with a boot loader,
4198 common tasks include updating clocks and initializing memory
4199 controllers.
4200 That may be needed to let you write the boot loader into flash,
4201 in order to ``de-brick'' your board; or to load programs into
4202 external DDR memory without having run the boot loader.
4204 @deffn Command {target create} target_name type configparams...
4205 This command creates a GDB debug target that refers to a specific JTAG tap.
4206 It enters that target into a list, and creates a new
4207 command (@command{@var{target_name}}) which is used for various
4208 purposes including additional configuration.
4210 @itemize @bullet
4211 @item @var{target_name} ... is the name of the debug target.
4212 By convention this should be the same as the @emph{dotted.name}
4213 of the TAP associated with this target, which must be specified here
4214 using the @code{-chain-position @var{dotted.name}} configparam.
4216 This name is also used to create the target object command,
4217 referred to here as @command{$target_name},
4218 and in other places the target needs to be identified.
4219 @item @var{type} ... specifies the target type. @xref{targettypes,,target types}.
4220 @item @var{configparams} ... all parameters accepted by
4221 @command{$target_name configure} are permitted.
4222 If the target is big-endian, set it here with @code{-endian big}.
4224 You @emph{must} set the @code{-chain-position @var{dotted.name}} here.
4225 @end itemize
4226 @end deffn
4228 @deffn Command {$target_name configure} configparams...
4229 The options accepted by this command may also be
4230 specified as parameters to @command{target create}.
4231 Their values can later be queried one at a time by
4232 using the @command{$target_name cget} command.
4234 @emph{Warning:} changing some of these after setup is dangerous.
4235 For example, moving a target from one TAP to another;
4236 and changing its endianness.
4238 @itemize @bullet
4240 @item @code{-chain-position} @var{dotted.name} -- names the TAP
4241 used to access this target.
4243 @item @code{-endian} (@option{big}|@option{little}) -- specifies
4244 whether the CPU uses big or little endian conventions
4246 @item @code{-event} @var{event_name} @var{event_body} --
4247 @xref{targetevents,,Target Events}.
4248 Note that this updates a list of named event handlers.
4249 Calling this twice with two different event names assigns
4250 two different handlers, but calling it twice with the
4251 same event name assigns only one handler.
4253 Current target is temporarily overridden to the event issuing target
4254 before handler code starts and switched back after handler is done.
4256 @item @code{-work-area-backup} (@option{0}|@option{1}) -- says
4257 whether the work area gets backed up; by default,
4258 @emph{it is not backed up.}
4259 When possible, use a working_area that doesn't need to be backed up,
4260 since performing a backup slows down operations.
4261 For example, the beginning of an SRAM block is likely to
4262 be used by most build systems, but the end is often unused.
4264 @item @code{-work-area-size} @var{size} -- specify work are size,
4265 in bytes. The same size applies regardless of whether its physical
4266 or virtual address is being used.
4268 @item @code{-work-area-phys} @var{address} -- set the work area
4269 base @var{address} to be used when no MMU is active.
4271 @item @code{-work-area-virt} @var{address} -- set the work area
4272 base @var{address} to be used when an MMU is active.
4273 @emph{Do not specify a value for this except on targets with an MMU.}
4274 The value should normally correspond to a static mapping for the
4275 @code{-work-area-phys} address, set up by the current operating system.
4277 @anchor{rtostype}
4278 @item @code{-rtos} @var{rtos_type} -- enable rtos support for target,
4279 @var{rtos_type} can be one of @option{auto}, @option{eCos},
4280 @option{ThreadX}, @option{FreeRTOS}, @option{linux}, @option{ChibiOS},
4281 @option{embKernel}, @option{mqx}, @option{uCOS-III}
4282 @xref{gdbrtossupport,,RTOS Support}.
4284 @item @code{-defer-examine} -- skip target examination at initial JTAG chain
4285 scan and after a reset. A manual call to arp_examine is required to
4286 access the target for debugging.
4288 @item @code{-ap-num} @var{ap_number} -- set DAP access port for target,
4289 @var{ap_number} is the numeric index of the DAP AP the target is connected to.
4290 Use this option with systems where multiple, independent cores are connected
4291 to separate access ports of the same DAP.
4293 @item @code{-ctibase} @var{address} -- set base address of Cross-Trigger interface (CTI) connected
4294 to the target. Currently, only the @code{aarch64} target makes use of this option, where it is
4295 a mandatory configuration for the target run control.
4296 @end itemize
4297 @end deffn
4299 @section Other $target_name Commands
4300 @cindex object command
4302 The Tcl/Tk language has the concept of object commands,
4303 and OpenOCD adopts that same model for targets.
4305 A good Tk example is a on screen button.
4306 Once a button is created a button
4307 has a name (a path in Tk terms) and that name is useable as a first
4308 class command. For example in Tk, one can create a button and later
4309 configure it like this:
4311 @example
4312 # Create
4313 button .foobar -background red -command @{ foo @}
4314 # Modify
4315 .foobar configure -foreground blue
4316 # Query
4317 set x [.foobar cget -background]
4318 # Report
4319 puts [format "The button is %s" $x]
4320 @end example
4322 In OpenOCD's terms, the ``target'' is an object just like a Tcl/Tk
4323 button, and its object commands are invoked the same way.
4325 @example
4326 str912.cpu    mww 0x1234 0x42
4327 omap3530.cpu  mww 0x5555 123
4328 @end example
4330 The commands supported by OpenOCD target objects are:
4332 @deffn Command {$target_name arp_examine} @option{allow-defer}
4333 @deffnx Command {$target_name arp_halt}
4334 @deffnx Command {$target_name arp_poll}
4335 @deffnx Command {$target_name arp_reset}
4336 @deffnx Command {$target_name arp_waitstate}
4337 Internal OpenOCD scripts (most notably @file{startup.tcl})
4338 use these to deal with specific reset cases.
4339 They are not otherwise documented here.
4340 @end deffn
4342 @deffn Command {$target_name array2mem} arrayname width address count
4343 @deffnx Command {$target_name mem2array} arrayname width address count
4344 These provide an efficient script-oriented interface to memory.
4345 The @code{array2mem} primitive writes bytes, halfwords, or words;
4346 while @code{mem2array} reads them.
4347 In both cases, the TCL side uses an array, and
4348 the target side uses raw memory.
4350 The efficiency comes from enabling the use of
4351 bulk JTAG data transfer operations.
4352 The script orientation comes from working with data
4353 values that are packaged for use by TCL scripts;
4354 @command{mdw} type primitives only print data they retrieve,
4355 and neither store nor return those values.
4357 @itemize
4358 @item @var{arrayname} ... is the name of an array variable
4359 @item @var{width} ... is 8/16/32 - indicating the memory access size
4360 @item @var{address} ... is the target memory address
4361 @item @var{count} ... is the number of elements to process
4362 @end itemize
4363 @end deffn
4365 @deffn Command {$target_name cget} queryparm
4366 Each configuration parameter accepted by
4367 @command{$target_name configure}
4368 can be individually queried, to return its current value.
4369 The @var{queryparm} is a parameter name
4370 accepted by that command, such as @code{-work-area-phys}.
4371 There are a few special cases:
4373 @itemize @bullet
4374 @item @code{-event} @var{event_name} -- returns the handler for the
4375 event named @var{event_name}.
4376 This is a special case because setting a handler requires
4377 two parameters.
4378 @item @code{-type} -- returns the target type.
4379 This is a special case because this is set using
4380 @command{target create} and can't be changed
4381 using @command{$target_name configure}.
4382 @end itemize
4384 For example, if you wanted to summarize information about
4385 all the targets you might use something like this:
4387 @example
4388 foreach name [target names] @{
4389     set y [$name cget -endian]
4390     set z [$name cget -type]
4391     puts [format "Chip %d is %s, Endian: %s, type: %s" \
4392                  $x $name $y $z]
4394 @end example
4395 @end deffn
4397 @anchor{targetcurstate}
4398 @deffn Command {$target_name curstate}
4399 Displays the current target state:
4400 @code{debug-running},
4401 @code{halted},
4402 @code{reset},
4403 @code{running}, or @code{unknown}.
4404 (Also, @pxref{eventpolling,,Event Polling}.)
4405 @end deffn
4407 @deffn Command {$target_name eventlist}
4408 Displays a table listing all event handlers
4409 currently associated with this target.
4410 @xref{targetevents,,Target Events}.
4411 @end deffn
4413 @deffn Command {$target_name invoke-event} event_name
4414 Invokes the handler for the event named @var{event_name}.
4415 (This is primarily intended for use by OpenOCD framework
4416 code, for example by the reset code in @file{startup.tcl}.)
4417 @end deffn
4419 @deffn Command {$target_name mdw} addr [count]
4420 @deffnx Command {$target_name mdh} addr [count]
4421 @deffnx Command {$target_name mdb} addr [count]
4422 Display contents of address @var{addr}, as
4423 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
4424 or 8-bit bytes (@command{mdb}).
4425 If @var{count} is specified, displays that many units.
4426 (If you want to manipulate the data instead of displaying it,
4427 see the @code{mem2array} primitives.)
4428 @end deffn
4430 @deffn Command {$target_name mww} addr word
4431 @deffnx Command {$target_name mwh} addr halfword
4432 @deffnx Command {$target_name mwb} addr byte
4433 Writes the specified @var{word} (32 bits),
4434 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
4435 at the specified address @var{addr}.
4436 @end deffn
4438 @anchor{targetevents}
4439 @section Target Events
4440 @cindex target events
4441 @cindex events
4442 At various times, certain things can happen, or you want them to happen.
4443 For example:
4444 @itemize @bullet
4445 @item What should happen when GDB connects? Should your target reset?
4446 @item When GDB tries to flash the target, do you need to enable the flash via a special command?
4447 @item Is using SRST appropriate (and possible) on your system?
4448 Or instead of that, do you need to issue JTAG commands to trigger reset?
4449 SRST usually resets everything on the scan chain, which can be inappropriate.
4450 @item During reset, do you need to write to certain memory locations
4451 to set up system clocks or
4452 to reconfigure the SDRAM?
4453 How about configuring the watchdog timer, or other peripherals,
4454 to stop running while you hold the core stopped for debugging?
4455 @end itemize
4457 All of the above items can be addressed by target event handlers.
4458 These are set up by @command{$target_name configure -event} or
4459 @command{target create ... -event}.
4461 The programmer's model matches the @code{-command} option used in Tcl/Tk
4462 buttons and events. The two examples below act the same, but one creates
4463 and invokes a small procedure while the other inlines it.
4465 @example
4466 proc my_init_proc @{ @} @{
4467     echo "Disabling watchdog..."
4468     mww 0xfffffd44 0x00008000
4470 mychip.cpu configure -event reset-init my_init_proc
4471 mychip.cpu configure -event reset-init @{
4472     echo "Disabling watchdog..."
4473     mww 0xfffffd44 0x00008000
4475 @end example
4477 The following target events are defined:
4479 @itemize @bullet
4480 @item @b{debug-halted}
4481 @* The target has halted for debug reasons (i.e.: breakpoint)
4482 @item @b{debug-resumed}
4483 @* The target has resumed (i.e.: GDB said run)
4484 @item @b{early-halted}
4485 @* Occurs early in the halt process
4486 @item @b{examine-start}
4487 @* Before target examine is called.
4488 @item @b{examine-end}
4489 @* After target examine is called with no errors.
4490 @item @b{gdb-attach}
4491 @* When GDB connects. Issued before any GDB communication with the target
4492 starts. GDB expects the target is halted during attachment.
4493 @xref{gdbmeminspect,,GDB as a non-intrusive memory inspector}, how to
4494 connect GDB to running target.
4495 The event can be also used to set up the target so it is possible to probe flash.
4496 Probing flash is necessary during GDB connect if you want to use
4497 @pxref{programmingusinggdb,,programming using GDB}.
4498 Another use of the flash memory map is for GDB to automatically choose
4499 hardware or software breakpoints depending on whether the breakpoint
4500 is in RAM or read only memory.
4501 Default is @code{halt}
4502 @item @b{gdb-detach}
4503 @* When GDB disconnects
4504 @item @b{gdb-end}
4505 @* When the target has halted and GDB is not doing anything (see early halt)
4506 @item @b{gdb-flash-erase-start}
4507 @* Before the GDB flash process tries to erase the flash (default is
4508 @code{reset init})
4509 @item @b{gdb-flash-erase-end}
4510 @* After the GDB flash process has finished erasing the flash
4511 @item @b{gdb-flash-write-start}
4512 @* Before GDB writes to the flash
4513 @item @b{gdb-flash-write-end}
4514 @* After GDB writes to the flash (default is @code{reset halt})
4515 @item @b{gdb-start}
4516 @* Before the target steps, GDB is trying to start/resume the target
4517 @item @b{halted}
4518 @* The target has halted
4519 @item @b{reset-assert-pre}
4520 @* Issued as part of @command{reset} processing
4521 after @command{reset-start} was triggered
4522 but before either SRST alone is asserted on the scan chain,
4523 or @code{reset-assert} is triggered.
4524 @item @b{reset-assert}
4525 @* Issued as part of @command{reset} processing
4526 after @command{reset-assert-pre} was triggered.
4527 When such a handler is present, cores which support this event will use
4528 it instead of asserting SRST.
4529 This support is essential for debugging with JTAG interfaces which
4530 don't include an SRST line (JTAG doesn't require SRST), and for
4531 selective reset on scan chains that have multiple targets.
4532 @item @b{reset-assert-post}
4533 @* Issued as part of @command{reset} processing
4534 after @code{reset-assert} has been triggered.
4535 or the target asserted SRST on the entire scan chain.
4536 @item @b{reset-deassert-pre}
4537 @* Issued as part of @command{reset} processing
4538 after @code{reset-assert-post} has been triggered.
4539 @item @b{reset-deassert-post}
4540 @* Issued as part of @command{reset} processing
4541 after @code{reset-deassert-pre} has been triggered
4542 and (if the target is using it) after SRST has been
4543 released on the scan chain.
4544 @item @b{reset-end}
4545 @* Issued as the final step in @command{reset} processing.
4546 @item @b{reset-init}
4547 @* Used by @b{reset init} command for board-specific initialization.
4548 This event fires after @emph{reset-deassert-post}.
4550 This is where you would configure PLLs and clocking, set up DRAM so
4551 you can download programs that don't fit in on-chip SRAM, set up pin
4552 multiplexing, and so on.
4553 (You may be able to switch to a fast JTAG clock rate here, after
4554 the target clocks are fully set up.)
4555 @item @b{reset-start}
4556 @* Issued as the first step in @command{reset} processing
4557 before @command{reset-assert-pre} is called.
4559 This is the most robust place to use @command{jtag_rclk}
4560 or @command{adapter_khz} to switch to a low JTAG clock rate,
4561 when reset disables PLLs needed to use a fast clock.
4562 @item @b{resume-start}
4563 @* Before any target is resumed
4564 @item @b{resume-end}
4565 @* After all targets have resumed
4566 @item @b{resumed}
4567 @* Target has resumed
4568 @item @b{trace-config}
4569 @* After target hardware trace configuration was changed
4570 @end itemize
4572 @node Flash Commands
4573 @chapter Flash Commands
4575 OpenOCD has different commands for NOR and NAND flash;
4576 the ``flash'' command works with NOR flash, while
4577 the ``nand'' command works with NAND flash.
4578 This partially reflects different hardware technologies:
4579 NOR flash usually supports direct CPU instruction and data bus access,
4580 while data from a NAND flash must be copied to memory before it can be
4581 used. (SPI flash must also be copied to memory before use.)
4582 However, the documentation also uses ``flash'' as a generic term;
4583 for example, ``Put flash configuration in board-specific files''.
4585 Flash Steps:
4586 @enumerate
4587 @item Configure via the command @command{flash bank}
4588 @* Do this in a board-specific configuration file,
4589 passing parameters as needed by the driver.
4590 @item Operate on the flash via @command{flash subcommand}
4591 @* Often commands to manipulate the flash are typed by a human, or run
4592 via a script in some automated way. Common tasks include writing a
4593 boot loader, operating system, or other data.
4594 @item GDB Flashing
4595 @* Flashing via GDB requires the flash be configured via ``flash
4596 bank'', and the GDB flash features be enabled.
4597 @xref{gdbconfiguration,,GDB Configuration}.
4598 @end enumerate
4600 Many CPUs have the ablity to ``boot'' from the first flash bank.
4601 This means that misprogramming that bank can ``brick'' a system,
4602 so that it can't boot.
4603 JTAG tools, like OpenOCD, are often then used to ``de-brick'' the
4604 board by (re)installing working boot firmware.
4606 @anchor{norconfiguration}
4607 @section Flash Configuration Commands
4608 @cindex flash configuration
4610 @deffn {Config Command} {flash bank} name driver base size chip_width bus_width target [driver_options]
4611 Configures a flash bank which provides persistent storage
4612 for addresses from @math{base} to @math{base + size - 1}.
4613 These banks will often be visible to GDB through the target's memory map.
4614 In some cases, configuring a flash bank will activate extra commands;
4615 see the driver-specific documentation.
4617 @itemize @bullet
4618 @item @var{name} ... may be used to reference the flash bank
4619 in other flash commands. A number is also available.
4620 @item @var{driver} ... identifies the controller driver
4621 associated with the flash bank being declared.
4622 This is usually @code{cfi} for external flash, or else
4623 the name of a microcontroller with embedded flash memory.
4624 @xref{flashdriverlist,,Flash Driver List}.
4625 @item @var{base} ... Base address of the flash chip.
4626 @item @var{size} ... Size of the chip, in bytes.
4627 For some drivers, this value is detected from the hardware.
4628 @item @var{chip_width} ... Width of the flash chip, in bytes;
4629 ignored for most microcontroller drivers.
4630 @item @var{bus_width} ... Width of the data bus used to access the
4631 chip, in bytes; ignored for most microcontroller drivers.
4632 @item @var{target} ... Names the target used to issue
4633 commands to the flash controller.
4634 @comment Actually, it's currently a controller-specific parameter...
4635 @item @var{driver_options} ... drivers may support, or require,
4636 additional parameters. See the driver-specific documentation
4637 for more information.
4638 @end itemize
4639 @quotation Note
4640 This command is not available after OpenOCD initialization has completed.
4641 Use it in board specific configuration files, not interactively.
4642 @end quotation
4643 @end deffn
4645 @comment the REAL name for this command is "ocd_flash_banks"
4646 @comment less confusing would be: "flash list" (like "nand list")
4647 @deffn Command {flash banks}
4648 Prints a one-line summary of each device that was
4649 declared using @command{flash bank}, numbered from zero.
4650 Note that this is the @emph{plural} form;
4651 the @emph{singular} form is a very different command.
4652 @end deffn
4654 @deffn Command {flash list}
4655 Retrieves a list of associative arrays for each device that was
4656 declared using @command{flash bank}, numbered from zero.
4657 This returned list can be manipulated easily from within scripts.
4658 @end deffn
4660 @deffn Command {flash probe} num
4661 Identify the flash, or validate the parameters of the configured flash. Operation
4662 depends on the flash type.
4663 The @var{num} parameter is a value shown by @command{flash banks}.
4664 Most flash commands will implicitly @emph{autoprobe} the bank;
4665 flash drivers can distinguish between probing and autoprobing,
4666 but most don't bother.
4667 @end deffn
4669 @section Erasing, Reading, Writing to Flash
4670 @cindex flash erasing
4671 @cindex flash reading
4672 @cindex flash writing
4673 @cindex flash programming
4674 @anchor{flashprogrammingcommands}
4676 One feature distinguishing NOR flash from NAND or serial flash technologies
4677 is that for read access, it acts exactly like any other addressible memory.
4678 This means you can use normal memory read commands like @command{mdw} or
4679 @command{dump_image} with it, with no special @command{flash} subcommands.
4680 @xref{memoryaccess,,Memory access}, and @ref{imageaccess,,Image access}.
4682 Write access works differently. Flash memory normally needs to be erased
4683 before it's written. Erasing a sector turns all of its bits to ones, and
4684 writing can turn ones into zeroes. This is why there are special commands
4685 for interactive erasing and writing, and why GDB needs to know which parts
4686 of the address space hold NOR flash memory.
4688 @quotation Note
4689 Most of these erase and write commands leverage the fact that NOR flash
4690 chips consume target address space. They implicitly refer to the current
4691 JTAG target, and map from an address in that target's address space
4692 back to a flash bank.
4693 @comment In May 2009, those mappings may fail if any bank associated
4694 @comment with that target doesn't succesfuly autoprobe ... bug worth fixing?
4695 A few commands use abstract addressing based on bank and sector numbers,
4696 and don't depend on searching the current target and its address space.
4697 Avoid confusing the two command models.
4698 @end quotation
4700 Some flash chips implement software protection against accidental writes,
4701 since such buggy writes could in some cases ``brick'' a system.
4702 For such systems, erasing and writing may require sector protection to be
4703 disabled first.
4704 Examples include CFI flash such as ``Intel Advanced Bootblock flash'',
4705 and AT91SAM7 on-chip flash.
4706 @xref{flashprotect,,flash protect}.
4708 @deffn Command {flash erase_sector} num first last
4709 Erase sectors in bank @var{num}, starting at sector @var{first}
4710 up to and including @var{last}.
4711 Sector numbering starts at 0.
4712 Providing a @var{last} sector of @option{last}
4713 specifies "to the end of the flash bank".
4714 The @var{num} parameter is a value shown by @command{flash banks}.
4715 @end deffn
4717 @deffn Command {flash erase_address} [@option{pad}] [@option{unlock}] address length
4718 Erase sectors starting at @var{address} for @var{length} bytes.
4719 Unless @option{pad} is specified, @math{address} must begin a
4720 flash sector, and @math{address + length - 1} must end a sector.
4721 Specifying @option{pad} erases extra data at the beginning and/or
4722 end of the specified region, as needed to erase only full sectors.
4723 The flash bank to use is inferred from the @var{address}, and
4724 the specified length must stay within that bank.
4725 As a special case, when @var{length} is zero and @var{address} is
4726 the start of the bank, the whole flash is erased.
4727 If @option{unlock} is specified, then the flash is unprotected
4728 before erase starts.
4729 @end deffn
4731 @deffn Command {flash fillw} address word length
4732 @deffnx Command {flash fillh} address halfword length
4733 @deffnx Command {flash fillb} address byte length
4734 Fills flash memory with the specified @var{word} (32 bits),
4735 @var{halfword} (16 bits), or @var{byte} (8-bit) pattern,
4736 starting at @var{address} and continuing
4737 for @var{length} units (word/halfword/byte).
4738 No erasure is done before writing; when needed, that must be done
4739 before issuing this command.
4740 Writes are done in blocks of up to 1024 bytes, and each write is
4741 verified by reading back the data and comparing it to what was written.
4742 The flash bank to use is inferred from the @var{address} of
4743 each block, and the specified length must stay within that bank.
4744 @end deffn
4745 @comment no current checks for errors if fill blocks touch multiple banks!
4747 @deffn Command {flash write_bank} num filename [offset]
4748 Write the binary @file{filename} to flash bank @var{num},
4749 starting at @var{offset} bytes from the beginning of the bank. If @var{offset}
4750 is omitted, start at the beginning of the flash bank.
4751 The @var{num} parameter is a value shown by @command{flash banks}.
4752 @end deffn
4754 @deffn Command {flash read_bank} num filename [offset [length]]
4755 Read @var{length} bytes from the flash bank @var{num} starting at @var{offset}
4756 and write the contents to the binary @file{filename}. If @var{offset} is
4757 omitted, start at the beginning of the flash bank. If @var{length} is omitted,
4758 read the remaining bytes from the flash bank.
4759 The @var{num} parameter is a value shown by @command{flash banks}.
4760 @end deffn
4762 @deffn Command {flash verify_bank} num filename [offset]
4763 Compare the contents of the binary file @var{filename} with the contents of the
4764 flash bank @var{num} starting at @var{offset}. If @var{offset} is omitted,
4765 start at the beginning of the flash bank. Fail if the contents do not match.
4766 The @var{num} parameter is a value shown by @command{flash banks}.
4767 @end deffn
4769 @deffn Command {flash write_image} [erase] [unlock] filename [offset] [type]
4770 Write the image @file{filename} to the current target's flash bank(s).
4771 Only loadable sections from the image are written.
4772 A relocation @var{offset} may be specified, in which case it is added
4773 to the base address for each section in the image.
4774 The file [@var{type}] can be specified
4775 explicitly as @option{bin} (binary), @option{ihex} (Intel hex),
4776 @option{elf} (ELF file), @option{s19} (Motorola s19).
4777 @option{mem}, or @option{builder}.
4778 The relevant flash sectors will be erased prior to programming
4779 if the @option{erase} parameter is given. If @option{unlock} is
4780 provided, then the flash banks are unlocked before erase and
4781 program. The flash bank to use is inferred from the address of
4782 each image section.
4784 @quotation Warning
4785 Be careful using the @option{erase} flag when the flash is holding
4786 data you want to preserve.
4787 Portions of the flash outside those described in the image's
4788 sections might be erased with no notice.
4789 @itemize
4790 @item
4791 When a section of the image being written does not fill out all the
4792 sectors it uses, the unwritten parts of those sectors are necessarily
4793 also erased, because sectors can't be partially erased.
4794 @item
4795 Data stored in sector "holes" between image sections are also affected.
4796 For example, "@command{flash write_image erase ...}" of an image with
4797 one byte at the beginning of a flash bank and one byte at the end
4798 erases the entire bank -- not just the two sectors being written.
4799 @end itemize
4800 Also, when flash protection is important, you must re-apply it after
4801 it has been removed by the @option{unlock} flag.
4802 @end quotation
4804 @end deffn
4806 @section Other Flash commands
4807 @cindex flash protection
4809 @deffn Command {flash erase_check} num
4810 Check erase state of sectors in flash bank @var{num},
4811 and display that status.
4812 The @var{num} parameter is a value shown by @command{flash banks}.
4813 @end deffn
4815 @deffn Command {flash info} num [sectors]
4816 Print info about flash bank @var{num}, a list of protection blocks
4817 and their status. Use @option{sectors} to show a list of sectors instead.
4819 The @var{num} parameter is a value shown by @command{flash banks}.
4820 This command will first query the hardware, it does not print cached
4821 and possibly stale information.
4822 @end deffn
4824 @anchor{flashprotect}
4825 @deffn Command {flash protect} num first last (@option{on}|@option{off})
4826 Enable (@option{on}) or disable (@option{off}) protection of flash blocks
4827 in flash bank @var{num}, starting at protection block @var{first}
4828 and continuing up to and including @var{last}.
4829 Providing a @var{last} block of @option{last}
4830 specifies "to the end of the flash bank".
4831 The @var{num} parameter is a value shown by @command{flash banks}.
4832 The protection block is usually identical to a flash sector.
4833 Some devices may utilize a protection block distinct from flash sector.
4834 See @command{flash info} for a list of protection blocks.
4835 @end deffn
4837 @deffn Command {flash padded_value} num value
4838 Sets the default value used for padding any image sections, This should
4839 normally match the flash bank erased value. If not specified by this
4840 comamnd or the flash driver then it defaults to 0xff.
4841 @end deffn
4843 @anchor{program}
4844 @deffn Command {program} filename [verify] [reset] [exit] [offset]
4845 This is a helper script that simplifies using OpenOCD as a standalone
4846 programmer. The only required parameter is @option{filename}, the others are optional.
4847 @xref{Flash Programming}.
4848 @end deffn
4850 @anchor{flashdriverlist}
4851 @section Flash Driver List
4852 As noted above, the @command{flash bank} command requires a driver name,
4853 and allows driver-specific options and behaviors.
4854 Some drivers also activate driver-specific commands.
4856 @deffn {Flash Driver} virtual
4857 This is a special driver that maps a previously defined bank to another
4858 address. All bank settings will be copied from the master physical bank.
4860 The @var{virtual} driver defines one mandatory parameters,
4862 @itemize
4863 @item @var{master_bank} The bank that this virtual address refers to.
4864 @end itemize
4866 So in the following example addresses 0xbfc00000 and 0x9fc00000 refer to
4867 the flash bank defined at address 0x1fc00000. Any cmds executed on
4868 the virtual banks are actually performed on the physical banks.
4869 @example
4870 flash bank $_FLASHNAME pic32mx 0x1fc00000 0 0 0 $_TARGETNAME
4871 flash bank vbank0 virtual 0xbfc00000 0 0 0 \
4872            $_TARGETNAME $_FLASHNAME
4873 flash bank vbank1 virtual 0x9fc00000 0 0 0 \
4874            $_TARGETNAME $_FLASHNAME
4875 @end example
4876 @end deffn
4878 @subsection External Flash
4880 @deffn {Flash Driver} cfi
4881 @cindex Common Flash Interface
4882 @cindex CFI
4883 The ``Common Flash Interface'' (CFI) is the main standard for
4884 external NOR flash chips, each of which connects to a
4885 specific external chip select on the CPU.
4886 Frequently the first such chip is used to boot the system.
4887 Your board's @code{reset-init} handler might need to
4888 configure additional chip selects using other commands (like: @command{mww} to
4889 configure a bus and its timings), or
4890 perhaps configure a GPIO pin that controls the ``write protect'' pin
4891 on the flash chip.
4892 The CFI driver can use a target-specific working area to significantly
4893 speed up operation.
4895 The CFI driver can accept the following optional parameters, in any order:
4897 @itemize
4898 @item @var{jedec_probe} ... is used to detect certain non-CFI flash ROMs,
4899 like AM29LV010 and similar types.
4900 @item @var{x16_as_x8} ... when a 16-bit flash is hooked up to an 8-bit bus.
4901 @item @var{bus_swap} ... when data bytes in a 16-bit flash needs to be swapped.
4902 @item @var{data_swap} ... when data bytes in a 16-bit flash needs to be
4903 swapped when writing data values (ie. not CFI commands).
4904 @end itemize
4906 To configure two adjacent banks of 16 MBytes each, both sixteen bits (two bytes)
4907 wide on a sixteen bit bus:
4909 @example
4910 flash bank $_FLASHNAME cfi 0x00000000 0x01000000 2 2 $_TARGETNAME
4911 flash bank $_FLASHNAME cfi 0x01000000 0x01000000 2 2 $_TARGETNAME
4912 @end example
4914 To configure one bank of 32 MBytes
4915 built from two sixteen bit (two byte) wide parts wired in parallel
4916 to create a thirty-two bit (four byte) bus with doubled throughput:
4918 @example
4919 flash bank $_FLASHNAME cfi 0x00000000 0x02000000 2 4 $_TARGETNAME
4920 @end example
4922 @c "cfi part_id" disabled
4923 @end deffn
4925 @deffn {Flash Driver} jtagspi
4926 @cindex Generic JTAG2SPI driver
4927 @cindex SPI
4928 @cindex jtagspi
4929 @cindex bscan_spi
4930 Several FPGAs and CPLDs can retrieve their configuration (bitstream) from a
4931 SPI flash connected to them. To access this flash from the host, the device
4932 is first programmed with a special proxy bitstream that
4933 exposes the SPI flash on the device's JTAG interface. The flash can then be
4934 accessed through JTAG.
4936 Since signaling between JTAG and SPI is compatible, all that is required for
4937 a proxy bitstream is to connect TDI-MOSI, TDO-MISO, TCK-CLK and activate
4938 the flash chip select when the JTAG state machine is in SHIFT-DR. Such
4939 a bitstream for several Xilinx FPGAs can be found in
4940 @file{contrib/loaders/flash/fpga/xilinx_bscan_spi.py}. It requires
4941 @uref{https://github.com/m-labs/migen, migen} and a Xilinx toolchain to build.
4943 This flash bank driver requires a target on a JTAG tap and will access that
4944 tap directly. Since no support from the target is needed, the target can be a
4945 "testee" dummy. Since the target does not expose the flash memory
4946 mapping, target commands that would otherwise be expected to access the flash
4947 will not work. These include all @command{*_image} and
4948 @command{$target_name m*} commands as well as @command{program}. Equivalent
4949 functionality is available through the @command{flash write_bank},
4950 @command{flash read_bank}, and @command{flash verify_bank} commands.
4952 @itemize
4953 @item @var{ir} ... is loaded into the JTAG IR to map the flash as the JTAG DR.
4954 For the bitstreams generated from @file{xilinx_bscan_spi.py} this is the
4955 @var{USER1} instruction.
4956 @end itemize
4958 @example
4959 target create $_TARGETNAME testee -chain-position $_CHIPNAME.fpga
4960 set _XILINX_USER1 0x02
4961 flash bank $_FLASHNAME spi 0x0 0 0 0 \
4962            $_TARGETNAME $_XILINX_USER1
4963 @end example
4964 @end deffn
4966 @deffn {Flash Driver} xcf
4967 @cindex Xilinx Platform flash driver
4968 @cindex xcf
4969 Xilinx FPGAs can be configured from specialized flash ICs named Platform Flash.
4970 It is (almost) regular NOR flash with erase sectors, program pages, etc. The
4971 only difference is special registers controlling its FPGA specific behavior.
4972 They must be properly configured for successful FPGA loading using
4973 additional @var{xcf} driver command:
4975 @deffn Command {xcf ccb} <bank_id>
4976 command accepts additional parameters:
4977 @itemize
4978 @item @var{external|internal} ... selects clock source.
4979 @item @var{serial|parallel} ... selects serial or parallel data bus mode.
4980 @item @var{slave|master} ... selects slave of master mode for flash device.
4981 @item @var{40|20} ... selects clock frequency in MHz for internal clock
4982 in master mode.
4983 @end itemize
4984 @example
4985 xcf ccb 0 external parallel slave 40
4986 @end example
4987 All of them must be specified even if clock frequency is pointless
4988 in slave mode. If only bank id specified than command prints current
4989 CCB register value. Note: there is no need to write this register
4990 every time you erase/program data sectors because it stores in
4991 dedicated sector.
4992 @end deffn
4994 @deffn Command {xcf configure} <bank_id>
4995 Initiates FPGA loading procedure. Useful if your board has no "configure"
4996 button.
4997 @example
4998 xcf configure 0
4999 @end example
5000 @end deffn
5002 Additional driver notes:
5003 @itemize
5004 @item Only single revision supported.
5005 @item Driver automatically detects need of bit reverse, but
5006 only "bin" (raw binary, do not confuse it with "bit") and "mcs"
5007 (Intel hex) file types supported.
5008 @item For additional info check xapp972.pdf and ug380.pdf.
5009 @end itemize
5010 @end deffn
5012 @deffn {Flash Driver} lpcspifi
5013 @cindex NXP SPI Flash Interface
5014 @cindex SPIFI
5015 @cindex lpcspifi
5016 NXP's LPC43xx and LPC18xx families include a proprietary SPI
5017 Flash Interface (SPIFI) peripheral that can drive and provide
5018 memory mapped access to external SPI flash devices.
5020 The lpcspifi driver initializes this interface and provides
5021 program and erase functionality for these serial flash devices.
5022 Use of this driver @b{requires} a working area of at least 1kB
5023 to be configured on the target device; more than this will
5024 significantly reduce flash programming times.
5026 The setup command only requires the @var{base} parameter. All
5027 other parameters are ignored, and the flash size and layout
5028 are configured by the driver.
5030 @example
5031 flash bank $_FLASHNAME lpcspifi 0x14000000 0 0 0 $_TARGETNAME
5032 @end example
5034 @end deffn
5036 @deffn {Flash Driver} stmsmi
5037 @cindex STMicroelectronics Serial Memory Interface
5038 @cindex SMI
5039 @cindex stmsmi
5040 Some devices form STMicroelectronics (e.g. STR75x MCU family,
5041 SPEAr MPU family) include a proprietary
5042 ``Serial Memory Interface'' (SMI) controller able to drive external
5043 SPI flash devices.
5044 Depending on specific device and board configuration, up to 4 external
5045 flash devices can be connected.
5047 SMI makes the flash content directly accessible in the CPU address
5048 space; each external device is mapped in a memory bank.
5049 CPU can directly read data, execute code and boot from SMI banks.
5050 Normal OpenOCD commands like @command{mdw} can be used to display
5051 the flash content.
5053 The setup command only requires the @var{base} parameter in order
5054 to identify the memory bank.
5055 All other parameters are ignored. Additional information, like
5056 flash size, are detected automatically.
5058 @example
5059 flash bank $_FLASHNAME stmsmi 0xf8000000 0 0 0 $_TARGETNAME
5060 @end example
5062 @end deffn
5064 @deffn {Flash Driver} mrvlqspi
5065 This driver supports QSPI flash controller of Marvell's Wireless
5066 Microcontroller platform.
5068 The flash size is autodetected based on the table of known JEDEC IDs
5069 hardcoded in the OpenOCD sources.
5071 @example
5072 flash bank $_FLASHNAME mrvlqspi 0x0 0 0 0 $_TARGETNAME 0x46010000
5073 @end example
5075 @end deffn
5077 @deffn {Flash Driver} ath79
5078 @cindex Atheros ath79 SPI driver
5079 @cindex ath79
5080 Members of ATH79 SoC family from Atheros include a SPI interface with 3
5081 chip selects.
5082 On reset a SPI flash connected to the first chip select (CS0) is made
5083 directly read-accessible in the CPU address space (up to 16MBytes)
5084 and is usually used to store the bootloader and operating system.
5085 Normal OpenOCD commands like @command{mdw} can be used to display
5086 the flash content while it is in memory-mapped mode (only the first
5087 4MBytes are accessible without additional configuration on reset).
5089 The setup command only requires the @var{base} parameter in order
5090 to identify the memory bank. The actual value for the base address
5091 is not otherwise used by the driver. However the mapping is passed
5092 to gdb. Thus for the memory mapped flash (chipselect CS0) the base
5093 address should be the actual memory mapped base address. For unmapped
5094 chipselects (CS1 and CS2) care should be taken to use a base address
5095 that does not overlap with real memory regions.
5096 Additional information, like flash size, are detected automatically.
5097 An optional additional parameter sets the chipselect for the bank,
5098 with the default CS0.
5099 CS1 and CS2 require additional GPIO setup before they can be used
5100 since the alternate function must be enabled on the GPIO pin
5101 CS1/CS2 is routed to on the given SoC.
5103 @example
5104 flash bank $_FLASHNAME ath79 0 0 0 0 $_TARGETNAME
5106 # When using multiple chipselects the base should be different for each,
5107 # otherwise the write_image command is not able to distinguish the
5108 # banks.
5109 flash bank flash0 ath79 0x00000000 0 0 0 $_TARGETNAME cs0
5110 flash bank flash1 ath79 0x10000000 0 0 0 $_TARGETNAME cs1
5111 flash bank flash2 ath79 0x20000000 0 0 0 $_TARGETNAME cs2
5112 @end example
5114 @end deffn
5116 @subsection Internal Flash (Microcontrollers)
5118 @deffn {Flash Driver} aduc702x
5119 The ADUC702x analog microcontrollers from Analog Devices
5120 include internal flash and use ARM7TDMI cores.
5121 The aduc702x flash driver works with models ADUC7019 through ADUC7028.
5122 The setup command only requires the @var{target} argument
5123 since all devices in this family have the same memory layout.
5125 @example
5126 flash bank $_FLASHNAME aduc702x 0 0 0 0 $_TARGETNAME
5127 @end example
5128 @end deffn
5130 @deffn {Flash Driver} ambiqmicro
5131 @cindex ambiqmicro
5132 @cindex apollo
5133 All members of the Apollo microcontroller family from
5134 Ambiq Micro include internal flash and use ARM's Cortex-M4 core.
5135 The host connects over USB to an FTDI interface that communicates
5136 with the target using SWD.
5138 The @var{ambiqmicro} driver reads the Chip Information Register detect
5139 the device class of the MCU.
5140 The Flash and Sram sizes directly follow device class, and are used
5141 to set up the flash banks.
5142 If this fails, the driver will use default values set to the minimum
5143 sizes of an Apollo chip.
5145 All Apollo chips have two flash banks of the same size.
5146 In all cases the first flash bank starts at location 0,
5147 and the second bank starts after the first.
5149 @example
5150 # Flash bank 0
5151 flash bank $_FLASHNAME ambiqmicro 0 0x00040000 0 0 $_TARGETNAME
5152 # Flash bank 1 - same size as bank0, starts after bank 0.
5153 flash bank $_FLASHNAME ambiqmicro 0x00040000 0x00040000 0 0 \
5154            $_TARGETNAME
5155 @end example
5157 Flash is programmed using custom entry points into the bootloader.
5158 This is the only way to program the flash as no flash control registers
5159 are available to the user.
5161 The @var{ambiqmicro} driver adds some additional commands:
5163 @deffn Command {ambiqmicro mass_erase} <bank>
5164 Erase entire bank.
5165 @end deffn
5166 @deffn Command {ambiqmicro page_erase} <bank> <first> <last>
5167 Erase device pages.
5168 @end deffn
5169 @deffn Command {ambiqmicro program_otp} <bank> <offset> <count>
5170 Program OTP is a one time operation to create write protected flash.
5171 The user writes sectors to sram starting at 0x10000010.
5172 Program OTP will write these sectors from sram to flash, and write protect
5173 the flash.
5174 @end deffn
5175 @end deffn
5177 @anchor{at91samd}
5178 @deffn {Flash Driver} at91samd
5179 @cindex at91samd
5180 All members of the ATSAMD, ATSAMR, ATSAML and ATSAMC microcontroller
5181 families from Atmel include internal flash and use ARM's Cortex-M0+ core.
5182 This driver uses the same cmd names/syntax as @xref{at91sam3}.
5184 @deffn Command {at91samd chip-erase}
5185 Issues a complete Flash erase via the Device Service Unit (DSU). This can be
5186 used to erase a chip back to its factory state and does not require the
5187 processor to be halted.
5188 @end deffn
5190 @deffn Command {at91samd set-security}
5191 Secures the Flash via the Set Security Bit (SSB) command. This prevents access
5192 to the Flash and can only be undone by using the chip-erase command which
5193 erases the Flash contents and turns off the security bit. Warning: at this
5194 time, openocd will not be able to communicate with a secured chip and it is
5195 therefore not possible to chip-erase it without using another tool.
5197 @example
5198 at91samd set-security enable
5199 @end example
5200 @end deffn
5202 @deffn Command {at91samd eeprom}
5203 Shows or sets the EEPROM emulation size configuration, stored in the User Row
5204 of the Flash. When setting, the EEPROM size must be specified in bytes and it
5205 must be one of the permitted sizes according to the datasheet. Settings are
5206 written immediately but only take effect on MCU reset. EEPROM emulation
5207 requires additional firmware support and the minumum EEPROM size may not be
5208 the same as the minimum that the hardware supports. Set the EEPROM size to 0
5209 in order to disable this feature.
5211 @example
5212 at91samd eeprom
5213 at91samd eeprom 1024
5214 @end example
5215 @end deffn
5217 @deffn Command {at91samd bootloader}
5218 Shows or sets the bootloader size configuration, stored in the User Row of the
5219 Flash. This is called the BOOTPROT region. When setting, the bootloader size
5220 must be specified in bytes and it must be one of the permitted sizes according
5221 to the datasheet. Settings are written immediately but only take effect on
5222 MCU reset. Setting the bootloader size to 0 disables bootloader protection.
5224 @example
5225 at91samd bootloader
5226 at91samd bootloader 16384
5227 @end example
5228 @end deffn
5230 @deffn Command {at91samd dsu_reset_deassert}
5231 This command releases internal reset held by DSU
5232 and prepares reset vector catch in case of reset halt.
5233 Command is used internally in event event reset-deassert-post.
5234 @end deffn
5236 @end deffn
5238 @anchor{at91sam3}
5239 @deffn {Flash Driver} at91sam3
5240 @cindex at91sam3
5241 All members of the AT91SAM3 microcontroller family from
5242 Atmel include internal flash and use ARM's Cortex-M3 core. The driver
5243 currently (6/22/09) recognizes the AT91SAM3U[1/2/4][C/E] chips. Note
5244 that the driver was orginaly developed and tested using the
5245 AT91SAM3U4E, using a SAM3U-EK eval board. Support for other chips in
5246 the family was cribbed from the data sheet. @emph{Note to future
5247 readers/updaters: Please remove this worrysome comment after other
5248 chips are confirmed.}
5250 The AT91SAM3U4[E/C] (256K) chips have two flash banks; most other chips
5251 have one flash bank. In all cases the flash banks are at
5252 the following fixed locations:
5254 @example
5255 # Flash bank 0 - all chips
5256 flash bank $_FLASHNAME at91sam3 0x00080000 0 1 1 $_TARGETNAME
5257 # Flash bank 1 - only 256K chips
5258 flash bank $_FLASHNAME at91sam3 0x00100000 0 1 1 $_TARGETNAME
5259 @end example
5261 Internally, the AT91SAM3 flash memory is organized as follows.
5262 Unlike the AT91SAM7 chips, these are not used as parameters
5263 to the @command{flash bank} command:
5265 @itemize
5266 @item @emph{N-Banks:} 256K chips have 2 banks, others have 1 bank.
5267 @item @emph{Bank Size:} 128K/64K Per flash bank
5268 @item @emph{Sectors:} 16 or 8 per bank
5269 @item @emph{SectorSize:} 8K Per Sector
5270 @item @emph{PageSize:} 256 bytes per page. Note that OpenOCD operates on 'sector' sizes, not page sizes.
5271 @end itemize
5273 The AT91SAM3 driver adds some additional commands:
5275 @deffn Command {at91sam3 gpnvm}
5276 @deffnx Command {at91sam3 gpnvm clear} number
5277 @deffnx Command {at91sam3 gpnvm set} number
5278 @deffnx Command {at91sam3 gpnvm show} [@option{all}|number]
5279 With no parameters, @command{show} or @command{show all},
5280 shows the status of all GPNVM bits.
5281 With @command{show} @var{number}, displays that bit.
5283 With @command{set} @var{number} or @command{clear} @var{number},
5284 modifies that GPNVM bit.
5285 @end deffn
5287 @deffn Command {at91sam3 info}
5288 This command attempts to display information about the AT91SAM3
5289 chip. @emph{First} it read the @code{CHIPID_CIDR} [address 0x400e0740, see
5290 Section 28.2.1, page 505 of the AT91SAM3U 29/may/2009 datasheet,
5291 document id: doc6430A] and decodes the values. @emph{Second} it reads the
5292 various clock configuration registers and attempts to display how it
5293 believes the chip is configured. By default, the SLOWCLK is assumed to
5294 be 32768 Hz, see the command @command{at91sam3 slowclk}.
5295 @end deffn
5297 @deffn Command {at91sam3 slowclk} [value]
5298 This command shows/sets the slow clock frequency used in the
5299 @command{at91sam3 info} command calculations above.
5300 @end deffn
5301 @end deffn
5303 @deffn {Flash Driver} at91sam4
5304 @cindex at91sam4
5305 All members of the AT91SAM4 microcontroller family from
5306 Atmel include internal flash and use ARM's Cortex-M4 core.
5307 This driver uses the same cmd names/syntax as @xref{at91sam3}.
5308 @end deffn
5310 @deffn {Flash Driver} at91sam4l
5311 @cindex at91sam4l
5312 All members of the AT91SAM4L microcontroller family from
5313 Atmel include internal flash and use ARM's Cortex-M4 core.
5314 This driver uses the same cmd names/syntax as @xref{at91sam3}.
5316 The AT91SAM4L driver adds some additional commands:
5317 @deffn Command {at91sam4l smap_reset_deassert}
5318 This command releases internal reset held by SMAP
5319 and prepares reset vector catch in case of reset halt.
5320 Command is used internally in event event reset-deassert-post.
5321 @end deffn
5322 @end deffn
5324 @deffn {Flash Driver} atsamv
5325 @cindex atsamv
5326 All members of the ATSAMV, ATSAMS, and ATSAME families from
5327 Atmel include internal flash and use ARM's Cortex-M7 core.
5328 This driver uses the same cmd names/syntax as @xref{at91sam3}.
5329 @end deffn
5331 @deffn {Flash Driver} at91sam7
5332 All members of the AT91SAM7 microcontroller family from Atmel include
5333 internal flash and use ARM7TDMI cores. The driver automatically
5334 recognizes a number of these chips using the chip identification
5335 register, and autoconfigures itself.
5337 @example
5338 flash bank $_FLASHNAME at91sam7 0 0 0 0 $_TARGETNAME
5339 @end example
5341 For chips which are not recognized by the controller driver, you must
5342 provide additional parameters in the following order:
5344 @itemize
5345 @item @var{chip_model} ... label used with @command{flash info}
5346 @item @var{banks}
5347 @item @var{sectors_per_bank}
5348 @item @var{pages_per_sector}
5349 @item @var{pages_size}
5350 @item @var{num_nvm_bits}
5351 @item @var{freq_khz} ... required if an external clock is provided,
5352 optional (but recommended) when the oscillator frequency is known
5353 @end itemize
5355 It is recommended that you provide zeroes for all of those values
5356 except the clock frequency, so that everything except that frequency
5357 will be autoconfigured.
5358 Knowing the frequency helps ensure correct timings for flash access.
5360 The flash controller handles erases automatically on a page (128/256 byte)
5361 basis, so explicit erase commands are not necessary for flash programming.
5362 However, there is an ``EraseAll`` command that can erase an entire flash
5363 plane (of up to 256KB), and it will be used automatically when you issue
5364 @command{flash erase_sector} or @command{flash erase_address} commands.
5366 @deffn Command {at91sam7 gpnvm} bitnum (@option{set}|@option{clear})
5367 Set or clear a ``General Purpose Non-Volatile Memory'' (GPNVM)
5368 bit for the processor. Each processor has a number of such bits,
5369 used for controlling features such as brownout detection (so they
5370 are not truly general purpose).
5371 @quotation Note
5372 This assumes that the first flash bank (number 0) is associated with
5373 the appropriate at91sam7 target.
5374 @end quotation
5375 @end deffn
5376 @end deffn
5378 @deffn {Flash Driver} avr
5379 The AVR 8-bit microcontrollers from Atmel integrate flash memory.
5380 @emph{The current implementation is incomplete.}
5381 @comment - defines mass_erase ... pointless given flash_erase_address
5382 @end deffn
5384 @deffn {Flash Driver} bluenrg-x
5385 STMicroelectronics BlueNRG-1 and BlueNRG-2 Bluetooth low energy wireless system-on-chip. They include ARM Cortex-M0 core and internal flash memory.
5386 The driver automatically recognizes these chips using
5387 the chip identification registers, and autoconfigures itself.
5389 @example
5390 flash bank $_FLASHNAME bluenrg-x 0 0 0 0 $_TARGETNAME
5391 @end example
5393 Note that when users ask to erase all the sectors of the flash, a mass erase command is used which is faster than erasing
5394 each single sector one by one.
5396 @example
5397 flash erase_sector 0 0 79 # It will perform a mass erase on BlueNRG-1
5398 @end example
5400 @example
5401 flash erase_sector 0 0 127 # It will perform a mass erase on BlueNRG-2
5402 @end example
5404 Triggering a mass erase is also useful when users want to disable readout protection.
5406 @end deffn
5408 @deffn {Flash Driver} efm32
5409 All members of the EFM32 microcontroller family from Energy Micro include
5410 internal flash and use ARM Cortex-M3 cores. The driver automatically recognizes
5411 a number of these chips using the chip identification register, and
5412 autoconfigures itself.
5413 @example
5414 flash bank $_FLASHNAME efm32 0 0 0 0 $_TARGETNAME
5415 @end example
5416 A special feature of efm32 controllers is that it is possible to completely disable the
5417 debug interface by writing the correct values to the 'Debug Lock Word'. OpenOCD supports
5418 this via the following command:
5419 @example
5420 efm32 debuglock num
5421 @end example
5422 The @var{num} parameter is a value shown by @command{flash banks}.
5423 Note that in order for this command to take effect, the target needs to be reset.
5424 @emph{The current implementation is incomplete. Unprotecting flash pages is not
5425 supported.}
5426 @end deffn
5428 @deffn {Flash Driver} fm3
5429 All members of the FM3 microcontroller family from Fujitsu
5430 include internal flash and use ARM Cortex-M3 cores.
5431 The @var{fm3} driver uses the @var{target} parameter to select the
5432 correct bank config, it can currently be one of the following:
5433 @code{mb9bfxx1.cpu}, @code{mb9bfxx2.cpu}, @code{mb9bfxx3.cpu},
5434 @code{mb9bfxx4.cpu}, @code{mb9bfxx5.cpu} or @code{mb9bfxx6.cpu}.
5436 @example
5437 flash bank $_FLASHNAME fm3 0 0 0 0 $_TARGETNAME
5438 @end example
5439 @end deffn
5441 @deffn {Flash Driver} fm4
5442 All members of the FM4 microcontroller family from Spansion (formerly Fujitsu)
5443 include internal flash and use ARM Cortex-M4 cores.
5444 The @var{fm4} driver uses a @var{family} parameter to select the
5445 correct bank config, it can currently be one of the following:
5446 @code{MB9BFx64}, @code{MB9BFx65}, @code{MB9BFx66}, @code{MB9BFx67}, @code{MB9BFx68},
5447 @code{S6E2Cx8}, @code{S6E2Cx9}, @code{S6E2CxA} or @code{S6E2Dx},
5448 with @code{x} treated as wildcard and otherwise case (and any trailing
5449 characters) ignored.
5451 @example
5452 flash bank $@{_FLASHNAME@}0 fm4 0x00000000 0 0 0 \
5453            $_TARGETNAME S6E2CCAJ0A
5454 flash bank $@{_FLASHNAME@}1 fm4 0x00100000 0 0 0 \
5455            $_TARGETNAME S6E2CCAJ0A
5456 @end example
5457 @emph{The current implementation is incomplete. Protection is not supported,
5458 nor is Chip Erase (only Sector Erase is implemented).}
5459 @end deffn
5461 @deffn {Flash Driver} kinetis
5462 @cindex kinetis
5463 Kx, KLx, KVx and KE1x members of the Kinetis microcontroller family
5464 from NXP (former Freescale) include
5465 internal flash and use ARM Cortex-M0+ or M4 cores. The driver automatically
5466 recognizes flash size and a number of flash banks (1-4) using the chip
5467 identification register, and autoconfigures itself.
5468 Use kinetis_ke driver for KE0x and KEAx devices.
5470 The @var{kinetis} driver defines option:
5471 @itemize
5472 @item -sim-base @var{addr} ... base of System Integration Module where chip identification resides. Driver tries two known locations if option is omitted.
5473 @end itemize
5475 @example
5476 flash bank $_FLASHNAME kinetis 0 0 0 0 $_TARGETNAME
5477 @end example
5479 @deffn Command {kinetis create_banks}
5480 Configuration command enables automatic creation of additional flash banks
5481 based on real flash layout of device. Banks are created during device probe.
5482 Use 'flash probe 0' to force probe.
5483 @end deffn
5485 @deffn Command {kinetis fcf_source} [protection|write]
5486 Select what source is used when writing to a Flash Configuration Field.
5487 @option{protection} mode builds FCF content from protection bits previously
5488 set by 'flash protect' command.
5489 This mode is default. MCU is protected from unwanted locking by immediate
5490 writing FCF after erase of relevant sector.
5491 @option{write} mode enables direct write to FCF.
5492 Protection cannot be set by 'flash protect' command. FCF is written along
5493 with the rest of a flash image.
5494 @emph{BEWARE: Incorrect flash configuration may permanently lock the device!}
5495 @end deffn
5497 @deffn Command {kinetis fopt} [num]
5498 Set value to write to FOPT byte of Flash Configuration Field.
5499 Used in kinetis 'fcf_source protection' mode only.
5500 @end deffn
5502 @deffn Command {kinetis mdm check_security}
5503 Checks status of device security lock. Used internally in examine-end event.
5504 @end deffn
5506 @deffn Command {kinetis mdm halt}
5507 Issues a halt via the MDM-AP. This command can be used to break a watchdog reset
5508 loop when connecting to an unsecured target.
5509 @end deffn
5511 @deffn Command {kinetis mdm mass_erase}
5512 Issues a complete flash erase via the MDM-AP. This can be used to erase a chip
5513 back to its factory state, removing security. It does not require the processor
5514 to be halted, however the target will remain in a halted state after this
5515 command completes.
5516 @end deffn
5518 @deffn Command {kinetis nvm_partition}
5519 For FlexNVM devices only (KxxDX and KxxFX).
5520 Command shows or sets data flash or EEPROM backup size in kilobytes,
5521 sets two EEPROM blocks sizes in bytes and enables/disables loading
5522 of EEPROM contents to FlexRAM during reset.
5524 For details see device reference manual, Flash Memory Module,
5525 Program Partition command.
5527 Setting is possible only once after mass_erase.
5528 Reset the device after partition setting.
5530 Show partition size:
5531 @example
5532 kinetis nvm_partition info
5533 @end example
5535 Set 32 KB data flash, rest of FlexNVM is EEPROM backup. EEPROM has two blocks
5536 of 512 and 1536 bytes and its contents is loaded to FlexRAM during reset:
5537 @example
5538 kinetis nvm_partition dataflash 32 512 1536 on
5539 @end example
5541 Set 16 KB EEPROM backup, rest of FlexNVM is a data flash. EEPROM has two blocks
5542 of 1024 bytes and its contents is not loaded to FlexRAM during reset:
5543 @example
5544 kinetis nvm_partition eebkp 16 1024 1024 off
5545 @end example
5546 @end deffn
5548 @deffn Command {kinetis mdm reset}
5549 Issues a reset via the MDM-AP. This causes the MCU to output a low pulse on the
5550 RESET pin, which can be used to reset other hardware on board.
5551 @end deffn
5553 @deffn Command {kinetis disable_wdog}
5554 For Kx devices only (KLx has different COP watchdog, it is not supported).
5555 Command disables watchdog timer.
5556 @end deffn
5557 @end deffn
5559 @deffn {Flash Driver} kinetis_ke
5560 @cindex kinetis_ke
5561 KE0x and KEAx members of the Kinetis microcontroller family from NXP include
5562 internal flash and use ARM Cortex-M0+. The driver automatically recognizes
5563 the KE0x sub-family using the chip identification register, and
5564 autoconfigures itself.
5565 Use kinetis (not kinetis_ke) driver for KE1x devices.
5567 @example
5568 flash bank $_FLASHNAME kinetis_ke 0 0 0 0 $_TARGETNAME
5569 @end example
5571 @deffn Command {kinetis_ke mdm check_security}
5572 Checks status of device security lock. Used internally in examine-end event.
5573 @end deffn
5575 @deffn Command {kinetis_ke mdm mass_erase}
5576 Issues a complete Flash erase via the MDM-AP.
5577 This can be used to erase a chip back to its factory state.
5578 Command removes security lock from a device (use of SRST highly recommended).
5579 It does not require the processor to be halted.
5580 @end deffn
5582 @deffn Command {kinetis_ke disable_wdog}
5583 Command disables watchdog timer.
5584 @end deffn
5585 @end deffn
5587 @deffn {Flash Driver} lpc2000
5588 This is the driver to support internal flash of all members of the
5589 LPC11(x)00 and LPC1300 microcontroller families and most members of
5590 the LPC800, LPC1500, LPC1700, LPC1800, LPC2000, LPC4000 and LPC54100
5591 microcontroller families from NXP.
5593 @quotation Note
5594 There are LPC2000 devices which are not supported by the @var{lpc2000}
5595 driver:
5596 The LPC2888 is supported by the @var{lpc288x} driver.
5597 The LPC29xx family is supported by the @var{lpc2900} driver.
5598 @end quotation
5600 The @var{lpc2000} driver defines two mandatory and one optional parameters,
5601 which must appear in the following order:
5603 @itemize
5604 @item @var{variant} ... required, may be
5605 @option{lpc2000_v1} (older LPC21xx and LPC22xx)
5606 @option{lpc2000_v2} (LPC213x, LPC214x, LPC210[123], LPC23xx and LPC24xx)
5607 @option{lpc1700} (LPC175x and LPC176x and LPC177x/8x)
5608 @option{lpc4300} - available also as @option{lpc1800} alias (LPC18x[2357] and
5609 LPC43x[2357])
5610 @option{lpc800} (LPC8xx)
5611 @option{lpc1100} (LPC11(x)xx and LPC13xx)
5612 @option{lpc1500} (LPC15xx)
5613 @option{lpc54100} (LPC541xx)
5614 @option{lpc4000} (LPC40xx)
5615 or @option{auto} - automatically detects flash variant and size for LPC11(x)00,
5616 LPC8xx, LPC13xx, LPC17xx and LPC40xx
5617 @item @var{clock_kHz} ... the frequency, in kiloHertz,
5618 at which the core is running
5619 @item @option{calc_checksum} ... optional (but you probably want to provide this!),
5620 telling the driver to calculate a valid checksum for the exception vector table.
5621 @quotation Note
5622 If you don't provide @option{calc_checksum} when you're writing the vector
5623 table, the boot ROM will almost certainly ignore your flash image.
5624 However, if you do provide it,
5625 with most tool chains @command{verify_image} will fail.
5626 @end quotation
5627 @end itemize
5629 LPC flashes don't require the chip and bus width to be specified.
5631 @example
5632 flash bank $_FLASHNAME lpc2000 0x0 0x7d000 0 0 $_TARGETNAME \
5633       lpc2000_v2 14765 calc_checksum
5634 @end example
5636 @deffn {Command} {lpc2000 part_id} bank
5637 Displays the four byte part identifier associated with
5638 the specified flash @var{bank}.
5639 @end deffn
5640 @end deffn
5642 @deffn {Flash Driver} lpc288x
5643 The LPC2888 microcontroller from NXP needs slightly different flash
5644 support from its lpc2000 siblings.
5645 The @var{lpc288x} driver defines one mandatory parameter,
5646 the programming clock rate in Hz.
5647 LPC flashes don't require the chip and bus width to be specified.
5649 @example
5650 flash bank $_FLASHNAME lpc288x 0 0 0 0 $_TARGETNAME 12000000
5651 @end example
5652 @end deffn
5654 @deffn {Flash Driver} lpc2900
5655 This driver supports the LPC29xx ARM968E based microcontroller family
5656 from NXP.
5658 The predefined parameters @var{base}, @var{size}, @var{chip_width} and
5659 @var{bus_width} of the @code{flash bank} command are ignored. Flash size and
5660 sector layout are auto-configured by the driver.
5661 The driver has one additional mandatory parameter: The CPU clock rate
5662 (in kHz) at the time the flash operations will take place. Most of the time this
5663 will not be the crystal frequency, but a higher PLL frequency. The
5664 @code{reset-init} event handler in the board script is usually the place where
5665 you start the PLL.
5667 The driver rejects flashless devices (currently the LPC2930).
5669 The EEPROM in LPC2900 devices is not mapped directly into the address space.
5670 It must be handled much more like NAND flash memory, and will therefore be
5671 handled by a separate @code{lpc2900_eeprom} driver (not yet available).
5673 Sector protection in terms of the LPC2900 is handled transparently. Every time a
5674 sector needs to be erased or programmed, it is automatically unprotected.
5675 What is shown as protection status in the @code{flash info} command, is
5676 actually the LPC2900 @emph{sector security}. This is a mechanism to prevent a
5677 sector from ever being erased or programmed again. As this is an irreversible
5678 mechanism, it is handled by a special command (@code{lpc2900 secure_sector}),
5679 and not by the standard @code{flash protect} command.
5681 Example for a 125 MHz clock frequency:
5682 @example
5683 flash bank $_FLASHNAME lpc2900 0 0 0 0 $_TARGETNAME 125000
5684 @end example
5686 Some @code{lpc2900}-specific commands are defined. In the following command list,
5687 the @var{bank} parameter is the bank number as obtained by the
5688 @code{flash banks} command.
5690 @deffn Command {lpc2900 signature} bank
5691 Calculates a 128-bit hash value, the @emph{signature}, from the whole flash
5692 content. This is a hardware feature of the flash block, hence the calculation is
5693 very fast. You may use this to verify the content of a programmed device against
5694 a known signature.
5695 Example:
5696 @example
5697 lpc2900 signature 0
5698   signature: 0x5f40cdc8:0xc64e592e:0x10490f89:0x32a0f317
5699 @end example
5700 @end deffn
5702 @deffn Command {lpc2900 read_custom} bank filename
5703 Reads the 912 bytes of customer information from the flash index sector, and
5704 saves it to a file in binary format.
5705 Example:
5706 @example
5707 lpc2900 read_custom 0 /path_to/customer_info.bin
5708 @end example
5709 @end deffn
5711 The index sector of the flash is a @emph{write-only} sector. It cannot be
5712 erased! In order to guard against unintentional write access, all following
5713 commands need to be preceeded by a successful call to the @code{password}
5714 command:
5716 @deffn Command {lpc2900 password} bank password
5717 You need to use this command right before each of the following commands:
5718 @code{lpc2900 write_custom}, @code{lpc2900 secure_sector},
5719 @code{lpc2900 secure_jtag}.
5721 The password string is fixed to "I_know_what_I_am_doing".
5722 Example:
5723 @example
5724 lpc2900 password 0 I_know_what_I_am_doing
5725   Potentially dangerous operation allowed in next command!
5726 @end example
5727 @end deffn
5729 @deffn Command {lpc2900 write_custom} bank filename type
5730 Writes the content of the file into the customer info space of the flash index
5731 sector. The filetype can be specified with the @var{type} field. Possible values
5732 for @var{type} are: @var{bin} (binary), @var{ihex} (Intel hex format),
5733 @var{elf} (ELF binary) or @var{s19} (Motorola S-records). The file must
5734 contain a single section, and the contained data length must be exactly
5735 912 bytes.
5736 @quotation Attention
5737 This cannot be reverted! Be careful!
5738 @end quotation
5739 Example:
5740 @example
5741 lpc2900 write_custom 0 /path_to/customer_info.bin bin
5742 @end example
5743 @end deffn
5745 @deffn Command {lpc2900 secure_sector} bank first last
5746 Secures the sector range from @var{first} to @var{last} (including) against
5747 further program and erase operations. The sector security will be effective
5748 after the next power cycle.
5749 @quotation Attention
5750 This cannot be reverted! Be careful!
5751 @end quotation
5752 Secured sectors appear as @emph{protected} in the @code{flash info} command.
5753 Example:
5754 @example
5755 lpc2900 secure_sector 0 1 1
5756 flash info 0
5757   #0 : lpc2900 at 0x20000000, size 0x000c0000, (...)
5758           #  0: 0x00000000 (0x2000 8kB) not protected
5759           #  1: 0x00002000 (0x2000 8kB) protected
5760           #  2: 0x00004000 (0x2000 8kB) not protected
5761 @end example
5762 @end deffn
5764 @deffn Command {lpc2900 secure_jtag} bank
5765 Irreversibly disable the JTAG port. The new JTAG security setting will be
5766 effective after the next power cycle.
5767 @quotation Attention
5768 This cannot be reverted! Be careful!
5769 @end quotation
5770 Examples:
5771 @example
5772 lpc2900 secure_jtag 0
5773 @end example
5774 @end deffn
5775 @end deffn
5777 @deffn {Flash Driver} mdr
5778 This drivers handles the integrated NOR flash on Milandr Cortex-M
5779 based controllers. A known limitation is that the Info memory can't be
5780 read or verified as it's not memory mapped.
5782 @example
5783 flash bank <name> mdr <base> <size> \
5784       0 0 <target#> @var{type} @var{page_count} @var{sec_count}
5785 @end example
5787 @itemize @bullet
5788 @item @var{type} - 0 for main memory, 1 for info memory
5789 @item @var{page_count} - total number of pages
5790 @item @var{sec_count} - number of sector per page count
5791 @end itemize
5793 Example usage:
5794 @example
5795 if @{ [info exists IMEMORY] && [string equal $IMEMORY true] @} @{
5796    flash bank $@{_CHIPNAME@}_info.flash mdr 0x00000000 0x01000 \
5797          0 0 $_TARGETNAME 1 1 4
5798 @} else @{
5799    flash bank $_CHIPNAME.flash mdr 0x00000000 0x20000 \
5800          0 0 $_TARGETNAME 0 32 4
5802 @end example
5803 @end deffn
5805 @deffn {Flash Driver} niietcm4
5806 This drivers handles the integrated NOR flash on NIIET Cortex-M4
5807 based controllers. Flash size and sector layout are auto-configured by the driver.
5808 Main flash memory is called "Bootflash" and has main region and info region.
5809 Info region is NOT memory mapped by default,
5810 but it can replace first part of main region if needed.
5811 Full erase, single and block writes are supported for both main and info regions.
5812 There is additional not memory mapped flash called "Userflash", which
5813 also have division into regions: main and info.
5814 Purpose of userflash - to store system and user settings.
5815 Driver has special commands to perform operations with this memmory.
5817 @example
5818 flash bank $_FLASHNAME niietcm4 0 0 0 0 $_TARGETNAME
5819 @end example
5821 Some niietcm4-specific commands are defined:
5823 @deffn Command {niietcm4 uflash_read_byte} bank ('main'|'info') address
5824 Read byte from main or info userflash region.
5825 @end deffn
5827 @deffn Command {niietcm4 uflash_write_byte} bank ('main'|'info') address value
5828 Write byte to main or info userflash region.
5829 @end deffn
5831 @deffn Command {niietcm4 uflash_full_erase} bank
5832 Erase all userflash including info region.
5833 @end deffn
5835 @deffn Command {niietcm4 uflash_erase} bank ('main'|'info') first_sector last_sector
5836 Erase sectors of main or info userflash region, starting at sector first up to and including last.
5837 @end deffn
5839 @deffn Command {niietcm4 uflash_protect_check} bank ('main'|'info')
5840 Check sectors protect.
5841 @end deffn
5843 @deffn Command {niietcm4 uflash_protect} bank ('main'|'info') first_sector last_sector ('on'|'off')
5844 Protect sectors of main or info userflash region, starting at sector first up to and including last.
5845 @end deffn
5847 @deffn Command {niietcm4 bflash_info_remap} bank ('on'|'off')
5848 Enable remapping bootflash info region to 0x00000000 (or 0x40000000 if external memory boot used).
5849 @end deffn
5851 @deffn Command {niietcm4 extmem_cfg} bank ('gpioa'|'gpiob'|'gpioc'|'gpiod'|'gpioe'|'gpiof'|'gpiog'|'gpioh') pin_num ('func1'|'func3')
5852 Configure external memory interface for boot.
5853 @end deffn
5855 @deffn Command {niietcm4 service_mode_erase} bank
5856 Perform emergency erase of all flash (bootflash and userflash).
5857 @end deffn
5859 @deffn Command {niietcm4 driver_info} bank
5860 Show information about flash driver.
5861 @end deffn
5863 @end deffn
5865 @deffn {Flash Driver} nrf5
5866 All members of the nRF51 microcontroller families from Nordic Semiconductor
5867 include internal flash and use ARM Cortex-M0 core.
5868 Also, the nRF52832 microcontroller from Nordic Semiconductor, which include
5869 internal flash and use an ARM Cortex-M4F core.
5871 @example
5872 flash bank $_FLASHNAME nrf5 0 0x00000000 0 0 $_TARGETNAME
5873 @end example
5875 Some nrf5-specific commands are defined:
5877 @deffn Command {nrf5 mass_erase}
5878 Erases the contents of the code memory and user information
5879 configuration registers as well. It must be noted that this command
5880 works only for chips that do not have factory pre-programmed region 0
5881 code.
5882 @end deffn
5884 @end deffn
5886 @deffn {Flash Driver} ocl
5887 This driver is an implementation of the ``on chip flash loader''
5888 protocol proposed by Pavel Chromy.
5890 It is a minimalistic command-response protocol intended to be used
5891 over a DCC when communicating with an internal or external flash
5892 loader running from RAM. An example implementation for AT91SAM7x is
5893 available in @file{contrib/loaders/flash/at91sam7x/}.
5895 @example
5896 flash bank $_FLASHNAME ocl 0 0 0 0 $_TARGETNAME
5897 @end example
5898 @end deffn
5900 @deffn {Flash Driver} pic32mx
5901 The PIC32MX microcontrollers are based on the MIPS 4K cores,
5902 and integrate flash memory.
5904 @example
5905 flash bank $_FLASHNAME pix32mx 0x1fc00000 0 0 0 $_TARGETNAME
5906 flash bank $_FLASHNAME pix32mx 0x1d000000 0 0 0 $_TARGETNAME
5907 @end example
5909 @comment numerous *disabled* commands are defined:
5910 @comment - chip_erase ... pointless given flash_erase_address
5911 @comment - lock, unlock ... pointless given protect on/off (yes?)
5912 @comment - pgm_word ... shouldn't bank be deduced from address??
5913 Some pic32mx-specific commands are defined:
5914 @deffn Command {pic32mx pgm_word} address value bank
5915 Programs the specified 32-bit @var{value} at the given @var{address}
5916 in the specified chip @var{bank}.
5917 @end deffn
5918 @deffn Command {pic32mx unlock} bank
5919 Unlock and erase specified chip @var{bank}.
5920 This will remove any Code Protection.
5921 @end deffn
5922 @end deffn
5924 @deffn {Flash Driver} psoc4
5925 All members of the PSoC 41xx/42xx microcontroller family from Cypress
5926 include internal flash and use ARM Cortex-M0 cores.
5927 The driver automatically recognizes a number of these chips using
5928 the chip identification register, and autoconfigures itself.
5930 Note: Erased internal flash reads as 00.
5931 System ROM of PSoC 4 does not implement erase of a flash sector.
5933 @example
5934 flash bank $_FLASHNAME psoc4 0 0 0 0 $_TARGETNAME
5935 @end example
5937 psoc4-specific commands
5938 @deffn Command {psoc4 flash_autoerase} num (on|off)
5939 Enables or disables autoerase mode for a flash bank.
5941 If flash_autoerase is off, use mass_erase before flash programming.
5942 Flash erase command fails if region to erase is not whole flash memory.
5944 If flash_autoerase is on, a sector is both erased and programmed in one
5945 system ROM call. Flash erase command is ignored.
5946 This mode is suitable for gdb load.
5948 The @var{num} parameter is a value shown by @command{flash banks}.
5949 @end deffn
5951 @deffn Command {psoc4 mass_erase} num
5952 Erases the contents of the flash memory, protection and security lock.
5954 The @var{num} parameter is a value shown by @command{flash banks}.
5955 @end deffn
5956 @end deffn
5958 @deffn {Flash Driver} psoc6
5959 Supports PSoC6 (CY8C6xxx) family of Cypress microcontrollers.
5960 PSoC6 is a dual-core device with CM0+ and CM4 cores. Both cores share
5961 the same Flash/RAM/MMIO address space.
5963 Flash in PSoC6 is split into three regions:
5964 @itemize @bullet
5965 @item Main Flash - this is the main storage for user application.
5966 Total size varies among devices, sector size: 256 kBytes, row size:
5967 512 bytes. Supports erase operation on individual rows.
5968 @item Work Flash - intended to be used as storage for user data
5969 (e.g. EEPROM emulation). Total size: 32 KBytes, sector size: 32 KBytes,
5970 row size: 512 bytes.
5971 @item Supervisory Flash - special region which contains device-specific
5972 service data. This region does not support erase operation. Only few rows can
5973 be programmed by the user, most of the rows are read only. Programming
5974 operation will erase row automatically.
5975 @end itemize
5977 All three flash regions are supported by the driver. Flash geometry is detected
5978 automatically by parsing data in SPCIF_GEOMETRY register.
5980 PSoC6 is equipped with NOR Flash so erased Flash reads as 0x00.
5982 @example
5983 flash bank main_flash_cm0 psoc6 0x10000000 0 0 0 $@{TARGET@}.cm0
5984 flash bank work_flash_cm0 psoc6 0x14000000 0 0 0 $@{TARGET@}.cm0
5985 flash bank super_flash_user_cm0 psoc6 0x16000800 0 0 0 $@{TARGET@}.cm0
5986 flash bank super_flash_nar_cm0 psoc6 0x16001A00 0 0 0 $@{TARGET@}.cm0
5987 flash bank super_flash_key_cm0 psoc6 0x16005A00 0 0 0 $@{TARGET@}.cm0
5988 flash bank super_flash_toc2_cm0 psoc6 0x16007C00 0 0 0 $@{TARGET@}.cm0
5990 flash bank main_flash_cm4 psoc6 0x10000000 0 0 0 $@{TARGET@}.cm4
5991 flash bank work_flash_cm4 psoc6 0x14000000 0 0 0 $@{TARGET@}.cm4
5992 flash bank super_flash_user_cm4 psoc6 0x16000800 0 0 0 $@{TARGET@}.cm4
5993 flash bank super_flash_nar_cm4 psoc6 0x16001A00 0 0 0 $@{TARGET@}.cm4
5994 flash bank super_flash_key_cm4 psoc6 0x16005A00 0 0 0 $@{TARGET@}.cm4
5995 flash bank super_flash_toc2_cm4 psoc6 0x16007C00 0 0 0 $@{TARGET@}.cm4
5996 @end example
5998 psoc6-specific commands
5999 @deffn Command {psoc6 reset_halt}
6000 Command can be used to simulate broken Vector Catch from gdbinit or tcl scripts.
6001 When invoked for CM0+ target, it will set break point at application entry point
6002 and issue SYSRESETREQ. This will reset both cores and all peripherals. CM0+ will
6003 reset CM4 during boot anyway so this is safe. On CM4 target, VECTRESET is used
6004 instead of SYSRESETREQ to avoid unwanted reset of CM0+;
6005 @end deffn
6007 @deffn Command {psoc6 mass_erase} num
6008 Erases the contents given flash bank. The @var{num} parameter is a value shown
6009 by @command{flash banks}.
6010 Note: only Main and Work flash regions support Erase operation.
6011 @end deffn
6012 @end deffn
6014 @deffn {Flash Driver} sim3x
6015 All members of the SiM3 microcontroller family from Silicon Laboratories
6016 include internal flash and use ARM Cortex-M3 cores. It supports both JTAG
6017 and SWD interface.
6018 The @var{sim3x} driver tries to probe the device to auto detect the MCU.
6019 If this failes, it will use the @var{size} parameter as the size of flash bank.
6021 @example
6022 flash bank $_FLASHNAME sim3x 0 $_CPUROMSIZE 0 0 $_TARGETNAME
6023 @end example
6025 There are 2 commands defined in the @var{sim3x} driver:
6027 @deffn Command {sim3x mass_erase}
6028 Erases the complete flash. This is used to unlock the flash.
6029 And this command is only possible when using the SWD interface.
6030 @end deffn
6032 @deffn Command {sim3x lock}
6033 Lock the flash. To unlock use the @command{sim3x mass_erase} command.
6034 @end deffn
6035 @end deffn
6037 @deffn {Flash Driver} stellaris
6038 All members of the Stellaris LM3Sxxx, LM4x and Tiva C microcontroller
6039 families from Texas Instruments include internal flash. The driver
6040 automatically recognizes a number of these chips using the chip
6041 identification register, and autoconfigures itself.
6043 @example
6044 flash bank $_FLASHNAME stellaris 0 0 0 0 $_TARGETNAME
6045 @end example
6047 @deffn Command {stellaris recover}
6048 Performs the @emph{Recovering a "Locked" Device} procedure to restore
6049 the flash and its associated nonvolatile registers to their factory
6050 default values (erased). This is the only way to remove flash
6051 protection or re-enable debugging if that capability has been
6052 disabled.
6054 Note that the final "power cycle the chip" step in this procedure
6055 must be performed by hand, since OpenOCD can't do it.
6056 @quotation Warning
6057 if more than one Stellaris chip is connected, the procedure is
6058 applied to all of them.
6059 @end quotation
6060 @end deffn
6061 @end deffn
6063 @deffn {Flash Driver} stm32f1x
6064 All members of the STM32F0, STM32F1 and STM32F3 microcontroller families
6065 from ST Microelectronics include internal flash and use ARM Cortex-M0/M3/M4 cores.
6066 The driver automatically recognizes a number of these chips using
6067 the chip identification register, and autoconfigures itself.
6069 @example
6070 flash bank $_FLASHNAME stm32f1x 0 0 0 0 $_TARGETNAME
6071 @end example
6073 Note that some devices have been found that have a flash size register that contains
6074 an invalid value, to workaround this issue you can override the probed value used by
6075 the flash driver.
6077 @example
6078 flash bank $_FLASHNAME stm32f1x 0 0x20000 0 0 $_TARGETNAME
6079 @end example
6081 If you have a target with dual flash banks then define the second bank
6082 as per the following example.
6083 @example
6084 flash bank $_FLASHNAME stm32f1x 0x08080000 0 0 0 $_TARGETNAME
6085 @end example
6087 Some stm32f1x-specific commands are defined:
6089 @deffn Command {stm32f1x lock} num
6090 Locks the entire stm32 device.
6091 The @var{num} parameter is a value shown by @command{flash banks}.
6092 @end deffn
6094 @deffn Command {stm32f1x unlock} num
6095 Unlocks the entire stm32 device.
6096 The @var{num} parameter is a value shown by @command{flash banks}.
6097 @end deffn
6099 @deffn Command {stm32f1x mass_erase} num
6100 Mass erases the entire stm32f1x device.
6101 The @var{num} parameter is a value shown by @command{flash banks}.
6102 @end deffn
6104 @deffn Command {stm32f1x options_read} num
6105 Read and display the stm32 option bytes written by
6106 the @command{stm32f1x options_write} command.
6107 The @var{num} parameter is a value shown by @command{flash banks}.
6108 @end deffn
6110 @deffn Command {stm32f1x options_write} num (@option{SWWDG}|@option{HWWDG}) (@option{RSTSTNDBY}|@option{NORSTSTNDBY}) (@option{RSTSTOP}|@option{NORSTSTOP})
6111 Writes the stm32 option byte with the specified values.
6112 The @var{num} parameter is a value shown by @command{flash banks}.
6113 @end deffn
6114 @end deffn
6116 @deffn {Flash Driver} stm32f2x
6117 All members of the STM32F2, STM32F4 and STM32F7 microcontroller families from ST Microelectronics
6118 include internal flash and use ARM Cortex-M3/M4/M7 cores.
6119 The driver automatically recognizes a number of these chips using
6120 the chip identification register, and autoconfigures itself.
6122 @example
6123 flash bank $_FLASHNAME stm32f2x 0 0 0 0 $_TARGETNAME
6124 @end example
6126 Note that some devices have been found that have a flash size register that contains
6127 an invalid value, to workaround this issue you can override the probed value used by
6128 the flash driver.
6130 @example
6131 flash bank $_FLASHNAME stm32f2x 0 0x20000 0 0 $_TARGETNAME
6132 @end example
6134 Some stm32f2x-specific commands are defined:
6136 @deffn Command {stm32f2x lock} num
6137 Locks the entire stm32 device.
6138 The @var{num} parameter is a value shown by @command{flash banks}.
6139 @end deffn
6141 @deffn Command {stm32f2x unlock} num
6142 Unlocks the entire stm32 device.
6143 The @var{num} parameter is a value shown by @command{flash banks}.
6144 @end deffn
6146 @deffn Command {stm32f2x mass_erase} num
6147 Mass erases the entire stm32f2x device.
6148 The @var{num} parameter is a value shown by @command{flash banks}.
6149 @end deffn
6151 @deffn Command {stm32f2x options_read} num
6152 Reads and displays user options and (where implemented) boot_addr0, boot_addr1, optcr2.
6153 The @var{num} parameter is a value shown by @command{flash banks}.
6154 @end deffn
6156 @deffn Command {stm32f2x options_write} num user_options boot_addr0 boot_addr1
6157 Writes user options and (where implemented) boot_addr0 and boot_addr1 in raw format.
6158 Warning: The meaning of the various bits depends on the device, always check datasheet!
6159 The @var{num} parameter is a value shown by @command{flash banks}, @var{user_options} a
6160 12 bit value, consisting of bits 31-28 and 7-0 of FLASH_OPTCR, @var{boot_addr0} and
6161 @var{boot_addr1} two halfwords (of FLASH_OPTCR1).
6162 @end deffn
6164 @deffn Command {stm32f2x optcr2_write} num optcr2
6165 Writes FLASH_OPTCR2 options. Warning: Clearing PCROPi bits requires a full mass erase!
6166 The @var{num} parameter is a value shown by @command{flash banks}, @var{optcr2} a 32-bit word.
6167 @end deffn
6168 @end deffn
6170 @deffn {Flash Driver} stm32h7x
6171 All members of the STM32H7 microcontroller families from ST Microelectronics
6172 include internal flash and use ARM Cortex-M7 core.
6173 The driver automatically recognizes a number of these chips using
6174 the chip identification register, and autoconfigures itself.
6176 @example
6177 flash bank $_FLASHNAME stm32h7x 0 0 0 0 $_TARGETNAME
6178 @end example
6180 Note that some devices have been found that have a flash size register that contains
6181 an invalid value, to workaround this issue you can override the probed value used by
6182 the flash driver.
6184 @example
6185 flash bank $_FLASHNAME stm32h7x 0 0x20000 0 0 $_TARGETNAME
6186 @end example
6188 Some stm32h7x-specific commands are defined:
6190 @deffn Command {stm32h7x lock} num
6191 Locks the entire stm32 device.
6192 The @var{num} parameter is a value shown by @command{flash banks}.
6193 @end deffn
6195 @deffn Command {stm32h7x unlock} num
6196 Unlocks the entire stm32 device.
6197 The @var{num} parameter is a value shown by @command{flash banks}.
6198 @end deffn
6200 @deffn Command {stm32h7x mass_erase} num
6201 Mass erases the entire stm32h7x device.
6202 The @var{num} parameter is a value shown by @command{flash banks}.
6203 @end deffn
6204 @end deffn
6206 @deffn {Flash Driver} stm32lx
6207 All members of the STM32L microcontroller families from ST Microelectronics
6208 include internal flash and use ARM Cortex-M3 and Cortex-M0+ cores.
6209 The driver automatically recognizes a number of these chips using
6210 the chip identification register, and autoconfigures itself.
6212 @example
6213 flash bank $_FLASHNAME stm32lx 0 0 0 0 $_TARGETNAME
6214 @end example
6216 Note that some devices have been found that have a flash size register that contains
6217 an invalid value, to workaround this issue you can override the probed value used by
6218 the flash driver. If you use 0 as the bank base address, it tells the
6219 driver to autodetect the bank location assuming you're configuring the
6220 second bank.
6222 @example
6223 flash bank $_FLASHNAME stm32lx 0x08000000 0x20000 0 0 $_TARGETNAME
6224 @end example
6226 Some stm32lx-specific commands are defined:
6228 @deffn Command {stm32lx lock} num
6229 Locks the entire stm32 device.
6230 The @var{num} parameter is a value shown by @command{flash banks}.
6231 @end deffn
6233 @deffn Command {stm32lx unlock} num
6234 Unlocks the entire stm32 device.
6235 The @var{num} parameter is a value shown by @command{flash banks}.
6236 @end deffn
6238 @deffn Command {stm32lx mass_erase} num
6239 Mass erases the entire stm32lx device (all flash banks and EEPROM
6240 data). This is the only way to unlock a protected flash (unless RDP
6241 Level is 2 which can't be unlocked at all).
6242 The @var{num} parameter is a value shown by @command{flash banks}.
6243 @end deffn
6244 @end deffn
6246 @deffn {Flash Driver} stm32l4x
6247 All members of the STM32L4 microcontroller families from ST Microelectronics
6248 include internal flash and use ARM Cortex-M4 cores.
6249 The driver automatically recognizes a number of these chips using
6250 the chip identification register, and autoconfigures itself.
6252 @example
6253 flash bank $_FLASHNAME stm32l4x 0 0 0 0 $_TARGETNAME
6254 @end example
6256 Note that some devices have been found that have a flash size register that contains
6257 an invalid value, to workaround this issue you can override the probed value used by
6258 the flash driver.
6260 @example
6261 flash bank $_FLASHNAME stm32l4x 0x08000000 0x40000 0 0 $_TARGETNAME
6262 @end example
6264 Some stm32l4x-specific commands are defined:
6266 @deffn Command {stm32l4x lock} num
6267 Locks the entire stm32 device.
6268 The @var{num} parameter is a value shown by @command{flash banks}.
6269 @end deffn
6271 @deffn Command {stm32l4x unlock} num
6272 Unlocks the entire stm32 device.
6273 The @var{num} parameter is a value shown by @command{flash banks}.
6274 @end deffn
6276 @deffn Command {stm32l4x mass_erase} num
6277 Mass erases the entire stm32l4x device.
6278 The @var{num} parameter is a value shown by @command{flash banks}.
6279 @end deffn
6280 @end deffn
6282 @deffn {Flash Driver} str7x
6283 All members of the STR7 microcontroller family from ST Microelectronics
6284 include internal flash and use ARM7TDMI cores.
6285 The @var{str7x} driver defines one mandatory parameter, @var{variant},
6286 which is either @code{STR71x}, @code{STR73x} or @code{STR75x}.
6288 @example
6289 flash bank $_FLASHNAME str7x \
6290       0x40000000 0x00040000 0 0 $_TARGETNAME STR71x
6291 @end example
6293 @deffn Command {str7x disable_jtag} bank
6294 Activate the Debug/Readout protection mechanism
6295 for the specified flash bank.
6296 @end deffn
6297 @end deffn
6299 @deffn {Flash Driver} str9x
6300 Most members of the STR9 microcontroller family from ST Microelectronics
6301 include internal flash and use ARM966E cores.
6302 The str9 needs the flash controller to be configured using
6303 the @command{str9x flash_config} command prior to Flash programming.
6305 @example
6306 flash bank $_FLASHNAME str9x 0x40000000 0x00040000 0 0 $_TARGETNAME
6307 str9x flash_config 0 4 2 0 0x80000
6308 @end example
6310 @deffn Command {str9x flash_config} num bbsr nbbsr bbadr nbbadr
6311 Configures the str9 flash controller.
6312 The @var{num} parameter is a value shown by @command{flash banks}.
6314 @itemize @bullet
6315 @item @var{bbsr} - Boot Bank Size register
6316 @item @var{nbbsr} - Non Boot Bank Size register
6317 @item @var{bbadr} - Boot Bank Start Address register
6318 @item @var{nbbadr} - Boot Bank Start Address register
6319 @end itemize
6320 @end deffn
6322 @end deffn
6324 @deffn {Flash Driver} str9xpec
6325 @cindex str9xpec
6327 Only use this driver for locking/unlocking the device or configuring the option bytes.
6328 Use the standard str9 driver for programming.
6329 Before using the flash commands the turbo mode must be enabled using the
6330 @command{str9xpec enable_turbo} command.
6332 Here is some background info to help
6333 you better understand how this driver works. OpenOCD has two flash drivers for
6334 the str9:
6335 @enumerate
6336 @item
6337 Standard driver @option{str9x} programmed via the str9 core. Normally used for
6338 flash programming as it is faster than the @option{str9xpec} driver.
6339 @item
6340 Direct programming @option{str9xpec} using the flash controller. This is an
6341 ISC compilant (IEEE 1532) tap connected in series with the str9 core. The str9
6342 core does not need to be running to program using this flash driver. Typical use
6343 for this driver is locking/unlocking the target and programming the option bytes.
6344 @end enumerate
6346 Before we run any commands using the @option{str9xpec} driver we must first disable
6347 the str9 core. This example assumes the @option{str9xpec} driver has been
6348 configured for flash bank 0.
6349 @example
6350 # assert srst, we do not want core running
6351 # while accessing str9xpec flash driver
6352 jtag_reset 0 1
6353 # turn off target polling
6354 poll off
6355 # disable str9 core
6356 str9xpec enable_turbo 0
6357 # read option bytes
6358 str9xpec options_read 0
6359 # re-enable str9 core
6360 str9xpec disable_turbo 0
6361 poll on
6362 reset halt
6363 @end example
6364 The above example will read the str9 option bytes.
6365 When performing a unlock remember that you will not be able to halt the str9 - it
6366 has been locked. Halting the core is not required for the @option{str9xpec} driver
6367 as mentioned above, just issue the commands above manually or from a telnet prompt.
6369 Several str9xpec-specific commands are defined:
6371 @deffn Command {str9xpec disable_turbo} num
6372 Restore the str9 into JTAG chain.
6373 @end deffn
6375 @deffn Command {str9xpec enable_turbo} num
6376 Enable turbo mode, will simply remove the str9 from the chain and talk
6377 directly to the embedded flash controller.
6378 @end deffn
6380 @deffn Command {str9xpec lock} num
6381 Lock str9 device. The str9 will only respond to an unlock command that will
6382 erase the device.
6383 @end deffn
6385 @deffn Command {str9xpec part_id} num
6386 Prints the part identifier for bank @var{num}.
6387 @end deffn
6389 @deffn Command {str9xpec options_cmap} num (@option{bank0}|@option{bank1})
6390 Configure str9 boot bank.
6391 @end deffn
6393 @deffn Command {str9xpec options_lvdsel} num (@option{vdd}|@option{vdd_vddq})
6394 Configure str9 lvd source.
6395 @end deffn
6397 @deffn Command {str9xpec options_lvdthd} num (@option{2.4v}|@option{2.7v})
6398 Configure str9 lvd threshold.
6399 @end deffn
6401 @deffn Command {str9xpec options_lvdwarn} bank (@option{vdd}|@option{vdd_vddq})
6402 Configure str9 lvd reset warning source.
6403 @end deffn
6405 @deffn Command {str9xpec options_read} num
6406 Read str9 option bytes.
6407 @end deffn
6409 @deffn Command {str9xpec options_write} num
6410 Write str9 option bytes.
6411 @end deffn
6413 @deffn Command {str9xpec unlock} num
6414 unlock str9 device.
6415 @end deffn
6417 @end deffn
6419 @deffn {Flash Driver} tms470
6420 Most members of the TMS470 microcontroller family from Texas Instruments
6421 include internal flash and use ARM7TDMI cores.
6422 This driver doesn't require the chip and bus width to be specified.
6424 Some tms470-specific commands are defined:
6426 @deffn Command {tms470 flash_keyset} key0 key1 key2 key3
6427 Saves programming keys in a register, to enable flash erase and write commands.
6428 @end deffn
6430 @deffn Command {tms470 osc_mhz} clock_mhz
6431 Reports the clock speed, which is used to calculate timings.
6432 @end deffn
6434 @deffn Command {tms470 plldis} (0|1)
6435 Disables (@var{1}) or enables (@var{0}) use of the PLL to speed up
6436 the flash clock.
6437 @end deffn
6438 @end deffn
6440 @deffn {Flash Driver} xmc1xxx
6441 All members of the XMC1xxx microcontroller family from Infineon.
6442 This driver does not require the chip and bus width to be specified.
6443 @end deffn
6445 @deffn {Flash Driver} xmc4xxx
6446 All members of the XMC4xxx microcontroller family from Infineon.
6447 This driver does not require the chip and bus width to be specified.
6449 Some xmc4xxx-specific commands are defined:
6451 @deffn Command {xmc4xxx flash_password} bank_id passwd1 passwd2
6452 Saves flash protection passwords which are used to lock the user flash
6453 @end deffn
6455 @deffn Command {xmc4xxx flash_unprotect} bank_id user_level[0-1]
6456 Removes Flash write protection from the selected user bank
6457 @end deffn
6459 @end deffn
6461 @section NAND Flash Commands
6462 @cindex NAND
6464 Compared to NOR or SPI flash, NAND devices are inexpensive
6465 and high density. Today's NAND chips, and multi-chip modules,
6466 commonly hold multiple GigaBytes of data.
6468 NAND chips consist of a number of ``erase blocks'' of a given
6469 size (such as 128 KBytes), each of which is divided into a
6470 number of pages (of perhaps 512 or 2048 bytes each). Each
6471 page of a NAND flash has an ``out of band'' (OOB) area to hold
6472 Error Correcting Code (ECC) and other metadata, usually 16 bytes
6473 of OOB for every 512 bytes of page data.
6475 One key characteristic of NAND flash is that its error rate
6476 is higher than that of NOR flash. In normal operation, that
6477 ECC is used to correct and detect errors. However, NAND
6478 blocks can also wear out and become unusable; those blocks
6479 are then marked "bad". NAND chips are even shipped from the
6480 manufacturer with a few bad blocks. The highest density chips
6481 use a technology (MLC) that wears out more quickly, so ECC
6482 support is increasingly important as a way to detect blocks
6483 that have begun to fail, and help to preserve data integrity
6484 with techniques such as wear leveling.
6486 Software is used to manage the ECC. Some controllers don't
6487 support ECC directly; in those cases, software ECC is used.
6488 Other controllers speed up the ECC calculations with hardware.
6489 Single-bit error correction hardware is routine. Controllers
6490 geared for newer MLC chips may correct 4 or more errors for
6491 every 512 bytes of data.
6493 You will need to make sure that any data you write using
6494 OpenOCD includes the apppropriate kind of ECC. For example,
6495 that may mean passing the @code{oob_softecc} flag when
6496 writing NAND data, or ensuring that the correct hardware
6497 ECC mode is used.
6499 The basic steps for using NAND devices include:
6500 @enumerate
6501 @item Declare via the command @command{nand device}
6502 @* Do this in a board-specific configuration file,
6503 passing parameters as needed by the controller.
6504 @item Configure each device using @command{nand probe}.
6505 @* Do this only after the associated target is set up,
6506 such as in its reset-init script or in procures defined
6507 to access that device.
6508 @item Operate on the flash via @command{nand subcommand}
6509 @* Often commands to manipulate the flash are typed by a human, or run
6510 via a script in some automated way. Common task include writing a
6511 boot loader, operating system, or other data needed to initialize or
6512 de-brick a board.
6513 @end enumerate
6515 @b{NOTE:} At the time this text was written, the largest NAND
6516 flash fully supported by OpenOCD is 2 GiBytes (16 GiBits).
6517 This is because the variables used to hold offsets and lengths
6518 are only 32 bits wide.
6519 (Larger chips may work in some cases, unless an offset or length
6520 is larger than 0xffffffff, the largest 32-bit unsigned integer.)
6521 Some larger devices will work, since they are actually multi-chip
6522 modules with two smaller chips and individual chipselect lines.
6524 @anchor{nandconfiguration}
6525 @subsection NAND Configuration Commands
6526 @cindex NAND configuration
6528 NAND chips must be declared in configuration scripts,
6529 plus some additional configuration that's done after
6530 OpenOCD has initialized.
6532 @deffn {Config Command} {nand device} name driver target [configparams...]
6533 Declares a NAND device, which can be read and written to
6534 after it has been configured through @command{nand probe}.
6535 In OpenOCD, devices are single chips; this is unlike some
6536 operating systems, which may manage multiple chips as if
6537 they were a single (larger) device.
6538 In some cases, configuring a device will activate extra
6539 commands; see the controller-specific documentation.
6541 @b{NOTE:} This command is not available after OpenOCD
6542 initialization has completed. Use it in board specific
6543 configuration files, not interactively.
6545 @itemize @bullet
6546 @item @var{name} ... may be used to reference the NAND bank
6547 in most other NAND commands. A number is also available.
6548 @item @var{driver} ... identifies the NAND controller driver
6549 associated with the NAND device being declared.
6550 @xref{nanddriverlist,,NAND Driver List}.
6551 @item @var{target} ... names the target used when issuing
6552 commands to the NAND controller.
6553 @comment Actually, it's currently a controller-specific parameter...
6554 @item @var{configparams} ... controllers may support, or require,
6555 additional parameters. See the controller-specific documentation
6556 for more information.
6557 @end itemize
6558 @end deffn
6560 @deffn Command {nand list}
6561 Prints a summary of each device declared
6562 using @command{nand device}, numbered from zero.
6563 Note that un-probed devices show no details.
6564 @example
6565 > nand list
6566 #0: NAND 1GiB 3,3V 8-bit (Micron) pagesize: 2048, buswidth: 8,
6567         blocksize: 131072, blocks: 8192
6568 #1: NAND 1GiB 3,3V 8-bit (Micron) pagesize: 2048, buswidth: 8,
6569         blocksize: 131072, blocks: 8192
6571 @end example
6572 @end deffn
6574 @deffn Command {nand probe} num
6575 Probes the specified device to determine key characteristics
6576 like its page and block sizes, and how many blocks it has.
6577 The @var{num} parameter is the value shown by @command{nand list}.
6578 You must (successfully) probe a device before you can use
6579 it with most other NAND commands.
6580 @end deffn
6582 @subsection Erasing, Reading, Writing to NAND Flash
6584 @deffn Command {nand dump} num filename offset length [oob_option]
6585 @cindex NAND reading
6586 Reads binary data from the NAND device and writes it to the file,
6587 starting at the specified offset.
6588 The @var{num} parameter is the value shown by @command{nand list}.
6590 Use a complete path name for @var{filename}, so you don't depend
6591 on the directory used to start the OpenOCD server.
6593 The @var{offset} and @var{length} must be exact multiples of the
6594 device's page size. They describe a data region; the OOB data
6595 associated with each such page may also be accessed.
6597 @b{NOTE:} At the time this text was written, no error correction
6598 was done on the data that's read, unless raw access was disabled
6599 and the underlying NAND controller driver had a @code{read_page}
6600 method which handled that error correction.
6602 By default, only page data is saved to the specified file.
6603 Use an @var{oob_option} parameter to save OOB data:
6604 @itemize @bullet
6605 @item no oob_* parameter
6606 @*Output file holds only page data; OOB is discarded.
6607 @item @code{oob_raw}
6608 @*Output file interleaves page data and OOB data;
6609 the file will be longer than "length" by the size of the
6610 spare areas associated with each data page.
6611 Note that this kind of "raw" access is different from
6612 what's implied by @command{nand raw_access}, which just
6613 controls whether a hardware-aware access method is used.
6614 @item @code{oob_only}
6615 @*Output file has only raw OOB data, and will
6616 be smaller than "length" since it will contain only the
6617 spare areas associated with each data page.
6618 @end itemize
6619 @end deffn
6621 @deffn Command {nand erase} num [offset length]
6622 @cindex NAND erasing
6623 @cindex NAND programming
6624 Erases blocks on the specified NAND device, starting at the
6625 specified @var{offset} and continuing for @var{length} bytes.
6626 Both of those values must be exact multiples of the device's
6627 block size, and the region they specify must fit entirely in the chip.
6628 If those parameters are not specified,
6629 the whole NAND chip will be erased.
6630 The @var{num} parameter is the value shown by @command{nand list}.
6632 @b{NOTE:} This command will try to erase bad blocks, when told
6633 to do so, which will probably invalidate the manufacturer's bad
6634 block marker.
6635 For the remainder of the current server session, @command{nand info}
6636 will still report that the block ``is'' bad.
6637 @end deffn
6639 @deffn Command {nand write} num filename offset [option...]
6640 @cindex NAND writing
6641 @cindex NAND programming
6642 Writes binary data from the file into the specified NAND device,
6643 starting at the specified offset. Those pages should already
6644 have been erased; you can't change zero bits to one bits.
6645 The @var{num} parameter is the value shown by @command{nand list}.
6647 Use a complete path name for @var{filename}, so you don't depend
6648 on the directory used to start the OpenOCD server.
6650 The @var{offset} must be an exact multiple of the device's page size.
6651 All data in the file will be written, assuming it doesn't run
6652 past the end of the device.
6653 Only full pages are written, and any extra space in the last
6654 page will be filled with 0xff bytes. (That includes OOB data,
6655 if that's being written.)
6657 @b{NOTE:} At the time this text was written, bad blocks are
6658 ignored. That is, this routine will not skip bad blocks,
6659 but will instead try to write them. This can cause problems.
6661 Provide at most one @var{option} parameter. With some
6662 NAND drivers, the meanings of these parameters may change
6663 if @command{nand raw_access} was used to disable hardware ECC.
6664 @itemize @bullet
6665 @item no oob_* parameter
6666 @*File has only page data, which is written.
6667 If raw acccess is in use, the OOB area will not be written.
6668 Otherwise, if the underlying NAND controller driver has
6669 a @code{write_page} routine, that routine may write the OOB
6670 with hardware-computed ECC data.
6671 @item @code{oob_only}
6672 @*File has only raw OOB data, which is written to the OOB area.
6673 Each page's data area stays untouched. @i{This can be a dangerous
6674 option}, since it can invalidate the ECC data.
6675 You may need to force raw access to use this mode.
6676 @item @code{oob_raw}
6677 @*File interleaves data and OOB data, both of which are written
6678 If raw access is enabled, the data is written first, then the
6679 un-altered OOB.
6680 Otherwise, if the underlying NAND controller driver has
6681 a @code{write_page} routine, that routine may modify the OOB
6682 before it's written, to include hardware-computed ECC data.
6683 @item @code{oob_softecc}
6684 @*File has only page data, which is written.
6685 The OOB area is filled with 0xff, except for a standard 1-bit
6686 software ECC code stored in conventional locations.
6687 You might need to force raw access to use this mode, to prevent
6688 the underlying driver from applying hardware ECC.
6689 @item @code{oob_softecc_kw}
6690 @*File has only page data, which is written.
6691 The OOB area is filled with 0xff, except for a 4-bit software ECC
6692 specific to the boot ROM in Marvell Kirkwood SoCs.
6693 You might need to force raw access to use this mode, to prevent
6694 the underlying driver from applying hardware ECC.
6695 @end itemize
6696 @end deffn
6698 @deffn Command {nand verify} num filename offset [option...]
6699 @cindex NAND verification
6700 @cindex NAND programming
6701 Verify the binary data in the file has been programmed to the
6702 specified NAND device, starting at the specified offset.
6703 The @var{num} parameter is the value shown by @command{nand list}.
6705 Use a complete path name for @var{filename}, so you don't depend
6706 on the directory used to start the OpenOCD server.
6708 The @var{offset} must be an exact multiple of the device's page size.
6709 All data in the file will be read and compared to the contents of the
6710 flash, assuming it doesn't run past the end of the device.
6711 As with @command{nand write}, only full pages are verified, so any extra
6712 space in the last page will be filled with 0xff bytes.
6714 The same @var{options} accepted by @command{nand write},
6715 and the file will be processed similarly to produce the buffers that
6716 can be compared against the contents produced from @command{nand dump}.
6718 @b{NOTE:} This will not work when the underlying NAND controller
6719 driver's @code{write_page} routine must update the OOB with a
6720 hardward-computed ECC before the data is written. This limitation may
6721 be removed in a future release.
6722 @end deffn
6724 @subsection Other NAND commands
6725 @cindex NAND other commands
6727 @deffn Command {nand check_bad_blocks} num [offset length]
6728 Checks for manufacturer bad block markers on the specified NAND
6729 device. If no parameters are provided, checks the whole
6730 device; otherwise, starts at the specified @var{offset} and
6731 continues for @var{length} bytes.
6732 Both of those values must be exact multiples of the device's
6733 block size, and the region they specify must fit entirely in the chip.
6734 The @var{num} parameter is the value shown by @command{nand list}.
6736 @b{NOTE:} Before using this command you should force raw access
6737 with @command{nand raw_access enable} to ensure that the underlying
6738 driver will not try to apply hardware ECC.
6739 @end deffn
6741 @deffn Command {nand info} num
6742 The @var{num} parameter is the value shown by @command{nand list}.
6743 This prints the one-line summary from "nand list", plus for
6744 devices which have been probed this also prints any known
6745 status for each block.
6746 @end deffn
6748 @deffn Command {nand raw_access} num (@option{enable}|@option{disable})
6749 Sets or clears an flag affecting how page I/O is done.
6750 The @var{num} parameter is the value shown by @command{nand list}.
6752 This flag is cleared (disabled) by default, but changing that
6753 value won't affect all NAND devices. The key factor is whether
6754 the underlying driver provides @code{read_page} or @code{write_page}
6755 methods. If it doesn't provide those methods, the setting of
6756 this flag is irrelevant; all access is effectively ``raw''.
6758 When those methods exist, they are normally used when reading
6759 data (@command{nand dump} or reading bad block markers) or
6760 writing it (@command{nand write}). However, enabling
6761 raw access (setting the flag) prevents use of those methods,
6762 bypassing hardware ECC logic.
6763 @i{This can be a dangerous option}, since writing blocks
6764 with the wrong ECC data can cause them to be marked as bad.
6765 @end deffn
6767 @anchor{nanddriverlist}
6768 @subsection NAND Driver List
6769 As noted above, the @command{nand device} command allows
6770 driver-specific options and behaviors.
6771 Some controllers also activate controller-specific commands.
6773 @deffn {NAND Driver} at91sam9
6774 This driver handles the NAND controllers found on AT91SAM9 family chips from
6775 Atmel. It takes two extra parameters: address of the NAND chip;
6776 address of the ECC controller.
6777 @example
6778 nand device $NANDFLASH at91sam9 $CHIPNAME 0x40000000 0xfffffe800
6779 @end example
6780 AT91SAM9 chips support single-bit ECC hardware. The @code{write_page} and
6781 @code{read_page} methods are used to utilize the ECC hardware unless they are
6782 disabled by using the @command{nand raw_access} command. There are four
6783 additional commands that are needed to fully configure the AT91SAM9 NAND
6784 controller. Two are optional; most boards use the same wiring for ALE/CLE:
6785 @deffn Command {at91sam9 cle} num addr_line
6786 Configure the address line used for latching commands. The @var{num}
6787 parameter is the value shown by @command{nand list}.
6788 @end deffn
6789 @deffn Command {at91sam9 ale} num addr_line
6790 Configure the address line used for latching addresses. The @var{num}
6791 parameter is the value shown by @command{nand list}.
6792 @end deffn
6794 For the next two commands, it is assumed that the pins have already been
6795 properly configured for input or output.
6796 @deffn Command {at91sam9 rdy_busy} num pio_base_addr pin
6797 Configure the RDY/nBUSY input from the NAND device. The @var{num}
6798 parameter is the value shown by @command{nand list}. @var{pio_base_addr}
6799 is the base address of the PIO controller and @var{pin} is the pin number.
6800 @end deffn
6801 @deffn Command {at91sam9 ce} num pio_base_addr pin
6802 Configure the chip enable input to the NAND device. The @var{num}
6803 parameter is the value shown by @command{nand list}. @var{pio_base_addr}
6804 is the base address of the PIO controller and @var{pin} is the pin number.
6805 @end deffn
6806 @end deffn
6808 @deffn {NAND Driver} davinci
6809 This driver handles the NAND controllers found on DaVinci family
6810 chips from Texas Instruments.
6811 It takes three extra parameters:
6812 address of the NAND chip;
6813 hardware ECC mode to use (@option{hwecc1},
6814 @option{hwecc4}, @option{hwecc4_infix});
6815 address of the AEMIF controller on this processor.
6816 @example
6817 nand device davinci dm355.arm 0x02000000 hwecc4 0x01e10000
6818 @end example
6819 All DaVinci processors support the single-bit ECC hardware,
6820 and newer ones also support the four-bit ECC hardware.
6821 The @code{write_page} and @code{read_page} methods are used
6822 to implement those ECC modes, unless they are disabled using
6823 the @command{nand raw_access} command.
6824 @end deffn
6826 @deffn {NAND Driver} lpc3180
6827 These controllers require an extra @command{nand device}
6828 parameter: the clock rate used by the controller.
6829 @deffn Command {lpc3180 select} num [mlc|slc]
6830 Configures use of the MLC or SLC controller mode.
6831 MLC implies use of hardware ECC.
6832 The @var{num} parameter is the value shown by @command{nand list}.
6833 @end deffn
6835 At this writing, this driver includes @code{write_page}
6836 and @code{read_page} methods. Using @command{nand raw_access}
6837 to disable those methods will prevent use of hardware ECC
6838 in the MLC controller mode, but won't change SLC behavior.
6839 @end deffn
6840 @comment current lpc3180 code won't issue 5-byte address cycles
6842 @deffn {NAND Driver} mx3
6843 This driver handles the NAND controller in i.MX31. The mxc driver
6844 should work for this chip aswell.
6845 @end deffn
6847 @deffn {NAND Driver} mxc
6848 This driver handles the NAND controller found in Freescale i.MX
6849 chips. It has support for v1 (i.MX27 and i.MX31) and v2 (i.MX35).
6850 The driver takes 3 extra arguments, chip (@option{mx27},
6851 @option{mx31}, @option{mx35}), ecc (@option{noecc}, @option{hwecc})
6852 and optionally if bad block information should be swapped between
6853 main area and spare area (@option{biswap}), defaults to off.
6854 @example
6855 nand device mx35.nand mxc imx35.cpu mx35 hwecc biswap
6856 @end example
6857 @deffn Command {mxc biswap} bank_num [enable|disable]
6858 Turns on/off bad block information swaping from main area,
6859 without parameter query status.
6860 @end deffn
6861 @end deffn
6863 @deffn {NAND Driver} orion
6864 These controllers require an extra @command{nand device}
6865 parameter: the address of the controller.
6866 @example
6867 nand device orion 0xd8000000
6868 @end example
6869 These controllers don't define any specialized commands.
6870 At this writing, their drivers don't include @code{write_page}
6871 or @code{read_page} methods, so @command{nand raw_access} won't
6872 change any behavior.
6873 @end deffn
6875 @deffn {NAND Driver} s3c2410
6876 @deffnx {NAND Driver} s3c2412
6877 @deffnx {NAND Driver} s3c2440
6878 @deffnx {NAND Driver} s3c2443
6879 @deffnx {NAND Driver} s3c6400
6880 These S3C family controllers don't have any special
6881 @command{nand device} options, and don't define any
6882 specialized commands.
6883 At this writing, their drivers don't include @code{write_page}
6884 or @code{read_page} methods, so @command{nand raw_access} won't
6885 change any behavior.
6886 @end deffn
6888 @section mFlash
6890 @subsection mFlash Configuration
6891 @cindex mFlash Configuration
6893 @deffn {Config Command} {mflash bank} soc base RST_pin target
6894 Configures a mflash for @var{soc} host bank at
6895 address @var{base}.
6896 The pin number format depends on the host GPIO naming convention.
6897 Currently, the mflash driver supports s3c2440 and pxa270.
6899 Example for s3c2440 mflash where @var{RST pin} is GPIO B1:
6901 @example
6902 mflash bank $_FLASHNAME s3c2440 0x10000000 1b 0
6903 @end example
6905 Example for pxa270 mflash where @var{RST pin} is GPIO 43:
6907 @example
6908 mflash bank $_FLASHNAME pxa270 0x08000000 43 0
6909 @end example
6910 @end deffn
6912 @subsection mFlash commands
6913 @cindex mFlash commands
6915 @deffn Command {mflash config pll} frequency
6916 Configure mflash PLL.
6917 The @var{frequency} is the mflash input frequency, in Hz.
6918 Issuing this command will erase mflash's whole internal nand and write new pll.
6919 After this command, mflash needs power-on-reset for normal operation.
6920 If pll was newly configured, storage and boot(optional) info also need to be update.
6921 @end deffn
6923 @deffn Command {mflash config boot}
6924 Configure bootable option.
6925 If bootable option is set, mflash offer the first 8 sectors
6926 (4kB) for boot.
6927 @end deffn
6929 @deffn Command {mflash config storage}
6930 Configure storage information.
6931 For the normal storage operation, this information must be
6932 written.
6933 @end deffn
6935 @deffn Command {mflash dump} num filename offset size
6936 Dump @var{size} bytes, starting at @var{offset} bytes from the
6937 beginning of the bank @var{num}, to the file named @var{filename}.
6938 @end deffn
6940 @deffn Command {mflash probe}
6941 Probe mflash.
6942 @end deffn
6944 @deffn Command {mflash write} num filename offset
6945 Write the binary file @var{filename} to mflash bank @var{num}, starting at
6946 @var{offset} bytes from the beginning of the bank.
6947 @end deffn
6949 @node Flash Programming
6950 @chapter Flash Programming
6952 OpenOCD implements numerous ways to program the target flash, whether internal or external.
6953 Programming can be acheived by either using GDB @ref{programmingusinggdb,,Programming using GDB},
6954 or using the cmds given in @ref{flashprogrammingcommands,,Flash Programming Commands}.
6956 @*To simplify using the flash cmds directly a jimtcl script is available that handles the programming and verify stage.
6957 OpenOCD will program/verify/reset the target and optionally shutdown.
6959 The script is executed as follows and by default the following actions will be peformed.
6960 @enumerate
6961 @item 'init' is executed.
6962 @item 'reset init' is called to reset and halt the target, any 'reset init' scripts are executed.
6963 @item @code{flash write_image} is called to erase and write any flash using the filename given.
6964 @item @code{verify_image} is called if @option{verify} parameter is given.
6965 @item @code{reset run} is called if @option{reset} parameter is given.
6966 @item OpenOCD is shutdown if @option{exit} parameter is given.
6967 @end enumerate
6969 An example of usage is given below. @xref{program}.
6971 @example
6972 # program and verify using elf/hex/s19. verify and reset
6973 # are optional parameters
6974 openocd -f board/stm32f3discovery.cfg \
6975         -c "program filename.elf verify reset exit"
6977 # binary files need the flash address passing
6978 openocd -f board/stm32f3discovery.cfg \
6979         -c "program filename.bin exit 0x08000000"
6980 @end example
6982 @node PLD/FPGA Commands
6983 @chapter PLD/FPGA Commands
6984 @cindex PLD
6985 @cindex FPGA
6987 Programmable Logic Devices (PLDs) and the more flexible
6988 Field Programmable Gate Arrays (FPGAs) are both types of programmable hardware.
6989 OpenOCD can support programming them.
6990 Although PLDs are generally restrictive (cells are less functional, and
6991 there are no special purpose cells for memory or computational tasks),
6992 they share the same OpenOCD infrastructure.
6993 Accordingly, both are called PLDs here.
6995 @section PLD/FPGA Configuration and Commands
6997 As it does for JTAG TAPs, debug targets, and flash chips (both NOR and NAND),
6998 OpenOCD maintains a list of PLDs available for use in various commands.
6999 Also, each such PLD requires a driver.
7001 They are referenced by the number shown by the @command{pld devices} command,
7002 and new PLDs are defined by @command{pld device driver_name}.
7004 @deffn {Config Command} {pld device} driver_name tap_name [driver_options]
7005 Defines a new PLD device, supported by driver @var{driver_name},
7006 using the TAP named @var{tap_name}.
7007 The driver may make use of any @var{driver_options} to configure its
7008 behavior.
7009 @end deffn
7011 @deffn {Command} {pld devices}
7012 Lists the PLDs and their numbers.
7013 @end deffn
7015 @deffn {Command} {pld load} num filename
7016 Loads the file @file{filename} into the PLD identified by @var{num}.
7017 The file format must be inferred by the driver.
7018 @end deffn
7020 @section PLD/FPGA Drivers, Options, and Commands
7022 Drivers may support PLD-specific options to the @command{pld device}
7023 definition command, and may also define commands usable only with
7024 that particular type of PLD.
7026 @deffn {FPGA Driver} virtex2 [no_jstart]
7027 Virtex-II is a family of FPGAs sold by Xilinx.
7028 It supports the IEEE 1532 standard for In-System Configuration (ISC).
7030 If @var{no_jstart} is non-zero, the JSTART instruction is not used after
7031 loading the bitstream. While required for Series2, Series3, and Series6, it
7032 breaks bitstream loading on Series7.
7034 @deffn {Command} {virtex2 read_stat} num
7035 Reads and displays the Virtex-II status register (STAT)
7036 for FPGA @var{num}.
7037 @end deffn
7038 @end deffn
7040 @node General Commands
7041 @chapter General Commands
7042 @cindex commands
7044 The commands documented in this chapter here are common commands that
7045 you, as a human, may want to type and see the output of. Configuration type
7046 commands are documented elsewhere.
7048 Intent:
7049 @itemize @bullet
7050 @item @b{Source Of Commands}
7051 @* OpenOCD commands can occur in a configuration script (discussed
7052 elsewhere) or typed manually by a human or supplied programatically,
7053 or via one of several TCP/IP Ports.
7055 @item @b{From the human}
7056 @* A human should interact with the telnet interface (default port: 4444)
7057 or via GDB (default port 3333).
7059 To issue commands from within a GDB session, use the @option{monitor}
7060 command, e.g. use @option{monitor poll} to issue the @option{poll}
7061 command. All output is relayed through the GDB session.
7063 @item @b{Machine Interface}
7064 The Tcl interface's intent is to be a machine interface. The default Tcl
7065 port is 5555.
7066 @end itemize
7069 @section Server Commands
7071 @deffn {Command} exit
7072 Exits the current telnet session.
7073 @end deffn
7075 @deffn {Command} help [string]
7076 With no parameters, prints help text for all commands.
7077 Otherwise, prints each helptext containing @var{string}.
7078 Not every command provides helptext.
7080 Configuration commands, and commands valid at any time, are
7081 explicitly noted in parenthesis.
7082 In most cases, no such restriction is listed; this indicates commands
7083 which are only available after the configuration stage has completed.
7084 @end deffn
7086 @deffn Command sleep msec [@option{busy}]
7087 Wait for at least @var{msec} milliseconds before resuming.
7088 If @option{busy} is passed, busy-wait instead of sleeping.
7089 (This option is strongly discouraged.)
7090 Useful in connection with script files
7091 (@command{script} command and @command{target_name} configuration).
7092 @end deffn
7094 @deffn Command shutdown [@option{error}]
7095 Close the OpenOCD server, disconnecting all clients (GDB, telnet,
7096 other). If option @option{error} is used, OpenOCD will return a
7097 non-zero exit code to the parent process.
7098 @end deffn
7100 @anchor{debuglevel}
7101 @deffn Command debug_level [n]
7102 @cindex message level
7103 Display debug level.
7104 If @var{n} (from 0..4) is provided, then set it to that level.
7105 This affects the kind of messages sent to the server log.
7106 Level 0 is error messages only;
7107 level 1 adds warnings;
7108 level 2 adds informational messages;
7109 level 3 adds debugging messages;
7110 and level 4 adds verbose low-level debug messages.
7111 The default is level 2, but that can be overridden on
7112 the command line along with the location of that log
7113 file (which is normally the server's standard output).
7114 @xref{Running}.
7115 @end deffn
7117 @deffn Command echo [-n] message
7118 Logs a message at "user" priority.
7119 Output @var{message} to stdout.
7120 Option "-n" suppresses trailing newline.
7121 @example
7122 echo "Downloading kernel -- please wait"
7123 @end example
7124 @end deffn
7126 @deffn Command log_output [filename]
7127 Redirect logging to @var{filename};
7128 the initial log output channel is stderr.
7129 @end deffn
7131 @deffn Command add_script_search_dir [directory]
7132 Add @var{directory} to the file/script search path.
7133 @end deffn
7135 @deffn Command bindto [name]
7136 Specify address by name on which to listen for incoming TCP/IP connections.
7137 By default, OpenOCD will listen on all available interfaces.
7138 @end deffn
7140 @anchor{targetstatehandling}
7141 @section Target State handling
7142 @cindex reset
7143 @cindex halt
7144 @cindex target initialization
7146 In this section ``target'' refers to a CPU configured as
7147 shown earlier (@pxref{CPU Configuration}).
7148 These commands, like many, implicitly refer to
7149 a current target which is used to perform the
7150 various operations. The current target may be changed
7151 by using @command{targets} command with the name of the
7152 target which should become current.
7154 @deffn Command reg [(number|name) [(value|'force')]]
7155 Access a single register by @var{number} or by its @var{name}.
7156 The target must generally be halted before access to CPU core
7157 registers is allowed. Depending on the hardware, some other
7158 registers may be accessible while the target is running.
7160 @emph{With no arguments}:
7161 list all available registers for the current target,
7162 showing number, name, size, value, and cache status.
7163 For valid entries, a value is shown; valid entries
7164 which are also dirty (and will be written back later)
7165 are flagged as such.
7167 @emph{With number/name}: display that register's value.
7168 Use @var{force} argument to read directly from the target,
7169 bypassing any internal cache.
7171 @emph{With both number/name and value}: set register's value.
7172 Writes may be held in a writeback cache internal to OpenOCD,
7173 so that setting the value marks the register as dirty instead
7174 of immediately flushing that value. Resuming CPU execution
7175 (including by single stepping) or otherwise activating the
7176 relevant module will flush such values.
7178 Cores may have surprisingly many registers in their
7179 Debug and trace infrastructure:
7181 @example
7182 > reg
7183 ===== ARM registers
7184 (0) r0 (/32): 0x0000D3C2 (dirty)
7185 (1) r1 (/32): 0xFD61F31C
7186 (2) r2 (/32)
7188 (164) ETM_contextid_comparator_mask (/32)
7190 @end example
7191 @end deffn
7193 @deffn Command halt [ms]
7194 @deffnx Command wait_halt [ms]
7195 The @command{halt} command first sends a halt request to the target,
7196 which @command{wait_halt} doesn't.
7197 Otherwise these behave the same: wait up to @var{ms} milliseconds,
7198 or 5 seconds if there is no parameter, for the target to halt
7199 (and enter debug mode).
7200 Using 0 as the @var{ms} parameter prevents OpenOCD from waiting.
7202 @quotation Warning
7203 On ARM cores, software using the @emph{wait for interrupt} operation
7204 often blocks the JTAG access needed by a @command{halt} command.
7205 This is because that operation also puts the core into a low
7206 power mode by gating the core clock;
7207 but the core clock is needed to detect JTAG clock transitions.
7209 One partial workaround uses adaptive clocking: when the core is
7210 interrupted the operation completes, then JTAG clocks are accepted
7211 at least until the interrupt handler completes.
7212 However, this workaround is often unusable since the processor, board,
7213 and JTAG adapter must all support adaptive JTAG clocking.
7214 Also, it can't work until an interrupt is issued.
7216 A more complete workaround is to not use that operation while you
7217 work with a JTAG debugger.
7218 Tasking environments generaly have idle loops where the body is the
7219 @emph{wait for interrupt} operation.
7220 (On older cores, it is a coprocessor action;
7221 newer cores have a @option{wfi} instruction.)
7222 Such loops can just remove that operation, at the cost of higher
7223 power consumption (because the CPU is needlessly clocked).
7224 @end quotation
7226 @end deffn
7228 @deffn Command resume [address]
7229 Resume the target at its current code position,
7230 or the optional @var{address} if it is provided.
7231 OpenOCD will wait 5 seconds for the target to resume.
7232 @end deffn
7234 @deffn Command step [address]
7235 Single-step the target at its current code position,
7236 or the optional @var{address} if it is provided.
7237 @end deffn
7239 @anchor{resetcommand}
7240 @deffn Command reset
7241 @deffnx Command {reset run}
7242 @deffnx Command {reset halt}
7243 @deffnx Command {reset init}
7244 Perform as hard a reset as possible, using SRST if possible.
7245 @emph{All defined targets will be reset, and target
7246 events will fire during the reset sequence.}
7248 The optional parameter specifies what should
7249 happen after the reset.
7250 If there is no parameter, a @command{reset run} is executed.
7251 The other options will not work on all systems.
7252 @xref{Reset Configuration}.
7254 @itemize @minus
7255 @item @b{run} Let the target run
7256 @item @b{halt} Immediately halt the target
7257 @item @b{init} Immediately halt the target, and execute the reset-init script
7258 @end itemize
7259 @end deffn
7261 @deffn Command soft_reset_halt
7262 Requesting target halt and executing a soft reset. This is often used
7263 when a target cannot be reset and halted. The target, after reset is
7264 released begins to execute code. OpenOCD attempts to stop the CPU and
7265 then sets the program counter back to the reset vector. Unfortunately
7266 the code that was executed may have left the hardware in an unknown
7267 state.
7268 @end deffn
7270 @section I/O Utilities
7272 These commands are available when
7273 OpenOCD is built with @option{--enable-ioutil}.
7274 They are mainly useful on embedded targets,
7275 notably the ZY1000.
7276 Hosts with operating systems have complementary tools.
7278 @emph{Note:} there are several more such commands.
7280 @deffn Command append_file filename [string]*
7281 Appends the @var{string} parameters to
7282 the text file @file{filename}.
7283 Each string except the last one is followed by one space.
7284 The last string is followed by a newline.
7285 @end deffn
7287 @deffn Command cat filename
7288 Reads and displays the text file @file{filename}.
7289 @end deffn
7291 @deffn Command cp src_filename dest_filename
7292 Copies contents from the file @file{src_filename}
7293 into @file{dest_filename}.
7294 @end deffn
7296 @deffn Command ip
7297 @emph{No description provided.}
7298 @end deffn
7300 @deffn Command ls
7301 @emph{No description provided.}
7302 @end deffn
7304 @deffn Command mac
7305 @emph{No description provided.}
7306 @end deffn
7308 @deffn Command meminfo
7309 Display available RAM memory on OpenOCD host.
7310 Used in OpenOCD regression testing scripts.
7311 @end deffn
7313 @deffn Command peek
7314 @emph{No description provided.}
7315 @end deffn
7317 @deffn Command poke
7318 @emph{No description provided.}
7319 @end deffn
7321 @deffn Command rm filename
7322 @c "rm" has both normal and Jim-level versions??
7323 Unlinks the file @file{filename}.
7324 @end deffn
7326 @deffn Command trunc filename
7327 Removes all data in the file @file{filename}.
7328 @end deffn
7330 @anchor{memoryaccess}
7331 @section Memory access commands
7332 @cindex memory access
7334 These commands allow accesses of a specific size to the memory
7335 system. Often these are used to configure the current target in some
7336 special way. For example - one may need to write certain values to the
7337 SDRAM controller to enable SDRAM.
7339 @enumerate
7340 @item Use the @command{targets} (plural) command
7341 to change the current target.
7342 @item In system level scripts these commands are deprecated.
7343 Please use their TARGET object siblings to avoid making assumptions
7344 about what TAP is the current target, or about MMU configuration.
7345 @end enumerate
7347 @deffn Command mdw [phys] addr [count]
7348 @deffnx Command mdh [phys] addr [count]
7349 @deffnx Command mdb [phys] addr [count]
7350 Display contents of address @var{addr}, as
7351 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
7352 or 8-bit bytes (@command{mdb}).
7353 When the current target has an MMU which is present and active,
7354 @var{addr} is interpreted as a virtual address.
7355 Otherwise, or if the optional @var{phys} flag is specified,
7356 @var{addr} is interpreted as a physical address.
7357 If @var{count} is specified, displays that many units.
7358 (If you want to manipulate the data instead of displaying it,
7359 see the @code{mem2array} primitives.)
7360 @end deffn
7362 @deffn Command mww [phys] addr word
7363 @deffnx Command mwh [phys] addr halfword
7364 @deffnx Command mwb [phys] addr byte
7365 Writes the specified @var{word} (32 bits),
7366 @var{halfword} (16 bits), or @var{byte} (8-bit) value,
7367 at the specified address @var{addr}.
7368 When the current target has an MMU which is present and active,
7369 @var{addr} is interpreted as a virtual address.
7370 Otherwise, or if the optional @var{phys} flag is specified,
7371 @var{addr} is interpreted as a physical address.
7372 @end deffn
7374 @anchor{imageaccess}
7375 @section Image loading commands
7376 @cindex image loading
7377 @cindex image dumping
7379 @deffn Command {dump_image} filename address size
7380 Dump @var{size} bytes of target memory starting at @var{address} to the
7381 binary file named @var{filename}.
7382 @end deffn
7384 @deffn Command {fast_load}
7385 Loads an image stored in memory by @command{fast_load_image} to the
7386 current target. Must be preceeded by fast_load_image.
7387 @end deffn
7389 @deffn Command {fast_load_image} filename address [@option{bin}|@option{ihex}|@option{elf}|@option{s19}]
7390 Normally you should be using @command{load_image} or GDB load. However, for
7391 testing purposes or when I/O overhead is significant(OpenOCD running on an embedded
7392 host), storing the image in memory and uploading the image to the target
7393 can be a way to upload e.g. multiple debug sessions when the binary does not change.
7394 Arguments are the same as @command{load_image}, but the image is stored in OpenOCD host
7395 memory, i.e. does not affect target. This approach is also useful when profiling
7396 target programming performance as I/O and target programming can easily be profiled
7397 separately.
7398 @end deffn
7400 @deffn Command {load_image} filename address [[@option{bin}|@option{ihex}|@option{elf}|@option{s19}] @option{min_addr} @option{max_length}]
7401 Load image from file @var{filename} to target memory offset by @var{address} from its load address.
7402 The file format may optionally be specified
7403 (@option{bin}, @option{ihex}, @option{elf}, or @option{s19}).
7404 In addition the following arguments may be specifed:
7405 @var{min_addr} - ignore data below @var{min_addr} (this is w.r.t. to the target's load address + @var{address})
7406 @var{max_length} - maximum number of bytes to load.
7407 @example
7408 proc load_image_bin @{fname foffset address length @} @{
7409     # Load data from fname filename at foffset offset to
7410     # target at address. Load at most length bytes.
7411     load_image $fname [expr $address - $foffset] bin \
7412                $address $length
7414 @end example
7415 @end deffn
7417 @deffn Command {test_image} filename [address [@option{bin}|@option{ihex}|@option{elf}]]
7418 Displays image section sizes and addresses
7419 as if @var{filename} were loaded into target memory
7420 starting at @var{address} (defaults to zero).
7421 The file format may optionally be specified
7422 (@option{bin}, @option{ihex}, or @option{elf})
7423 @end deffn
7425 @deffn Command {verify_image} filename address [@option{bin}|@option{ihex}|@option{elf}]
7426 Verify @var{filename} against target memory starting at @var{address}.
7427 The file format may optionally be specified
7428 (@option{bin}, @option{ihex}, or @option{elf})
7429 This will first attempt a comparison using a CRC checksum, if this fails it will try a binary compare.
7430 @end deffn
7432 @deffn Command {verify_image_checksum} filename address [@option{bin}|@option{ihex}|@option{elf}]
7433 Verify @var{filename} against target memory starting at @var{address}.
7434 The file format may optionally be specified
7435 (@option{bin}, @option{ihex}, or @option{elf})
7436 This perform a comparison using a CRC checksum only
7437 @end deffn
7440 @section Breakpoint and Watchpoint commands
7441 @cindex breakpoint
7442 @cindex watchpoint
7444 CPUs often make debug modules accessible through JTAG, with
7445 hardware support for a handful of code breakpoints and data
7446 watchpoints.
7447 In addition, CPUs almost always support software breakpoints.
7449 @deffn Command {bp} [address len [@option{hw}]]
7450 With no parameters, lists all active breakpoints.
7451 Else sets a breakpoint on code execution starting
7452 at @var{address} for @var{length} bytes.
7453 This is a software breakpoint, unless @option{hw} is specified
7454 in which case it will be a hardware breakpoint.
7456 (@xref{arm9vectorcatch,,arm9 vector_catch}, or @pxref{xscalevectorcatch,,xscale vector_catch},
7457 for similar mechanisms that do not consume hardware breakpoints.)
7458 @end deffn
7460 @deffn Command {rbp} address
7461 Remove the breakpoint at @var{address}.
7462 @end deffn
7464 @deffn Command {rwp} address
7465 Remove data watchpoint on @var{address}
7466 @end deffn
7468 @deffn Command {wp} [address len [(@option{r}|@option{w}|@option{a}) [value [mask]]]]
7469 With no parameters, lists all active watchpoints.
7470 Else sets a data watchpoint on data from @var{address} for @var{length} bytes.
7471 The watch point is an "access" watchpoint unless
7472 the @option{r} or @option{w} parameter is provided,
7473 defining it as respectively a read or write watchpoint.
7474 If a @var{value} is provided, that value is used when determining if
7475 the watchpoint should trigger. The value may be first be masked
7476 using @var{mask} to mark ``don't care'' fields.
7477 @end deffn
7479 @section Misc Commands
7481 @cindex profiling
7482 @deffn Command {profile} seconds filename [start end]
7483 Profiling samples the CPU's program counter as quickly as possible,
7484 which is useful for non-intrusive stochastic profiling.
7485 Saves up to 10000 samples in @file{filename} using ``gmon.out''
7486 format. Optional @option{start} and @option{end} parameters allow to
7487 limit the address range.
7488 @end deffn
7490 @deffn Command {version}
7491 Displays a string identifying the version of this OpenOCD server.
7492 @end deffn
7494 @deffn Command {virt2phys} virtual_address
7495 Requests the current target to map the specified @var{virtual_address}
7496 to its corresponding physical address, and displays the result.
7497 @end deffn
7499 @node Architecture and Core Commands
7500 @chapter Architecture and Core Commands
7501 @cindex Architecture Specific Commands
7502 @cindex Core Specific Commands
7504 Most CPUs have specialized JTAG operations to support debugging.
7505 OpenOCD packages most such operations in its standard command framework.
7506 Some of those operations don't fit well in that framework, so they are
7507 exposed here as architecture or implementation (core) specific commands.
7509 @anchor{armhardwaretracing}
7510 @section ARM Hardware Tracing
7511 @cindex tracing
7512 @cindex ETM
7513 @cindex ETB
7515 CPUs based on ARM cores may include standard tracing interfaces,
7516 based on an ``Embedded Trace Module'' (ETM) which sends voluminous
7517 address and data bus trace records to a ``Trace Port''.
7519 @itemize
7520 @item
7521 Development-oriented boards will sometimes provide a high speed
7522 trace connector for collecting that data, when the particular CPU
7523 supports such an interface.
7524 (The standard connector is a 38-pin Mictor, with both JTAG
7525 and trace port support.)
7526 Those trace connectors are supported by higher end JTAG adapters
7527 and some logic analyzer modules; frequently those modules can
7528 buffer several megabytes of trace data.
7529 Configuring an ETM coupled to such an external trace port belongs
7530 in the board-specific configuration file.
7531 @item
7532 If the CPU doesn't provide an external interface, it probably
7533 has an ``Embedded Trace Buffer'' (ETB) on the chip, which is a
7534 dedicated SRAM. 4KBytes is one common ETB size.
7535 Configuring an ETM coupled only to an ETB belongs in the CPU-specific
7536 (target) configuration file, since it works the same on all boards.
7537 @end itemize
7539 ETM support in OpenOCD doesn't seem to be widely used yet.
7541 @quotation Issues
7542 ETM support may be buggy, and at least some @command{etm config}
7543 parameters should be detected by asking the ETM for them.
7545 ETM trigger events could also implement a kind of complex
7546 hardware breakpoint, much more powerful than the simple
7547 watchpoint hardware exported by EmbeddedICE modules.
7548 @emph{Such breakpoints can be triggered even when using the
7549 dummy trace port driver}.
7551 It seems like a GDB hookup should be possible,
7552 as well as tracing only during specific states
7553 (perhaps @emph{handling IRQ 23} or @emph{calls foo()}).
7555 There should be GUI tools to manipulate saved trace data and help
7556 analyse it in conjunction with the source code.
7557 It's unclear how much of a common interface is shared
7558 with the current XScale trace support, or should be
7559 shared with eventual Nexus-style trace module support.
7561 At this writing (November 2009) only ARM7, ARM9, and ARM11 support
7562 for ETM modules is available. The code should be able to
7563 work with some newer cores; but not all of them support
7564 this original style of JTAG access.
7565 @end quotation
7567 @subsection ETM Configuration
7568 ETM setup is coupled with the trace port driver configuration.
7570 @deffn {Config Command} {etm config} target width mode clocking driver
7571 Declares the ETM associated with @var{target}, and associates it
7572 with a given trace port @var{driver}. @xref{traceportdrivers,,Trace Port Drivers}.
7574 Several of the parameters must reflect the trace port capabilities,
7575 which are a function of silicon capabilties (exposed later
7576 using @command{etm info}) and of what hardware is connected to
7577 that port (such as an external pod, or ETB).
7578 The @var{width} must be either 4, 8, or 16,
7579 except with ETMv3.0 and newer modules which may also
7580 support 1, 2, 24, 32, 48, and 64 bit widths.
7581 (With those versions, @command{etm info} also shows whether
7582 the selected port width and mode are supported.)
7584 The @var{mode} must be @option{normal}, @option{multiplexed},
7585 or @option{demultiplexed}.
7586 The @var{clocking} must be @option{half} or @option{full}.
7588 @quotation Warning
7589 With ETMv3.0 and newer, the bits set with the @var{mode} and
7590 @var{clocking} parameters both control the mode.
7591 This modified mode does not map to the values supported by
7592 previous ETM modules, so this syntax is subject to change.
7593 @end quotation
7595 @quotation Note
7596 You can see the ETM registers using the @command{reg} command.
7597 Not all possible registers are present in every ETM.
7598 Most of the registers are write-only, and are used to configure
7599 what CPU activities are traced.
7600 @end quotation
7601 @end deffn
7603 @deffn Command {etm info}
7604 Displays information about the current target's ETM.
7605 This includes resource counts from the @code{ETM_CONFIG} register,
7606 as well as silicon capabilities (except on rather old modules).
7607 from the @code{ETM_SYS_CONFIG} register.
7608 @end deffn
7610 @deffn Command {etm status}
7611 Displays status of the current target's ETM and trace port driver:
7612 is the ETM idle, or is it collecting data?
7613 Did trace data overflow?
7614 Was it triggered?
7615 @end deffn
7617 @deffn Command {etm tracemode} [type context_id_bits cycle_accurate branch_output]
7618 Displays what data that ETM will collect.
7619 If arguments are provided, first configures that data.
7620 When the configuration changes, tracing is stopped
7621 and any buffered trace data is invalidated.
7623 @itemize
7624 @item @var{type} ... describing how data accesses are traced,
7625 when they pass any ViewData filtering that that was set up.
7626 The value is one of
7627 @option{none} (save nothing),
7628 @option{data} (save data),
7629 @option{address} (save addresses),
7630 @option{all} (save data and addresses)
7631 @item @var{context_id_bits} ... 0, 8, 16, or 32
7632 @item @var{cycle_accurate} ... @option{enable} or @option{disable}
7633 cycle-accurate instruction tracing.
7634 Before ETMv3, enabling this causes much extra data to be recorded.
7635 @item @var{branch_output} ... @option{enable} or @option{disable}.
7636 Disable this unless you need to try reconstructing the instruction
7637 trace stream without an image of the code.
7638 @end itemize
7639 @end deffn
7641 @deffn Command {etm trigger_debug} (@option{enable}|@option{disable})
7642 Displays whether ETM triggering debug entry (like a breakpoint) is
7643 enabled or disabled, after optionally modifying that configuration.
7644 The default behaviour is @option{disable}.
7645 Any change takes effect after the next @command{etm start}.
7647 By using script commands to configure ETM registers, you can make the
7648 processor enter debug state automatically when certain conditions,
7649 more complex than supported by the breakpoint hardware, happen.
7650 @end deffn
7652 @subsection ETM Trace Operation
7654 After setting up the ETM, you can use it to collect data.
7655 That data can be exported to files for later analysis.
7656 It can also be parsed with OpenOCD, for basic sanity checking.
7658 To configure what is being traced, you will need to write
7659 various trace registers using @command{reg ETM_*} commands.
7660 For the definitions of these registers, read ARM publication
7661 @emph{IHI 0014, ``Embedded Trace Macrocell, Architecture Specification''}.
7662 Be aware that most of the relevant registers are write-only,
7663 and that ETM resources are limited. There are only a handful
7664 of address comparators, data comparators, counters, and so on.
7666 Examples of scenarios you might arrange to trace include:
7668 @itemize
7669 @item Code flow within a function, @emph{excluding} subroutines
7670 it calls. Use address range comparators to enable tracing
7671 for instruction access within that function's body.
7672 @item Code flow within a function, @emph{including} subroutines
7673 it calls. Use the sequencer and address comparators to activate
7674 tracing on an ``entered function'' state, then deactivate it by
7675 exiting that state when the function's exit code is invoked.
7676 @item Code flow starting at the fifth invocation of a function,
7677 combining one of the above models with a counter.
7678 @item CPU data accesses to the registers for a particular device,
7679 using address range comparators and the ViewData logic.
7680 @item Such data accesses only during IRQ handling, combining the above
7681 model with sequencer triggers which on entry and exit to the IRQ handler.
7682 @item @emph{... more}
7683 @end itemize
7685 At this writing, September 2009, there are no Tcl utility
7686 procedures to help set up any common tracing scenarios.
7688 @deffn Command {etm analyze}
7689 Reads trace data into memory, if it wasn't already present.
7690 Decodes and prints the data that was collected.
7691 @end deffn
7693 @deffn Command {etm dump} filename
7694 Stores the captured trace data in @file{filename}.
7695 @end deffn
7697 @deffn Command {etm image} filename [base_address] [type]
7698 Opens an image file.
7699 @end deffn
7701 @deffn Command {etm load} filename
7702 Loads captured trace data from @file{filename}.
7703 @end deffn
7705 @deffn Command {etm start}
7706 Starts trace data collection.
7707 @end deffn
7709 @deffn Command {etm stop}
7710 Stops trace data collection.
7711 @end deffn
7713 @anchor{traceportdrivers}
7714 @subsection Trace Port Drivers
7716 To use an ETM trace port it must be associated with a driver.
7718 @deffn {Trace Port Driver} dummy
7719 Use the @option{dummy} driver if you are configuring an ETM that's
7720 not connected to anything (on-chip ETB or off-chip trace connector).
7721 @emph{This driver lets OpenOCD talk to the ETM, but it does not expose
7722 any trace data collection.}
7723 @deffn {Config Command} {etm_dummy config} target
7724 Associates the ETM for @var{target} with a dummy driver.
7725 @end deffn
7726 @end deffn
7728 @deffn {Trace Port Driver} etb
7729 Use the @option{etb} driver if you are configuring an ETM
7730 to use on-chip ETB memory.
7731 @deffn {Config Command} {etb config} target etb_tap
7732 Associates the ETM for @var{target} with the ETB at @var{etb_tap}.
7733 You can see the ETB registers using the @command{reg} command.
7734 @end deffn
7735 @deffn Command {etb trigger_percent} [percent]
7736 This displays, or optionally changes, ETB behavior after the
7737 ETM's configured @emph{trigger} event fires.
7738 It controls how much more trace data is saved after the (single)
7739 trace trigger becomes active.
7741 @itemize
7742 @item The default corresponds to @emph{trace around} usage,
7743 recording 50 percent data before the event and the rest
7744 afterwards.
7745 @item The minimum value of @var{percent} is 2 percent,
7746 recording almost exclusively data before the trigger.
7747 Such extreme @emph{trace before} usage can help figure out
7748 what caused that event to happen.
7749 @item The maximum value of @var{percent} is 100 percent,
7750 recording data almost exclusively after the event.
7751 This extreme @emph{trace after} usage might help sort out
7752 how the event caused trouble.
7753 @end itemize
7754 @c REVISIT allow "break" too -- enter debug mode.
7755 @end deffn
7757 @end deffn
7759 @deffn {Trace Port Driver} oocd_trace
7760 This driver isn't available unless OpenOCD was explicitly configured
7761 with the @option{--enable-oocd_trace} option. You probably don't want
7762 to configure it unless you've built the appropriate prototype hardware;
7763 it's @emph{proof-of-concept} software.
7765 Use the @option{oocd_trace} driver if you are configuring an ETM that's
7766 connected to an off-chip trace connector.
7768 @deffn {Config Command} {oocd_trace config} target tty
7769 Associates the ETM for @var{target} with a trace driver which
7770 collects data through the serial port @var{tty}.
7771 @end deffn
7773 @deffn Command {oocd_trace resync}
7774 Re-synchronizes with the capture clock.
7775 @end deffn
7777 @deffn Command {oocd_trace status}
7778 Reports whether the capture clock is locked or not.
7779 @end deffn
7780 @end deffn
7783 @section Generic ARM
7784 @cindex ARM
7786 These commands should be available on all ARM processors.
7787 They are available in addition to other core-specific
7788 commands that may be available.
7790 @deffn Command {arm core_state} [@option{arm}|@option{thumb}]
7791 Displays the core_state, optionally changing it to process
7792 either @option{arm} or @option{thumb} instructions.
7793 The target may later be resumed in the currently set core_state.
7794 (Processors may also support the Jazelle state, but
7795 that is not currently supported in OpenOCD.)
7796 @end deffn
7798 @deffn Command {arm disassemble} address [count [@option{thumb}]]
7799 @cindex disassemble
7800 Disassembles @var{count} instructions starting at @var{address}.
7801 If @var{count} is not specified, a single instruction is disassembled.
7802 If @option{thumb} is specified, or the low bit of the address is set,
7803 Thumb2 (mixed 16/32-bit) instructions are used;
7804 else ARM (32-bit) instructions are used.
7805 (Processors may also support the Jazelle state, but
7806 those instructions are not currently understood by OpenOCD.)
7808 Note that all Thumb instructions are Thumb2 instructions,
7809 so older processors (without Thumb2 support) will still
7810 see correct disassembly of Thumb code.
7811 Also, ThumbEE opcodes are the same as Thumb2,
7812 with a handful of exceptions.
7813 ThumbEE disassembly currently has no explicit support.
7814 @end deffn
7816 @deffn Command {arm mcr} pX op1 CRn CRm op2 value
7817 Write @var{value} to a coprocessor @var{pX} register
7818 passing parameters @var{CRn},
7819 @var{CRm}, opcodes @var{opc1} and @var{opc2},
7820 and using the MCR instruction.
7821 (Parameter sequence matches the ARM instruction, but omits
7822 an ARM register.)
7823 @end deffn
7825 @deffn Command {arm mrc} pX coproc op1 CRn CRm op2
7826 Read a coprocessor @var{pX} register passing parameters @var{CRn},
7827 @var{CRm}, opcodes @var{opc1} and @var{opc2},
7828 and the MRC instruction.
7829 Returns the result so it can be manipulated by Jim scripts.
7830 (Parameter sequence matches the ARM instruction, but omits
7831 an ARM register.)
7832 @end deffn
7834 @deffn Command {arm reg}
7835 Display a table of all banked core registers, fetching the current value from every
7836 core mode if necessary.
7837 @end deffn
7839 @deffn Command {arm semihosting} [@option{enable}|@option{disable}]
7840 @cindex ARM semihosting
7841 Display status of semihosting, after optionally changing that status.
7843 Semihosting allows for code executing on an ARM target to use the
7844 I/O facilities on the host computer i.e. the system where OpenOCD
7845 is running. The target application must be linked against a library
7846 implementing the ARM semihosting convention that forwards operation
7847 requests by using a special SVC instruction that is trapped at the
7848 Supervisor Call vector by OpenOCD.
7849 @end deffn
7851 @deffn Command {arm semihosting_cmdline} [@option{enable}|@option{disable}]
7852 @cindex ARM semihosting
7853 Set the command line to be passed to the debuggee.
7855 @example
7856 arm semihosting_cmdline argv0 argv1 argv2 ...
7857 @end example
7859 This option lets one set the command line arguments to be passed to
7860 the program. The first argument (argv0) is the program name in a
7861 standard C environment (argv[0]). Depending on the program (not much
7862 programs look at argv[0]), argv0 is ignored and can be any string.
7863 @end deffn
7865 @deffn Command {arm semihosting_fileio} [@option{enable}|@option{disable}]
7866 @cindex ARM semihosting
7867 Display status of semihosting fileio, after optionally changing that
7868 status.
7870 Enabling this option forwards semihosting I/O to GDB process using the
7871 File-I/O remote protocol extension. This is especially useful for
7872 interacting with remote files or displaying console messages in the
7873 debugger.
7874 @end deffn
7876 @section ARMv4 and ARMv5 Architecture
7877 @cindex ARMv4
7878 @cindex ARMv5
7880 The ARMv4 and ARMv5 architectures are widely used in embedded systems,
7881 and introduced core parts of the instruction set in use today.
7882 That includes the Thumb instruction set, introduced in the ARMv4T
7883 variant.
7885 @subsection ARM7 and ARM9 specific commands
7886 @cindex ARM7
7887 @cindex ARM9
7889 These commands are specific to ARM7 and ARM9 cores, like ARM7TDMI, ARM720T,
7890 ARM9TDMI, ARM920T or ARM926EJ-S.
7891 They are available in addition to the ARM commands,
7892 and any other core-specific commands that may be available.
7894 @deffn Command {arm7_9 dbgrq} [@option{enable}|@option{disable}]
7895 Displays the value of the flag controlling use of the
7896 the EmbeddedIce DBGRQ signal to force entry into debug mode,
7897 instead of breakpoints.
7898 If a boolean parameter is provided, first assigns that flag.
7900 This should be
7901 safe for all but ARM7TDMI-S cores (like NXP LPC).
7902 This feature is enabled by default on most ARM9 cores,
7903 including ARM9TDMI, ARM920T, and ARM926EJ-S.
7904 @end deffn
7906 @deffn Command {arm7_9 dcc_downloads} [@option{enable}|@option{disable}]
7907 @cindex DCC
7908 Displays the value of the flag controlling use of the debug communications
7909 channel (DCC) to write larger (>128 byte) amounts of memory.
7910 If a boolean parameter is provided, first assigns that flag.
7912 DCC downloads offer a huge speed increase, but might be
7913 unsafe, especially with targets running at very low speeds. This command was introduced
7914 with OpenOCD rev. 60, and requires a few bytes of working area.
7915 @end deffn
7917 @deffn Command {arm7_9 fast_memory_access} [@option{enable}|@option{disable}]
7918 Displays the value of the flag controlling use of memory writes and reads
7919 that don't check completion of the operation.
7920 If a boolean parameter is provided, first assigns that flag.
7922 This provides a huge speed increase, especially with USB JTAG
7923 cables (FT2232), but might be unsafe if used with targets running at very low
7924 speeds, like the 32kHz startup clock of an AT91RM9200.
7925 @end deffn
7927 @subsection ARM720T specific commands
7928 @cindex ARM720T
7930 These commands are available to ARM720T based CPUs,
7931 which are implementations of the ARMv4T architecture
7932 based on the ARM7TDMI-S integer core.
7933 They are available in addition to the ARM and ARM7/ARM9 commands.
7935 @deffn Command {arm720t cp15} opcode [value]
7936 @emph{DEPRECATED -- avoid using this.
7937 Use the @command{arm mrc} or @command{arm mcr} commands instead.}
7939 Display cp15 register returned by the ARM instruction @var{opcode};
7940 else if a @var{value} is provided, that value is written to that register.
7941 The @var{opcode} should be the value of either an MRC or MCR instruction.
7942 @end deffn
7944 @subsection ARM9 specific commands
7945 @cindex ARM9
7947 ARM9-family cores are built around ARM9TDMI or ARM9E (including ARM9EJS)
7948 integer processors.
7949 Such cores include the ARM920T, ARM926EJ-S, and ARM966.
7951 @c 9-june-2009: tried this on arm920t, it didn't work.
7952 @c no-params always lists nothing caught, and that's how it acts.
7953 @c 23-oct-2009: doesn't work _consistently_ ... as if the ICE
7954 @c versions have different rules about when they commit writes.
7956 @anchor{arm9vectorcatch}
7957 @deffn Command {arm9 vector_catch} [@option{all}|@option{none}|list]
7958 @cindex vector_catch
7959 Vector Catch hardware provides a sort of dedicated breakpoint
7960 for hardware events such as reset, interrupt, and abort.
7961 You can use this to conserve normal breakpoint resources,
7962 so long as you're not concerned with code that branches directly
7963 to those hardware vectors.
7965 This always finishes by listing the current configuration.
7966 If parameters are provided, it first reconfigures the
7967 vector catch hardware to intercept
7968 @option{all} of the hardware vectors,
7969 @option{none} of them,
7970 or a list with one or more of the following:
7971 @option{reset} @option{undef} @option{swi} @option{pabt} @option{dabt}
7972 @option{irq} @option{fiq}.
7973 @end deffn
7975 @subsection ARM920T specific commands
7976 @cindex ARM920T
7978 These commands are available to ARM920T based CPUs,
7979 which are implementations of the ARMv4T architecture
7980 built using the ARM9TDMI integer core.
7981 They are available in addition to the ARM, ARM7/ARM9,
7982 and ARM9 commands.
7984 @deffn Command {arm920t cache_info}
7985 Print information about the caches found. This allows to see whether your target
7986 is an ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
7987 @end deffn
7989 @deffn Command {arm920t cp15} regnum [value]
7990 Display cp15 register @var{regnum};
7991 else if a @var{value} is provided, that value is written to that register.
7992 This uses "physical access" and the register number is as
7993 shown in bits 38..33 of table 9-9 in the ARM920T TRM.
7994 (Not all registers can be written.)
7995 @end deffn
7997 @deffn Command {arm920t cp15i} opcode [value [address]]
7998 @emph{DEPRECATED -- avoid using this.
7999 Use the @command{arm mrc} or @command{arm mcr} commands instead.}
8001 Interpreted access using ARM instruction @var{opcode}, which should
8002 be the value of either an MRC or MCR instruction
8003 (as shown tables 9-11, 9-12, and 9-13 in the ARM920T TRM).
8004 If no @var{value} is provided, the result is displayed.
8005 Else if that value is written using the specified @var{address},
8006 or using zero if no other address is provided.
8007 @end deffn
8009 @deffn Command {arm920t read_cache} filename
8010 Dump the content of ICache and DCache to a file named @file{filename}.
8011 @end deffn
8013 @deffn Command {arm920t read_mmu} filename
8014 Dump the content of the ITLB and DTLB to a file named @file{filename}.
8015 @end deffn
8017 @subsection ARM926ej-s specific commands
8018 @cindex ARM926ej-s
8020 These commands are available to ARM926ej-s based CPUs,
8021 which are implementations of the ARMv5TEJ architecture
8022 based on the ARM9EJ-S integer core.
8023 They are available in addition to the ARM, ARM7/ARM9,
8024 and ARM9 commands.
8026 The Feroceon cores also support these commands, although
8027 they are not built from ARM926ej-s designs.
8029 @deffn Command {arm926ejs cache_info}
8030 Print information about the caches found.
8031 @end deffn
8033 @subsection ARM966E specific commands
8034 @cindex ARM966E
8036 These commands are available to ARM966 based CPUs,
8037 which are implementations of the ARMv5TE architecture.
8038 They are available in addition to the ARM, ARM7/ARM9,
8039 and ARM9 commands.
8041 @deffn Command {arm966e cp15} regnum [value]
8042 Display cp15 register @var{regnum};
8043 else if a @var{value} is provided, that value is written to that register.
8044 The six bit @var{regnum} values are bits 37..32 from table 7-2 of the
8045 ARM966E-S TRM.
8046 There is no current control over bits 31..30 from that table,
8047 as required for BIST support.
8048 @end deffn
8050 @subsection XScale specific commands
8051 @cindex XScale
8053 Some notes about the debug implementation on the XScale CPUs:
8055 The XScale CPU provides a special debug-only mini-instruction cache
8056 (mini-IC) in which exception vectors and target-resident debug handler
8057 code are placed by OpenOCD. In order to get access to the CPU, OpenOCD
8058 must point vector 0 (the reset vector) to the entry of the debug
8059 handler. However, this means that the complete first cacheline in the
8060 mini-IC is marked valid, which makes the CPU fetch all exception
8061 handlers from the mini-IC, ignoring the code in RAM.
8063 To address this situation, OpenOCD provides the @code{xscale
8064 vector_table} command, which allows the user to explicity write
8065 individual entries to either the high or low vector table stored in
8066 the mini-IC.
8068 It is recommended to place a pc-relative indirect branch in the vector
8069 table, and put the branch destination somewhere in memory. Doing so
8070 makes sure the code in the vector table stays constant regardless of
8071 code layout in memory:
8072 @example
8073 _vectors:
8074         ldr     pc,[pc,#0x100-8]
8075         ldr     pc,[pc,#0x100-8]
8076         ldr     pc,[pc,#0x100-8]
8077         ldr     pc,[pc,#0x100-8]
8078         ldr     pc,[pc,#0x100-8]
8079         ldr     pc,[pc,#0x100-8]
8080         ldr     pc,[pc,#0x100-8]
8081         ldr     pc,[pc,#0x100-8]
8082         .org 0x100
8083         .long real_reset_vector
8084         .long real_ui_handler
8085         .long real_swi_handler
8086         .long real_pf_abort
8087         .long real_data_abort
8088         .long 0 /* unused */
8089         .long real_irq_handler
8090         .long real_fiq_handler
8091 @end example
8093 Alternatively, you may choose to keep some or all of the mini-IC
8094 vector table entries synced with those written to memory by your
8095 system software. The mini-IC can not be modified while the processor
8096 is executing, but for each vector table entry not previously defined
8097 using the @code{xscale vector_table} command, OpenOCD will copy the
8098 value from memory to the mini-IC every time execution resumes from a
8099 halt. This is done for both high and low vector tables (although the
8100 table not in use may not be mapped to valid memory, and in this case
8101 that copy operation will silently fail). This means that you will
8102 need to briefly halt execution at some strategic point during system
8103 start-up; e.g., after the software has initialized the vector table,
8104 but before exceptions are enabled. A breakpoint can be used to
8105 accomplish this once the appropriate location in the start-up code has
8106 been identified. A watchpoint over the vector table region is helpful
8107 in finding the location if you're not sure. Note that the same
8108 situation exists any time the vector table is modified by the system
8109 software.
8111 The debug handler must be placed somewhere in the address space using
8112 the @code{xscale debug_handler} command. The allowed locations for the
8113 debug handler are either (0x800 - 0x1fef800) or (0xfe000800 -
8114 0xfffff800). The default value is 0xfe000800.
8116 XScale has resources to support two hardware breakpoints and two
8117 watchpoints. However, the following restrictions on watchpoint
8118 functionality apply: (1) the value and mask arguments to the @code{wp}
8119 command are not supported, (2) the watchpoint length must be a
8120 power of two and not less than four, and can not be greater than the
8121 watchpoint address, and (3) a watchpoint with a length greater than
8122 four consumes all the watchpoint hardware resources. This means that
8123 at any one time, you can have enabled either two watchpoints with a
8124 length of four, or one watchpoint with a length greater than four.
8126 These commands are available to XScale based CPUs,
8127 which are implementations of the ARMv5TE architecture.
8129 @deffn Command {xscale analyze_trace}
8130 Displays the contents of the trace buffer.
8131 @end deffn
8133 @deffn Command {xscale cache_clean_address} address
8134 Changes the address used when cleaning the data cache.
8135 @end deffn
8137 @deffn Command {xscale cache_info}
8138 Displays information about the CPU caches.
8139 @end deffn
8141 @deffn Command {xscale cp15} regnum [value]
8142 Display cp15 register @var{regnum};
8143 else if a @var{value} is provided, that value is written to that register.
8144 @end deffn
8146 @deffn Command {xscale debug_handler} target address
8147 Changes the address used for the specified target's debug handler.
8148 @end deffn
8150 @deffn Command {xscale dcache} [@option{enable}|@option{disable}]
8151 Enables or disable the CPU's data cache.
8152 @end deffn
8154 @deffn Command {xscale dump_trace} filename
8155 Dumps the raw contents of the trace buffer to @file{filename}.
8156 @end deffn
8158 @deffn Command {xscale icache} [@option{enable}|@option{disable}]
8159 Enables or disable the CPU's instruction cache.
8160 @end deffn
8162 @deffn Command {xscale mmu} [@option{enable}|@option{disable}]
8163 Enables or disable the CPU's memory management unit.
8164 @end deffn
8166 @deffn Command {xscale trace_buffer} [@option{enable}|@option{disable} [@option{fill} [n] | @option{wrap}]]
8167 Displays the trace buffer status, after optionally
8168 enabling or disabling the trace buffer
8169 and modifying how it is emptied.
8170 @end deffn
8172 @deffn Command {xscale trace_image} filename [offset [type]]
8173 Opens a trace image from @file{filename}, optionally rebasing
8174 its segment addresses by @var{offset}.
8175 The image @var{type} may be one of
8176 @option{bin} (binary), @option{ihex} (Intel hex),
8177 @option{elf} (ELF file), @option{s19} (Motorola s19),
8178 @option{mem}, or @option{builder}.
8179 @end deffn
8181 @anchor{xscalevectorcatch}
8182 @deffn Command {xscale vector_catch} [mask]
8183 @cindex vector_catch
8184 Display a bitmask showing the hardware vectors to catch.
8185 If the optional parameter is provided, first set the bitmask to that value.
8187 The mask bits correspond with bit 16..23 in the DCSR:
8188 @example
8189 0x01    Trap Reset
8190 0x02    Trap Undefined Instructions
8191 0x04    Trap Software Interrupt
8192 0x08    Trap Prefetch Abort
8193 0x10    Trap Data Abort
8194 0x20    reserved
8195 0x40    Trap IRQ
8196 0x80    Trap FIQ
8197 @end example
8198 @end deffn
8200 @deffn Command {xscale vector_table} [(@option{low}|@option{high}) index value]
8201 @cindex vector_table
8203 Set an entry in the mini-IC vector table. There are two tables: one for
8204 low vectors (at 0x00000000), and one for high vectors (0xFFFF0000), each
8205 holding the 8 exception vectors. @var{index} can be 1-7, because vector 0
8206 points to the debug handler entry and can not be overwritten.
8207 @var{value} holds the 32-bit opcode that is placed in the mini-IC.
8209 Without arguments, the current settings are displayed.
8211 @end deffn
8213 @section ARMv6 Architecture
8214 @cindex ARMv6
8216 @subsection ARM11 specific commands
8217 @cindex ARM11
8219 @deffn Command {arm11 memwrite burst} [@option{enable}|@option{disable}]
8220 Displays the value of the memwrite burst-enable flag,
8221 which is enabled by default.
8222 If a boolean parameter is provided, first assigns that flag.
8223 Burst writes are only used for memory writes larger than 1 word.
8224 They improve performance by assuming that the CPU has read each data
8225 word over JTAG and completed its write before the next word arrives,
8226 instead of polling for a status flag to verify that completion.
8227 This is usually safe, because JTAG runs much slower than the CPU.
8228 @end deffn
8230 @deffn Command {arm11 memwrite error_fatal} [@option{enable}|@option{disable}]
8231 Displays the value of the memwrite error_fatal flag,
8232 which is enabled by default.
8233 If a boolean parameter is provided, first assigns that flag.
8234 When set, certain memory write errors cause earlier transfer termination.
8235 @end deffn
8237 @deffn Command {arm11 step_irq_enable} [@option{enable}|@option{disable}]
8238 Displays the value of the flag controlling whether
8239 IRQs are enabled during single stepping;
8240 they are disabled by default.
8241 If a boolean parameter is provided, first assigns that.
8242 @end deffn
8244 @deffn Command {arm11 vcr} [value]
8245 @cindex vector_catch
8246 Displays the value of the @emph{Vector Catch Register (VCR)},
8247 coprocessor 14 register 7.
8248 If @var{value} is defined, first assigns that.
8250 Vector Catch hardware provides dedicated breakpoints
8251 for certain hardware events.
8252 The specific bit values are core-specific (as in fact is using
8253 coprocessor 14 register 7 itself) but all current ARM11
8254 cores @emph{except the ARM1176} use the same six bits.
8255 @end deffn
8257 @section ARMv7 and ARMv8 Architecture
8258 @cindex ARMv7
8259 @cindex ARMv8
8261 @subsection ARMv7 and ARMv8 Debug Access Port (DAP) specific commands
8262 @cindex Debug Access Port
8263 @cindex DAP
8264 These commands are specific to ARM architecture v7 and v8 Debug Access Port (DAP),
8265 included on Cortex-M and Cortex-A systems.
8266 They are available in addition to other core-specific commands that may be available.
8268 @deffn Command {dap apid} [num]
8269 Displays ID register from AP @var{num},
8270 defaulting to the currently selected AP.
8271 @end deffn
8273 @deffn Command {dap apreg} ap_num reg [value]
8274 Displays content of a register @var{reg} from AP @var{ap_num}
8275 or set a new value @var{value}.
8276 @var{reg} is byte address of a word register, 0, 4, 8 ... 0xfc.
8277 @end deffn
8279 @deffn Command {dap apsel} [num]
8280 Select AP @var{num}, defaulting to 0.
8281 @end deffn
8283 @deffn Command {dap baseaddr} [num]
8284 Displays debug base address from MEM-AP @var{num},
8285 defaulting to the currently selected AP.
8286 @end deffn
8288 @deffn Command {dap info} [num]
8289 Displays the ROM table for MEM-AP @var{num},
8290 defaulting to the currently selected AP.
8291 @end deffn
8293 @deffn Command {dap memaccess} [value]
8294 Displays the number of extra tck cycles in the JTAG idle to use for MEM-AP
8295 memory bus access [0-255], giving additional time to respond to reads.
8296 If @var{value} is defined, first assigns that.
8297 @end deffn
8299 @deffn Command {dap apcsw} [0 / 1]
8300 fix CSW_SPROT from register AP_REG_CSW on selected dap.
8301 Defaulting to 0.
8302 @end deffn
8304 @deffn Command {dap ti_be_32_quirks} [@option{enable}]
8305 Set/get quirks mode for TI TMS450/TMS570 processors
8306 Disabled by default
8307 @end deffn
8310 @subsection ARMv7-A specific commands
8311 @cindex Cortex-A
8313 @deffn Command {cortex_a cache_info}
8314 display information about target caches
8315 @end deffn
8317 @deffn Command {cortex_a dacrfixup [@option{on}|@option{off}]}
8318 Work around issues with software breakpoints when the program text is
8319 mapped read-only by the operating system. This option sets the CP15 DACR
8320 to "all-manager" to bypass MMU permission checks on memory access.
8321 Defaults to 'off'.
8322 @end deffn
8324 @deffn Command {cortex_a dbginit}
8325 Initialize core debug
8326 Enables debug by unlocking the Software Lock and clearing sticky powerdown indications
8327 @end deffn
8329 @deffn Command {cortex_a smp_off}
8330 Disable SMP mode
8331 @end deffn
8333 @deffn Command {cortex_a smp_on}
8334 Enable SMP mode
8335 @end deffn
8337 @deffn Command {cortex_a smp_gdb} [core_id]
8338 Display/set the current core displayed in GDB
8339 @end deffn
8341 @deffn Command {cortex_a maskisr} [@option{on}|@option{off}]
8342 Selects whether interrupts will be processed when single stepping
8343 @end deffn
8345 @deffn Command {cache_config l2x}  [base way]
8346 configure l2x cache
8347 @end deffn
8350 @subsection ARMv7-R specific commands
8351 @cindex Cortex-R
8353 @deffn Command {cortex_r dbginit}
8354 Initialize core debug
8355 Enables debug by unlocking the Software Lock and clearing sticky powerdown indications
8356 @end deffn
8358 @deffn Command {cortex_r maskisr} [@option{on}|@option{off}]
8359 Selects whether interrupts will be processed when single stepping
8360 @end deffn
8363 @subsection ARMv7-M specific commands
8364 @cindex tracing
8365 @cindex SWO
8366 @cindex SWV
8367 @cindex TPIU
8368 @cindex ITM
8369 @cindex ETM
8371 @deffn Command {tpiu config} (@option{disable} | ((@option{external} | @option{internal (@var{filename} | -)}) @
8372                (@option{sync @var{port_width}} | ((@option{manchester} | @option{uart}) @var{formatter_enable})) @
8373                @var{TRACECLKIN_freq} [@var{trace_freq}]))
8375 ARMv7-M architecture provides several modules to generate debugging
8376 information internally (ITM, DWT and ETM). Their output is directed
8377 through TPIU to be captured externally either on an SWO pin (this
8378 configuration is called SWV) or on a synchronous parallel trace port.
8380 This command configures the TPIU module of the target and, if internal
8381 capture mode is selected, starts to capture trace output by using the
8382 debugger adapter features.
8384 Some targets require additional actions to be performed in the
8385 @b{trace-config} handler for trace port to be activated.
8387 Command options:
8388 @itemize @minus
8389 @item @option{disable} disable TPIU handling;
8390 @item @option{external} configure TPIU to let user capture trace
8391 output externally (with an additional UART or logic analyzer hardware);
8392 @item @option{internal @var{filename}} configure TPIU and debug adapter to
8393 gather trace data and append it to @var{filename} (which can be
8394 either a regular file or a named pipe);
8395 @item @option{internal -} configure TPIU and debug adapter to
8396 gather trace data, but not write to any file. Useful in conjunction with the @command{tcl_trace} command;
8397 @item @option{sync @var{port_width}} use synchronous parallel trace output
8398 mode, and set port width to @var{port_width};
8399 @item @option{manchester} use asynchronous SWO mode with Manchester
8400 coding;
8401 @item @option{uart} use asynchronous SWO mode with NRZ (same as
8402 regular UART 8N1) coding;
8403 @item @var{formatter_enable} is @option{on} or @option{off} to enable
8404 or disable TPIU formatter which needs to be used when both ITM and ETM
8405 data is to be output via SWO;
8406 @item @var{TRACECLKIN_freq} this should be specified to match target's
8407 current TRACECLKIN frequency (usually the same as HCLK);
8408 @item @var{trace_freq} trace port frequency. Can be omitted in
8409 internal mode to let the adapter driver select the maximum supported
8410 rate automatically.
8411 @end itemize
8413 Example usage:
8414 @enumerate
8415 @item STM32L152 board is programmed with an application that configures
8416 PLL to provide core clock with 24MHz frequency; to use ITM output it's
8417 enough to:
8418 @example
8419 #include <libopencm3/cm3/itm.h>
8420     ...
8421         ITM_STIM8(0) = c;
8422     ...
8423 @end example
8424 (the most obvious way is to use the first stimulus port for printf,
8425 for that this ITM_STIM8 assignment can be used inside _write(); to make it
8426 blocking to avoid data loss, add @code{while (!(ITM_STIM8(0) &
8427 ITM_STIM_FIFOREADY));});
8428 @item An FT2232H UART is connected to the SWO pin of the board;
8429 @item Commands to configure UART for 12MHz baud rate:
8430 @example
8431 $ setserial /dev/ttyUSB1 spd_cust divisor 5
8432 $ stty -F /dev/ttyUSB1 38400
8433 @end example
8434 (FT2232H's base frequency is 60MHz, spd_cust allows to alias 38400
8435 baud with our custom divisor to get 12MHz)
8436 @item @code{itmdump -f /dev/ttyUSB1 -d1}
8437 @item OpenOCD invocation line:
8438 @example
8439 openocd -f interface/stlink-v2-1.cfg \
8440         -c "transport select hla_swd" \
8441         -f target/stm32l1.cfg \
8442         -c "tpiu config external uart off 24000000 12000000"
8443 @end example
8444 @end enumerate
8445 @end deffn
8447 @deffn Command {itm port} @var{port} (@option{0}|@option{1}|@option{on}|@option{off})
8448 Enable or disable trace output for ITM stimulus @var{port} (counting
8449 from 0). Port 0 is enabled on target creation automatically.
8450 @end deffn
8452 @deffn Command {itm ports} (@option{0}|@option{1}|@option{on}|@option{off})
8453 Enable or disable trace output for all ITM stimulus ports.
8454 @end deffn
8456 @subsection Cortex-M specific commands
8457 @cindex Cortex-M
8459 @deffn Command {cortex_m maskisr} (@option{auto}|@option{on}|@option{off})
8460 Control masking (disabling) interrupts during target step/resume.
8462 The @option{auto} option handles interrupts during stepping a way they get
8463 served but don't disturb the program flow. The step command first allows
8464 pending interrupt handlers to execute, then disables interrupts and steps over
8465 the next instruction where the core was halted. After the step interrupts
8466 are enabled again. If the interrupt handlers don't complete within 500ms,
8467 the step command leaves with the core running.
8469 Note that a free breakpoint is required for the @option{auto} option. If no
8470 breakpoint is available at the time of the step, then the step is taken
8471 with interrupts enabled, i.e. the same way the @option{off} option does.
8473 Default is @option{auto}.
8474 @end deffn
8476 @deffn Command {cortex_m vector_catch} [@option{all}|@option{none}|list]
8477 @cindex vector_catch
8478 Vector Catch hardware provides dedicated breakpoints
8479 for certain hardware events.
8481 Parameters request interception of
8482 @option{all} of these hardware event vectors,
8483 @option{none} of them,
8484 or one or more of the following:
8485 @option{hard_err} for a HardFault exception;
8486 @option{mm_err} for a MemManage exception;
8487 @option{bus_err} for a BusFault exception;
8488 @option{irq_err},
8489 @option{state_err},
8490 @option{chk_err}, or
8491 @option{nocp_err} for various UsageFault exceptions; or
8492 @option{reset}.
8493 If NVIC setup code does not enable them,
8494 MemManage, BusFault, and UsageFault exceptions
8495 are mapped to HardFault.
8496 UsageFault checks for
8497 divide-by-zero and unaligned access
8498 must also be explicitly enabled.
8500 This finishes by listing the current vector catch configuration.
8501 @end deffn
8503 @deffn Command {cortex_m reset_config} (@option{srst}|@option{sysresetreq}|@option{vectreset})
8504 Control reset handling. The default @option{srst} is to use srst if fitted,
8505 otherwise fallback to @option{vectreset}.
8506 @itemize @minus
8507 @item @option{srst} use hardware srst if fitted otherwise fallback to @option{vectreset}.
8508 @item @option{sysresetreq} use NVIC SYSRESETREQ to reset system.
8509 @item @option{vectreset} use NVIC VECTRESET to reset system.
8510 @end itemize
8511 Using @option{vectreset} is a safe option for all current Cortex-M cores.
8512 This however has the disadvantage of only resetting the core, all peripherals
8513 are uneffected. A solution would be to use a @code{reset-init} event handler to manually reset
8514 the peripherals.
8515 @xref{targetevents,,Target Events}.
8516 @end deffn
8518 @subsection ARMv8-A specific commands
8519 @cindex ARMv8-A
8520 @cindex aarch64
8522 @deffn Command {aarch64 cache_info}
8523 Display information about target caches
8524 @end deffn
8526 @deffn Command {aarch64 dbginit}
8527 This command enables debugging by clearing the OS Lock and sticky power-down and reset
8528 indications. It also establishes the expected, basic cross-trigger configuration the aarch64
8529 target code relies on. In a configuration file, the command would typically be called from a
8530 @code{reset-end} or @code{reset-deassert-post} handler, to re-enable debugging after a system reset.
8531 However, normally it is not necessary to use the command at all.
8532 @end deffn
8534 @deffn Command {aarch64 smp_on|smp_off}
8535 Enable and disable SMP handling. The state of SMP handling influences the way targets in an SMP group
8536 are handled by the run control. With SMP handling enabled, issuing halt or resume to one core will trigger
8537 halting or resuming of all cores in the group. The command @code{target smp} defines which targets are in the SMP
8538 group. With SMP handling disabled, all targets need to be treated individually.
8539 @end deffn
8541 @deffn Command {aarch64 maskisr} [@option{on}|@option{off}]
8542 Selects whether interrupts will be processed when single stepping. The default configuration is
8543 @option{on}.
8544 @end deffn
8546 @section Intel Architecture
8548 Intel Quark X10xx is the first product in the Quark family of SoCs. It is an IA-32
8549 (Pentium x86 ISA) compatible SoC. The core CPU in the X10xx is codenamed Lakemont.
8550 Lakemont version 1 (LMT1) is used in X10xx. The CPU TAP (Lakemont TAP) is used for
8551 software debug and the CLTAP is used for SoC level operations.
8552 Useful docs are here: https://communities.intel.com/community/makers/documentation
8553 @itemize
8554 @item Intel Quark SoC X1000 OpenOCD/GDB/Eclipse App Note (web search for doc num 330015)
8555 @item Intel Quark SoC X1000 Debug Operations User Guide (web search for doc num 329866)
8556 @item Intel Quark SoC X1000 Datasheet (web search for doc num 329676)
8557 @end itemize
8559 @subsection x86 32-bit specific commands
8560 The three main address spaces for x86 are memory, I/O and configuration space.
8561 These commands allow a user to read and write to the 64Kbyte I/O address space.
8563 @deffn Command {x86_32 idw} address
8564 Display the contents of a 32-bit I/O port from address range 0x0000 - 0xffff.
8565 @end deffn
8567 @deffn Command {x86_32 idh} address
8568 Display the contents of a 16-bit I/O port from address range 0x0000 - 0xffff.
8569 @end deffn
8571 @deffn Command {x86_32 idb} address
8572 Display the contents of a 8-bit I/O port from address range 0x0000 - 0xffff.
8573 @end deffn
8575 @deffn Command {x86_32 iww} address
8576 Write the contents of a 32-bit I/O port to address range 0x0000 - 0xffff.
8577 @end deffn
8579 @deffn Command {x86_32 iwh} address
8580 Write the contents of a 16-bit I/O port to address range 0x0000 - 0xffff.
8581 @end deffn
8583 @deffn Command {x86_32 iwb} address
8584 Write the contents of a 8-bit I/O port to address range 0x0000 - 0xffff.
8585 @end deffn
8587 @section OpenRISC Architecture
8589 The OpenRISC CPU is a soft core. It is used in a programmable SoC which can be
8590 configured with any of the TAP / Debug Unit available.
8592 @subsection TAP and Debug Unit selection commands
8593 @deffn Command {tap_select} (@option{vjtag}|@option{mohor}|@option{xilinx_bscan})
8594 Select between the Altera Virtual JTAG , Xilinx Virtual JTAG and Mohor TAP.
8595 @end deffn
8596 @deffn Command {du_select} (@option{adv}|@option{mohor}) [option]
8597 Select between the Advanced Debug Interface and the classic one.
8599 An option can be passed as a second argument to the debug unit.
8601 When using the Advanced Debug Interface, option = 1 means the RTL core is
8602 configured with ADBG_USE_HISPEED = 1. This configuration skips status checking
8603 between bytes while doing read or write bursts.
8604 @end deffn
8606 @subsection Registers commands
8607 @deffn Command {addreg} [name] [address] [feature] [reg_group]
8608 Add a new register in the cpu register list. This register will be
8609 included in the generated target descriptor file.
8611 @strong{[feature]} must be "org.gnu.gdb.or1k.group[0..10]".
8613 @strong{[reg_group]} can be anything. The default register list defines "system",
8614  "dmmu", "immu", "dcache", "icache", "mac", "debug", "perf", "power", "pic"
8615  and "timer" groups.
8617 @emph{example:}
8618 @example
8619 addreg rtest 0x1234 org.gnu.gdb.or1k.group0 system
8620 @end example
8623 @end deffn
8624 @deffn Command {readgroup} (@option{group})
8625 Display all registers in @emph{group}.
8627 @emph{group} can be "system",
8628  "dmmu", "immu", "dcache", "icache", "mac", "debug", "perf", "power", "pic",
8629  "timer" or any new group created with addreg command.
8630 @end deffn
8632 @anchor{softwaredebugmessagesandtracing}
8633 @section Software Debug Messages and Tracing
8634 @cindex Linux-ARM DCC support
8635 @cindex tracing
8636 @cindex libdcc
8637 @cindex DCC
8638 OpenOCD can process certain requests from target software, when
8639 the target uses appropriate libraries.
8640 The most powerful mechanism is semihosting, but there is also
8641 a lighter weight mechanism using only the DCC channel.
8643 Currently @command{target_request debugmsgs}
8644 is supported only for @option{arm7_9} and @option{cortex_m} cores.
8645 These messages are received as part of target polling, so
8646 you need to have @command{poll on} active to receive them.
8647 They are intrusive in that they will affect program execution
8648 times. If that is a problem, @pxref{armhardwaretracing,,ARM Hardware Tracing}.
8650 See @file{libdcc} in the contrib dir for more details.
8651 In addition to sending strings, characters, and
8652 arrays of various size integers from the target,
8653 @file{libdcc} also exports a software trace point mechanism.
8654 The target being debugged may
8655 issue trace messages which include a 24-bit @dfn{trace point} number.
8656 Trace point support includes two distinct mechanisms,
8657 each supported by a command:
8659 @itemize
8660 @item @emph{History} ... A circular buffer of trace points
8661 can be set up, and then displayed at any time.
8662 This tracks where code has been, which can be invaluable in
8663 finding out how some fault was triggered.
8665 The buffer may overflow, since it collects records continuously.
8666 It may be useful to use some of the 24 bits to represent a
8667 particular event, and other bits to hold data.
8669 @item @emph{Counting} ... An array of counters can be set up,
8670 and then displayed at any time.
8671 This can help establish code coverage and identify hot spots.
8673 The array of counters is directly indexed by the trace point
8674 number, so trace points with higher numbers are not counted.
8675 @end itemize
8677 Linux-ARM kernels have a ``Kernel low-level debugging
8678 via EmbeddedICE DCC channel'' option (CONFIG_DEBUG_ICEDCC,
8679 depends on CONFIG_DEBUG_LL) which uses this mechanism to
8680 deliver messages before a serial console can be activated.
8681 This is not the same format used by @file{libdcc}.
8682 Other software, such as the U-Boot boot loader, sometimes
8683 does the same thing.
8685 @deffn Command {target_request debugmsgs} [@option{enable}|@option{disable}|@option{charmsg}]
8686 Displays current handling of target DCC message requests.
8687 These messages may be sent to the debugger while the target is running.
8688 The optional @option{enable} and @option{charmsg} parameters
8689 both enable the messages, while @option{disable} disables them.
8691 With @option{charmsg} the DCC words each contain one character,
8692 as used by Linux with CONFIG_DEBUG_ICEDCC;
8693 otherwise the libdcc format is used.
8694 @end deffn
8696 @deffn Command {trace history} [@option{clear}|count]
8697 With no parameter, displays all the trace points that have triggered
8698 in the order they triggered.
8699 With the parameter @option{clear}, erases all current trace history records.
8700 With a @var{count} parameter, allocates space for that many
8701 history records.
8702 @end deffn
8704 @deffn Command {trace point} [@option{clear}|identifier]
8705 With no parameter, displays all trace point identifiers and how many times
8706 they have been triggered.
8707 With the parameter @option{clear}, erases all current trace point counters.
8708 With a numeric @var{identifier} parameter, creates a new a trace point counter
8709 and associates it with that identifier.
8711 @emph{Important:} The identifier and the trace point number
8712 are not related except by this command.
8713 These trace point numbers always start at zero (from server startup,
8714 or after @command{trace point clear}) and count up from there.
8715 @end deffn
8718 @node JTAG Commands
8719 @chapter JTAG Commands
8720 @cindex JTAG Commands
8721 Most general purpose JTAG commands have been presented earlier.
8722 (@xref{jtagspeed,,JTAG Speed}, @ref{Reset Configuration}, and @ref{TAP Declaration}.)
8723 Lower level JTAG commands, as presented here,
8724 may be needed to work with targets which require special
8725 attention during operations such as reset or initialization.
8727 To use these commands you will need to understand some
8728 of the basics of JTAG, including:
8730 @itemize @bullet
8731 @item A JTAG scan chain consists of a sequence of individual TAP
8732 devices such as a CPUs.
8733 @item Control operations involve moving each TAP through the same
8734 standard state machine (in parallel)
8735 using their shared TMS and clock signals.
8736 @item Data transfer involves shifting data through the chain of
8737 instruction or data registers of each TAP, writing new register values
8738 while the reading previous ones.
8739 @item Data register sizes are a function of the instruction active in
8740 a given TAP, while instruction register sizes are fixed for each TAP.
8741 All TAPs support a BYPASS instruction with a single bit data register.
8742 @item The way OpenOCD differentiates between TAP devices is by
8743 shifting different instructions into (and out of) their instruction
8744 registers.
8745 @end itemize
8747 @section Low Level JTAG Commands
8749 These commands are used by developers who need to access
8750 JTAG instruction or data registers, possibly controlling
8751 the order of TAP state transitions.
8752 If you're not debugging OpenOCD internals, or bringing up a
8753 new JTAG adapter or a new type of TAP device (like a CPU or
8754 JTAG router), you probably won't need to use these commands.
8755 In a debug session that doesn't use JTAG for its transport protocol,
8756 these commands are not available.
8758 @deffn Command {drscan} tap [numbits value]+ [@option{-endstate} tap_state]
8759 Loads the data register of @var{tap} with a series of bit fields
8760 that specify the entire register.
8761 Each field is @var{numbits} bits long with
8762 a numeric @var{value} (hexadecimal encouraged).
8763 The return value holds the original value of each
8764 of those fields.
8766 For example, a 38 bit number might be specified as one
8767 field of 32 bits then one of 6 bits.
8768 @emph{For portability, never pass fields which are more
8769 than 32 bits long. Many OpenOCD implementations do not
8770 support 64-bit (or larger) integer values.}
8772 All TAPs other than @var{tap} must be in BYPASS mode.
8773 The single bit in their data registers does not matter.
8775 When @var{tap_state} is specified, the JTAG state machine is left
8776 in that state.
8777 For example @sc{drpause} might be specified, so that more
8778 instructions can be issued before re-entering the @sc{run/idle} state.
8779 If the end state is not specified, the @sc{run/idle} state is entered.
8781 @quotation Warning
8782 OpenOCD does not record information about data register lengths,
8783 so @emph{it is important that you get the bit field lengths right}.
8784 Remember that different JTAG instructions refer to different
8785 data registers, which may have different lengths.
8786 Moreover, those lengths may not be fixed;
8787 the SCAN_N instruction can change the length of
8788 the register accessed by the INTEST instruction
8789 (by connecting a different scan chain).
8790 @end quotation
8791 @end deffn
8793 @deffn Command {flush_count}
8794 Returns the number of times the JTAG queue has been flushed.
8795 This may be used for performance tuning.
8797 For example, flushing a queue over USB involves a
8798 minimum latency, often several milliseconds, which does
8799 not change with the amount of data which is written.
8800 You may be able to identify performance problems by finding
8801 tasks which waste bandwidth by flushing small transfers too often,
8802 instead of batching them into larger operations.
8803 @end deffn
8805 @deffn Command {irscan} [tap instruction]+ [@option{-endstate} tap_state]
8806 For each @var{tap} listed, loads the instruction register
8807 with its associated numeric @var{instruction}.
8808 (The number of bits in that instruction may be displayed
8809 using the @command{scan_chain} command.)
8810 For other TAPs, a BYPASS instruction is loaded.
8812 When @var{tap_state} is specified, the JTAG state machine is left
8813 in that state.
8814 For example @sc{irpause} might be specified, so the data register
8815 can be loaded before re-entering the @sc{run/idle} state.
8816 If the end state is not specified, the @sc{run/idle} state is entered.
8818 @quotation Note
8819 OpenOCD currently supports only a single field for instruction
8820 register values, unlike data register values.
8821 For TAPs where the instruction register length is more than 32 bits,
8822 portable scripts currently must issue only BYPASS instructions.
8823 @end quotation
8824 @end deffn
8826 @deffn Command {jtag_reset} trst srst
8827 Set values of reset signals.
8828 The @var{trst} and @var{srst} parameter values may be
8829 @option{0}, indicating that reset is inactive (pulled or driven high),
8830 or @option{1}, indicating it is active (pulled or driven low).
8831 The @command{reset_config} command should already have been used
8832 to configure how the board and JTAG adapter treat these two
8833 signals, and to say if either signal is even present.
8834 @xref{Reset Configuration}.
8836 Note that TRST is specially handled.
8837 It actually signifies JTAG's @sc{reset} state.
8838 So if the board doesn't support the optional TRST signal,
8839 or it doesn't support it along with the specified SRST value,
8840 JTAG reset is triggered with TMS and TCK signals
8841 instead of the TRST signal.
8842 And no matter how that JTAG reset is triggered, once
8843 the scan chain enters @sc{reset} with TRST inactive,
8844 TAP @code{post-reset} events are delivered to all TAPs
8845 with handlers for that event.
8846 @end deffn
8848 @deffn Command {pathmove} start_state [next_state ...]
8849 Start by moving to @var{start_state}, which
8850 must be one of the @emph{stable} states.
8851 Unless it is the only state given, this will often be the
8852 current state, so that no TCK transitions are needed.
8853 Then, in a series of single state transitions
8854 (conforming to the JTAG state machine) shift to
8855 each @var{next_state} in sequence, one per TCK cycle.
8856 The final state must also be stable.
8857 @end deffn
8859 @deffn Command {runtest} @var{num_cycles}
8860 Move to the @sc{run/idle} state, and execute at least
8861 @var{num_cycles} of the JTAG clock (TCK).
8862 Instructions often need some time
8863 to execute before they take effect.
8864 @end deffn
8866 @c tms_sequence (short|long)
8867 @c ... temporary, debug-only, other than USBprog bug workaround...
8869 @deffn Command {verify_ircapture} (@option{enable}|@option{disable})
8870 Verify values captured during @sc{ircapture} and returned
8871 during IR scans. Default is enabled, but this can be
8872 overridden by @command{verify_jtag}.
8873 This flag is ignored when validating JTAG chain configuration.
8874 @end deffn
8876 @deffn Command {verify_jtag} (@option{enable}|@option{disable})
8877 Enables verification of DR and IR scans, to help detect
8878 programming errors. For IR scans, @command{verify_ircapture}
8879 must also be enabled.
8880 Default is enabled.
8881 @end deffn
8883 @section TAP state names
8884 @cindex TAP state names
8886 The @var{tap_state} names used by OpenOCD in the @command{drscan},
8887 @command{irscan}, and @command{pathmove} commands are the same
8888 as those used in SVF boundary scan documents, except that
8889 SVF uses @sc{idle} instead of @sc{run/idle}.
8891 @itemize @bullet
8892 @item @b{RESET} ... @emph{stable} (with TMS high);
8893 acts as if TRST were pulsed
8894 @item @b{RUN/IDLE} ... @emph{stable}; don't assume this always means IDLE
8895 @item @b{DRSELECT}
8896 @item @b{DRCAPTURE}
8897 @item @b{DRSHIFT} ... @emph{stable}; TDI/TDO shifting
8898 through the data register
8899 @item @b{DREXIT1}
8900 @item @b{DRPAUSE} ... @emph{stable}; data register ready
8901 for update or more shifting
8902 @item @b{DREXIT2}
8903 @item @b{DRUPDATE}
8904 @item @b{IRSELECT}
8905 @item @b{IRCAPTURE}
8906 @item @b{IRSHIFT} ... @emph{stable}; TDI/TDO shifting
8907 through the instruction register
8908 @item @b{IREXIT1}
8909 @item @b{IRPAUSE} ... @emph{stable}; instruction register ready
8910 for update or more shifting
8911 @item @b{IREXIT2}
8912 @item @b{IRUPDATE}
8913 @end itemize
8915 Note that only six of those states are fully ``stable'' in the
8916 face of TMS fixed (low except for @sc{reset})
8917 and a free-running JTAG clock. For all the
8918 others, the next TCK transition changes to a new state.
8920 @itemize @bullet
8921 @item From @sc{drshift} and @sc{irshift}, clock transitions will
8922 produce side effects by changing register contents. The values
8923 to be latched in upcoming @sc{drupdate} or @sc{irupdate} states
8924 may not be as expected.
8925 @item @sc{run/idle}, @sc{drpause}, and @sc{irpause} are reasonable
8926 choices after @command{drscan} or @command{irscan} commands,
8927 since they are free of JTAG side effects.
8928 @item @sc{run/idle} may have side effects that appear at non-JTAG
8929 levels, such as advancing the ARM9E-S instruction pipeline.
8930 Consult the documentation for the TAP(s) you are working with.
8931 @end itemize
8933 @node Boundary Scan Commands
8934 @chapter Boundary Scan Commands
8936 One of the original purposes of JTAG was to support
8937 boundary scan based hardware testing.
8938 Although its primary focus is to support On-Chip Debugging,
8939 OpenOCD also includes some boundary scan commands.
8941 @section SVF: Serial Vector Format
8942 @cindex Serial Vector Format
8943 @cindex SVF
8945 The Serial Vector Format, better known as @dfn{SVF}, is a
8946 way to represent JTAG test patterns in text files.
8947 In a debug session using JTAG for its transport protocol,
8948 OpenOCD supports running such test files.
8950 @deffn Command {svf} @file{filename} [@option{-tap @var{tapname}}] [@option{[-]quiet}] @
8951                      [@option{[-]nil}] [@option{[-]progress}] [@option{[-]ignore_error}]
8952 This issues a JTAG reset (Test-Logic-Reset) and then
8953 runs the SVF script from @file{filename}.
8955 Arguments can be specified in any order; the optional dash doesn't
8956 affect their semantics.
8958 Command options:
8959 @itemize @minus
8960 @item @option{-tap @var{tapname}} ignore IR and DR headers and footers
8961 specified by the SVF file with HIR, TIR, HDR and TDR commands;
8962 instead, calculate them automatically according to the current JTAG
8963 chain configuration, targetting @var{tapname};
8964 @item @option{[-]quiet} do not log every command before execution;
8965 @item @option{[-]nil} ``dry run'', i.e., do not perform any operations
8966 on the real interface;
8967 @item @option{[-]progress} enable progress indication;
8968 @item @option{[-]ignore_error} continue execution despite TDO check
8969 errors.
8970 @end itemize
8971 @end deffn
8973 @section XSVF: Xilinx Serial Vector Format
8974 @cindex Xilinx Serial Vector Format
8975 @cindex XSVF
8977 The Xilinx Serial Vector Format, better known as @dfn{XSVF}, is a
8978 binary representation of SVF which is optimized for use with
8979 Xilinx devices.
8980 In a debug session using JTAG for its transport protocol,
8981 OpenOCD supports running such test files.
8983 @quotation Important
8984 Not all XSVF commands are supported.
8985 @end quotation
8987 @deffn Command {xsvf} (tapname|@option{plain}) filename [@option{virt2}] [@option{quiet}]
8988 This issues a JTAG reset (Test-Logic-Reset) and then
8989 runs the XSVF script from @file{filename}.
8990 When a @var{tapname} is specified, the commands are directed at
8991 that TAP.
8992 When @option{virt2} is specified, the @sc{xruntest} command counts
8993 are interpreted as TCK cycles instead of microseconds.
8994 Unless the @option{quiet} option is specified,
8995 messages are logged for comments and some retries.
8996 @end deffn
8998 The OpenOCD sources also include two utility scripts
8999 for working with XSVF; they are not currently installed
9000 after building the software.
9001 You may find them useful:
9003 @itemize
9004 @item @emph{svf2xsvf} ... converts SVF files into the extended XSVF
9005 syntax understood by the @command{xsvf} command; see notes below.
9006 @item @emph{xsvfdump} ... converts XSVF files into a text output format;
9007 understands the OpenOCD extensions.
9008 @end itemize
9010 The input format accepts a handful of non-standard extensions.
9011 These include three opcodes corresponding to SVF extensions
9012 from Lattice Semiconductor (LCOUNT, LDELAY, LDSR), and
9013 two opcodes supporting a more accurate translation of SVF
9014 (XTRST, XWAITSTATE).
9015 If @emph{xsvfdump} shows a file is using those opcodes, it
9016 probably will not be usable with other XSVF tools.
9019 @node Utility Commands
9020 @chapter Utility Commands
9021 @cindex Utility Commands
9023 @section RAM testing
9024 @cindex RAM testing
9026 There is often a need to stress-test random access memory (RAM) for
9027 errors. OpenOCD comes with a Tcl implementation of well-known memory
9028 testing procedures allowing the detection of all sorts of issues with
9029 electrical wiring, defective chips, PCB layout and other common
9030 hardware problems.
9032 To use them, you usually need to initialise your RAM controller first;
9033 consult your SoC's documentation to get the recommended list of
9034 register operations and translate them to the corresponding
9035 @command{mww}/@command{mwb} commands.
9037 Load the memory testing functions with
9039 @example
9040 source [find tools/memtest.tcl]
9041 @end example
9043 to get access to the following facilities:
9045 @deffn Command {memTestDataBus} address
9046 Test the data bus wiring in a memory region by performing a walking
9047 1's test at a fixed address within that region.
9048 @end deffn
9050 @deffn Command {memTestAddressBus} baseaddress size
9051 Perform a walking 1's test on the relevant bits of the address and
9052 check for aliasing. This test will find single-bit address failures
9053 such as stuck-high, stuck-low, and shorted pins.
9054 @end deffn
9056 @deffn Command {memTestDevice} baseaddress size
9057 Test the integrity of a physical memory device by performing an
9058 increment/decrement test over the entire region. In the process every
9059 storage bit in the device is tested as zero and as one.
9060 @end deffn
9062 @deffn Command {runAllMemTests} baseaddress size
9063 Run all of the above tests over a specified memory region.
9064 @end deffn
9066 @section Firmware recovery helpers
9067 @cindex Firmware recovery
9069 OpenOCD includes an easy-to-use script to facilitate mass-market
9070 devices recovery with JTAG.
9072 For quickstart instructions run:
9073 @example
9074 openocd -f tools/firmware-recovery.tcl -c firmware_help
9075 @end example
9077 @node TFTP
9078 @chapter TFTP
9079 @cindex TFTP
9080 If OpenOCD runs on an embedded host (as ZY1000 does), then TFTP can
9081 be used to access files on PCs (either the developer's PC or some other PC).
9083 The way this works on the ZY1000 is to prefix a filename by
9084 "/tftp/ip/" and append the TFTP path on the TFTP
9085 server (tftpd). For example,
9087 @example
9088 load_image /tftp/10.0.0.96/c:\temp\abc.elf
9089 @end example
9091 will load c:\temp\abc.elf from the developer pc (10.0.0.96) into memory as
9092 if the file was hosted on the embedded host.
9094 In order to achieve decent performance, you must choose a TFTP server
9095 that supports a packet size bigger than the default packet size (512 bytes). There
9096 are numerous TFTP servers out there (free and commercial) and you will have to do
9097 a bit of googling to find something that fits your requirements.
9099 @node GDB and OpenOCD
9100 @chapter GDB and OpenOCD
9101 @cindex GDB
9102 OpenOCD complies with the remote gdbserver protocol and, as such, can be used
9103 to debug remote targets.
9104 Setting up GDB to work with OpenOCD can involve several components:
9106 @itemize
9107 @item The OpenOCD server support for GDB may need to be configured.
9108 @xref{gdbconfiguration,,GDB Configuration}.
9109 @item GDB's support for OpenOCD may need configuration,
9110 as shown in this chapter.
9111 @item If you have a GUI environment like Eclipse,
9112 that also will probably need to be configured.
9113 @end itemize
9115 Of course, the version of GDB you use will need to be one which has
9116 been built to know about the target CPU you're using. It's probably
9117 part of the tool chain you're using. For example, if you are doing
9118 cross-development for ARM on an x86 PC, instead of using the native
9119 x86 @command{gdb} command you might use @command{arm-none-eabi-gdb}
9120 if that's the tool chain used to compile your code.
9122 @section Connecting to GDB
9123 @cindex Connecting to GDB
9124 Use GDB 6.7 or newer with OpenOCD if you run into trouble. For
9125 instance GDB 6.3 has a known bug that produces bogus memory access
9126 errors, which has since been fixed; see
9127 @url{http://osdir.com/ml/gdb.bugs.discuss/2004-12/msg00018.html}
9129 OpenOCD can communicate with GDB in two ways:
9131 @enumerate
9132 @item
9133 A socket (TCP/IP) connection is typically started as follows:
9134 @example
9135 target remote localhost:3333
9136 @end example
9137 This would cause GDB to connect to the gdbserver on the local pc using port 3333.
9139 It is also possible to use the GDB extended remote protocol as follows:
9140 @example
9141 target extended-remote localhost:3333
9142 @end example
9143 @item
9144 A pipe connection is typically started as follows:
9145 @example
9146 target remote | openocd -c "gdb_port pipe; log_output openocd.log"
9147 @end example
9148 This would cause GDB to run OpenOCD and communicate using pipes (stdin/stdout).
9149 Using this method has the advantage of GDB starting/stopping OpenOCD for the debug
9150 session. log_output sends the log output to a file to ensure that the pipe is
9151 not saturated when using higher debug level outputs.
9152 @end enumerate
9154 To list the available OpenOCD commands type @command{monitor help} on the
9155 GDB command line.
9157 @section Sample GDB session startup
9159 With the remote protocol, GDB sessions start a little differently
9160 than they do when you're debugging locally.
9161 Here's an example showing how to start a debug session with a
9162 small ARM program.
9163 In this case the program was linked to be loaded into SRAM on a Cortex-M3.
9164 Most programs would be written into flash (address 0) and run from there.
9166 @example
9167 $ arm-none-eabi-gdb example.elf
9168 (gdb) target remote localhost:3333
9169 Remote debugging using localhost:3333
9171 (gdb) monitor reset halt
9173 (gdb) load
9174 Loading section .vectors, size 0x100 lma 0x20000000
9175 Loading section .text, size 0x5a0 lma 0x20000100
9176 Loading section .data, size 0x18 lma 0x200006a0
9177 Start address 0x2000061c, load size 1720
9178 Transfer rate: 22 KB/sec, 573 bytes/write.
9179 (gdb) continue
9180 Continuing.
9182 @end example
9184 You could then interrupt the GDB session to make the program break,
9185 type @command{where} to show the stack, @command{list} to show the
9186 code around the program counter, @command{step} through code,
9187 set breakpoints or watchpoints, and so on.
9189 @section Configuring GDB for OpenOCD
9191 OpenOCD supports the gdb @option{qSupported} packet, this enables information
9192 to be sent by the GDB remote server (i.e. OpenOCD) to GDB. Typical information includes
9193 packet size and the device's memory map.
9194 You do not need to configure the packet size by hand,
9195 and the relevant parts of the memory map should be automatically
9196 set up when you declare (NOR) flash banks.
9198 However, there are other things which GDB can't currently query.
9199 You may need to set those up by hand.
9200 As OpenOCD starts up, you will often see a line reporting
9201 something like:
9203 @example
9204 Info : lm3s.cpu: hardware has 6 breakpoints, 4 watchpoints
9205 @end example
9207 You can pass that information to GDB with these commands:
9209 @example
9210 set remote hardware-breakpoint-limit 6
9211 set remote hardware-watchpoint-limit 4
9212 @end example
9214 With that particular hardware (Cortex-M3) the hardware breakpoints
9215 only work for code running from flash memory. Most other ARM systems
9216 do not have such restrictions.
9218 Rather than typing such commands interactively, you may prefer to
9219 save them in a file and have GDB execute them as it starts, perhaps
9220 using a @file{.gdbinit} in your project directory or starting GDB
9221 using @command{gdb -x filename}.
9223 @section Programming using GDB
9224 @cindex Programming using GDB
9225 @anchor{programmingusinggdb}
9227 By default the target memory map is sent to GDB. This can be disabled by
9228 the following OpenOCD configuration option:
9229 @example
9230 gdb_memory_map disable
9231 @end example
9232 For this to function correctly a valid flash configuration must also be set
9233 in OpenOCD. For faster performance you should also configure a valid
9234 working area.
9236 Informing GDB of the memory map of the target will enable GDB to protect any
9237 flash areas of the target and use hardware breakpoints by default. This means
9238 that the OpenOCD option @command{gdb_breakpoint_override} is not required when
9239 using a memory map. @xref{gdbbreakpointoverride,,gdb_breakpoint_override}.
9241 To view the configured memory map in GDB, use the GDB command @option{info mem}.
9242 All other unassigned addresses within GDB are treated as RAM.
9244 GDB 6.8 and higher set any memory area not in the memory map as inaccessible.
9245 This can be changed to the old behaviour by using the following GDB command
9246 @example
9247 set mem inaccessible-by-default off
9248 @end example
9250 If @command{gdb_flash_program enable} is also used, GDB will be able to
9251 program any flash memory using the vFlash interface.
9253 GDB will look at the target memory map when a load command is given, if any
9254 areas to be programmed lie within the target flash area the vFlash packets
9255 will be used.
9257 If the target needs configuring before GDB programming, set target
9258 event gdb-flash-erase-start:
9259 @example
9260 $_TARGETNAME configure -event gdb-flash-erase-start BODY
9261 @end example
9262 @xref{targetevents,,Target Events} for other GDB programming related events.
9264 To verify any flash programming the GDB command @option{compare-sections}
9265 can be used.
9267 @section Using GDB as a non-intrusive memory inspector
9268 @cindex Using GDB as a non-intrusive memory inspector
9269 @anchor{gdbmeminspect}
9271 If your project controls more than a blinking LED, let's say a heavy industrial
9272 robot or an experimental nuclear reactor, stopping the controlling process
9273 just because you want to attach GDB is not a good option.
9275 OpenOCD does not support GDB non-stop mode (might be implemented in the future).
9276 Though there is a possible setup where the target does not get stopped
9277 and GDB treats it as it were running.
9278 If the target supports background access to memory while it is running,
9279 you can use GDB in this mode to inspect memory (mainly global variables)
9280 without any intrusion of the target process.
9282 Remove default setting of gdb-attach event. @xref{targetevents,,Target Events}.
9283 Place following command after target configuration:
9284 @example
9285 $_TARGETNAME configure -event gdb-attach @{@}
9286 @end example
9288 If any of installed flash banks does not support probe on running target,
9289 switch off gdb_memory_map:
9290 @example
9291 gdb_memory_map disable
9292 @end example
9294 Ensure GDB is configured without interrupt-on-connect.
9295 Some GDB versions set it by default, some does not.
9296 @example
9297 set remote interrupt-on-connect off
9298 @end example
9300 If you switched gdb_memory_map off, you may want to setup GDB memory map
9301 manually or issue @command{set mem inaccessible-by-default off}
9303 Now you can issue GDB command @command{target remote ...} and inspect memory
9304 of a running target. Do not use GDB commands @command{continue},
9305 @command{step} or @command{next} as they synchronize GDB with your target
9306 and GDB would require stopping the target to get the prompt back.
9308 Do not use this mode under an IDE like Eclipse as it caches values of
9309 previously shown varibles.
9311 @anchor{usingopenocdsmpwithgdb}
9312 @section Using OpenOCD SMP with GDB
9313 @cindex SMP
9314 For SMP support following GDB serial protocol packet have been defined :
9315 @itemize @bullet
9316 @item j - smp status request
9317 @item J - smp set request
9318 @end itemize
9320 OpenOCD implements :
9321 @itemize @bullet
9322 @item @option{jc} packet for reading core id displayed by
9323 GDB connection. Reply is @option{XXXXXXXX} (8 hex digits giving core id) or
9324  @option{E01} for target not smp.
9325 @item @option{JcXXXXXXXX} (8 hex digits) packet for setting core id displayed at next GDB continue
9326 (core id -1 is reserved for returning to normal resume mode). Reply @option{E01}
9327 for target not smp or @option{OK} on success.
9328 @end itemize
9330 Handling of this packet within GDB can be done :
9331 @itemize @bullet
9332 @item by the creation of an internal variable (i.e @option{_core}) by mean
9333 of function allocate_computed_value allowing following GDB command.
9334 @example
9335 set $_core 1
9336 #Jc01 packet is sent
9337 print $_core
9338 #jc packet is sent and result is affected in $
9339 @end example
9341 @item by the usage of GDB maintenance command as described in following example (2 cpus in SMP with
9342 core id 0 and 1 @pxref{definecputargetsworkinginsmp,,Define CPU targets working in SMP}).
9344 @example
9345 # toggle0 : force display of coreid 0
9346 define toggle0
9347 maint packet Jc0
9348 continue
9349 main packet Jc-1
9351 # toggle1 : force display of coreid 1
9352 define toggle1
9353 maint packet Jc1
9354 continue
9355 main packet Jc-1
9357 @end example
9358 @end itemize
9360 @section RTOS Support
9361 @cindex RTOS Support
9362 @anchor{gdbrtossupport}
9364 OpenOCD includes RTOS support, this will however need enabling as it defaults to disabled.
9365 It can be enabled by passing @option{-rtos} arg to the target. @xref{rtostype,,RTOS Type}.
9367 @xref{Threads, Debugging Programs with Multiple Threads,
9368 Debugging Programs with Multiple Threads, gdb, GDB manual}, for details about relevant
9369 GDB commands.
9371 @* An example setup is below:
9373 @example
9374 $_TARGETNAME configure -rtos auto
9375 @end example
9377 This will attempt to auto detect the RTOS within your application.
9379 Currently supported rtos's include:
9380 @itemize @bullet
9381 @item @option{eCos}
9382 @item @option{ThreadX}
9383 @item @option{FreeRTOS}
9384 @item @option{linux}
9385 @item @option{ChibiOS}
9386 @item @option{embKernel}
9387 @item @option{mqx}
9388 @item @option{uCOS-III}
9389 @end itemize
9391 @quotation Note
9392 Before an RTOS can be detected, it must export certain symbols; otherwise, it cannot
9393 be used by OpenOCD. Below is a list of the required symbols for each supported RTOS.
9394 @end quotation
9396 @table @code
9397 @item eCos symbols
9398 Cyg_Thread::thread_list, Cyg_Scheduler_Base::current_thread.
9399 @item ThreadX symbols
9400 _tx_thread_current_ptr, _tx_thread_created_ptr, _tx_thread_created_count.
9401 @item FreeRTOS symbols
9402 @c The following is taken from recent texinfo to provide compatibility
9403 @c with ancient versions that do not support @raggedright
9404 @tex
9405 \begingroup
9406 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
9407 pxCurrentTCB, pxReadyTasksLists, xDelayedTaskList1, xDelayedTaskList2,
9408 pxDelayedTaskList, pxOverflowDelayedTaskList, xPendingReadyList,
9409 uxCurrentNumberOfTasks, uxTopUsedPriority.
9410 \par
9411 \endgroup
9412 @end tex
9413 @item linux symbols
9414 init_task.
9415 @item ChibiOS symbols
9416 rlist, ch_debug, chSysInit.
9417 @item embKernel symbols
9418 Rtos::sCurrentTask, Rtos::sListReady, Rtos::sListSleep,
9419 Rtos::sListSuspended, Rtos::sMaxPriorities, Rtos::sCurrentTaskCount.
9420 @item mqx symbols
9421 _mqx_kernel_data, MQX_init_struct.
9422 @item uC/OS-III symbols
9423 OSRunning, OSTCBCurPtr, OSTaskDbgListPtr, OSTaskQty
9424 @end table
9426 For most RTOS supported the above symbols will be exported by default. However for
9427 some, eg. FreeRTOS and uC/OS-III, extra steps must be taken.
9429 These RTOSes may require additional OpenOCD-specific file to be linked
9430 along with the project:
9432 @table @code
9433 @item FreeRTOS
9434 contrib/rtos-helpers/FreeRTOS-openocd.c
9435 @item uC/OS-III
9436 contrib/rtos-helpers/uCOS-III-openocd.c
9437 @end table
9439 @node Tcl Scripting API
9440 @chapter Tcl Scripting API
9441 @cindex Tcl Scripting API
9442 @cindex Tcl scripts
9443 @section API rules
9445 Tcl commands are stateless; e.g. the @command{telnet} command has
9446 a concept of currently active target, the Tcl API proc's take this sort
9447 of state information as an argument to each proc.
9449 There are three main types of return values: single value, name value
9450 pair list and lists.
9452 Name value pair. The proc 'foo' below returns a name/value pair
9453 list.
9455 @example
9456 >  set foo(me)  Duane
9457 >  set foo(you) Oyvind
9458 >  set foo(mouse) Micky
9459 >  set foo(duck) Donald
9460 @end example
9462 If one does this:
9464 @example
9465 >  set foo
9466 @end example
9468 The result is:
9470 @example
9471 me Duane you Oyvind mouse Micky duck Donald
9472 @end example
9474 Thus, to get the names of the associative array is easy:
9476 @verbatim
9477 foreach { name value } [set foo] {
9478         puts "Name: $name, Value: $value"
9480 @end verbatim
9482 Lists returned should be relatively small. Otherwise, a range
9483 should be passed in to the proc in question.
9485 @section Internal low-level Commands
9487 By "low-level," we mean commands that a human would typically not
9488 invoke directly.
9490 Some low-level commands need to be prefixed with "ocd_"; e.g.
9491 @command{ocd_flash_banks}
9492 is the low-level API upon which @command{flash banks} is implemented.
9494 @itemize @bullet
9495 @item @b{mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
9497 Read memory and return as a Tcl array for script processing
9498 @item @b{array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
9500 Convert a Tcl array to memory locations and write the values
9501 @item @b{ocd_flash_banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...]
9503 Return information about the flash banks
9505 @item @b{capture} <@var{command}>
9507 Run <@var{command}> and return full log output that was produced during
9508 its execution. Example:
9510 @example
9511 > capture "reset init"
9512 @end example
9514 @end itemize
9516 OpenOCD commands can consist of two words, e.g. "flash banks". The
9517 @file{startup.tcl} "unknown" proc will translate this into a Tcl proc
9518 called "flash_banks".
9520 @section OpenOCD specific Global Variables
9522 Real Tcl has ::tcl_platform(), and platform::identify, and many other
9523 variables. JimTCL, as implemented in OpenOCD creates $ocd_HOSTOS which
9524 holds one of the following values:
9526 @itemize @bullet
9527 @item @b{cygwin}   Running under Cygwin
9528 @item @b{darwin}   Darwin (Mac-OS) is the underlying operating sytem.
9529 @item @b{freebsd}  Running under FreeBSD
9530 @item @b{openbsd}  Running under OpenBSD
9531 @item @b{netbsd}   Running under NetBSD
9532 @item @b{linux}    Linux is the underlying operating sytem
9533 @item @b{mingw32}  Running under MingW32
9534 @item @b{winxx}    Built using Microsoft Visual Studio
9535 @item @b{ecos}     Running under eCos
9536 @item @b{other}    Unknown, none of the above.
9537 @end itemize
9539 Note: 'winxx' was choosen because today (March-2009) no distinction is made between Win32 and Win64.
9541 @quotation Note
9542 We should add support for a variable like Tcl variable
9543 @code{tcl_platform(platform)}, it should be called
9544 @code{jim_platform} (because it
9545 is jim, not real tcl).
9546 @end quotation
9548 @section Tcl RPC server
9549 @cindex RPC
9551 OpenOCD provides a simple RPC server that allows to run arbitrary Tcl
9552 commands and receive the results.
9554 To access it, your application needs to connect to a configured TCP port
9555 (see @command{tcl_port}). Then it can pass any string to the
9556 interpreter terminating it with @code{0x1a} and wait for the return
9557 value (it will be terminated with @code{0x1a} as well). This can be
9558 repeated as many times as desired without reopening the connection.
9560 Remember that most of the OpenOCD commands need to be prefixed with
9561 @code{ocd_} to get the results back. Sometimes you might also need the
9562 @command{capture} command.
9564 See @file{contrib/rpc_examples/} for specific client implementations.
9566 @section Tcl RPC server notifications
9567 @cindex RPC Notifications
9569 Notifications are sent asynchronously to other commands being executed over
9570 the RPC server, so the port must be polled continuously.
9572 Target event, state and reset notifications are emitted as Tcl associative arrays
9573 in the following format.
9575 @verbatim
9576 type target_event event [event-name]
9577 type target_state state [state-name]
9578 type target_reset mode [reset-mode]
9579 @end verbatim
9581 @deffn {Command} tcl_notifications [on/off]
9582 Toggle output of target notifications to the current Tcl RPC server.
9583 Only available from the Tcl RPC server.
9584 Defaults to off.
9586 @end deffn
9588 @section Tcl RPC server trace output
9589 @cindex RPC trace output
9591 Trace data is sent asynchronously to other commands being executed over
9592 the RPC server, so the port must be polled continuously.
9594 Target trace data is emitted as a Tcl associative array in the following format.
9596 @verbatim
9597 type target_trace data [trace-data-hex-encoded]
9598 @end verbatim
9600 @deffn {Command} tcl_trace [on/off]
9601 Toggle output of target trace data to the current Tcl RPC server.
9602 Only available from the Tcl RPC server.
9603 Defaults to off.
9605 See an example application here:
9606 @url{https://github.com/apmorton/OpenOcdTraceUtil} [OpenOcdTraceUtil]
9608 @end deffn
9610 @node FAQ
9611 @chapter FAQ
9612 @cindex faq
9613 @enumerate
9614 @anchor{faqrtck}
9615 @item @b{RTCK, also known as: Adaptive Clocking - What is it?}
9616 @cindex RTCK
9617 @cindex adaptive clocking
9620 In digital circuit design it is often refered to as ``clock
9621 synchronisation'' the JTAG interface uses one clock (TCK or TCLK)
9622 operating at some speed, your CPU target is operating at another.
9623 The two clocks are not synchronised, they are ``asynchronous''
9625 In order for the two to work together they must be synchronised
9626 well enough to work; JTAG can't go ten times faster than the CPU,
9627 for example. There are 2 basic options:
9628 @enumerate
9629 @item
9630 Use a special "adaptive clocking" circuit to change the JTAG
9631 clock rate to match what the CPU currently supports.
9632 @item
9633 The JTAG clock must be fixed at some speed that's enough slower than
9634 the CPU clock that all TMS and TDI transitions can be detected.
9635 @end enumerate
9637 @b{Does this really matter?} For some chips and some situations, this
9638 is a non-issue, like a 500MHz ARM926 with a 5 MHz JTAG link;
9639 the CPU has no difficulty keeping up with JTAG.
9640 Startup sequences are often problematic though, as are other
9641 situations where the CPU clock rate changes (perhaps to save
9642 power).
9644 For example, Atmel AT91SAM chips start operation from reset with
9645 a 32kHz system clock. Boot firmware may activate the main oscillator
9646 and PLL before switching to a faster clock (perhaps that 500 MHz
9647 ARM926 scenario).
9648 If you're using JTAG to debug that startup sequence, you must slow
9649 the JTAG clock to sometimes 1 to 4kHz. After startup completes,
9650 JTAG can use a faster clock.
9652 Consider also debugging a 500MHz ARM926 hand held battery powered
9653 device that enters a low power ``deep sleep'' mode, at 32kHz CPU
9654 clock, between keystrokes unless it has work to do. When would
9655 that 5 MHz JTAG clock be usable?
9657 @b{Solution #1 - A special circuit}
9659 In order to make use of this,
9660 your CPU, board, and JTAG adapter must all support the RTCK
9661 feature. Not all of them support this; keep reading!
9663 The RTCK ("Return TCK") signal in some ARM chips is used to help with
9664 this problem. ARM has a good description of the problem described at
9665 this link: @url{http://www.arm.com/support/faqdev/4170.html} [checked
9666 28/nov/2008]. Link title: ``How does the JTAG synchronisation logic
9667 work? / how does adaptive clocking work?''.
9669 The nice thing about adaptive clocking is that ``battery powered hand
9670 held device example'' - the adaptiveness works perfectly all the
9671 time. One can set a break point or halt the system in the deep power
9672 down code, slow step out until the system speeds up.
9674 Note that adaptive clocking may also need to work at the board level,
9675 when a board-level scan chain has multiple chips.
9676 Parallel clock voting schemes are good way to implement this,
9677 both within and between chips, and can easily be implemented
9678 with a CPLD.
9679 It's not difficult to have logic fan a module's input TCK signal out
9680 to each TAP in the scan chain, and then wait until each TAP's RTCK comes
9681 back with the right polarity before changing the output RTCK signal.
9682 Texas Instruments makes some clock voting logic available
9683 for free (with no support) in VHDL form; see
9684 @url{http://tiexpressdsp.com/index.php/Adaptive_Clocking}
9686 @b{Solution #2 - Always works - but may be slower}
9688 Often this is a perfectly acceptable solution.
9690 In most simple terms: Often the JTAG clock must be 1/10 to 1/12 of
9691 the target clock speed. But what that ``magic division'' is varies
9692 depending on the chips on your board.
9693 @b{ARM rule of thumb} Most ARM based systems require an 6:1 division;
9694 ARM11 cores use an 8:1 division.
9695 @b{Xilinx rule of thumb} is 1/12 the clock speed.
9697 Note: most full speed FT2232 based JTAG adapters are limited to a
9698 maximum of 6MHz. The ones using USB high speed chips (FT2232H)
9699 often support faster clock rates (and adaptive clocking).
9701 You can still debug the 'low power' situations - you just need to
9702 either use a fixed and very slow JTAG clock rate ... or else
9703 manually adjust the clock speed at every step. (Adjusting is painful
9704 and tedious, and is not always practical.)
9706 It is however easy to ``code your way around it'' - i.e.: Cheat a little,
9707 have a special debug mode in your application that does a ``high power
9708 sleep''. If you are careful - 98% of your problems can be debugged
9709 this way.
9711 Note that on ARM you may need to avoid using the @emph{wait for interrupt}
9712 operation in your idle loops even if you don't otherwise change the CPU
9713 clock rate.
9714 That operation gates the CPU clock, and thus the JTAG clock; which
9715 prevents JTAG access. One consequence is not being able to @command{halt}
9716 cores which are executing that @emph{wait for interrupt} operation.
9718 To set the JTAG frequency use the command:
9720 @example
9721 # Example: 1.234MHz
9722 adapter_khz 1234
9723 @end example
9726 @item @b{Win32 Pathnames} Why don't backslashes work in Windows paths?
9728 OpenOCD uses Tcl and a backslash is an escape char. Use @{ and @}
9729 around Windows filenames.
9731 @example
9732 > echo \a
9734 > echo @{\a@}
9736 > echo "\a"
9739 @end example
9742 @item @b{Missing: cygwin1.dll} OpenOCD complains about a missing cygwin1.dll.
9744 Make sure you have Cygwin installed, or at least a version of OpenOCD that
9745 claims to come with all the necessary DLLs. When using Cygwin, try launching
9746 OpenOCD from the Cygwin shell.
9748 @item @b{Breakpoint Issue} I'm trying to set a breakpoint using GDB (or a frontend like Insight or
9749 Eclipse), but OpenOCD complains that "Info: arm7_9_common.c:213
9750 arm7_9_add_breakpoint(): sw breakpoint requested, but software breakpoints not enabled".
9752 GDB issues software breakpoints when a normal breakpoint is requested, or to implement
9753 source-line single-stepping. On ARMv4T systems, like ARM7TDMI, ARM720T or ARM920T,
9754 software breakpoints consume one of the two available hardware breakpoints.
9756 @item @b{LPC2000 Flash} When erasing or writing LPC2000 on-chip flash, the operation fails at random.
9758 Make sure the core frequency specified in the @option{flash lpc2000} line matches the
9759 clock at the time you're programming the flash. If you've specified the crystal's
9760 frequency, make sure the PLL is disabled. If you've specified the full core speed
9761 (e.g. 60MHz), make sure the PLL is enabled.
9763 @item @b{Amontec Chameleon} When debugging using an Amontec Chameleon in its JTAG Accelerator configuration,
9764 I keep getting "Error: amt_jtagaccel.c:184 amt_wait_scan_busy(): amt_jtagaccel timed
9765 out while waiting for end of scan, rtck was disabled".
9767 Make sure your PC's parallel port operates in EPP mode. You might have to try several
9768 settings in your PC BIOS (ECP, EPP, and different versions of those).
9770 @item @b{Data Aborts} When debugging with OpenOCD and GDB (plain GDB, Insight, or Eclipse),
9771 I get lots of "Error: arm7_9_common.c:1771 arm7_9_read_memory():
9772 memory read caused data abort".
9774 The errors are non-fatal, and are the result of GDB trying to trace stack frames
9775 beyond the last valid frame. It might be possible to prevent this by setting up
9776 a proper "initial" stack frame, if you happen to know what exactly has to
9777 be done, feel free to add this here.
9779 @b{Simple:} In your startup code - push 8 registers of zeros onto the
9780 stack before calling main(). What GDB is doing is ``climbing'' the run
9781 time stack by reading various values on the stack using the standard
9782 call frame for the target. GDB keeps going - until one of 2 things
9783 happen @b{#1} an invalid frame is found, or @b{#2} some huge number of
9784 stackframes have been processed. By pushing zeros on the stack, GDB
9785 gracefully stops.
9787 @b{Debugging Interrupt Service Routines} - In your ISR before you call
9788 your C code, do the same - artifically push some zeros onto the stack,
9789 remember to pop them off when the ISR is done.
9791 @b{Also note:} If you have a multi-threaded operating system, they
9792 often do not @b{in the intrest of saving memory} waste these few
9793 bytes. Painful...
9796 @item @b{JTAG Reset Config} I get the following message in the OpenOCD console (or log file):
9797 "Warning: arm7_9_common.c:679 arm7_9_assert_reset(): srst resets test logic, too".
9799 This warning doesn't indicate any serious problem, as long as you don't want to
9800 debug your core right out of reset. Your .cfg file specified @option{jtag_reset
9801 trst_and_srst srst_pulls_trst} to tell OpenOCD that either your board,
9802 your debugger or your target uC (e.g. LPC2000) can't assert the two reset signals
9803 independently. With this setup, it's not possible to halt the core right out of
9804 reset, everything else should work fine.
9806 @item @b{USB Power} When using OpenOCD in conjunction with Amontec JTAGkey and the Yagarto
9807 toolchain (Eclipse, arm-elf-gcc, arm-elf-gdb), the debugging seems to be
9808 unstable. When single-stepping over large blocks of code, GDB and OpenOCD
9809 quit with an error message. Is there a stability issue with OpenOCD?
9811 No, this is not a stability issue concerning OpenOCD. Most users have solved
9812 this issue by simply using a self-powered USB hub, which they connect their
9813 Amontec JTAGkey to. Apparently, some computers do not provide a USB power
9814 supply stable enough for the Amontec JTAGkey to be operated.
9816 @b{Laptops running on battery have this problem too...}
9818 @item @b{GDB Disconnects} When using the Amontec JTAGkey, sometimes OpenOCD crashes with the following
9819 error message: "Error: gdb_server.c:101 gdb_get_char(): read: 10054".
9820 What does that mean and what might be the reason for this?
9822 Error code 10054 corresponds to WSAECONNRESET, which means that the debugger (GDB)
9823 has closed the connection to OpenOCD. This might be a GDB issue.
9825 @item @b{LPC2000 Flash} In the configuration file in the section where flash device configurations
9826 are described, there is a parameter for specifying the clock frequency
9827 for LPC2000 internal flash devices (e.g. @option{flash bank $_FLASHNAME lpc2000
9828 0x0 0x40000 0 0 $_TARGETNAME lpc2000_v1 14746 calc_checksum}), which must be
9829 specified in kilohertz. However, I do have a quartz crystal of a
9830 frequency that contains fractions of kilohertz (e.g. 14,745,600 Hz,
9831 i.e. 14,745.600 kHz). Is it possible to specify real numbers for the
9832 clock frequency?
9834 No. The clock frequency specified here must be given as an integral number.
9835 However, this clock frequency is used by the In-Application-Programming (IAP)
9836 routines of the LPC2000 family only, which seems to be very tolerant concerning
9837 the given clock frequency, so a slight difference between the specified clock
9838 frequency and the actual clock frequency will not cause any trouble.
9840 @item @b{Command Order} Do I have to keep a specific order for the commands in the configuration file?
9842 Well, yes and no. Commands can be given in arbitrary order, yet the
9843 devices listed for the JTAG scan chain must be given in the right
9844 order (jtag newdevice), with the device closest to the TDO-Pin being
9845 listed first. In general, whenever objects of the same type exist
9846 which require an index number, then these objects must be given in the
9847 right order (jtag newtap, targets and flash banks - a target
9848 references a jtag newtap and a flash bank references a target).
9850 You can use the ``scan_chain'' command to verify and display the tap order.
9852 Also, some commands can't execute until after @command{init} has been
9853 processed. Such commands include @command{nand probe} and everything
9854 else that needs to write to controller registers, perhaps for setting
9855 up DRAM and loading it with code.
9857 @anchor{faqtaporder}
9858 @item @b{JTAG TAP Order} Do I have to declare the TAPS in some
9859 particular order?
9861 Yes; whenever you have more than one, you must declare them in
9862 the same order used by the hardware.
9864 Many newer devices have multiple JTAG TAPs. For example: ST
9865 Microsystems STM32 chips have two TAPs, a ``boundary scan TAP'' and
9866 ``Cortex-M3'' TAP. Example: The STM32 reference manual, Document ID:
9867 RM0008, Section 26.5, Figure 259, page 651/681, the ``TDI'' pin is
9868 connected to the boundary scan TAP, which then connects to the
9869 Cortex-M3 TAP, which then connects to the TDO pin.
9871 Thus, the proper order for the STM32 chip is: (1) The Cortex-M3, then
9872 (2) The boundary scan TAP. If your board includes an additional JTAG
9873 chip in the scan chain (for example a Xilinx CPLD or FPGA) you could
9874 place it before or after the STM32 chip in the chain. For example:
9876 @itemize @bullet
9877 @item OpenOCD_TDI(output) -> STM32 TDI Pin (BS Input)
9878 @item STM32 BS TDO (output) -> STM32 Cortex-M3 TDI (input)
9879 @item STM32 Cortex-M3 TDO (output) -> SM32 TDO Pin
9880 @item STM32 TDO Pin (output) -> Xilinx TDI Pin (input)
9881 @item Xilinx TDO Pin -> OpenOCD TDO (input)
9882 @end itemize
9884 The ``jtag device'' commands would thus be in the order shown below. Note:
9886 @itemize @bullet
9887 @item jtag newtap Xilinx tap -irlen ...
9888 @item jtag newtap stm32  cpu -irlen ...
9889 @item jtag newtap stm32  bs  -irlen ...
9890 @item # Create the debug target and say where it is
9891 @item target create stm32.cpu -chain-position stm32.cpu ...
9892 @end itemize
9895 @item @b{SYSCOMP} Sometimes my debugging session terminates with an error. When I look into the
9896 log file, I can see these error messages: Error: arm7_9_common.c:561
9897 arm7_9_execute_sys_speed(): timeout waiting for SYSCOMP
9899 TODO.
9901 @end enumerate
9903 @node Tcl Crash Course
9904 @chapter Tcl Crash Course
9905 @cindex Tcl
9907 Not everyone knows Tcl - this is not intended to be a replacement for
9908 learning Tcl, the intent of this chapter is to give you some idea of
9909 how the Tcl scripts work.
9911 This chapter is written with two audiences in mind. (1) OpenOCD users
9912 who need to understand a bit more of how Jim-Tcl works so they can do
9913 something useful, and (2) those that want to add a new command to
9914 OpenOCD.
9916 @section Tcl Rule #1
9917 There is a famous joke, it goes like this:
9918 @enumerate
9919 @item Rule #1: The wife is always correct
9920 @item Rule #2: If you think otherwise, See Rule #1
9921 @end enumerate
9923 The Tcl equal is this:
9925 @enumerate
9926 @item Rule #1: Everything is a string
9927 @item Rule #2: If you think otherwise, See Rule #1
9928 @end enumerate
9930 As in the famous joke, the consequences of Rule #1 are profound. Once
9931 you understand Rule #1, you will understand Tcl.
9933 @section Tcl Rule #1b
9934 There is a second pair of rules.
9935 @enumerate
9936 @item Rule #1: Control flow does not exist. Only commands
9937 @* For example: the classic FOR loop or IF statement is not a control
9938 flow item, they are commands, there is no such thing as control flow
9939 in Tcl.
9940 @item Rule #2: If you think otherwise, See Rule #1
9941 @* Actually what happens is this: There are commands that by
9942 convention, act like control flow key words in other languages. One of
9943 those commands is the word ``for'', another command is ``if''.
9944 @end enumerate
9946 @section Per Rule #1 - All Results are strings
9947 Every Tcl command results in a string. The word ``result'' is used
9948 deliberatly. No result is just an empty string. Remember: @i{Rule #1 -
9949 Everything is a string}
9951 @section Tcl Quoting Operators
9952 In life of a Tcl script, there are two important periods of time, the
9953 difference is subtle.
9954 @enumerate
9955 @item Parse Time
9956 @item Evaluation Time
9957 @end enumerate
9959 The two key items here are how ``quoted things'' work in Tcl. Tcl has
9960 three primary quoting constructs, the [square-brackets] the
9961 @{curly-braces@} and ``double-quotes''
9963 By now you should know $VARIABLES always start with a $DOLLAR
9964 sign. BTW: To set a variable, you actually use the command ``set'', as
9965 in ``set VARNAME VALUE'' much like the ancient BASIC langauge ``let x
9966 = 1'' statement, but without the equal sign.
9968 @itemize @bullet
9969 @item @b{[square-brackets]}
9970 @* @b{[square-brackets]} are command substitutions. It operates much
9971 like Unix Shell `back-ticks`. The result of a [square-bracket]
9972 operation is exactly 1 string. @i{Remember Rule #1 - Everything is a
9973 string}. These two statements are roughly identical:
9974 @example
9975     # bash example
9976     X=`date`
9977     echo "The Date is: $X"
9978     # Tcl example
9979     set X [date]
9980     puts "The Date is: $X"
9981 @end example
9982 @item @b{``double-quoted-things''}
9983 @* @b{``double-quoted-things''} are just simply quoted
9984 text. $VARIABLES and [square-brackets] are expanded in place - the
9985 result however is exactly 1 string. @i{Remember Rule #1 - Everything
9986 is a string}
9987 @example
9988     set x "Dinner"
9989     puts "It is now \"[date]\", $x is in 1 hour"
9990 @end example
9991 @item @b{@{Curly-Braces@}}
9992 @*@b{@{Curly-Braces@}} are magic: $VARIABLES and [square-brackets] are
9993 parsed, but are NOT expanded or executed. @{Curly-Braces@} are like
9994 'single-quote' operators in BASH shell scripts, with the added
9995 feature: @{curly-braces@} can be nested, single quotes can not. @{@{@{this is
9996 nested 3 times@}@}@} NOTE: [date] is a bad example;
9997 at this writing, Jim/OpenOCD does not have a date command.
9998 @end itemize
10000 @section Consequences of Rule 1/2/3/4
10002 The consequences of Rule 1 are profound.
10004 @subsection Tokenisation & Execution.
10006 Of course, whitespace, blank lines and #comment lines are handled in
10007 the normal way.
10009 As a script is parsed, each (multi) line in the script file is
10010 tokenised and according to the quoting rules. After tokenisation, that
10011 line is immedatly executed.
10013 Multi line statements end with one or more ``still-open''
10014 @{curly-braces@} which - eventually - closes a few lines later.
10016 @subsection Command Execution
10018 Remember earlier: There are no ``control flow''
10019 statements in Tcl. Instead there are COMMANDS that simply act like
10020 control flow operators.
10022 Commands are executed like this:
10024 @enumerate
10025 @item Parse the next line into (argc) and (argv[]).
10026 @item Look up (argv[0]) in a table and call its function.
10027 @item Repeat until End Of File.
10028 @end enumerate
10030 It sort of works like this:
10031 @example
10032     for(;;)@{
10033         ReadAndParse( &argc, &argv );
10035         cmdPtr = LookupCommand( argv[0] );
10037         (*cmdPtr->Execute)( argc, argv );
10038     @}
10039 @end example
10041 When the command ``proc'' is parsed (which creates a procedure
10042 function) it gets 3 parameters on the command line. @b{1} the name of
10043 the proc (function), @b{2} the list of parameters, and @b{3} the body
10044 of the function. Not the choice of words: LIST and BODY. The PROC
10045 command stores these items in a table somewhere so it can be found by
10046 ``LookupCommand()''
10048 @subsection The FOR command
10050 The most interesting command to look at is the FOR command. In Tcl,
10051 the FOR command is normally implemented in C. Remember, FOR is a
10052 command just like any other command.
10054 When the ascii text containing the FOR command is parsed, the parser
10055 produces 5 parameter strings, @i{(If in doubt: Refer to Rule #1)} they
10056 are:
10058 @enumerate 0
10059 @item The ascii text 'for'
10060 @item The start text
10061 @item The test expression
10062 @item The next text
10063 @item The body text
10064 @end enumerate
10066 Sort of reminds you of ``main( int argc, char **argv )'' does it not?
10067 Remember @i{Rule #1 - Everything is a string.} The key point is this:
10068 Often many of those parameters are in @{curly-braces@} - thus the
10069 variables inside are not expanded or replaced until later.
10071 Remember that every Tcl command looks like the classic ``main( argc,
10072 argv )'' function in C. In JimTCL - they actually look like this:
10074 @example
10076 MyCommand( Jim_Interp *interp,
10077            int *argc,
10078            Jim_Obj * const *argvs );
10079 @end example
10081 Real Tcl is nearly identical. Although the newer versions have
10082 introduced a byte-code parser and intepreter, but at the core, it
10083 still operates in the same basic way.
10085 @subsection FOR command implementation
10087 To understand Tcl it is perhaps most helpful to see the FOR
10088 command. Remember, it is a COMMAND not a control flow structure.
10090 In Tcl there are two underlying C helper functions.
10092 Remember Rule #1 - You are a string.
10094 The @b{first} helper parses and executes commands found in an ascii
10095 string. Commands can be seperated by semicolons, or newlines. While
10096 parsing, variables are expanded via the quoting rules.
10098 The @b{second} helper evaluates an ascii string as a numerical
10099 expression and returns a value.
10101 Here is an example of how the @b{FOR} command could be
10102 implemented. The pseudo code below does not show error handling.
10103 @example
10104 void Execute_AsciiString( void *interp, const char *string );
10106 int Evaluate_AsciiExpression( void *interp, const char *string );
10109 MyForCommand( void *interp,
10110               int argc,
10111               char **argv )
10113    if( argc != 5 )@{
10114        SetResult( interp, "WRONG number of parameters");
10115        return ERROR;
10116    @}
10118    // argv[0] = the ascii string just like C
10120    // Execute the start statement.
10121    Execute_AsciiString( interp, argv[1] );
10123    // Top of loop test
10124    for(;;)@{
10125         i = Evaluate_AsciiExpression(interp, argv[2]);
10126         if( i == 0 )
10127             break;
10129         // Execute the body
10130         Execute_AsciiString( interp, argv[3] );
10132         // Execute the LOOP part
10133         Execute_AsciiString( interp, argv[4] );
10134     @}
10136     // Return no error
10137     SetResult( interp, "" );
10138     return SUCCESS;
10140 @end example
10142 Every other command IF, WHILE, FORMAT, PUTS, EXPR, everything works
10143 in the same basic way.
10145 @section OpenOCD Tcl Usage
10147 @subsection source and find commands
10148 @b{Where:} In many configuration files
10149 @* Example: @b{ source [find FILENAME] }
10150 @*Remember the parsing rules
10151 @enumerate
10152 @item The @command{find} command is in square brackets,
10153 and is executed with the parameter FILENAME. It should find and return
10154 the full path to a file with that name; it uses an internal search path.
10155 The RESULT is a string, which is substituted into the command line in
10156 place of the bracketed @command{find} command.
10157 (Don't try to use a FILENAME which includes the "#" character.
10158 That character begins Tcl comments.)
10159 @item The @command{source} command is executed with the resulting filename;
10160 it reads a file and executes as a script.
10161 @end enumerate
10162 @subsection format command
10163 @b{Where:} Generally occurs in numerous places.
10164 @* Tcl has no command like @b{printf()}, instead it has @b{format}, which is really more like
10165 @b{sprintf()}.
10166 @b{Example}
10167 @example
10168     set x 6
10169     set y 7
10170     puts [format "The answer: %d" [expr $x * $y]]
10171 @end example
10172 @enumerate
10173 @item The SET command creates 2 variables, X and Y.
10174 @item The double [nested] EXPR command performs math
10175 @* The EXPR command produces numerical result as a string.
10176 @* Refer to Rule #1
10177 @item The format command is executed, producing a single string
10178 @* Refer to Rule #1.
10179 @item The PUTS command outputs the text.
10180 @end enumerate
10181 @subsection Body or Inlined Text
10182 @b{Where:} Various TARGET scripts.
10183 @example
10184 #1 Good
10185    proc someproc @{@} @{
10186        ... multiple lines of stuff ...
10187    @}
10188    $_TARGETNAME configure -event FOO someproc
10189 #2 Good - no variables
10190    $_TARGETNAME confgure -event foo "this ; that;"
10191 #3 Good Curly Braces
10192    $_TARGETNAME configure -event FOO @{
10193         puts "Time: [date]"
10194    @}
10195 #4 DANGER DANGER DANGER
10196    $_TARGETNAME configure -event foo "puts \"Time: [date]\""
10197 @end example
10198 @enumerate
10199 @item The $_TARGETNAME is an OpenOCD variable convention.
10200 @*@b{$_TARGETNAME} represents the last target created, the value changes
10201 each time a new target is created. Remember the parsing rules. When
10202 the ascii text is parsed, the @b{$_TARGETNAME} becomes a simple string,
10203 the name of the target which happens to be a TARGET (object)
10204 command.
10205 @item The 2nd parameter to the @option{-event} parameter is a TCBODY
10206 @*There are 4 examples:
10207 @enumerate
10208 @item The TCLBODY is a simple string that happens to be a proc name
10209 @item The TCLBODY is several simple commands seperated by semicolons
10210 @item The TCLBODY is a multi-line @{curly-brace@} quoted string
10211 @item The TCLBODY is a string with variables that get expanded.
10212 @end enumerate
10214 In the end, when the target event FOO occurs the TCLBODY is
10215 evaluated. Method @b{#1} and @b{#2} are functionally identical. For
10216 Method @b{#3} and @b{#4} it is more interesting. What is the TCLBODY?
10218 Remember the parsing rules. In case #3, @{curly-braces@} mean the
10219 $VARS and [square-brackets] are expanded later, when the EVENT occurs,
10220 and the text is evaluated. In case #4, they are replaced before the
10221 ``Target Object Command'' is executed. This occurs at the same time
10222 $_TARGETNAME is replaced. In case #4 the date will never
10223 change. @{BTW: [date] is a bad example; at this writing,
10224 Jim/OpenOCD does not have a date command@}
10225 @end enumerate
10226 @subsection Global Variables
10227 @b{Where:} You might discover this when writing your own procs @* In
10228 simple terms: Inside a PROC, if you need to access a global variable
10229 you must say so. See also ``upvar''. Example:
10230 @example
10231 proc myproc @{ @} @{
10232      set y 0 #Local variable Y
10233      global x #Global variable X
10234      puts [format "X=%d, Y=%d" $x $y]
10236 @end example
10237 @section Other Tcl Hacks
10238 @b{Dynamic variable creation}
10239 @example
10240 # Dynamically create a bunch of variables.
10241 for @{ set x 0 @} @{ $x < 32 @} @{ set x [expr $x + 1]@} @{
10242     # Create var name
10243     set vn [format "BIT%d" $x]
10244     # Make it a global
10245     global $vn
10246     # Set it.
10247     set $vn [expr (1 << $x)]
10249 @end example
10250 @b{Dynamic proc/command creation}
10251 @example
10252 # One "X" function - 5 uart functions.
10253 foreach who @{A B C D E@}
10254    proc [format "show_uart%c" $who] @{ @} "show_UARTx $who"
10256 @end example
10258 @include fdl.texi
10260 @node OpenOCD Concept Index
10261 @comment DO NOT use the plain word ``Index'', reason: CYGWIN filename
10262 @comment case issue with ``Index.html'' and ``index.html''
10263 @comment Occurs when creating ``--html --no-split'' output
10264 @comment This fix is based on: http://sourceware.org/ml/binutils/2006-05/msg00215.html
10265 @unnumbered OpenOCD Concept Index
10267 @printindex cp
10269 @node Command and Driver Index
10270 @unnumbered Command and Driver Index
10271 @printindex fn
10273 @bye