hw.HWModuleOp Class Reference

Inheritance diagram for hw.HWModuleOp:

Collaboration diagram for hw.HWModuleOp:

Public Member Functions
def	__init__ (self, name, input_ports=[], output_ports=[], *parameters=[], attributes={}, body_builder=None, loc=None, ip=None)
def	body (self)
def	entry_block (self)
def	input_indices (self)
def	__getattr__ (self, name)
dict[str:Value]	inputs (self)
dict[str:Type]	outputs (self)
def	add_entry_block (self)
Public Member Functions inherited from hw.ModuleLike
def	type (self)
def	name (self)
def	is_external (self)
list[ParamDeclAttr]	parameters (self)
def	instantiate (self, str name, Dict[str, object] parameters={}, results=None, sym_name=None, loc=None, ip=None, **kwargs)

Detailed Description

Specialization for the HW module op class.

Definition at line 294 of file hw.py.

Constructor & Destructor Documentation

__init__()

def hw.HWModuleOp.__init__	(		self,
			name,
			input_ports = [],
			output_ports = [],
		*	parameters = [],
			attributes = {},
			body_builder = None,
			loc = None,
			ip = None
	)

Create a module-like with the provided `name`, `input_ports`, and
`output_ports`.
- `name` is a string representing the module name.
- `input_ports` is a list of pairs of string names and mlir.ir types.
- `output_ports` is a list of pairs of string names and mlir.ir types.
- `body_builder` is an optional callback, when provided a new entry block
  is created and the callback is invoked with the new op as argument within
  an InsertionPoint context already set for the block. The callback is
  expected to insert a terminator in the block.

Reimplemented from hw.ModuleLike.

Definition at line 297 of file hw.py.

Member Function Documentation

__getattr__()

def hw.HWModuleOp.__getattr__	(		self,
			name
	)

Definition at line 337 of file hw.py.

References hw.HWModuleOp.entry_block(), and hw.HWModuleOp.input_indices().

add_entry_block()

def hw.HWModuleOp.add_entry_block

(

self

)

Definition at line 354 of file hw.py.

References circt::hw::PortConverterImpl.body, circt::hw::PortConversion.body, hw.HWModuleOp.body(), hw.TypeScopeOp.body(), hw.ModuleLike.is_external(), FIRRTLBundleField.type, FIRRTLClassElement.type, HWStructFieldInfo.type, HWModulePort.type, circt::HWArithToHWTypeConverter::ConvertedType.type, circt::arc::StateInfo.type, circt::calyx::PortInfo.type, circt::esi::ESIAPIType.type, circt::esi::ServicePortInfo.type, circt::esi::BundledChannel.type, circt::firrtl::PortInfo.type, circt::firrtl::ClassElement.type, circt::hw::ModulePort.type, circt::hw::detail::FieldInfo.type, circt::hw::detail::OffsetFieldInfo.type, circt::moore::StructMember.type, circt::om::evaluator::ReferenceValue.type, circt::om::evaluator::AttributeValue.type, circt::om::evaluator::ListValue.type, circt::om::evaluator::MapValue.type, circt::om::evaluator::TupleValue.type, circt::systemc::detail::PortInfo.type, fsm.MachineOp.type(), hw.ModuleLike.type(), Python.support.OpOperand.type(), esi::ChannelPort.type, esiaccel.types.Port.type, ResetSignal.type, Property.type, NonHWField.type, FlatBundleFieldEntry.type, EmittedExpr.type, and FunctionRewrite.type.

Referenced by hw.ModuleLike.__init__().

body()

def hw.HWModuleOp.body

(

self

)

Definition at line 321 of file hw.py.

Referenced by fsm.MachineOp.__init__(), esi.ESIPureModuleOp.add_entry_block(), and hw.HWModuleOp.add_entry_block().

entry_block()

def hw.HWModuleOp.entry_block

(

self

)

Definition at line 325 of file hw.py.

Referenced by hw.HWModuleOp.__getattr__(), and hw.HWModuleOp.inputs().

input_indices()

def hw.HWModuleOp.input_indices

(

self

)

Definition at line 329 of file hw.py.

References FIRRTLBundleField.type, FIRRTLClassElement.type, HWStructFieldInfo.type, HWModulePort.type, circt::HWArithToHWTypeConverter::ConvertedType.type, circt::arc::StateInfo.type, circt::calyx::PortInfo.type, circt::esi::ESIAPIType.type, circt::esi::ServicePortInfo.type, circt::esi::BundledChannel.type, circt::firrtl::PortInfo.type, circt::firrtl::ClassElement.type, circt::hw::ModulePort.type, circt::hw::detail::FieldInfo.type, circt::hw::detail::OffsetFieldInfo.type, circt::moore::StructMember.type, circt::om::evaluator::ReferenceValue.type, circt::om::evaluator::AttributeValue.type, circt::om::evaluator::ListValue.type, circt::om::evaluator::MapValue.type, circt::om::evaluator::TupleValue.type, circt::systemc::detail::PortInfo.type, fsm.MachineOp.type(), hw.ModuleLike.type(), Python.support.OpOperand.type(), esi::ChannelPort.type, esiaccel.types.Port.type, ResetSignal.type, Property.type, NonHWField.type, FlatBundleFieldEntry.type, EmittedExpr.type, and FunctionRewrite.type.

Referenced by hw.HWModuleOp.__getattr__(), and hw.HWModuleOp.inputs().

inputs()

dict[str:Value] hw.HWModuleOp.inputs

(

self

)

Definition at line 343 of file hw.py.

References hw.HWModuleOp.entry_block(), and hw.HWModuleOp.input_indices().

outputs()

dict[str:Type] hw.HWModuleOp.outputs

(

self

)

Definition at line 349 of file hw.py.

References FIRRTLBundleField.type, FIRRTLClassElement.type, HWStructFieldInfo.type, HWModulePort.type, circt::HWArithToHWTypeConverter::ConvertedType.type, circt::arc::StateInfo.type, circt::calyx::PortInfo.type, circt::esi::ESIAPIType.type, circt::esi::ServicePortInfo.type, circt::esi::BundledChannel.type, circt::firrtl::PortInfo.type, circt::firrtl::ClassElement.type, circt::hw::ModulePort.type, circt::hw::detail::FieldInfo.type, circt::hw::detail::OffsetFieldInfo.type, circt::moore::StructMember.type, circt::om::evaluator::ReferenceValue.type, circt::om::evaluator::AttributeValue.type, circt::om::evaluator::ListValue.type, circt::om::evaluator::MapValue.type, circt::om::evaluator::TupleValue.type, circt::systemc::detail::PortInfo.type, fsm.MachineOp.type(), hw.ModuleLike.type(), Python.support.OpOperand.type(), esi::ChannelPort.type, esiaccel.types.Port.type, ResetSignal.type, Property.type, NonHWField.type, FlatBundleFieldEntry.type, EmittedExpr.type, and FunctionRewrite.type.

---

The documentation for this class was generated from the following file:

• /home/runner/work/circt-www/circt-www/circt_src/lib/Bindings/Python/dialects/hw.py