Installing OpenOCD
==================
+On Linux, you may have permissions problems to address. The best
+way to do this is to use the contrib/udev.rules file. It probably
+belongs somewhere in /etc/udev/rules.d, but consult your operating
+system documentation to be sure. In particular, make sure that it
+matches the syntax used by your operating system's version of udev.
+
A Note to OpenOCD Users
-----------------------
If you would rather be working "with" OpenOCD rather than "on" it, your
-operating system or interface supplier may provide binaries for you in a
-convenient package.
+operating system or JTAG interface supplier may provide binaries for
+you in a convenient-enough package.
-Such packages should be more stable than SVN trunk, where bleeding-edge
+Such packages may be more stable than git mainline, where bleeding-edge
development takes place. These "Packagers" produce binary releases of
-OpenOCD after the developers produces new "stable" versions of the
-source code. Previous versions of OpenOCD cannot be used to diagnosed
+OpenOCD after the developers produces new "release" versions of the
+source code. Previous versions of OpenOCD cannot be used to diagnose
problems with the current release, so users are encouraged to keep in
contact with their distribution package maintainers or interface vendors
to ensure suitable upgrades appear regularly.
The INSTALL file contains generic instructions for running 'configure'
and compiling the OpenOCD source code. That file is provided by default
for all GNU automake packages. If you are not familiar with the GNU
-autotools, then you should read those instructions first.
+autotools, then you should read those instructions first.
The remainder of this document tries to provide some instructions for
those looking for a quick-install.
of commands:
./configure [with some options listed in the next section]
- make
+ make
make install
The 'configure' step generates the Makefiles required to build OpenOCD,
cross-compile on a x86 Linux host to run on Windows (MinGW32), you could
use the following configuration options:
- ./configure --build=i686-pc-linux-gnu --host=i586-mingw32msvc ...
+ ./configure --build=i686-pc-linux-gnu --host=i586-mingw32msvc ...
Likewise, the following options allow OpenOCD to be cross-compiled for
an ARM target on the same x86 host:
--enable-maintainer-mode enable make rules and dependencies not useful
(and sometimes confusing) to the casual installer
- NOTE: This option is *required* for SVN builds!
+ NOTE: This option is *required* for GIT builds!
It should *not* be used to build a release.
--enable-dummy Enable building the dummy JTAG port driver
FTD2XX
--enable-ft2232_ftd2xx Enable building support for FT2232 based devices
using the FTD2XX driver from ftdichip.com
- --enable-ftd2xx-highspeed
- Enable building support for FT2232H and
- FT4232H-based devices (requires >=libftd2xx-0.4.16)
--enable-gw16012 Enable building support for the Gateworks GW16012
JTAG Programmer
--enable-httpd Enable builtin httpd server - useful for standalone
OpenOCD implementations
+ --disable-doxygen-html Disable building Doxygen manual as HTML.
+ --enable-doxygen-pdf Enable building Doxygen manual as PDF.
+
Miscellaneous Configure Options
-------------------------------
option if you want to use giveio instead of ioperm parallel port access
method.
-FT2232C Based USB Dongles
+FT2232C Based USB Dongles
-------------------------
There are 2 methods of using the FTD2232, either (1) using the
FTDICHIP.COM closed source driver, or (2) the open (and free) driver
-libftdi.
+libftdi.
Using LIBFTDI
-------------
+The libftdi source code can be download from the following website:
+
+ http://www.intra2net.com/en/developer/libftdi/download.php
+
For both Linux and Windows, both libusb and libftdi must be built and
installed. To use the newer FT2232H chips, supporting RTCK and USB high
speed (480 Mbps), you need libftdi version 0.16 or newer. Many Linux
distributions provide suitable packages for these libraries.
-For Windows, libftdi is supported with versions 0.14 and later.
+For Windows, libftdi is supported with versions 0.14 and later.
With these prerequisites met, configure the libftdi solution like this:
Using FTDI's FTD2XX
-------------------
-Some claim the (closed) FTDICHIP.COM solution is faster, which
+The (closed source) FTDICHIP.COM solution is faster on MS-Windows. That
is the motivation for supporting it even though its licensing restricts
it to non-redistributable OpenOCD binaries, and it is not available for
all operating systems used with OpenOCD. You may, however, build such
The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
TAR.GZ file. You must unpack them ``some where'' convient. As of this
writing FTDICHIP does not supply means to install these files "in an
-appropriate place."
+appropriate place."
If your distribution does not package these, there are several
'./configure' options to solve this problem:
Remember, this library is binary-only, while OpenOCD is licenced
according to GNU GPLv2 without any exceptions. That means that
_distributing_ copies of OpenOCD built with the FTDI code would violate
-the OpenOCD licensing terms.
-
-
-Cygwin/Win32 Notes
-******************
-
-The Cygwin/Win32 ZIP file contains a directory named ftd2xx.win32.
-Assuming that you have extracted this archive in the same directory as
-the OpenOCD package, you could configure with options like the following:
-
- ./configure \
- --enable-ft2232_ftd2xx \
- --with-ftd2xx-win32-zipdir=../ftd2xx.win32 \
- ... other options ...
+the OpenOCD licensing terms.
Linux Notes
***********
--with-ft2xx-linux-tardir=../libftd2xx0.4.16 \
... other options ...
-=================================
-Obtaining OpenOCD From Subversion
----------------------------------
+Note that on Linux there is no good reason to use these FTDI binaries;
+they are no faster (on Linux) than libftdi, and cause licensing issues.
+
+==========================
+Obtaining OpenOCD From GIT
+==========================
+
+You can download the current GIT version with a GIT client of your
+choice from the main repository:
+
+ git://openocd.git.sourceforge.net/gitroot/openocd/openocd
+
+You may prefer to use a mirror:
-You can download the current SVN version with an SVN client of your
-choice from the following repositories:
+ http://repo.or.cz/r/openocd.git
+ git://repo.or.cz/openocd.git
- svn://svn.berlios.de/openocd/trunk
-or
- http://svn.berlios.de/svnroot/repos/openocd/trunk
+Using the GIT command line client, you might use the following command
+to set up a local copy of the current repository (make sure there is no
+directory called "openocd" in the current directory):
-Using the SVN command line client, you can use the following command to
-fetch the latest version (make sure there is no (non-svn) directory
-called "openocd" in the current directory):
+ git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
- svn checkout svn://svn.berlios.de/openocd/trunk openocd
+Then you can update that at your convenience using
-If you prefer GIT based tools, the git-svn package works too:
+ git pull
- git svn clone -s svn://svn.berlios.de/openocd
+There is also a gitweb interface, which you can use either to browse
+the repository or to downlad arbitrary snapshots using HTTP:
-Tips For Building From The Subversion Repository
-************************************************
+ http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd
+ http://repo.or.cz/w/openocd.git
+
+Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
+each at this writing.
+
+
+Tips For Building From a GIT Repository
+---------------------------------------
Building OpenOCD from a repository requires a recent version of the GNU
-autotools (autoconf >= 2.59 and automake >= 1.9). For building on
-Windows, you have to use Cygwin. Make sure that your PATH
-environment variable contains no other locations with Unix utils (like
-UnxUtils) - these can't handle the Cygwin paths, resulting in obscure
-dependency errors. This was an observation gathered from the logs of
-one user; please correct us if this is wrong.
+autotools (autoconf >= 2.59 and automake >= 1.9).
1) Run './bootstrap' to create the 'configure' script and prepare
the build process for your host system.
2) Run './configure --enable-maintainer-mode' with other options.
-
-The following URL is a good reference if you want to build OpenOCD
-under cygwin.
-http://forum.sparkfun.com/viewtopic.php?t=11221
-
-Alternatively you can build the Windows binary under Linux using
-MinGW cross compiler. The following documents some tips of
-using this cross build option.
-
-a) libusb-win32
-You can choose to use the libusb-win32 binary distribution from
-its Sourceforge page. As of this writing, the latest version
-is 0.1.12.2. This is the recommend version to use since it fixed
-an issue with USB composite device and this is important for FTDI
-based JTAG debuggers.
-http://sourceforge.net/projects/libusb-win32/
-
-You need to download the libusb-win32-device-bin-0.1.12.2.tar.gz
-package. Please extract this file into a temp directory.
-
-Copy the file libusb-win32-device-bin-0.1.12.2\include\usb.h
-to your MinGW include directory.
-
-Copy the library libusb-win32-device-bin-0.1.12.2\lib\gcc\libusb.a
-to your MinGW library directory.
-
-Take note that different Linux distros often have different
-MinGW installation directory. Some of them also put the
-library and include into a seperate sys-root directory.
-
-If there is a new svn version of libusb-win32, you can build it
-as well.
-
-This is the instrunction from the libusb-win32 Makefile.
-# If you're cross-compiling and your mingw32 tools are called
-# i586-mingw32msvc-gcc and so on, then you can compile libusb-win32
-# by running
-# make host_prefix=i586-mingw32msvc all
-
-b) libftdi
-libftdi source codes can be download from the following website.
-http://www.intra2net.com/en/developer/libftdi/download.php
-
-It does not provide Windows binary. You can build it from the
-source tarball or the git tree.
-
-If you are using the git tree, the following is the instruction
-from README.mingw. You need to have cmake installed.
-- Edit Toolchain-mingw32.cmake to point to the correct MinGW
-installation.
-- Create a build directory like "mkdir build-win32", e.g in ../libftdi/
-- cd in that directory and run
- "cmake -DCMAKE_TOOLCHAIN_FILE=../Toolchain-mingw32.cmake .."
-- Copy src/ftdi.h to your MinGW include directory.
-- Copy build-win32/src/*.a to your MinGW lib directory.
-
-c) OpenOCD
-Now you can build OpenOCD under Linux using MinGW.
-You need to use --host=your_mingW_prefix in the configure option.
-
-Example for libftdi (in one line, tested under Ubuntu 9.04):
-./configure --host=i586-mingw32msvc --enable-maintainer-mode
---disable-shared --enable-ft2232_libftdi
-
-Example for ftd2xx (in one line, tested under Ubuntu 9.04)
-./configure --host=i586-mingw32msvc --enable-maintainer-mode
---disable-shared --enable-ft2232_ftd2xx
---with-ftd2xx-win32-zipdir=/home/mcuee/Desktop/build/openocd/libftd2xx-win32
Code Review / openocd.git / blobdiff