IR+frontend: Add plugin metadata

Author: Hugo Lom

topwrap/frontend/yaml/design.py

@@ -37,7 +37,13 @@
 from topwrap.model.interface import Interface, InterfaceMode
 from topwrap.model.memory_map import MemoryMap as IRMemoryMap
 from topwrap.model.memory_map import MemoryMapSubordinate
-from topwrap.model.misc import ElaboratableValue, FileReference, Identifier, ObjectId
+from topwrap.model.misc import (
+    ElaboratableValue,
+    FileReference,
+    Identifier,
+    ObjectId,
+    PluginMetadata,
+)
 from topwrap.model.module import Module
 from topwrap.resource_field import RepoReferenceHandler
 
@@ -221,8 +227,15 @@ def _parse_hier(
 
         self._parse_clocks_resets(design, desc)
 
+        self._parse_extensions(design, desc)
+
         return design
 
+    def _parse_extensions(self, des: Design, desc: DesignDescription):
+        for plugin_name, metadata in desc.extensions.items():
+            md = PluginMetadata(name=plugin_name, data=metadata)
+            des.add_metadata(md)
+
     def _parse_parameters(self, desc: DesignDescription, design: Design):
         for cname, ip in desc.ips.items():
             comp = design.components.find_by_name(cname)

topwrap/frontend/yaml/design_schema.py

@@ -185,6 +185,7 @@ class DesignDescription(MarshmallowDataclassExtensions):
     clock_domains: Dict[str, DesignSectionClockDomain] = ext_field(dict)
     reset_domains: Dict[str, DesignSectionResetDomain] = ext_field(dict)
     memory_maps: Dict[str, MemoryMap] = ext_field(dict)
+    extensions: Dict[str, Any] = ext_field(dict)
 
     Schema: ClassVar[Type[marshmallow.Schema]] = DesignDescriptionSchema
 

topwrap/model/design.py

@@ -24,6 +24,7 @@
     ModelBase,
     ObjectId,
     Parameter,
+    PluginMetadata,
     QuerableView,
     VariableName,
     set_parent,
@@ -155,6 +156,7 @@ class Design(ModelBase):
     _reset_domains: list[ResetDomain]
     memory_maps: dict[str, MemoryMap]
     parent: Module
+    _extensions: list[PluginMetadata]
 
     def __init__(
         self,
@@ -165,6 +167,7 @@ def __init__(
         clock_domains: Iterable[ClockDomain] = (),
         reset_domains: Iterable[ResetDomain] = (),
         memory_maps: Optional[dict[str, MemoryMap]] = None,
+        extensions: Iterable[PluginMetadata] = (),
     ) -> None:
         super().__init__()
         self._components = []
@@ -173,6 +176,7 @@ def __init__(
         self._clock_domains = []
         self._reset_domains = []
         self.memory_maps = {}
+        self._extensions = []
 
         if memory_maps is not None:
             self.add_memory_maps(memory_maps)
@@ -186,6 +190,8 @@ def __init__(
             self.add_clock_domain(domain)
         for domain in reset_domains:
             self.add_reset_domain(domain)
+        for data in extensions:
+            self.add_metadata(data)
 
     @property
     def components(self) -> QuerableView[ModuleInstance]:
@@ -207,6 +213,10 @@ def clock_domains(self) -> QuerableView[ClockDomain]:
     def reset_domains(self) -> QuerableView[ResetDomain]:
         return QuerableView(self._reset_domains)
 
+    @property
+    def extensions(self) -> QuerableView[PluginMetadata]:
+        return QuerableView(self._extensions)
+
     def add_component(self, component: ModuleInstance):
         set_parent(component, self)
         self._components.append(component)
@@ -227,6 +237,10 @@ def add_reset_domain(self, domain: ResetDomain):
         set_parent(domain, self)
         self._reset_domains.append(domain)
 
+    def add_metadata(self, metadata: PluginMetadata):
+        set_parent(metadata, self)
+        self._extensions.append(metadata)
+
     def add_memory_maps(self, mem_maps: dict[str, MemoryMap]):
         for memory_map in mem_maps.values():
             memory_map.parent = self

topwrap/model/misc.py

@@ -290,3 +290,17 @@ def __eq__(self, value: object) -> bool:
         if isinstance(value, Parameter):
             return self.name == value.name and self.default_value == value.default_value
         return NotImplemented
+
+
+class PluginMetadata(ModelBase):
+    """Represents generic module data"""
+
+    parent: Module
+    name: VariableName
+    data: Any
+
+    def __init__(self, *, name: VariableName, data: Any) -> None:
+        super().__init__()
+        self.name = name
+        self.data = data
+