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