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