[fpga] Enforce CW310 SAM3X Firmware

nasahlpa · nasahlpa · commit a196d0070f0d · 2024-12-05T10:39:07.000+01:00
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 &lt;nasahlpa@lowrisc.org&gt;
diff --git a/capture/capture_aes.py b/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"]
 
diff --git a/capture/capture_hmac.py b/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"]
 
diff --git a/capture/capture_ibex.py b/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"]
 
diff --git a/capture/capture_kmac.py b/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"]
 
diff --git a/capture/capture_otbn.py b/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"]
 
diff --git a/capture/capture_sha3.py b/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"]
 
diff --git a/fault_injection/fi_crypto.py b/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)
 
diff --git a/fault_injection/fi_ibex.py b/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)
 
diff --git a/fault_injection/fi_otbn.py b/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)
 
diff --git a/fault_injection/fi_rng.py b/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)
 
diff --git a/target/cw_fpga.py b/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
diff --git a/target/targets.py b/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!")

Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,9 @@ def setup(cfg: dict, project: Path):`
`106`	`106`	`)`
`107`	`107`	`target = Target(target_cfg)`
`108`	`108`
	`109`	`+ # Check target firmware.`
	`110`	`+ target.check_fw_version("1.5")`
	`111`	`+`
`109`	`112`	`# Init scope.`
`110`	`113`	`scope_type = cfg["capture"]["scope_select"]`
`111`	`114`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,9 @@ def setup(cfg: dict, project: Path):`
`94`	`94`	`)`
`95`	`95`	`target = Target(target_cfg)`
`96`	`96`
	`97`	`+ # Check target firmware.`
	`98`	`+ target.check_fw_version("1.5")`
	`99`	`+`
`97`	`100`	`# Init scope.`
`98`	`101`	`scope_type = cfg["capture"]["scope_select"]`
`99`	`102`
Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,9 @@ def setup(cfg: dict, project: Path):`
`110`	`110`	`)`
`111`	`111`	`target = Target(target_cfg)`
`112`	`112`
	`113`	`+ # Check target firmware.`
	`114`	`+ target.check_fw_version("1.5")`
	`115`	`+`
`113`	`116`	`# Init scope.`
`114`	`117`	`scope_type = cfg["capture"]["scope_select"]`
`115`	`118`
Original file line number	Diff line number	Diff line change
`@@ -120,6 +120,9 @@ def setup(cfg: dict, project: Path):`
`120`	`120`	`)`
`121`	`121`	`target = Target(target_cfg)`
`122`	`122`
	`123`	`+ # Check target firmware.`
	`124`	`+ target.check_fw_version("1.5")`
	`125`	`+`
`123`	`126`	`# Init scope.`
`124`	`127`	`scope_type = cfg["capture"]["scope_select"]`
`125`	`128`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,9 @@ def setup(cfg: dict, project: Path):`
`95`	`95`	`)`
`96`	`96`	`target = Target(target_cfg)`
`97`	`97`
	`98`	`+ # Check target firmware.`
	`99`	`+ target.check_fw_version("1.5")`
	`100`	`+`
`98`	`101`	`# Init scope.`
`99`	`102`	`scope_type = cfg["capture"]["scope_select"]`
`100`	`103`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,9 @@ def setup(cfg: dict, project: Path):`
`52`	`52`	`)`
`53`	`53`	`target = Target(target_cfg)`
`54`	`54`
	`55`	`+ # Check target firmware.`
	`56`	`+ target.check_fw_version("1.5")`
	`57`	`+`
`55`	`58`	`# Init FI gear.`
`56`	`59`	`fi_gear = FIGear(cfg)`
`57`	`60`