xaiefal::XAieBroadcast Class Reference

class for broadcast channel resource. A broadcast channel resource represents a broadcast channel between specified tiles. More...

#include <xaiefal-bc.hpp>

Inheritance diagram for xaiefal::XAieBroadcast:

Public Member Functions
	XAieBroadcast ()=delete
	XAieBroadcast (std::shared_ptr< XAieDevHandle > DevHd, const std::vector< XAie_LocType > &vInLocs, XAie_ModuleType StartM, XAie_ModuleType EndM)
	XAieBroadcast (XAieDev &Dev, const std::vector< XAie_LocType > &vInLocs, XAie_ModuleType StartM, XAie_ModuleType EndM)
	~XAieBroadcast ()
int	getBc ()
AieRC	getEvent (XAie_LocType Loc, XAie_ModuleType Mod, XAie_Events &Event)
AieRC	getChannel (std::vector< XAie_LocType > &vL, XAie_ModuleType &StartM, XAie_ModuleType &EndM)
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 ()

Additional Inherited Members
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 broadcast channel resource. A broadcast channel resource represents a broadcast channel between specified tiles.

There are three different ways tiles can be broadcasted:

• Broadcast within a tile if a single tile is specified.
• Broadcast to the whole partition if no tiles are specified.
• Broadcast to the tiles on the contiguous path of tiles specified by user.

Constructor & Destructor Documentation

XAieBroadcast() [1/3]

xaiefal::XAieBroadcast::XAieBroadcast ( )

delete

XAieBroadcast() [2/3]

xaiefal::XAieBroadcast::XAieBroadcast ( std::shared_ptr< XAieDevHandle > DevHd, const std::vector< XAie_LocType > & vInLocs, XAie_ModuleType StartM, XAie_ModuleType EndM )

inline

XAieBroadcast() [3/3]

xaiefal::XAieBroadcast::XAieBroadcast ( XAieDev & Dev, const std::vector< XAie_LocType > & vInLocs, XAie_ModuleType StartM, XAie_ModuleType EndM )

inline

~XAieBroadcast()

xaiefal::XAieBroadcast::~XAieBroadcast ( )

inline

Member Function Documentation

getBc()

int xaiefal::XAieBroadcast::getBc ( )

inline

This function returns the broadcast channel ID

Returns

broadcast channel ID if resource has been reserved, -1 otherwise.

getChannel()

AieRC xaiefal::XAieBroadcast::getChannel ( std::vector< XAie_LocType > & vL, XAie_ModuleType & StartM, XAie_ModuleType & EndM )

inline

This function returns broadcast channel information

Parameters

vL	returns vector of tiles of the channel
StartM	returns start module
EndM	returns end module

Returns

XAIE_OK

getEvent()

AieRC xaiefal::XAieBroadcast::getEvent ( XAie_LocType Loc, XAie_ModuleType Mod, XAie_Events & Event )

inline

This function gets the broadcast event of the specified tile module on the broadcast channel.

Parameters

Loc	tile location
Mod	module type
Event	for returning broadcast event

Returns

XAIE_OK for success, error code for failure

getRscStat()

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

inlinevirtual

This function returns resources static for a specific group of this type of resource.

Parameters

GName

resource group name

Returns

resource group resource statistics of this type of resource of specific tiles/module

Reimplemented from xaiefal::XAieRsc.

---

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

• src/rsc/xaiefal-bc.hpp