TISP User Guide
TISP::SuperNode::superNode Class Referenceabstract

Detailed Description

Provides the base class for supernode. Contains member functions to create dma context and allocate memory required to store DRU-related parameters.

Definition at line 65 of file TISP_superNode.hpp.

Inherited by TISP::SuperNode::i2d_to_o2d< dTypeIn, dTypeOut >, and TISP::SuperNode::i2d_to_o2dTranspose< dTypeIn, dTypeOut >.

Public Member Functions

virtual void exec ()=0
 This function is implemented by classes derived from TISP::superNode. More...
 
void execDefault (std::unique_ptr< opVec > &myOpVec)
 This function executes a given supernode. It contains the boiler plate template for block-based DMA and compute flow. The function calls the execute::graph function which in turn executes the correct compute flow. For data movement, appropriate APIs are called around the execute::graph function. Typical execute case of most superNodes variants (derived classes) More...
 
virtual ~superNode ()
 

Static Public Member Functions

static Udma_DrvHandle setUdmaDrvHandle (Udma_DrvObjectInt &udmaDrvObj)
 

Protected Member Functions

 superNode (size_t _numChannels, size_t _numInChannels, size_t _numOutChannels)
 Supernode constructor that is called to create the supernode with appropriate parameters. Typically, used by classes derived from the superNode as part of their constructor c. More...
 

Protected Attributes

int32_t chIdIn [TISP_MAX_DMA_CHANNEL_SUPER_NODE]
 
int32_t chIdOut [TISP_MAX_DMA_CHANNEL_SUPER_NODE]
 
uint8_t * dmaUtilsContext
 
uint8_t * pTrMemCh [TISP_MAX_DMA_CHANNEL_SUPER_NODE]
 

Private Attributes

size_t numChannels
 
size_t numInChannels
 
size_t numOutChannels
 

Constructor & Destructor Documentation

◆ superNode()

superNode::superNode ( size_t  _numChannels,
size_t  _numInChannels,
size_t  _numOutChannels 
)
protected

Supernode constructor that is called to create the supernode with appropriate parameters. Typically, used by classes derived from the superNode as part of their constructor c.

Parameters
[in]&_myOpVec: Operator vector with list of nodes to be executed inside the supernode
[in]_numChannels: Total number of DMA channels to be used by the supernode
[in]_numInChannels: Total number of input DMA channels
[in]_numOutChannels: Total number of output DMA channels
Returns
None

Definition at line 43 of file TISP_superNode.cpp.

◆ ~superNode()

virtual TISP::SuperNode::superNode::~superNode ( )
inlinevirtual

Definition at line 106 of file TISP_superNode.hpp.

Member Function Documentation

◆ exec()

virtual void TISP::SuperNode::superNode::exec ( )
pure virtual

This function is implemented by classes derived from TISP::superNode.

Implemented in TISP::SuperNode::i2d_to_o2dTranspose< dTypeIn, dTypeOut >, and TISP::SuperNode::i2d_to_o2d< dTypeIn, dTypeOut >.

◆ execDefault()

void superNode::execDefault ( std::unique_ptr< opVec > &  myOpVec)

This function executes a given supernode. It contains the boiler plate template for block-based DMA and compute flow. The function calls the execute::graph function which in turn executes the correct compute flow. For data movement, appropriate APIs are called around the execute::graph function. Typical execute case of most superNodes variants (derived classes)

Returns
None.

Definition at line 63 of file TISP_superNode.cpp.

◆ setUdmaDrvHandle()

Udma_DrvHandle superNode::setUdmaDrvHandle ( Udma_DrvObjectInt &  udmaDrvObj)
static

Definition at line 12 of file TISP_superNode.cpp.

Field Documentation

◆ numChannels

size_t TISP::SuperNode::superNode::numChannels
private

Definition at line 68 of file TISP_superNode.hpp.

◆ numInChannels

size_t TISP::SuperNode::superNode::numInChannels
private

Definition at line 69 of file TISP_superNode.hpp.

◆ numOutChannels

size_t TISP::SuperNode::superNode::numOutChannels
private

Definition at line 70 of file TISP_superNode.hpp.

◆ chIdIn

int32_t TISP::SuperNode::superNode::chIdIn[TISP_MAX_DMA_CHANNEL_SUPER_NODE]
protected

Definition at line 73 of file TISP_superNode.hpp.

◆ chIdOut

int32_t TISP::SuperNode::superNode::chIdOut[TISP_MAX_DMA_CHANNEL_SUPER_NODE]
protected

Definition at line 74 of file TISP_superNode.hpp.

◆ dmaUtilsContext

uint8_t* TISP::SuperNode::superNode::dmaUtilsContext
protected

Definition at line 75 of file TISP_superNode.hpp.

◆ pTrMemCh

uint8_t* TISP::SuperNode::superNode::pTrMemCh[TISP_MAX_DMA_CHANNEL_SUPER_NODE]
protected

Definition at line 76 of file TISP_superNode.hpp.