Go to file
P33M 4d87f6dcae
Merge pull request #84 from picmaster/rp2040-v0.12.0
flash/nor/spi: add zetta zd25q16
2023-08-07 11:51:45 +01:00
.github/workflows github/workflow: enable libftdi based adapters 2022-06-03 23:46:02 +00:00
LICENSES openocd: src: replace the GPL and BSD-Source-Code license tags 2022-07-23 13:14:59 +00:00
contrib openocd: fix SPDX tag format for files .c 2022-09-18 08:22:01 +00:00
doc doc: describe tcl port consistently. 2022-12-03 09:27:27 +00:00
jimtcl@a77ef1a621 jimtcl: update to version 0.81 (2021-11-28) 2021-12-03 21:47:07 +00:00
src flash/nor/spi: add zetta zd25q16 2023-08-04 00:25:51 +03:00
tcl interface: raspberrypi-swd: add override for downstream pin connections 2023-07-07 14:07:05 +01:00
testing drivers/bcm2835gpio: Migrate to adapter gpio commands 2022-09-13 22:17:14 +00:00
tools checkpatch: fix for flag --no-tree 2022-09-23 21:19:44 +00:00
.checkpatch.conf checkpatch: enable CAMELCASE test 2022-09-18 08:20:56 +00:00
.gitignore checkpatch: enable CAMELCASE test 2022-09-18 08:20:56 +00:00
.gitmodules .gitmodules: switch away from repo.or.cz 2022-02-19 14:33:08 +00:00
.travis.yml openocd: fix syntax of SPDX tags 2022-09-13 22:03:24 +00:00
AUTHORS Add AUTHORS for 0.2.0 release. 2009-07-02 11:17:21 +00:00
AUTHORS.ChangeLog Add AUTHORS.ChangeLog file suitable to be passed to 'svn2cl --authors'. 2009-07-02 11:18:45 +00:00
BUGS docs: update OpenOCD url's to openocd.org domain 2015-04-16 20:28:21 +01:00
COPYING LICENSES: add 'license-rules.txt' 2021-04-11 20:52:43 +01:00
ChangeLog fix typos in documentation 2009-11-26 10:12:22 -08:00
Doxyfile.in Doxyfile.in: exclude libjaylink from doxygen 2021-01-13 11:33:14 +00:00
HACKING HACKING: add chapter on checkpatch 2022-09-18 08:21:40 +00:00
Makefile.am openocd: src: replace the GPL and BSD-Source-Code license tags 2022-07-23 13:14:59 +00:00
NEWS The openocd-0.12.0 release 2023-01-14 23:14:31 +03:00
NEWS-0.2.0 whitespace cleanup, mostly for docs 2009-12-30 11:51:29 -08:00
NEWS-0.3.0 Version 0.4.0-dev 2009-11-04 19:44:36 -08:00
NEWS-0.4.0 Open the merge window for the 0.5.0 release cycle. 2010-02-21 13:27:37 -08:00
NEWS-0.5.0 coding style: doc: remove empty lines at end of text files 2020-02-24 10:31:29 +00:00
NEWS-0.6.0 Restore -dev suffix, archive NEWS file, add new blank NEWS file - start 2012-09-07 11:04:05 +02:00
NEWS-0.7.0 Restore normal development cycle 2013-05-05 10:45:03 +02:00
NEWS-0.8.0 Restore normal development cycle 2014-04-27 15:07:08 +04:00
NEWS-0.9.0 Restore normal development cycle 2015-05-18 00:34:18 +03:00
NEWS-0.10.0 Restore normal development cycle 2017-01-23 00:46:51 +03:00
NEWS-0.11.0 Restore normal development cycle 2021-03-07 15:44:45 +03:00
NEWTAPS Fix spelling of ARM Cortex 2016-05-20 21:38:03 +01:00
README README: update build dependency list 2022-10-15 15:59:20 +00:00
README.Windows openocd: drop dependency from libusb0 2021-04-05 23:25:34 +01:00
README.macOS openocd: drop dependency from libusb0 2021-04-05 23:25:34 +01:00
TODO swim: add new transport 2020-05-24 21:32:05 +01:00
bootstrap openocd: build: add SPDX tag 2022-07-23 13:06:38 +00:00
config_subdir.m4 jimtcl: add configure flag for build maintainer mode 2022-03-12 09:47:18 +00:00
configure.ac The openocd-0.12.0 release 2023-01-14 23:14:31 +03:00
guess-rev.sh guess-rev.sh: fix minor typo 2019-05-23 22:14:30 +01:00
uncrustify.cfg build: update uncrustify config 2012-02-06 10:40:25 +00:00


Welcome to OpenOCD!

OpenOCD provides on-chip programming and debugging support with a
layered architecture of JTAG interface and TAP support including:

- (X)SVF playback to facilitate automated boundary scan and FPGA/CPLD
- debug target support (e.g. ARM, MIPS): single-stepping,
  breakpoints/watchpoints, gprof profiling, etc;
- flash chip drivers (e.g. CFI, NAND, internal flash);
- embedded TCL interpreter for easy scripting.

Several network interfaces are available for interacting with OpenOCD:
telnet, TCL, and GDB. The GDB server enables OpenOCD to function as a
"remote target" for source-level debugging of embedded systems using
the GNU GDB program (and the others who talk GDB protocol, e.g. IDA

This README file contains an overview of the following topics:

- quickstart instructions,
- how to find and build more OpenOCD documentation,
- list of the supported hardware,
- the installation and build process,
- packaging tips.

Quickstart for the impatient

If you have a popular board then just start OpenOCD with its config,

  openocd -f board/stm32f4discovery.cfg

If you are connecting a particular adapter with some specific target,
you need to source both the jtag interface and the target configs,

  openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \
          -f target/ti_calypso.cfg

  openocd -f interface/stlink.cfg -c "transport select hla_swd" \
          -f target/stm32l0.cfg

After OpenOCD startup, connect GDB with

  (gdb) target extended-remote localhost:3333

OpenOCD Documentation

In addition to the in-tree documentation, the latest manuals may be
viewed online at the following URLs:

  OpenOCD User's Guide:

  OpenOCD Developer's Manual:

These reflect the latest development versions, so the following section
introduces how to build the complete documentation from the package.

For more information, refer to these documents or contact the developers
by subscribing to the OpenOCD developer mailing list:


Building the OpenOCD Documentation

By default the OpenOCD build process prepares documentation in the
"Info format" and installs it the standard way, so that "info openocd"
can access it.

Additionally, the OpenOCD User's Guide can be produced in the
following different formats:

  # If PDFVIEWER is set, this creates and views the PDF User Guide.
  make pdf && ${PDFVIEWER} doc/openocd.pdf

  # If HTMLVIEWER is set, this creates and views the HTML User Guide.
  make html && ${HTMLVIEWER} doc/openocd.html/index.html

The OpenOCD Developer Manual contains information about the internal
architecture and other details about the code:

  # NB! make sure doxygen is installed, type doxygen --version
  make doxygen && ${HTMLVIEWER} doxygen/index.html

Supported hardware

JTAG adapters

AICE, AM335x, ARM-JTAG-EW, ARM-USB-OCD, ARM-USB-TINY, AT91RM9200, axm0432, BCM2835,
Bus Blaster, Buspirate, Cadence DPI, Cadence vdebug, Chameleon, CMSIS-DAP,
Cortino, Cypress KitProg, DENX, Digilent JTAG-SMT2, DLC 5, DLP-USB1232H,
embedded projects, Espressif USB JTAG Programmer,
eStick, FlashLINK, FlossJTAG, Flyswatter, Flyswatter2,
FTDI FT232R, Gateworks, Hoegl, ICDI, ICEBear, J-Link, JTAG VPI, JTAGkey,
JTAGkey2, JTAG-lock-pick, KT-Link, Linux GPIOD, Lisa/L, LPC1768-Stick,
Mellanox rshim, MiniModule, NGX, Nuvoton Nu-Link, Nu-Link2, NXHX, NXP IMX GPIO,
OOCDLink, Opendous, OpenJTAG, Openmoko, OpenRD, OSBDM, Presto, Redbee,
Remote Bitbang, RLink, SheevaPlug devkit, Stellaris evkits,
ST-LINK (SWO tracing supported), STM32-PerformanceStick, STR9-comStick,
sysfsgpio, Tigard, TI XDS110, TUMPA, Turtelizer, ULINK, USB-A9260, USB-Blaster,
USB-JTAG, USBprog, VPACLink, VSLLink, Wiggler, XDS100v2, Xilinx XVC/PCIe,

Debug targets

ARM: AArch64, ARM11, ARM7, ARM9, Cortex-A/R (v7-A/R), Cortex-M (ARMv{6/7/8}-M),
FA526, Feroceon/Dragonite, XScale.
ARCv2, AVR32, DSP563xx, DSP5680xx, EnSilica eSi-RISC, EJTAG (MIPS32, MIPS64),
ESP32, ESP32-S2, ESP32-S3, Intel Quark, LS102x-SAP, NDS32, RISC-V, ST STM8,

Flash drivers

ADUC702x, AT91SAM, AT91SAM9 (NAND), ATH79, ATmega128RFA1, Atmel SAM, AVR, CFI,
DSP5680xx, EFM32, EM357, eSi-RISC, eSi-TSMC, EZR32HG, FM3, FM4, Freedom E SPI,
GD32, i.MX31, Kinetis, LPC8xx/LPC1xxx/LPC2xxx/LPC541xx, LPC2900, LPC3180, LPC32xx,
LPCSPIFI, Marvell QSPI, MAX32, Milandr, MXC, NIIET, nRF51, nRF52 , NuMicro,
NUC910, Nuvoton NPCX, onsemi RSL10, Orion/Kirkwood, PIC32mx, PSoC4/5LP/6,
Raspberry RP2040, Renesas RPC HF and SH QSPI,
S3C24xx, S3C6400, SiM3x, SiFive Freedom E, Stellaris, ST BlueNRG, STM32,
TI CC13xx, TI CC26xx, TI CC32xx, TI MSP432, Winner Micro w600, Xilinx XCF,
XMC1xxx, XMC4xxx.

Installing OpenOCD

A Note to OpenOCD Users

If you would rather be working "with" OpenOCD rather than "on" it, your
operating system or JTAG interface supplier may provide binaries for
you in a convenient-enough package.

Such packages may be more stable than git mainline, where
bleeding-edge development takes place. These "Packagers" produce
binary releases of OpenOCD after the developers produces new "release"
versions of the source code. Previous versions of OpenOCD cannot be
used to diagnose problems with the current release, so users are
encouraged to keep in contact with their distribution package
maintainers or interface vendors to ensure suitable upgrades appear

Users of these binary versions of OpenOCD must contact their Packager to
ask for support or newer versions of the binaries; the OpenOCD
developers do not support packages directly.

A Note to OpenOCD Packagers

You are a PACKAGER of OpenOCD if you:

- Sell dongles and include pre-built binaries;
- Supply tools or IDEs (a development solution integrating OpenOCD);
- Build packages (e.g. RPM or DEB files for a GNU/Linux distribution).

As a PACKAGER, you will experience first reports of most issues.
When you fix those problems for your users, your solution may help
prevent hundreds (if not thousands) of other questions from other users.

If something does not work for you, please work to inform the OpenOCD
developers know how to improve the system or documentation to avoid
future problems, and follow-up to help us ensure the issue will be fully
resolved in our future releases.

That said, the OpenOCD developers would also like you to follow a few

- Send patches, including config files, upstream, participate in the
- Enable all the options OpenOCD supports, even those unrelated to your
  particular hardware;
- Use "ftdi" interface adapter driver for the FTDI-based devices.

Building OpenOCD

The INSTALL file contains generic instructions for running 'configure'
and compiling the OpenOCD source code. That file is provided by
default for all GNU autotools packages. If you are not familiar with
the GNU autotools, then you should read those instructions first.

The remainder of this document tries to provide some instructions for
those looking for a quick-install.

OpenOCD Dependencies

GCC or Clang is currently required to build OpenOCD. The developers
have begun to enforce strict code warnings (-Wall, -Werror, -Wextra,
and more) and use C99-specific features: inline functions, named
initializers, mixing declarations with code, and other tricks. While
it may be possible to use other compilers, they must be somewhat
modern and could require extending support to conditionally remove
GCC-specific extensions.

You'll also need:

- make
- libtool
- pkg-config >= 0.23 or pkgconf

OpenOCD uses jimtcl library; build from git can retrieve jimtcl as git

Additionally, for building from git:

- autoconf >= 2.69
- automake >= 1.14
- texinfo >= 5.0

Optional USB-based adapter drivers need libusb-1.0.

Optional USB-Blaster, ASIX Presto and OpenJTAG interface adapter
drivers need:
  - libftdi: http://www.intra2net.com/en/developer/libftdi/index.php

Optional CMSIS-DAP adapter driver needs HIDAPI library.

Optional linuxgpiod adapter driver needs libgpiod library.

Optional JLink adapter driver needs libjaylink; build from git can
retrieve libjaylink as git submodule.

Optional ARM disassembly needs capstone library.

Optional development script checkpatch needs:

- perl
- python
- python-ply

Permissions delegation

Running OpenOCD with root/administrative permissions is strongly
discouraged for security reasons.

For USB devices on GNU/Linux you should use the contrib/60-openocd.rules
file. It probably belongs somewhere in /etc/udev/rules.d, but
consult your operating system documentation to be sure. Do not forget
to add yourself to the "plugdev" group.

For parallel port adapters on GNU/Linux and FreeBSD please change your
"ppdev" (parport* or ppi*) device node permissions accordingly.

For parport adapters on Windows you need to run install_giveio.bat
(it's also possible to use "ioperm" with Cygwin instead) to give
ordinary users permissions for accessing the "LPT" registers directly.

Compiling OpenOCD

To build OpenOCD, use the following sequence of commands:

  ./bootstrap (when building from the git repository)
  ./configure [options]
  sudo make install

The 'configure' step generates the Makefiles required to build
OpenOCD, usually with one or more options provided to it. The first
'make' step will build OpenOCD and place the final executable in
'./src/'. The final (optional) step, ``make install'', places all of
the files in the required location.

To see the list of all the supported options, run
  ./configure --help

Cross-compiling Options

Cross-compiling is supported the standard autotools way, you just need
to specify the cross-compiling target triplet in the --host option,
e.g. for cross-building for Windows 32-bit with MinGW on Debian:

  ./configure --host=i686-w64-mingw32 [options]

To make pkg-config work nicely for cross-compiling, you might need an
additional wrapper script as described at


This is needed to tell pkg-config where to look for the target
libraries that OpenOCD depends on. Alternatively, you can specify
*_CFLAGS and *_LIBS environment variables directly, see "./configure
--help" for the details.

For a more or less complete script that does all this for you, see


Parallel Port Dongles

If you want to access the parallel port using the PPDEV interface you
have to specify both --enable-parport AND --enable-parport-ppdev, since
the later option is an option to the parport driver.

The same is true for the --enable-parport-giveio option, you have to
use both the --enable-parport AND the --enable-parport-giveio option
if you want to use giveio instead of ioperm parallel port access

Obtaining OpenOCD From GIT

You can download the current GIT version with a GIT client of your
choice from the main repository:


You may prefer to use a mirror:


Using the GIT command line client, you might use the following command
to set up a local copy of the current repository (make sure there is no
directory called "openocd" in the current directory):

   git clone git://git.code.sf.net/p/openocd/code openocd

Then you can update that at your convenience using

   git pull

There is also a gitweb interface, which you can use either to browse
the repository or to download arbitrary snapshots using HTTP:


Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
each at this writing.