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