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