Difference between revisions of "OpenOCD Ubuntu Package"

Revision as of 04:03, 9 April 2022

As an alternative to compiling OpenOCD from source, OpenOCD is available via Ubuntu's Advanced Packaging Tool (APT). Ubuntu users can download and install OpenOCD using the apt-get command.

Installing the OpenOCD Package

Open a terminal window (Applications menu > Accessories > Terminal) and type:

sudo apt-get update
sudo apt-get install openocd

The Ubuntu APT will install OpenOCD and its config files to your computer. As with any command using sudo, you will need an administrator password to run this command.

Linking to /usr/share/openocd

The package installs config files to /usr/share/openocd/scripts, but OpenOCD looks for config files in /usr/local/share/openocd/scripts. Fix that now by creating a symbolic link in /usr/local/share to /usr/share/openocd. In the terminal window, type:

cd /usr/local/share
sudo ln -s /usr/share/openocd .

OpenOCD will now be able to find its config files. For more information on how OpenOCD searches for config files, see OpenOCD Config File Paths.

Running OpenOCD

You can run OpenOCD from a terminal window from any directory. Installing OpenOCD from the APT allows users to run OpenOCD without sudo. (If you compiled OpenOCD yourself you would need to take special steps to allow users to use OpenOCD without sudo).

In a terminal window, type:

openocd -f path_to/file.cfg [-f another_path_to/file2.cfg]

For example, to run OpenOCD for the hitex str9 comstic board, type:

openocd -f interface/hitex_str9-comstick.cfg -f target/str912.cfg

To get started, see Running OpenOCD on Linux. If you encounter errors, see OpenOCD Troubleshooting.