[sigrok-firmware-fx2lafw.git] / README

-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------

The sigrok project aims at creating a portable, cross-platform,
Free/Libre/Open-Source signal analysis software suite that supports various
device types (such as logic analyzers, oscilloscopes, multimeters, and more).

sigrok-firmware-fx2lafw is a Free/Libre/Open-source firmware for logic
analyzers based on the Cypress EZ-USB FX2(LP) chip, as well as the
Hantek 6022BE and Sainsmart DDS120 USB oscilloscopes.


Status
------

sigrok-firmware-fx2lafw is in a usable state and has had official
tarball releases.


Requirements
------------

 - git
 - make
 - autoconf >= 2.63
 - automake >= 1.11
 - sdcc (>= 2.9.0)

Notes:

 - In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0).
   On Debian you can install it via:

     $ apt-get install sdcc

   This project has been tested to work with sdcc 2.9 and 3.x.


Building and installing
-----------------------

In order to get the sigrok-firmware-fx2lafw source code and build it, run:

 $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
 $ cd sigrok-firmware-fx2lafw
 $ ./autogen.sh
 $ ./configure
 $ make

For installing sigrok-firmware-fx2lafw:

 $ make install

The generated *.fw files are installed into /usr/local/share/sigrok-firmware.

You can override the install location like this:

 $ ./configure --prefix=/usr

See INSTALL or the following wiki page for more (OS-specific) instructions:

 http://sigrok.org/wiki/Building


Pre-built firmware files
------------------------

There are also pre-built firmware files that can be used without having
to build them from source. You can download those from:

  http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/


fx2lib
------

The fx2lafw code uses a (slightly modified) "fx2lib" helper library.

It was imported into fx2lafw from

  git://github.com/ubixum/fx2lib.git

as of Feb 12, 2012 (git hash "416c104cbd").

The following files/directories were removed, as they're not needed
for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.


Hantek 6022BE firmware
----------------------

The Hantek 6022BE firmware was originally created by Jochen Hoenicke in
05/2015 for the Hantek6022API github project by Robert Cope. Full credit
for the implementation of the firmware goes to Jochen Hoenicke, thanks!

Github project:

  https://github.com/rpcope1/Hantek6022API

We've incorporated the Hantek 6022BE firmware into the sigrok-firmware-fx2lafw
repo/tarball for convenience of sigrok users. E.g. so that they can
easily get it with the other fx2lafw firmware files from distro
packages, the build scripts in sigrok-util automatically build/install
it, the sigrok Windows installers automatically ship it, the sigrok
Android APKs automatically ship it, etc. etc.

The files we've integrated into fx2lafw from Hantek6022API were taken from
the PyHT6022/HantekFirmware/custom directory of that repo, using the state
as of 03/2016 (the files were last modified in 05/2015, though).

The git hash of the last relevant commit there was:

  0498e2ab239aabb1084c19e1e24faf56764b217e

Files integrated into fx2lafw:

 - hw/hantek-6022be/dscr.a51: Copied unmodified.

 - hantek_6022be.c: This file was originally created by appending the
   contents of the original device.c and fw.c together.


Sainsmart DDS120 firmware
-------------------------

The Sainsmart DDS120 firmware is heavily based upon the original Hantek 6022BE
firmware, so the items mentioned above apply here as well.


Copyright and license
---------------------

sigrok-firmware-fx2lafw is licensed under the terms of the GNU General Public
License (GPL), version 2 or later.

It uses additional helper code (fx2lib, Hantek 6022BE, and Sainsmart DDS120
firmware), licensed under the GNU LGPL (version 2.1 or later).

While some individual source code files are licensed under the LGPLv2.1+, and
some files are licensed under the GPLv2+, this doesn't change the fact that
the firmware as a whole is licensed under the terms of the GPLv2+.

Please see the individual source files for the full list of copyright holders.


Mailing list
------------

 https://lists.sourceforge.net/lists/listinfo/sigrok-devel


IRC
---

You can find the sigrok developers in the #sigrok IRC channel on Freenode.


Website
-------

 http://sigrok.org/wiki/Fx2lafw
Commit	Line	Data
	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 (>= 2.9.0)
	29
	30	Notes:
	31
	32	- In order to build fx2lafw you need the 'sdcc' compiler (>= 2.9.0).
	33	On Debian you can install it via:
	34
	35	$ apt-get install sdcc
	36
	37	This project has been tested to work with sdcc 2.9 and 3.x.
	38
	39
	40	Building and installing
	41	-----------------------
	42
	43	In order to get the sigrok-firmware-fx2lafw source code and build it, run:
	44
	45	$ git clone git://sigrok.org/sigrok-firmware-fx2lafw
	46	$ cd sigrok-firmware-fx2lafw
	47	$ ./autogen.sh
	48	$ ./configure
	49	$ make
	50
	51	For installing sigrok-firmware-fx2lafw:
	52
	53	$ make install
	54
	55	The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
	56
	57	You can override the install location like this:
	58
	59	$ ./configure --prefix=/usr
	60
	61	See INSTALL or the following wiki page for more (OS-specific) instructions:
	62
	63	http://sigrok.org/wiki/Building
	64
	65
	66	Pre-built firmware files
	67	------------------------
	68
	69	There are also pre-built firmware files that can be used without having
	70	to build them from source. You can download those from:
	71
	72	http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/
	73
	74
	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
	89
	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
	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
	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
	137	It uses additional helper code (fx2lib, Hantek 6022BE, and Sainsmart DDS120
	138	firmware), licensed under the GNU LGPL (version 2.1 or later).
	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
	147	Mailing list
	148	------------
	149
	150	https://lists.sourceforge.net/lists/listinfo/sigrok-devel
	151
	152
	153	IRC
	154	---
	155
	156	You can find the sigrok developers in the #sigrok IRC channel on Freenode.
	157
	158
	159	Website
	160	-------
	161
	162	http://sigrok.org/wiki/Fx2lafw
	163