add link to 64bit install instructions on Kubuntu by Ken Ryan
[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
7824bbf6 12 * ISE Webpack 9.1SP3
0b50c513 13 * ISE Webpack 9.1SP2
14 * ISE Webpack 9.1SP1
54fc4508 15 * ISE Webpack 8.2SP3
0b50c513 16 * ISE Webpack 8.1SP3
3b1b5fa8 17 * ChipScope 9.1.03i
0b50c513 18 * ChipScope 9.1.02i
3b1b5fa8 19 * ChipScope 8.2.04i
b8b5059a 20 * EDK 9.1.02i
2c6ade7a 21 * EDK 9.1.01i
54fc4508 22 * EDK 8.2.02i
5649925c 23 * EDK 8.1.02i
113af964 24
7606d470 25In addition to the XILINX USB and parallel cables, devices based on the FTDI
262232 serial converter chip are also experimentally supported. This includes
27devices like the Amontec JTAGkey(-Tiny).
28
b8b5059a
MG
29Build the library by calling `make'. If you are on a 64 bit system but want
30to build a 32 bit library, run `make lib32' instead.
113af964 31
32To use this library you have to preload the library before starting impact:
33
34$ LD_PRELOAD=/path/to/libusb-driver.so impact
35or
36$ export LD_PRELOAD=/path/to/libusb-driver.so (for sh shells)
37$ setenv LD_PRELOAD /path/to/libusb-driver.so (for csh shells)
38$ impact
fdd05738 39
45b9b80b 40The source for this library can be found at:
badd6a82 41http://git.zerfleddert.de/cgi-bin/gitweb.cgi/usb-driver
45b9b80b 42
32e2af23 43The main website is located at:
44http://www.rmdir.de/~michael/xilinx/
45
b22eea29
MG
46The Git repository can be cloned with:
47git clone git://git.zerfleddert.de/usb-driver
48
54357994 49
50Notes for the USB cable
51=======================
52
53To use the device as an ordinary user, put the following line in a new
fdd05738 54file in /etc/udev/rules.d/ and restart udev:
55ACTION=="add", BUS=="usb", SYSFS{idVendor}=="03fd", MODE="666"
979132fe 56
57
58If your cable does not have the ID 03fd:0008 in the output of lsusb,
59the initial firmware has not been loaded (loading it changes the
60product-ID from another value to 8). To load the firmware follow
61these steps:
62
c2e95a30 631. If you have no /etc/udev/rules.d/xusbdfwu.rules file, copy it from
64 /path/to/ISE/bin/lin/xusbdfwu.rules to /etc/udev/rules.d/xusbdfwu.rules
979132fe 65
662. Install the package containing /sbin/fxload from your linux distribution.
67 It is usually called "fxload"
68
693. copy the file /path/to/ISE/bin/lin/xusbdfwu.hex to /usr/share/xusbdfwu.hex
70
714. restart udev and re-plug the cable
54357994 72
73
74Notes for the parallel cable
75============================
76
77To access the parallel port from userspace, the kernel needs to be built with
78the features "Parallel port support" (CONFIG_PARPORT), "PC-style hardware"
79(CONFIG_PARPORT_PC) and "Support for user-space parallel port device drivers"
80(CONFIG_PPDEV) builtin or as modules. If these features are built as modules,
81they need to be loaded before using this library.
82These modules are called:
83parport
84parport_pc
85ppdev
86
87
88To use the device as an ordinary user, put the user in the group 'lp'
6f766a61 89
90
cdc9c5bf 91If you have an almost compatible cable which works with other software but not
05e1bfcd 92with Impact, try adding -DFORCE_PC3_IDENT to the CFLAGS line in the Makefile.
93This enables a hack by Stefan Ziegenbalg to force detection of a parallel cable.
cdc9c5bf 94
95
6f766a61 96Parallel Cable IV is currently only supported in 'compatibility mode', as no
97attempt to configure the ECP registers is done by this library.
0c71f276 98
99
100If you get "Programming failed" or "DONE did not go high" when programming
101through the parallel cable with Impact 9.1, make sure to have the option "Use
102HIGHZ instead of BYPASS" enabled in Edit -> Preferences -> iMPACT Configuration
103Preferences.
104If you are using batch mode, add the following line to your cmd file:
105setPreference -pref UseHighz:TRUE
7606d470 106(This problem also occurs on windows and when using the real windrvr in linux
107and is solved with the same workaround. Impact 8.2 is working fine with the same
0c71f276 108boards and designs)
7606d470 109
110
111Notes for FTDI 2232 based cables
112================================
113
114To build the driver with FTDI 2232 support, you need to have libftdi and
115the libftdi development package installed. On debian, you can install both
116by installing 'libftdi-dev'.
117
118To set-up the device:
1191. Find out the vendor and product id of your cable using lsusb:
120 Bus 003 Device 005: ID 0403:cff8 Future Technology Devices ...
121 ~~~~~~~~~
122
1232. Copy the sample libusb-driverrc to ~/.libusb-driverrc, edit it and replace
19020bc5 124 the vendor and product-id in the example file with the values provided in
125 the lsusb-output. You can also change the 'parallel port' which is mapped to
126 this cable. Impact sees the device at that port as a Parallel Cable III.
7606d470 127
1283. To use the device as an ordinary user, put the following line in a new file
129 in /etc/udev/rules.d/ and restart udev:
130 ACTION=="add", BUS=="usb", SYSFS{idVendor}=="0403", SYSFS{idProduct}=="cff8", MODE="666"
131 (replace the vendor and product id with your values)
132
dc587d11 133The support for FTDI 2232 based devices is experimental and they are currently
1830118e 134significantly slower than the other supported cables.
Impressum, Datenschutz