Remove since long deprecated ft2232 driver
Purge all legacy interface configurations so there's no more confusion over which one to use. Also remove doc/INSTALL.txt which mentions ft2232 but otherwise just duplicates what INSTALL says. Change-Id: Ic94f808f123d4917e600b79309f1272c78a7bb11 Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/3236 Tested-by: jenkins Reviewed-by: Andreas Färber <afaerber@suse.de> Reviewed-by: Freddie Chopin <freddie.chopin@gmail.com>
This commit is contained in:
Andreas Fritiofson
-204
@@ -1,204 +0,0 @@
|
||||
TODO!!! this should be merged into openocd.texi!!!
|
||||
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
When building with support for FTDI FT2232 based devices, you need at least
|
||||
one of the following libraries:
|
||||
|
||||
- libftdi (http://www.intra2net.com/opensource/ftdi/)
|
||||
- libftd2xx (http://www.ftdichip.com/Drivers/D2XX.htm)
|
||||
|
||||
On Windows, you need either Cygwin or MinGW, but compilation for MinGW is also
|
||||
possible using a Cygwin host.
|
||||
|
||||
Basic Installation
|
||||
==================
|
||||
|
||||
OpenOCD is distributed without autotools generated files, i.e. without a
|
||||
configure script. Run ./bootstrap in the openocd directory to have all
|
||||
necessary files generated.
|
||||
|
||||
You have to explicitly enable desired JTAG interfaces during configure:
|
||||
|
||||
./configure --enable-parport --enable-ft2232-libftdi (OR --enable-ft2232-ftd2xx) \
|
||||
--enable-amtjtagaccel
|
||||
|
||||
Under Windows/Cygwin, only the ftd2xx driver is supported for FT2232 based
|
||||
devices. You have to specify the location of the FTDI driver package with the
|
||||
--with-ftd2xx=/full/path/name option.
|
||||
|
||||
Under Linux you can choose to build the parport driver with support for
|
||||
/dev/parportN instead of the default access with direct port I/O using
|
||||
--enable-parport_ppdev. This has the advantage of running OpenOCD without root
|
||||
privileges at the expense of a slight performance decrease. This is also
|
||||
available on FreeBSD using PPI, but the naming of the devices is different.
|
||||
|
||||
Generic installation instructions
|
||||
=================================
|
||||
|
||||
These are generic installation instructions.
|
||||
|
||||
The `configure' shell script attempts to guess correct values for
|
||||
various system-dependent variables used during compilation. It uses
|
||||
those values to create a `Makefile' in each directory of the package.
|
||||
It may also create one or more `.h' files containing system-dependent
|
||||
definitions. Finally, it creates a shell script `config.status' that
|
||||
you can run in the future to recreate the current configuration, a file
|
||||
`config.cache' that saves the results of its tests to speed up
|
||||
reconfiguring, and a file `config.log' containing compiler output
|
||||
(useful mainly for debugging `configure').
|
||||
|
||||
If you need to do unusual things to compile the package, please try
|
||||
to figure out how `configure' could check whether to do them, and mail
|
||||
diffs or instructions to the address given in the `README' so they can
|
||||
be considered for the next release. If at some point `config.cache'
|
||||
contains results you don't want to keep, you may remove or edit it.
|
||||
|
||||
The file `configure.in' is used to create `configure' by a program
|
||||
called `autoconf'. You only need `configure.in' if you want to change
|
||||
it or regenerate `configure' using a newer version of `autoconf'.
|
||||
|
||||
The simplest way to compile this package is:
|
||||
|
||||
1. `cd' to the directory containing the package's source code and type
|
||||
`./configure' to configure the package for your system. If you're
|
||||
using `csh' on an old version of System V, you might need to type
|
||||
`sh ./configure' instead to prevent `csh' from trying to execute
|
||||
`configure' itself.
|
||||
|
||||
Running `configure' takes a while. While running, it prints some
|
||||
messages telling which features it is checking for.
|
||||
|
||||
2. Type `make' to compile the package.
|
||||
|
||||
3. Type `make install' to install the programs and any data files and
|
||||
documentation.
|
||||
|
||||
4. You can remove the program binaries and object files from the
|
||||
source code directory by typing `make clean'.
|
||||
|
||||
Compilers and Options
|
||||
=====================
|
||||
|
||||
Some systems require unusual options for compilation or linking that
|
||||
the `configure' script does not know about. You can give `configure'
|
||||
initial values for variables by setting them in the environment. Using
|
||||
a Bourne-compatible shell, you can do that on the command line like
|
||||
this:
|
||||
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
|
||||
|
||||
Or on systems that have the `env' program, you can do it like this:
|
||||
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
|
||||
|
||||
Compiling For Multiple Architectures
|
||||
====================================
|
||||
|
||||
You can compile the package for more than one kind of computer at the
|
||||
same time, by placing the object files for each architecture in their
|
||||
own directory. To do this, you must use a version of `make' that
|
||||
supports the `VPATH' variable, such as GNU `make'. `cd' to the
|
||||
directory where you want the object files and executables to go and run
|
||||
the `configure' script. `configure' automatically checks for the
|
||||
source code in the directory that `configure' is in and in `..'.
|
||||
|
||||
If you have to use a `make' that does not supports the `VPATH'
|
||||
variable, you have to compile the package for one architecture at a time
|
||||
in the source code directory. After you have installed the package for
|
||||
one architecture, use `make distclean' before reconfiguring for another
|
||||
architecture.
|
||||
|
||||
Installation Names
|
||||
==================
|
||||
|
||||
By default, `make install' will install the package's files in
|
||||
`/usr/local/bin', `/usr/local/man', etc. You can specify an
|
||||
installation prefix other than `/usr/local' by giving `configure' the
|
||||
option `--prefix=PATH'.
|
||||
|
||||
You can specify separate installation prefixes for
|
||||
architecture-specific files and architecture-independent files. If you
|
||||
give `configure' the option `--exec-prefix=PATH', the package will use
|
||||
PATH as the prefix for installing programs and libraries.
|
||||
Documentation and other data files will still use the regular prefix.
|
||||
|
||||
If the package supports it, you can cause programs to be installed
|
||||
with an extra prefix or suffix on their names by giving `configure' the
|
||||
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
|
||||
|
||||
Optional Features
|
||||
=================
|
||||
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
`configure', where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
|
||||
is something like `gnu-as' or `x' (for the X Window System). The
|
||||
`README' should mention any `--enable-' and `--with-' options that the
|
||||
package recognizes.
|
||||
|
||||
For packages that use the X Window System, `configure' can usually
|
||||
find the X include and library files automatically, but if it doesn't,
|
||||
you can use the `configure' options `--x-includes=DIR' and
|
||||
`--x-libraries=DIR' to specify their locations.
|
||||
|
||||
Specifying the System Type
|
||||
==========================
|
||||
|
||||
There may be some features `configure' can not figure out
|
||||
automatically, but needs to determine by the type of host the package
|
||||
will run on. Usually `configure' can figure that out, but if it prints
|
||||
a message saying it can not guess the host type, give it the
|
||||
`--host=TYPE' option. TYPE can either be a short name for the system
|
||||
type, such as `sun4', or a canonical name with three fields:
|
||||
CPU-COMPANY-SYSTEM
|
||||
|
||||
See the file `config.sub' for the possible values of each field. If
|
||||
`config.sub' isn't included in this package, then this package doesn't
|
||||
need to know the host type.
|
||||
|
||||
If you are building compiler tools for cross-compiling, you can also
|
||||
use the `--target=TYPE' option to select the type of system they will
|
||||
produce code for and the `--build=TYPE' option to select the type of
|
||||
system on which you are compiling the package.
|
||||
|
||||
Sharing Defaults
|
||||
================
|
||||
|
||||
If you want to set default values for `configure' scripts to share,
|
||||
you can create a site shell script called `config.site' that gives
|
||||
default values for variables like `CC', `cache_file', and `prefix'.
|
||||
`configure' looks for `PREFIX/share/config.site' if it exists, then
|
||||
`PREFIX/etc/config.site' if it exists. Or, you can set the
|
||||
`CONFIG_SITE' environment variable to the location of the site script.
|
||||
A warning: not all `configure' scripts look for a site script.
|
||||
|
||||
Operation Controls
|
||||
==================
|
||||
|
||||
`configure' recognizes the following options to control how it
|
||||
operates.
|
||||
|
||||
`--cache-file=FILE'
|
||||
Use and save the results of the tests in FILE instead of
|
||||
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
|
||||
debugging `configure'.
|
||||
|
||||
`--help'
|
||||
Print a summary of the options to `configure', and exit.
|
||||
|
||||
`--quiet'
|
||||
`--silent'
|
||||
`-q'
|
||||
Do not print messages saying which checks are being made.
|
||||
|
||||
`--srcdir=DIR'
|
||||
Look for the package's source code in directory DIR. Usually
|
||||
`configure' can determine that directory automatically.
|
||||
|
||||
`--version'
|
||||
Print the version of Autoconf used to generate the `configure'
|
||||
script, and exit.
|
||||
|
||||
`configure' also accepts some other, not widely useful, options.
|
||||
|
||||
+1
-2
@@ -2,8 +2,7 @@ info_TEXINFOS = openocd.texi
|
||||
openocd_TEXINFOS = fdl.texi
|
||||
man_MANS = openocd.1
|
||||
EXTRA_DIST = openocd.1 \
|
||||
manual \
|
||||
INSTALL.txt
|
||||
manual
|
||||
|
||||
MAINTAINERCLEANFILES = \
|
||||
$(srcdir)/Makefile.in \
|
||||
|
||||
@@ -334,7 +334,7 @@ git tag -m "The openocd-${PACKAGE_VERSION} release." "${PACKAGE_TAG}"
|
||||
configuring its contents, using them to build a copy of OpenOCD,
|
||||
and verifying that the result prints the correct release version
|
||||
in its startup banner. (For example,
|
||||
"configure --enable-ft2232_libftdi --enable-parport"
|
||||
"configure --enable-parport"
|
||||
then "make" and run "src/openocd -v" as a sanity check.)
|
||||
-# Run <code>make docs</code> to create the
|
||||
documentation which will be published.
|
||||
|
||||
+3
-110
@@ -898,7 +898,7 @@ using a Signalyzer FT2232-based JTAG adapter to talk to
|
||||
a board with an Atmel AT91SAM7X256 microcontroller:
|
||||
|
||||
@example
|
||||
source [find interface/signalyzer.cfg]
|
||||
source [find interface/ftdi/signalyzer.cfg]
|
||||
|
||||
# GDB can also flash my flash!
|
||||
gdb_memory_map enable
|
||||
@@ -910,7 +910,7 @@ source [find target/sam7x256.cfg]
|
||||
Here is the command line equivalent of that configuration:
|
||||
|
||||
@example
|
||||
openocd -f interface/signalyzer.cfg \
|
||||
openocd -f interface/ftdi/signalyzer.cfg \
|
||||
-c "gdb_memory_map enable" \
|
||||
-c "gdb_flash_program enable" \
|
||||
-f target/sam7x256.cfg
|
||||
@@ -2403,109 +2403,12 @@ A dummy software-only driver for debugging.
|
||||
Cirrus Logic EP93xx based single-board computer bit-banging (in development)
|
||||
@end deffn
|
||||
|
||||
@deffn {Interface Driver} {ft2232}
|
||||
FTDI FT2232 (USB) based devices over one of the userspace libraries.
|
||||
|
||||
Note that this driver has several flaws and the @command{ftdi} driver is
|
||||
recommended as its replacement.
|
||||
|
||||
These interfaces have several commands, used to configure the driver
|
||||
before initializing the JTAG scan chain:
|
||||
|
||||
@deffn {Config Command} {ft2232_device_desc} description
|
||||
Provides the USB device description (the @emph{iProduct string})
|
||||
of the FTDI FT2232 device. If not
|
||||
specified, the FTDI default value is used. This setting is only valid
|
||||
if compiled with FTD2XX support.
|
||||
@end deffn
|
||||
|
||||
@deffn {Config Command} {ft2232_serial} serial-number
|
||||
Specifies the @var{serial-number} of the FTDI FT2232 device to use,
|
||||
in case the vendor provides unique IDs and more than one FT2232 device
|
||||
is connected to the host.
|
||||
If not specified, serial numbers are not considered.
|
||||
(Note that USB serial numbers can be arbitrary Unicode strings,
|
||||
and are not restricted to containing only decimal digits.)
|
||||
@end deffn
|
||||
|
||||
@deffn {Config Command} {ft2232_layout} name
|
||||
Each vendor's FT2232 device can use different GPIO signals
|
||||
to control output-enables, reset signals, and LEDs.
|
||||
Currently valid layout @var{name} values include:
|
||||
@itemize @minus
|
||||
@item @b{axm0432_jtag} Axiom AXM-0432
|
||||
@item @b{comstick} Hitex STR9 comstick
|
||||
@item @b{cortino} Hitex Cortino JTAG interface
|
||||
@item @b{evb_lm3s811} TI/Luminary Micro EVB_LM3S811 as a JTAG interface,
|
||||
either for the local Cortex-M3 (SRST only)
|
||||
or in a passthrough mode (neither SRST nor TRST)
|
||||
This layout can not support the SWO trace mechanism, and should be
|
||||
used only for older boards (before rev C).
|
||||
@item @b{luminary_icdi} This layout should be used with most TI/Luminary
|
||||
eval boards, including Rev C LM3S811 eval boards and the eponymous
|
||||
ICDI boards, to debug either the local Cortex-M3 or in passthrough mode
|
||||
to debug some other target. It can support the SWO trace mechanism.
|
||||
@item @b{flyswatter} Tin Can Tools Flyswatter
|
||||
@item @b{icebear} ICEbear JTAG adapter from Section 5
|
||||
@item @b{jtagkey} Amontec JTAGkey and JTAGkey-Tiny (and compatibles)
|
||||
@item @b{jtagkey2} Amontec JTAGkey2 (and compatibles)
|
||||
@item @b{m5960} American Microsystems M5960
|
||||
@item @b{olimex-jtag} Olimex ARM-USB-OCD and ARM-USB-Tiny
|
||||
@item @b{oocdlink} OOCDLink
|
||||
@c oocdlink ~= jtagkey_prototype_v1
|
||||
@item @b{redbee-econotag} Integrated with a Redbee development board.
|
||||
@item @b{redbee-usb} Integrated with a Redbee USB-stick development board.
|
||||
@item @b{sheevaplug} Marvell Sheevaplug development kit
|
||||
@item @b{signalyzer} Xverve Signalyzer
|
||||
@item @b{stm32stick} Hitex STM32 Performance Stick
|
||||
@item @b{turtelizer2} egnite Software turtelizer2
|
||||
@item @b{usbjtag} "USBJTAG-1" layout described in the OpenOCD diploma thesis
|
||||
@end itemize
|
||||
@end deffn
|
||||
|
||||
@deffn {Config Command} {ft2232_vid_pid} [vid pid]+
|
||||
The vendor ID and product ID of the FTDI FT2232 device. If not specified, the FTDI
|
||||
default values are used.
|
||||
Currently, up to eight [@var{vid}, @var{pid}] pairs may be given, e.g.
|
||||
@example
|
||||
ft2232_vid_pid 0x0403 0xcff8 0x15ba 0x0003
|
||||
@end example
|
||||
@end deffn
|
||||
|
||||
@deffn {Config Command} {ft2232_latency} ms
|
||||
On some systems using FT2232 based JTAG interfaces the FT_Read function call in
|
||||
ft2232_read() fails to return the expected number of bytes. This can be caused by
|
||||
USB communication delays and has proved hard to reproduce and debug. Setting the
|
||||
FT2232 latency timer to a larger value increases delays for short USB packets but it
|
||||
also reduces the risk of timeouts before receiving the expected number of bytes.
|
||||
The OpenOCD default value is 2 and for some systems a value of 10 has proved useful.
|
||||
@end deffn
|
||||
|
||||
@deffn {Config Command} {ft2232_channel} channel
|
||||
Used to select the channel of the ft2232 chip to use (between 1 and 4).
|
||||
The default value is 1.
|
||||
@end deffn
|
||||
|
||||
For example, the interface config file for a
|
||||
Turtelizer JTAG Adapter looks something like this:
|
||||
|
||||
@example
|
||||
interface ft2232
|
||||
ft2232_device_desc "Turtelizer JTAG/RS232 Adapter"
|
||||
ft2232_layout turtelizer2
|
||||
ft2232_vid_pid 0x0403 0xbdc8
|
||||
@end example
|
||||
@end deffn
|
||||
|
||||
@deffn {Interface Driver} {ftdi}
|
||||
This driver is for adapters using the MPSSE (Multi-Protocol Synchronous Serial
|
||||
Engine) mode built into many FTDI chips, such as the FT2232, FT4232 and FT232H.
|
||||
It is a complete rewrite to address a large number of problems with the ft2232
|
||||
interface driver.
|
||||
|
||||
The driver is using libusb-1.0 in asynchronous mode to talk to the FTDI device,
|
||||
bypassing intermediate libraries like libftdi of D2XX. Performance-wise it is
|
||||
consistently faster than the ft2232 driver, sometimes several times faster.
|
||||
bypassing intermediate libraries like libftdi of D2XX.
|
||||
|
||||
A major improvement of this driver is that support for new FTDI based adapters
|
||||
can be added competely through configuration files, without the need to patch
|
||||
@@ -9344,16 +9247,6 @@ supply stable enough for the Amontec JTAGkey to be operated.
|
||||
|
||||
@b{Laptops running on battery have this problem too...}
|
||||
|
||||
@item @b{USB Power} When using the Amontec JTAGkey, sometimes OpenOCD crashes with the
|
||||
following error messages: "Error: ft2232.c:201 ft2232_read(): FT_Read returned:
|
||||
4" and "Error: ft2232.c:365 ft2232_send_and_recv(): couldn't read from FT2232".
|
||||
What does that mean and what might be the reason for this?
|
||||
|
||||
First of all, the reason might be the USB power supply. Try using a self-powered
|
||||
hub instead of a direct connection to your computer. Secondly, the error code 4
|
||||
corresponds to an FT_IO_ERROR, which means that the driver for the FTDI USB
|
||||
chip ran into some sort of error - this points us to a USB problem.
|
||||
|
||||
@item @b{GDB Disconnects} When using the Amontec JTAGkey, sometimes OpenOCD crashes with the following
|
||||
error message: "Error: gdb_server.c:101 gdb_get_char(): read: 10054".
|
||||
What does that mean and what might be the reason for this?
|
||||
|
||||
Reference in New Issue
Block a user