]> sigrok.org Git - sigrok-firmware-fx2lafw.git/blame - README
Drop fx2lib files we don't really need.
[sigrok-firmware-fx2lafw.git] / README
CommitLineData
d5f5ea73
UH
1------------------------------------------------------------------------------
2fx2lafw
3------------------------------------------------------------------------------
4
5fx2lafw is a free/libre/open-source firmware for logic analyzers based on
6the Cypress EZ-USB FX2(LP) chip.
7
c7e02d8c 8It is licensed under the terms of the GNU GPL (version 2 or later), and uses
94ca1bed
UH
9additional helper code (fx2lib), licensed under the GNU LGPL (version 2.1
10or later).
d5f5ea73 11
8b13135e 12
d5f5ea73
UH
13Requirements
14------------
15
c7e02d8c
UH
16 - In order to build fx2lafw you need the 'sdcc' compiler.
17 On Debian you can install it via:
d5f5ea73 18
c7e02d8c 19 $ apt-get install sdcc
d5f5ea73 20
c7e02d8c
UH
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.
d5f5ea73 23
d5f5ea73
UH
24
25Building
26--------
27
060dc3fe 28 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/fx2lafw
d5f5ea73 29 $ cd fx2lafw
d5f5ea73
UH
30 $ make
31
8b13135e 32
d5f5ea73
UH
33Usage
34-----
35
8b13135e
UH
36Copy the generated *.fw file for your device (e.g. fx2lafw-saleae-logic.fw)
37into the $prefix/share/sigrok-firmware directory (create it, if needed).
38
39Replace $prefix with the install prefix of sigrok, e.g. /usr or /usr/local.
40
41Example (assuming /usr/local as $prefix):
42
43 $ sudo mkdir /usr/local/share/sigrok-firmware
d5f5ea73 44
8b13135e
UH
45 $ sudo cp hw/saleae-logic/build/fx2lafw-saleae-logic.fw \
46 /usr/local/share/sigrok-firmware
d5f5ea73 47
8b13135e
UH
48The sigrok frontends (command-line or GUI) will automatically search for
49firmware files there and automatically use/upload them.
94ca1bed
UH
50
51
52fx2lib
53------
54
55The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
56
57It was imported into fx2lafw from
58
59 git://github.com/ubixum/fx2lib.git
60
61as of Feb 12, 2012 (git hash "416c104cbd").
62
63The following files/directories were removed, as they're not needed
64for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
65
91f1e17f 66
d5f5ea73
UH
67Website
68-------
69
70See the fx2lafw website for further information:
71
72 http://sigrok.org/wiki/Fx2lafw
73