-------------------------------------------------------------------------------
-fx2lafw
-------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
+README
+-------------------------------------------------------------------------------
-fx2lafw is a free/libre/open-source firmware for logic analyzers based on
+The sigrok project aims at creating a portable, cross-platform,
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
+
+fx2lafw is a Free/Libre/Open-source firmware for logic analyzers based on
the Cypress EZ-USB FX2(LP) chip.
It is licensed under the terms of the GNU GPL (version 2 or later), and uses
or later).
+Status
+------
+
+sigrok-firmware-fx2lafw is in a usable state and has had official
+tarball releases.
+
+
Requirements
------------
- - In order to build fx2lafw you need the 'sdcc' compiler.
+ - git
+ - make
+ - autoconf >= 2.63
+ - automake >= 1.11
+ - sdcc (>= 2.9.0)
+
+Notes:
+
+ - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0).
On Debian you can install it via:
$ apt-get install sdcc
+ This project has been tested to work with sdcc 2.9.x, and 3.x.y.
+
- You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
versions didn't have support for FX2 devices using this firmware.
-Building
---------
+Building and installing
+-----------------------
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
- $ cd fx2lafw
- $ make
+In order to get the sigrok-firmware-fx2lafw source code and build it, run:
+ $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
+ $ cd sigrok-firmware-fx2lafw
+ $ ./autogen.sh
+ $ ./configure
+ $ make
-Usage
------
+For installing sigrok-firmware-fx2lafw:
-Copy the generated *.fw file for your device (e.g. fx2lafw-saleae-logic.fw)
-into the $prefix/share/sigrok-firmware directory (create it, if needed).
+ $ make install
-Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.
+The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
-Example (assuming /usr/local as $prefix):
+You can override the install location like this:
- $ sudo mkdir /usr/local/share/sigrok-firmware
+ $ ./configure --prefix=/usr
- $ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
- /usr/local/share/sigrok-firmware
+Please see the following wiki pages for more detailed instructions:
-The sigrok frontends (command-line or GUI) will automatically search for
-firmware files there and automatically use/upload them.
+ http://sigrok.org/wiki/Linux
+ http://sigrok.org/wiki/Mac_OS_X
+ http://sigrok.org/wiki/Windows
+ http://sigrok.org/wiki/FreeBSD
fx2lib
for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
+Mailing lists
+-------------
+
+There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+ https://lists.sourceforge.net/lists/listinfo/sigrok-commits
+
+
+IRC
+---
+
+You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+
+
Website
-------
-See the fx2lafw website for further information:
-
- http://sigrok.org/wiki/Fx2lafw
+ http://sigrok.org/wiki/Fx2lafw