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