README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4
   5 The sigrok project aims at creating a portable, cross-platform,
   6 Free/Libre/Open-Source signal analysis software suite that supports various
   7 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
   8
   9 fx2lafw is a Free/Libre/Open-source firmware for logic analyzers based on
  10 the Cypress EZ-USB FX2(LP) chip.
  11
  12 It is licensed under the terms of the GNU GPL (version 2 or later), and uses
  13 additional helper code (fx2lib), licensed under the GNU LGPL (version 2.1
  14 or later).
  15
  16
  17 Status
  18 ------
  19
  20 sigrok-firmware-fx2lafw is in a usable state and has had official
  21 tarball releases.
  22
  23
  24 Requirements
  25 ------------
  26
  27  - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.8.0).
  28    On Debian you can install it via:
  29
  30      $ apt-get install sdcc
  31
  32    This project has been tested to work with sdcc 2.8, 2.9, and 3.x.
  33
  34  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
  35    versions didn't have support for FX2 devices using this firmware.
  36
  37
  38 Building and installing
  39 -----------------------
  40
  41 In order to get the sigrok-firmware-fx2lafw source code and build it, run:
  42
  43  $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
  44  $ cd sigrok-firmware-fx2lafw
  45  $ ./autogen.sh
  46  $ ./configure
  47  $ make
  48
  49 For installing sigrok-firmware-fx2lafw:
  50
  51  $ make install
  52
  53 The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
  54
  55 You can override the install location like this:
  56
  57  $ ./configure --prefix=/usr
  58
  59 Please see the following wiki pages for more detailed instructions:
  60
  61  http://sigrok.org/wiki/Linux
  62  http://sigrok.org/wiki/Mac_OS_X
  63  http://sigrok.org/wiki/Windows
  64  http://sigrok.org/wiki/FreeBSD
  65
  66
  67 fx2lib
  68 ------
  69
  70 The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
  71
  72 It was imported into fx2lafw from
  73
  74   git://github.com/ubixum/fx2lib.git
  75
  76 as of Feb 12, 2012 (git hash "416c104cbd").
  77
  78 The following files/directories were removed, as they're not needed
  79 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
  80
  81
  82 Mailing lists
  83 -------------
  84
  85 There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:
  86
  87  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  88  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  89
  90
  91 IRC
  92 ---
  93
  94 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  95
  96
  97 Website
  98 -------
  99
 100  http://sigrok.org/wiki/Fx2lafw
 101