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.synth.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
    • ConstantCache
      • ConstantCache.__init__()
      • ConstantCache.extract_const_val_as_const_var()
  • hwt.serializer.generic.indent module
    • getIndent()
  • hwt.serializer.generic.ops module
  • hwt.serializer.generic.tmpVarConstructor module
    • NoTmpVars
      • NoTmpVars.create_cached()
      • NoTmpVars.create_var_cached()
    • TmpVarConstructor
      • TmpVarConstructor.__init__()
      • TmpVarConstructor.create_var()
      • TmpVarConstructor.create_var_cached()
      • TmpVarConstructor.finish_var_init()
      • TmpVarConstructor.sort_hdl_declarations_first()
    • TmpVarNotConstructableError
  • hwt.serializer.generic.to_hdl_ast module
  • hwt.serializer.generic.utils module
    • TmpVarsSwap
      • TmpVarsSwap.__init__()
  • hwt.serializer.generic.value module
    • ToHdlAst_Value
      • ToHdlAst_Value.Value_try_extract_as_const()
      • ToHdlAst_Value.as_hdl_HBitsConst()
      • ToHdlAst_Value.as_hdl_HFloatConst()
      • ToHdlAst_Value.as_hdl_HFunctionConst()
      • ToHdlAst_Value.as_hdl_HStringConst()
      • ToHdlAst_Value.as_hdl_HdlSignalItem()
      • ToHdlAst_Value.as_hdl_IntegerVal()
      • ToHdlAst_Value.as_hdl_Value()
      • ToHdlAst_Value.as_hdl_int()
      • ToHdlAst_Value.is_suitable_for_const_extract()
• 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
    • ResourceError
    • ResourceFF
    • ResourceLatch
    • ResourceMUX
      • ResourceMUX.__init__()
    • ResourceRAM
      • ResourceRAM.__init__()
    • RtlResourceType
  • 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: 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

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 MyHwModule(HwModule):
    # ...
    pass

hwt.serializer.mode._serializeExclude_eval(parentModule: HwModule, 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(parentModule: HwModule, 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(parentModule: HwModule, priv)

Decide to serialize only objs with unique 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.hwParamsToValTuple(module: HwModule)

hwt.serializer.mode.serializeExclude(cls: Type[HwModule])

Never serialize HDL objects from this class

hwt.serializer.mode.serializeOnce(cls: Type[HwModule])

Serialize HDL objects only once per class

hwt.serializer.mode.serializeParamsUniq(cls: Type[HwModule])

Decide to serialize only when parameters are unique

hwt.serializer.serializer_config module

hwt.serializer.serializer_filter module

hwt.serializer.store_manager module

hwt.serializer.utils module