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