[ipgen] Try out a virtual provider library for tops

Signed-off-by: Alexander Williams <[email protected]>
lowRISC · Dec 29, 2024 · 085b35f · 085b35f
1 parent ae6066e
commit 085b35f
Show file tree

Hide file tree

Showing 82 changed files with 370 additions and 265 deletions.
diff --git a/hw/ip_templates/alert_handler/alert_handler.core.tpl b/hw/ip_templates/alert_handler/alert_handler.core.tpl
@@ -13,6 +13,9 @@ filesets:
       - ${instance_vlnv("lowrisc:ip:alert_handler_component:0.1")}
       - ${instance_vlnv("lowrisc:ip_interfaces:alert_handler_reg:0.1")}
     file_type: systemVerilogSource
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:alert_handler_virtual_provider")})"
 
 parameters:
   SYNTHESIS:
@@ -28,6 +31,8 @@ targets:
 
   lint:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
     default_tool: verilator
     parameters:
       - SYNTHESIS=true

diff --git a/hw/ip_templates/alert_handler/dv/alert_handler_sim.core.tpl b/hw/ip_templates/alert_handler/dv/alert_handler_sim.core.tpl
@@ -18,6 +18,10 @@ filesets:
       - ${instance_vlnv("lowrisc:dv:alert_handler_sva:0.1")}
     file_type: systemVerilogSource
 
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:alert_handler_virtual_provider")})"
+
 generate:
   ral:
     generator: ralgen
@@ -31,6 +35,7 @@ targets:
     filesets:
       - files_rtl
       - files_dv
+      - files_virtual_provider
     generate:
       - ral
     default_tool: vcs

diff --git a/hw/ip_templates/alert_handler/fpv/alert_handler_esc_timer_fpv.core.tpl b/hw/ip_templates/alert_handler/fpv/alert_handler_esc_timer_fpv.core.tpl
@@ -14,6 +14,9 @@ filesets:
       - tb/alert_handler_esc_timer_bind_fpv.sv
       - tb/alert_handler_esc_timer_tb.sv
     file_type: systemVerilogSource
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:alert_handler_virtual_provider")})"
 
 targets:
   default: &default_target
@@ -26,6 +29,10 @@ targets:
 
   formal:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
 
   lint:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
diff --git a/hw/ip_templates/alert_handler/fpv/alert_handler_ping_timer_fpv.core.tpl b/hw/ip_templates/alert_handler/fpv/alert_handler_ping_timer_fpv.core.tpl
@@ -14,6 +14,9 @@ filesets:
       - tb/alert_handler_ping_timer_bind_fpv.sv
       - tb/alert_handler_ping_timer_tb.sv
     file_type: systemVerilogSource
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:alert_handler_virtual_provider")})"
 
 targets:
   default: &default_target
@@ -26,6 +29,10 @@ targets:
 
   formal:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
 
   lint:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
diff --git a/hw/ip_templates/clkmgr/clkmgr.core.tpl b/hw/ip_templates/clkmgr/clkmgr.core.tpl
@@ -33,11 +33,9 @@ filesets:
       - rtl/clkmgr_trans.sv
     file_type: systemVerilogSource
 
-% if len(pwrmgr_instance_name) > 0:
-  files_top_lint:
+  files_virtual_provider:
     depend:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pwrmgr_pkg:0.1", pwrmgr_instance_name)})"
-% endif
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:clkmgr_virtual_provider")})"
 
   files_verilator_waiver:
     depend:
@@ -69,10 +67,8 @@ targets:
 
   lint:
     <<: *default_target
-% if len(pwrmgr_instance_name) > 0:
     filesets_append:
-      - files_top_lint
-% endif
+      - files_virtual_provider
     default_tool: verilator
     parameters:
       - SYNTHESIS=true

diff --git a/hw/ip_templates/clkmgr/data/clkmgr.tpldesc.hjson b/hw/ip_templates/clkmgr/data/clkmgr.tpldesc.hjson
@@ -92,11 +92,5 @@
       type: "bool"
       default: "1"
     }
-    {
-      name: "pwrmgr_instance_name"
-      desc: "Instance name for the pwrmgr dependencies, if available"
-      type: "string"
-      default: ""
-    }
   ]
 }
diff --git a/hw/ip_templates/clkmgr/dv/clkmgr_sim.core.tpl b/hw/ip_templates/clkmgr/dv/clkmgr_sim.core.tpl
@@ -18,21 +18,17 @@ filesets:
       - cov/clkmgr_cov_bind.sv
     file_type: systemVerilogSource
 
-% if len(pwrmgr_instance_name) > 0:
-  files_top_sim:
+  files_virtual_provider:
     depend:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pwrmgr_pkg:0.1", pwrmgr_instance_name)})"
-%endif
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:clkmgr_virtual_provider")})"
 
 targets:
   sim: &sim_target
     toplevel: tb
     filesets:
       - files_rtl
       - files_dv
-% if len(pwrmgr_instance_name) > 0:
-      - files_top_sim
-% endif
+      - files_virtual_provider
     default_tool: vcs
 
   lint:

diff --git a/hw/ip_templates/flash_ctrl/data/flash_ctrl.tpldesc.hjson b/hw/ip_templates/flash_ctrl/data/flash_ctrl.tpldesc.hjson
@@ -87,11 +87,5 @@
       type: "int"
       default: "1048576"
     }
-    {
-      name: "pwrmgr_instance_name"
-      desc: "Instance name for the pwrmgr dependencies, if available"
-      type: "string"
-      default: ""
-    }
   ]
 }
diff --git a/hw/ip_templates/flash_ctrl/dv/flash_ctrl_sim.core.tpl b/hw/ip_templates/flash_ctrl/dv/flash_ctrl_sim.core.tpl
@@ -22,11 +22,9 @@ filesets:
       - tb/tb.sv
     file_type: systemVerilogSource
 
-% if len(pwrmgr_instance_name) > 0:
-  files_top_sim:
+  files_virtual_provider:
     depend:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pwrmgr_pkg:0.1", pwrmgr_instance_name)})"
-%endif
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:flash_ctrl_virtual_provider")})"
 
 targets:
   default: &default_target
@@ -37,15 +35,11 @@ targets:
 
   sim:
     <<: *default_target
-% if len(pwrmgr_instance_name) > 0:
     filesets_append:
-      - files_top_sim
-% endif
+      - files_virtual_provider
     default_tool: vcs
 
   lint:
     <<: *default_target
-% if len(pwrmgr_instance_name) > 0:
     filesets_append:
-      - files_top_sim
-% endif
+      - files_virtual_provider
diff --git a/hw/ip_templates/flash_ctrl/flash_ctrl.core.tpl b/hw/ip_templates/flash_ctrl/flash_ctrl.core.tpl
@@ -46,11 +46,9 @@ filesets:
       - rtl/flash_phy_scramble.sv
     file_type: systemVerilogSource
 
-% if len(pwrmgr_instance_name) > 0:
-  files_top_lint:
+  files_virtual_provider:
     depend:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pwrmgr_pkg:0.1", pwrmgr_instance_name)})"
-% endif
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:flash_ctrl_virtual_provider")})"
 
   files_verilator_waiver:
     depend:
@@ -93,10 +91,8 @@ targets:
 
   lint:
     <<: *default_target
-% if len(pwrmgr_instance_name) > 0:
     filesets_append:
-      - files_top_lint
-% endif
+      - files_virtual_provider
     default_tool: verilator
     parameters:
       - SYNTHESIS=true

diff --git a/hw/ip_templates/pinmux/fpv/pinmux_chip_fpv.core.tpl b/hw/ip_templates/pinmux/fpv/pinmux_chip_fpv.core.tpl
@@ -20,6 +20,9 @@ filesets:
     files:
       - tb/pinmux_chip_tb.sv
     file_type: systemVerilogSource
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pinmux_virtual_provider")})"
 
 generate:
   csr_assert_gen:
@@ -38,6 +41,10 @@ targets:
 
   formal:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
 
   lint:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
diff --git a/hw/ip_templates/pinmux/fpv/pinmux_fpv.core.tpl b/hw/ip_templates/pinmux/fpv/pinmux_fpv.core.tpl
@@ -16,6 +16,9 @@ filesets:
     files:
       - tb/pinmux_tb.sv
     file_type: systemVerilogSource
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pinmux_virtual_provider")})"
 
 generate:
   csr_assert_gen:
@@ -34,6 +37,10 @@ targets:
 
   formal:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
 
   lint:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
diff --git a/hw/ip_templates/pinmux/pinmux.core.tpl b/hw/ip_templates/pinmux/pinmux.core.tpl
@@ -34,6 +34,10 @@ filesets:
       - rtl/pinmux.sv
     file_type: systemVerilogSource
 
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pinmux_virtual_provider")})"
+
   files_verilator_waiver:
     depend:
       # common waivers
@@ -74,6 +78,8 @@ targets:
 
   lint:
     <<: *default_target
+    filesets_append:
+      - files_virtual_provider
     default_tool: verilator
     parameters:
       - SYNTHESIS=true
@@ -95,4 +101,5 @@ targets:
   formal:
     filesets:
       - files_rtl
+      - files_virtual_provider
     toplevel: pinmux_tb
diff --git a/hw/ip_templates/pwrmgr/data/pwrmgr.tpldesc.hjson b/hw/ip_templates/pwrmgr/data/pwrmgr.tpldesc.hjson
@@ -64,17 +64,5 @@
       type: "int"
       default: "1"
     }
-    {
-      name: "alert_handler_instance_name"
-      desc: "Instance name for the alert_handler dependencies, if available"
-      type: "string"
-      default: ""
-    }
-    {
-      name: "clkmgr_instance_name"
-      desc: "Instance name for the clkmgr dependencies, if available"
-      type: "string"
-      default: ""
-    }
   ]
 }
diff --git a/hw/ip_templates/pwrmgr/dv/pwrmgr_sim.core.tpl b/hw/ip_templates/pwrmgr/dv/pwrmgr_sim.core.tpl
@@ -17,30 +17,17 @@ filesets:
       - tb.sv
       - cov/pwrmgr_cov_bind.sv
     file_type: systemVerilogSource
-<%
-    have_files_top_sim = (len(clkmgr_instance_name) > 0 or
-                          len(alert_handler_instance_name) > 0)
-%>\
-% if have_files_top_sim:
-  files_top_sim:
+  files_virtual_provider:
     depend:
-%   if len(alert_handler_instance_name) > 0:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:alert_handler_pkg:0.1", alert_handler_instance_name)})"
-%   endif
-%   if len(clkmgr_instance_name) > 0:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:clkmgr_pwrmgr_sva_if:0.1", clkmgr_instance_name)})"
-%   endif
-% endif
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pwrmgr_virtual_provider")})"
 
 targets:
   sim: &sim_target
     toplevel: tb
     filesets:
       - files_rtl
       - files_dv
-% if have_files_top_sim:
-      - files_top_sim
-% endif
+      - files_virtual_provider
     default_tool: vcs
 
   lint:

diff --git a/hw/ip_templates/pwrmgr/pwrmgr.core.tpl b/hw/ip_templates/pwrmgr/pwrmgr.core.tpl
@@ -15,11 +15,9 @@ filesets:
       - ${instance_vlnv("lowrisc:ip:pwrmgr_component:0.1")}
     file_type: systemVerilogSource
 
-% if len(alert_handler_instance_name) > 0:
-  files_top_lint:
+  files_virtual_provider:
     depend:
-      - "fileset_top ? (${instance_vlnv("lowrisc:ip:alert_handler_pkg:0.1", alert_handler_instance_name)})"
-% endif
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:pwrmgr_virtual_provider")})"
 
   files_verilator_waiver:
     depend:
@@ -62,10 +60,8 @@ targets:
 
   lint:
     <<: *default_target
-% if len(alert_handler_instance_name) > 0:
     filesets_append:
-      - files_top_lint
-% endif
+      - files_virtual_provider
     default_tool: verilator
     parameters:
       - SYNTHESIS=true

diff --git a/hw/ip_templates/rstmgr/data/rstmgr.tpldesc.hjson b/hw/ip_templates/rstmgr/data/rstmgr.tpldesc.hjson
@@ -117,17 +117,5 @@
       type: "bool"
       default: "1"
     }
-    {
-      name: "alert_handler_instance_name"
-      desc: "Instance name for the alert_handler dependencies, if available"
-      type: "string"
-      default: ""
-    }
-    {
-      name: "pwrmgr_instance_name"
-      desc: "Instance name for the pwrmgr dependencies, if available"
-      type: "string"
-      default: ""
-    }
   ]
 }
diff --git a/hw/ip_templates/rstmgr/dv/rstmgr_cnsty_chk/rstmgr_cnsty_chk_sim.core.tpl b/hw/ip_templates/rstmgr/dv/rstmgr_cnsty_chk/rstmgr_cnsty_chk_sim.core.tpl
@@ -20,12 +20,17 @@ filesets:
       - tb.sv
     file_type: systemVerilogSource
 
+  files_virtual_provider:
+    depend:
+      - "fileset_top ? (${instance_vlnv("lowrisc:ip:rstmgr_virtual_provider")})"
+
 targets:
   sim: &sim_target
     toplevel: tb
     filesets:
       - files_rtl
       - files_dv
+      - files_virtual_provider
     default_tool: vcs
 
   lint: