[dv] Add more documentation to the sw_type_e

Signed-off-by: Douglas Reis <[email protected]>

Author: engdoreis

hw/top_darjeeling/dv/env/chip_env_pkg.sv

@@ -102,8 +102,10 @@ package chip_env_pkg;
     SpiDeviceIngressMem
   } chip_mem_e;
 
-  // On OpenTitan, we deal with 4 types of SW - ROM, the main test, the OTBN test and the OTP image.
+  // On Darjeeling, we deal with 8 types of SW.
   // This basically puts these SW types into 'slots' that the external regression tool can set.
+  // Note: This enum must be consistent across tops.
+  // Note: If this enum is updated, then also update the file `build_sw_collateral_for_sim.py`.
   typedef enum {
     SwTypeRom       = 0, // Ibex SW - first stage boot ROM.
     SwTypeTestSlotA = 1, // Ibex SW - test SW in (flash) slot A.

hw/top_earlgrey/dv/env/chip_env_pkg.sv

@@ -100,8 +100,10 @@ package chip_env_pkg;
     Rom
   } chip_mem_e;
 
-  // On OpenTitan, we deal with 4 types of SW - ROM, the main test, the OTBN test and the OTP image.
+  // On Earlgrey, we deal with 6 types of SW.
   // This basically puts these SW types into 'slots' that the external regression tool can set.
+  // Note: This enum must be consistent across tops.
+  // Note: If this enum is updated, then also update the file `build_sw_collateral_for_sim.py`.
   typedef enum {
     SwTypeRom       = 0, // Ibex SW - first stage boot ROM.
     SwTypeTestSlotA = 1, // Ibex SW - test SW in (flash) slot A.

util/py/scripts/build_sw_collateral_for_sim.py

@@ -134,6 +134,8 @@
     "dont_filter",
 ]
 
+""" This enum should match the enum in `hw/top_<>/dv/env/chip_env_pkg.sv`. """
+
 
 class sw_type_e(Enum):
     SwTypeROM = 0  # Ibex SW - first stage boot ROM.
@@ -541,5 +543,6 @@ def _int_or_str(value):
 
     _deploy_software_collateral(args)
 
+
 if __name__ == "__main__":
     sys.exit(_main())