Refactor tests (better grouping + cocotb support) (#15)

* initial refactor

* fix cocotb tests

* fix typecheck

* install verilator
This commit is contained in:
Arnav Sacheti
2025-10-26 17:56:35 -07:00
committed by GitHub
parent 93276ff616
commit b1f1bf983a
66 changed files with 1734 additions and 2963 deletions

View File

@@ -2,94 +2,91 @@ from typing import overload
from systemrdl.node import AddressableNode
from ...utils import get_indexed_path
from ..base_cpuif import BaseCpuif
from .axi4_lite_cpuif import AXI4LiteCpuif
class AXI4LiteCpuifFlat(BaseCpuif):
class AXI4LiteCpuifFlat(AXI4LiteCpuif):
"""Verilator-friendly variant that flattens the AXI4-Lite interface ports."""
template_path = "axi4lite_tmpl.sv"
is_interface = True
is_interface = False
def _port_declaration(self, child: AddressableNode) -> str:
base = f"axi4lite_intf.master m_axil_{child.inst_name}"
# When unrolled, current_idx is set - append it to the name
if child.current_idx is not None:
base = f"{base}_{'_'.join(map(str, child.current_idx))}"
# Only add array dimensions if this should be treated as an array
if self.check_is_array(child):
assert child.array_dimensions is not None
return f"{base} {''.join(f'[{dim}]' for dim in child.array_dimensions)}"
return base
def _port_declaration(self, child: AddressableNode) -> list[str]:
return [
f"input logic {self.signal('AWREADY', child)}",
f"output logic {self.signal('AWVALID', child)}",
f"output logic [{self.addr_width - 1}:0] {self.signal('AWADDR', child)}",
f"output logic [2:0] {self.signal('AWPROT', child)}",
f"input logic {self.signal('WREADY', child)}",
f"output logic {self.signal('WVALID', child)}",
f"output logic [{self.data_width - 1}:0] {self.signal('WDATA', child)}",
f"output logic [{self.data_width_bytes - 1}:0] {self.signal('WSTRB', child)}",
f"output logic {self.signal('BREADY', child)}",
f"input logic {self.signal('BVALID', child)}",
f"input logic [1:0] {self.signal('BRESP', child)}",
f"input logic {self.signal('ARREADY', child)}",
f"output logic {self.signal('ARVALID', child)}",
f"output logic [{self.addr_width - 1}:0] {self.signal('ARADDR', child)}",
f"output logic [2:0] {self.signal('ARPROT', child)}",
f"output logic {self.signal('RREADY', child)}",
f"input logic {self.signal('RVALID', child)}",
f"input logic [{self.data_width - 1}:0] {self.signal('RDATA', child)}",
f"input logic [1:0] {self.signal('RRESP', child)}",
]
@property
def port_declaration(self) -> str:
"""Returns the port declaration for the AXI4-Lite interface."""
slave_ports: list[str] = ["axi4lite_intf.slave s_axil"]
master_ports: list[str] = list(map(self._port_declaration, self.addressable_children))
slave_ports: list[str] = [
f"input logic {self.signal('ACLK')}",
f"input logic {self.signal('ARESETn')}",
f"output logic {self.signal('AWREADY')}",
f"input logic {self.signal('AWVALID')}",
f"input logic [{self.addr_width - 1}:0] {self.signal('AWADDR')}",
f"input logic [2:0] {self.signal('AWPROT')}",
f"output logic {self.signal('WREADY')}",
f"input logic {self.signal('WVALID')}",
f"input logic [{self.data_width - 1}:0] {self.signal('WDATA')}",
f"input logic [{self.data_width_bytes - 1}:0] {self.signal('WSTRB')}",
f"input logic {self.signal('BREADY')}",
f"output logic {self.signal('BVALID')}",
f"output logic [1:0] {self.signal('BRESP')}",
f"output logic {self.signal('ARREADY')}",
f"input logic {self.signal('ARVALID')}",
f"input logic [{self.addr_width - 1}:0] {self.signal('ARADDR')}",
f"input logic [2:0] {self.signal('ARPROT')}",
f"input logic {self.signal('RREADY')}",
f"output logic {self.signal('RVALID')}",
f"output logic [{self.data_width - 1}:0] {self.signal('RDATA')}",
f"output logic [1:0] {self.signal('RRESP')}",
]
master_ports: list[str] = []
for child in self.addressable_children:
master_ports.extend(self._port_declaration(child))
return ",\n".join(slave_ports + master_ports)
@overload
def signal(self, signal: str, node: None = None, indexer: None = None) -> str: ...
@overload
def signal(self, signal: str, node: AddressableNode, indexer: str) -> str: ...
def signal(self, signal: str, node: AddressableNode | None = None, indexer: str | None = None) -> str:
if node is None or indexer is None:
# Node is none, so this is a slave signal
return f"s_axil.{signal}"
def signal(self, signal: str, node: AddressableNode, indexer: str | None = None) -> str: ...
# Master signal
return f"m_axil_{get_indexed_path(node.parent, node, indexer, skip_kw_filter=True)}.{signal}"
def fanout(self, node: AddressableNode) -> str:
fanout: dict[str, str] = {}
wr_sel = f"cpuif_wr_sel.{get_indexed_path(self.exp.ds.top_node, node, 'gi')}"
rd_sel = f"cpuif_rd_sel.{get_indexed_path(self.exp.ds.top_node, node, 'gi')}"
# Write address channel
fanout[self.signal("AWVALID", node, "gi")] = wr_sel
fanout[self.signal("AWADDR", node, "gi")] = self.signal("AWADDR")
fanout[self.signal("AWPROT", node, "gi")] = self.signal("AWPROT")
# Write data channel
fanout[self.signal("WVALID", node, "gi")] = wr_sel
fanout[self.signal("WDATA", node, "gi")] = "cpuif_wr_data"
fanout[self.signal("WSTRB", node, "gi")] = "cpuif_wr_byte_en"
# Write response channel (master -> slave)
fanout[self.signal("BREADY", node, "gi")] = self.signal("BREADY")
# Read address channel
fanout[self.signal("ARVALID", node, "gi")] = rd_sel
fanout[self.signal("ARADDR", node, "gi")] = self.signal("ARADDR")
fanout[self.signal("ARPROT", node, "gi")] = self.signal("ARPROT")
# Read data channel (master -> slave)
fanout[self.signal("RREADY", node, "gi")] = self.signal("RREADY")
return "\n".join(f"assign {lhs} = {rhs};" for lhs, rhs in fanout.items())
def fanin(self, node: AddressableNode | None = None) -> str:
fanin: dict[str, str] = {}
def signal(
self,
signal: str,
node: AddressableNode | None = None,
indexer: str | None = None,
) -> str:
if node is None:
fanin["cpuif_rd_ack"] = "'0"
fanin["cpuif_rd_err"] = "'0"
else:
# Read side: ack comes from RVALID; err if RRESP[1] is set (SLVERR/DECERR)
fanin["cpuif_rd_ack"] = self.signal("RVALID", node, "i")
fanin["cpuif_rd_err"] = f"{self.signal('RRESP', node, 'i')}[1]"
return f"s_axil_{signal}"
return "\n".join(f"{lhs} = {rhs};" for lhs, rhs in fanin.items())
base = f"m_axil_{node.inst_name}_{signal}"
if not self.check_is_array(node):
if node.current_idx is not None:
return f"{base}_{'_'.join(map(str, node.current_idx))}"
return base
def readback(self, node: AddressableNode | None = None) -> str:
fanin: dict[str, str] = {}
if node is None:
fanin["cpuif_rd_data"] = "'0"
else:
fanin["cpuif_rd_data"] = self.signal("RDATA", node, "i")
return "\n".join(f"{lhs} = {rhs};" for lhs, rhs in fanin.items())
if indexer is None:
return f"{base}[N_{node.inst_name.upper()}S]"
return f"{base}[{indexer}]"