Merge pull request #464 from open-ephys/issue-447

Add version check for onix gateware v2.x

Author: aacuevas

OpenEphys.Onix1/ContextTask.cs

@@ -94,6 +94,13 @@ internal ContextTask(string driver, int index)
             contextIndex = index;
             ctx = new oni.Context(contextDriver, contextIndex);
             Initialize();
+            var (major, _) = GenericHelper.GetFirmwareVersionComponents(GetHub(0).FirmwareVersion);
+            if (major != 2)
+            {
+                throw new NotSupportedException("This library requires version 2.x of the ONIX firmware. "
+                    + "Please perform a firmware update to use this library. Instructions can be found at "
+                    + "https://open-ephys.github.io/onix-docs/Hardware%20Guide/PCIe%20Host/updating-firmware.html");
+            }
         }
 
         private void Initialize()

OpenEphys.Onix1/GenericHelper.cs

@@ -6,5 +6,15 @@ public static uint GetHubAddressFromDeviceAddress(uint deviceAddress)
         {
             return (deviceAddress & 0xFF00u);
         }
+
+        /// <summary>
+        /// Gets 8-bit version components from a 16-bit version register value
+        /// </summary>
+        /// <param name="version">Register value containing a 16-bit firmware version number.</param>
+        /// <returns> A tuple containing the 8-bit major and minor version components.</returns>
+        internal static (byte major, byte minor) GetFirmwareVersionComponents(uint version)
+        {
+            return ((byte)((version >> 8) & 0xFF), (byte)(version & 0xFF));
+        }
     }
 }