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