Improve and restructure libftd2xx and libftdi build documentation
Improve and restructure libftd2xx and libftdi build documentation. Signed-off-by: Dirk Behme <[email protected]> --- doc/openocd.texi | 90 ++++++++++++++++++++++++++++++++++++++++++------------- 1 files changed, 70 insertions(+), 20 deletions(-) Index: trunk/doc/openocd.texi =================================================================== --- trunk.orig/doc/openocd.texi +++ trunk/doc/openocd.texi @@ -242,15 +242,17 @@ should be included: @item @option{--enable-amtjtagaccel} - Parallel Port [Amontec, see below] @item -...@option{--enable-ft2232_ftd2xx} - Numerous USB Type ARM JTAG dongles use the FT2232C chip from this FTDICHIP.COM chip (closed source). +...@option{--enable-ft2232_libftdi} - Use open source (free) driver alternate to FTDICHIP.COM's ftd2xx (closed source) solution (Linux, MacOS, Cygwin) @item -...@option{--enable-ft2232_libftdi} - An open source (free) alternate to FTDICHIP.COM ftd2xx solution (Linux, MacOS, Cygwin) +...@option{--enable-ft2232_ftd2xx} - Use FTDICHIP.COM's (closed source) driver for FT2232C chip based USB type ARM JTAG dongles. If using this, there a several sub-options for additional configuration: +...@itemize @bullet @item @option{--with-ftd2xx-win32-zipdir=PATH} - If using FTDICHIP.COM ft2232c, point at the directory where the Win32 FTDICHIP.COM 'CDM' driver zip file was unpacked. @item @option{--with-ftd2xx-linux-tardir=PATH} - Linux only equal of @option{--with-ftd2xx-win32-zipdir}, where you unpacked the TAR.GZ file. @item @option{--with-ftd2xx-lib=shared|static} - Linux only. Default: static, specifies how the FTDICHIP.COM libftd2xx driver should be linked. Note 'static' only works in conjunction with @option{--with-ftd2xx-linux-tardir}. Shared is supported (12/26/2008), however you must manually install the required header files and shared libraries in an appropriate place. This uses ``libusb'' internally. +...@end itemize @item @option{--enable-gw16012} @item @@ -276,56 +278,104 @@ the @option{--enable-parport_ppdev} opti @section 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. Some claim the (closed) FTDICHIP.COM solution is faster. +There are 2 methods of using the FTD2232, either + +1) using FTDICHIP.COM's closed source libftd2xx driver (@option{--enable-ft2232_ftd2xx}). + +or + +2) the open source (free) libftdi driver (@option{--enable-ft2232_libftdi}). -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 +Note: Some claim the (closed) FTDICHIP.COM solution is faster. + +...@subsection Closed source libftd2xx + +The FTDICHIP.COM driver comes as either a (win32) ZIP file, or a (linux) +TAR.GZ file. You must unpack it ``some where'' convient. As of this writing (12/26/2008) FTDICHIP does not supply means to install these files ``in an appropriate place'' As a result, there are two ``./configure'' options that help. Below is an example build process: +...@enumerate -1) Check out the latest version of ``openocd'' from SVN. +...@item Check out the latest version of ``openocd'' from SVN. -2) Download & Unpack either the Windows or Linux FTD2xx Drivers - (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}) +...@item Download & unpack either the Windows or Linux FTD2xx Drivers + (@uref{http://www.ftdichip.com/Drivers/D2XX.htm}). E.g.: @example /home/duane/ftd2xx.win32 => the Cygwin/Win32 ZIP file contents. /home/duane/libftd2xx0.4.16 => the Linux TAR file contents. @end example -3) Configure with these options: +...@item Configure with these options: +...@itemize @bullet +...@item @b{Cygwin} @example -Cygwin FTCICHIP solution ./configure --prefix=/home/duane/mytools \ --enable-ft2232_ftd2xx \ --with-ftd2xx-win32-zipdir=/home/duane/ftd2xx.win32 +...@end example -Linux FTDICHIP solution +...@item @b{Linux} +...@example ./configure --prefix=/home/duane/mytools \ --enable-ft2232_ftd2xx \ --with-ft2xx-linux-tardir=/home/duane/libftd2xx0.4.16 -Cygwin/Linux LIBFTDI solution - Assumes: - 1a) For Windows: The windows port of LIBUSB is in place. - 1b) For Linux: libusb has been built and is inplace. +...@end example +...@end itemize + +...@item Then just type ``make'', and perhaps ``make install''. +...@end enumerate + +...@subsection Open source libftdi + +The open source libftdi driver comes as (linux/cygwin) TAR.GZ file. You must unpack it ``some where'' convient and build it by @option{./configure & ./make & ./make install} before you can use it with OpenOCD. + +Below is an example build process: + +...@enumerate + +...@item Check out the latest version of ``openocd'' from SVN. + +...@item Download, configure, build and install libftdi. Open source libftdi is available at + @uref{http://www.intra2net.com/de/produkte/opensource/ftdi/}. + +...@item Configure OpenOCD with these options: +...@itemize @bullet + - 2) And libftdi has been built and installed - Note: libftdi - relies upon libusb. +...@item @b{Cygwin/Linux} +...@example ./configure --prefix=/home/duane/mytools \ --enable-ft2232_libftdi @end example +...@end itemize -4) Then just type ``make'', and perhaps ``make install''. + Assumes: +...@enumerate + @item For Windows: The windows port of LIBUSB is in place. + @item For Linux: libusb has been built and is in place. + + @item Libftdi has been built and installed +...@end enumerate + + Notes: +...@enumerate + +...@item libftdi relies upon libusb. + +...@item If you built libftdi with --prefix=<path>, building OpenOCD you have to use the same <path> for OpenOCD build, too. This ensures that OpenOCD's build tooling finds libftdi properly. +...@end enumerate + +...@item Then just type ``make'', and perhaps ``make install''. +...@end enumerate @section Miscellaneous configure options
_______________________________________________ Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
