projects / sigrok-firmware-fx2lafw.git / blame
| 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 | ||
| c7e02d8c UH |
27 | - In order to build fx2lafw you need the 'sdcc' compiler. |
| 28 | On Debian you can install it via: | |
| d5f5ea73 | 29 | |
| c7e02d8c | 30 | $ apt-get install sdcc |
| d5f5ea73 | 31 | |
| c7e02d8c UH |
32 | - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier |
| 33 | versions didn't have support for FX2 devices using this firmware. | |
| d5f5ea73 | 34 | |
| d5f5ea73 | 35 | |
| a75447f1 UH |
36 | Building and installing |
| 37 | ----------------------- | |
| d5f5ea73 | 38 | |
| a75447f1 | 39 | In order to get the sigrok-firmware-fx2lafw source code and build it, run: |
| d5f5ea73 | 40 | |
| a75447f1 UH |
41 | $ git clone git://sigrok.org/sigrok-firmware-fx2lafw |
| 42 | $ cd sigrok-firmware-fx2lafw | |
| 43 | $ make | |
| 8b13135e | 44 | |
| a75447f1 | 45 | For installing sigrok-firmware-fx2lafw: |
| 8b13135e | 46 | |
| a75447f1 | 47 | $ make install |
| 8b13135e | 48 | |
| de1a2178 | 49 | The generated *.fw files are installed into /usr/local/share/sigrok-firmware. |
| d5f5ea73 | 50 | |
| de1a2178 | 51 | You can override the install location like this: |
| d5f5ea73 | 52 | |
| a75447f1 UH |
53 | $ make install DESTDIR=/usr/share/sigrok-firmware |
| 54 | ||
| 55 | Please see the following wiki pages for more detailed instructions: | |
| 56 | ||
| 57 | http://sigrok.org/wiki/Linux | |
| 58 | http://sigrok.org/wiki/Mac_OS_X | |
| 59 | http://sigrok.org/wiki/Windows | |
| 60 | http://sigrok.org/wiki/FreeBSD | |
| 94ca1bed UH |
61 | |
| 62 | ||
| 63 | fx2lib | |
| 64 | ------ | |
| 65 | ||
| 66 | The fx2lafw code uses a (slightly modified) "fx2lib" helper library. | |
| 67 | ||
| 68 | It was imported into fx2lafw from | |
| 69 | ||
| 70 | git://github.com/ubixum/fx2lib.git | |
| 71 | ||
| 72 | as of Feb 12, 2012 (git hash "416c104cbd"). | |
| 73 | ||
| 74 | The following files/directories were removed, as they're not needed | |
| 75 | for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/. | |
| 76 | ||
| 91f1e17f | 77 | |
| a75447f1 UH |
78 | Mailing lists |
| 79 | ------------- | |
| 80 | ||
| 81 | There are two mailing lists for sigrok/sigrok-firmware-fx2lafw: | |
| 82 | ||
| 83 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
| 84 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
| 85 | ||
| 86 | ||
| 87 | IRC | |
| 88 | --- | |
| 89 | ||
| 90 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
| 91 | ||
| 92 | ||
| d5f5ea73 UH |
93 | Website |
| 94 | ------- | |
| 95 | ||
| a75447f1 | 96 | http://sigrok.org/wiki/Fx2lafw |
| d5f5ea73 | 97 |