lib.wiring: add support for array dimensions to ComponentMetadata.

Author: jfng

amaranth/lib/wiring.py

@@ -1708,6 +1708,18 @@ class ComponentMetadata(Annotation):
     schema = {
         "$schema": "https://json-schema.org/draft/2020-12/schema",
         "$id": "https://amaranth-lang.org/schema/amaranth/0.5/component.json",
+        "$defs": {
+            "dimensions": {
+                "type": "array",
+                "items": {
+                    "type": "integer",
+                    "minimum": 0,
+                },
+            },
+            "annotations": {
+                "type": "object",
+            },
+        },
         "type": "object",
         "properties": {
             "interface": {
@@ -1742,6 +1754,9 @@ class ComponentMetadata(Annotation):
                                                 "type": "string",
                                                 "pattern": "^[+-]?[0-9]+$",
                                             },
+                                            "dimensions": {
+                                                "$ref": "#/$defs/dimensions",
+                                            },
                                         },
                                         "additionalProperties": False,
                                         "required": [
@@ -1751,6 +1766,7 @@ class ComponentMetadata(Annotation):
                                             "width",
                                             "signed",
                                             "init",
+                                            "dimensions",
                                         ],
                                     },
                                     {
@@ -1762,14 +1778,18 @@ class ComponentMetadata(Annotation):
                                             "members": {
                                                 "$ref": "#/properties/interface/properties/members",
                                             },
+                                            "dimensions": {
+                                                "$ref": "#/$defs/dimensions",
+                                            },
                                             "annotations": {
-                                                "type": "object",
+                                                "$ref": "#/$defs/annotations",
                                             },
                                         },
                                         "additionalProperties": False,
                                         "required": [
                                             "type",
                                             "members",
+                                            "dimensions",
                                             "annotations",
                                         ],
                                     },
@@ -1779,7 +1799,7 @@ class ComponentMetadata(Annotation):
                         "additionalProperties": False,
                     },
                     "annotations": {
-                        "type": "object",
+                        "$ref": "#/$defs/annotations",
                     },
                 },
                 "additionalProperties": False,
@@ -1839,6 +1859,7 @@ def describe_member(member, *, path):
                     "width": cast_shape.width,
                     "signed": cast_shape.signed,
                     "init": str(member._init_as_const.value),
+                    "dimensions": list(member.dimensions),
                 }
             elif member.is_signature:
                 return {
@@ -1847,6 +1868,7 @@ def describe_member(member, *, path):
                         name: describe_member(sub_member, path=(*path, name))
                         for name, sub_member in member.signature.members.items()
                     },
+                    "dimensions": list(member.dimensions),
                     "annotations": {
                         annotation.schema["$id"]: annotation.as_json()
                         for annotation in member.signature.annotations(member)

tests/test_lib_wiring.py

@@ -1194,7 +1194,7 @@ def as_json(self):
         class Signature1(Signature):
             def __init__(self):
                 super().__init__({
-                    "i": In(unsigned(8), init=42),
+                    "i": In(unsigned(8), init=42).array(2).array(3),
                     "o": Out(signed(4))
                 })
 
@@ -1205,7 +1205,7 @@ class Signature2(Signature):
             def __init__(self):
                 super().__init__({
                     "clk": In(1),
-                    "foo": Out(Signature1()),
+                    "foo": Out(Signature1()).array(4),
                     "oof": In(Signature1())
                 })
 
@@ -1227,6 +1227,7 @@ def __init__(self):
                         "width": 1,
                         "signed": False,
                         "init": "0",
+                        "dimensions": [],
                     },
                     "foo": {
                         "type": "interface",
@@ -1238,6 +1239,7 @@ def __init__(self):
                                 "width": 8,
                                 "signed": False,
                                 "init": "42",
+                                "dimensions": [3, 2],
                             },
                             "o": {
                                 "type": "port",
@@ -1246,8 +1248,10 @@ def __init__(self):
                                 "width": 4,
                                 "signed": True,
                                 "init": "0",
+                                "dimensions": [],
                             },
                         },
+                        "dimensions": [4],
                         "annotations": {
                             "https://example.com/schema/foo/0.1/bar.json": {
                                 "hello": True,
@@ -1264,6 +1268,7 @@ def __init__(self):
                                 "width": 8,
                                 "signed": False,
                                 "init": "42",
+                                "dimensions": [3, 2],
                             },
                             "o": {
                                 "type": "port",
@@ -1272,8 +1277,10 @@ def __init__(self):
                                 "width": 4,
                                 "signed": True,
                                 "init": "0",
+                                "dimensions": [],
                             },
                         },
+                        "dimensions": [],
                         "annotations": {
                             "https://example.com/schema/foo/0.1/bar.json": {
                                 "hello": True,