DSPLIB User Guide
Data Structures | Functions
DSPLIB_matMul

Introduction

Kernel for multiplying two matrices.

Data Structures

struct  DSPLIB_matMul_InitArgs
 Structure containing the parameters to initialize the kernel. More...
 

Functions

int32_t DSPLIB_matMul_getHandleSize (DSPLIB_matMul_InitArgs *pKerInitArgs)
 This is a query function to calculate the size of internal handle. More...
 
DSPLIB_STATUS DSPLIB_matMul_init (DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsIn0, DSPLIB_bufParams2D_t *bufParamsIn1, DSPLIB_bufParams2D_t *bufParamsOut, const DSPLIB_matMul_InitArgs *pKerInitArgs)
 This function should be called before the DSPLIB_matMul_exec function is called. This function takes care of any one-time operations such as setting up the configuration of required hardware resources such as the streaming engine. The results of these operations are stored in the handle. More...
 
DSPLIB_STATUS DSPLIB_matMul_init_checkParams (DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsIn0, const DSPLIB_bufParams2D_t *bufParamsIn1, const DSPLIB_bufParams2D_t *bufParamsOut, const DSPLIB_matMul_InitArgs *pKerInitArgs)
 This function checks the validity of the parameters passed to DSPLIB_matMul_init function. This function is called with the same parameters as the DSPLIB_matMul_init, and this function must be called before the DSPLIB_matMul_init is called. More...
 
DSPLIB_STATUS DSPLIB_matMul_exec_checkParams (DSPLIB_kernelHandle handle, const void *restrict pIn0, const void *restrict pIn1, const void *restrict pOut)
 This function checks the validity of the parameters passed to DSPLIB_matMul_exec function. This function is called with the same parameters as the DSPLIB_matMul_init, and this function must be called before the DSPLIB_matMul_init is called. More...
 
DSPLIB_STATUS DSPLIB_matMul_exec (DSPLIB_kernelHandle handle, void *restrict pIn0, void *restrict pIn1, void *restrict pOut)
 This function is the main kernel compute function. More...
 

Function Documentation

◆ DSPLIB_matMul_getHandleSize()

int32_t DSPLIB_matMul_getHandleSize ( DSPLIB_matMul_InitArgs *  pKerInitArgs)

This is a query function to calculate the size of internal handle.

Parameters
[in]pKerInitArgs: Pointer to structure holding init parameters
Returns
Size of the buffer in bytes
Remarks
Application is expected to allocate buffer of the requested size and provide it as input to other functions requiring it.

Definition at line 26 of file DSPLIB_matMul.cpp.

◆ DSPLIB_matMul_init()

DSPLIB_STATUS DSPLIB_matMul_init ( DSPLIB_kernelHandle  handle,
DSPLIB_bufParams2D_t *  bufParamsIn0,
DSPLIB_bufParams2D_t *  bufParamsIn1,
DSPLIB_bufParams2D_t *  bufParamsOut,
const DSPLIB_matMul_InitArgs *  pKerInitArgs 
)

This function should be called before the DSPLIB_matMul_exec function is called. This function takes care of any one-time operations such as setting up the configuration of required hardware resources such as the streaming engine. The results of these operations are stored in the handle.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsIn0: Pointer to the structure containing dimensional information of input matrix A
[in]bufParamsIn1: Pointer to the structure containing dimensional information of input matrix B
[out]bufParamsOut: Pointer to the structure containing dimensional information of output matrix C
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Remarks
Application is expected to provide a valid handle.

Definition at line 96 of file DSPLIB_matMul.cpp.

◆ DSPLIB_matMul_init_checkParams()

DSPLIB_STATUS DSPLIB_matMul_init_checkParams ( DSPLIB_kernelHandle  handle,
const DSPLIB_bufParams2D_t *  bufParamsIn0,
const DSPLIB_bufParams2D_t *  bufParamsIn1,
const DSPLIB_bufParams2D_t *  bufParamsOut,
const DSPLIB_matMul_InitArgs *  pKerInitArgs 
)

This function checks the validity of the parameters passed to DSPLIB_matMul_init function. This function is called with the same parameters as the DSPLIB_matMul_init, and this function must be called before the DSPLIB_matMul_init is called.

Parameters
[in]handle: Active handle to the kernel
[in]bufParamsIn0: Pointer to the structure containing dimensional information of input matrix A
[in]bufParamsIn1: Pointer to the structure containing dimensional information of input matrix B
[out]bufParamsOut: Pointer to the structure containing dimensional information of output matrix C
[in]pKerInitArgs: Pointer to the structure holding init parameters
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Remarks
None

Definition at line 33 of file DSPLIB_matMul.cpp.

◆ DSPLIB_matMul_exec_checkParams()

DSPLIB_STATUS DSPLIB_matMul_exec_checkParams ( DSPLIB_kernelHandle  handle,
const void *restrict  pIn0,
const void *restrict  pIn1,
const void *restrict  pOut 
)

This function checks the validity of the parameters passed to DSPLIB_matMul_exec function. This function is called with the same parameters as the DSPLIB_matMul_init, and this function must be called before the DSPLIB_matMul_init is called.

Parameters
[in]handle: Active handle to the kernel
[in]pIn0: Pointer to the structure input matrix A
[in]pIn1: Pointer to the structure input matrix B
[out]pout: Pointer to the output matrix C
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Remarks
None

Definition at line 76 of file DSPLIB_matMul.cpp.

◆ DSPLIB_matMul_exec()

DSPLIB_STATUS DSPLIB_matMul_exec ( DSPLIB_kernelHandle  handle,
void *restrict  pIn0,
void *restrict  pIn1,
void *restrict  pOut 
)

This function is the main kernel compute function.

Please refer to details under DSPLIB_matMul_exec

Parameters
[in]handle: Active handle to the kernel
[in]pIn0: Pointer to buffer holding the input matrix A
[in]pIn1: Pointer to buffer holding the input matrix B
[out]pOut: Pointer to buffer holding the output matrix C
Returns
Status value indicating success or failure. Refer to DSPLIB_STATUS.
Assumptions:
  • None
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
Remarks
Before calling this function, application is expected to call DSPLIB_matMul_init and This ensures resource configuration and error checks are done only once for several invocations of this function.

Definition at line 166 of file DSPLIB_matMul.cpp.