X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=include%2Ffx2lafw.h;h=bbc155b008500da1b161d41851d49d1ce2a0427b;hb=4c9f15c9b885f4c08ed6c49df9fd382fa4008261;hp=7d5877dd35a987193559e5fdb13eeedf7a71b337;hpb=28d52f414aea134690fba92d62b40607e55550bf;p=sigrok-firmware-fx2lafw.git

diff --git a/include/fx2lafw.h b/include/fx2lafw.h
index 7d5877dd..bbc155b0 100644
--- 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,17 +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
 
-/**
- * Performs setup common to all fx2lafw devices.
+/*
+ * 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.
  */
-void fx2lafw_init(void);
+#define FX2LAFW_VERSION_MAJOR	1
+#define FX2LAFW_VERSION_MINOR	1
 
-/**
- * Performs a single iteration of the main loop code which is common
- * to all fx2lafw devices.
- */
-void fx2lafw_poll(void);
+#endif