document lib32 target, add EDK 9.1.02i as working

[usb-driver] / README

diff --git a/README b/README
index 277ffe6eff675fc81608aa94924cb546dca8e4de..23265b8b8df554f0e805754a07042d8cacfde2ce 100644 (file)
--- a/README
+++ b/README
@@ -9,14 +9,25 @@ 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.1SP3
  * ISE Webpack 9.1SP2
  * ISE Webpack 9.1SP1
  * ISE Webpack 8.2SP3
  * ISE Webpack 8.1SP3
+ * ChipScope 9.1.03i
  * ChipScope 9.1.02i
+ * ChipScope 8.2.04i
+ * EDK 9.1.02i
+ * EDK 9.1.01i
  * EDK 8.2.02i
+ * EDK 8.1.02i
 
-Build the library by calling `make'.
+In addition to the XILINX USB and parallel cables, devices based on the FTDI
+2232 serial converter chip are also experimentally supported. This includes
+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 use this library you have to preload the library before starting impact:
 
@@ -26,6 +37,15 @@ $ export LD_PRELOAD=/path/to/libusb-driver.so  (for sh shells)
 $ setenv LD_PRELOAD /path/to/libusb-driver.so  (for csh shells)
 $ impact
 
+The source for this library can be found at:
+http://git.zerfleddert.de/cgi-bin/gitweb.cgi/usb-driver
+
+The main website is located at:
+http://www.rmdir.de/~michael/xilinx/
+
+The Git repository can be cloned with:
+git clone git://git.zerfleddert.de/usb-driver
+
 
 Notes for the USB cable
 =======================
@@ -68,6 +88,11 @@ ppdev
 To use the device as an ordinary user, put the user in the group 'lp'
 
 
+If you have an almost compatible cable which works with other software but not
+with Impact, try adding -DFORCE_PC3_IDENT to the CFLAGS line in the Makefile.
+This enables a hack by Stefan Ziegenbalg to force detection of a parallel cable.
+
+
 Parallel Cable IV is currently only supported in 'compatibility mode', as no
 attempt to configure the ECP registers is done by this library.
 
@@ -78,6 +103,32 @@ HIGHZ instead of BYPASS" enabled in Edit -> Preferences -> iMPACT Configuration
 Preferences.
 If you are using batch mode, add the following line to your cmd file:
 setPreference -pref UseHighz:TRUE
-(This problem also occurs on windows and when using the real windrvr in linux and
-is solved with the same workaround. Impact 8.2 is working fine with the same
+(This problem also occurs on windows and when using the real windrvr in linux
+and is solved with the same workaround. Impact 8.2 is working fine with the same
 boards and designs)
+
+
+Notes for FTDI 2232 based cables
+================================
+
+To build the driver with FTDI 2232 support, you need to have libftdi and
+the libftdi development package installed. On debian, you can install both
+by installing 'libftdi-dev'.
+
+To set-up the device:
+1. Find out the vendor and product id of your cable using lsusb:
+   Bus 003 Device 005: ID 0403:cff8 Future Technology Devices ...
+                          ~~~~~~~~~
+
+2. Copy the sample libusb-driverrc to ~/.libusb-driverrc, edit it and replace
+   the vendor and product-id in the example file with the values provided in
+   the lsusb-output. You can also change the 'parallel port' which is mapped to
+   this cable. Impact sees the device at that port as a Parallel Cable III.
+
+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"
+   (replace the vendor and product id with your values)
+
+The support for FTDI 2232 based devices is experimental and they are currently
+significantly slower than the other supported cables.