Open OCD User’s Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 193 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Scroll down to view the document on your mobile browser.

About
- What is OpenOCD?
- OpenOCD Web Site
- Latest User's Guide:
- OpenOCD User's Forum
- OpenOCD User's Mailing List
- OpenOCD IRC
OpenOCD Developer Resources
- OpenOCD Git Repository
- Doxygen Developer Manual
- Gerrit Review System
- OpenOCD Developer Mailing List
- OpenOCD Bug Tracker
Debug Adapter Hardware
- Choosing a Dongle
- Stand-alone JTAG Probe
- USB FT2232 Based
- USB-JTAG / Altera USB-Blaster compatibles
- USB J-Link based
- USB RLINK based
- USB ST-LINK based
- USB TI/Stellaris ICDI based
- USB CMSIS-DAP based
- USB Other
- IBM PC Parallel Printer Port Based
- Other...
About Jim-Tcl
Running
- Simple setup, no customization
- What OpenOCD does as it starts
OpenOCD Project Setup
- Hooking up the JTAG Adapter
- Project Directory
- Configuration Basics
- User Config Files
- Project-Specific Utilities
- Target Software Changes
- Target Hardware Setup
Config File Guidelines
- Interface Config Files
- Board Config Files
- Target Config Files
- Translating Configuration Files
Server Configuration
- Configuration Stage
- Entering the Run Stage
- TCP/IP Ports
- GDB Configuration
- Event Polling
Debug Adapter Configuration
- Interface Configuration
- Interface Drivers
- Transport Configuration
- JTAG Speed
Reset Configuration
- Types of Reset
- SRST and TRST Issues
- Commands for Handling Resets
- Custom Reset Handling
TAP Declaration
- Scan Chains
- TAP Names
- TAP Declaration Commands
- Other TAP commands
- TAP Events
- Enabling and Disabling TAPs
- Autoprobing
- DAP declaration (ARMv6-M, ARMv7 and ARMv8 targets)
CPU Configuration
- Target List
- Target CPU Types
- Target Configuration
- Other $target_name Commands
- Target Events
Flash Commands
- Flash Configuration Commands
- Erasing, Reading, Writing to Flash
- Other Flash commands
- Flash Driver List
  - External Flash
  - Internal Flash (Microcontrollers)
- NAND Flash Commands
- mFlash
  - mFlash Configuration
  - mFlash commands
Flash Programming
PLD/FPGA Commands
- PLD/FPGA Configuration and Commands
- PLD/FPGA Drivers, Options, and Commands
General Commands
- Server Commands
- Target State handling
- I/O Utilities
- Memory access commands
- Image loading commands
- Breakpoint and Watchpoint commands
- Misc Commands
Architecture and Core Commands
- ARM Hardware Tracing
- ARM Cross-Trigger Interface
- Generic ARM
- ARMv4 and ARMv5 Architecture
- ARMv6 Architecture
  - ARM11 specific commands
- ARMv7 and ARMv8 Architecture
- EnSilica eSi-RISC Architecture
- Intel Architecture
  - x86 32-bit specific commands
- OpenRISC Architecture
  - TAP and Debug Unit selection commands
  - Registers commands
- RISC-V Architecture
- Software Debug Messages and Tracing
JTAG Commands
- Low Level JTAG Commands
- TAP state names
Boundary Scan Commands
- SVF: Serial Vector Format
- XSVF: Xilinx Serial Vector Format
Utility Commands
- RAM testing
- Firmware recovery helpers
TFTP
GDB and OpenOCD
- Connecting to GDB
- Sample GDB session startup
- Configuring GDB for OpenOCD
- Programming using GDB
- Using GDB as a non-intrusive memory inspector
- Using OpenOCD SMP with GDB
- RTOS Support
Tcl Scripting API
- API rules
- Internal low-level Commands
- OpenOCD specific Global Variables
- Tcl RPC server
- Tcl RPC server notifications
- Tcl RPC server trace output
FAQ
Tcl Crash Course
- Tcl Rule #1
- Tcl Rule #1b
- Per Rule #1 - All Results are strings
- Tcl Quoting Operators
- Consequences of Rule 1/2/3/4
- OpenOCD Tcl Usage
- Other Tcl Hacks
The GNU Free Documentation License.
- ADDENDUM: How to use this License for your documents
OpenOCD Concept Index
Command and Driver Index

Navigation menu