X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=README;h=e3b49a93a65f51b69d20bb79f7890ab9d8588748;hb=b747da266344ae9f17b5e27a38bbe51e28f00e7a;hp=07ccac1839149eaf3cb7c45c73db9d603f114f58;hpb=14fb875e8fedd56ca800adb5058a67b5152447e1;p=openocd.git diff --git a/README b/README index 07ccac1839..e3b49a93a6 100644 --- a/README +++ b/README @@ -51,10 +51,11 @@ The OpenOCD User's Guide can be produced in two different format: 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. @@ -63,6 +64,12 @@ 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 ----------------------- @@ -165,6 +172,29 @@ will build OpenOCD and place the final executable in ./src/. The 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 --------------------- @@ -252,11 +282,6 @@ The following additional options may also be useful: --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 @@ -286,6 +311,10 @@ 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 @@ -302,7 +331,7 @@ Then type ``make'', and perhaps ``make install''. 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 @@ -334,19 +363,6 @@ 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 ... - Linux Notes *********** @@ -360,6 +376,9 @@ the following: --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 --------------------------------- @@ -385,16 +404,9 @@ Tips For Building From The Subversion 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. - -