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