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