hwt.synthesizer.interfaceLevel package

interfaceLevel is responsible for manipulation of high-level interfaces.

Submodules

hwt.synthesizer.interfaceLevel.directionFns module

class hwt.synthesizer.interfaceLevel.directionFns.HwIODirectionFns

Bases: object

_reverseDirection()

Reverse direction of this interface in implementation stage

_setAsExtern(isExtern: bool)

Set interface as external

_setDirectionsLikeIn(hioDir: INTF_DIRECTION)

hwt.synthesizer.interfaceLevel.getDefaultClkRts module

hwt.synthesizer.interfaceLevel.getDefaultClkRts.getClk(module: HwModuleBase)

Get clock signal from unit instance

hwt.synthesizer.interfaceLevel.getDefaultClkRts.getRst(module: HwModuleBase)

Get reset signal from unit instance

hwt.synthesizer.interfaceLevel.hwModuleImplHelpers module

hwt.synthesizer.interfaceLevel.implDependent module

class hwt.synthesizer.interfaceLevel.implDependent.HwIOImplDependentFns

Bases: object

HwIO functions which have high potential to be overloaded in concrete interface implementation

_getAssociatedClk()

If interface has associated clk return it otherwise try to find clk on parent recursively

_getAssociatedRst()

If interface has associated rst(_n) return it otherwise try to find rst(_n) on parent recursively

_getIpCoreIntfClass()

_initSimAgent(sim: HdlSimulator)

hwt.synthesizer.interfaceLevel.propDeclrCollector module

class hwt.synthesizer.interfaceLevel.propDeclrCollector.MakeClkRstAssociations(module: HwModule, clk=None, rst=None)

Bases: object

All newly added interfaces will be associated with clk, rst specified in constructor of this object.

__init__(module: HwModule, clk=None, rst=None)

class hwt.synthesizer.interfaceLevel.propDeclrCollector.MakeParamsShared(module: HwModule, exclude: Tuple[Set[str], Set[str]] | None, prefix: str)

Bases: object

All newly added interfaces and units will share all parametes with unit specified in constructor of this object.

__init__(module: HwModule, exclude: Tuple[Set[str], Set[str]] | None, prefix: str)

class hwt.synthesizer.interfaceLevel.propDeclrCollector.PropDeclrCollector

Bases: object

Class which manages the registration of components and interfaces in specified elaboration phases.

It uses __setattr__ listeners to detect new properties and then calls a listener function to process the registration.

Used for HwModule, HwIO classes to detect and load interfaces and components.

_associated(clk=None, rst=None) → MakeClkRstAssociations

associate newly added interfaces to “self” with selected clk, rst (if interface is not associated agents try to find clk/rst by _getAssociatedClk/_getAssociatedRst which will search for any clk/rst on parent recursively) Usage:

with self._associated(clk=self.myClk, rst=self.myRst):
    self.myAxi = Axi4Stream()
    # this interface is associated with myClk and myRst
    # simulation agents and component builders will use them

Parameters:

exclude – params which should not be shared

_declrCollector(name: str, prop: object)

_hwParamsShared(exclude: Tuple[Set[str], Set[str]] | None = None, prefix='') → MakeParamsShared

Auto-propagate params by name to child components and interfaces Usage:

with self._hwParamsShared():
    # your interfaces and unit which should share all params with "self" there

Parameters:

• exclude – tuple (src param names to exclude, dst param names to exclude)

• prefix – prefix which should be added to name of child parameters before parameter name matching

_implCollector(name: str, prop)

Handle property definitions in _impl phase

_loadConfig() → None

Load params in hwConfig()

_loadImpl()

_make_association(clk=None, rst=None) → None

Associate this object with specified clk/rst

_paramCollector(pName: str, prop)

_registerArray(name: str | None, items: HObjList[Self], onParentPropertyPath: TypePath)

Register array of items on interface level object

_registerArray_append(arr: HObjList[Self], item: Self, index: int)

Register a single object in the list

_registerHwIO(hwIOName: str, hwIO: HwIOBase, onParentPropertyPath: TypePath, isPrivate: bool)

Register HwIO object on interface level object

_registerHwIOInHwImpl(hwIOName: str, hwio: HwIOBase, onParentPropertyPath: TypePath)

Register interface in implementation phase

_registerParameter(pName: str, parameter: HwParam) → None

Register HwParam object on interface level object

_registerSubmodule(mName: str, submodule: HwModule, onParentPropertyPath: TypePath)

Register unit object on interface level object

_registerSubmoduleInImpl(name: str, m: HwModuleBase, onParentPropertyPath: TypePath)

Attention:

unit has to be parametrized before it is registered (some components can change interface by parametrization)

_updateHwParamsFrom(otherObj: PropDeclrCollector, updater: Callable[[PropDeclrCollector, HwParam, HwParam], None], exclude: Tuple[Set[str], Set[str]] | None, prefix: str) → PropDeclrCollector

Update all parameters which are defined on self from otherObj

Parameters:

• otherObj – other object which HwParam instances should be updated

• updater – updater function(self, myParameter, otherParameter)

• exclude – tuple of set of param names for src and dst which which should be excluded

• prefix – prefix which should be added to name of paramters of this object before matching parameter name on parent

hwConfig() → None

Configure object parameters

• setup all parameters on this object, use HwParam class instances to allow use of parameter inheritance

• called in __init__ of class

hwDeclr() → None

In this function user should specify the declaration of interfaces for communication with outside word. It is also better to declare sub components there as it allows for better parallelization during the build.

• _declr method is called after _config

• if this object is hwt.hwModule.HwModule all interfaces are treated as externally accessible interfaces if this object is HwIO instance all subinterfaces are loaded as well

hwImpl() → None

Implementation - construct main body of the component in this function.

• called after _declr

hwt.synthesizer.interfaceLevel.propDeclrCollector.nameAvailabilityCheck(obj: PropDeclrCollector, propName: str, prop: object)

Check if not redefining property on obj but allow to cast current property to a HwParam

hwt.synthesizer.interfaceLevel.utils module

hwt.synthesizer.interfaceLevel.utils.HwIO_connectPacked(srcPacked: RtlSignalBase, dstInterface: HwIOBase | RtlSignalBase, exclude: Container[HwIOBase | RtlSignalBase] | None = None)

Connect 1D vector signal to this structuralized interface (LSB of first interface is LSB of result)

Parameters:

• packedSrc – vector which should be connected

• dstInterface – structuralized interface where should packedSrc be connected to

• exclude – sub interfaces of self which should be excluded

hwt.synthesizer.interfaceLevel.utils.HwIO_pack(hio: HwIOBase, masterDirEqTo=DIRECTION.OUT, exclude: Container[HwIOBase | RtlSignalBase] | None = None) → HBitsConst | RtlSignalBase[HBits]

Concatenate all signals to one big signal, recursively (LSB of first interface is LSB of result)

Parameters:

• masterDirEqTo – only signals with this direction are packed

• exclude – sequence of signals/interfaces to exclude

hwt.synthesizer.interfaceLevel.utils.HwIO_walkFlatten(hwio: HwIOBase, shouldEnterHwIOFn: Callable[[HwIOBase], tuple[bool, bool]] | None)

Parameters:

shouldEnterHwIOFn – function (actual hwio) returns tuple (shouldEnter, shouldYield)

hwt.synthesizer.interfaceLevel.utils.HwIO_walkSignals(hwio: HwIOBase)

exception hwt.synthesizer.interfaceLevel.utils.NotSpecifiedError

Bases: Exception

This error means that you need to implement this function to use this functionality

e.g. you have to implement Simulation agent for interface when you create new one and you can not use existing