]>
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 | ||
bf4dba5d | 9 | sigrok-firmware-fx2lafw is a Free/Libre/Open-source firmware for logic |
52ec81d3 UH |
10 | analyzers based on the Cypress EZ-USB FX2(LP) chip, as well as the |
11 | Hantek 6022BE USB oscilloscope. | |
d5f5ea73 | 12 | |
8b13135e | 13 | |
a75447f1 UH |
14 | Status |
15 | ------ | |
16 | ||
17 | sigrok-firmware-fx2lafw is in a usable state and has had official | |
18 | tarball releases. | |
19 | ||
20 | ||
d5f5ea73 UH |
21 | Requirements |
22 | ------------ | |
23 | ||
92c99f68 UH |
24 | - git |
25 | - make | |
26 | - autoconf >= 2.63 | |
27 | - automake >= 1.11 | |
28 | - sdcc (>= 2.9.0) | |
29 | ||
30 | Notes: | |
31 | ||
32 | - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0). | |
c7e02d8c | 33 | On Debian you can install it via: |
d5f5ea73 | 34 | |
c7e02d8c | 35 | $ apt-get install sdcc |
d5f5ea73 | 36 | |
b27c7431 | 37 | This project has been tested to work with sdcc 2.9 and 3.x. |
36074319 | 38 | |
c7e02d8c UH |
39 | - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier |
40 | versions didn't have support for FX2 devices using this firmware. | |
d5f5ea73 | 41 | |
d5f5ea73 | 42 | |
a75447f1 UH |
43 | Building and installing |
44 | ----------------------- | |
d5f5ea73 | 45 | |
a75447f1 | 46 | In order to get the sigrok-firmware-fx2lafw source code and build it, run: |
d5f5ea73 | 47 | |
a75447f1 UH |
48 | $ git clone git://sigrok.org/sigrok-firmware-fx2lafw |
49 | $ cd sigrok-firmware-fx2lafw | |
36074319 UH |
50 | $ ./autogen.sh |
51 | $ ./configure | |
a75447f1 | 52 | $ make |
8b13135e | 53 | |
a75447f1 | 54 | For installing sigrok-firmware-fx2lafw: |
8b13135e | 55 | |
a75447f1 | 56 | $ make install |
8b13135e | 57 | |
de1a2178 | 58 | The generated *.fw files are installed into /usr/local/share/sigrok-firmware. |
d5f5ea73 | 59 | |
de1a2178 | 60 | You can override the install location like this: |
d5f5ea73 | 61 | |
36074319 | 62 | $ ./configure --prefix=/usr |
a75447f1 | 63 | |
a123aff7 | 64 | See INSTALL or the following wiki page for more (OS-specific) instructions: |
a75447f1 | 65 | |
a123aff7 | 66 | http://sigrok.org/wiki/Building |
94ca1bed UH |
67 | |
68 | ||
c610cc7e UH |
69 | Pre-built firmware files |
70 | ------------------------ | |
71 | ||
72 | There are also pre-built firmware files that can be used without having | |
05f43695 | 73 | to build them from source. You can download those from: |
c610cc7e | 74 | |
05f43695 | 75 | http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/ |
c610cc7e UH |
76 | |
77 | ||
94ca1bed UH |
78 | fx2lib |
79 | ------ | |
80 | ||
81 | The fx2lafw code uses a (slightly modified) "fx2lib" helper library. | |
82 | ||
83 | It was imported into fx2lafw from | |
84 | ||
85 | git://github.com/ubixum/fx2lib.git | |
86 | ||
87 | as of Feb 12, 2012 (git hash "416c104cbd"). | |
88 | ||
89 | The following files/directories were removed, as they're not needed | |
90 | for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/. | |
91 | ||
91f1e17f | 92 | |
52ec81d3 UH |
93 | Hantek 6022BE firmware |
94 | ---------------------- | |
95 | ||
96 | The Hantek 6022BE firmware was originally created by Jochen Hoenicke in | |
97 | 05/2015 for the Hantek6022API github project by Robert Cope. Full credit | |
98 | for the implementation of the firmware goes to Jochen Hoenicke, thanks! | |
99 | ||
100 | Github project: | |
101 | ||
102 | https://github.com/rpcope1/Hantek6022API | |
103 | ||
104 | We've incorporated the Hantek 6022BE firmware into the sigrok-firmware-fx2lafw | |
105 | repo/tarball for convenience of sigrok users. E.g. so that they can | |
106 | easily get it with the other fx2lafw firmware files from distro | |
107 | packages, the build scripts in sigrok-util automatically build/install | |
108 | it, the sigrok Windows installers automatically ship it, the sigrok | |
109 | Android APKs automatically ship it, etc. etc. | |
110 | ||
111 | The files we've integrated into fx2lafw from Hantek6022API were taken from | |
112 | the PyHT6022/HantekFirmware/custom directory of that repo, using the state | |
113 | as of 03/2016 (the files were last modified in 05/2015, though). | |
114 | ||
115 | The git hash of the last relevant commit there was: | |
116 | ||
117 | 0498e2ab239aabb1084c19e1e24faf56764b217e | |
118 | ||
119 | Files integrated into fx2lafw: | |
120 | ||
121 | - hw/hantek-6022be/dscr.a51: Copied unmodified. | |
122 | ||
123 | - hantek_6022be.c: This file was originally created by appending the | |
124 | contents of the original device.c and fw.c together. | |
125 | ||
126 | ||
bf4dba5d UH |
127 | Copyright and license |
128 | --------------------- | |
129 | ||
130 | sigrok-firmware-fx2lafw is licensed under the terms of the GNU General Public | |
131 | License (GPL), version 2 or later. | |
132 | ||
52ec81d3 UH |
133 | It uses additional helper code (fx2lib, Hantek 6022BE firmware), licensed |
134 | under the GNU LGPL (version 2.1 or later). | |
bf4dba5d UH |
135 | |
136 | While some individual source code files are licensed under the LGPLv2.1+, and | |
137 | some files are licensed under the GPLv2+, this doesn't change the fact that | |
138 | the firmware as a whole is licensed under the terms of the GPLv2+. | |
139 | ||
140 | Please see the individual source files for the full list of copyright holders. | |
141 | ||
142 | ||
70b415b6 UH |
143 | Mailing list |
144 | ------------ | |
a75447f1 UH |
145 | |
146 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
a75447f1 UH |
147 | |
148 | ||
149 | IRC | |
150 | --- | |
151 | ||
152 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
153 | ||
154 | ||
d5f5ea73 UH |
155 | Website |
156 | ------- | |
157 | ||
a75447f1 | 158 | http://sigrok.org/wiki/Fx2lafw |
d5f5ea73 | 159 |