Trace event resource class. Each event to trace is presented as a trace event resource class. More...

#include <xaiefal-trace.hpp>

Inheritance diagram for xaiefal::XAieTraceEvent:

Public Member Functions
	XAieTraceEvent ()=delete
	XAieTraceEvent (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod, std::shared_ptr< XAieTraceCntr > TCntr)
	XAieTraceEvent (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod)
	~XAieTraceEvent ()
AieRC	setEvent (XAie_ModuleType Module, XAie_Events TraceEvent)
AieRC	getEvent (XAie_ModuleType &Module, XAie_Events &TraceEvent) const
int	getBc ()
Public Member Functions inherited from xaiefal::XAieSingleTileRsc
	XAieSingleTileRsc ()=delete
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod)
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType Type)
	XAieSingleTileRsc (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod)
	XAieSingleTileRsc (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType Type)
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc)
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAieRscType Type)
	XAieSingleTileRsc (XAieDev &Dev, XAie_LocType Loc, XAieRscType Type)
virtual	~XAieSingleTileRsc ()
XAie_LocType	loc () const
XAie_ModuleType	mod () const
AieRC	getRscId (XAie_LocType &OutLoc, XAie_ModuleType &OutMod, uint32_t &OutRscId)
virtual XAieRscStat	getRscStat (const std::string &GName) const
Public Member Functions inherited from xaiefal::XAieRsc
	XAieRsc ()=delete
	XAieRsc (std::shared_ptr< XAieDevHandle > DevHd)
	XAieRsc (std::shared_ptr< XAieDevHandle > DevHd, XAieRscType Type)
	XAieRsc (XAieDev &Dev)
virtual	~XAieRsc ()
AieRC	setPreferredId (uint32_t id, bool isStaticAllocated=false)
uint32_t	getPreferredId ()
AieRC	reserve ()
AieRC	release ()
AieRC	free ()
AieRC	start ()
AieRC	stop ()
bool	isInitialized () const
bool	isReserved () const
bool	isConfigured () const
bool	isRunning () const
void	getReservedRscs (std::vector< XAieUserRsc > &vOutRscs) const
AieRC	getRscs (std::vector< XAieUserRsc > &vOutRscs)
AieRC	setRscs (std::vector< XAieUserRsc > &vInRscs)
virtual XAieRscType	getRscType () const
XAie_DevInst *	dev ()
virtual uint32_t	getAvailManagedRscs ()
virtual XAieRscType	getManagedRscsType ()

Protected Member Functions
AieRC	_reserve ()
AieRC	_release ()
AieRC	_start ()
AieRC	_stop ()
void	_getReservedRscs (std::vector< XAieUserRsc > &vOutRscs) const

Protected Attributes
std::shared_ptr< XAieTraceCntr >	TraceCntr
XAie_Events	Event
XAie_ModuleType	EventMod
std::shared_ptr< XAieBroadcast >	BC
uint8_t	Slot
Protected Attributes inherited from xaiefal::XAieSingleTileRsc
XAie_LocType	Loc
XAie_ModuleType	Mod
Protected Attributes inherited from xaiefal::XAieRsc
XAieRscState	State
XAieRscType	Type
std::shared_ptr< XAieDevHandle >	AieHd
uint32_t	preferredId
uint32_t	reservedId
std::vector< XAieUserRsc >	vRscs

Detailed Description

Trace event resource class. Each event to trace is presented as a trace event resource class.

Constructor & Destructor Documentation

◆ XAieTraceEvent() [1/3]

xaiefal::XAieTraceEvent::XAieTraceEvent ( )

delete

◆ XAieTraceEvent() [2/3]

xaiefal::XAieTraceEvent::XAieTraceEvent	(	std::shared_ptr< XAieDevHandle >	DevHd,
		XAie_LocType	Loc,
		XAie_ModuleType	Mod,
		std::shared_ptr< XAieTraceCntr >	TCntr )

inline

◆ XAieTraceEvent() [3/3]

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

inline

◆ ~XAieTraceEvent()

xaiefal::XAieTraceEvent::~XAieTraceEvent ( )

inline

Member Function Documentation

◆ _getReservedRscs()

void xaiefal::XAieTraceEvent::_getReservedRscs ( std::vector< XAieUserRsc > & vOutRscs ) const

inlineprotectedvirtual

This function returns resources reserved.

Parameters

vOutRscs vector to store the reserved resources

Reimplemented from xaiefal::XAieSingleTileRsc.

◆ _release()

AieRC xaiefal::XAieTraceEvent::_release ( )

inlineprotectedvirtual

This function will be called by release(). It allows child class to implement its own resource release.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ _reserve()

AieRC xaiefal::XAieTraceEvent::_reserve ( )

inlineprotectedvirtual

This function will be called by reserve(). It allows child class to implement its own resource reservation.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ _start()

AieRC xaiefal::XAieTraceEvent::_start ( )

inlineprotectedvirtual

This function will be called by start(). It allows child class to implement its own resource start.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ _stop()

AieRC xaiefal::XAieTraceEvent::_stop ( )

inlineprotectedvirtual

This function will be called by stop(). It allows child class to implement its own resource stop.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ getBc()

int xaiefal::XAieTraceEvent::getBc ( )

inline

This function returns the trace event broadcast event if trace event needs broadcasting.

Returns: broadcast channel if trace event is reserved, and broadcast is required, error code for failure.

◆ getEvent()

AieRC xaiefal::XAieTraceEvent::getEvent	(	XAie_ModuleType &	Module,
		XAie_Events &	TraceEvent ) const

inline

This function returns the event to trace and its module. If the event is not set, it will return failure.

Parameters

Module	returns the module of the event
TraceEvent	returns the event to trace

Returns: XAIE_OK for success, error code for failure.

◆ setEvent()

AieRC xaiefal::XAieTraceEvent::setEvent	(	XAie_ModuleType	Module,
		XAie_Events	TraceEvent )

inline

This function sets event to trace.

Parameters

Module	module of the event
Event	event to trace

Returns: XAIE_OK for success, error code for failure

Field Documentation

◆ BC

std::shared_ptr<XAieBroadcast> xaiefal::XAieTraceEvent::BC

protected

broadcast resource if need to broadcast event to tracer

◆ Event

XAie_Events xaiefal::XAieTraceEvent::Event

protected

event to trace

◆ EventMod

XAie_ModuleType xaiefal::XAieTraceEvent::EventMod

protected

event module type

◆ Slot

uint8_t xaiefal::XAieTraceEvent::Slot

protected

trace slot

◆ TraceCntr

std::shared_ptr<XAieTraceCntr> xaiefal::XAieTraceEvent::TraceCntr

protected

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

src/rsc/xaiefal-trace.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XAieTraceEvent() [1/3]

◆ XAieTraceEvent() [2/3]

◆ XAieTraceEvent() [3/3]

◆ ~XAieTraceEvent()

Member Function Documentation

◆ _getReservedRscs()

◆ _release()

◆ _reserve()

◆ _start()

◆ _stop()

◆ getBc()

◆ getEvent()

◆ setEvent()

Field Documentation

◆ BC

◆ Event

◆ EventMod

◆ Slot

◆ TraceCntr