6.8 KiB
title | TODO | summary | summary | upstream_version | upstream_commit | upstream_release_date | version | npm_subversion | download_url | comments | date | categories | tags | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
xPack OpenOCD v{{ XBB_RELEASE_VERSION }} released | select one summary | Version **{{ XBB_RELEASE_VERSION }}** is a maintenance release; it updates to the latest upstream master. | Version **{{ XBB_RELEASE_VERSION }}** is a new release; it follows the upstream release. | 0.12.0 | 9ea7f3d | 15 Jan 2022 | {{ XBB_RELEASE_VERSION }} | 1 | https://github.com/xpack-dev-tools/openocd-xpack/releases/tag/v{{ XBB_RELEASE_VERSION }}/ | true |
|
|
|
title: xPack OpenOCD v{{ XBB_RELEASE_VERSION }} released
TODO: select one summary
summary: "Version {{ XBB_RELEASE_VERSION }} is a maintenance release; it updates to the latest upstream master."
summary: "Version {{ XBB_RELEASE_VERSION }} is a new release; it follows the upstream release."
upstream_version: "0.12.0" upstream_commit: "9ea7f3d" upstream_release_date: "15 Jan 2022"
version: "{{ XBB_RELEASE_VERSION }}" npm_subversion: "1"
download_url: https://github.com/xpack-dev-tools/openocd-xpack/releases/tag/v{{ XBB_RELEASE_VERSION }}/
comments: true
date: {{ RELEASE_DATE }}
categories:
- releases
- openocd
tags:
- releases
- openocd
The xPack OpenOCD is a standalone cross-platform binary distribution of OpenOCD.
There are separate binaries for Windows (Intel 64-bit), macOS (Intel 64-bit, Apple Silicon 64-bit) and GNU/Linux (Intel 64-bit, Arm 32/64-bit).
{% raw %}{% include note.html content="The main targets for the Arm binaries are the Raspberry Pi class devices (armv7l and aarch64; armv6 is not supported)." %}{% endraw %}
Download
The binary files are available from GitHub [Releases]({% raw %}{{ page.download_url }}{% endraw %}).
Prerequisites
- GNU/Linux Intel 64-bit: any system with GLIBC 2.27 or higher (like Ubuntu 18 or later, Debian 10 or later, RedHat 8 later, Fedora 29 or later, etc)
- GNU/Linux Arm 32/64-bit: any system with GLIBC 2.27 or higher (like Raspberry Pi OS, Ubuntu 18 or later, Debian 10 or later, RedHat 8 later, Fedora 29 or later, etc)
- Intel Windows 64-bit: Windows 7 with the Universal C Runtime (UCRT), Windows 8, Windows 10
- Intel macOS 64-bit: 10.13 or later
- Apple Silicon macOS 64-bit: 11.6 or later
Install
The full details of installing the xPack OpenOCD on various platforms are presented in the separate [Install]({% raw %}{{ site.baseurl }}{% endraw %}/dev-tools/openocd/install/) page.
Easy install
The easiest way to install OpenOCD is with
[xpm
]({% raw %}{{ site.baseurl }}{% endraw %}/xpm/)
by using the binary xPack, available as
@xpack-dev-tools/openocd
from the npmjs.com
registry.
With the xpm
tool available, installing
the latest version of the package and adding it as
a development dependency for a project is quite easy:
cd my-project
xpm init # Add a package.json if not already present
xpm install @xpack-dev-tools/openocd@latest --verbose
ls -l xpacks/.bin
To install this specific version, use:
xpm install @xpack-dev-tools/openocd@{% raw %}{{ page.version }}.{{ page.npm_subversion }}{% endraw %} --verbose
For xPacks aware tools, like the Eclipse Embedded C/C++ plug-ins, it is also possible to install OpenOCD globally, in the user home folder.
xpm install --global @xpack-dev-tools/openocd@latest --verbose
Eclipse will automatically
identify binaries installed with
xpm
and provide a convenient method to manage paths.
Uninstall
To remove the links created by xpm in the current project:
cd my-project
xpm uninstall @xpack-dev-tools/openocd
To completely remove the package from the central xPack store:
xpm uninstall --global @xpack-dev-tools/openocd
Compliance
The xPack OpenOCD generally follows the official OpenOCD releases.
The current version is based on:
- OpenOCD version {% raw %}{{ page.upstream_version }}{% endraw %}, the development commit [{% raw %}{{ page.upstream_commit }}{% endraw %}](https://github.com/xpack-dev-tools/openocd/commit/{% raw %}{{ page.upstream_commit }}{% endraw %}/) from {% raw %}{{ page.upstream_release_date }}{% endraw %}.
Changes
There are no functional changes.
Compared to the upstream, the following changes were applied:
- the
src/openocd.c
file was edited to display the branding string - the
contrib/60-openocd.rules
file was simplified to avoid protection related issues.
Bug fixes
- none
Enhancements
- none
Known problems
- none
Shared libraries
On all platforms the packages are standalone, and expect only the standard runtime to be present on the host.
All dependencies that are build as shared libraries are copied locally
in the libexec
folder (or in the same folder as the executable for Windows).
DT_RPATH
and LD_LIBRARY_PATH
On GNU/Linux the binaries are adjusted to use a relative path:
$ readelf -d library.so | grep runpath
0x000000000000001d (RPATH) Library rpath: [$ORIGIN]
In the GNU ld.so search strategy, the DT_RPATH
has
the highest priority, higher than LD_LIBRARY_PATH
, so if this later one
is set in the environment, it should not interfere with the xPack binaries.
Please note that previous versions, up to mid-2020, used DT_RUNPATH
, which
has a priority lower than LD_LIBRARY_PATH
, and does not tolerate setting
it in the environment.
@rpath
and @loader_path
Similarly, on macOS, the binaries are adjusted with install_name_tool
to use a
relative path.
Documentation
The original documentation is available online:
Build
The binaries for all supported platforms (Windows, macOS and GNU/Linux) were built using the xPack Build Box (XBB), a set of build environments based on slightly older distributions, that should be compatible with most recent systems.
The scripts used to build this distribution are in:
distro-info/scripts
For the prerequisites and more details on the build procedure, please see the How to build page.
CI tests
Before publishing, a set of simple tests were performed on an exhaustive set of platforms. The results are available from:
Tests
The binaries were testes on Windows 10 Pro 32/64-bit, Intel Ubuntu 18 LTS 64-bit, Intel Xubuntu 18 LTS 32-bit and macOS 10.15.
Install the package with xpm.
The simple test, consists in starting the binaries only to identify the STM32F4DISCOVERY board.
.../xpack-openocd-{{ XBB_RELEASE_VERSION }}/bin/openocd -f board/stm32f4discovery.cfg
A more complex test consist in programming and debugging a simple blinky application on the STM32F4DISCOVERY board. The binaries were those generated by simple Eclipse projects available in the xPack GNU Arm Embedded GCC project.
Checksums
The SHA-256 hashes for the files are: