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