[topgen] Generically filter for MMIO region visible devices

Remove hardcoded devices and interfaces for MMIO region filtering by adding two new optional module attributes cpu_visible and cpu_not_visible. Signed-off-by: Robert Schilling <[email protected]>
lowRISC · May 23, 2024 · 6cd511e · 6cd511e
1 parent 3216fab
commit 6cd511e
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 100 deletions.
diff --git a/hw/top_darjeeling/data/autogen/top_darjeeling.gen.hjson b/hw/top_darjeeling/data/autogen/top_darjeeling.gen.hjson
@@ -4082,6 +4082,10 @@
           hart: 0x30600000
         }
       }
+      cpu_visible:
+      [
+        ram
+      ]
       memory:
       {
         ram:
@@ -4277,6 +4281,12 @@
           soc_dbg: 0x00000000
         }
       }
+      cpu_not_visible:
+      [
+        mem
+        regs
+        dbg
+      ]
       param_decl:
       {
         SecVolatileRawUnlockEn: top_pkg::SecVolatileRawUnlockEn

diff --git a/hw/top_darjeeling/data/top_darjeeling.hjson b/hw/top_darjeeling/data/top_darjeeling.hjson
@@ -553,6 +553,7 @@
         regs: {hart: "0x30500000"},
         ram:  {hart: "0x30600000"},
       },
+      cpu_visible: ['ram']
       // Memory regions must be associated with a dedicated
       // TL-UL device interface.
       memory: {
@@ -577,6 +578,7 @@
         regs: {hart: "0x21200000"},
         dbg:  {soc_dbg: "0x00000000"},
       },
+      cpu_not_visible: ["mem", "regs", "dbg"]
       param_decl: {
         // NOTE THAT THIS IS A FEATURE FOR TEST CHIPS ONLY TO MITIGATE
         // THE RISK OF A BROKEN OTP MACRO. THIS WILL BE DISABLED FOR

diff --git a/hw/top_darjeeling/sw/autogen/chip/top_darjeeling.rs b/hw/top_darjeeling/sw/autogen/chip/top_darjeeling.rs
@@ -2748,4 +2748,4 @@ pub enum TopDarjeelingHintableClocks {
 /// configuration space, i.e. ROM, main SRAM, and flash are excluded but
 /// retention SRAM, spi_device memory, or usbdev memory are included.
 pub const TOP_DARJEELING_MMIO_BASE_ADDR: usize = 0x21100000;
-pub const TOP_DARJEELING_MMIO_SIZE_BYTES: usize = 0xF400020;
+pub const TOP_DARJEELING_MMIO_SIZE_BYTES: usize = 0xF501000;
diff --git a/hw/top_darjeeling/sw/autogen/chip/top_darjeeling_memory.rs b/hw/top_darjeeling/sw/autogen/chip/top_darjeeling_memory.rs
@@ -737,4 +737,4 @@ pub const TOP_DARJEELING_RV_CORE_IBEX_CFG_SIZE_BYTES: usize = 0x800;
 /// configuration space, i.e. ROM, main SRAM, and flash are excluded but
 /// retention SRAM, spi_device memory, or usbdev memory are included.
 pub const TOP_DARJEELING_MMIO_BASE_ADDR: usize = 0x21100000;
-pub const TOP_DARJEELING_MMIO_SIZE_BYTES: usize = 0xF400020;
+pub const TOP_DARJEELING_MMIO_SIZE_BYTES: usize = 0xF501000;
diff --git a/hw/top_earlgrey/data/autogen/top_earlgrey.gen.hjson b/hw/top_earlgrey/data/autogen/top_earlgrey.gen.hjson
@@ -4814,6 +4814,10 @@
           hart: 0x40600000
         }
       }
+      cpu_visible:
+      [
+        ram
+      ]
       memory:
       {
         ram:
@@ -5462,6 +5466,11 @@
           hart: 0x41200000
         }
       }
+      cpu_not_visible:
+      [
+        mem
+        regs
+      ]
       generate_dif: false
       clock_connections:
       {

diff --git a/hw/top_earlgrey/data/top_earlgrey.hjson b/hw/top_earlgrey/data/top_earlgrey.hjson
@@ -649,6 +649,7 @@
         regs: {hart: "0x40500000"},
         ram:  {hart: "0x40600000"},
       }
+      cpu_visible: ["ram"]
       // Memory regions must be associated with a dedicated
       // TL-UL device interface.
       memory: {
@@ -705,6 +706,7 @@
         mem:  {hart: "0x00010000"},
         regs: {hart: "0x41200000"}
       },
+      cpu_not_visible: ["mem", "regs"]
       generate_dif: "False"
     },
     { name: "rv_plic",

diff --git a/util/topgen/c.py b/util/topgen/c.py
@@ -10,32 +10,11 @@
 from mako.template import Template
 from reggen.ip_block import IpBlock
 
-from .lib import Name, get_base_and_size
+from .lib import Name, get_base_and_size, MemoryRegion, init_mmio_region
 
 C_FILE_EXTENSIONS = (".c", ".h", ".cc", ".inc")
 
 
-class MemoryRegion(object):
-    def __init__(self, name: Name, base_addr: int, size_bytes: int):
-        assert isinstance(base_addr, int)
-        self.name = name
-        self.base_addr = base_addr
-        self.size_bytes = size_bytes
-        self.size_words = (size_bytes + 3) // 4
-
-    def base_addr_name(self):
-        return self.name + Name(["base", "addr"])
-
-    def offset_name(self):
-        return self.name + Name(["offset"])
-
-    def size_bytes_name(self):
-        return self.name + Name(["size", "bytes"])
-
-    def size_words_name(self):
-        return self.name + Name(["size", "words"])
-
-
 class CEnum(object):
     def __init__(self, name):
         self.name = name
@@ -123,7 +102,7 @@ def __init__(self, top_info, name_to_block: Dict[str, IpBlock]):
         self._init_rstmgr_sw_rsts()
         self._init_pwrmgr_reset_requests()
         self._init_clkmgr_clocks()
-        self._init_mmio_region()
+        self.mmio = init_mmio_region(self.top, self._top_name, self.memories(), self.devices())
 
     def devices(self) -> List[Tuple[Tuple[str, Optional[str]], MemoryRegion]]:
         '''Return a list of MemoryRegion objects for devices on the bus
@@ -511,29 +490,3 @@ def _init_clkmgr_clocks(self):
         self.clkmgr_gateable_clocks = gateable_clocks
         self.clkmgr_hintable_clocks = hintable_clocks
 
-    def _init_mmio_region(self):
-        """
-        Computes the bounds of the MMIO region.
-
-        MMIO region excludes any memory that is separate from the module configuration
-        space, i.e. ROM, main SRAM, and flash are excluded but retention SRAM,
-        spi_device memory, or usbdev memory are included.
-        """
-        memories = [region.base_addr for (_, region) in self.memories()]
-        # TODO(#14345): Remove the hardcoded "rv_dm" name check below.
-        # TODO: we need a cleaner way to define which buses are visible
-        # by the CPU and which ones are not. For now, exclude every
-        # interface with the name `dbg`, since that is attached to the
-        # debug bus which is not connected to the CPU LSU.
-        regions = [
-            region for ((dev_name, if_name), region) in self.devices()
-            if (dev_name == "sram_ctrl_ret_aon" and if_name == 'ram') or
-               (region.base_addr not in memories and dev_name != "rv_dm" and
-                (if_name is None or if_name != 'dbg'))
-        ]
-        # Note: The memory interface of the retention RAM is in the MMIO address space,
-        # which we prefer since it reduces the number of ePMP regions we need.
-        mmio = range(min([r.base_addr for r in regions]),
-                     max([r.base_addr + r.size_bytes for r in regions]))
-        self.mmio = MemoryRegion(self._top_name + Name(["mmio"]), mmio.start,
-                                 mmio.stop - mmio.start)
diff --git a/util/topgen/lib.py b/util/topgen/lib.py
@@ -85,6 +85,27 @@ def remove_part(self, part_to_remove: str) -> "Name":
         return Name([p for p in self.parts if p != part_to_remove])
 
 
+class MemoryRegion(object):
+    def __init__(self, name: Name, base_addr: int, size_bytes: int):
+        assert isinstance(base_addr, int)
+        self.name = name
+        self.base_addr = base_addr
+        self.size_bytes = size_bytes
+        self.size_words = (size_bytes + 3) // 4
+
+    def base_addr_name(self):
+        return self.name + Name(["base", "addr"])
+
+    def offset_name(self):
+        return self.name + Name(["offset"])
+
+    def size_bytes_name(self):
+        return self.name + Name(["size", "bytes"])
+
+    def size_words_name(self):
+        return self.name + Name(["size", "words"])
+
+
 def is_ipcfg(ip: Path) -> bool:  # return bool
     log.info("IP Path: %s" % repr(ip))
     ip_name = ip.parents[1].name
@@ -566,3 +587,31 @@ def is_lc_ctrl(modules):
             return True
 
     return False
+
+
+def init_mmio_region(top, top_name, memories, devices):
+    """
+    Computes the bounds of the MMIO region.
+
+    MMIO region excludes any memory that is separate from the module configuration
+    space, i.e. ROM, main SRAM, and flash are excluded but retention SRAM,
+    spi_device memory, or usbdev memory are included.
+    """
+    memories = [region.base_addr for (_, region) in memories]
+    regions = []
+    for ((dev_name, if_name), region) in devices:
+        module = get_module_by_name(top, dev_name)
+
+        # Ignore interface if explicitly not visible to the CPU
+        if 'cpu_not_visible' in module and if_name in module['cpu_not_visible']:
+            continue
+        # Include interface if explicitly visible to the CPU
+        if (('cpu_visible' in module and if_name in module['cpu_visible']) or
+            region.base_addr not in memories):
+            regions.append(region)
+
+    # Note: The memory interface of the retention RAM is in the MMIO address space,
+    # which we prefer since it reduces the number of ePMP regions we need.
+    mmio = range(min([r.base_addr for r in regions]),
+                    max([r.base_addr + r.size_bytes for r in regions]))
+    return MemoryRegion(top_name + Name(["mmio"]), mmio.start, mmio.stop - mmio.start)
diff --git a/util/topgen/rust.py b/util/topgen/rust.py
@@ -9,32 +9,11 @@
 from mako.template import Template
 from reggen.ip_block import IpBlock
 
-from .lib import Name, get_base_and_size
+from .lib import Name, get_base_and_size, MemoryRegion, init_mmio_region
 
 RUST_FILE_EXTENSIONS = (".rs")
 
 
-class MemoryRegion(object):
-    def __init__(self, name: Name, base_addr: int, size_bytes: int):
-        assert isinstance(base_addr, int)
-        self.name = name
-        self.base_addr = base_addr
-        self.size_bytes = size_bytes
-        self.size_words = (size_bytes + 3) // 4
-
-    def base_addr_name(self):
-        return self.name + Name(["base", "addr"])
-
-    def offset_name(self):
-        return self.name + Name(["offset"])
-
-    def size_bytes_name(self):
-        return self.name + Name(["size", "bytes"])
-
-    def size_words_name(self):
-        return self.name + Name(["size", "words"])
-
-
 class RustEnum(object):
     def __init__(self, top_name, name, repr_type=None):
         self.name = top_name + name
@@ -214,7 +193,7 @@ def __init__(self, top_info, name_to_block: Dict[str, IpBlock], version_stamp: D
         self._init_rstmgr_sw_rsts()
         self._init_pwrmgr_reset_requests()
         self._init_clkmgr_clocks()
-        self._init_mmio_region()
+        self.mmio = init_mmio_region(self.top, self._top_name, self.memories(), self.devices())
 
     def devices(self) -> List[Tuple[Tuple[str, Optional[str]], MemoryRegion]]:
         '''Return a list of MemoryRegion objects for devices on the bus
@@ -597,29 +576,3 @@ def _init_clkmgr_clocks(self):
 
         self.clkmgr_gateable_clocks = gateable_clocks
         self.clkmgr_hintable_clocks = hintable_clocks
-
-    def _init_mmio_region(self):
-        """
-        Computes the bounds of the MMIO region.
-
-        MMIO region excludes any memory that is separate from the module configuration
-        space, i.e. ROM, main SRAM, and flash are excluded but retention SRAM,
-        spi_device memory, or usbdev memory are included.
-        """
-        memories = [region.base_addr for (_, region) in self.memories()]
-        # TODO(#14345): Remove the hardcoded "rv_dm" name check below.
-        # TODO: we need a cleaner way to define which buses are visible
-        # by the CPU and which ones are not. For now, exclude every
-        # interface with the name `dbg`, since that is attached to the
-        # debug bus which is not connected to the CPU LSU.
-        regions = [
-            region for ((dev_name, if_name), region) in self.devices()
-            if region.base_addr not in memories and dev_name != "rv_dm" and
-            (if_name is None or if_name != 'dbg')
-        ]
-        # Note: The memory interface of the retention RAM is in the MMIO address space,
-        # which we prefer since it reduces the number of ePMP regions we need.
-        mmio = range(min([r.base_addr for r in regions]),
-                     max([r.base_addr + r.size_bytes for r in regions]))
-        self.mmio = MemoryRegion(self._top_name + Name(["mmio"]), mmio.start,
-                                 mmio.stop - mmio.start)
diff --git a/util/topgen/validate.py b/util/topgen/validate.py
@@ -193,6 +193,8 @@
     'domain': ['l', 'optional list of power domains, defaults to Domain0'],
     'clock_reset_export': ['l', 'optional list with prefixes for exported '
                                 'clocks and resets at the chip level'],
+    'cpu_visible': ['list', 'List of address spaces visible to the CPU'],
+    'cpu_not_visible': ['list', 'List of address spaces not visible to the CPU'],
     'attr': ['s', 'optional attribute indicating whether the IP is '
                   '"templated" or "reggen_only"'],
     'base_addr': ['g', 'dict of address space mapped to the corresponding '