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