[sigrok-firmware-fx2lafw.git] / README

------------------------------------------------------------------------------
fx2lafw
------------------------------------------------------------------------------

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
additional helper code licensed under the GNU LGPL (version 2.1 or later).


Requirements
------------

 - In order to build fx2lafw you need the 'sdcc' compiler.
   On Debian you can install it via:

     $ apt-get install sdcc

 - 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
--------

  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
  $ cd fx2lafw
  $ make


Usage
-----

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).

Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.

Example (assuming /usr/local as $prefix):

  $ sudo mkdir /usr/local/share/sigrok-firmware

  $ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
            /usr/local/share/sigrok-firmware

The sigrok frontends (command-line or GUI) will automatically search for
firmware files there and automatically use/upload them.
  

Website
-------

See the fx2lafw website for further information:

  http://sigrok.org/wiki/Fx2lafw
Commit	Line	Data
	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 licensed under the GNU LGPL (version 2.1 or later).
	10
	11
	12	Requirements
	13	------------
	14
	15	- In order to build fx2lafw you need the 'sdcc' compiler.
	16	On Debian you can install it via:
	17
	18	$ apt-get install sdcc
	19
	20	- You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
	21	versions didn't have support for FX2 devices using this firmware.
	22
	23
	24	Building
	25	--------
	26
	27	$ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
	28	$ cd fx2lafw
	29	$ make
	30
	31
	32	Usage
	33	-----
	34
	35	Copy the generated *.fw file for your device (e.g. fx2lafw-saleae-logic.fw)
	36	into the $prefix/share/sigrok-firmware directory (create it, if needed).
	37
	38	Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.
	39
	40	Example (assuming /usr/local as $prefix):
	41
	42	$ sudo mkdir /usr/local/share/sigrok-firmware
	43
	44	$ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
	45	/usr/local/share/sigrok-firmware
	46
	47	The sigrok frontends (command-line or GUI) will automatically search for
	48	firmware files there and automatically use/upload them.
	49
	50
	51	Website
	52	-------
	53
	54	See the fx2lafw website for further information:
	55
	56	http://sigrok.org/wiki/Fx2lafw
	57