Implement the SysInfo API for a standard MMIO protocol. More...

#include <Services.h>

Inheritance diagram for esi::services::MMIOSysInfo:

[legend]

Collaboration diagram for esi::services::MMIOSysInfo:

[legend]

Public Member Functions
	MMIOSysInfo (const MMIO *)

uint32_t	getEsiVersion () const override
	Get the ESI version number to check version compatibility.

virtual std::vector< uint8_t >	getCompressedManifest () const override
	Return the zlib compressed JSON system manifest.

Public Member Functions inherited from esi::services::SysInfo
virtual	~SysInfo ()=default

virtual std::string	getServiceSymbol () const override

virtual std::string	getJsonManifest () const
	Return the JSON-formatted system manifest.

	Service (AcceleratorConnection &conn)

Public Member Functions inherited from esi::services::Service
	Service (AcceleratorConnection &conn)

virtual	~Service ()=default

virtual Service *	getChildService (Service::Type service, AppIDPath id={}, std::string implName={}, ServiceImplDetails details={}, HWClientDetails clients={})
	Create a "child" service of this service.

virtual BundlePort *	getPort (AppIDPath id, const BundleType *type) const
	Get specialized port for this service to attach to the given appid path.

AcceleratorConnection &	getConnection () const

Private Attributes
const MMIO *	mmio

Additional Inherited Members
Public Types inherited from esi::services::Service
using	Type = const std::type_info &

Protected Attributes inherited from esi::services::Service
AcceleratorConnection &	conn

Detailed Description

Implement the SysInfo API for a standard MMIO protocol.

Definition at line 185 of file Services.h.

Constructor & Destructor Documentation

◆ MMIOSysInfo()

MMIOSysInfo::MMIOSysInfo ( const MMIO * mmio )

Definition at line 133 of file Services.cpp.

Member Function Documentation

◆ getCompressedManifest()

std::vector< uint8_t > MMIOSysInfo::getCompressedManifest ( ) const

overridevirtual

Return the zlib compressed JSON system manifest.

Implements esi::services::SysInfo.

Definition at line 143 of file Services.cpp.

References getEsiVersion(), esi::MetadataOffset, mmio, and esi::services::MMIO::read().

◆ getEsiVersion()

uint32_t MMIOSysInfo::getEsiVersion ( ) const

overridevirtual

Get the ESI version number to check version compatibility.

Implements esi::services::SysInfo.

Definition at line 136 of file Services.cpp.

References esi::MagicNumber, esi::MetadataOffset, mmio, esi::services::MMIO::read(), and esi::toHex().

Referenced by getCompressedManifest().

Member Data Documentation

◆ mmio

const MMIO* esi::services::MMIOSysInfo::mmio

private

Definition at line 196 of file Services.h.

Referenced by getCompressedManifest(), and getEsiVersion().

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

/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Services.h
/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Services.cpp

Public Member Functions

Private Attributes

Additional Inherited Members