bsv

Callback.

Classes:

• BSVCallback –

  Callback function for Peakrdl Generated Bluespec verilog code.

BSVCallback

BSVCallback(dut)

Bases: CallbackBase

Callback function for Peakrdl Generated Bluespec verilog code.

The BSV generated RTL 1. Retains the signal name for Reg* types. 2. For Wire types the signal has a _wget suffix to indicate value and a _whas suffix to indicate the signal is driven in the current cycle. 3. The original Bluespec code uses s as the pattern for the bleuspec variable name.

The override for the sig function takes care of this difference.

Parameters:

• dut (Any) –

  cocotb dut reference.

Methods:

• read –

  Finds the actual signal in RTL and returns its value.

• sig –

  Finds the signal in dut and returns a reference to it.

• write –

  Finds the actual signal in RTL and sets its value.

Source code in src/peakrdl_cocotb_ralgen/callbacks/callback_base.py

def __init__(self, dut):
    """Initialize.

    params:
      dut (Any): cocotb dut reference.
    """
    self.dut = dut

read

read(sigHash)

Finds the actual signal in RTL and returns its value.

Parameters:

• sigHash (dict) –

  A dictionary of signal parameters " {"reg": register, "sig": signal_name, "low": signal's low index in the register, "high": signal's high index in the register, }

Source code in src/peakrdl_cocotb_ralgen/callbacks/callback_base.py

def read(self, sigHash):
    """Finds the actual signal in RTL and returns its value.

    params:
        sigHash (dict): A dictionary of signal parameters "
            {"reg": register,
            "sig": signal_name,
            "low": signal's low index in the register,
            "high": signal's high index in the register,
             }
    """
    rv = self.sig(sigHash).value if self.sig(sigHash) is not None else None
    cocotb.log.debug(f"{sigHash} rv={rv}")
    return rv

sig

sig(sigHash)

Finds the signal in dut and returns a reference to it.

Parameters:

• sigHash (dict) –

  A dictionary of signal parameters " {"reg": register, "sig": signal_name, "low": signal's low index in the register, "high": signal's high index in the register, }

Source code in src/peakrdl_cocotb_ralgen/callbacks/bsv.py

def sig(self, sigHash):
    """Finds the signal in dut and returns a reference to it.

    params:
        sigHash (dict): A dictionary of signal parameters "
            {"reg": register,
            "sig": signal_name,
            "low": signal's low index in the register,
            "high": signal's high index in the register,
             }
    """
    sig = f"s{sigHash['path'][-2].lower()}{sigHash['path'][-1]}"
    return (
        getattr(self.dut, sig)
        if hasattr(self.dut, sig)
        else getattr(self.dut, sig + "_wget")
    )

write

write(sigHash, wr)

Finds the actual signal in RTL and sets its value.

Parameters:

• sigHash (dict) –

  A dictionary of signal parameters " {"reg": register, "sig": signal_name, "low": signal's low index in the register, "high": signal's high index in the register, }

• wr (int) –

  Integer value to write to the signal

Source code in src/peakrdl_cocotb_ralgen/callbacks/callback_base.py

def write(self, sigHash, wr):
    """Finds the actual signal in RTL and sets its value.

    params:
        sigHash (dict): A dictionary of signal parameters "
            {"reg": register,
            "sig": signal_name,
            "low": signal's low index in the register,
            "high": signal's high index in the register,
             }
        wr (int): Integer value to write to the signal
    """
    if self.sig(sigHash):
        self.sig(sigHash).value = Force(wr)