cndm: Initial commit of board control I2C logic

Signed-off-by: Alex Forencich <alex@alexforencich.com>
This commit is contained in:
Alex Forencich
2026-03-17 14:06:55 -07:00
parent 033d961906
commit d9cf440351
5 changed files with 1515 additions and 0 deletions

View File

@@ -0,0 +1,50 @@
# SPDX-License-Identifier: CERN-OHL-S-2.0
#
# Copyright (c) 2026 FPGA Ninja, LLC
#
# Authors:
# - Alex Forencich
TOPLEVEL_LANG = verilog
SIM ?= verilator
WAVES ?= 0
COCOTB_HDL_TIMEUNIT = 1ns
COCOTB_HDL_TIMEPRECISION = 1ns
RTL_DIR = ../../rtl
LIB_DIR = ../../lib
TAXI_SRC_DIR = $(LIB_DIR)/taxi/src
DUT = cndm_brd_ctrl_i2c
COCOTB_TEST_MODULES = test_$(DUT)
COCOTB_TOPLEVEL = test_$(DUT)
MODULE = $(COCOTB_TEST_MODULES)
TOPLEVEL = $(COCOTB_TOPLEVEL)
VERILOG_SOURCES += $(COCOTB_TOPLEVEL).sv
VERILOG_SOURCES += $(RTL_DIR)/$(DUT).f
# 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_DEFAULT_PRESCALE := 1
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

View File

@@ -0,0 +1,382 @@
#!/usr/bin/env python
# SPDX-License-Identifier: CERN-OHL-S-2.0
"""
Copyright (c) 2026 FPGA Ninja, LLC
Authors:
- Alex Forencich
"""
import logging
import os
import struct
import cocotb_test.simulator
import cocotb
from cocotb.clock import Clock
from cocotb.triggers import RisingEdge
from cocotbext.axi import AxiStreamBus, AxiStreamSource, AxiStreamSink
from cocotbext.axi.utils import hexdump_str
from cocotbext.i2c import I2cMemory
CMD_BRD_OP_NOP = 0x0000
CMD_BRD_OP_FLASH_RD = 0x0100
CMD_BRD_OP_FLASH_WR = 0x0101
CMD_BRD_OP_FLASH_CMD = 0x0108
CMD_BRD_OP_EEPROM_RD = 0x0200
CMD_BRD_OP_EEPROM_WR = 0x0201
CMD_BRD_OP_OPTIC_RD = 0x0300
CMD_BRD_OP_OPTIC_WR = 0x0301
CMD_BRD_OP_HWID_SN_RD = 0x0400
CMD_BRD_OP_HWID_VPD_RD = 0x0410
CMD_BRD_OP_HWID_MAC_RD = 0x0480
CMD_BRD_OP_PLL_STATUS_RD = 0x0500
CMD_BRD_OP_PLL_TUNE_RAW_RD = 0x0502
CMD_BRD_OP_PLL_TUNE_RAW_WR = 0x0503
CMD_BRD_OP_PLL_TUNE_PPT_RD = 0x0504
CMD_BRD_OP_PLL_TUNE_PPT_WR = 0x0505
CMD_BRD_OP_I2C_RD = 0x8100
CMD_BRD_OP_I2C_WR = 0x8101
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, 4, units="ns").start())
self.brd_ctrl_cmd = AxiStreamSource(AxiStreamBus(dut.s_axis_cmd), dut.clk, dut.rst)
self.brd_ctrl_rsp = AxiStreamSink(AxiStreamBus(dut.m_axis_rsp), dut.clk, dut.rst)
self.i2c_eeprom = I2cMemory(sda=dut.i2c_sda_o, sda_o=dut.i2c_sda_i,
scl=dut.i2c_scl_o, scl_o=dut.i2c_scl_i, addr=0x54, size=256)
self.sfp0 = I2cMemory(sda=dut.i2c_sda_o, sda_o=dut.i2c_sda_i,
scl=dut.i2c_scl_o, scl_o=dut.i2c_scl_i, addr=0x50, size=256)
self.sfp1 = I2cMemory(sda=dut.i2c_sda_o, sda_o=dut.i2c_sda_i,
scl=dut.i2c_scl_o, scl_o=dut.i2c_scl_i, addr=0x51, size=256)
self.si570 = I2cMemory(sda=dut.i2c_sda_o, sda_o=dut.i2c_sda_i,
scl=dut.i2c_scl_o, scl_o=dut.i2c_scl_i, addr=0x5D, size=256)
self.mux1 = I2cMemory(sda=dut.i2c_sda_o, sda_o=dut.i2c_sda_i,
scl=dut.i2c_scl_o, scl_o=dut.i2c_scl_i, addr=0x74, size=256)
self.mux2 = I2cMemory(sda=dut.i2c_sda_o, sda_o=dut.i2c_sda_i,
scl=dut.i2c_scl_o, scl_o=dut.i2c_scl_i, addr=0x75, size=256)
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)
@cocotb.test()
async def run_test(dut):
tb = TB(dut)
await tb.reset()
tb.i2c_eeprom.write_mem(0, bytes.fromhex("""
37 35 37 35 31 39 32 37 31 37 33 32 2d 36 39 39
39 36 20 20 20 20 20 20 20 20 20 20 20 20 20 20
00 0a 35 03 72 c9 00 00 00 00 00 00 00 00 00 00
54 53 53 30 31 36 35 2d 30 32 20 20 20 20 20 20
5b 31 31 31 31 31 31 31 31 31 5d 20 20 20 20 20
57 65 64 2c 20 31 36 20 41 75 67 20 32 30 31 37
31 30 3a 33 35 3a 35 36 2b 30 38 30 30 20 20 20
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
4b 43 55 31 30 35 20 20 20 20 20 20 20 20 20 20
31 2e 31 20 20 20 20 20 20 20 20 20 20 20 20 20
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
"""))
tb.sfp0.write_mem(0, bytes.fromhex("""
03 04 21 00 00 00 00 00 04 00 00 00 67 00 00 00
00 00 03 00 41 6d 70 68 65 6e 6f 6c 20 20 20 20
20 20 20 20 00 41 50 48 35 37 31 35 34 30 30 30
32 20 20 20 20 20 20 20 4b 20 20 20 01 00 00 f7
00 00 00 00 41 50 46 30 39 34 38 30 30 32 30 32
37 39 20 20 30 39 31 31 32 34 20 20 00 00 00 c1
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 00
""" + " ff"*128))
tb.sfp1.write_mem(0, bytes.fromhex("""
03 04 21 00 00 00 00 00 04 00 00 00 67 00 00 00
00 00 03 00 41 6d 70 68 65 6e 6f 6c 20 20 20 20
20 20 20 20 00 41 50 48 35 37 31 35 34 30 30 30
32 20 20 20 20 20 20 20 4b 20 20 20 01 00 00 f7
00 00 00 00 41 50 46 30 39 34 38 30 30 32 30 32
37 39 20 20 30 39 31 31 32 34 20 20 00 00 00 c1
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 00
""" + " ff"*128))
tb.si570.write_mem(0, bytes.fromhex("""
4f 02 32 a1 3d 20 00 01 c2 bb ff 84 82 07 c2 c0
00 00 00 00 c2 c0 00 00 00 07 c2 c0 00 00 00 0c
b9 09 80 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
20 7f 86 81 7b 81 03 00 10 08 00 00 00 00 02 bb
ff 84 82 00 00 00 62 00 00 00 00 00 00 00 00 00
"""))
tb.log.info("Read MAC")
cmd = struct.pack("<HHLbbbbLLL",
0, # index
CMD_BRD_OP_HWID_MAC_RD, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0, # addr
0, # len
0, # rsvd
)
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("MAC: %s", ':'.join(x.hex() for x in struct.unpack_from('6c', rsp.tdata, 24+2)))
tb.log.info("Read SN")
cmd = struct.pack("<HHLbbbbLLL",
0, # index
CMD_BRD_OP_HWID_SN_RD, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0, # addr
0, # len
0, # rsvd
)
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("SN: %s", rsp.tdata[24:24+32].strip(b' \x00'))
tb.log.info("Read EEPROM")
cmd = struct.pack("<HHLbbbbLLL",
0, # index
CMD_BRD_OP_EEPROM_RD, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0x00, # addr
32, # len
0, # rsvd
)
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("Data: %s", rsp.tdata[24:24+32])
tb.log.info("Read SFP0")
cmd = struct.pack("<HHLbbbbLLL",
0, # index
CMD_BRD_OP_OPTIC_RD, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0x00, # addr
32, # len
0, # rsvd
)
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("Data: %s", rsp.tdata[24:24+32])
tb.log.info("Read SFP1")
cmd = struct.pack("<HHLbbbbLLL",
1, # index
CMD_BRD_OP_OPTIC_RD, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0x00, # addr
32, # len
0, # rsvd
)
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("Data: %s", rsp.tdata[24:24+32])
tb.log.info("Write EEPROM")
data = b"EEPROM write data"
cmd = struct.pack("<HHLbbbbLLL",
0, # index
CMD_BRD_OP_EEPROM_WR, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0x80, # addr
len(data), # len
0, # rsvd
)+data
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("Write SFP0")
data = b"SFP0 write data"
cmd = struct.pack("<HHLbbbbLLL",
0, # index
CMD_BRD_OP_OPTIC_WR, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0x80, # addr
len(data), # len
0, # rsvd
)+data
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
tb.log.info("Write SFP1")
data = b"SFP1 write data"
cmd = struct.pack("<HHLbbbbLLL",
1, # index
CMD_BRD_OP_OPTIC_WR, # opcode
0, # flags
0, # page
0, # bank
0, # dev addr offset
0, # rsvd
0x80, # addr
len(data), # len
0, # rsvd
)+data
await tb.brd_ctrl_cmd.send(cmd)
rsp = await tb.brd_ctrl_rsp.recv()
tb.log.info("Response: %s", rsp)
for k in range(1000):
await RisingEdge(dut.clk)
tb.log.info("EEPROM data:")
tb.log.info(hexdump_str(tb.i2c_eeprom.mem, 0, 256))
tb.log.info("PLL data:")
tb.log.info(hexdump_str(tb.si570.mem, 0, 256))
tb.log.info("SFP0 data:")
tb.log.info(hexdump_str(tb.sfp0.mem, 0, 256))
tb.log.info("SFP1 data:")
tb.log.info(hexdump_str(tb.sfp1.mem, 0, 256))
await RisingEdge(dut.clk)
await RisingEdge(dut.clk)
# cocotb-test
tests_dir = os.path.abspath(os.path.dirname(__file__))
rtl_dir = os.path.abspath(os.path.join(tests_dir, '..', '..', 'rtl'))
lib_dir = os.path.abspath(os.path.join(tests_dir, '..', '..', 'lib'))
taxi_src_dir = os.path.abspath(os.path.join(lib_dir, 'taxi', 'src'))
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_cndm_brd_ctrl_i2c(request):
dut = "cndm_brd_ctrl_i2c"
module = os.path.splitext(os.path.basename(__file__))[0]
toplevel = module
verilog_sources = [
os.path.join(tests_dir, f"{toplevel}.sv"),
os.path.join(rtl_dir, f"{dut}.f"),
]
verilog_sources = process_f_files(verilog_sources)
parameters = {}
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,
)

View File

@@ -0,0 +1,131 @@
// SPDX-License-Identifier: CERN-OHL-S-2.0
/*
Copyright (c) 2026 FPGA Ninja, LLC
Authors:
- Alex Forencich
*/
`resetall
`timescale 1ns / 1ps
`default_nettype none
/*
* I2C master testbench
*/
module test_cndm_brd_ctrl_i2c #
(
/* verilator lint_off WIDTHTRUNC */
parameter logic OPTIC_EN = 1'b1,
parameter OPTIC_CNT = 2,
parameter logic EEPROM_EN = 1'b1,
parameter EEPROM_IDX = OPTIC_EN ? OPTIC_CNT : 0,
parameter logic MAC_EEPROM_EN = EEPROM_EN,
parameter MAC_EEPROM_IDX = EEPROM_IDX,
parameter MAC_EEPROM_OFFSET = 32,
parameter MAC_COUNT = OPTIC_CNT,
parameter logic MAC_FROM_BASE = 1'b1,
parameter logic SN_EEPROM_EN = EEPROM_EN,
parameter SN_EEPROM_IDX = EEPROM_IDX,
parameter SN_EEPROM_OFFSET = 0,
parameter SN_LEN = 32,
parameter logic PLL_EN = 1'b1,
parameter PLL_IDX = EEPROM_IDX + (EEPROM_EN ? 1 : 0),
parameter logic MUX_EN = 1'b1,
parameter MUX_CNT = 2,
parameter logic [MUX_CNT-1:0][6:0] MUX_I2C_ADDR = {7'h75, 7'h74},
parameter DEV_CNT = PLL_IDX + (PLL_EN ? 1 : 0),
parameter logic [DEV_CNT-1:0][6:0] DEV_I2C_ADDR = {7'h5D, 7'h54, 7'h51, 7'h50},
parameter logic [DEV_CNT-1:0][31:0] DEV_ADDR_CFG = {32'h00_00_0000, 32'h00_00_0040, 32'h7e_7f_0070, 32'h7e_7f_0070},
parameter logic [DEV_CNT-1:0][MUX_CNT-1:0][7:0] DEV_MUX_MASK = {{8'h00, 8'h01}, {8'h07, 8'h00}, {8'h00, 8'h08}, {8'h00, 8'h04}},
parameter I2C_PRESCALE = 2
/* verilator lint_on WIDTHTRUNC */
)
();
logic clk;
logic rst;
taxi_axis_if #(
.DATA_W(32),
.KEEP_EN(1),
.ID_EN(1),
.ID_W(4),
.USER_EN(1),
.USER_W(1)
) s_axis_cmd(), m_axis_rsp();
logic i2c_scl_i;
logic i2c_scl_o;
logic i2c_sda_i;
logic i2c_sda_o;
logic [DEV_CNT-1:0] dev_sel;
logic [DEV_CNT-1:0] dev_rst;
cndm_brd_ctrl_i2c #(
.OPTIC_EN(OPTIC_EN),
.OPTIC_CNT(OPTIC_CNT),
.EEPROM_EN(EEPROM_EN),
.EEPROM_IDX(EEPROM_IDX),
.MAC_EEPROM_EN(MAC_EEPROM_EN),
.MAC_EEPROM_IDX(MAC_EEPROM_IDX),
.MAC_EEPROM_OFFSET(MAC_EEPROM_OFFSET),
.MAC_COUNT(MAC_COUNT),
.MAC_FROM_BASE(MAC_FROM_BASE),
.SN_EEPROM_EN(SN_EEPROM_EN),
.SN_EEPROM_IDX(SN_EEPROM_IDX),
.SN_EEPROM_OFFSET(SN_EEPROM_OFFSET),
.SN_LEN(SN_LEN),
.PLL_EN(PLL_EN),
.PLL_IDX(PLL_IDX),
.MUX_EN(MUX_EN),
.MUX_CNT(MUX_CNT),
.MUX_I2C_ADDR(MUX_I2C_ADDR),
.DEV_CNT(DEV_CNT),
.DEV_I2C_ADDR(DEV_I2C_ADDR),
.DEV_ADDR_CFG(DEV_ADDR_CFG),
.DEV_MUX_MASK(DEV_MUX_MASK),
.I2C_PRESCALE(I2C_PRESCALE)
)
uut (
.clk(clk),
.rst(rst),
/*
* Board control command interface
*/
.s_axis_cmd(s_axis_cmd),
.m_axis_rsp(m_axis_rsp),
/*
* I2C interface
*/
.i2c_scl_i(i2c_scl_i),
.i2c_scl_o(i2c_scl_o),
.i2c_sda_i(i2c_sda_i),
.i2c_sda_o(i2c_sda_o),
.dev_sel(dev_sel),
.dev_rst(dev_rst)
);
endmodule
`resetall