Verilog experiment

.gitignore

@@ -16,3 +16,5 @@ __pycache__/
 
 # build outputs
 build
+/overrides.txt
+.python-version

chipflow_digital_ip/io/__init__.py

@@ -2,5 +2,13 @@
 from ._uart import UARTPeripheral
 from ._i2c import I2CPeripheral
 from ._spi import SPIPeripheral
+from ._verilog_wrapper import VerilogWrapper, load_wrapper_from_toml
 
-__all__ = ['GPIOPeripheral', 'UARTPeripheral', 'I2CPeripheral', 'SPIPeripheral']
+__all__ = [
+    'GPIOPeripheral',
+    'UARTPeripheral',
+    'I2CPeripheral',
+    'SPIPeripheral',
+    'VerilogWrapper',
+    'load_wrapper_from_toml',
+]

chipflow_digital_ip/io/_glasgow_i2c.py

@@ -1,4 +1,4 @@
-from amaranth import *
+from amaranth import * 
 from amaranth.lib.cdc import FFSynchronizer
 
 

chipflow_digital_ip/io/_glasgow_iostream.py

@@ -1,9 +1,13 @@
-from amaranth import *
+from amaranth import * 
 from amaranth.lib import data, wiring, stream, io
 from amaranth.lib.wiring import In, Out
 
+from amaranth_types.types import ShapeLike
+
+
 __all__ = ["IOStreamer", "PortGroup"]
 
+
 class PortGroup:
     """Group of Amaranth library I/O ports.
 
@@ -118,7 +122,7 @@ class IOStreamer(wiring.Component):
     """
 
     @staticmethod
-    def o_stream_signature(ioshape, /, *, ratio=1, meta_layout=0):
+    def o_stream_signature(ioshape, /, *, ratio=1, meta_layout: ShapeLike = 0):
         return stream.Signature(data.StructLayout({
             "port": _map_ioshape("o", ioshape, lambda width: data.StructLayout({
                 "o":  width if ratio == 1 else data.ArrayLayout(width, ratio),
@@ -129,16 +133,16 @@ def o_stream_signature(ioshape, /, *, ratio=1, meta_layout=0):
         }))
 
     @staticmethod
-    def i_stream_signature(ioshape, /, *, ratio=1, meta_layout=0):
+    def i_stream_signature(ioshape, /, *, ratio=1, meta_layout: ShapeLike = 0):
         return stream.Signature(data.StructLayout({
             "port": _map_ioshape("i", ioshape, lambda width: data.StructLayout({
                 "i":  width if ratio == 1 else data.ArrayLayout(width, ratio),
             })),
             "meta": meta_layout,
         }))
 
-    def __init__(self, ioshape, ports, /, *, ratio=1, init=None, meta_layout=0):
-        assert isinstance(ioshape, (int, dict))
+    def __init__(self, ioshape: dict, ports, /, *, ratio=1, init=None, meta_layout: ShapeLike = 0):
+        assert isinstance(ioshape, dict)
         assert ratio in (1, 2)
 
         self._ioshape = ioshape
@@ -161,7 +165,7 @@ def elaborate(self, platform):
             buffer_cls, latency = SimulatableDDRBuffer, 3
 
         if isinstance(self._ports, io.PortLike):
-            m.submodules.buffer = buffer = buffer_cls("io", self._ports)
+            m.submodules.buffer = buffer = buffer_cls(io.Direction.Bidir, self._ports)
         if isinstance(self._ports, PortGroup):
             buffer = {}
             for name, sub_port in self._ports.__dict__.items():
@@ -231,7 +235,7 @@ def delay(value, name):
 
 class IOClocker(wiring.Component):
     @staticmethod
-    def i_stream_signature(ioshape, /, *, _ratio=1, meta_layout=0):
+    def i_stream_signature(ioshape, /, *, _ratio=1, meta_layout: ShapeLike = 0):
         # Currently the only supported ratio is 1, but this will change in the future for
         # interfaces like HyperBus.
         return stream.Signature(data.StructLayout({
@@ -245,10 +249,10 @@ def i_stream_signature(ioshape, /, *, _ratio=1, meta_layout=0):
         }))
 
     @staticmethod
-    def o_stream_signature(ioshape, /, *, ratio=1, meta_layout=0):
+    def o_stream_signature(ioshape, /, *, ratio=1, meta_layout: ShapeLike = 0):
         return IOStreamer.o_stream_signature(ioshape, ratio=ratio, meta_layout=meta_layout)
 
-    def __init__(self, ioshape, *, clock, o_ratio=1, meta_layout=0, divisor_width=16):
+    def __init__(self, ioshape, *, clock, o_ratio=1, meta_layout: ShapeLike = 0, divisor_width=16):
         assert isinstance(ioshape, dict)
         assert isinstance(clock, str)
         assert o_ratio in (1, 2)

chipflow_digital_ip/io/_gpio.py

@@ -1,4 +1,3 @@
-
 from amaranth import Module, unsigned
 from amaranth.lib import wiring
 from amaranth.lib.wiring import In, Out, flipped, connect

chipflow_digital_ip/io/_rfc_uart.py

@@ -2,17 +2,26 @@
 The Amaranth SoC RFC UART from https://github.com/ChipFlow/chipflow-digital-ip
 """
 
+from typing import Generic, TypeVar
+
 from amaranth import *
 from amaranth.lib import stream, wiring
 from amaranth.lib.wiring import In, Out, flipped, connect
+from amaranth.hdl import ValueCastable
+
+from amaranth_types.types import HasElaborate, ShapeLike, ValueLike
 
 from amaranth_soc import csr
 
 
 __all__ = ["RxPhySignature", "TxPhySignature", "RxPeripheral", "TxPeripheral", "Peripheral"]
 
+_T_ValueOrValueCastable = TypeVar("_T_ValueOrValueCastable", bound=Value | ValueCastable, covariant=True)
+_T_ShapeLike = TypeVar("_T_ShapeLike", bound=ShapeLike, covariant=True)
+_T_Symbol_ShapeLike = TypeVar("_T_Symbol_ShapeLike", bound=ShapeLike, covariant=True)
+
 
-class RxPhySignature(wiring.Signature):
+class RxPhySignature(wiring.Signature, Generic[_T_ShapeLike, _T_Symbol_ShapeLike]):
     """Receiver PHY signature.
 
     Parameters
@@ -38,7 +47,7 @@ class RxPhySignature(wiring.Signature):
         Receiver error flag. Pulsed for one clock cycle in case of an implementation-specific error
         (e.g. wrong parity bit).
     """
-    def __init__(self, phy_config_shape, symbol_shape):
+    def __init__(self, phy_config_shape: _T_ShapeLike, symbol_shape: _T_Symbol_ShapeLike):
         super().__init__({
             "rst":      Out(1),
             "config":   Out(phy_config_shape),
@@ -48,7 +57,7 @@ def __init__(self, phy_config_shape, symbol_shape):
         })
 
 
-class TxPhySignature(wiring.Signature):
+class TxPhySignature(wiring.Signature, Generic[_T_ShapeLike, _T_Symbol_ShapeLike]):
     """Transmitter PHY signature.
 
     Parameters
@@ -68,7 +77,7 @@ class TxPhySignature(wiring.Signature):
     symbols : :py:`Out(stream.Signature(symbol_shape))`
         Symbol stream. The shape of its payload is given by the `symbol_shape` parameter.
     """
-    def __init__(self, phy_config_shape, symbol_shape):
+    def __init__(self, phy_config_shape: _T_ShapeLike, symbol_shape: _T_Symbol_ShapeLike):
         super().__init__({
             "rst":     Out(1),
             "config":  Out(phy_config_shape),
@@ -98,7 +107,7 @@ def elaborate(self, platform):
         return m
 
 
-class RxPeripheral(wiring.Component):
+class RxPeripheral(wiring.Component, Generic[_T_ShapeLike, _T_ValueOrValueCastable, _T_Symbol_ShapeLike]):
     class Config(csr.Register, access="rw"):
         """Peripheral configuration register.
 
@@ -141,7 +150,7 @@ class PhyConfig(csr.Register, access="rw"):
         phy_config_init : :class:`int`
             Initial value of the PHY configuration word.
         """
-        def __init__(self, phy_config_shape, phy_config_init):
+        def __init__(self, phy_config_shape: _T_ShapeLike, phy_config_init: _T_ValueOrValueCastable):
             super().__init__(csr.Field(_PhyConfigFieldAction, phy_config_shape,
                                        init=phy_config_init))
 
@@ -199,7 +208,7 @@ class Data(csr.Register, access="r"):
         symbol_shape : :ref:`shape-like <lang-shapelike>`
             Shape of a symbol.
         """
-        def __init__(self, symbol_shape):
+        def __init__(self, symbol_shape: _T_Symbol_ShapeLike):
             super().__init__(csr.Field(csr.action.R, symbol_shape))
 
     """UART receiver peripheral.
@@ -224,8 +233,8 @@ def __init__(self, symbol_shape):
     phy : :py:`Out(RxPhySignature(phy_config_shape, symbol_shape))`
         Interface between the peripheral and its PHY.
     """
-    def __init__(self, *, addr_width, data_width, phy_config_shape=unsigned(16),
-                 phy_config_init=0, symbol_shape=unsigned(8)):
+    def __init__(self, *, addr_width, data_width, phy_config_shape:_T_ShapeLike = unsigned(16),
+                 phy_config_init: _T_ValueOrValueCastable = Value.cast(0), symbol_shape: _T_Symbol_ShapeLike = unsigned(8)):
         regs = csr.Builder(addr_width=addr_width, data_width=data_width)
 
         self._config     = regs.add("Config",    self.Config())
@@ -298,7 +307,7 @@ def elaborate(self, platform):
         return m
 
 
-class TxPeripheral(wiring.Component):
+class TxPeripheral(wiring.Component, Generic[_T_ShapeLike, _T_Symbol_ShapeLike, _T_ValueOrValueCastable]):
     class Config(csr.Register, access="rw"):
         """Peripheral configuration register.
 
@@ -341,7 +350,7 @@ class PhyConfig(csr.Register, access="rw"):
         phy_config_init : :class:`int`
             Initial value of the PHY configuration word.
         """
-        def __init__(self, phy_config_shape, phy_config_init):
+        def __init__(self, phy_config_shape: _T_ShapeLike, phy_config_init: _T_ValueOrValueCastable):
             super().__init__(csr.Field(_PhyConfigFieldAction, phy_config_shape,
                                        init=phy_config_init))
 
@@ -391,7 +400,7 @@ class Data(csr.Register, access="w"):
         symbol_shape : :ref:`shape-like <lang-shapelike>`
             Shape of a symbol.
         """
-        def __init__(self, symbol_shape):
+        def __init__(self, symbol_shape: _T_Symbol_ShapeLike):
             super().__init__(csr.Field(csr.action.W, symbol_shape))
 
     """UART transmitter peripheral.
@@ -416,8 +425,8 @@ def __init__(self, symbol_shape):
     phy : :py:`Out(TxPhySignature(phy_config_shape, symbol_shape))`
         Interface between the peripheral and its PHY.
     """
-    def __init__(self, *, addr_width, data_width=8, phy_config_shape=unsigned(16),
-                 phy_config_init=0, symbol_shape=unsigned(8)):
+    def __init__(self, *, addr_width, data_width=8, phy_config_shape: _T_ShapeLike = unsigned(16),
+                 phy_config_init: _T_ValueOrValueCastable = Value.cast(0), symbol_shape: _T_Symbol_ShapeLike = unsigned(8)):
         regs = csr.Builder(addr_width=addr_width, data_width=data_width)
 
         self._config     = regs.add("Config",    self.Config())
@@ -487,7 +496,7 @@ def elaborate(self, platform):
         return m
 
 
-class Peripheral(wiring.Component):
+class Peripheral(wiring.Component, Generic[_T_ShapeLike, _T_Symbol_ShapeLike, _T_ValueOrValueCastable]):
     """UART transceiver peripheral.
 
     This peripheral is composed of two subordinate peripherals. A :class:`RxPeripheral` occupies
@@ -522,8 +531,8 @@ class Peripheral(wiring.Component):
     :exc:`TypeError`
         If ``addr_width`` is not a positive integer.
     """
-    def __init__(self, *, addr_width, data_width=8, phy_config_shape=unsigned(16),
-                 phy_config_init=0, symbol_shape=unsigned(8)):
+    def __init__(self, *, addr_width, data_width=8, phy_config_shape: _T_ShapeLike = unsigned(16),
+                 phy_config_init: _T_ValueOrValueCastable = Value.cast(0), symbol_shape: _T_Symbol_ShapeLike = unsigned(8)):
         if not isinstance(addr_width, int) or addr_width <= 0:
             raise TypeError(f"Address width must be a positive integer, not {addr_width!r}")
 

chipflow_digital_ip/io/_spi.py

@@ -1,4 +1,4 @@
-from amaranth import Module, Signal, Cat, C, unsigned
+from amaranth import *
 from amaranth.lib import wiring
 from amaranth.lib.wiring import In, Out, connect, flipped