class for stream port select resource There are limited numter of ports events, in order to generate events for stream port status, applicaiton needs to reserve a stream port select resource first. More...

#include <xaiefal-ss.hpp>

Inheritance diagram for xaiefal::XAieStreamPortSelect:

Public Member Functions
	XAieStreamPortSelect ()=delete
	XAieStreamPortSelect (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc)
	XAieStreamPortSelect (XAieDev &Dev, XAie_LocType Loc)
AieRC	setPortToSelect (XAie_StrmPortIntf PIntf, StrmSwPortType PType, uint32_t PNum)
AieRC	getSSIdleEvent (XAie_Events &Event) const
AieRC	getSSRunningEvent (XAie_Events &Event) const
AieRC	getSSStalledEvent (XAie_Events &Event) const
AieRC	getSSTlastEvent (XAie_Events &Event) const
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 ()

Additional Inherited Members
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

class for stream port select resource There are limited numter of ports events, in order to generate events for stream port status, applicaiton needs to reserve a stream port select resource first.

Constructor & Destructor Documentation

◆ XAieStreamPortSelect() [1/3]

xaiefal::XAieStreamPortSelect::XAieStreamPortSelect ( )

delete

◆ XAieStreamPortSelect() [2/3]

xaiefal::XAieStreamPortSelect::XAieStreamPortSelect	(	std::shared_ptr< XAieDevHandle >	DevHd,
		XAie_LocType	Loc )

inline

◆ XAieStreamPortSelect() [3/3]

xaiefal::XAieStreamPortSelect::XAieStreamPortSelect	(	XAieDev &	Dev,
		XAie_LocType	Loc )

inline

Member Function Documentation

◆ _release()

AieRC xaiefal::XAieStreamPortSelect::_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::XAieStreamPortSelect::_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::XAieStreamPortSelect::_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::XAieStreamPortSelect::_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.

◆ getSSIdleEvent()

AieRC xaiefal::XAieStreamPortSelect::getSSIdleEvent ( XAie_Events & Event ) const

inline

This function returns stream port idle event.

Parameters

Event store the selected stream port idle event

Returns: XAIE_OK for success, error code for failure.

◆ getSSRunningEvent()

AieRC xaiefal::XAieStreamPortSelect::getSSRunningEvent ( XAie_Events & Event ) const

inline

This function returns stream port running event.

Parameters

Event store the selected stream port running event

Returns: XAIE_OK for success, error code for failure.

◆ getSSStalledEvent()

AieRC xaiefal::XAieStreamPortSelect::getSSStalledEvent ( XAie_Events & Event ) const

inline

This function returns stream port stalled event.

Parameters

Event store the selected stream port stalled event

Returns: XAIE_OK for success, error code for failure.

◆ getSSTlastEvent()

AieRC xaiefal::XAieStreamPortSelect::getSSTlastEvent ( XAie_Events & Event ) const

inline

This function returns stream port tlast event.

Parameters

Event store the selected stream port tlast event

Returns: XAIE_OK for success, error code for failure.

◆ setPortToSelect()

AieRC xaiefal::XAieStreamPortSelect::setPortToSelect	(	XAie_StrmPortIntf	PIntf,
		StrmSwPortType	PType,
		uint32_t	PNum )

inline

This function sets which port to select. It needs to be called before start() which configures the hardware.

Parameters

PIntf	port interface
PType	port type
PNum	port number

Returns: XAIE_OK for success, error code for failure.

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

src/rsc/xaiefal-ss.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XAieStreamPortSelect() [1/3]

◆ XAieStreamPortSelect() [2/3]

◆ XAieStreamPortSelect() [3/3]

Member Function Documentation

◆ _release()

◆ _reserve()

◆ _start()

◆ _stop()

◆ getSSIdleEvent()

◆ getSSRunningEvent()

◆ getSSStalledEvent()

◆ getSSTlastEvent()

◆ setPortToSelect()