floogen: Render endpoint enums to index into Sam (#111)

* floogen(tpl): Remove obsolete template

* floogen(routing): Allow description of address rules

* floogen(tpl): Render enums to index the SAM

* hw(pkg): Add `min` helper function

* docs: Update CHANGELOG

Author: fischeti

CHANGELOG.md

@@ -25,6 +25,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added support for single-AXI configuration networks. (https://github.com/pulp-platform/FlooNoC/pull/69)
 - Support for negative increments when specifying a `src_range` or `dst_range` in the `connections` schema. (https://github.com/pulp-platform/FlooNoC/pull/77)
 - Add support for multiple non-contiguous address ranges for endpoints. (https://github.com/pulp-platform/FlooNoC/pull/80)
+- Added a `sam_idx_e` enum in the package, which allows to directly index into the system address map. (https://github.com/pulp-platform/FlooNoC/pull/111)
 
 ### Changed
 

floogen/model/network.py

@@ -660,8 +660,14 @@ def gen_sam(self):
             dest = ni.id
             if self.routing.xy_id_offset is not None:
                 dest -= self.routing.xy_id_offset
-            for addr_range in ni.addr_range:
-                addr_rule = RouteMapRule(dest=dest, addr_range=addr_range, desc=ni.name)
+            for i, addr_range in enumerate(ni.addr_range):
+                rule_name = ni.render_enum_name()
+                if addr_range.desc is not None:
+                    rule_name += f"_{addr_range.desc}"
+                elif len(ni.addr_range) > 1:
+                    rule_name += f"_{i}"
+                rule_name += "_sam_idx"
+                addr_rule = RouteMapRule(dest=dest, addr_range=addr_range, desc=rule_name)
                 addr_table.append(addr_rule)
         return RouteMap(name="sam", rules=addr_table)
 
@@ -760,6 +766,13 @@ def render_ep_enum(self):
         fields_dict["num_endpoints"] = len(fields_dict)
         return sv_enum_typedef(name="ep_id_e", fields_dict=fields_dict)
 
+    def render_sam_idx_enum(self):
+        """Render the system address map index enum in the generated code."""
+        fields_dict = {}
+        for i, desc in enumerate(reversed(self.routing.sam.rules)):
+            fields_dict[desc.desc] = i
+        return sv_enum_typedef(name="sam_idx_e", fields_dict=fields_dict)
+
     def render_network(self):
         """Render the network in the generated code."""
         return self.noc_tpl.render(noc=self)

floogen/model/routing.py

@@ -175,6 +175,7 @@ class AddrRange(BaseModel):
     size: int
     base: Optional[int] = None
     idx: Optional[int] = None
+    desc: Optional[str] = None
 
     def __str__(self):
         return f"[{self.start:X}:{self.end:X}]"

floogen/templates/floo_flit_pkg.sv.mako

@@ -20,6 +20,8 @@ package floo_${noc.name}_noc_pkg;
 
   ${noc.render_ep_enum()}
 
+  ${noc.render_sam_idx_enum()}
+
   ${noc.routing.render_typedefs()}
 
 % if noc.routing.use_id_table:

floogen/templates/floo_top_noc_pkg.sv.mako

@@ -254,6 +254,11 @@ package floo_pkg;
     return (a > b) ? a : b;
   endfunction
 
+  /// Helper function to calculate the minimum of two unsigned integers
+  function automatic int unsigned min(int unsigned a, int unsigned b);
+    return (a < b) ? a : b;
+  endfunction
+
   /// Returns the AXI config the resulting AXI config when joining a narrow
   /// and wide AXI subordinate interfaces.
   function automatic axi_cfg_t axi_join_cfg(axi_cfg_t cfg_n, axi_cfg_t cfg_w);