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