README

   1 ------------------------------------------------------------------------------
   2 fx2lafw
   3 ------------------------------------------------------------------------------
   4
   5 fx2lafw is a free/libre/open-source firmware for logic analyzers based on
   6 the Cypress EZ-USB FX2(LP) chip.
   7
   8 It is licensed under the terms of the GNU GPL (version 2 or later), and uses
   9 additional helper code (fx2lib), licensed under the GNU LGPL (version 2.1
  10 or later).
  11
  12
  13 Requirements
  14 ------------
  15
  16  - In order to build fx2lafw you need the 'sdcc' compiler.
  17    On Debian you can install it via:
  18
  19      $ apt-get install sdcc
  20
  21  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
  22    versions didn't have support for FX2 devices using this firmware.
  23
  24
  25 Building
  26 --------
  27
  28   $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
  29   $ cd fx2lafw
  30   $ make
  31
  32
  33 Usage
  34 -----
  35
  36 Copy the generated *.fw file for your device (e.g. fx2lafw-saleae-logic.fw)
  37 into the $prefix/share/sigrok-firmware directory (create it, if needed).
  38
  39 Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.
  40
  41 Example (assuming /usr/local as $prefix):
  42
  43   $ sudo mkdir /usr/local/share/sigrok-firmware
  44
  45   $ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
  46             /usr/local/share/sigrok-firmware
  47
  48 The sigrok frontends (command-line or GUI) will automatically search for
  49 firmware files there and automatically use/upload them.
  50
  51
  52 fx2lib
  53 ------
  54
  55 The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
  56
  57 It was imported into fx2lafw from
  58
  59   git://github.com/ubixum/fx2lib.git
  60
  61 as of Feb 12, 2012 (git hash "416c104cbd").
  62
  63 The following files/directories were removed, as they're not needed
  64 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
  65
  66
  67 Website
  68 -------
  69
  70 See the fx2lafw website for further information:
  71
  72   http://sigrok.org/wiki/Fx2lafw
  73