Inheritance diagram for esiaccel.types.WritePort:

Collaboration diagram for esiaccel.types.WritePort:

[legend]

Public Member Functions
	__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
	__init__ (self, BundlePort owner, cpp.ChannelPort cpp_port)
	connect (self, Optional[int] buffer_size=None)
	disconnect (self)

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

Additional Inherited Members
Public Attributes inherited from esiaccel.types.Port
	owner = owner
	cpp_port = cpp_port
	type = _get_esi_type(cpp_port.type)
	window_type = _get_esi_type(win) if win is not None else None

Detailed Description

A unidirectional communication channel from the host to the accelerator.

Definition at line 599 of file types.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 602 of file types.py.

References __init__().

Referenced by __init__().

Member Function Documentation

◆ __serialize_msg()

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

private

Definition at line 606 of file types.py.

References circt::arc::StateInfo.type, circt::calyx::PortInfo.type, circt::esi::BundledChannel.type, circt::esi::ServicePortInfo.type, circt::FieldInfo.type, circt::firrtl::ClassElement.type, circt::firrtl::PortInfo.type, circt::hw::detail::OffsetFieldInfo.type, circt::hw::ModulePort.type, circt::ImportVerilog::FlattenedIfacePort.type, circt::ImportVerilog::VirtualInterfaceLowering.type, circt::moore::DPIArgInfo.type, circt::moore::StructLikeMember.type, circt::om::evaluator::AttributeValue.type, circt::om::evaluator::ListValue.type, circt::rtg::DictEntry.type, circt::sim::DPIArgument.type, circt::systemc::detail::PortInfo.type, esi::backends::cosim::RpcClient.Impl::ChannelMeta.type, esi::backends::cosim::RpcClient::ChannelDesc.type, esi::BundlePort.type, esi::ChannelAssignment.type, esi::ChannelPort.type, esi::Constant.type, esiaccel.types.BundleType.Channel.type, esiaccel.types.Port.type, FIRRTLBundleField.type, FIRRTLClassElement.type, HWModulePort.type, HWStructFieldInfo.type, HWUnionFieldInfo.type, and Unknown.type.

Referenced by try_write(), and 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 621 of file types.py.

References __serialize_msg(), and esiaccel.types.Port.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 614 of file types.py.

References __serialize_msg(), esiaccel.types.Port.cpp_port, and write().

Referenced by write().

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