[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 (fx2lib), 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


Installation
------------

  $ sudo make install

The generated *.fw files are installed into /usr/local/share/sigrok-firmware.

You can override the install location like this:

  $ sudo make install DESTDIR=/usr/share/sigrok-firmware


fx2lib
------

The fx2lafw code uses a (slightly modified) "fx2lib" helper library.

It was imported into fx2lafw from

  git://github.com/ubixum/fx2lib.git

as of Feb 12, 2012 (git hash "416c104cbd").

The following files/directories were removed, as they're not needed
for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.


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 (fx2lib), licensed under the GNU LGPL (version 2.1
	10	or later).
	11
	12
	13	Requirements
	14	------------
	15
	16	- In order to build fx2lafw you need the 'sdcc' compiler.
	17	On Debian you can install it via:
	18
	19	$ apt-get install sdcc
	20
	21	- You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
	22	versions didn't have support for FX2 devices using this firmware.
	23
	24
	25	Building
	26	--------
	27
	28	$ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
	29	$ cd fx2lafw
	30	$ make
	31
	32
	33	Installation
	34	------------
	35
	36	$ sudo make install
	37
	38	The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
	39
	40	You can override the install location like this:
	41
	42	$ sudo make install DESTDIR=/usr/share/sigrok-firmware
	43
	44
	45	fx2lib
	46	------
	47
	48	The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
	49
	50	It was imported into fx2lafw from
	51
	52	git://github.com/ubixum/fx2lib.git
	53
	54	as of Feb 12, 2012 (git hash "416c104cbd").
	55
	56	The following files/directories were removed, as they're not needed
	57	for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
	58
	59
	60	Website
	61	-------
	62
	63	See the fx2lafw website for further information:
	64
	65	http://sigrok.org/wiki/Fx2lafw
	66