-----------------------
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
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
-------------
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:
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.
+the OpenOCD licensing terms.
Linux Notes
***********
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 Subversion
----------------------------------
+==========================
+Obtaining OpenOCD From GIT
+==========================
-You can download the current SVN version with an SVN client of your
-choice from the following repositories:
+You can download the current GIT version with a GIT client of your
+choice from the main repository:
- svn://svn.berlios.de/openocd/trunk
-or
- http://svn.berlios.de/svnroot/repos/openocd/trunk
+ git://openocd.git.sourceforge.net/gitroot/openocd/openocd
-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):
+You may prefer to use a mirror:
- svn checkout svn://svn.berlios.de/openocd/trunk openocd
+ http://repo.or.cz/r/openocd.git
+ git://repo.or.cz/openocd.git
-If you prefer GIT based tools, the git-svn package works too:
+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):
- git svn clone -s svn://svn.berlios.de/openocd
+ git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
-Tips For Building From The Subversion Repository
-************************************************
+Then you can update that at your convenience using
+
+ git pull
+
+There is also a gitweb interface, which you can use either to browse
+the repository or to downlad arbitrary snapshots using HTTP:
+
+ 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).
+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.
Code Review / openocd.git / blobdiff