[tools,ipgen] Improve VLNV renaming

- Change IpTemplateRendererBase._tplfunc_instance_vlnv per the new VLNV scheme. This only needs the template name and the info in "self". Remove the extra "prefix" parameter. - Remove some unnecessary vlnv related ipgen parameters. - Change top core files to use the new naming. Fixes lowRISC#26540 Signed-off-by: Guillermo Maturana <[email protected]>
matutem · Mar 7, 2025 · 73fd87d · 73fd87d
1 parent d2c2669
commit 73fd87d
Show file tree

Hide file tree

Showing 312 changed files with 951 additions and 789 deletions.
diff --git a/hw/dv/sv/flash_phy_prim_agent/flash_phy_prim_agent.core b/hw/dv/sv/flash_phy_prim_agent/flash_phy_prim_agent.core
@@ -9,7 +9,7 @@ filesets:
     depend:
       - lowrisc:dv:dv_utils
       - lowrisc:dv:dv_lib
-      - lowrisc:ip_interfaces:flash_ctrl_pkg
+      - lowrisc:virtual_ip:flash_ctrl_pkg
     files:
       - flash_phy_prim_if.sv
       - flash_phy_prim_agent_pkg.sv

diff --git a/hw/ip/keymgr/keymgr.core b/hw/ip/keymgr/keymgr.core
@@ -18,7 +18,7 @@ filesets:
       - lowrisc:prim:sec_anchor
       - lowrisc:prim:secded
       - lowrisc:prim:sparse_fsm
-      - lowrisc:ip_interfaces:flash_ctrl_pkg
+      - lowrisc:virtual_ip:flash_ctrl_pkg
       - lowrisc:ip:keymgr_pkg
       - lowrisc:ip:kmac_pkg
       - lowrisc:ip:otp_ctrl_pkg

diff --git a/hw/ip/lc_ctrl/lc_ctrl.core b/hw/ip/lc_ctrl/lc_ctrl.core
@@ -17,11 +17,11 @@ filesets:
       - lowrisc:prim:sparse_fsm
       - lowrisc:ip:lc_ctrl_pkg
       - lowrisc:ip:tlul
-      - lowrisc:ip_interfaces:pwrmgr_pkg
+      - lowrisc:virtual_ip:pwrmgr_pkg
       - lowrisc:ip:otp_ctrl_pkg
       - lowrisc:ip:kmac_pkg
       - lowrisc:ip:rv_dm
-      - lowrisc:ip_interfaces:alert_handler_pkg
+      - lowrisc:virtual_ip:alert_handler_pkg
     files:
       - rtl/lc_ctrl_regs_reg_top.sv
       - rtl/lc_ctrl_dmi_reg_top.sv

diff --git a/hw/ip/prim_generic/prim_generic_flash.core b/hw/ip/prim_generic/prim_generic_flash.core
@@ -12,8 +12,8 @@ filesets:
       - lowrisc:prim:ram_1p
       - "fileset_partner  ? (partner:systems:ast_pkg)"
       - "!fileset_partner ? (lowrisc:systems:ast_pkg)"
-      - lowrisc:ip_interfaces:flash_ctrl_pkg
-      - lowrisc:ip_interfaces:flash_ctrl_prim_reg_top
+      - lowrisc:virtual_ip:flash_ctrl_pkg
+      - lowrisc:virtual_ip:flash_ctrl_prim_reg_top
     files:
       - rtl/prim_generic_flash_bank.sv
       - rtl/prim_generic_flash.sv

diff --git a/hw/ip/soc_dbg_ctrl/soc_dbg_ctrl.core b/hw/ip/soc_dbg_ctrl/soc_dbg_ctrl.core
@@ -14,7 +14,7 @@ filesets:
       # TODO(PR #23555): This must depend upon the Darjeeling pwrmgr pkg directly
       # for the pwr_boot_status_t structure presently.
       # - lowrisc:ip_interfaces:pwrmgr_pkg
-      - lowrisc:opentitan:top_darjeeling_pwrmgr_pkg
+      - lowrisc:darjeeling_ip:pwrmgr_pkg
       - lowrisc:ip:lc_ctrl_pkg
     files:
       - rtl/soc_dbg_ctrl_reg_pkg.sv

diff --git a/hw/ip_templates/ac_range_check/data/ac_range_check.tpldesc.hjson b/hw/ip_templates/ac_range_check/data/ac_range_check.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name:    "uniquified_modules"
+      desc:    "A dictionary mapping template_names to uniquified_names"
+      type:    "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name:    "module_instance_name"
       desc:    "instance name in case there are multiple AC Range Check instances"

diff --git a/hw/ip_templates/alert_handler/alert_handler_pkg.core.tpl b/hw/ip_templates/alert_handler/alert_handler_pkg.core.tpl
@@ -5,7 +5,7 @@ CAPI=2:
 name: ${instance_vlnv(f"lowrisc:ip:{module_instance_name}_pkg:0.1")}
 description: "Alert Handler constants in packages"
 virtual:
-  - "lowrisc:ip_interfaces:${module_instance_name}_pkg"
+  - "lowrisc:virtual_ip:${module_instance_name}_pkg"
 
 filesets:
   files_rtl:

diff --git a/hw/ip_templates/alert_handler/data/alert_handler.tpldesc.hjson b/hw/ip_templates/alert_handler/data/alert_handler.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "n_alerts"
       desc: "Number of alert sources"

diff --git a/hw/ip_templates/clkmgr/clkmgr.core.tpl b/hw/ip_templates/clkmgr/clkmgr.core.tpl
@@ -9,7 +9,7 @@ filesets:
   files_rtl:
     depend:
       - lowrisc:ip:lc_ctrl_pkg
-      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg", pwrmgr_vlnv_prefix)}
+      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg")}
       - lowrisc:ip:tlul
       - lowrisc:prim:all
       - lowrisc:prim:buf

diff --git a/hw/ip_templates/clkmgr/clkmgr_pkg.core.tpl b/hw/ip_templates/clkmgr/clkmgr_pkg.core.tpl
@@ -2,10 +2,10 @@ CAPI=2:
 # Copyright lowRISC contributors (OpenTitan project).
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
-name: ${instance_vlnv("lowrisc:systems:clkmgr_pkg:0.1")}
+name: ${instance_vlnv("lowrisc:ip:clkmgr_pkg:0.1")}
 description: "Top specific clock manager package"
 virtual:
-  - lowrisc:ip_interfaces:clkmgr_pkg
+  - lowrisc:virtual_ip:clkmgr_pkg
 
 filesets:
   files_rtl:

diff --git a/hw/ip_templates/clkmgr/data/clkmgr.tpldesc.hjson b/hw/ip_templates/clkmgr/data/clkmgr.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "src_clks"
       desc: "The source clocks"
@@ -92,12 +98,6 @@
       type: "bool"
       default: "1"
     }
-    {
-      name: "pwrmgr_vlnv_prefix"
-      desc: "Provides the VLNV prefix (for instance_vlnv) for the pwrmgr_pkg used by this clkmgr"
-      type: "string"
-      default: ""
-    }
     {
       name: "top_pkg_vlnv"
       desc: "Provides the VLNV for the top_pkg used by this clkmgr"

diff --git a/hw/ip_templates/clkmgr/dv/env/clkmgr_env.core.tpl b/hw/ip_templates/clkmgr/dv/env/clkmgr_env.core.tpl
@@ -9,7 +9,7 @@ filesets:
     depend:
       - lowrisc:dv:ralgen
       - lowrisc:dv:cip_lib
-      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg", pwrmgr_vlnv_prefix)}
+      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg")}
       - ${instance_vlnv("lowrisc:ip:clkmgr_pkg")}
       - ${top_pkg_vlnv}
     files:

diff --git a/hw/ip_templates/flash_ctrl/data/flash_ctrl.tpldesc.hjson b/hw/ip_templates/flash_ctrl/data/flash_ctrl.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "banks"
       desc: "Number of banks"
@@ -87,12 +93,6 @@
       type: "int"
       default: "1048576"
     }
-    {
-      name: "pwrmgr_vlnv_prefix"
-      desc: "Provides the VLNV prefix (for instance_vlnv) for the pwrmgr_pkg used by this clkmgr"
-      type: "string"
-      default: ""
-    }
     {
       name: "top_pkg_vlnv"
       desc: "Provides the VLNV for the top_pkg used by this clkmgr"

diff --git a/hw/ip_templates/flash_ctrl/dv/env/flash_ctrl_bkdr_util.core.tpl b/hw/ip_templates/flash_ctrl/dv/env/flash_ctrl_bkdr_util.core.tpl
@@ -13,7 +13,7 @@ filesets:
       - lowrisc:dv:crypto_dpi_prince:0.1
       - lowrisc:dv:crypto_dpi_present:0.1
       - lowrisc:prim:secded:0.1
-      - ${instance_vlnv("lowrisc:ip_interfaces:flash_ctrl_pkg")}
+      - ${instance_vlnv("lowrisc:ip:flash_ctrl_pkg")}
       - lowrisc:dv:mem_bkdr_util
     files:
       - flash_ctrl_bkdr_util_pkg.sv

diff --git a/hw/ip_templates/flash_ctrl/flash_ctrl_pkg.core.tpl b/hw/ip_templates/flash_ctrl/flash_ctrl_pkg.core.tpl
@@ -5,15 +5,15 @@ CAPI=2:
 name: ${instance_vlnv("lowrisc:ip:flash_ctrl_pkg:0.1")}
 description: "Top specific flash package"
 virtual:
-  - lowrisc:ip_interfaces:flash_ctrl_pkg
+  - lowrisc:virtual_ip:flash_ctrl_pkg
 
 filesets:
   files_rtl:
     depend:
       - ${top_pkg_vlnv}
       - lowrisc:prim:util
       - lowrisc:ip:lc_ctrl_pkg
-      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg", pwrmgr_vlnv_prefix)}
+      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg")}
       - lowrisc:ip:jtag_pkg
       - lowrisc:ip:edn_pkg
       - lowrisc:tlul:headers

diff --git a/hw/ip_templates/flash_ctrl/flash_ctrl_prim_reg_top.core.tpl b/hw/ip_templates/flash_ctrl/flash_ctrl_prim_reg_top.core.tpl
@@ -5,7 +5,7 @@ CAPI=2:
 name: ${instance_vlnv("lowrisc:ip:flash_ctrl_prim_reg_top:1.0")}
 description: "Generic register top for the FLASH wrapper"
 virtual:
-  - lowrisc:ip_interfaces:flash_ctrl_prim_reg_top
+  - lowrisc:virtual_ip:flash_ctrl_prim_reg_top
 
 filesets:
   files_rtl:

diff --git a/hw/ip_templates/gpio/data/gpio.tpldesc.hjson b/hw/ip_templates/gpio/data/gpio.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "module_instance_name"
       desc: "instance name in case there are multiple gpio instances"

diff --git a/hw/ip_templates/otp_ctrl/data/otp_ctrl.tpldesc.hjson b/hw/ip_templates/otp_ctrl/data/otp_ctrl.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "otp_mmap"
       desc: "An object containing the memory map and all attributes"

diff --git a/hw/ip_templates/otp_ctrl/dv/cov/otp_ctrl_cov.core.tpl b/hw/ip_templates/otp_ctrl/dv/cov/otp_ctrl_cov.core.tpl
@@ -4,13 +4,11 @@ CAPI=2:
 # SPDX-License-Identifier: Apache-2.0
 name: ${instance_vlnv("lowrisc:dv:otp_ctrl_cov")}
 description: "OTP_CTRL functional coverage and bind files"
-virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_cov
 
 filesets:
   files_rtl:
     depend:
-      - lowrisc:ip_interfaces:pwrmgr_pkg
+      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg")}
       - ${instance_vlnv("lowrisc:ip:otp_ctrl_top_specific_pkg")}
 
   files_dv:

diff --git a/hw/ip_templates/otp_ctrl/dv/env/otp_ctrl_env.core.tpl b/hw/ip_templates/otp_ctrl/dv/env/otp_ctrl_env.core.tpl
@@ -4,8 +4,6 @@ CAPI=2:
 # SPDX-License-Identifier: Apache-2.0
 name: ${instance_vlnv("lowrisc:dv:otp_ctrl_env:0.1")}
 description: "OTP_CTRL DV UVM environment"
-virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_env
 
 filesets:
   files_dv:

diff --git a/hw/ip_templates/otp_ctrl/dv/env/otp_ctrl_mem_bkdr_util.core.tpl b/hw/ip_templates/otp_ctrl/dv/env/otp_ctrl_mem_bkdr_util.core.tpl
@@ -4,8 +4,6 @@ CAPI=2:
 # SPDX-License-Identifier: Apache-2.0
 name: ${instance_vlnv("lowrisc:dv:otp_ctrl_mem_bkdr_util:0.1")}
 description: "OTP_CTRL mem_bkdr_util support package"
-virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_mem_bkdr_util
 
 filesets:
   files_dv:

diff --git a/hw/ip_templates/otp_ctrl/dv/otp_ctrl_sim.core.tpl b/hw/ip_templates/otp_ctrl/dv/otp_ctrl_sim.core.tpl
@@ -4,8 +4,6 @@ CAPI=2:
 # SPDX-License-Identifier: Apache-2.0
 name: ${instance_vlnv("lowrisc:dv:otp_ctrl_sim:0.1")}
 description: "OTP_CTRL DV sim target"
-virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_sim
 
 filesets:
   files_rtl:

diff --git a/hw/ip_templates/otp_ctrl/dv/sva/otp_ctrl_sva.core.tpl b/hw/ip_templates/otp_ctrl/dv/sva/otp_ctrl_sva.core.tpl
@@ -4,8 +4,6 @@ CAPI=2:
 # SPDX-License-Identifier: Apache-2.0
 name: ${instance_vlnv("lowrisc:dv:otp_ctrl_sva:0.1")}
 description: "OTP_CTRL assertion modules and bind file."
-virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_sva
 
 filesets:
   files_dv:

diff --git a/hw/ip_templates/otp_ctrl/dv/tests/otp_ctrl_test.core.tpl b/hw/ip_templates/otp_ctrl/dv/tests/otp_ctrl_test.core.tpl
@@ -4,8 +4,6 @@ CAPI=2:
 # SPDX-License-Identifier: Apache-2.0
 name: ${instance_vlnv("lowrisc:dv:otp_ctrl_test:0.1")}
 description: "OTP_CTRL DV UVM test"
-virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_test
 
 filesets:
   files_dv:

diff --git a/hw/ip_templates/otp_ctrl/otp_ctrl.core.tpl b/hw/ip_templates/otp_ctrl/otp_ctrl.core.tpl
@@ -5,7 +5,7 @@ CAPI=2:
 name: ${instance_vlnv("lowrisc:ip:otp_ctrl:1.0")}
 description: "OTP Controller"
 virtual:
-  - lowrisc:ip_interfaces:otp_ctrl
+  - lowrisc:virtual_ip:otp_ctrl
 
 filesets:
   files_rtl:
@@ -25,7 +25,7 @@ filesets:
       - lowrisc:prim:secded
       - lowrisc:prim:edn_req
       - lowrisc:prim:sec_anchor
-      - lowrisc:ip_interfaces:pwrmgr_pkg
+      - ${instance_vlnv("lowrisc:ip:pwrmgr_pkg")}
       - lowrisc:ip:edn_pkg
       - lowrisc:prim:sparse_fsm
       - "fileset_partner  ? (partner:systems:ast_pkg)"

diff --git a/hw/ip_templates/otp_ctrl/otp_ctrl_prim_reg_top.core b/hw/ip_templates/otp_ctrl/otp_ctrl_prim_reg_top.core
@@ -10,7 +10,7 @@ filesets:
       # otp_ctrl_prim_reg_top.sv should depend on generic items for now.
       # This may change and will require reworking the flow to generate
       # the otp prim.
-      - lowrisc:ip_interfaces:otp_ctrl_top_specific_pkg
+      - lowrisc:virtual_ip:otp_ctrl_top_specific_pkg
     files:
       - rtl/otp_ctrl_prim_reg_top.sv
     file_type: systemVerilogSource

diff --git a/hw/ip_templates/otp_ctrl/otp_ctrl_top_specific_pkg.core.tpl b/hw/ip_templates/otp_ctrl/otp_ctrl_top_specific_pkg.core.tpl
@@ -5,7 +5,7 @@ CAPI=2:
 name: ${instance_vlnv("lowrisc:ip:otp_ctrl_top_specific_pkg:1.0")}
 description: "OTP Controller Top Specific Packages"
 virtual:
-  - lowrisc:ip_interfaces:otp_ctrl_top_specific_pkg
+  - lowrisc:virtual_ip:otp_ctrl_top_specific_pkg
 
 filesets:
   files_rtl:

diff --git a/hw/ip_templates/otp_ctrl/syn/otp_ctrl_gtech_syn_cfg.hjson.tpl b/hw/ip_templates/otp_ctrl/syn/otp_ctrl_gtech_syn_cfg.hjson.tpl
@@ -6,7 +6,7 @@
   name: otp_ctrl
 
   // Fusesoc core file used for building the file list.
-  fusesoc_core: lowrisc:opentitan:top_${topname}_{name}:0.1
+  fusesoc_core: lowrisc:${topname}_ip:{name}:0.1
 
   import_cfgs: [// Project wide common GTECH synthesis config file
                 "{proj_root}/hw/syn/tools/dvsim/common_gtech_syn_cfg.hjson"]

diff --git a/hw/ip_templates/otp_ctrl/syn/otp_ctrl_syn_cfg.hjson.tpl b/hw/ip_templates/otp_ctrl/syn/otp_ctrl_syn_cfg.hjson.tpl
@@ -6,7 +6,7 @@
   name: otp_ctrl
 
   // Fusesoc core file used for building the file list.
-  fusesoc_core: lowrisc:opentitan:top_${topname}_{name}:0.1
+  fusesoc_core: lowrisc:${topname}_ip:{name}:0.1
 
   import_cfgs: [// Project wide common synthesis config file
                 "{proj_root}/hw/syn/tools/dvsim/common_syn_cfg.hjson"]

diff --git a/hw/ip_templates/pinmux/data/pinmux.tpldesc.hjson b/hw/ip_templates/pinmux/data/pinmux.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "n_wkup_detect"
       desc: "Number of wakeups"

diff --git a/hw/ip_templates/pinmux/pinmux_pkg.core.tpl b/hw/ip_templates/pinmux/pinmux_pkg.core.tpl
@@ -5,7 +5,7 @@ CAPI=2:
 name: ${instance_vlnv("lowrisc:ip:pinmux_pkg:0.1")}
 description: "Pinmux package"
 virtual:
-  - lowrisc:ip_interfaces:pinmux_pkg
+  - lowrisc:virtual_ip:pinmux_pkg
 
 filesets:
   files_rtl:

diff --git a/hw/ip_templates/pwrmgr/data/pwrmgr.tpldesc.hjson b/hw/ip_templates/pwrmgr/data/pwrmgr.tpldesc.hjson
@@ -9,6 +9,12 @@
       type: "string"
       default: ""
     }
+    {
+      name: "uniquified_modules"
+      desc: "A dictionary mapping template_names to uniquified_names"
+      type: "object"
+      default: {"clkmgr": "clkmgr1"}
+    }
     {
       name: "NumWkups"
       desc: "Number of wakeup requests"

diff --git a/hw/ip_templates/pwrmgr/pwrmgr_pkg.core.tpl b/hw/ip_templates/pwrmgr/pwrmgr_pkg.core.tpl
@@ -5,7 +5,7 @@ CAPI=2:
 name: ${instance_vlnv("lowrisc:ip:pwrmgr_pkg:0.1")}
 description: "Power manager package"
 virtual:
-  - lowrisc:ip_interfaces:pwrmgr_pkg
+  - lowrisc:virtual_ip:pwrmgr_pkg
 
 filesets:
   files_rtl: