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 sigrok-firmware-fx2lafw is a Free/Libre/Open-source firmware for logic
  10 analyzers based on the Cypress EZ-USB FX2(LP) chip.
  11
  12
  13 Status
  14 ------
  15
  16 sigrok-firmware-fx2lafw is in a usable state and has had official
  17 tarball releases.
  18
  19
  20 Requirements
  21 ------------
  22
  23  - git
  24  - make
  25  - autoconf >= 2.63
  26  - automake >= 1.11
  27  - sdcc (>= 2.9.0)
  28
  29 Notes:
  30
  31  - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0).
  32    On Debian you can install it via:
  33
  34      $ apt-get install sdcc
  35
  36    This project has been tested to work with sdcc 2.9 and 3.x.
  37
  38  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
  39    versions didn't have support for FX2 devices using this firmware.
  40
  41
  42 Building and installing
  43 -----------------------
  44
  45 In order to get the sigrok-firmware-fx2lafw source code and build it, run:
  46
  47  $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
  48  $ cd sigrok-firmware-fx2lafw
  49  $ ./autogen.sh
  50  $ ./configure
  51  $ make
  52
  53 For installing sigrok-firmware-fx2lafw:
  54
  55  $ make install
  56
  57 The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
  58
  59 You can override the install location like this:
  60
  61  $ ./configure --prefix=/usr
  62
  63 See INSTALL or the following wiki page for more (OS-specific) instructions:
  64
  65  http://sigrok.org/wiki/Building
  66
  67
  68 Pre-built firmware files
  69 ------------------------
  70
  71 There are also pre-built firmware files that can be used without having
  72 to build them from source. You can download those from SourceForge:
  73
  74   http://sourceforge.net/projects/sigrok/files/binary/sigrok-firmware-fx2lafw/
  75
  76
  77 fx2lib
  78 ------
  79
  80 The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
  81
  82 It was imported into fx2lafw from
  83
  84   git://github.com/ubixum/fx2lib.git
  85
  86 as of Feb 12, 2012 (git hash "416c104cbd").
  87
  88 The following files/directories were removed, as they're not needed
  89 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
  90
  91
  92 Copyright and license
  93 ---------------------
  94
  95 sigrok-firmware-fx2lafw is licensed under the terms of the GNU General Public
  96 License (GPL), version 2 or later.
  97
  98 It uses additional helper code (fx2lib), licensed under the GNU LGPL
  99 (version 2.1 or later).
 100
 101 While some individual source code files are licensed under the LGPLv2.1+, and
 102 some files are licensed under the GPLv2+, this doesn't change the fact that
 103 the firmware as a whole is licensed under the terms of the GPLv2+.
 104
 105 Please see the individual source files for the full list of copyright holders.
 106
 107
 108 Mailing list
 109 ------------
 110
 111  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
 112
 113
 114 IRC
 115 ---
 116
 117 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 118
 119
 120 Website
 121 -------
 122
 123  http://sigrok.org/wiki/Fx2lafw
 124