[hw,gpio,rtl] Templatize GPIO

Signed-off-by: Robert Schilling <[email protected]>

Author: Razer6

hw/ip_templates/gpio/BUILD renamed to hw/ip_templates/gpio/BUILD.tpl

@@ -13,7 +13,5 @@ filegroup(
             "doc/**",
             "README.md",
         ],
-    ) + [
-        "//hw/ip/gpio/data:all_files",
-    ],
+    ),
 )

hw/ip_templates/gpio/README.md

@@ -10,7 +10,7 @@
 
 This document specifies GPIO hardware IP functionality. This
 module conforms to the [Comportable guideline for peripheral device
-functionality](../../../doc/contributing/hw/comportability/README.md)
+functionality](../../../../doc/contributing/hw/comportability/README.md)
 See that document for integration overview within the broader top
 level system.
 

hw/ip_templates/gpio/data/BUILD

@@ -2,7 +2,7 @@
 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
 // SPDX-License-Identifier: Apache-2.0
 {
-  name:               "gpio",
+  name:               "${module_instance_name}",
   human_name:         "General-Purpose I/O Controller",
   one_line_desc:      "General-purpose I/O pin control interface for software",
   one_paragraph_desc: '''
@@ -119,7 +119,7 @@
       type:    "uni",
       name:    "sampled_straps",
       act:     "req",
-      package: "gpio_pkg",
+      package: "${module_instance_name}_pkg",
       desc:    '''
                This vector contains the sampled strap values.
                ''',

hw/ip_templates/gpio/data/gpio.hjson renamed to hw/ip_templates/gpio/data/gpio.hjson.tpl

@@ -2,7 +2,7 @@
 // Licensed under the Apache License, Version 2.0, see LICENSE for details.
 // SPDX-License-Identifier: Apache-2.0
 {
-  name: "gpio"
+  name: "${module_instance_name}"
   import_testplans: ["hw/dv/tools/dvsim/testplans/csr_testplan.hjson",
                      "hw/dv/tools/dvsim/testplans/alert_test_testplan.hjson",
                      "hw/dv/tools/dvsim/testplans/intr_test_testplan.hjson",

hw/ip_templates/gpio/data/gpio_testplan.hjson renamed to hw/ip_templates/gpio/data/gpio_testplan.hjson.tpl

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 load("//rules/opentitan:hw.bzl", "opentitan_ip")
 
-GPIO = opentitan_ip(
-    name = "gpio",
-    hjson = "//hw/ip/gpio/data:gpio.hjson",
+${module_instance_name.upper()} = opentitan_ip(
+    name = "${module_instance_name}",
+    hjson = "//hw/top_${topname}/ip_autogen/${module_instance_name}:data/${module_instance_name}.hjson",
 )

hw/ip_templates/gpio/defs.bzl renamed to hw/ip_templates/gpio/defs.bzl.tpl

@@ -0,0 +1,4 @@
+# Hardware Interfaces
+
+<!-- BEGIN CMDGEN util/regtool.py --interfaces ./hw/top_${topname}/ip_autogen/${module_instance_name}/data/${module_instance_name}.hjson -->
+<!-- END CMDGEN -->

hw/ip_templates/gpio/doc/checklist.md

@@ -120,4 +120,4 @@ printf("0b%b", *GPIO_INTR_STATE);       // 0b00001100
 
 ## Device Interface Functions (DIFs)
 
-- [Device Interface Functions](../../../../sw/device/lib/dif/dif_gpio.h)
+- [Device Interface Functions](../../../../../sw/device/lib/dif/dif_gpio.h)