eth: Add MAC pause control modules

Signed-off-by: Alex Forencich <alex@alexforencich.com>
2025-12-09 17:08:38 -08:00 · 2025-02-05 21:11:14 -08:00
parent f479a85155
commit 584f2a6542
6 changed files with 1407 additions and 0 deletions
--- a/tb/eth/taxi_mac_pause_ctrl_tx/Makefile
+++ b/tb/eth/taxi_mac_pause_ctrl_tx/Makefile
@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: CERN-OHL-S-2.0
+#
+# Copyright (c) 2023-2025 FPGA Ninja, LLC
+#
+# Authors:
+# - Alex Forencich
+
+TOPLEVEL_LANG = verilog
+
+SIM ?= verilator
+WAVES ?= 0
+
+COCOTB_HDL_TIMEUNIT = 1ns
+COCOTB_HDL_TIMEPRECISION = 1ps
+
+DUT      = taxi_mac_pause_ctrl_tx
+COCOTB_TEST_MODULES = test_$(DUT)
+COCOTB_TOPLEVEL     = $(DUT)
+MODULE   = $(COCOTB_TEST_MODULES)
+TOPLEVEL = $(COCOTB_TOPLEVEL)
+VERILOG_SOURCES += ../../../rtl/eth/$(DUT).sv
+
+# handle file list files
+process_f_file = $(call process_f_files,$(addprefix $(dir $1),$(shell cat $1)))
+process_f_files = $(foreach f,$1,$(if $(filter %.f,$f),$(call process_f_file,$f),$f))
+uniq_base = $(if $1,$(call uniq_base,$(foreach f,$1,$(if $(filter-out $(notdir $(lastword $1)),$(notdir $f)),$f,))) $(lastword $1))
+VERILOG_SOURCES := $(call uniq_base,$(call process_f_files,$(VERILOG_SOURCES)))
+
+# module parameters
+export PARAM_MCF_PARAMS_SIZE := 18
+export PARAM_PFC_EN := "1'b1"
+
+ifeq ($(SIM), icarus)
+	PLUSARGS += -fst
+
+	COMPILE_ARGS += $(foreach v,$(filter PARAM_%,$(.VARIABLES)),-P $(COCOTB_TOPLEVEL).$(subst PARAM_,,$(v))=$($(v)))
+else ifeq ($(SIM), verilator)
+	COMPILE_ARGS += $(foreach v,$(filter PARAM_%,$(.VARIABLES)),-G$(subst PARAM_,,$(v))=$($(v)))
+
+	ifeq ($(WAVES), 1)
+		COMPILE_ARGS += --trace-fst
+		VERILATOR_TRACE = 1
+	endif
+endif
+
+include $(shell cocotb-config --makefiles)/Makefile.sim
--- a/tb/eth/taxi_mac_pause_ctrl_tx/test_taxi_mac_pause_ctrl_tx.py
+++ b/tb/eth/taxi_mac_pause_ctrl_tx/test_taxi_mac_pause_ctrl_tx.py
@@ -0,0 +1,395 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: CERN-OHL-S-2.0
+"""
+
+Copyright (c) 2023-2025 FPGA Ninja, LLC
+
+Authors:
+- Alex Forencich
+
+"""
+
+import logging
+import os
+import struct
+
+from scapy.layers.l2 import Ether
+
+import cocotb_test.simulator
+
+import cocotb
+from cocotb.clock import Clock
+from cocotb.triggers import RisingEdge
+from cocotb.regression import TestFactory
+from cocotb.utils import get_sim_time
+
+from cocotbext.axi.stream import define_stream
+
+
+McfBus, McfTransaction, McfSource, McfSink, McfMonitor = define_stream("Mcf",
+    signals=["valid", "eth_dst", "eth_src", "eth_type", "opcode", "params"],
+    optional_signals=["ready", "id", "dest", "user"]
+)
+
+
+class TB:
+    def __init__(self, dut):
+        self.dut = dut
+
+        self.log = logging.getLogger("cocotb.tb")
+        self.log.setLevel(logging.DEBUG)
+
+        cocotb.start_soon(Clock(dut.clk, 6.4, units="ns").start())
+
+        self.mcf_sink = McfSink(McfBus.from_prefix(dut, "mcf"), dut.clk, dut.rst)
+
+        dut.tx_lfc_req.setimmediatevalue(0)
+        dut.tx_lfc_resend.setimmediatevalue(0)
+
+        dut.tx_pfc_req.setimmediatevalue(0)
+        dut.tx_pfc_resend.setimmediatevalue(0)
+
+        dut.cfg_tx_lfc_eth_dst.setimmediatevalue(0)
+        dut.cfg_tx_lfc_eth_src.setimmediatevalue(0)
+        dut.cfg_tx_lfc_eth_type.setimmediatevalue(0)
+        dut.cfg_tx_lfc_opcode.setimmediatevalue(0)
+        dut.cfg_tx_lfc_en.setimmediatevalue(0)
+        dut.cfg_tx_lfc_quanta.setimmediatevalue(0)
+        dut.cfg_tx_lfc_refresh.setimmediatevalue(0)
+        dut.cfg_tx_pfc_eth_dst.setimmediatevalue(0)
+        dut.cfg_tx_pfc_eth_src.setimmediatevalue(0)
+        dut.cfg_tx_pfc_eth_type.setimmediatevalue(0)
+        dut.cfg_tx_pfc_opcode.setimmediatevalue(0)
+        dut.cfg_tx_pfc_en.setimmediatevalue(0)
+        dut.cfg_tx_pfc_quanta.setimmediatevalue(0)
+        dut.cfg_tx_pfc_refresh.setimmediatevalue(0)
+        dut.cfg_quanta_step.setimmediatevalue(256)
+        dut.cfg_quanta_clk_en.setimmediatevalue(1)
+
+    async def reset(self):
+        self.dut.rst.setimmediatevalue(0)
+        await RisingEdge(self.dut.clk)
+        await RisingEdge(self.dut.clk)
+        self.dut.rst.value = 1
+        await RisingEdge(self.dut.clk)
+        await RisingEdge(self.dut.clk)
+        self.dut.rst.value = 0
+        await RisingEdge(self.dut.clk)
+        await RisingEdge(self.dut.clk)
+
+    async def recv_mcf(self):
+        rx_frame = await self.mcf_sink.recv()
+
+        data = bytearray()
+        data.extend(rx_frame.eth_dst.integer.to_bytes(6, 'big'))
+        data.extend(rx_frame.eth_src.integer.to_bytes(6, 'big'))
+        data.extend(rx_frame.eth_type.integer.to_bytes(2, 'big'))
+        data.extend(rx_frame.opcode.integer.to_bytes(2, 'big'))
+        data.extend(rx_frame.params.integer.to_bytes(44, 'little'))
+
+        return Ether(data)
+
+
+def check_lfc_frame(tb, pkt, quanta):
+    tb.log.info("Pause frame: %s", repr(pkt))
+
+    op, q = struct.unpack_from('!HH', bytes(pkt[Ether].payload), 0)
+    tb.log.info("opcode: 0x%x", op)
+    tb.log.info("quanta: %d", q)
+
+    assert pkt[Ether].dst == '01:80:c2:00:00:01'
+    assert pkt[Ether].src == '5a:51:52:53:54:55'
+    assert pkt[Ether].type == 0x8808
+    assert op == 0x0001
+    assert q == quanta
+
+
+async def run_test_lfc(dut):
+
+    tb = TB(dut)
+
+    await tb.reset()
+
+    dut.tx_lfc_req.value = 0
+    dut.tx_lfc_resend.value = 0
+
+    dut.tx_pfc_req.value = 0x00
+    dut.tx_pfc_resend.value = 0
+
+    dut.cfg_tx_lfc_eth_dst.value = 0x0180C2000001
+    dut.cfg_tx_lfc_eth_src.value = 0x5A5152535455
+    dut.cfg_tx_lfc_eth_type.value = 0x8808
+    dut.cfg_tx_lfc_opcode.value = 0x0001
+    dut.cfg_tx_lfc_en.value = 1
+    dut.cfg_tx_lfc_quanta.value = 0xFFFF
+    dut.cfg_tx_lfc_refresh.value = 0x7F00
+    dut.cfg_tx_pfc_eth_dst.value = 0x0180C2000001
+    dut.cfg_tx_pfc_eth_src.value = 0x5A5152535455
+    dut.cfg_tx_pfc_eth_type.value = 0x8808
+    dut.cfg_tx_pfc_opcode.value = 0x0101
+    dut.cfg_tx_pfc_en.value = 0
+    dut.cfg_tx_pfc_quanta.value = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
+    dut.cfg_tx_pfc_refresh.value = 0x7F007F007F007F007F007F007F007F00
+    dut.cfg_quanta_step.value = int(10000*256 / (512*156.25))
+    dut.cfg_quanta_clk_en.value = 1
+
+    tb.log.info("Test pause")
+
+    dut.cfg_tx_lfc_refresh.value = 100
+
+    dut.tx_lfc_req.value = 1
+    start_time = None
+
+    for k in range(4):
+        rx_pkt = await tb.recv_mcf()
+        stop_time = get_sim_time('sec')
+
+        check_lfc_frame(tb, rx_pkt, 0xFFFF)
+
+        if start_time:
+            refresh_time = stop_time-start_time
+            refresh_quanta = refresh_time / (512 * 1/10e9)
+
+            tb.log.info("refresh time   : %g s", refresh_time)
+            tb.log.info("refresh quanta : %f", refresh_quanta)
+
+            assert round(refresh_quanta) == 100
+
+        start_time = get_sim_time('sec')
+
+    dut.tx_lfc_req.value = 0
+
+    rx_pkt = await tb.recv_mcf()
+
+    check_lfc_frame(tb, rx_pkt, 0x0)
+
+    await RisingEdge(dut.clk)
+    await RisingEdge(dut.clk)
+
+
+def check_pfc_frame(tb, pkt, enable_mask, quanta_mask, quanta):
+    tb.log.info("PFC frame: %s", repr(pkt))
+
+    op, enable, *q = struct.unpack_from('!HH8H', bytes(pkt[Ether].payload), 0)
+    tb.log.info("opcode: 0x%x", op)
+    tb.log.info("enable: 0x%x", enable)
+    tb.log.info("quanta: %r", q)
+
+    assert pkt[Ether].dst == '01:80:c2:00:00:01'
+    assert pkt[Ether].src == '5a:51:52:53:54:55'
+    assert pkt[Ether].type == 0x8808
+    assert op == 0x0101
+    assert enable == enable_mask
+    for k in range(8):
+        if quanta_mask & (1 << k):
+            assert q[k] == quanta
+        else:
+            assert q[k] == 0
+
+
+async def run_test_pfc(dut):
+
+    tb = TB(dut)
+
+    await tb.reset()
+
+    dut.tx_lfc_req.value = 0
+    dut.tx_lfc_resend.value = 0
+
+    dut.tx_pfc_req.value = 0x00
+    dut.tx_pfc_resend.value = 0
+
+    dut.cfg_tx_lfc_eth_dst.value = 0x0180C2000001
+    dut.cfg_tx_lfc_eth_src.value = 0x5A5152535455
+    dut.cfg_tx_lfc_eth_type.value = 0x8808
+    dut.cfg_tx_lfc_opcode.value = 0x0001
+    dut.cfg_tx_lfc_en.value = 0
+    dut.cfg_tx_lfc_quanta.value = 0xFFFF
+    dut.cfg_tx_lfc_refresh.value = 0x7F00
+    dut.cfg_tx_pfc_eth_dst.value = 0x0180C2000001
+    dut.cfg_tx_pfc_eth_src.value = 0x5A5152535455
+    dut.cfg_tx_pfc_eth_type.value = 0x8808
+    dut.cfg_tx_pfc_opcode.value = 0x0101
+    dut.cfg_tx_pfc_en.value = 1
+    dut.cfg_tx_pfc_quanta.value = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
+    dut.cfg_tx_pfc_refresh.value = 0x7F007F007F007F007F007F007F007F00
+    dut.cfg_quanta_step.value = int(10000*256 / (512*156.25))
+    dut.cfg_quanta_clk_en.value = 1
+
+    tb.log.info("Test pause")
+
+    dut.cfg_tx_pfc_refresh.value = 0x00640064006400640064006400640064
+
+    dut.tx_pfc_req.value = 0x01
+    start_time = None
+
+    for k in range(4):
+        rx_pkt = await tb.recv_mcf()
+        stop_time = get_sim_time('sec')
+
+        check_pfc_frame(tb, rx_pkt, 0x01, 0x01, 0xFFFF)
+
+        if start_time:
+            refresh_time = stop_time-start_time
+            refresh_quanta = refresh_time / (512 * 1/10e9)
+
+            tb.log.info("refresh time   : %g s", refresh_time)
+            tb.log.info("refresh quanta : %f", refresh_quanta)
+
+            assert round(refresh_quanta) == 100
+
+        start_time = get_sim_time('sec')
+
+    dut.tx_pfc_req.value = 0x00
+
+    rx_pkt = await tb.recv_mcf()
+
+    check_pfc_frame(tb, rx_pkt, 0x01, 0x00, 0xFFFF)
+
+    tb.log.info("Test all channels")
+
+    dut.cfg_tx_pfc_refresh.value = 0x00640064006400640064006400640064
+
+    for ch in range(8):
+
+        dut.tx_pfc_req.value = 0xFF >> (7-ch)
+        start_time = None
+
+        for k in range(3):
+            rx_pkt = await tb.recv_mcf()
+            stop_time = get_sim_time('sec')
+
+            check_pfc_frame(tb, rx_pkt, 0xFF >> (7-ch), 0xFF >> (7-ch), 0xFFFF)
+
+            if start_time:
+                refresh_time = stop_time-start_time
+                refresh_quanta = refresh_time / (512 * 1/10e9)
+
+                tb.log.info("refresh time   : %g s", refresh_time)
+                tb.log.info("refresh quanta : %f", refresh_quanta)
+
+                assert round(refresh_quanta) == 100
+
+            start_time = get_sim_time('sec')
+
+    dut.tx_pfc_req.value = 0x00
+
+    rx_pkt = await tb.recv_mcf()
+
+    check_pfc_frame(tb, rx_pkt, 0xFF, 0x00, 0xFFFF)
+
+    tb.log.info("Test isolation")
+
+    dut.cfg_tx_pfc_refresh.value = 0x00640064006400640064006400640064
+
+    dut.tx_pfc_req.value = 0x01
+    start_time = None
+
+    rx_pkt = await tb.recv_mcf()
+    stop_time = get_sim_time('sec')
+
+    check_pfc_frame(tb, rx_pkt, 0x01, 0x01, 0xFFFF)
+
+    dut.tx_pfc_req.value = 0x03
+    start_time = None
+
+    rx_pkt = await tb.recv_mcf()
+    stop_time = get_sim_time('sec')
+
+    check_pfc_frame(tb, rx_pkt, 0x03, 0x03, 0xFFFF)
+
+    dut.tx_pfc_req.value = 0x01
+    start_time = None
+
+    rx_pkt = await tb.recv_mcf()
+    stop_time = get_sim_time('sec')
+
+    check_pfc_frame(tb, rx_pkt, 0x03, 0x01, 0xFFFF)
+
+    start_time = get_sim_time('sec')
+
+    for k in range(4):
+        rx_pkt = await tb.recv_mcf()
+        stop_time = get_sim_time('sec')
+
+        check_pfc_frame(tb, rx_pkt, 0x01, 0x01, 0xFFFF)
+
+        if start_time:
+            refresh_time = stop_time-start_time
+            refresh_quanta = refresh_time / (512 * 1/10e9)
+
+            tb.log.info("refresh time   : %g s", refresh_time)
+            tb.log.info("refresh quanta : %f", refresh_quanta)
+
+            assert round(refresh_quanta) == 100
+
+        start_time = get_sim_time('sec')
+
+    dut.tx_pfc_req.value = 0x00
+
+    rx_pkt = await tb.recv_mcf()
+
+    check_pfc_frame(tb, rx_pkt, 0x01, 0x00, 0xFFFF)
+
+    await RisingEdge(dut.clk)
+    await RisingEdge(dut.clk)
+
+
+if cocotb.SIM_NAME:
+
+    for test in [run_test_lfc, run_test_pfc]:
+
+        factory = TestFactory(test)
+        factory.generate_tests()
+
+
+# cocotb-test
+
+tests_dir = os.path.abspath(os.path.dirname(__file__))
+rtl_dir = os.path.abspath(os.path.join(tests_dir, '..', '..', '..', 'rtl'))
+
+
+def process_f_files(files):
+    lst = {}
+    for f in files:
+        if f[-2:].lower() == '.f':
+            with open(f, 'r') as fp:
+                l = fp.read().split()
+            for f in process_f_files([os.path.join(os.path.dirname(f), x) for x in l]):
+                lst[os.path.basename(f)] = f
+        else:
+            lst[os.path.basename(f)] = f
+    return list(lst.values())
+
+
+def test_taxi_mac_pause_ctrl_tx(request):
+    dut = "taxi_mac_pause_ctrl_tx"
+    module = os.path.splitext(os.path.basename(__file__))[0]
+    toplevel = dut
+
+    verilog_sources = [
+        os.path.join(rtl_dir, "eth", f"{dut}.sv"),
+    ]
+
+    verilog_sources = process_f_files(verilog_sources)
+
+    parameters = {}
+
+    parameters['MCF_PARAMS_SIZE'] = 18
+    parameters['PFC_EN'] = "1'b1"
+
+    extra_env = {f'PARAM_{k}': str(v) for k, v in parameters.items()}
+
+    sim_build = os.path.join(tests_dir, "sim_build",
+        request.node.name.replace('[', '-').replace(']', ''))
+
+    cocotb_test.simulator.run(
+        simulator="verilator",
+        python_search=[tests_dir],
+        verilog_sources=verilog_sources,
+        toplevel=toplevel,
+        module=module,
+        parameters=parameters,
+        sim_build=sim_build,
+        extra_env=extra_env,
+    )