README

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