Quicklinks
If you already know the general facts about the xPack OpenOCD, you can directly skip to the desired pages.
User pages:
Developer & maintainer pages:
- GitHub - the project repo
- README-DEVELOPER - for information on how to build the binaries
- README-MAINTAINER - for information on the workflow used to make releases
Overview
The xPack OpenOCD is a cross-platform binary distribution of OpenOCD, the Open On-Chip Debugger, an open source project hosted on SourceForge.
The OpenOCD project maintainers recommend that end-users compile it using the latest version of the source code available from the repository. OpenOCD is a rolling distribution, and currently there are no special stable branches or tags and there are no clear release dates for future versions.
If for GNU/Linux users compiling projects is common, Windows users do not have an easy way of building OpenCOD from sources, and elaborate build environments must be installed, making the whole process impractical.
If you are not interested in building from sources, and appreciate a better integration with the environments like Eclipse, please feel free to use the xPack OpenOCD binaries, and preferably install them in the default locations.
Benefits
The main advantages of using the xPack OpenOCD are:
- a convenient, uniform and portable install/uninstall/upgrade procedure, the same procedure is used for all major platforms (Intel Windows 64-bit, Intel GNU/Linux 64-bit, Arm GNU/Linux 64/32-bit, Intel macOS 64-bit, Apple Silicon macOS 64-bit)
- a better integration with development environments like Eclipse Embedded CDT.
All binaries are self-contained, they include all required libraries, and can be installed in any location.
Compatibility
The xPack OpenOCD is fully compatible with the original OpenOCD distribution.
Install
The details of installing the xPack OpenOCD on various platforms are presented in the separate install page.
Documentation
The original OpenOCD documentation is available online:
Support
For the various support options, please read the separate support page.
Change log
The release and change log is available in the repository
CHANGELOG.md
file.
Build details
For those interested in building the binaries, please read the
README-DEVELOPER
page.
However, the ultimate source for details are the build scripts themselves,
all available from the
openocd-xpack.git/scripts
folder.
Releases
See the releases pages.