Inheritance diagram for esiaccel.types.WritePort:

Collaboration diagram for esiaccel.types.WritePort:

Public Member Functions
def	__init__ (self, BundlePort owner, cpp.WriteChannelPort cpp_port)

bool	write (self, msg=None)

bool	try_write (self, msg=None)

Public Member Functions inherited from esiaccel.types.Port
def	__init__ (self, BundlePort owner, cpp.ChannelPort cpp_port)

def	connect (self, Optional[int] buffer_size=None)

def	disconnect (self)

Private Member Functions
bytearray	__serialize_msg (self, msg=None)

Additional Inherited Members
Public Attributes inherited from esiaccel.types.Port
	owner

	cpp_port

	type

Detailed Description

A unidirectional communication channel from the host to the accelerator.

Definition at line 313 of file types.py.

Constructor & Destructor Documentation

◆ init()

def esiaccel.types.WritePort.__init__	(		self,
		BundlePort	owner,
		cpp.WriteChannelPort	cpp_port
	)

Definition at line 316 of file types.py.

References esiaccel.types.Port.cpp_port, and esiaccel.types.BundlePort.cpp_port.

Member Function Documentation

◆ __serialize_msg()

bytearray esiaccel.types.WritePort.__serialize_msg	(	self,
		msg = `None`
	)

private

Definition at line 320 of file types.py.

References FIRRTLBundleField.type, FIRRTLClassElement.type, HWStructFieldInfo.type, HWModulePort.type, circt::HWArithToHWTypeConverter::ConvertedType.type, circt::arc::StateInfo.type, circt::calyx::PortInfo.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::StructLikeMember.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::Constant.type, esi::ChannelAssignment.type, esi::ChannelPort.type, esiaccel.types.Port.type, ResetSignal.type, Property.type, NonHWField.type, FlatBundleFieldEntry.type, EmittedExpr.type, and FunctionRewrite.type.

Referenced by esiaccel.types.WritePort.try_write(), and esiaccel.types.WritePort.write().

◆ try_write()

bool esiaccel.types.WritePort.try_write	(	self,
		msg = `None`
	)

Like 'write', but uses the non-blocking tryWrite method of the underlying
    port. Returns True if the write was successful, False otherwise.

Definition at line 335 of file types.py.

References esiaccel.types.WritePort.__serialize_msg(), esiaccel.types.Port.cpp_port, and esiaccel.types.BundlePort.cpp_port.

◆ write()

bool esiaccel.types.WritePort.write	(	self,
		msg = `None`
	)

Write a typed message to the channel. Attempts to serialize 'msg' to what
    the accelerator expects, but will fail if the object is not convertible to
    the port type.

Definition at line 328 of file types.py.

References esiaccel.types.WritePort.__serialize_msg(), esiaccel.types.Port.cpp_port, and esiaccel.types.BundlePort.cpp_port.

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

/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/python/esiaccel/types.py

Public Member Functions

Private Member Functions

Additional Inherited Members