[fpga] Enforce CW310 SAM3X Firmware

As CW310 SAM3X firmware version below "1.5" have an UART flow control
bug, enforce that the version is at leaset "1.5". This ensures that
the communication over uJSON works flawless.

Signed-off-by: Pascal Nasahl <nasahlpa@lowrisc.org>

Author: nasahlpa

capture/capture_aes.py

@@ -106,6 +106,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init scope.
     scope_type = cfg["capture"]["scope_select"]
 

capture/capture_hmac.py

@@ -106,6 +106,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init scope.
     scope_type = cfg["capture"]["scope_select"]
 

capture/capture_ibex.py

@@ -94,6 +94,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init scope.
     scope_type = cfg["capture"]["scope_select"]
 

capture/capture_kmac.py

@@ -110,6 +110,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init scope.
     scope_type = cfg["capture"]["scope_select"]
 

capture/capture_otbn.py

@@ -120,6 +120,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init scope.
     scope_type = cfg["capture"]["scope_select"]
 

capture/capture_sha3.py

@@ -95,6 +95,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init scope.
     scope_type = cfg["capture"]["scope_select"]
 

fault_injection/fi_crypto.py

@@ -52,6 +52,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init FI gear.
     fi_gear = FIGear(cfg)
 

fault_injection/fi_ibex.py

@@ -52,6 +52,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init FI gear.
     fi_gear = FIGear(cfg)
 

fault_injection/fi_otbn.py

@@ -52,6 +52,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init FI gear.
     fi_gear = FIGear(cfg)
 

fault_injection/fi_rng.py

@@ -52,6 +52,9 @@ def setup(cfg: dict, project: Path):
     )
     target = Target(target_cfg)
 
+    # Check target firmware.
+    target.check_fw_version("1.5")
+
     # Init FI gear.
     fi_gear = FIGear(cfg)
 

target/cw_fpga.py

@@ -224,3 +224,14 @@ def reset_target(self):
             io.pin_set_state("USB_A14", 1)
             # Add a small delay to allow OpenTitan to boot up.
             time.sleep(0.1)
+
+    def check_fw_version(self, min_version: str):
+        """Checks whether the SAM3X CW310 FW matches the expected version. """
+        major_min, minor_min = min_version.split(".")
+        fw = self.target.target.latest_fw()
+        if fw["major"] < int(major_min) or fw["minor"] < int(minor_min):
+            print(f'Error: CW310 SAM3X FW is {str(fw["major"])}.{str(fw["minor"])}'
+                  f'should be {min_version}. Check the CW310 manual for updating the firmware.')
+            return False
+        else:
+            return True

target/targets.py

@@ -126,3 +126,9 @@ def is_done(self):
             return self.target.target.is_done()
         else:
             return True
+
+    def check_fw_version(self, min_version: str):
+        """Check if target CW is >= min:version. Only for CW310 FPGA."""
+        if self.target_cfg.target_type == "cw310":
+            if not self.target.check_fw_version(min_version):
+                raise RuntimeError("Error: Please upgrade target firmware!")