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