don't export internal symbols

[usb-driver] / README

diff --git a/README b/README
index 597b1b2313596ef03ba478bf7011ca686f320d06..17d606e893c7cf056c85011c74e8a759fea59788 100644 (file)
--- a/README
+++ b/README
@@ -9,14 +9,28 @@ 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:
 
 ppdev. It was written against impact from ISE Webpack 9.1SP1 and tested with
 the following software:
 

- * ISE Webpack 9.1SP2
- * ISE Webpack 9.1SP1
+ * 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
  * ISE Webpack 8.2SP3
  * ISE Webpack 8.1SP3

- * 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 10.1
+ * EDK 9.2.01i, 9.2.02i
+ * EDK 9.1.01i, 9.1.02i

  * EDK 8.2.02i
  * EDK 8.2.02i

+ * EDK 8.1.02i
+ * Synplicity Identify

 
 

-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:
 
 
 To use this library you have to preload the library before starting impact:
 


@@ -27,14 +41,20 @@ $ setenv LD_PRELOAD /path/to/libusb-driver.so  (for csh shells)
 $ impact
 
 The source for this library can be found at:
 $ impact
 
 The source for this library can be found at:

-http://cvs.zerfleddert.de/cgi-bin/viewcvs.cgi/usb-driver/
+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
 =======================
 
 To use the device as an ordinary user, put the following line in a new
 
 
 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:
+file "libusb-driver.rules" in /etc/udev/rules.d/ and restart udev:

 ACTION=="add", BUS=="usb", SYSFS{idVendor}=="03fd", MODE="666"
 
 
 ACTION=="add", BUS=="usb", SYSFS{idVendor}=="03fd", MODE="666"
 
 


@@ -49,11 +69,19 @@ these steps:
 2. Install the package containing /sbin/fxload from your linux distribution.
    It is usually called "fxload"
 
 2. 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
+3. copy the files /path/to/ISE/bin/lin/xusb*.hex to /usr/share/

 
 4. restart udev and re-plug the cable
 
 
 
 4. restart udev and re-plug the cable
 
 

+If you have multiple cables connected, you can specify the cable to use
+in the XILINX_USB_DEV environment-variable as "bus:device".
+These identifiers are available in the output of lsusb:
+Bus 001 Device 004: ID 03fd:0008 Xilinx, Inc.
+    ^^^        ^^^
+To use this cable, set the XILINX_USB_DEV variable to "001:004".
+
+

 Notes for the parallel cable
 ============================
 
 Notes for the parallel cable
 ============================
 


@@ -71,6 +99,11 @@ ppdev
 To use the device as an ordinary user, put the user in the group 'lp'
 
 
 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.
 
 Parallel Cable IV is currently only supported in 'compatibility mode', as no
 attempt to configure the ECP registers is done by this library.
 


@@ -81,6 +114,41 @@ 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
 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)
 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.
+
+
+Locked cables
+=============
+
+If you get the message 'The cable is being used by another application.' from
+impact, try running the following command:
+
+echo -e 'cleancablelock\nexit' | impact -batch