DSPLIB User Guide
DSPLIB_mat_submat_copy_priv.h File Reference

Introduction

Header file for kernel's internal use. For the kernel's interface, please see DSPLIB_mat_submat_copy.

Definition in file DSPLIB_mat_submat_copy_priv.h.

Go to the source code of this file.

Data Structures

struct  DSPLIB_mat_submat_copy_PrivArgs
 Structure that is reserved for internal use by the kernel. More...
 

Macros

#define DSPLIB_MAT_SUBMAT_COPY_IXX_IXX_OXX_PBLOCK_SIZE   (4 * SE_PARAM_SIZE)
 Macro to define the size of bufPblock array of DSPLIB_mat_submat_copy_PrivArgs structure. More...
 

Typedefs

typedef DSPLIB_STATUS(* pFxnDSPLIB_mat_submat_copy_exec) (DSPLIB_kernelHandle handle, void *restrict pX, void *restrict pY)
 This is a function pointer type that conforms to the declaration of DSPLIB_mat_submat_copy_exec_ci and DSPLIB_mat_submat_copy_exec_cn. More...
 

Functions

template<typename dataType >
DSPLIB_STATUS DSPLIB_mat_submat_copy_init_ci (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsX, const DSPLIB_bufParams2D_t *bufParamsY, const DSPLIB_mat_submat_copyInitArgs *pKerInitArgs)
 This function is the initialization function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_mat_submat_copy_init. More...
 
template<typename dataType >
DSPLIB_STATUS DSPLIB_mat_submat_copy_exec_ci (DSPLIB_kernelHandle handle, void *restrict pX, void *restrict pY)
 This function is the main execution function for the C7x implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_mat_submat_copy_exec. More...
 
DSPLIB_STATUS DSPLIB_mat_submat_copy_init_cn (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsX, DSPLIB_bufParams2D_t *bufParamsY, const DSPLIB_mat_submat_copyInitArgs *pKerInitArgs)
 This function is the initialization function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_mat_submat_copy_init. More...
 
template<typename dataType >
DSPLIB_STATUS DSPLIB_mat_submat_copy_exec_cn (DSPLIB_kernelHandle handle, void *restrict pX, void *restrict pY)
 This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_mat_submat_copy_exec. More...
 

Macro Definition Documentation

◆ DSPLIB_MAT_SUBMAT_COPY_IXX_IXX_OXX_PBLOCK_SIZE

#define DSPLIB_MAT_SUBMAT_COPY_IXX_IXX_OXX_PBLOCK_SIZE   (4 * SE_PARAM_SIZE)

Macro to define the size of bufPblock array of DSPLIB_mat_submat_copy_PrivArgs structure.

Definition at line 38 of file DSPLIB_mat_submat_copy_priv.h.

Typedef Documentation

◆ pFxnDSPLIB_mat_submat_copy_exec

typedef DSPLIB_STATUS(* pFxnDSPLIB_mat_submat_copy_exec) (DSPLIB_kernelHandle handle, void *restrict pX, void *restrict pY)

This is a function pointer type that conforms to the declaration of DSPLIB_mat_submat_copy_exec_ci and DSPLIB_mat_submat_copy_exec_cn.

Definition at line 45 of file DSPLIB_mat_submat_copy_priv.h.

Function Documentation

◆ DSPLIB_mat_submat_copy_init_ci()

template<typename dataType >
DSPLIB_STATUS DSPLIB_mat_submat_copy_init_ci ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams2D_t bufParamsX,
const DSPLIB_bufParams2D_t bufParamsY,
const DSPLIB_mat_submat_copyInitArgs pKerInitArgs 
)

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

This function determines the configuration for the streaming engine resources based on the function call parameters, and the configuration is saved in bufPBlock array. In the kernel call sequence, DSPLIB_mat_submat_copy_exec_ci would be called later independently by the application. When DSPLIB_mat_submat_copy_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_mat_submat_copy_exec_ci does not lose cycles to determine the hardware configuration.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsX: Pointer to the structure containing dimensional information of input buffer
[out]bufParamsY: 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 45 of file DSPLIB_mat_submat_copy_ci.cpp.

◆ DSPLIB_mat_submat_copy_exec_ci()

template<typename dataType >
DSPLIB_STATUS DSPLIB_mat_submat_copy_exec_ci ( DSPLIB_kernelHandle  handle,
void *restrict  pX,
void *restrict  pY 
)

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

The function uses streaming engine to load data in TRANSPOSE MODE. The result is then stored at separate location using a streaming address generator.

Parameters
[in]handle: Active handle to the kernel
[in]pX: Pointer to buffer holding the X matrix
[out]pY: Pointer to buffer holding the Y matrix
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 180 of file DSPLIB_mat_submat_copy_ci.cpp.

◆ DSPLIB_mat_submat_copy_init_cn()

DSPLIB_STATUS DSPLIB_mat_submat_copy_init_cn ( DSPLIB_kernelHandle  handle,
DSPLIB_bufParams2D_t bufParamsX,
DSPLIB_bufParams2D_t bufParamsY,
const DSPLIB_mat_submat_copyInitArgs pKerInitArgs 
)

This function is the initialization function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_mat_submat_copy_init.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsX: Pointer to the structure containing dimensional information of input buffer
[out]bufParamsY: 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 43 of file DSPLIB_mat_submat_copy_cn.cpp.

◆ DSPLIB_mat_submat_copy_exec_cn()

template<typename dataType >
DSPLIB_STATUS DSPLIB_mat_submat_copy_exec_cn ( DSPLIB_kernelHandle  handle,
void *restrict  pX,
void *restrict  pY 
)

This function is the main execution function for the natural C implementation of the kernel. The function declaration conforms to the declaration of DSPLIB_mat_submat_copy_exec.

Parameters
[in]handle: Active handle to the kernel
[in]pX: Pointer to buffer holding the X matrix
[out]pY: Pointer to buffer holding the Y matrix
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.

Definition at line 58 of file DSPLIB_mat_submat_copy_cn.cpp.