Fix #include guard names.

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

diff --git a/include/fx2lafw.h b/include/fx2lafw.h
index 3f69361cafe6969913005beaf059a6b9fdc5855c..c0f8db645c414a9107d4573455609bec307b5b88 100644 (file)
--- a/include/fx2lafw.h
+++ b/include/fx2lafw.h
@@ -18,13 +18,25 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#ifndef FX2LAFW_FX2LAFW_H
-#define FX2LAFW_FX2LAFW_H
+#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