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