xaiefal
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
xaiefal::XAieRscGroupBase Class Reference

base class to resources functional group More...

#include <xaiefal-rsc-group.hpp>

Inheritance diagram for xaiefal::XAieRscGroupBase:
xaiefal::XAieRscGroupAvail xaiefal::XAieRscGroupRuntime xaiefal::XAieRscGroupStatic

Public Member Functions

 XAieRscGroupBase (std::shared_ptr< XAieDevHandle > DevHd, const std::string &Name="")
 XAieRscGroupBase ()
 ~XAieRscGroupBase ()
XAieRscStat getRscStat () const
XAieRscStat getRscStat (XAie_LocType Loc) const
XAieRscStat getRscStat (XAie_LocType Loc, XAieRscType RscType) const
XAieRscStat getRscStat (XAie_LocType Loc, XAie_ModuleType Mod) const
XAieRscStat getRscStat (XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType RscType) const
XAieRscStat getRscStat (XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType RscType, uint32_t RscId) const
XAieRscStat getRscStat (const std::vector< XAie_LocType > &vLocs, XAieRscType RscType) const
XAieRscStat getRscStat (const std::vector< XAie_LocType > &vLocs, XAieRscType RscType, uint32_t RscId) const
virtual AieRC addRsc (std::shared_ptr< XAieRsc > Rsc)

Protected Member Functions

virtual XAieRscStat _getRscStat (const std::vector< XAie_LocType > &vLocs, XAie_ModuleType Mod, XAieRscType RscType, uint32_t RscId) const
XAieRscStat _getRscStatTile (XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType RscType, uint32_t RscId) const

Static Protected Member Functions

static std::vector< XAie_LocType > _getAllTilesLocs (XAie_DevInst *DevInst)
static std::vector< XAieUserRscStat > _createDrvRscStats (XAie_DevInst *DevInst, const std::vector< XAie_LocType > &vLocs, XAie_ModuleType Mod, XAieRscType RscType)

Protected Attributes

std::string FuncName
std::weak_ptr< XAieDevHandle > AieHd

Detailed Description

base class to resources functional group

Constructor & Destructor Documentation

◆ XAieRscGroupBase() [1/2]

xaiefal::XAieRscGroupBase::XAieRscGroupBase ( std::shared_ptr< XAieDevHandle > DevHd,
const std::string & Name = "" )
inline

◆ XAieRscGroupBase() [2/2]

xaiefal::XAieRscGroupBase::XAieRscGroupBase ( )
inline

◆ ~XAieRscGroupBase()

xaiefal::XAieRscGroupBase::~XAieRscGroupBase ( )
inline

Member Function Documentation

◆ _createDrvRscStats()

std::vector< XAieUserRscStat > xaiefal::XAieRscGroupBase::_createDrvRscStats ( XAie_DevInst * DevInst,
const std::vector< XAie_LocType > & vLocs,
XAie_ModuleType Mod,
XAieRscType RscType )
inlinestaticprotected

This function is to create resources statistics array to pass to lower level driver to get the resources statistics.

Parameters
DevInstAI engine device instance pointer
vLocstile locations, (0xFF, 0xFF) for any tile
Modmodule type, 0xFFFFFFFF for any module
RscType,resourcetype, 0xFFFFFFFF for any resource type
Returns
resource statistics vector which can be passed to lower level driver.

◆ _getAllTilesLocs()

std::vector< XAie_LocType > xaiefal::XAieRscGroupBase::_getAllTilesLocs ( XAie_DevInst * DevInst)
inlinestaticprotected

This function is to create tile vectors for all tiles of an AIE partition device.

Parameters
DevInstAI engine device instance pointer
Returns
vector of tiles locations of all tiles of the AIE partition device.

◆ _getRscStat()

virtual XAieRscStat xaiefal::XAieRscGroupBase::_getRscStat ( const std::vector< XAie_LocType > & vLocs,
XAie_ModuleType Mod,
XAieRscType RscType,
uint32_t RscId ) const
inlineprotectedvirtual

This function is to return resources statics of this function group.

@vLocs tile locations, (0xFF, 0xFF) for any tile @Mod module type, 0xFFFFFFFF for any module @RscType, resource type, 0xFFFFFFFF for any resource type @RscId, resource Id, 0xFFFFFFFF for any resource id

Returns
resoruce group statics object.

◆ _getRscStatTile()

XAieRscStat xaiefal::XAieRscGroupBase::_getRscStatTile ( XAie_LocType Loc,
XAie_ModuleType Mod,
XAieRscType RscType,
uint32_t RscId ) const
inlineprotected

◆ addRsc()

virtual AieRC xaiefal::XAieRscGroupBase::addRsc ( std::shared_ptr< XAieRsc > Rsc)
inlinevirtual

Reimplemented in xaiefal::XAieRscGroupAvail, and xaiefal::XAieRscGroupRuntime.

◆ getRscStat() [1/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( ) const
inline

This function is to return resources statics of this function group.

Returns
resoruce group statics object.

◆ getRscStat() [2/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( const std::vector< XAie_LocType > & vLocs,
XAieRscType RscType ) const
inline

This function is to return resources statics of this function group of specific tiles, specific resource.

@vLocs tile locations @RscType resource type

Returns
resoruce group statics object.

◆ getRscStat() [3/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( const std::vector< XAie_LocType > & vLocs,
XAieRscType RscType,
uint32_t RscId ) const
inline

This function is to return resources statics of this function group of specific tiles, specific module, specific resource, specific resource id.

@vLocs tile locations @RscType resource type @RscId resource Id

Returns
resoruce group statics object.

◆ getRscStat() [4/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( XAie_LocType Loc) const
inline

This function is to return resources statics of this function group of a specific tile.

@Loc tile location

Returns
resoruce group statics object.

◆ getRscStat() [5/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( XAie_LocType Loc,
XAie_ModuleType Mod ) const
inline

This function is to return resources statics of this function group of a specific tile, specific module.

@Loc tile location @Mod module type

Returns
resoruce group statics object.

◆ getRscStat() [6/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( XAie_LocType Loc,
XAie_ModuleType Mod,
XAieRscType RscType ) const
inline

This function is to return resources statics of this function group of a specific tile, specific module, specific resource.

@Loc tile location @Mod module type @RscType resource type

Returns
resoruce group statics object.

◆ getRscStat() [7/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( XAie_LocType Loc,
XAie_ModuleType Mod,
XAieRscType RscType,
uint32_t RscId ) const
inline

This function is to return resources statics of this function group of a specific tile, specific module, specific resource.

@Loc tile location @Mod module type @RscType resource type @RscId resource Id

Returns
resoruce group statics object.

◆ getRscStat() [8/8]

XAieRscStat xaiefal::XAieRscGroupBase::getRscStat ( XAie_LocType Loc,
XAieRscType RscType ) const
inline

This function is to return resources statics of this function group of a specific tile of a specific resource type.

@Loc tile location @RscType resource type

Returns
resoruce group statics object.

Field Documentation

◆ AieHd

std::weak_ptr<XAieDevHandle> xaiefal::XAieRscGroupBase::AieHd
protected

AI engine device instance

◆ FuncName

std::string xaiefal::XAieRscGroupBase::FuncName
protected

function name of this group

The documentation for this class was generated from the following file:
Generated on for xaiefal by doxygen 1.15.0