Skip to content

Latest commit

 

History

History
142 lines (98 loc) · 5.7 KB

README.md

File metadata and controls

142 lines (98 loc) · 5.7 KB
Raw

npm (scoped) npm

The xPack OpenOCD

Note: If you are looking for how to build Nuclei OpenOCD, please check README-BUILD-Nuclei.md

This open source project is hosted on GitHub as xpack-dev-tools/openocd-xpack and provides the platform specific binaries for the xPack OpenOCD.

This distribution follows the official OpenOCD.

The binaries can be installed automatically as binary xPacks or manually as portable archives.

In addition to the package meta data, this project also includes the build scripts.

User info

This section is intended as a shortcut for those who plan to use the OpenOCD binaries. For full details please read the xPack OpenOCD pages.

Easy install

The easiest way to install OpenOCD is using the binary xPack, available as @xpack-dev-tools/openocd from the npmjs.com registry.

Prerequisites

The only requirement is a recent xpm, which is a portable Node.js command line application. To install it, follow the instructions from the xpm page.

Install

With the xpm tool available, installing the latest version of the package is quite easy:

$ xpm install --global @xpack-dev-tools/openocd@latest

This command will always install the latest available version, into the central xPacks repository, which is a platform dependent folder (check the output of the xpm command or the actual folder used on your platform).

This location is configurable using the environment variable XPACKS_REPO_FOLDER; for more details please check the xpm folders page.

xPacks aware tools, like the GNU MCU Eclipse plug-ins automatically identify binaries installed with xpm and provide a convenient method to manage paths.

Uninstall

To remove the installed xPack, the command is similar:

$ xpm uninstall --global @xpack-dev-tools/openocd

(Note: not yet implemented. As a temporary workaround, simply remove the xPacks/@xpack-dev-tools/openocd folder, or one of the the versioned subfolders.)

Manual install

For all platforms, the xPack OpenOCD binaries are released as portable archives that can be installed in any location.

The archives can be downloaded from the GitHub Releases page.

For more details please read the Install page.

Windows drivers

Most JTAG probes require separate drivers on Windows. For more details please read the Install page.

GNU/Linux UDEV subsystem

For the JTAG probes implemented as USB devices (actually most of them), the last installation step on GNU/Linux is to configure the UDEV subsystem.

For more details please read the Install page.

Maintainer info

Support

The quick answer is to use the xPack forums; please select the correct forum.

For more details please read the Support page.

License

The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.

The binary distributions include several open-source components; the corresponding licenses are available in the installed distro-info/licenses folder.

Download analytics

Credit to Shields IO and Somsubhra/github-release-stats.