hwt.serializer package

This package contains serializers. Purpose of serializer class is to convert hwt representations of designed architecture to hdlConvertorAst to convert it to target language (VHDL/Verilog/SystemC…+xdc/ucf/…).

Rather than using serializer classes manually it is recommended to use hwt.synthesizer.utils.to_rtl()

The serialization process is usually a destructive operation as parts of AST can be rewritten to fit target language.

Subpackages

• hwt.serializer.combLoopAnalyzer package
  • Submodules
  • hwt.serializer.combLoopAnalyzer.tarjan module
• hwt.serializer.generic package
  • Submodules
  • hwt.serializer.generic.constant_cache module
  • hwt.serializer.generic.indent module
  • hwt.serializer.generic.ops module
  • hwt.serializer.generic.tmpVarConstructor module
  • hwt.serializer.generic.to_hdl_ast module
  • hwt.serializer.generic.utils module
  • hwt.serializer.generic.value module
• hwt.serializer.hwt package
  • Submodules
  • hwt.serializer.hwt.context module
  • hwt.serializer.hwt.ops module
  • hwt.serializer.hwt.serializer module
  • hwt.serializer.hwt.types module
  • hwt.serializer.hwt.value module
• hwt.serializer.resourceAnalyzer package
  • Submodules
  • hwt.serializer.resourceAnalyzer.analyzer module
  • hwt.serializer.resourceAnalyzer.resourceTypes module
  • hwt.serializer.resourceAnalyzer.utils module
• hwt.serializer.simModel package
  • Submodules
  • hwt.serializer.simModel.serializer module
  • hwt.serializer.simModel.tmpVarConstructorConstOnly module
  • hwt.serializer.simModel.types module
  • hwt.serializer.simModel.value module
• hwt.serializer.systemC package
  • Submodules
  • hwt.serializer.systemC.expr module
  • hwt.serializer.systemC.serializer module
  • hwt.serializer.systemC.statements module
  • hwt.serializer.systemC.type module
  • hwt.serializer.systemC.utils module
• hwt.serializer.verilog package
  • Submodules
  • hwt.serializer.verilog.context module
  • hwt.serializer.verilog.ops module
  • hwt.serializer.verilog.serializer module
  • hwt.serializer.verilog.statements module
  • hwt.serializer.verilog.types module
  • hwt.serializer.verilog.utils module
  • hwt.serializer.verilog.value module
• hwt.serializer.vhdl package
  • Submodules
  • hwt.serializer.vhdl.ops module
  • hwt.serializer.vhdl.serializer module
  • hwt.serializer.vhdl.statements module
  • hwt.serializer.vhdl.types module
  • hwt.serializer.vhdl.value module
• hwt.serializer.xdc package
  • Submodules
  • hwt.serializer.xdc.serializer module

Submodules

hwt.serializer.exceptions module

exception hwt.serializer.exceptions.SerializerException

Bases: Exception

exception hwt.serializer.exceptions.UnsupportedEventOpErr

Bases: hwt.serializer.exceptions.SerializerException

Target HDL can not use event operator in this context, it usually has to be replaced by correct expression of sensitivity list

hwt.serializer.ip_packager module

class hwt.serializer.ip_packager.IpPackager(topUnit: hwt.synthesizer.unit.Unit, name: str = None, extra_files: List[str] = [], serializer_cls=<class 'hwt.serializer.vhdl.Vhdl2008Serializer'>, target_platform=<hwt.synthesizer.dummyPlatform.DummyPlatform object>)

Bases: ipCorePackager.packager.IpCorePackager

IP-core packager

Summary:Packs HDL, constraint and other files to IP-Core package for distribution and simple integration

__init__(topUnit: hwt.synthesizer.unit.Unit, name: str = None, extra_files: List[str] = [], serializer_cls=<class 'hwt.serializer.vhdl.Vhdl2008Serializer'>, target_platform=<hwt.synthesizer.dummyPlatform.DummyPlatform object>)

Parameters:

• topObj – hwt.synthesizer.unit.Unit instance of top component
• name – optional name of top
• extra_files – list of extra HDL/constrain file names for files which should be distributed in this IP-core (*.v - verilog, *.sv,*.svh -system verilog, *.vhd - vhdl, *.xdc - XDC)
• serializer – serializer which specifies target HDL language
• target_platform – specifies properties of target platform, like available resources, vendor, etc.

getInterfaceDirection(thisIntf)

See:doc of method on parent class

getInterfaceLogicalName(intf: hwt.synthesizer.interface.Interface)

See:doc of method on parent class

getInterfacePhysicalName(intf: hwt.synthesizer.interface.Interface)

See:doc of method on parent class

getInterfaceType(intf: hwt.synthesizer.interface.Interface) → hwt.hdl.types.hdlType.HdlType

See:doc of method on parent class

getObjDebugName(obj: Union[hwt.synthesizer.interface.Interface, hwt.synthesizer.unit.Unit, hwt.synthesizer.param.Param]) → str

See:doc of method on parent class

getParamPhysicalName(p: hdlConvertorAst.hdlAst._defs.HdlIdDef)

getParamType(p: hdlConvertorAst.hdlAst._defs.HdlIdDef) → hwt.hdl.types.hdlType.HdlType

getTypeWidth(dtype: hwt.hdl.types.hdlType.HdlType, do_eval=False) → Tuple[int, Union[int, hwt.synthesizer.rtlLevel.rtlSignal.RtlSignal], bool]

See:doc of method on parent class

getVectorFromType(dtype) → Union[bool, None, Tuple[int, int]]

See:doc of method on parent class

iterInterfaces(top: hwt.synthesizer.unit.Unit)

iterParams(unit: hwt.synthesizer.unit.Unit)

paramToIpValue(idPrefix: str, g: hdlConvertorAst.hdlAst._defs.HdlIdDef, resolve) → ipCorePackager.otherXmlObjs.Value

serializeType(hdlType: hwt.hdl.types.hdlType.HdlType) → str

See:doc of method on parent class

serialzeValueToTCL(val, do_eval=False) → Tuple[str, str, bool]

See:doc of method on parent class

toHdlConversion(top, topName: str, saveTo: str) → List[str]

Parameters:

• top – object which is represenation of design
• topName – name which should be used for ipcore
• saveTo – path of directory where generated files should be stored

Returns:

list of file namens in correct compile order

class hwt.serializer.ip_packager.ToHdlAstVivadoTclExpr(name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Bases: hwt.serializer.vhdl.serializer.ToHdlAstVhdl2008

_id = <HdlValueId id>

_spirit_decode = <HdlValueId spirit:decode>

as_hdl_SignalItem(si, declaration=False)

hwt.serializer.mode module

Serializer mode specifies if hdl objects derived from parent unit should be serialized to target HDL or not

use serialize* methods to specify serialization mode for unit class

@serializeExclude
class MyUnit(Unit):
    # ...
    pass

hwt.serializer.mode._serializeExclude_eval(parentUnit, priv)

Always decide not to serialize obj

Parameters:priv – private data for this function first unit of this class Returns:tuple (do serialize this object, next priv, replacement unit)

hwt.serializer.mode._serializeOnce_eval(parentUnit, priv)

Decide to serialize only first obj of it’s class

Parameters:priv – private data for this function (first object with class == obj.__class__) Returns:tuple (do serialize this object, next priv, replacement unit) where priv is private data for this function (first object with class == obj.__class__)

hwt.serializer.mode._serializeParamsUniq_eval(parentUnit, priv)

Decide to serialize only objs with uniq parameters and class

Parameters:priv – private data for this function ({frozen_params: obj}) Returns:tuple (do serialize this object, next priv, replacement unit)

hwt.serializer.mode.freeze_dict(data)

hwt.serializer.mode.paramsToValTuple(unit)

hwt.serializer.mode.serializeExclude(cls)

Never serialize HDL objects from this class

hwt.serializer.mode.serializeOnce(cls)

Serialize HDL objects only once per class

hwt.serializer.mode.serializeParamsUniq(cls)

Decide to serialize only when parameters are unique

hwt.serializer.serializer_config module

class hwt.serializer.serializer_config.DummySerializerConfig

Bases: object

The serializer which does not do any additional code transformations and does not produce any output. It is used to generate just internal representation of RTL code.

TO_CONSTRAINTS = None

TO_HDL = None

TO_HDL_AST

alias of hwt.serializer.generic.to_hdl_ast.ToHdlAst

fileExtension = None

hwt.serializer.serializer_filter module

class hwt.serializer.serializer_filter.SerializerFilter

Bases: object

Base class for filters used to exclude some hwt.synthesizer.unit.Unit instances from target HDL (in order to prevent code duplication, archetype colisions etc.)

This base implementation keeps track about others objects and calls _serializeDecision on the hwt.synthesizer.unit.Unit instance to decide if instance should be excluded.

__init__()

Initialize self. See help(type(self)) for accurate signature.

do_serialize(unit: hwt.synthesizer.unit.Unit) → Tuple[bool, Optional[hwt.synthesizer.unit.Unit]]

Decide if this unit should be serialized or not eventually fix name to fit same already serialized unit

Parameters:

• obj – object to serialize
• serializedClasses – dict {unitCls : unitobj}
• serializedConfiguredUnits – (unitCls, paramsValues) : unitObj where paramsValues are named tuple name:value

class hwt.serializer.serializer_filter.SerializerFilterAll

Bases: hwt.serializer.serializer_filter.SerializerFilter

Ignore any serialization constraints and dump everything

do_serialize(unit: hwt.synthesizer.unit.Unit) → bool

Decide if this unit should be serialized or not eventually fix name to fit same already serialized unit

Parameters:

• obj – object to serialize
• serializedClasses – dict {unitCls : unitobj}
• serializedConfiguredUnits – (unitCls, paramsValues) : unitObj where paramsValues are named tuple name:value

class hwt.serializer.serializer_filter.SerializerFilterDoNotExclude

Bases: hwt.serializer.serializer_filter.SerializerFilter

Use all serialization specifications except @serializeExclude Usefull when it is requred to dump all components for sim etc.

do_serialize(unit: hwt.synthesizer.unit.Unit) → bool

Decide if this unit should be serialized or not eventually fix name to fit same already serialized unit

Parameters:

• obj – object to serialize
• serializedClasses – dict {unitCls : unitobj}
• serializedConfiguredUnits – (unitCls, paramsValues) : unitObj where paramsValues are named tuple name:value

hwt.serializer.store_manager module

class hwt.serializer.store_manager.SaveToFilesFlat(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, root: str, _filter: Optional[hwt.serializer.serializer_filter.SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Bases: hwt.serializer.store_manager.StoreManager

Store all produced code to a single directory, file per component.

__init__(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, root: str, _filter: Optional[hwt.serializer.serializer_filter.SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Initialize self. See help(type(self)) for accurate signature.

write(obj: Union[hdlConvertorAst.hdlAst._bases.iHdlObj, hwt.synthesizer.unit.HdlConstraintList])

class hwt.serializer.store_manager.SaveToSingleFiles(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, root: str, name: str, _filter: Optional[hwt.serializer.serializer_filter.SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Bases: hwt.serializer.store_manager.StoreManager

Store all produced code to a single directory, all component source code to single file and all constrains to single file.

__init__(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, root: str, name: str, _filter: Optional[hwt.serializer.serializer_filter.SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Initialize self. See help(type(self)) for accurate signature.

write(obj: Union[hdlConvertorAst.hdlAst._bases.iHdlObj, hwt.synthesizer.unit.HdlConstraintList])

class hwt.serializer.store_manager.SaveToStream(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, stream: _io.StringIO, _filter: Optional[hwt.serializer.serializer_filter.SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Bases: hwt.serializer.store_manager.StoreManager

Store all produced code to an output stream

__init__(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, stream: _io.StringIO, _filter: Optional[hwt.serializer.serializer_filter.SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Initialize self. See help(type(self)) for accurate signature.

write(obj: Union[hdlConvertorAst.hdlAst._bases.iHdlObj, hwt.synthesizer.unit.HdlConstraintList])

class hwt.serializer.store_manager.StoreManager(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, _filter: Type[SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Bases: object

A base class for an objects which manage how the output of the serialization is stored by serializer_cls

__init__(serializer_cls: hwt.serializer.serializer_config.DummySerializerConfig, _filter: Type[SerializerFilter] = None, name_scope: Optional[hdlConvertorAst.translate.common.name_scope.NameScope] = None)

Initialize self. See help(type(self)) for accurate signature.

hierarchy_pop(obj: Unit) → hdlConvertorAst.translate.common.name_scope.NameScope

hierarchy_push(obj: Unit) → hdlConvertorAst.translate.common.name_scope.NameScope

write(obj: Union[hdlConvertorAst.hdlAst._bases.iHdlObj, hwt.synthesizer.unit.HdlConstraintList])

hwt.serializer.utils module

hwt.serializer.utils.HdlStatement_sort_key(stm: hwt.hdl.statements.statement.HdlStatement)

hwt.serializer.utils.RtlSignal_sort_key(s: hwt.synthesizer.rtlLevel.mainBases.RtlSignalBase)

hwt.serializer.utils.getMaxStmIdForStm(stm)

Get maximum _instId from all assignments in statement, used for sorting of processes in architecture