OpenOCD User's Guide

OpenOCD User's Guide
About
- What is OpenOCD?
- OpenOCD Web Site
- Latest User's Guide:
- OpenOCD User's Forum
- OpenOCD User's Mailing List
- OpenOCD IRC
1 OpenOCD Developer Resources
- 1.1 OpenOCD GIT Repository
- 1.2 Doxygen Developer Manual
- 1.3 OpenOCD Developer Mailing List
- 1.4 OpenOCD Bug Database
2 Debug Adapter Hardware
- 2.1 Choosing a Dongle
- 2.2 Stand alone Systems
- 2.3 USB FT2232 Based
- 2.4 USB-JTAG / Altera USB-Blaster compatibles
- 2.5 USB JLINK based
- 2.6 USB RLINK based
- 2.7 USB ST-LINK based
- 2.8 USB Other
- 2.9 IBM PC Parallel Printer Port Based
- 2.10 Other...
3 About Jim-Tcl
4 Running
- 4.1 Simple setup, no customization
- 4.2 What OpenOCD does as it starts
5 OpenOCD Project Setup
- 5.1 Hooking up the JTAG Adapter
- 5.2 Project Directory
- 5.3 Configuration Basics
- 5.4 User Config Files
- 5.5 Project-Specific Utilities
- 5.6 Target Software Changes
- 5.7 Target Hardware Setup
6 Config File Guidelines
- 6.1 Interface Config Files
- 6.2 Board Config Files
- 6.3 Target Config Files
- 6.4 Translating Configuration Files
7 Daemon Configuration
- 7.1 Configuration Stage
- 7.2 Entering the Run Stage
- 7.3 TCP/IP Ports
- 7.4 GDB Configuration
- 7.5 Event Polling
8 Debug Adapter Configuration
- 8.1 Interface Configuration
- 8.2 Interface Drivers
- 8.3 Transport Configuration
- 8.4 JTAG Speed
9 Reset Configuration
- 9.1 Types of Reset
- 9.2 SRST and TRST Issues
- 9.3 Commands for Handling Resets
- 9.4 Custom Reset Handling
10 TAP Declaration
- 10.1 Scan Chains
- 10.2 TAP Names
- 10.3 TAP Declaration Commands
- 10.4 Other TAP commands
- 10.5 TAP Events
- 10.6 Enabling and Disabling TAPs
- 10.7 Autoprobing
11 CPU Configuration
- 11.1 Target List
- 11.2 Target CPU Types and Variants
- 11.3 Target Configuration
- 11.4 Other $target_name Commands
- 11.5 Target Events
12 Flash Commands
- 12.1 Flash Configuration Commands
- 12.2 Erasing, Reading, Writing to Flash
- 12.3 Other Flash commands
- 12.4 Flash Driver List
- 12.5 mFlash
  - 12.5.1 mFlash Configuration
  - 12.5.2 mFlash commands
13 NAND Flash Commands
- 13.1 NAND Configuration Commands
- 13.2 Erasing, Reading, Writing to NAND Flash
- 13.3 Other NAND commands
- 13.4 NAND Driver List
14 PLD/FPGA Commands
- 14.1 PLD/FPGA Configuration and Commands
- 14.2 PLD/FPGA Drivers, Options, and Commands
15 General Commands
- 15.1 Daemon Commands
- 15.2 Target State handling
- 15.3 I/O Utilities
- 15.4 Memory access commands
- 15.5 Image loading commands
- 15.6 Breakpoint and Watchpoint commands
- 15.7 Misc Commands
16 Architecture and Core Commands
- 16.1 ARM Hardware Tracing
- 16.2 Generic ARM
- 16.3 ARMv4 and ARMv5 Architecture
- 16.4 ARMv6 Architecture
  - 16.4.1 ARM11 specific commands
- 16.5 ARMv7 Architecture
  - 16.5.1 ARMv7 Debug Access Port (DAP) specific commands
  - 16.5.2 Cortex-M3 specific commands
- 16.6 Software Debug Messages and Tracing
17 JTAG Commands
- 17.1 Low Level JTAG Commands
- 17.2 TAP state names
18 Boundary Scan Commands
- 18.1 SVF: Serial Vector Format
- 18.2 XSVF: Xilinx Serial Vector Format
19 TFTP
20 GDB and OpenOCD
- 20.1 Connecting to GDB
- 20.2 Sample GDB session startup
- 20.3 Configuring GDB for OpenOCD
- 20.4 Programming using GDB
- 20.5 Using openocd SMP with GDB
21 Tcl Scripting API
- 21.1 API rules
- 21.2 Internal low-level Commands
- 21.3 OpenOCD specific Global Variables
22 FAQ
23 Tcl Crash Course
- 23.1 Tcl Rule #1
- 23.2 Tcl Rule #1b
- 23.3 Per Rule #1 - All Results are strings
- 23.4 Tcl Quoting Operators
- 23.5 Consequences of Rule 1/2/3/4
- 23.6 OpenOCD Tcl Usage
- 23.7 Other Tcl Hacks
Appendix A The GNU Free Documentation License.
- ADDENDUM: How to use this License for your documents
OpenOCD Concept Index
Command and Driver Index

This User's Guide documents release 0.6.1, dated 7 October 2012, of the Open On-Chip Debugger (OpenOCD).

OpenOCD User's Guide

Short Contents

Table of Contents

OpenOCD User's Guide