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