DSPLIB User Guide
Macros | Functions
DSPLIB_max_ci.cpp File Reference

Go to the source code of this file.

Macros

#define UNROLL_FACTOR   4
 

Functions

template<typename dataType >
DSPLIB_STATUS DSPLIB_max_init_ci (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_max_init. More...
 
template DSPLIB_STATUS DSPLIB_max_init_ci< int16_t > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< uint16_t > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< int32_t > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< uint32_t > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< int8_t > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< uint8_t > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< float > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template DSPLIB_STATUS DSPLIB_max_init_ci< double > (DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_max_InitArgs *pKerInitArgs)
 
template<typename dataType , int32_t dataIn>
DSPLIB_STATUS DSPLIB_max_exec_ci (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_max_exec. More...
 
template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< int8_t, DSPLIB_INT8 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< uint8_t, DSPLIB_UINT8 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< int16_t, DSPLIB_INT16 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< uint16_t, DSPLIB_UINT16 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template DSPLIB_STATUS DSPLIB_max_exec_ci< int32_t, DSPLIB_INT32 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template DSPLIB_STATUS DSPLIB_max_exec_ci< uint32_t, DSPLIB_UINT32 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template DSPLIB_STATUS DSPLIB_max_exec_ci< float, DSPLIB_FLOAT32 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template DSPLIB_STATUS DSPLIB_max_exec_ci< double, DSPLIB_FLOAT64 > (DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
 
template<typename T , typename vec >
vec DSPLIB_max_loopLogic (size_t length, size_t width, T *pSrc)
 This function is the kernel loop helper function for the optimized implementation of the kernel. The function is called within DSPLIB_max_exec_c and this method performs the loops needed to calculate the vector containing all of the maximum values. More...
 

Macro Definition Documentation

◆ UNROLL_FACTOR

#define UNROLL_FACTOR   4

Definition at line 52 of file DSPLIB_max_ci.cpp.

Function Documentation

◆ DSPLIB_max_init_ci()

template<typename dataType >
DSPLIB_STATUS DSPLIB_max_init_ci ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_max_init.

This function determines the configuration for the streaming engine and MMA hardware resources based on the function call parameters, and the configuration is saved in bufPBlock array. In the kernel call sequence, DSPLIB_max_exec_ci would be called later independently by the application. When DSPLIB_max_exec_ci runs, it merely retrieves the configuration from the bufPBlock and uses it to set up the hardware resources. This arrangement is so that DSPLIB_max_exec_ci does not lose cycles to determine the hardware configuration.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsIn: Pointer to the structure containing dimensional information of input buffer
[out]bufParamsOut: Pointer to the structure containing dimensional information of ouput buffer
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 55 of file DSPLIB_max_ci.cpp.

◆ DSPLIB_max_init_ci< int16_t >()

template DSPLIB_STATUS DSPLIB_max_init_ci< int16_t > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< uint16_t >()

template DSPLIB_STATUS DSPLIB_max_init_ci< uint16_t > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< int32_t >()

template DSPLIB_STATUS DSPLIB_max_init_ci< int32_t > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< uint32_t >()

template DSPLIB_STATUS DSPLIB_max_init_ci< uint32_t > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< int8_t >()

template DSPLIB_STATUS DSPLIB_max_init_ci< int8_t > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< uint8_t >()

template DSPLIB_STATUS DSPLIB_max_init_ci< uint8_t > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< float >()

template DSPLIB_STATUS DSPLIB_max_init_ci< float > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_init_ci< double >()

template DSPLIB_STATUS DSPLIB_max_init_ci< double > ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams1D_t *  bufParamsIn,
const DSPLIB_bufParams1D_t *  bufParamsOut,
const DSPLIB_max_InitArgs *  pKerInitArgs 
)

◆ DSPLIB_max_exec_ci()

template<typename dataType , int32_t dataIn>
DSPLIB_STATUS DSPLIB_max_exec_ci ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_max_exec.

The function uses MMA hardware accelerator to perform the convolution computation. Filter data is loaded into B panel of the MMA from memory using one streaming engine, while the input data is loaded into A vectors of the MMA using the other streaming engine. Result of the compute from MMA C panel is stored into memory using a stream minress generator.

Parameters
[in]handle: Active handle to the kernel
[in]pIn: Pointer to buffer holding the input data
[out]pOut: Pointer to buffer holding the output data
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Performance Considerations:
For best performance,
  • the input and output data buffers are expected to be in L2 memory
  • the buffer pointers are assumed to be 64-byte aligned

Definition at line 218 of file DSPLIB_max_ci.cpp.

◆ DSPLIB_max_exec_ci< int8_t, DSPLIB_INT8 >()

template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< int8_t, DSPLIB_INT8 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

Definition at line 290 of file DSPLIB_max_ci.cpp.

◆ DSPLIB_max_exec_ci< uint8_t, DSPLIB_UINT8 >()

template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< uint8_t, DSPLIB_UINT8 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

Definition at line 345 of file DSPLIB_max_ci.cpp.

◆ DSPLIB_max_exec_ci< int16_t, DSPLIB_INT16 >()

template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< int16_t, DSPLIB_INT16 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

Definition at line 395 of file DSPLIB_max_ci.cpp.

◆ DSPLIB_max_exec_ci< uint16_t, DSPLIB_UINT16 >()

template<>
DSPLIB_STATUS DSPLIB_max_exec_ci< uint16_t, DSPLIB_UINT16 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

Definition at line 445 of file DSPLIB_max_ci.cpp.

◆ DSPLIB_max_exec_ci< int32_t, DSPLIB_INT32 >()

template DSPLIB_STATUS DSPLIB_max_exec_ci< int32_t, DSPLIB_INT32 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

◆ DSPLIB_max_exec_ci< uint32_t, DSPLIB_UINT32 >()

template DSPLIB_STATUS DSPLIB_max_exec_ci< uint32_t, DSPLIB_UINT32 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

◆ DSPLIB_max_exec_ci< float, DSPLIB_FLOAT32 >()

template DSPLIB_STATUS DSPLIB_max_exec_ci< float, DSPLIB_FLOAT32 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

◆ DSPLIB_max_exec_ci< double, DSPLIB_FLOAT64 >()

template DSPLIB_STATUS DSPLIB_max_exec_ci< double, DSPLIB_FLOAT64 > ( DSPLIB_kernelHandle  handle,
void *restrict  pIn,
void *restrict  pOut 
)

◆ DSPLIB_max_loopLogic()

template<typename T , typename vec >
vec DSPLIB_max_loopLogic ( size_t  length,
size_t  width,
T *  pSrc 
)

This function is the kernel loop helper function for the optimized implementation of the kernel. The function is called within DSPLIB_max_exec_c and this method performs the loops needed to calculate the vector containing all of the maximum values.

Parameters
[in]length: length of the input buffer
[in]width: width of one SIMD buffer
[out]pSrc: Pointer to buffer holding the input buffer
Returns
Vector containing all maximum values.

Definition at line 505 of file DSPLIB_max_ci.cpp.