The OpenOCD Developer Manual contains information about the internal
architecture and other details about the code:
+ # NB! make sure doxygen is installed, type doxygen --version
make doxygen
# If HTMLVIEWER is set, this views the HTML Doxygen output.
- ${HTMLVIEWER} doxyegen/index.html
+ ${HTMLVIEWER} doxygen/index.html
The remaining sections describe how to configure the system such that
you can build the in-tree documentation.
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
-----------------------
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,
final (optional) step, ``make install'', places all of the files in the
required location.
+Cross-Compiling Options
+-----------------------
+
+To cross-compile, you must specify both --build and --host options to
+the 'configure' script. For example, you can configure OpenOCD to
+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 ...
+
+Likewise, the following options allow OpenOCD to be cross-compiled for
+an ARM target on the same x86 host:
+
+ ./configure --build=i686-pc-linux-gnu --host=arm-elf ...
+
+Both must be specified to work around bugs in autoconf.
+
+Scripts for producing ARM cross-compilers can be found on the web with a
+little searching. A script to produce an x86 Linux-hosted MinGW32
+cross-compiler can be downloaded from the following URL:
+
+ http://www.mingw.org/wiki/LinuxCrossMinGW
+
Configuration Options
---------------------
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
--disable-wextra Disable extra compiler warnings
--disable-werror Do not treat warnings as errors
- --enable-release Enable building of an OpenOCD release. This
- option is intended for project maintainers.
- It simply omits the svn version string when
- the openocd -v is executed (to KISS).
-
--disable-option-checking
Ignore unrecognized --enable and --with options.
--disable-dependency-tracking speeds up one-time build
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 ...
+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
---------------------------------
************************************************
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.
-
-
Code Review / openocd.git / blobdiff