X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Ffx2lafw.h;h=5a66de86442e7db729abdbab3f363fd935a4e814;hb=c7e02d8c24b6f89a274b33300dd47925f5ffb69f;hp=b990e4e6b7aa3a22592df6d47e2dc553b4bae8ac;hpb=18544912fb14f1beb10fe375aad9743a8e8df790;p=sigrok-firmware-fx2lafw.git

diff --git a/include/fx2lafw.h b/include/fx2lafw.h
index b990e4e6..5a66de86 100644
--- a/include/fx2lafw.h
+++ b/include/fx2lafw.h
@@ -18,9 +18,26 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+#ifndef FX2LAFW_FX2LAFW_H
+#define FX2LAFW_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