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