xaiefal
Loading...
Searching...
No Matches
Public Member Functions
xaiefal::XAieMod Class Reference
module XAie_ModuleType

AI enigne module. It defines AI engine module operations. such as get resource within a module. More...

#include <xaiefal-base.hpp>

Public Member Functions

 XAieMod ()
 XAieMod (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod)
 ~XAieMod ()
XAie_LocType loc () const
XAie_ModuleType mod () const
XAieRscStat getRscStat (const std::string &GName)
std::shared_ptr< XAiePerfCounter > perfCounter (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAiePerfCounter > perfCounter ()
std::shared_ptr< XAieMdmPerfCounter > mdmPerfCounter (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieMdmPerfCounter > mdmPerfCounter ()
std::shared_ptr< XAieTraceCntr > traceControl ()
std::shared_ptr< XAieTraceEvent > traceEvent (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieTraceEvent > traceEvent ()
std::shared_ptr< XAieActiveCycles > activeCycles (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieActiveCycles > activeCycles ()
std::shared_ptr< XAieStallCycles > stallCycles (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieStallCycles > stallCycles ()
std::shared_ptr< XAieStallOccurrences > stallOccurrences (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieStallOccurrences > stallOccurrences ()
std::shared_ptr< XAiePCEvent > pcEvent (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAiePCEvent > pcEvent ()
std::shared_ptr< XAiePCRange > pcRange (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAiePCRange > pcRange ()
std::shared_ptr< XAieComboEvent > comboEvent (XAieDevHdRscGroupWrapper &RGroup, uint32_t ENum=2)
std::shared_ptr< XAieComboEvent > comboEvent (uint32_t ENum=2)
std::shared_ptr< XAieGroupEventHandle > groupEvent (XAieDevHdRscGroupWrapper &RGroup, XAie_Events Event)
std::shared_ptr< XAieGroupEventHandle > groupEvent (XAie_Events Event)
std::shared_ptr< XAieUserEvent > userEvent (XAieDevHdRscGroupWrapper &RGroup)
std::shared_ptr< XAieUserEvent > userEvent ()

Detailed Description

AI enigne module. It defines AI engine module operations. such as get resource within a module.

Constructor & Destructor Documentation

◆ XAieMod() [1/2]

xaiefal::XAieMod::XAieMod ( )
inline

◆ XAieMod() [2/2]

xaiefal::XAieMod::XAieMod ( XAieDev & Dev,
XAie_LocType Loc,
XAie_ModuleType Mod )
inline

◆ ~XAieMod()

xaiefal::XAieMod::~XAieMod ( )
inline

Member Function Documentation

◆ activeCycles() [1/2]

std::shared_ptr< XAieActiveCycles > xaiefal::XAieMod::activeCycles ( )
inline

◆ activeCycles() [2/2]

std::shared_ptr< XAieActiveCycles > xaiefal::XAieMod::activeCycles ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns perfcounter resource software object for active cycles.

Parameters
RGroupresource group
Returns
perfconter software object pointer

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.

◆ comboEvent() [1/2]

std::shared_ptr< XAieComboEvent > xaiefal::XAieMod::comboEvent ( uint32_t ENum = 2)
inline

◆ comboEvent() [2/2]

std::shared_ptr< XAieComboEvent > xaiefal::XAieMod::comboEvent ( XAieDevHdRscGroupWrapper & RGroup,
uint32_t ENum = 2 )
inline

This function returns combo event resource software object.

Parameters
RGroupresource group @ENum number of input events
Returns
combo event software object pointer

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.

◆ getRscStat()

XAieRscStat xaiefal::XAieMod::getRscStat ( const std::string & GName)
inline

This function returns requested resource group resource statistics of the tile.

Parameters
GNameresource group name
Returns
resource group resource statistics

◆ groupEvent() [1/2]

std::shared_ptr< XAieGroupEventHandle > xaiefal::XAieMod::groupEvent ( XAie_Events Event)
inline

◆ groupEvent() [2/2]

std::shared_ptr< XAieGroupEventHandle > xaiefal::XAieMod::groupEvent ( XAieDevHdRscGroupWrapper & RGroup,
XAie_Events Event )
inline

This function returns group event handle object shared pointer

Parameters
RGroupresource group @Event group event
Returns
group event handle software object pointer

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.

◆ loc()

XAie_LocType xaiefal::XAieMod::loc ( ) const
inline

This function returns tile location

Returns
tile location

◆ mdmPerfCounter() [1/2]

std::shared_ptr< XAieMdmPerfCounter > xaiefal::XAieMod::mdmPerfCounter ( )
inline

◆ mdmPerfCounter() [2/2]

std::shared_ptr< XAieMdmPerfCounter > xaiefal::XAieMod::mdmPerfCounter ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns MDM perfcounter resource software object of the module (SHIM tile only).

Parameters
RGroupresource group
Returns
perfconter software object pointer

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.

◆ mod()

XAie_ModuleType xaiefal::XAieMod::mod ( ) const
inline

This function returns module type

Returns
module type

◆ pcEvent() [1/2]

std::shared_ptr< XAiePCEvent > xaiefal::XAieMod::pcEvent ( )
inline

◆ pcEvent() [2/2]

std::shared_ptr< XAiePCEvent > xaiefal::XAieMod::pcEvent ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns PC event resource software object.

Parameters
RGroupresource group
Returns
PC event software object pointer

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.

◆ pcRange() [1/2]

std::shared_ptr< XAiePCRange > xaiefal::XAieMod::pcRange ( )
inline

◆ pcRange() [2/2]

std::shared_ptr< XAiePCRange > xaiefal::XAieMod::pcRange ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns PC range resource software object.

Parameters
RGroupresource group
Returns
PC range software object pointer

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.

◆ perfCounter() [1/2]

std::shared_ptr< XAiePerfCounter > xaiefal::XAieMod::perfCounter ( )
inline

◆ perfCounter() [2/2]

std::shared_ptr< XAiePerfCounter > xaiefal::XAieMod::perfCounter ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns perfcounter resource software object of the module.

Parameters
RGroupresource group
Returns
perfconter software object pointer

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.

◆ stallCycles() [1/2]

std::shared_ptr< XAieStallCycles > xaiefal::XAieMod::stallCycles ( )
inline

◆ stallCycles() [2/2]

std::shared_ptr< XAieStallCycles > xaiefal::XAieMod::stallCycles ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns perfcounter resource software object for stall cycles.

Parameters
RGroupresource group
Returns
perfconter software object pointer

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.

◆ stallOccurrences() [1/2]

std::shared_ptr< XAieStallOccurrences > xaiefal::XAieMod::stallOccurrences ( )
inline

◆ stallOccurrences() [2/2]

std::shared_ptr< XAieStallOccurrences > xaiefal::XAieMod::stallOccurrences ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns perfcounter resource software object for stall occurences.

Parameters
RGroupresource group
Returns
perfconter software object pointer

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.

◆ traceControl()

std::shared_ptr< XAieTraceCntr > xaiefal::XAieMod::traceControl ( )
inline

This function returns trace control resource software object of the module.

Returns
trace control software object pointer

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.

◆ traceEvent() [1/2]

std::shared_ptr< XAieTraceEvent > xaiefal::XAieMod::traceEvent ( )
inline

◆ traceEvent() [2/2]

std::shared_ptr< XAieTraceEvent > xaiefal::XAieMod::traceEvent ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns trace event resource software object of the module.

Parameters
RGroupresource group
Returns
trace event software object pointer

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.

◆ userEvent() [1/2]

std::shared_ptr< XAieUserEvent > xaiefal::XAieMod::userEvent ( )
inline

◆ userEvent() [2/2]

std::shared_ptr< XAieUserEvent > xaiefal::XAieMod::userEvent ( XAieDevHdRscGroupWrapper & RGroup)
inline

This function returns user event handle object shared pointer

Parameters
RGroupresource group
Returns
user event handle software object pointer

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.

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