Public Member Functions
str	__str__ (self)
str	__repr__ (self)
List[Instance]	instance_path (self)
str	name (self)
int	bit_pos (self)
Optional[Value]	value (self)
bool	is_output_port (self)

Detailed Description

Represents a signal or port object in the dataflow graph.
This class encapsulates a specific signal within the hardware hierarchy,
including its location in the instance hierarchy, signal name, and bit position
for multi-bit signals.
Attributes:
    instance_path: Hierarchical path to the module containing this object
    name: The signal/port name within the module
    bit_pos: Bit position for multi-bit signals (0 for single-bit)

Definition at line 43 of file synth.py.

Member Function Documentation

◆ repr()

str synth.Object.__repr__ ( self )

Definition at line 68 of file synth.py.

◆ str()

str synth.Object.__str__ ( self )

Generate a human-readable string representation of this object.
Format: "module1:instance1/module2:instance2 signal_name[bit_pos]"

Definition at line 59 of file synth.py.

References msft.DynamicInstanceOp.instance_path(), and instance_path().

◆ bit_pos()

int synth.Object.bit_pos ( self )

Get the bit position for multi-bit signals.

Definition at line 84 of file synth.py.

◆ instance_path()

List[Instance] synth.Object.instance_path ( self )

Get the hierarchical instance path to this object.

Definition at line 72 of file synth.py.

Referenced by __str__().

◆ is_output_port()

bool synth.Object.is_output_port ( self )

Check if this object represents an output port.

Definition at line 94 of file synth.py.

References BasePath.value, circt::Backedge.value, circt::DIVariable.value, circt::FieldRef.value, circt::firrtl::ContainAliasableTypes< head, tail >.value, circt::firrtl::ContainAliasableTypes< BaseTy >.value, circt::firrtl::GatedClockConversion::MatRef.value, circt::firrtl::InstanceInfo::LatticeValue.value, circt::FVInt.value, circt::llhd::deseq::ClockInfo.value, circt::llhd::deseq::FixedValue.value, circt::llhd::deseq::ResetInfo.value, circt::llhd::deseq::ValueEntry.value, circt::llhd::deseq::ValueField.value, circt::StringAttrOrRef.value, circt::synth::Object.value, circt::synth::ValueWithArrivalTime.value, ConnectInfo.value, Def.value, DependentLiveRange.value, DriveOperands.value, DriveSlice.value, esi::Constant.value, LibertyGroup::AttrEntry.value, List.value, ModuleState::RenderLong.value, Object.value, OneWord.value, Path.value, Python.support.OpOperand.value, RegisterAllocationResult.value, Signal.value, Specialized< T >.value, value(), ValueSlice.value, and ValueTerm.value.

◆ name()

str synth.Object.name ( self )

Get the name of this signal/port.

Definition at line 79 of file synth.py.

◆ value()

Optional[Value] synth.Object.value ( self )

Get the MLIR value associated with this object, if any.

Definition at line 89 of file synth.py.

Referenced by is_output_port().

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

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

Public Member Functions