[topgen] Add tool support for ipgen'ed GPIO

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

Author: Razer6

hw/top_darjeeling/data/top_darjeeling.hjson

@@ -295,6 +295,7 @@
     },
     { name: "gpio",
       type: "gpio",
+      template_type: "gpio",
       clock_srcs: {clk_i: "io_div4"},
       clock_group: "peri",
       reset_connections: {rst_ni: "lc_io_div4"},
@@ -304,7 +305,8 @@
       param_decl: {
         GpioAsHwStrapsEn: "1",
         GpioAsyncOn: "1"
-      }
+      },
+      attr: "ipgen"
     },
     { name: "spi_device",
       type: "spi_device",

hw/top_earlgrey/data/top_earlgrey.hjson

@@ -349,6 +349,7 @@
     },
     { name: "gpio",
       type: "gpio",
+      template_type: "gpio",
       clock_srcs: {clk_i: "io_div4"},
       clock_group: "peri",
       reset_connections: {rst_ni: "lc_io_div4"},
@@ -358,7 +359,8 @@
       param_decl: {
         GpioAsHwStrapsEn: "0",
         GpioAsyncOn: "1"
-      }
+      },
+      attr: "ipgen"
     },
     { name: "spi_device",
       type: "spi_device",

hw/top_englishbreakfast/data/top_englishbreakfast.hjson

@@ -291,6 +291,7 @@
     },
     { name: "gpio",
       type: "gpio",
+      template_type: "gpio",
       clock_srcs: {clk_i: "io_div4"},
       clock_group: "peri",
       reset_connections: {rst_ni: "sys_io_div4"},
@@ -299,7 +300,8 @@
       },
       param_decl: {
         GpioAsyncOn: "1"
-      }
+      },
+      attr: "ipgen"
     }
     { name: "spi_device",
       type: "spi_device",

util/topgen.py

@@ -756,6 +756,23 @@ def generate_racl(top: ConfigT, module: ConfigT, out_path: Path) -> None:
     generate_ipgen(top, module, params, out_path)
 
 
+def _get_gpio_params(top: ConfigT) -> ParamsT:
+    """Extracts parameters for GPIO ipgen."""
+
+    gpio = lib.find_module(top["module"], "gpio")
+    params = {
+        "module_instance_name": gpio["type"]
+    }
+    return params
+
+
+def generate_gpio(top: ConfigT, module: ConfigT,
+                  out_path: Path) -> None:
+    log.info('Generating GPIO with ipgen')
+    params = _get_gpio_params(top)
+    generate_ipgen(top, module, params, out_path)
+
+
 def generate_top_only(top_only_dict: List[str], out_path: Path, top_name: str,
                       alt_hjson_path: str) -> None:
     """Generate the regfile for top_only IPs."""
@@ -1063,6 +1080,9 @@ def insert_ip_attrs(module: ConfigT, params: ParamsT):
         raise SystemExit("There are ipgen modules with multiple instances: "
                          f"{multi_instance_ipgens}")
 
+    if "gpio" in ipgen_instances:
+        instance = ipgen_instances["gpio"][0]
+        insert_ip_attrs(instance, _get_gpio_params(topcfg))
     if "racl_config" in topcfg:
         amend_racl(topcfg, name_to_block, allow_missing_blocks=True)
         assert "racl_ctrl" in ipgen_instances
@@ -1234,6 +1254,9 @@ def generate_modules(template_type: str,
     # Generate rstmgr if there is an instance
     generate_modules("rstmgr", generate_rstmgr, single_instance=True)
 
+    # Generate gpio if there is an instance
+    generate_modules("gpio", generate_gpio, single_instance=True)
+
     # Generate ac_range_check
     generate_modules("ac_range_check",
                      generate_ac_range_check,