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  - git
  28  - make
  29  - autoconf >= 2.63
  30  - automake >= 1.11
  31  - sdcc (>= 2.9.0)
  32
  33 Notes:
  34
  35  - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0).
  36    On Debian you can install it via:
  37
  38      $ apt-get install sdcc
  39
  40    This project has been tested to work with sdcc 2.9, 3.0, 3.1, and 3.2.
  41
  42  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
  43    versions didn't have support for FX2 devices using this firmware.
  44
  45
  46 Building and installing
  47 -----------------------
  48
  49 In order to get the sigrok-firmware-fx2lafw source code and build it, run:
  50
  51  $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
  52  $ cd sigrok-firmware-fx2lafw
  53  $ ./autogen.sh
  54  $ ./configure
  55  $ make
  56
  57 For installing sigrok-firmware-fx2lafw:
  58
  59  $ make install
  60
  61 The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
  62
  63 You can override the install location like this:
  64
  65  $ ./configure --prefix=/usr
  66
  67 See INSTALL or the following wiki page for more (OS-specific) instructions:
  68
  69  http://sigrok.org/wiki/Building
  70
  71
  72 Pre-built firmware files
  73 ------------------------
  74
  75 There are also pre-built firmware files that can be used without having
  76 to build them from source. You can download those from SourceForge:
  77
  78   http://sourceforge.net/projects/sigrok/files/binary/sigrok-firmware-fx2lafw/
  79
  80
  81 fx2lib
  82 ------
  83
  84 The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
  85
  86 It was imported into fx2lafw from
  87
  88   git://github.com/ubixum/fx2lib.git
  89
  90 as of Feb 12, 2012 (git hash "416c104cbd").
  91
  92 The following files/directories were removed, as they're not needed
  93 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
  94
  95
  96 Mailing lists
  97 -------------
  98
  99 There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:
 100
 101  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
 102  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
 103
 104
 105 IRC
 106 ---
 107
 108 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 109
 110
 111 Website
 112 -------
 113
 114  http://sigrok.org/wiki/Fx2lafw
 115