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