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