esiaccel.types.ReadPort Class Reference

Inheritance diagram for esiaccel.types.ReadPort:

Collaboration diagram for esiaccel.types.ReadPort:

Public Member Functions
	__init__ (self, BundlePort owner, cpp.ReadChannelPort cpp_port)
object	read (self)
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)

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 accelerator to the host.

Definition at line 627 of file types.py.

Constructor & Destructor Documentation

__init__()

esiaccel.types.ReadPort.__init__	(		self,
		BundlePort	owner,
		cpp.ReadChannelPort	cpp_port )

Definition at line 630 of file types.py.

References __init__().

Referenced by __init__().

Member Function Documentation

read()

object esiaccel.types.ReadPort.read

(

self

)

Read a typed message from the channel. Returns a deserialized object of a
type defined by the port type.

Definition at line 634 of file types.py.

References esiaccel.types.Port.cpp_port, read(), 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 read().

---

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