[hw,kmac,rtl] Parametrize the number of app interfaces

Signed-off-by: Robert Schilling <[email protected]>
lowRISC · Nov 10, 2024 · 72776ab · 72776ab
1 parent 16e57ff
commit 72776ab
Show file tree

Hide file tree

Showing 18 changed files with 169 additions and 80 deletions.
diff --git a/hw/ip/kmac/data/kmac.hjson b/hw/ip/kmac/data/kmac.hjson
@@ -123,6 +123,21 @@
       local:   "false"
       expose:  "true"
     }
+    { name:    "NumAppIntf"
+      type:    "int"
+      default: "3"
+      desc:    "Number of words for the secret key"
+      local:   "false"
+      expose:  "true"
+    }
+    { name:                "AppCfg"
+      desc:                "Number of words for the secret key"
+      type:                "kmac_pkg::app_config_t"
+      unpacked_dimensions: "[KmacNumAppIntf]"
+      default:             "'{kmac_pkg::AppCfgKeyMgr, kmac_pkg::AppCfgLcCtrl, kmac_pkg::AppCfgRomCtrl}"
+      local:               "false"
+      expose:              "true"
+    }
     { name:    "NumWordsKey"
       type:    "int"
       default: "16"
@@ -196,7 +211,7 @@
       name:    "app"
       act:     "rsp"
       package: "kmac_pkg"
-      width:   "3"
+      width:   "NumAppIntf"
     }
     { struct:  "edn"
       type:    "req_rsp"

diff --git a/hw/ip/kmac/doc/interfaces.md b/hw/ip/kmac/doc/interfaces.md
@@ -10,15 +10,15 @@ Referring to the [Comportable guideline for peripheral device functionality](htt
 
 ## [Inter-Module Signals](https://opentitan.org/book/doc/contributing/hw/comportability/index.html#inter-signal-handling)
 
-| Port Name      | Package::Struct        | Type    | Act   |   Width | Description   |
-|:---------------|:-----------------------|:--------|:------|--------:|:--------------|
-| keymgr_key     | keymgr_pkg::hw_key_req | uni     | rcv   |       1 |               |
-| app            | kmac_pkg::app          | req_rsp | rsp   |       3 |               |
-| entropy        | edn_pkg::edn           | req_rsp | req   |       1 |               |
-| idle           | prim_mubi_pkg::mubi4   | uni     | req   |       1 |               |
-| en_masking     | logic                  | uni     | req   |       1 |               |
-| lc_escalate_en | lc_ctrl_pkg::lc_tx     | uni     | rcv   |       1 |               |
-| tl             | tlul_pkg::tl           | req_rsp | rsp   |       1 |               |
+| Port Name      | Package::Struct        | Type    | Act   | Width      | Description   |
+|:---------------|:-----------------------|:--------|:------|:-----------|:--------------|
+| keymgr_key     | keymgr_pkg::hw_key_req | uni     | rcv   | 1          |               |
+| app            | kmac_pkg::app          | req_rsp | rsp   | NumAppIntf |               |
+| entropy        | edn_pkg::edn           | req_rsp | req   | 1          |               |
+| idle           | prim_mubi_pkg::mubi4   | uni     | req   | 1          |               |
+| en_masking     | logic                  | uni     | req   | 1          |               |
+| lc_escalate_en | lc_ctrl_pkg::lc_tx     | uni     | rcv   | 1          |               |
+| tl             | tlul_pkg::tl           | req_rsp | rsp   | 1          |               |
 
 ## Interrupts
 

diff --git a/hw/ip/kmac/dv/README.md b/hw/ip/kmac/dv/README.md
@@ -123,8 +123,8 @@ The `kmac_scoreboard` is primarily used for end to end checking.
 It creates the following analysis ports to retrieve the data monitored by corresponding interface agents:
 * tl_a_chan_fifo: TL address channel
 * tl_d_chan_fifo: TL data channel
-* kmac_app_req_fifo[kmac_pkg::NumAppIntf]: An array of analysis FIFOs to hold request transactions coming from the various application interfaces
-* kmac_app_rsp_fifo[kmac_pkg::NumAppIntf]: An array of analysis FIFOs to hold response transactions coming from the various application interfaces
+* kmac_app_req_fifo[NUM_APP_INTF]: An array of analysis FIFOs to hold request transactions coming from the various application interfaces
+* kmac_app_rsp_fifo[NUM_APP_INTF]: An array of analysis FIFOs to hold response transactions coming from the various application interfaces
 * edn_fifo: FIFO used to hold transactions coming from the EDN interface
 
 The KMAC scoreboard implements a cycle-accurate model of the DUT that is used to thoroughly check the operation of the KMAC IP.

diff --git a/hw/ip/kmac/dv/env/kmac_env.sv b/hw/ip/kmac/dv/env/kmac_env.sv
@@ -12,13 +12,13 @@ class kmac_env extends cip_base_env #(
 
   `uvm_component_new
 
-  kmac_app_agent m_kmac_app_agent[kmac_pkg::NumAppIntf];
+  kmac_app_agent m_kmac_app_agent[kmac_env_pkg::NUM_APP_INTF];
   key_sideload_agent keymgr_sideload_agent;
 
   function void build_phase(uvm_phase phase);
     super.build_phase(phase);
 
-    for (int i = 0; i < kmac_pkg::NumAppIntf; i++) begin
+    for (int i = 0; i < kmac_env_pkg::NUM_APP_INTF; i++) begin
       string name = $sformatf("m_kmac_app_agent[%0d]", i);
       m_kmac_app_agent[i] = kmac_app_agent::type_id::create(name, this);
       uvm_config_db#(kmac_app_agent_cfg)::set(this, name, "cfg", cfg.m_kmac_app_agent_cfg[i]);
@@ -39,7 +39,7 @@ class kmac_env extends cip_base_env #(
   function void connect_phase(uvm_phase phase);
     super.connect_phase(phase);
 
-    for (int i = 0; i < kmac_pkg::NumAppIntf; i++) begin
+    for (int i = 0; i < kmac_env_pkg::NUM_APP_INTF; i++) begin
       m_kmac_app_agent[i].monitor.analysis_port.connect(scoreboard.kmac_app_rsp_fifo[i].analysis_export);
       m_kmac_app_agent[i].m_data_push_agent.monitor.analysis_port.connect(
         scoreboard.kmac_app_req_fifo[i].analysis_export);

diff --git a/hw/ip/kmac/dv/env/kmac_env_cfg.sv b/hw/ip/kmac/dv/env/kmac_env_cfg.sv
@@ -7,7 +7,7 @@ class kmac_env_cfg extends cip_base_env_cfg #(.RAL_T(kmac_reg_block));
   // ext interfaces
   kmac_vif kmac_vif;
 
-  rand kmac_app_agent_cfg m_kmac_app_agent_cfg[kmac_pkg::NumAppIntf];
+  rand kmac_app_agent_cfg m_kmac_app_agent_cfg[kmac_env_pkg::NUM_APP_INTF];
   rand key_sideload_agent_cfg keymgr_sideload_agent_cfg;
 
   // Masked KMAC is the default configuration
@@ -50,7 +50,7 @@ class kmac_env_cfg extends cip_base_env_cfg #(.RAL_T(kmac_reg_block));
     shadow_storage_err_status_fields[ral.cfg_regwen.en] = 0;
     shadow_storage_err_status_fields[ral.status.sha3_idle] = 0;
 
-    for (int i = 0; i < kmac_pkg::NumAppIntf; i++) begin
+    for (int i = 0; i < kmac_env_pkg::NUM_APP_INTF; i++) begin
       string name = $sformatf("m_kmac_app_agent_cfg[%0d]", i);
       m_kmac_app_agent_cfg[i] = kmac_app_agent_cfg::type_id::create(name);
       m_kmac_app_agent_cfg[i].if_mode = dv_utils_pkg::Host;

diff --git a/hw/ip/kmac/dv/env/kmac_env_cov.sv b/hw/ip/kmac/dv/env/kmac_env_cov.sv
@@ -205,7 +205,7 @@ class kmac_env_cov extends cip_base_env_cov #(.CFG_T(kmac_env_cfg));
   config_masked_cg config_masked_cg;
   config_unmasked_cg config_unmasked_cg;
 
-  app_cg_wrap app_cg_wrappers[kmac_pkg::NumAppIntf];
+  app_cg_wrap app_cg_wrappers[kmac_env_pkg::NUM_APP_INTF];
 
   covergroup msg_len_cg with function sample(int len);
     msg_len: coverpoint len {

diff --git a/hw/ip/kmac/dv/env/kmac_env_pkg.sv b/hw/ip/kmac/dv/env/kmac_env_pkg.sv
@@ -19,6 +19,7 @@ package kmac_env_pkg;
   import kmac_app_agent_pkg::*;
   import kmac_ral_pkg::*;
   import kmac_pkg::*;
+  import kmac_reg_pkg::*;
   import keymgr_pkg::*;
   import key_sideload_agent_pkg::*;
   import sec_cm_pkg::*;
@@ -71,6 +72,9 @@ package kmac_env_pkg;
 
   parameter uint NUM_EDN = 1;
 
+  // Earlgrey has 3 application interfaces
+  parameter uint NUM_APP_INTF = 3;
+
   /////////////////////////////
   // Timing Model Parameters //
   /////////////////////////////

diff --git a/hw/ip/kmac/dv/env/kmac_if.sv b/hw/ip/kmac/dv/env/kmac_if.sv
@@ -9,8 +9,8 @@ interface kmac_if(input clk_i, input rst_ni);
   logic                                          en_masking_o;
   lc_ctrl_pkg::lc_tx_t                           lc_escalate_en_i;
   prim_mubi_pkg::mubi4_t                         idle_o;
-  kmac_pkg::app_req_t [kmac_pkg::NumAppIntf-1:0] app_req;
-  kmac_pkg::app_rsp_t [kmac_pkg::NumAppIntf-1:0] app_rsp;
+  kmac_pkg::app_req_t [kmac_env_pkg::NUM_APP_INTF-1:0] app_req;
+  kmac_pkg::app_rsp_t [kmac_env_pkg::NUM_APP_INTF-1:0] app_rsp;
 
   function automatic void drive_lc_escalate(lc_ctrl_pkg::lc_tx_t val);
     lc_escalate_en_i = val;

diff --git a/hw/ip/kmac/dv/env/kmac_scoreboard.sv b/hw/ip/kmac/dv/env/kmac_scoreboard.sv
@@ -153,16 +153,16 @@ class kmac_scoreboard extends cip_base_scoreboard #(
                                 ({KMAC_FIFO_DEPTH{1'b1}} << KmacStatusFifoDepthLSB);
 
   // TLM fifos
-  uvm_tlm_analysis_fifo #(kmac_app_item) kmac_app_rsp_fifo[kmac_pkg::NumAppIntf];
+  uvm_tlm_analysis_fifo #(kmac_app_item) kmac_app_rsp_fifo[NUM_APP_INTF];
   uvm_tlm_analysis_fifo #(push_pull_agent_pkg::push_pull_item #(
     .HostDataWidth(kmac_app_agent_pkg::KMAC_REQ_DATA_WIDTH)))
-    kmac_app_req_fifo[kmac_pkg::NumAppIntf];
+    kmac_app_req_fifo[NUM_APP_INTF];
 
   `uvm_component_new
 
   function void build_phase(uvm_phase phase);
     super.build_phase(phase);
-    for (int i = 0; i < kmac_pkg::NumAppIntf; i++) begin
+    for (int i = 0; i < NUM_APP_INTF; i++) begin
       kmac_app_req_fifo[i] = new($sformatf("kmac_app_req_fifo[%0d]", i), this);
       kmac_app_rsp_fifo[i] = new($sformatf("kmac_app_rsp_fifo[%0d]", i), this);
     end

diff --git a/hw/ip/kmac/dv/env/kmac_virtual_sequencer.sv b/hw/ip/kmac/dv/env/kmac_virtual_sequencer.sv
@@ -10,7 +10,7 @@ class kmac_virtual_sequencer extends cip_base_virtual_sequencer #(
 
   `uvm_component_new
 
-  kmac_app_sequencer kmac_app_sequencer_h[kmac_pkg::NumAppIntf];
+  kmac_app_sequencer kmac_app_sequencer_h[kmac_env_pkg::NUM_APP_INTF];
   key_sideload_sequencer key_sideload_sequencer_h;
 
 endclass
diff --git a/hw/ip/kmac/dv/env/seq_lib/kmac_app_with_partial_data_vseq.sv b/hw/ip/kmac/dv/env/seq_lib/kmac_app_with_partial_data_vseq.sv
@@ -11,7 +11,7 @@ class kmac_app_with_partial_data_vseq extends kmac_app_vseq;
 
   virtual task pre_start();
     super.pre_start();
-    for (int i = 0; i < kmac_pkg::NumAppIntf; i++) begin
+    for (int i = 0; i < kmac_env_pkg::NUM_APP_INTF; i++) begin
       cfg.m_kmac_app_agent_cfg[i].inject_zero_in_host_strb = 1;
     end
     cfg.do_cycle_accurate_check = 0;

diff --git a/hw/ip/kmac/dv/tb.sv b/hw/ip/kmac/dv/tb.sv
@@ -19,8 +19,8 @@ module tb;
   // keymgr/kmac sideload wires
   keymgr_pkg::hw_key_req_t kmac_sideload_key;
   // kmac_app interfaces
-  kmac_pkg::app_req_t [kmac_pkg::NumAppIntf-1:0] app_req;
-  kmac_pkg::app_rsp_t [kmac_pkg::NumAppIntf-1:0] app_rsp;
+  kmac_pkg::app_req_t [NUM_APP_INTF-1:0] app_req;
+  kmac_pkg::app_rsp_t [NUM_APP_INTF-1:0] app_rsp;
 
   // interfaces
   clk_rst_if clk_rst_if(.clk(clk), .rst_n(rst_n));
@@ -37,7 +37,7 @@ module tb;
     .sideload_key (kmac_sideload_key)
   );
 
-  kmac_app_intf kmac_app_if[kmac_pkg::NumAppIntf](.clk(clk), .rst_n(rst_n));
+  kmac_app_intf kmac_app_if[NUM_APP_INTF](.clk(clk), .rst_n(rst_n));
 
   // edn_clk, edn_rst_n and edn_if is defined and driven in below macro
   `DV_EDN_IF_CONNECT
@@ -48,7 +48,8 @@ module tb;
 
   kmac #(
     .EnMasking(`EN_MASKING),
-    .SwKeyMasked(`SW_KEY_MASKED)
+    .SwKeyMasked(`SW_KEY_MASKED),
+    .NumAppIntf(NUM_APP_INTF)
   ) dut (
     .clk_i              (clk            ),
     .rst_ni             (rst_n          ),
@@ -89,7 +90,7 @@ module tb;
     .entropy_i          ({edn_if[0].ack, edn_if[0].d_data} )
   );
 
-  for (genvar i = 0; i < kmac_pkg::NumAppIntf; i++) begin : gen_kmac_app_intf
+  for (genvar i = 0; i < NUM_APP_INTF; i++) begin : gen_kmac_app_intf
     assign app_req[i]                   = kmac_app_if[i].kmac_data_req;
     assign kmac_app_if[i].kmac_data_rsp = app_rsp[i];
     assign kmac_if.app_req[i] = app_req[i];

diff --git a/hw/ip/kmac/lint/kmac.waiver b/hw/ip/kmac/lint/kmac.waiver
@@ -9,7 +9,7 @@ waive -rules {HIER_NET_NOT_READ NOT_READ INPUT_NOT_READ} -location {kmac.sv} -re
 
 waive -rules {HIER_NET_NOT_READ NOT_READ INPUT_NOT_READ} -location {kmac.sv} \
     -regexp {'tlram_addr' is not read} \
-    -comment "MSG_FIFO ignores the exact memory address but use strobe for alignement"
+    -comment "MSG_FIFO ignores the exact memory address but use strobe for alignment"
 
 waive -rules {HIER_NET_NOT_READ NOT_READ INPUT_NOT_READ} \
     -location {kmac_msgfifo.sv} -regexp {'packer_wmask.* is not read} \
@@ -29,3 +29,16 @@ waive -rules {INTEGER} -location {kmac_entropy.sv} \
 
 waive -rules {CASE_SEL_EXPR} -location {kmac_app.sv} \
     -comment "not a problem, just a suggested alternate implementation"
+
+waive -rules TWO_STATE_TYPE -location {kmac_pkg.sv} \
+      -regexp {'PrefixMode' is of two state type} \
+      -comment "Enum bit is used as a generate selection. OK to be two state"
+waive -rules TWO_STATE_TYPE -location {kmac_pkg.sv} \
+      -regexp {'app_mode_e' is of two state type} \
+      -comment "Enum bit is used in ifs only. OK to be two state"
+waive -rules TWO_STATE_TYPE -location {kmac_pkg.sv} \
+      -regexp {'Mode' is of two state type} \
+      -comment "Enum bit is used in ifs only. OK to be two state"
+waive -rules TWO_STATE_TYPE -location {kmac_pkg.sv} \
+      -regexp {'app_config_t' is of type struct which contains two state type field} \
+      -comment "Struct fields waived separately. OK to be two state"
diff --git a/hw/ip/kmac/rtl/kmac.sv b/hw/ip/kmac/rtl/kmac.sv
@@ -28,7 +28,9 @@ module kmac
   parameter int SecCmdDelay = 0,
 
   // Accept SW message when idle and before receiving a START command. Useful for SCA only.
-  parameter bit SecIdleAcceptSwMsg = 1'b0,
+  parameter bit SecIdleAcceptSwMsg          = 1'b0,
+  parameter int unsigned NumAppIntf         = 3,
+  parameter app_config_t AppCfg[NumAppIntf] = '{AppCfgKeyMgr, AppCfgLcCtrl, AppCfgRomCtrl},
 
   parameter lfsr_perm_t RndCnstLfsrPerm = RndCnstLfsrPermDefault,
   parameter lfsr_seed_t RndCnstLfsrSeed = RndCnstLfsrSeedDefault,
@@ -1042,7 +1044,9 @@ module kmac
   // Application interface Mux/Demux
   kmac_app #(
     .EnMasking(EnMasking),
-    .SecIdleAcceptSwMsg(SecIdleAcceptSwMsg)
+    .SecIdleAcceptSwMsg(SecIdleAcceptSwMsg),
+    .NumAppIntf(NumAppIntf),
+    .AppCfg(AppCfg)
   ) u_app_intf (
     .clk_i,
     .rst_ni,

diff --git a/hw/ip/kmac/rtl/kmac_app.sv b/hw/ip/kmac/rtl/kmac_app.sv
@@ -10,9 +10,11 @@ module kmac_app
   import kmac_pkg::*;
 #(
   // App specific configs are defined in kmac_pkg
-  parameter  bit EnMasking = 1'b0,
-  localparam int Share = (EnMasking) ? 2 : 1, // derived parameter
-  parameter  bit SecIdleAcceptSwMsg = 1'b0
+  parameter  bit          EnMasking          = 1'b0,
+  localparam int          Share              = (EnMasking) ? 2 : 1, // derived parameter
+  parameter  bit          SecIdleAcceptSwMsg = 1'b0,
+  parameter  int unsigned NumAppIntf         = 3,
+  parameter  app_config_t AppCfg[NumAppIntf] = '{AppCfgKeyMgr, AppCfgLcCtrl, AppCfgRomCtrl}
 ) (
   input clk_i,
   input rst_ni,
@@ -872,7 +874,7 @@ module kmac_app
       kmac_en_o         <= AppCfg[arb_idx].Mode == AppKMAC ? 1'b 1 : 1'b 0;
       sha3_mode_o       <= AppCfg[arb_idx].Mode == AppSHA3
                            ? sha3_pkg::Sha3 : sha3_pkg::CShake;
-      keccak_strength_o <= AppCfg[arb_idx].Strength ;
+      keccak_strength_o <= AppCfg[arb_idx].KeccakStrength ;
     end else if (st == StIdle) begin
       kmac_en_o         <= reg_kmac_en_i;
       sha3_mode_o       <= reg_sha3_mode_i;

diff --git a/hw/ip/kmac/rtl/kmac_pkg.sv b/hw/ip/kmac/rtl/kmac_pkg.sv
@@ -190,15 +190,6 @@ package kmac_pkg;
   // Application interface //
   ///////////////////////////
 
-  // Number of the application interface
-  // Currently KMAC has three interface.
-  // 0: KeyMgr
-  // 1: LC_CTRL
-  // 2: ROM_CTRL
-  // Make sure to change `width` of app inter-module signal definition
-  // if this value is changed.
-  parameter int unsigned NumAppIntf = 3;
-
   // Application Algorithm
   // Each interface can choose algorithms among SHA3, cSHAKE, KMAC
   typedef enum bit [1:0] {
@@ -228,7 +219,7 @@ package kmac_pkg;
   typedef struct packed {
     app_mode_e Mode;
 
-    sha3_pkg::keccak_strength_e Strength;
+    sha3_pkg::keccak_strength_e KeccakStrength;
 
     // PrefixMode determines the origin value of Prefix that is used in KMAC
     // and cSHAKE operations.
@@ -241,33 +232,28 @@ package kmac_pkg;
     logic [NSPrefixW-1:0] Prefix;
   } app_config_t;
 
-  parameter app_config_t AppCfg [NumAppIntf] = '{
-    // KeyMgr
-    '{
-      Mode:       AppKMAC, // KeyMgr uses KMAC operation
-      Strength:   sha3_pkg::L256,
-      PrefixMode: 1'b 1,   // Use prefix parameter
-      // {fname: encoded_string("KMAC"), custom_str: encoded_string("")}
-      Prefix:     NSPrefixW'({EncodedStringEmpty, EncodedStringKMAC})
-    },
-
-    // LC_CTRL
-    '{
-      Mode:       AppCShake,
-      Strength:   sha3_pkg::L128,
-      PrefixMode: 1'b 1,     // Use prefix parameter
-      // {fname: encode_string(""), custom_str: encode_string("LC_CTRL")}
-      Prefix: NSPrefixW'({EncodedStringLcCtrl, EncodedStringEmpty})
-    },
-
-    // ROM_CTRL
-    '{
-      Mode:       AppCShake,
-      Strength:   sha3_pkg::L256,
-      PrefixMode: 1'b 1,     // Use prefix parameter
-      // {fname: encode_string(""), custom_str: encode_string("ROM_CTRL")}
-      Prefix: NSPrefixW'({EncodedStringRomCtrl, EncodedStringEmpty})
-    }
+  parameter app_config_t AppCfgKeyMgr = '{
+    Mode:       AppKMAC, // KeyMgr uses KMAC operation
+    Strength:   sha3_pkg::L256,
+    PrefixMode: 1'b 1,   // Use prefix parameter
+    // {fname: encoded_string("KMAC"), custom_str: encoded_string("")}
+    Prefix:     NSPrefixW'({EncodedStringEmpty, EncodedStringKMAC})
+  };
+
+  parameter app_config_t AppCfgLcCtrl= '{
+    Mode:       AppCShake,
+    Strength:   sha3_pkg::L128,
+    PrefixMode: 1'b 1,     // Use prefix parameter
+    // {fname: encode_string(""), custom_str: encode_string("LC_CTRL")}
+    Prefix: NSPrefixW'({EncodedStringLcCtrl, EncodedStringEmpty})
+  };
+
+  parameter app_config_t AppCfgRomCtrl = '{
+    Mode:       AppCShake,
+    Strength:   sha3_pkg::L256,
+    PrefixMode: 1'b 1,     // Use prefix parameter
+    // {fname: encode_string(""), custom_str: encode_string("ROM_CTRL")}
+    Prefix: NSPrefixW'({EncodedStringRomCtrl, EncodedStringEmpty})
   };
 
   // Exporting the app internal mux selection enum into the package. So that DV