[keymgr_dpe, rtl, dv] Support multiple top configurations

This commit allows for a limited parametrization by the top without
having a fully templated IP. The top can define the following:

- Number of bootstages (either two or three)
- Number of ROM digest values
- Number of HW slots instanciated (up to 8 slots)

The block level dv is extended to test two different configurations,
called earlgrey and darjeeling.

Signed-off-by: Raphael Roth <rroth@lowrisc.org>

Author: rroth-lowrisc

hw/ip/keymgr_dpe/data/keymgr_dpe.hjson

@@ -228,11 +228,33 @@
       default: "1",
       local: "true"
     },
+    { name: "NumMaxHwSlot",
+      desc: '''
+        Number of maximum supported HW slots. If this value is changed then the
+        bit width in SLOT_SRC_SEL / SLOT_DST_SEL in the
+        "CONTROL_SHADOWED" register needs to be updated too.
+      ''',
+      type: "int",
+      default: "8",
+      local: "true"
+    },
+    { name: "NumInstHwSlot",
+      desc: "Number of instantiated HW slots",
+      type: "int",
+      default: "4",
+      expose:  "true"
+    },
+    { name: "NumBootStages",
+      desc: "Number of available boot stage",
+      type: "int",
+      default: "3",
+      expose:  "true"
+    },
     { name: "NumRomDigestInputs",
       desc: "Number of digest inputs from ROM_CTRL",
       type: "int",
-      default: "2",
-      local: "true"
+      default: "1",
+      expose:  "true"
     },
   ],
 

hw/ip/keymgr_dpe/dv/README.md

@@ -102,6 +102,7 @@ Here's how to run a smoke test:
 ```console
 $ dvsim $REPO_TOP/hw/ip/keymgr_dpe/dv/keymgr_dpe_sim_cfg.hjson -i keymgr_dpe_smoke
 ```
+With the configurations `keymgr_dpe_earlgrey_sim_cfg.hjson` / `keymgr_dpe_darjeeling_sim_cfg.hjson` it is possible to test the top dependent default configurations.
 
 ## Testplan
 [Testplan](../data/keymgr_dpe_testplan.hjson)

hw/ip/keymgr_dpe/dv/env/keymgr_dpe_ctrl_if.sv

@@ -10,14 +10,14 @@ interface keymgr_dpe_ctrl_if (input clk_i, input rst_ni);
   // Function to access the key of one slot via backdoor.
   // Required to load the UDS after XORing with generated randomness.
   function automatic keymgr_dpe_env_pkg::key_shares_t get_key_of_slot(int unsigned slot);
-    import keymgr_dpe_pkg::DpeNumSlots;
+    import keymgr_dpe_env_pkg::DvNumInstHwSlot;
 
-    // Check that the slot index is in range. The key_slots_q array has length DpeNumSlots, which is
-    // a global parameter.
-    if (slot >= DpeNumSlots) begin
+    // Check that the slot index is in range. The key_slots_q array has length DvNumInstHwSlot,
+    // which is a global parameter.
+    if (slot >= DvNumInstHwSlot) begin
       `uvm_error($sformatf("%m"),
-                 $sformatf("Slot index out of range: index is %0d but DpeNumSlots is %0d",
-                           slot, DpeNumSlots))
+                 $sformatf("Slot index out of range: index is %0d but DvNumInstHwSlot is %0d",
+                           slot, DvNumInstHwSlot))
       return '0;
     end
 

hw/ip/keymgr_dpe/dv/env/keymgr_dpe_env_pkg.sv

@@ -20,6 +20,39 @@ package keymgr_dpe_env_pkg;
   `include "uvm_macros.svh"
   `include "dv_macros.svh"
 
+  // Define default values for all blocklevel dv parameter
+  `ifndef DEF_DV_BOOT_STAGES
+   `define DEF_DV_BOOT_STAGES 3
+  `endif
+  `ifndef DEF_DV_DPE_NUM_SLOT
+   `define DEF_DV_DPE_NUM_SLOT 4
+  `endif
+  `ifndef DEF_DV_NUM_ROM_DIGEST
+   `define DEF_DV_NUM_ROM_DIGEST 1
+  `endif
+
+  // Avoid using defines throughout the DV code by introducing the following
+  // parameters.
+  parameter int DvBootStages = `DEF_DV_BOOT_STAGES;
+  parameter int DvNumInstHwSlot = `DEF_DV_DPE_NUM_SLOT;
+  parameter int DvNumRomDigestInputs = `DEF_DV_NUM_ROM_DIGEST;
+
+  // Advance width calculation
+  // When deriving from the UDS the following data are consumed (Not ordered):
+  //   - Software binding
+  //   - Revision seed
+  //   - OTP device ID
+  //   - LC keymgr diversification value
+  //   - ROM digests
+  //   - Creator seed (only if boot stage equals two)
+  parameter int DvDpeAdvDataWidth = keymgr_pkg::SwBindingWidth +
+      keymgr_pkg::KeyWidth + keymgr_pkg::KeyWidth * (DvBootStages == 2) +
+      lc_ctrl_pkg::LcKeymgrDivWidth + keymgr_dpe_pkg::DeviceIdWidth +
+      keymgr_pkg::KeyWidth * DvNumRomDigestInputs;
+
+  localparam int DvNumInstHwSlotWidth = prim_util_pkg::vbits(DvNumInstHwSlot);
+  typedef logic [DvNumInstHwSlotWidth-1:0] dv_keymgr_dpe_slot_idx_e;
+
   // parameters and types
   parameter uint NUM_ALERTS = 2;
   parameter string LIST_OF_ALERTS[NUM_ALERTS] = {"recov_operation_err", "fatal_fault_err"};
@@ -64,8 +97,8 @@ package keymgr_dpe_env_pkg;
   } keymgr_dpe_fault_inject_type_e;
 
   typedef struct{
-    keymgr_dpe_pkg::keymgr_dpe_slot_idx_e src_slot;
-    keymgr_dpe_pkg::keymgr_dpe_slot_idx_e dst_slot;
+    dv_keymgr_dpe_slot_idx_e src_slot;
+    dv_keymgr_dpe_slot_idx_e dst_slot;
   } keymgr_dpe_key_slot_t;
 
   string msg_id = "keymgr_dpe_env_pkg";

hw/ip/keymgr_dpe/dv/env/keymgr_dpe_if.sv

@@ -7,7 +7,6 @@ interface keymgr_dpe_if(input clk, input rst_n);
 
   import uvm_pkg::*;
   import keymgr_dpe_env_pkg::*;
-  import keymgr_dpe_reg_pkg::NumRomDigestInputs;
 
   // Represents the keymgr_dpe sideload state for each sideload interface.
   //
@@ -16,13 +15,13 @@ interface keymgr_dpe_if(input clk, input rst_n);
   // Status can't be directly changed from SideLoadClear to SideLoadAvail.
   // When status is SideLoadClear due to SIDELOAD_CLEAR programmed, need to write CSR to 0 to reset
   // it so that status is changed to SideLoadNotAvail, then we may set it to SideLoadAvail again
-  lc_ctrl_pkg::lc_tx_t                                keymgr_dpe_en;
-  lc_ctrl_pkg::lc_keymgr_div_t                        keymgr_dpe_div;
-  keymgr_dpe_pkg::keymgr_dpe_device_id_t              otp_device_id;
-  keymgr_dpe_pkg::keymgr_dpe_creator_root_key_t       creator_root_key;
-  keymgr_dpe_pkg::keymgr_dpe_creator_seed_t           creator_seed;
-  keymgr_dpe_pkg::keymgr_dpe_owner_seed_t             owner_seed;
-  rom_ctrl_pkg::keymgr_data_t[NumRomDigestInputs-1:0] rom_digests;
+  lc_ctrl_pkg::lc_tx_t                                  keymgr_dpe_en;
+  lc_ctrl_pkg::lc_keymgr_div_t                          keymgr_dpe_div;
+  keymgr_dpe_pkg::keymgr_dpe_device_id_t                otp_device_id;
+  keymgr_dpe_pkg::keymgr_dpe_creator_root_key_t         creator_root_key;
+  keymgr_dpe_pkg::keymgr_dpe_creator_seed_t             creator_seed;
+  keymgr_dpe_pkg::keymgr_dpe_owner_seed_t               owner_seed;
+  rom_ctrl_pkg::keymgr_data_t[DvNumRomDigestInputs-1:0] rom_digests;
 
   keymgr_pkg::hw_key_req_t kmac_key;
   keymgr_pkg::hw_key_req_t aes_key;
@@ -103,7 +102,7 @@ interface keymgr_dpe_if(input clk, input rst_n);
 
   // assigned from the keymgr_dpe.keymgr_dpe_ctrl.key_slots_q signal, which should hold the
   // current value of the keyslots in the dut.
-  keymgr_dpe_pkg::keymgr_dpe_slot_t [keymgr_dpe_pkg::DpeNumSlots-1:0] internal_key_slots;
+  keymgr_dpe_pkg::keymgr_dpe_slot_t [DvNumInstHwSlot-1:0] internal_key_slots;
 
   task automatic init(bit rand_otp_key, bit invalid_otp_key);
     // Keymgr_dpe only latches OTP key once, so this scb does not support change OTP key on the
@@ -115,7 +114,7 @@ interface keymgr_dpe_if(input clk, input rst_n);
     keymgr_dpe_en = lc_ctrl_pkg::On;
     keymgr_dpe_div = 64'h5CFBD765CE33F34E;
     otp_device_id = 'hF0F0;
-    for (int i = 0; i < NumRomDigestInputs; ++i) begin
+    for (int i = 0; i < DvNumRomDigestInputs; ++i) begin
       rom_digests[i].data = 256'hA20A046CF42E6EAC560A3F82BFA76285B5C1D4AEA7C915E49A32D1C89BE0F507;
       rom_digests[i].valid = '1;
     end
@@ -193,14 +192,14 @@ interface keymgr_dpe_if(input clk, input rst_n);
     // as a set of flags / counters.
     bit bad_keymgr_dpe_div = 1'b0;
     bit bad_otp_device_id = 1'b0;
-    bit [NumRomDigestInputs-1:0] bad_rom_data = '0, bad_rom_valid = '0;
+    bit [DvNumRomDigestInputs-1:0] bad_rom_data = '0, bad_rom_valid = '0;
 
     repeat (num_invalid_input) begin
       randcase
         1: bad_keymgr_dpe_div = 1'b1;
         1: bad_otp_device_id = 1'b1;
-        1: bad_rom_data[$urandom % NumRomDigestInputs] = 1'b1;
-        1: bad_rom_valid[$urandom % NumRomDigestInputs] = 1'b1;
+        1: bad_rom_data[$urandom % DvNumRomDigestInputs] = 1'b1;
+        1: bad_rom_valid[$urandom % DvNumRomDigestInputs] = 1'b1;
       endcase
     end
 
@@ -221,7 +220,7 @@ interface keymgr_dpe_if(input clk, input rst_n);
 
       // rom_digests
       begin
-        for (int i = 0; i < NumRomDigestInputs; i++)
+        for (int i = 0; i < DvNumRomDigestInputs; i++)
           fork
             automatic int local_i = i;
             #($urandom_range(1000, 0) * 1ns);
@@ -239,8 +238,8 @@ interface keymgr_dpe_if(input clk, input rst_n);
   function automatic void compare_internal_key_slot(
     keymgr_dpe_pkg::keymgr_dpe_slot_t dst_key_slot,
     keymgr_dpe_pkg::keymgr_dpe_slot_t src_key_slot,
-    keymgr_dpe_pkg::keymgr_dpe_slot_idx_e dst_slot_index,
-    keymgr_dpe_pkg::keymgr_dpe_slot_idx_e src_slot_index,
+    dv_keymgr_dpe_slot_idx_e dst_slot_index,
+    dv_keymgr_dpe_slot_idx_e src_slot_index,
     bit check_parent_retained
   );
     `DV_CHECK_EQ(dst_key_slot, internal_key_slots[dst_slot_index],