xaiefal::XAieDev Class Reference

AI engine device class. It defines AI engine device operations. More...

#include <xaiefal-base.hpp>

Public Member Functions
	XAieDev ()=delete
	XAieDev (XAie_DevInst *DevPtr, bool TurnOnFinishOnDestruct=false)
	~XAieDev ()
XAieTile &	tile (XAie_LocType Loc)
XAieTile &	tile (uint8_t Col, uint32_t Row)
XAie_DevInst *	dev ()
std::shared_ptr< XAieDevHandle >	getDevHandle ()
XAieDevHdRscGroupWrapper &	getRscGroup (const std::string &GName)
void	removeRscGroup (const std::string &GName)
XAieRscStat	getRscStat (const std::string &GName)
AieRC	saveAllocatedRscsToFile (const std::string &File)
AieRC	loadStaticRscsFromMem (const char *MetaData)
AieRC	reserveEcc ()
AieRC	reserveErrorHandling ()
std::shared_ptr< XAieBroadcast >	broadcast (std::vector< XAie_LocType > &vLocs, XAie_ModuleType StartM, XAie_ModuleType EndM, XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieBroadcast >	broadcast (std::vector< XAie_LocType > &vLocs, XAie_ModuleType StartM, XAie_ModuleType EndM)
AieRC	modToString (XAie_ModuleType Mod, std::string &MString)
AieRC	stringToMod (const std::string &MString, XAie_ModuleType &Mod)

Detailed Description

AI engine device class. It defines AI engine device operations.

Constructor & Destructor Documentation

XAieDev() [1/2]

xaiefal::XAieDev::XAieDev ( )

delete

XAieDev() [2/2]

xaiefal::XAieDev::XAieDev ( XAie_DevInst * DevPtr, bool TurnOnFinishOnDestruct = false )

inline

~XAieDev()

xaiefal::XAieDev::~XAieDev ( )

inline

Member Function Documentation

broadcast() [1/2]

std::shared_ptr< XAieBroadcast > xaiefal::XAieDev::broadcast ( std::vector< XAie_LocType > & vLocs, XAie_ModuleType StartM, XAie_ModuleType EndM )

inline

broadcast() [2/2]

std::shared_ptr< XAieBroadcast > xaiefal::XAieDev::broadcast ( std::vector< XAie_LocType > & vLocs, XAie_ModuleType StartM, XAie_ModuleType EndM, XAieDevHdRscGroupWrapper & RGroup )

inline

This function returns broadcast resource software object within a tile.

Parameters

vLocs	vector of tile locations
StartM	starting module of the broadcast channel
EndM	Ending module of the broadcast channel
GName	resource group name

Returns

broadcast channel software object pointer within a tile.

Please note that this function will not request hardware resource. After this function is called, in order to reserve the hardware resource, it will need to call reserve() function of the resource class.

dev()

XAie_DevInst * xaiefal::XAieDev::dev ( )

inline

This function returns AI engine device pointer.

Returns

AI engine device pointer.

getDevHandle()

std::shared_ptr< XAieDevHandle > xaiefal::XAieDev::getDevHandle ( )

inline

This function returns AI engine device handle

Returns

AI engine device handle

getRscGroup()

XAieDevHdRscGroupWrapper & xaiefal::XAieDev::getRscGroup ( const std::string & GName )

inline

This function returns requested resource group. If the resource group already exists, it returns it; if not, create the group.

Parameters

GName

resource group name

Returns

resource group wrapper

getRscStat()

XAieRscStat xaiefal::XAieDev::getRscStat ( const std::string & GName )

inline

This function returns requested resource group resource statistics

Parameters

GName

resource group name

Returns

resource group resource statistics

loadStaticRscsFromMem()

AieRC xaiefal::XAieDev::loadStaticRscsFromMem ( const char * MetaData )

inline

This loads resource metadata into the static resource bitmaps

Parameters

MetaData

pointer to resource metadata

Returns

XAIE_OK for success, error code for failure

modToString()

AieRC xaiefal::XAieDev::modToString ( XAie_ModuleType Mod, std::string & MString )

inline

This function returns module type string.

Parameters

Mod	module type
MString	returns module type name in string

Returns

XAIE_OK for success, error code for failure

removeRscGroup()

void xaiefal::XAieDev::removeRscGroup ( const std::string & GName )

inline

This function remove the resource group specified by the resource group name

Parameters

GName

resource group name

reserveEcc()

AieRC xaiefal::XAieDev::reserveEcc ( )

inline

This function makes a call to RscMgr Backend to reserve resources necessary for ECC

Returns

XAIE_OK for success, error code for failure

reserveErrorHandling()

AieRC xaiefal::XAieDev::reserveErrorHandling ( )

inline

This function makes a call to RscMgr Backend to reserve resources necessary for Error Handling

Returns

XAIE_OK for success, error code for failure

saveAllocatedRscsToFile()

AieRC xaiefal::XAieDev::saveAllocatedRscsToFile ( const std::string & File )

inline

This function saves all runtime allocated resources metadata to given filename

Parameters

File	filename string

Returns

XAIE_OK for success, error code for failure

stringToMod()

AieRC xaiefal::XAieDev::stringToMod ( const std::string & MString, XAie_ModuleType & Mod )

inline

This function returns module type from module name string.

Parameters

MString	module type name in string
Mod	returns module type

Returns

XAIE_OK for success, error code for failure

tile() [1/2]

XAieTile & xaiefal::XAieDev::tile ( uint8_t Col, uint32_t Row )

inline

This function returns a tile object reference.

Parameters

Col	absolute column index
Row	absolute row index, 0 is shim row

Returns

tile object reference

tile() [2/2]

XAieTile & xaiefal::XAieDev::tile ( XAie_LocType Loc )

inline

This function returns a tile object reference.

Parameters

Loc	tile Location

Returns

tile object reference

---

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

• src/common/xaiefal-base.hpp
• src/rsc/xaiefal-rscmgr.hpp