Template:CompileOpenOCDWinGit

This guide will compile OpenOCD on  with the  driver library, for use with the TinCanTools Flyswatter, Flyswatter2, and Flyswatter3. The executable created with this guide is compatible with Windows XP and Windows 7. The process is identical on 32 and 64 bit versions of Windows.

This guide makes use of the GCC cross-compiler added to Cygwin on June 2, 2011. The cross-compiler makes compiling OpenOCD for Windows much easier. Older instructions can be found at Compiling OpenOCD for  - Pre June 2011.

Version is the version of OpenOCD currently in development. For instructions on compiling with the most recent release code, see Compiling OpenOCD WinXP or Compiling OpenOCD Win7.

OpenOCD 0.6.0 vs the 0.5.0 Release
This guide uses the most recent version of the OpenOCD source currently in development. Unlike the 0.5.0 release the development version includes support for the Flyswatter2 and Flyswatter3, so you won't need to download or apply a patch before compiling. However, the development code is subject to change at any time. If you encounter problems with this option, try the OpenOCD 0.5.0 instructions in Compiling OpenOCD WinXP or Compiling OpenOCD Win7 instead.

Installing Cygwin
Download and install Cygwin from http://www.cygwin.com. Cygwin provides a GNU development environment for Windows, which will allow you to compile OpenOCD using the GNU Compiler Collection (GCC). You will not need Cygwin to run OpenOCD. The Cygwin installer is available at http://cygwin.com/install.html.

If you already have Cygwin installed, this guide recommends that you delete it and reinstall completely. Close all Cygwin windows and services and delete your Cygwin directory (by default, C:\cygwin). Then find any packages downloaded but not installed and delete them as well. You set the location of these files when you installed Cygwin. By default they appear in My Documents/Downloads. If you don't wish to reinstall Cygwin you can find more information at http://cygwin.com/ml/cygwin/2011-06/msg00021.html.

In the Cygwin installer you will be prompted to select additional packages to install. Install the following optional packages, found under the Devel heading:


 * autoconf (all packages)
 * automake (all packages)
 * binutils
 * gcc
 * gcc-core
 * gcc-g++
 * git
 * libtool
 * libusb-1.0
 * libusb-win32
 * libusb-devel
 * make
 * mingw-binutils
 * mingw-gcc
 * mingw-gcc-core
 * mingw-gcc-g++
 * mingw-pthreads
 * mingw-runtime
 * patch (found under the Utils heading)

Check all of these packages and click Next. Cygwin will inform you that it must install additional packages to satisfy the above packages' dependencies. Allow it to do so. Make sure that the Select Required Packages checkbox is checked before you proceed.

Installing libusb for the Flyswatter
Libusb is a usb driver library you will need to communicate with the Flyswatter. You will need a newer version of libusb than the one distributed through the Cygwin installer, and you will need libusb for Windows as well. Download libusb-win32- from. Open the zip archive and extract the contents to C:\cygwin\home.

Navigate to the folder \libusb-win32-bin-\lib\gcc. Copy the file libusb.a to C:\cygwin\lib and C:\cygwin\usr\i686-pc-mingw32\sys-root\mingw\lib.

Navigate to \libusb-win32-bin-\include. Copy the file usb.h to C:\cygwin\usr\include and C:\cygwin\usr\i686-pc-mingw32\sys-root\mingw\include.

Downloading OpenOCD
Git is version control software available as a Cygwin package. You already installed this software above. You can use git to download the current development code from the OpenOCD git repository at sourceforge.net. In the Cygwin console window, navigate to your home directory and make sure you don't already have a directory there named openocd/. (Downloading with git will create a directory called openocd/ containing the OpenOCD source. If you already have a directory called openocd/ either rename it or navigate to a different directory before you proceed.) Then download OpenOCD with the following command:

cd ~ git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd

There should now be a folder in your home directory called openocd/.

Compiling OpenOCD
In the terminal window, navigate to the new folder containing the OpenOCD source and compile as follows.

cd /home/openocd ./bootstrap

make make install

Navigate to /home/openocd/src to find the openocd binary. You can run the binary from the Windows command line interface without using Cygwin.

Preparing to Run OpenOCD
Navigate to C:\cygwin\home\openocd\src to find openocd.exe. The executable can be run from the Windows command line and does not require Cygwin.

You can run openocd from C:\cygwin\home\openocd\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 folder containing OpenOCD and its config files. Go to Start Menu > My Computer and open your C: drive. Right-click anywhere in the C: drive window and select New > Folder. Rename the new folder openocd-bin.

In another Windows Explorer window, open C:\cygwin\home\openocd\tcl. Click and drag to select all the contents of the folder. Right-click on any file and select Copy. Open C:\openocd-bin, right-click anywhere, and select Paste.

Now go to C:\cygwin\home\openocd\src and copy openocd.exe to C:\openocd-bin. The folder should now contain the following files and folders:

board chip cpld cpu openocd.exe interface target test bitsbytes.tcl memory.tcl mmr_helpers.tcl readable.tcl

You can now run OpenOCD from C:\openocd-bin. To get started running OpenOCD, see Running OpenOCD on Windows.