support for multiple USB cables by Mondrian Nuessle <nuessle@uni-mannheim.de>
[usb-driver] / README
CommitLineData
54357994 1This library emulates Jungo Windrvr USB and parallel port functions in
2userspace which are required by XILINX impact to access the Platform cable USB
3and Parallel Cable III.
4With this library it is possible to access the cables without loading a
5proprietary kernel module which breaks with every new kernel release. It uses
6f766a61 6the functionality provided by the libusb userspace library for USB access and
54357994 7the kernel interface at /dev/parport0 for parallel port access instead and
8should work on every kernel version which is supported by libusb and supports
9ppdev. It was written against impact from ISE Webpack 9.1SP1 and tested with
10the following software:
0b50c513 11
ddd89a53 12 * ISE Webpack 9.2SP1
7824bbf6 13 * ISE Webpack 9.1SP3
0b50c513 14 * ISE Webpack 9.1SP2
15 * ISE Webpack 9.1SP1
54fc4508 16 * ISE Webpack 8.2SP3
0b50c513 17 * ISE Webpack 8.1SP3
ddd89a53 18 * ChipScope 9.2.01i
3b1b5fa8 19 * ChipScope 9.1.03i
0b50c513 20 * ChipScope 9.1.02i
3b1b5fa8 21 * ChipScope 8.2.04i
b8b5059a 22 * EDK 9.1.02i
2c6ade7a 23 * EDK 9.1.01i
54fc4508 24 * EDK 8.2.02i
5649925c 25 * EDK 8.1.02i
337944d1 26 * Synplicity Identify
113af964 27
7606d470 28In addition to the XILINX USB and parallel cables, devices based on the FTDI
292232 serial converter chip are also experimentally supported. This includes
30devices like the Amontec JTAGkey(-Tiny).
31
b8b5059a
MG
32Build the library by calling `make'. If you are on a 64 bit system but want
33to build a 32 bit library, run `make lib32' instead.
113af964 34
35To use this library you have to preload the library before starting impact:
36
37$ LD_PRELOAD=/path/to/libusb-driver.so impact
38or
39$ export LD_PRELOAD=/path/to/libusb-driver.so (for sh shells)
40$ setenv LD_PRELOAD /path/to/libusb-driver.so (for csh shells)
41$ impact
fdd05738 42
45b9b80b 43The source for this library can be found at:
badd6a82 44http://git.zerfleddert.de/cgi-bin/gitweb.cgi/usb-driver
45b9b80b 45
32e2af23 46The main website is located at:
47http://www.rmdir.de/~michael/xilinx/
48
b22eea29
MG
49The Git repository can be cloned with:
50git clone git://git.zerfleddert.de/usb-driver
51
54357994 52
53Notes for the USB cable
54=======================
55
56To use the device as an ordinary user, put the following line in a new
fdd05738 57file in /etc/udev/rules.d/ and restart udev:
58ACTION=="add", BUS=="usb", SYSFS{idVendor}=="03fd", MODE="666"
979132fe 59
60
61If your cable does not have the ID 03fd:0008 in the output of lsusb,
62the initial firmware has not been loaded (loading it changes the
63product-ID from another value to 8). To load the firmware follow
64these steps:
65
c2e95a30 661. If you have no /etc/udev/rules.d/xusbdfwu.rules file, copy it from
67 /path/to/ISE/bin/lin/xusbdfwu.rules to /etc/udev/rules.d/xusbdfwu.rules
979132fe 68
692. Install the package containing /sbin/fxload from your linux distribution.
70 It is usually called "fxload"
71
723. copy the file /path/to/ISE/bin/lin/xusbdfwu.hex to /usr/share/xusbdfwu.hex
73
744. restart udev and re-plug the cable
54357994 75
76
77Notes for the parallel cable
78============================
79
80To access the parallel port from userspace, the kernel needs to be built with
81the features "Parallel port support" (CONFIG_PARPORT), "PC-style hardware"
82(CONFIG_PARPORT_PC) and "Support for user-space parallel port device drivers"
83(CONFIG_PPDEV) builtin or as modules. If these features are built as modules,
84they need to be loaded before using this library.
85These modules are called:
86parport
87parport_pc
88ppdev
89
90
91To use the device as an ordinary user, put the user in the group 'lp'
6f766a61 92
93
cdc9c5bf 94If you have an almost compatible cable which works with other software but not
05e1bfcd 95with Impact, try adding -DFORCE_PC3_IDENT to the CFLAGS line in the Makefile.
96This enables a hack by Stefan Ziegenbalg to force detection of a parallel cable.
cdc9c5bf 97
98
6f766a61 99Parallel Cable IV is currently only supported in 'compatibility mode', as no
100attempt to configure the ECP registers is done by this library.
0c71f276 101
102
103If you get "Programming failed" or "DONE did not go high" when programming
104through the parallel cable with Impact 9.1, make sure to have the option "Use
105HIGHZ instead of BYPASS" enabled in Edit -> Preferences -> iMPACT Configuration
106Preferences.
107If you are using batch mode, add the following line to your cmd file:
108setPreference -pref UseHighz:TRUE
7606d470 109(This problem also occurs on windows and when using the real windrvr in linux
110and is solved with the same workaround. Impact 8.2 is working fine with the same
0c71f276 111boards and designs)
7606d470 112
113
114Notes for FTDI 2232 based cables
115================================
116
117To build the driver with FTDI 2232 support, you need to have libftdi and
118the libftdi development package installed. On debian, you can install both
119by installing 'libftdi-dev'.
120
121To set-up the device:
1221. Find out the vendor and product id of your cable using lsusb:
123 Bus 003 Device 005: ID 0403:cff8 Future Technology Devices ...
124 ~~~~~~~~~
125
1262. Copy the sample libusb-driverrc to ~/.libusb-driverrc, edit it and replace
19020bc5 127 the vendor and product-id in the example file with the values provided in
128 the lsusb-output. You can also change the 'parallel port' which is mapped to
129 this cable. Impact sees the device at that port as a Parallel Cable III.
7606d470 130
1313. To use the device as an ordinary user, put the following line in a new file
132 in /etc/udev/rules.d/ and restart udev:
133 ACTION=="add", BUS=="usb", SYSFS{idVendor}=="0403", SYSFS{idProduct}=="cff8", MODE="666"
134 (replace the vendor and product id with your values)
135
dc587d11 136The support for FTDI 2232 based devices is experimental and they are currently
1830118e 137significantly slower than the other supported cables.
c21a2dec
MG
138
139
140Locked cables
141=============
142
143If you get the message 'The cable is being used by another application.' from
144impact, try running the following command:
145
146echo -e 'cleancablelock\nexit' | impact -batch
Impressum, Datenschutz