This guide will compile OpenOCD 0.4.0 for Ubuntu 10.04 with the LibFTDI driver library, for use with the TinCanTools Flyswatter. This is the most recent release version of OpenOCD. It does not include support for the Flyswatter2 or Flyswatter3, but this guide includes instructions on adding Flyswatter2/Flyswatter3 support with a patch. OpenOCD 0.6.0 (currently in development) does include support for the Flyswatter2 and Flyswatter3, but is subject to change at any time and may be more difficult to compile. If you would prefer to use the most recent version of the source currently in development rather than the 0.5.0 release, see Compiling OpenOCD v06 Linux.
You will need to install several packages to compile and run OpenOCD. Open a terminal window (Applications menu > Accessories > Terminal) and type:
sudo apt-get install libtool autoconf texinfo libusb-dev
If you prefer to compile libusb yourself, you can find the source at http://sourceforge.net/projects/libusb/files/libusb-1.0/.
Downloading and Compiling libFTDI
libFTDI is an open source library that enables you to talk to FTDI chips like: FT232BM, FT245BM, FT245R, FT2232C, FT2232D and FT2232H. You will need libFTDI to compile OpenOCD. Download libftdi-0.19.tar.gz from:
and extract it to your home directory (/home/USERNAME, replacing USERNAME with your username).
Navigate to home/USERNAME/libftdi-0.19/src, and copy ftdi.h to your /usr/include directory. Then create a symbolic link to ftdi.h in /usr/local/include. In the terminal window:
cd ~/libftdi-0.19/src sudo cp ftdi.h /usr/include cd /usr/local/include sudo ln -s /usr/include/ftdi.h ftdi.h
Return to your libftdi-0.19 directory and compile.
cd ~/libftdi-0.19 ./configure make sudo make install
This will install the necessary library files to /usr/local/lib. Navigate to /usr/lib and create symbolic links to the new files.
cd /usr/lib sudo ln -s /usr/local/lib/libftdi.a libftdi.a sudo ln -s /usr/local/lib/libftdi.la libftdi.la sudo ln -s /usr/local/lib/libftdi.so.1.19.0 libftdi.so.1.19.0 sudo ln -s /usr/local/lib/libftdi.so.1.19.0 libftdi.so sudo ln -s /usr/local/lib/libftdi.so.1.19.0 libftdi.so.1
Download the OpenOCD 0.4.0 source from http://prdownload.berlios.de/openocd/openocd-0.4.0.tar.gz and extract it to /home/USERNAME/openocd-0.4.0.
Installing the Flyswatter 2 / Flyswatter 3 Patch (Optional)
The OpenOCD Flyswatter 3 beta patch provides support for the Flyswatter3 and Flyswatter2, a config file for the Olimex PIC-P32MX development board, and an updated config file for the TinCanTools Hammer. Download the file Media:Openocd-fs3-b0.1.patch. (Right click the link and select Save As.) Save the file to your new openocd-0.4.0 directory.
In the terminal window, navigate to the patch file and patch the source as follows:
cd ~/openocd-0.4.0 patch -p1 -i Openocd-fs3-b0.1.patch
For more information on the config files added by this patch, see OpenOCD Config Files.
In the terminal window, navigate to the new folder containing the OpenOCD source and compile as follows.
cd ~/openocd-0.4.0 sudo ./configure --disable-werror --enable-ft2232_libftdi sudo make sudo make install
Navigate to /home/USERNAME/openocd-0.5.0/src to find the openocd binary. You will need superuser privileges (the sudo command) to run OpenOCD.
Preparing to Run OpenOCD
You can run openocd from /home/USERNAME/openocd-0.4.0/src, but you may encounter problems with configuration files. For a more in-depth discussion of these issues, see OpenOCD Config File Paths. This guide recommends that you create a new directory containing OpenOCD and its config files.
Create a new directory in /home/USERNAME called openocd-bin, and copy the openocd binary and the contents of /home/USERNAME/openocd/tcl to the new directory. You can do this from the terminal window with the collowing commands:
cd ~ mkdir openocd-bin cd ~/openocd/tcl cp -r * ~/openocd-bin cd ~/openocd/src cp openocd ~/openocd-bin
openocd-bin should now contain the following files and subdirectories:
board chip cpld cpu openocd interface target test bitsbytes.tcl mem_helper.tcl memory.tcl mmr_helpers.tcl