Overview
The ModusToolbox™ OpenOCD command-line interface (CLI) is based on the Open On-Chip Debugger (OpenOCD) product. OpenOCD is a powerful tool whose interface interacts with the target device via the JTAG/SWD debug ports. OpenOCD allows programming internal and external flash memories of a wide range of target devices, CFI-compatible flashes, and some CPLD/FPGA devices.
This document covers the ModusToolbox™-specific CLI extensions of OpenOCD. See the official documentation at:
http://openocd.org/documentation/
The latest released version of ModusToolbox™ OpenOCD is available from the GitHub repository:
Supported OS
- Windows 11 (x64)
- Ubuntu 22.04 "Jammy Jellyfish", Ubuntu 24.04 "Noble Numbat", Ubuntu 25.04 "Plucky Puffin"
- macOS 14 "Sonoma", macOS 15 "Sequoia", and macOS 26 "Tahoe" (native Arm processors)
Supported devices
- AIROC™ CYW20809 Bluetooth® LE system on chip
- PSOC™ 6 and PSOC™ 64
- PSOC™ 4, PSOC™ 4 HVPA, PSOC™ 4 HVMS
- PMG1, CCGx
- AIROC™ CYW4390x 1
- XMC7xxx/ XMC5xxx
- TRAVEO™ T2G Body High
- TRAVEO™ T2G Body Entry
- TRAVEO™ T2G Cluster 4M/6M/6M DDR MCU
- TRAVEO™ Cluster Entry 4M MCU
- FX3G2 and FX2G3
- PAG2S
- PSOC™ Control C3
- PSOC™ Edge E84
Supported hardware (probes)
- SEGGER J-Link stand-alone programmer (via libusbK driver for pre-2022 year probes)
- SEGGER J-Link on-board programmer
- Infineon KitProg3 on-board programmer
- Infineon MiniProg4 standalone programmer
- FTDI-based adapter on CYW954907AEVAL1F / CYW943907AEVAL1F kits
Installation
The ModusToolbox™ OpenOCD CLI software is installed as part of either ModusToolbox™ Programming tools package. Refer to the ModusToolbox™ Programming tools release notes for details.
You can also download the latest version from the GitHub repository:
Enable J-Link for work with OpenOCD
On Windows, to use pre-2022 year J-Link, update the driver as described in the article from SEGGER Knowledge Base of OpenOCD support. This ModusToolboxTM version of OpenOCD was tested with the libusbK v3.1.0.0 driver for the J-Link probe.
For on-board programmers and post 2022 standalone probes, configure J-Link to use native WinUSB driver as described in J-Link WinUSB driver selection.
Error codes
The OpenOCD tool returns '0' as the response code on successful completion; on a failure, it returns '1'.