[dtgen] Support IPs without a regblock

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

Author: Razer6

util/dtgen/dt_ip.c.tpl

@@ -60,13 +60,15 @@ dt_instance_id_t dt_${device_name}_instance_id(
   return TRY_GET_DT(dt, kDtInstanceIdUnknown)->inst_id;
 }
 
+% if helper.has_reg_blocks():
 uint32_t dt_${device_name}_reg_block(
     dt_${device_name}_t dt,
     dt_${device_name}_reg_block_t reg_block) {
   // Return a recognizable address in case of wrong argument.
   return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
 }
 
+% endif
 uint32_t dt_${device_name}_memory_base(
     dt_${device_name}_t dt,
     dt_${device_name}_memory_t mem) {

util/dtgen/dt_ip.h.tpl

@@ -38,27 +38,29 @@ ${helper.render_extension(Extension.DtIpPos.HeaderIncludes)}
  */
 ${helper.inst_enum.render()}
 
+% if helper.has_reg_blocks():
 /**
  * List of register blocks.
  *
  * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
  */
 ${helper.reg_block_enum.render()}
 
-/**
- * List of memories.
- *
- * Memories are guaranteed to start at 0 and to be consecutively numbered.
- */
-${helper.memory_enum.render()}
-
 /** Primary register block (associated with the "primary" set of registers that control the IP). */
 <%
   default_reg_block_name = (helper.reg_block_enum.name + Name(["primary"])).as_c_enum()
   default_reg_block_value = (helper.reg_block_enum.name + Name.from_snake_case(helper.default_node)).as_c_enum()
 %>\
 static const ${helper.reg_block_enum.name.as_c_type()} ${default_reg_block_name} = ${default_reg_block_value};
 
+% endif
+/**
+ * List of memories.
+ *
+ * Memories are guaranteed to start at 0 and to be consecutively numbered.
+ */
+${helper.memory_enum.render()}
+
 % if helper.has_irqs():
 /**
  * List of IRQs.
@@ -151,6 +153,7 @@ dt_${device_name}_t dt_${device_name}_from_instance_id(dt_instance_id_t inst_id)
  */
 dt_instance_id_t dt_${device_name}_instance_id(dt_${device_name}_t dt);
 
+% if helper.has_reg_blocks():
 /**
  * Get the register base address of an instance.
  *
@@ -176,6 +179,7 @@ static inline uint32_t dt_${device_name}_primary_reg_block(
   return dt_${device_name}_reg_block(dt, ${default_reg_block_value});
 }
 
+% endif
 /**
  * Get the base address of a memory.
  *

util/dtgen/helper.py

@@ -675,8 +675,10 @@ def _init_reg_blocks(self):
             else:
                 reg_blocks.append(rb)
 
-        assert self.default_node in reg_blocks, \
-            "default node ({}) is invalid".format(self.default_node)
+        # If there are no register blocks, we don't need to validate default_node
+        if reg_blocks:
+            assert self.default_node in reg_blocks, \
+                "default node ({}) is invalid".format(self.default_node)
 
         self.reg_block_enum = self._enum_type(
             Name([]), Name(["dt"]) + self.ip_name + Name(["reg", "block"]))
@@ -881,6 +883,9 @@ def _init_instances(self):
                 self.inst_enum.add_first_constant("First instance")
             self.inst_enum.add_count_constant("Number of instances")
 
+    def has_reg_blocks(self):
+        return len(self.ip.reg_blocks) > 0
+
     def has_features(self):
         return len(self.ip.features) > 0
 
@@ -897,15 +902,16 @@ def _create_dt_struct(self):
             field_type = ScalarType(TopHelper.DT_INSTANCE_ID_NAME),
             docstring = "Instance ID"
         )
-        self.inst_struct.add_field(
-            name = self.REG_BLOCK_ADDR_FIELD_NAME,
-            field_type = ArrayMapType(
-                elem_type = ScalarType("uint32_t"),
-                index_type = ScalarType(self.reg_block_enum.name),
-                length = Name(["count"]),
-            ),
-            docstring = "Base address of each register block"
-        )
+        if self.has_reg_blocks():
+            self.inst_struct.add_field(
+                name = self.REG_BLOCK_ADDR_FIELD_NAME,
+                field_type = ArrayMapType(
+                    elem_type = ScalarType("uint32_t"),
+                    index_type = ScalarType(self.reg_block_enum.name),
+                    length = Name(["count"]),
+                ),
+                docstring = "Base address of each register block"
+            )
         self.inst_struct.add_field(
             name = self.MEM_ADDR_FIELD_NAME,
             field_type = ArrayMapType(
@@ -997,19 +1003,20 @@ def _create_instance(self, m):
         # Instance ID.
         inst_desc[self.INST_ID_FIELD_NAME] = Name.from_snake_case(modname)
         # Reg block address map.
-        reg_block_map = OrderedDict()
-        for rb in self.ip.reg_blocks.keys():
-            rb_key = rb
-            if rb is None:
-                rb = self.UNNAMED_REG_BLOCK_NAME
-                rb_key = "null"  # Due to json serializing, None appears as null.
-            rb = Name.from_snake_case(rb)
-            # It is possible that this module is not accessible in this
-            # address space. In this case, return a dummy value.
-            # FIXME Maybe find a better way of doing this.
-            assert rb_key in m["base_addrs"]
-            reg_block_map[rb] = m["base_addrs"][rb_key].get(self._addr_space, "0xffffffff")
-        inst_desc[self.REG_BLOCK_ADDR_FIELD_NAME] = reg_block_map
+        if self.has_reg_blocks():
+            reg_block_map = OrderedDict()
+            for rb in self.ip.reg_blocks.keys():
+                rb_key = rb
+                if rb is None:
+                    rb = self.UNNAMED_REG_BLOCK_NAME
+                    rb_key = "null"  # Due to json serializing, None appears as null.
+                rb = Name.from_snake_case(rb)
+                # It is possible that this module is not accessible in this
+                # address space. In this case, return a dummy value.
+                # FIXME Maybe find a better way of doing this.
+                assert rb_key in m["base_addrs"]
+                reg_block_map[rb] = m["base_addrs"][rb_key].get(self._addr_space, "0xffffffff")
+            inst_desc[self.REG_BLOCK_ADDR_FIELD_NAME] = reg_block_map
         # Memories.
         mem_addr_map = OrderedDict()
         mem_size_map = OrderedDict()

util/dttool.py

@@ -182,8 +182,11 @@ def main():
         for (ipname, ip) in name_to_block.items():
             default_node = args.default_node
             if default_node is None:
-                # Pick the first one.
-                default_node = list(ip.reg_blocks.keys())[0]
+                if len(ip.reg_blocks) == 0:
+                    default_node = None
+                else:
+                    # Pick the first one.
+                    default_node = list(ip.reg_blocks.keys())[0]
                 if len(ip.reg_blocks) > 1:
                     logging.warning(f"IP {ipname} has more than one register block node " +
                                     f"but no default was specified, will use {default_node}")
@@ -200,13 +203,11 @@ def main():
             render_template(
                 TOPGEN_TEMPLATE_PATH / "dt_ip.h.tpl",
                 outdir / "dt_{}.h".format(ipname),
-                default_node = default_node,
                 helper = helper,
             )
             render_template(
                 TOPGEN_TEMPLATE_PATH / "dt_ip.c.tpl",
                 outdir / "dt_{}.c".format(ipname),
-                default_node = default_node,
                 helper = helper,
             )