GPL headers: Use correct project name.

[sigrok-firmware-fx2lafw.git] / include / fx2lafw.h

diff --git a/include/fx2lafw.h b/include/fx2lafw.h
index b990e4e6b7aa3a22592df6d47e2dc553b4bae8ac..6706b2c71f59c822605c33d2f3365a364e1e96be 100644 (file)
--- a/include/fx2lafw.h
+++ b/include/fx2lafw.h
@@ -1,5 +1,5 @@
 /*
- * This file is part of the fx2lafw project.
+ * This file is part of the sigrok-firmware-fx2lafw project.
  *
  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
  *
@@ -18,9 +18,26 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+#ifndef FX2LAFW_INCLUDE_FX2LAFW_H
+#define FX2LAFW_INCLUDE_FX2LAFW_H
+
 #include <autovector.h>
 
 #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
+
+#endif