viewed on-line at the following URLs:
OpenOCD User's Guide:
- http://openocd.berlios.de/doc/html/index.html
+ http://openocd.sourceforge.net/doc/html/index.html
OpenOCD Developer's Manual:
- http://openocd.berlios.de/doc/doxygen/index.html
+ http://openocd.sourceforge.net/doc/doxygen/html/index.html
These reflect the latest development versions, so the following section
introduces how to build the complete documentation from the package.
For more information, refer to these documents or contact the developers
by subscribing to the OpenOCD developer mailing list:
- openocd-development@lists.berlios.de
+ openocd-devel@lists.sourceforge.net
Building the OpenOCD 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
+On Linux, you may have permissions problems to address. The best way
+to do this is to use the contrib/openocd.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.
-----------------------
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.
--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
+ --enable-parport Enable building the pc parallel port driver
+ --disable-parport-ppdev Disable use of ppdev (/dev/parportN) for parport
+ (for x86 only)
+ --enable-parport-giveio Enable use of giveio for parport (for CygWin only)
+
+
--enable-ft2232_libftdi Enable building support for FT2232 based devices
using the libftdi driver, opensource alternate of
FTD2XX
--enable-ft2232_ftd2xx Enable building support for FT2232 based devices
using the FTD2XX driver from ftdichip.com
+ --enable-usb_blaster_libftdi
+ Enable building support for the Altera USB-Blaster
+ using the libftdi driver, opensource alternate of
+ FTD2XX
+ --enable-usb_blaster_ftd2xx
+ Enable building support for the Altera USB-Blaster
+ using the FTD2XX driver from ftdichip.com
+
+ --enable-amtjtagaccel Enable building the Amontec JTAG-Accelerator driver
+
+ --enable-zy1000-master Use ZY1000 JTAG master registers
+ --enable-zy1000 Enable ZY1000 interface
+
+ --enable-ioutil Enable ioutil functions - useful for standalone
+ OpenOCD implementations
+
+ --enable-ep93xx Enable building support for EP93xx based SBCs
+
+ --enable-at91rm9200 Enable building support for AT91RM9200 based SBCs
+
--enable-gw16012 Enable building support for the Gateworks GW16012
JTAG Programmer
- --enable-parport Enable building the pc parallel port driver
- --disable-parport-ppdev Disable use of ppdev (/dev/parportN) for parport
- (for x86 only)
- --enable-parport-giveio Enable use of giveio for parport (for CygWin only)
-
--enable-presto_libftdi Enable building support for ASIX Presto Programmer
using the libftdi driver
--enable-presto_ftd2xx Enable building support for ASIX Presto Programmer
using the FTD2XX driver
- --enable-amtjtagaccel Enable building the Amontec JTAG-Accelerator driver
- --enable-arm-jtag-ew Enable building support for the Olimex ARM-JTAG-EW
+ --enable-usbprog Enable building support for the usbprog JTAG
Programmer
+
+ --enable-oocd_trace Enable building support for some prototype
+ OpenOCD+trace ETM capture hardware
+
--enable-jlink Enable building support for the Segger J-Link JTAG
Programmer
+
+ --enable-vsllink Enable building support for the Versaloon-Link JTAG
+ Programmer
+
--enable-rlink Enable building support for the Raisonance RLink
JTAG Programmer
- --enable-usbprog Enable building support for the usbprog JTAG
+ --enable-ulink Enable building support for the Keil ULINK JTAG
Programmer
- --enable-vsllink Enable building support for the Versaloon-Link JTAG
+ --enable-arm-jtag-ew Enable building support for the Olimex ARM-JTAG-EW
Programmer
- --enable-oocd_trace Enable building support for the OpenOCD+trace ETM
- capture device
+ --enable-buspirate Enable building support for the Buspirate
- --enable-ep93xx Enable building support for EP93xx based SBCs
- --enable-at91rm9200 Enable building support for AT91RM9200 based SBCs
+ --enable-stlink Enable building support for the ST-Link JTAG
+ Programmer
- --enable-ecosboard Enable building support for eCos based JTAG debugger
- --enable-zy1000 Enable ZY1000 interface
+ --enable-osbdm Enable building support for the OSBDM (JTAG only)
+ Programmer
+
+ --enable-opendous Enable building support for the estick/opendous JTAG
+ Programmer
--enable-minidriver-dummy
Enable the dummy minidriver.
- --enable-ioutil Enable ioutil functions - useful for standalone
- OpenOCD implementations
- --enable-httpd Enable builtin httpd server - useful for standalone
- OpenOCD implementations
+ --disable-internal-jimtcl
+ Disable building internal jimtcl
+ --enable-libusb0 Use libusb-0.1 library for USB JTAG devices
+ --enable-remote-bitbang Enable building support for the Remote Bitbang jtag
+ driver
+
+ --disable-doxygen-html Disable building Doxygen manual as HTML.
+ --enable-doxygen-pdf Enable building Doxygen manual as PDF.
Miscellaneous Configure Options
-------------------------------
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
+speed (480 Mbps), use libftdi version 0.17 or newer. Many Linux
distributions provide suitable packages for these libraries.
For Windows, libftdi is supported with versions 0.14 and later.
copies for personal use.
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
+TAR.GZ file. You must unpack them ``some where'' convenient. As of this
writing FTDICHIP does not supply means to install these files "in an
appropriate place."
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 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:
+
+ http://repo.or.cz/r/openocd.git
+ git://repo.or.cz/openocd.git
+
+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 clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
-You can download the current SVN version with an SVN client of your
-choice from the following repositories:
+Then you can update that at your convenience using
- svn://svn.berlios.de/openocd/trunk
-or
- http://svn.berlios.de/svnroot/repos/openocd/trunk
+ git pull
-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):
+There is also a gitweb interface, which you can use either to browse
+the repository or to download arbitrary snapshots using HTTP:
- svn checkout svn://svn.berlios.de/openocd/trunk openocd
+ http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd
+ http://repo.or.cz/w/openocd.git
-If you prefer GIT based tools, the git-svn package works too:
+Snapshots are compressed tarballs of the source tree, about 1.3 MBytes
+each at this writing.
- git svn clone -s svn://svn.berlios.de/openocd
-Tips For Building From The Subversion Repository
-************************************************
+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).
Code Review / openocd.git / blobdiff