From 74fb8c83e6d1f9d2e1d28b844f4d9fc23037ec08 Mon Sep 17 00:00:00 2001 From: Swetha S Date: Wed, 8 Oct 2025 12:53:12 +0530 Subject: [PATCH 1/2] Rename README to README.md --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From a8cb29dacdaab0fa8948be5b758e7ab024946fe0 Mon Sep 17 00:00:00 2001 From: Swetha S Date: Wed, 8 Oct 2025 14:51:19 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 433 +++++++++++++++++++++++------------------------------- 1 file changed, 187 insertions(+), 246 deletions(-) diff --git a/README.md b/README.md index 875c85de3b..66f943c07b 100644 --- a/README.md +++ b/README.md @@ -1,152 +1,137 @@ -# Welcome to OpenOCD! +# Welcome to **OpenOCD** -OpenOCD provides on-chip programming and debugging support with a -layered architecture of JTAG interface and TAP support including: +**OpenOCD (Open On-Chip Debugger)** 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 - programming; -- 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 -Pro). +## Features -This README file contains an overview of the following topics: +- **(X)SVF playback** – facilitates automated boundary scan and FPGA/CPLD programming +- **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 -- quickstart instructions, -- how to find and build more OpenOCD documentation, -- list of the supported hardware, -- the installation and build process, -- packaging tips. +--- +## Network Interfaces -# Quickstart for the impatient +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 **GNU GDB** (and other tools that support the GDB protocol, e.g., **IDA Pro**). -If you have a popular board then just start OpenOCD with its config, -e.g.: +--- - openocd -f board/stm32f4discovery.cfg +## Table of Contents -If you are connecting a particular adapter with some specific target, -you need to source both the jtag interface and the target configs, -e.g.: +- [Quickstart](#quickstart) +- [Documentation](#documentation) +- [Supported Hardware](#supported-hardware) +- [Installing OpenOCD](#installing-openocd) +- [Building OpenOCD](#building-openocd) +- [Obtaining OpenOCD from GIT](#obtaining-openocd-from-git) -``` -openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \ - -f target/ti_calypso.cfg -``` - -``` -openocd -f interface/stlink.cfg -c "transport select 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: - http://openocd.org/doc/html/index.html - - OpenOCD Developer's Manual: - http://openocd.org/doc/doxygen/html/index.html - -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: +--- - openocd-devel@lists.sourceforge.net +## Quickstart -## Building the OpenOCD Documentation +If you have a popular board then just start OpenOCD with its config, e.g.: -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: - -Note: make sure doxygen is installed, type doxygen --version - - make doxygen && ${HTMLVIEWER} doxygen/index.html +```bash +openocd -f board/stm32f4discovery.cfg +``` +If you are connecting a particular adapter with a specific target, you need to source both the JTAG interface and the target configs, e.g.: -# Supported hardware +```bash +openocd -f interface/ftdi/jtagkey2.cfg -c "transport select jtag" \ + -f target/ti_calypso.cfg +``` -## JTAG adapters +or -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, -Xverve. +```bash +openocd -f interface/stlink.cfg -c "transport select swd" \ + -f target/stm32l0.cfg +``` +After OpenOCD startup, connect GDB with: -## Debug targets +```bash +(gdb) target extended-remote localhost:3333 +``` -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, RISC-V, ST STM8, -Xtensa. +## Documentation +In addition to the in-tree documentation, the latest manuals may be viewed online at: -## Flash drivers +- OpenOCD User's Guide - http://openocd.org/doc/html/index.html +- OpenOCD Developer's Manual - http://openocd.org/doc/doxygen/html/index.html +- For more information, refer to these documents or contact the developers by subscribing to the OpenOCD developer mailing list - [openocd-devel@lists.sourceforge.net](https://openocd-devel.narkive.com/) -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, -STM32 QUAD/OCTO-SPI for Flash/FRAM/EEPROM, STMSMI, STR7x, STR9x, SWM050, -TI CC13xx, TI CC26xx, TI CC32xx, TI MSP432, Winner Micro w600, Xilinx XCF, -XMC1xxx, XMC4xxx. +### Building the OpenOCD Documentation +By default, the OpenOCD build process prepares documentation in the Info format and installs it in the standard way, so that `info openocd` can access it. +Additionally, the OpenOCD User's Guide can be produced in the following different formats: -# Installing OpenOCD +- PDF - `make pdf && ${PDFVIEWER} doc/openocd.pdf` +- HTML - `make html && ${HTMLVIEWER} doc/openocd.html/index.html` + +The OpenOCD Developer Manual contains information about the internal architecture and other details about the code: -## A Note to OpenOCD Users +Make sure doxygen is installed: -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. +```bash +doxygen --version +``` -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" +make doxygen && ${HTMLVIEWER} doxygen/index.html + +## Supported Hardware +### JTAG Adapters + +| Adapter | Adapter | Adapter | Adapter | Adapter | Adapter | +|---------|---------|---------|---------|---------|---------| +| 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 | Xverve | + +### 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, RISC-V, ST STM8, Xtensa. + +### Flash Drivers +| Flask Driver | Flask Driver | Flask Driver | Flask Driver | Flask Driver | Flask Driver | +|----------------------|-----------------|-----------------|-----------------|-----------------|-----------------| +| 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 | SH QSPI | S3C24xx | S3C6400 | SiM3x | +| SiFive Freedom E | Stellaris | ST BlueNRG | STM32 | STM32 QUAD/OCTO-SPI | STMSMI | +| STR7x | STR9x | SWM050 | TI CC13xx | TI CC26xx | TI CC32xx | +| TI MSP432 | Winner Micro w600| Xilinx XCF | XMC1xxx | XMC4xxx | | + +## Installing OpenOCD +### A Note to OpenOCD Users +If you prefer to work with OpenOCD rather than on it, your OS or JTAG interface supplier may provide binaries for you. + +Such packages may be more stable than git mainline versions. + +Users of these binary versions must contact their Packager for support or updates — OpenOCD developers do not support binary packages directly. 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 @@ -157,13 +142,14 @@ 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 +### A Note on OpenOCD Packagers +#### You are a PACKAGER of OpenOCD if you: -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) -- 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). +#### Packager guidelines: As a PACKAGER, you will experience first reports of most issues. When you fix those problems for your users, your solution may help @@ -174,161 +160,116 @@ 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 -suggestions: - -- Send patches, including config files, upstream, participate in the - discussions; -- 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. +## Building OpenOCD +The INSTALL file contains detailed instructions for running configure and compiling OpenOCD. +Below is a quick summary. -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: +### Dependencies +#### Required: +- gcc or clang - make - libtool - pkg-config >= 0.23 or pkgconf - libjim >= 0.79 -Additionally, for building from git: +#### 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: -Optional CMSIS-DAP adapter driver needs HIDAPI library. +- libusb-1.0 – USB-based adapters +- libftdi – USB-Blaster, ASIX Presto, OpenJTAG +- hidapi – CMSIS-DAP +- libgpiod – linuxgpiod +- libjaylink – J-Link +- capstone – ARM disassembly -Optional linuxgpiod adapter driver needs libgpiod library. - -Optional J-Link adapter driver needs libjaylink library. - -Optional ARM disassembly needs capstone library. - -Optional development script checkpatch needs: +#### Optional script tools: - 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 +### Permissions Delegation +Running OpenOCD as root is discouraged. +For USB devices on Linux, use: +contrib/60-openocd.rules -To build OpenOCD, use the following sequence of commands: +Place it in /etc/udev/rules.d and add your user to the plugdev group. - ./bootstrap - ./configure [options] - make - sudo make install +**For parallel port adapters:** -The `bootstrap` command is only necessary when building from the Git repository. 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. +- **Linux/FreeBSD:** Change permissions on ppdev (parport* or ppi*) device nodes. +- **Windows:** Run install_giveio.bat (or use ioperm with Cygwin). -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 - - https://autotools.io/pkgconfig/cross-compiling.html - -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 - - contrib/cross-build.sh +### Compiling OpenOCD +Build with: +```bash +./bootstrap +./configure [options] +make +sudo make install +``` -## Parallel Port Dongles +- `bootstrap` — only for Git builds +- `configure` — generates Makefiles +- `make` — builds in ./src/ +- `make install` — installs system-wide -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. +To list all options: +```bash +./configure --help +``` -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 -method. +### Cross-Compiling Options +Cross-compiling example (Windows 32-bit, MinGW on Debian): +```bash +./configure --host=i686-w64-mingw32 [options] +``` -# Obtaining OpenOCD From GIT +For pkg-config cross-compiling setup: +[https://autotools.io/pkgconfig/cross-compiling.html](https://autotools.info/pkgconfig/cross-compiling.html) -You can download the current GIT version with a GIT client of your -choice from the main repository: +Alternatively, specify `*_CFLAGS` and `*_LIBS` directly. - git://git.code.sf.net/p/openocd/code +You can use the script: +```bash +contrib/cross-build.sh +``` -You may prefer to use a mirror: +### Parallel Port Dongles +For PPDEV interface: +```bash +--enable-parport --enable-parport-ppdev +``` - http://repo.or.cz/r/openocd.git - git://repo.or.cz/openocd.git +For giveio (Windows): +```bash +--enable-parport --enable-parport-giveio +``` -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): +## Obtaining OpenOCD from GIT +Download the current version: +```bash +git clone git://git.code.sf.net/p/openocd/code openocd +``` +Update with: +```bash +git pull +``` - git clone git://git.code.sf.net/p/openocd/code openocd +### Alternative mirrors: -Then you can update that at your convenience using `git pull`. +- http://repo.or.cz/r/openocd.git +- git://repo.or.cz/openocd.git -There is also a gitweb interface, which you can use either to browse -the repository or to download arbitrary snapshots using HTTP: +## Web interface and snapshots: - http://repo.or.cz/w/openocd.git +🔗 [http://repo.or.cz/w/openocd.git](https://repo.or.cz/w/openocd.git) -Snapshots are compressed tarballs of the source tree, about 1.3 MBytes -each at this writing. +Snapshots are compressed tarballs of the source tree (~1.3 MB).