Introduction
This chapter includes:
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:
The latest released version of ModusToolbox™ OpenOCD is available from the GitHub repository:
Supported OS
Windows 10 (x64), Windows 11 (x64)
Ubuntu 22.04 "Jammy Jellyfish", Ubuntu 24.04 "Noble Numbat", Ubuntu 25.04 "Plucky Puffin"
macOS 13 "Ventura", macOS 14 "Sonoma", macOS 15 "Sequoia" (Intel processors and Arm processors via Rosetta)
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 6M/4M MCU
FX3G2 and FX2G3
PAG2S
PSOC™ Control C3
PSOC™ Edge E84
Supported hardware (probes)
SEGGER J-Link
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
OpenOCD does not support J-link with the default J-Link USB driver in Windows. To use J-Link, update the driver as described in the article from
SEGGER Knowledge Base
of OpenOCD support.
This ModusToolbox™ version of OpenOCD was tested with the libusbK v3.1.0.0 driver for the J-Link probe.
Error codes
The OpenOCD tool returns '0' as the response code on successful completion; on a failure, it returns '1'.
1
Currently, OpenOCD does not provide a "built-in" Flash driver for the CYW4390x chip. All Flash-related operations are fully implemented in the TCL scripts. The behavior of the TCL-based driver is slightly different from the built-in one. Refer to the
CYW4390x commands
section for details.