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