Add setup script for USB cable which works on modern distributions

[usb-driver] / README

diff --git a/README b/README
index f9b6cec9bb558abf9466d6f9f51b914710f53cc4..802ca7809d8c5a7c9d65dec1d177efc77ebd71a9 100644 (file)
--- a/README
+++ b/README
@@ -9,18 +9,20 @@ should work on every kernel version which is supported by libusb and supports
 ppdev. It was written against impact from ISE Webpack 9.1SP1 and tested with
 the following software:
 
- * ISE Webpack 9.2SP1
- * ISE Webpack 9.1SP3
- * ISE Webpack 9.1SP2
- * ISE Webpack 9.1SP1
+ * ISE 12.1
+ * ISE Webpack 11.1
+ * ISE Webpack 10.1
+ * ISE Webpack 9.2SP1, SP2, SP3, SP4
+ * ISE Webpack 9.1SP1, SP2, SP3
  * ISE Webpack 8.2SP3
  * ISE Webpack 8.1SP3
- * ChipScope 9.2.01i
- * ChipScope 9.1.03i
- * ChipScope 9.1.02i
+ * ChipScope 10.1
+ * ChipScope 9.2.01i, 9.2.02i, 9.2.03i, 9.2.04i
+ * ChipScope 9.1.02i, 9.1.03i
  * ChipScope 8.2.04i
- * EDK 9.1.02i
- * EDK 9.1.01i
+ * EDK 10.1
+ * EDK 9.2.01i, 9.2.02i
+ * EDK 9.1.01i, 9.1.02i
  * EDK 8.2.02i
  * EDK 8.1.02i
  * Synplicity Identify
@@ -30,7 +32,8 @@ In addition to the XILINX USB and parallel cables, devices based on the FTDI
 devices like the Amontec JTAGkey(-Tiny).
 
 Build the library by calling `make'. If you are on a 64 bit system but want
-to build a 32 bit library, run `make lib32' instead.
+to build a 32 bit library, run `make lib32' instead. Be sure to have the 32
+bit versions of libusb-devel and libftdi-devel installed!
 
 To use this library you have to preload the library before starting impact:
 
@@ -54,8 +57,8 @@ Notes for the USB cable
 =======================
 
 To use the device as an ordinary user, put the following line in a new
-file in /etc/udev/rules.d/ and restart udev:
-ACTION=="add", BUS=="usb", SYSFS{idVendor}=="03fd", MODE="666"
+file "libusb-driver.rules" in /etc/udev/rules.d/ and restart udev:
+ACTION=="add", SUBSYSTEMS=="usb", ATTRS{idVendor}=="03fd", MODE="666"
 
 
 If your cable does not have the ID 03fd:0008 in the output of lsusb,
@@ -63,15 +66,28 @@ the initial firmware has not been loaded (loading it changes the
 product-ID from another value to 8). To load the firmware follow
 these steps:
 
+1. Run ./setup_pcusb in this directory, this should set up everything
+   correctly:
+   - When $XILINX is set correctly:
+     $ ./setup_pcusb
+   - When $XILINX is not set, and ISE is installed in /opt/Xilinx/13.1:
+     $ ./setup_pcusb /opt/Xilinx/13.1/ISE_DS/ISE
+
+Old instructions, use only when the above script did not work:
+
 1. If you have no /etc/udev/rules.d/xusbdfwu.rules file, copy it from
    /path/to/ISE/bin/lin/xusbdfwu.rules to /etc/udev/rules.d/xusbdfwu.rules
 
-2. Install the package containing /sbin/fxload from your linux distribution.
+2. If you are running a newer version of udev (as in Debian Squeeze and
+   Ubuntu 9.10), you need to adapt the rules-file to the new udev-version:
+   sed -i -e 's/TEMPNODE/tempnode/' -e 's/SYSFS/ATTRS/g' -e 's/BUS/SUBSYSTEMS/' /etc/udev/rules.d/xusbdfwu.rules
+
+3. Install the package containing /sbin/fxload from your linux distribution.
    It is usually called "fxload"
 
-3. copy the file /path/to/ISE/bin/lin/xusbdfwu.hex to /usr/share/xusbdfwu.hex
+4. copy the files /path/to/ISE/bin/lin/xusb*.hex to /usr/share/
 
-4. restart udev and re-plug the cable
+5. restart udev and re-plug the cable
 
 
 If you have multiple cables connected, you can specify the cable to use
@@ -138,7 +154,7 @@ To set-up the device:
 
 3. To use the device as an ordinary user, put the following line in a new file
    in /etc/udev/rules.d/ and restart udev:
-   ACTION=="add", BUS=="usb", SYSFS{idVendor}=="0403", SYSFS{idProduct}=="cff8", MODE="666"
+   ACTION=="add", SUBSYSTEMS=="usb", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="cff8", MODE="666"
    (replace the vendor and product id with your values)
 
 The support for FTDI 2232 based devices is experimental and they are currently