Cosmetics, update docs.

diff --git a/README b/README
index fd9dc2531f7d7585cfa65f197614d37aad5c9121..a724b02d7c6cc2db361890e749a294406daff59f 100644 (file)
--- a/README
+++ b/README
@@ -5,17 +5,20 @@ fx2lafw
 fx2lafw is a free/libre/open-source firmware for logic analyzers based on
 the Cypress EZ-USB FX2(LP) chip.
 
-It is licensed under the terms of the GNU GPL (version 2 or later).
+It is licensed under the terms of the GNU GPL (version 2 or later), and uses
+additional helper code licensed under the GNU LGPL (version 2.1 or later).
 
 
 Requirements
 ------------
 
-In order to build fx2lafw you need the 'sdcc' compiler.
+ - In order to build fx2lafw you need the 'sdcc' compiler.
+   On Debian you can install it via:
 
-On Debian you can install it via:
+     $ apt-get install sdcc
 
-  $ apt-get install sdcc
+ - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
+   versions didn't have support for FX2 devices using this firmware.
 
 
 Building

diff --git a/fx2lafw.c b/fx2lafw.c
index 7fe952843a6c165ef33d6ccd363bf95b77a8c719..e376443a3d527b45fc1629a7f3d829fb813f12e8 100644 (file)
--- a/fx2lafw.c
+++ b/fx2lafw.c
@@ -28,10 +28,9 @@
  *
  *  - We use the FX2 in GPIF mode to sample the data (asynchronously).
  *  - We use the internal 48MHz clock for GPIF.
- *  - The 8 channels/pins we sample (the GPIF data bus) are PB0-PB7.
- *    Support for 16 channels is not yet included, but might be added later.
- *  - Endpoint 2 is used for data transfers from FX2 to host.
- *  - The endpoint is quad-buffered.
+ *  - The 8 channels/pins we sample (the GPIF data bus) are PB0-PB7,
+ *    or PB0-PB7 + PD0-PD7 for 16-channel sampling. 
+ *  - Endpoint 2 (quad-buffered) is used for data transfers from FX2 to host.
  *
  * Documentation:
  *
@@ -44,7 +43,6 @@
 #include <setupdat.h>
 #include <eputils.h>
 #include <gpif.h>
-
 #include <command.h>
 #include <fx2lafw.h>
 #include <gpif-acquisition.h>
@@ -157,7 +155,7 @@ BOOL handle_set_interface(BYTE ifc, BYTE alt_ifc)
        /* We only support interface 0, alternate interface 0. */
        if (ifc != 0 || alt_ifc != 0)
                return FALSE;
-       
+
        /* Perform procedure from TRM, section 2.3.7: */
 
        /* (1) TODO. */

diff --git a/gpif-acquisition.c b/gpif-acquisition.c
index 4878b513937a98b6f7d5ad4517df8ecfc03e7e00..39e62e582deb997939dd652cdf1763ce76dc4b14 100644 (file)
--- a/gpif-acquisition.c
+++ b/gpif-acquisition.c
@@ -71,7 +71,7 @@ static void gpif_setup_registers(void)
        /* Contains RDY* pin values. Read-only according to TRM. */
        GPIFREADYSTAT = 0;
 
-       /* Make GPIF stop on transcation count not flag */
+       /* Make GPIF stop on transaction count not flag. */
        EP2GPIFPFSTOP = (0 << 0);
 }
 
@@ -128,7 +128,7 @@ void gpif_init_la(void)
        /* Initialize flowstate registers (not used by us). */
        gpif_init_flowstates();
 
-       /* Reset the status */
+       /* Reset the status. */
        gpif_acquiring = FALSE;
 }
 

diff --git a/hw/braintechnology-usb-lps/Makefile b/hw/braintechnology-usb-lps/Makefile
index 759c309686c3415600c26161dcebe60f420b122f..bfc0aeccd6e196bf1ec2fb856396ca84d746f7a9 100644 (file)
--- a/hw/braintechnology-usb-lps/Makefile
+++ b/hw/braintechnology-usb-lps/Makefile
@@ -18,9 +18,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-SOURCES = \
-       ../../fx2lafw.c \
-       ../../gpif-acquisition.c
+SOURCES = ../../fx2lafw.c ../../gpif-acquisition.c
 A51_SOURCES = dscr.a51
 BASENAME = fx2lafw-braintechnology-usb-lps
 

diff --git a/hw/cwav-usbeeax/Makefile b/hw/cwav-usbeeax/Makefile
index d0faa468d60cd9567c05dc291945191678dc80dc..2159f60741c29b850f80dcc9e087fd0f60f02ac5 100644 (file)
--- a/hw/cwav-usbeeax/Makefile
+++ b/hw/cwav-usbeeax/Makefile
@@ -18,9 +18,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-SOURCES = \
-       ../../fx2lafw.c \
-       ../../gpif-acquisition.c
+SOURCES = ../../fx2lafw.c ../../gpif-acquisition.c
 A51_SOURCES = dscr.a51
 BASENAME = fx2lafw-cwav-usbeeax
 

diff --git a/hw/cwav-usbeesx/Makefile b/hw/cwav-usbeesx/Makefile
index d5713a478ade68d2e78186536744f0178d6f0d18..391282662d2347301310dce5c7795417ee405b25 100644 (file)
--- a/hw/cwav-usbeesx/Makefile
+++ b/hw/cwav-usbeesx/Makefile
@@ -19,9 +19,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-SOURCES = \
-       ../../fx2lafw.c \
-       ../../gpif-acquisition.c
+SOURCES = ../../fx2lafw.c ../../gpif-acquisition.c
 A51_SOURCES = dscr.a51
 BASENAME = fx2lafw-cwav-usbeesx
 

diff --git a/hw/cypress-fx2/Makefile b/hw/cypress-fx2/Makefile
index 87d221960cedba4449609e994a1d022e3e3f0a07..78e2308c665595156bf954b605fd7eefe9f97dc9 100644 (file)
--- a/hw/cypress-fx2/Makefile
+++ b/hw/cypress-fx2/Makefile
@@ -18,9 +18,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-SOURCES = \
-       ../../fx2lafw.c \
-       ../../gpif-acquisition.c
+SOURCES = ../../fx2lafw.c ../../gpif-acquisition.c
 A51_SOURCES = dscr.a51
 BASENAME = fx2lafw-cypress-fx2
 

diff --git a/hw/cypress-fx2/dscr.a51 b/hw/cypress-fx2/dscr.a51
index 540642a46d0a9d938917a7202d188953fbc7f98c..a4a6e908336fd30420f2e1778b811578190988fd 100644 (file)
--- a/hw/cypress-fx2/dscr.a51
+++ b/hw/cypress-fx2/dscr.a51
@@ -19,7 +19,7 @@
 ;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ;;
 
-VID = 0xB404   ; Manufacturer ID (0x04B4)
+VID = 0xb404   ; Manufacturer ID (0x04b4)
 PID = 0x1386   ; Product ID (0x8613)
 
 .include "../../../include/dscr.inc"

diff --git a/hw/saleae-logic/Makefile b/hw/saleae-logic/Makefile
index f1e239d32a4c577d506ce708724331cb47367757..340ab87b34c80041b31dad9b0d1a221058db4267 100644 (file)
--- a/hw/saleae-logic/Makefile
+++ b/hw/saleae-logic/Makefile
@@ -18,9 +18,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-SOURCES = \
-       ../../fx2lafw.c \
-       ../../gpif-acquisition.c
+SOURCES = ../../fx2lafw.c ../../gpif-acquisition.c
 A51_SOURCES = dscr.a51
 BASENAME = fx2lafw-saleae-logic
 

diff --git a/include/fx2lafw.h b/include/fx2lafw.h
index 3f69361cafe6969913005beaf059a6b9fdc5855c..5a66de86442e7db729abdbab3f363fd935a4e814 100644 (file)
--- a/include/fx2lafw.h
+++ b/include/fx2lafw.h
@@ -25,6 +25,18 @@
 
 #define SYNCDELAY() SYNCDELAY4
 
+/*
+ * Major and minor fx2lafw firmware version numbers.
+ * These can be queried by the host via CMD_GET_FW_VERSION.
+ *
+ * The minor version number must be increased every time there are
+ * backwards-compatible changes (which do not change the API).
+ *
+ * The major version number must be increased every time there are API
+ * changes or functional changes which require adaptations in the host
+ * (libsigrok) drivers, i.e. changes where old libsigrok versions would no
+ * longer (properly) work with the new fx2lafw firmware.
+ */
 #define FX2LAFW_VERSION_MAJOR  1
 #define FX2LAFW_VERSION_MINOR  0
 

diff --git a/include/gpif-acquisition.h b/include/gpif-acquisition.h
index ff6ecf5790850a2788488508e05bc2940a7e746e..8787cf9122b83e6cfff7eaf18045c095e5e3b29d 100644 (file)
--- a/include/gpif-acquisition.h
+++ b/include/gpif-acquisition.h
@@ -22,13 +22,10 @@
 #define FX2LAFW_GPIF_ACQUISITION_H
 
 #include <stdbool.h>
-
 #include <command.h>
 
 void gpif_init_la(void);
-
 bool gpif_acquisition_start(const struct cmd_start_acquisition *cmd);
-
 void gpif_poll(void);
 
 #endif