DSPLIB User Guide
DSPLIB_sqr_priv.h
Go to the documentation of this file.
1 /******************************************************************************
2  * *
3  * module name :DSPLIB *
4  * *
5  * module descripton :Matrix Multiply Accelerator Library module for C7x+MMA *
6  * *
7  * Copyright (C) 2017-2018 Texas Instruments Incorporated - https://www.ti.com/ *
8  * ALL RIGHTS RESERVED *
9  * *
10  ******************************************************************************/
11 
12 /********************************************************************************
13  * @file DSPLIB_sqr_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_sqr
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_SQR_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_SQR_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_sqr.h"
26 
38 #define DSPLIB_SQR_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
39 
45 typedef DSPLIB_STATUS (*pFxnDSPLIB_sqr_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
46 
77 template <typename dataType>
78 extern DSPLIB_STATUS DSPLIB_sqr_init_ci(DSPLIB_kernelHandle handle,
79  const DSPLIB_bufParams1D_t *bufParamsIn,
80  const DSPLIB_bufParams1D_t *bufParamsOut,
81  const DSPLIB_sqr_InitArgs *pKerInitArgs);
82 
107 template <typename dataType, int32_t dataIn>
108 extern DSPLIB_STATUS DSPLIB_sqr_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
109 
126 template <typename dataType, int32_t dataIn>
127 extern DSPLIB_STATUS DSPLIB_sqr_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
128 
132 typedef struct {
136  pFxnDSPLIB_sqr_exec execute;
140  int32_t blockSize;
141  uint8_t bufPblock[DSPLIB_SQR_IXX_IXX_OXX_PBLOCK_SIZE];
142 } DSPLIB_sqr_PrivArgs;
143 
161 DSPLIB_STATUS
162 DSPLIB_sqr_init_cn(DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsIn, DSPLIB_bufParams2D_t *bufParamsOut);
163 
164 #endif /* DSPLIB_SQR_IXX_IXX_OXX_PRIV_H_ */
165 
166 /* ======================================================================== */
167 /* End of file: DSPLIB_sqr.h */
168 /* ======================================================================== */
DSPLIB_sqr.h
DSPLIB_sqr_init_ci
DSPLIB_STATUS DSPLIB_sqr_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_sqr_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_sqr_ci.cpp:61
DSPLIB_sqr_init_cn
DSPLIB_STATUS DSPLIB_sqr_init_cn(DSPLIB_kernelHandle handle, DSPLIB_bufParams2D_t *bufParamsIn, DSPLIB_bufParams2D_t *bufParamsOut)
This function is the initialization function for the natural C implementation of the kernel....
pFxnDSPLIB_sqr_exec
DSPLIB_STATUS(* pFxnDSPLIB_sqr_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_sqr_exec_ci and DSPLIB_sqr...
Definition: DSPLIB_sqr_priv.h:45
DSPLIB_SQR_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_SQR_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_sqr_PrivArgs structure.
Definition: DSPLIB_sqr_priv.h:38
DSPLIB_sqr_exec_cn
DSPLIB_STATUS DSPLIB_sqr_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
This function is the main execution function for the natural C implementation of the kernel....
Definition: DSPLIB_sqr_cn.cpp:32
DSPLIB_sqr_exec_ci
DSPLIB_STATUS DSPLIB_sqr_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....
Definition: DSPLIB_sqr_ci.cpp:156
DSPLIB_STATUS
DSPLIB_STATUS_NAME DSPLIB_STATUS
Return value for DSPLIB functions.
Definition: DSPLIB_types.h:170
DSPLIB_STATUS_NAME
DSPLIB_STATUS_NAME
The enumeration of all status codes.
Definition: DSPLIB_types.h:151
DSPLIB_kernelHandle
void * DSPLIB_kernelHandle
Handle type for DSPLIB operations.
Definition: DSPLIB_types.h:172
DSPLIB_bufParams1D_t
A structure for a 1 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:70
DSPLIB_bufParams2D_t
A structure for a 2 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:78
DSPLIB_sqr_InitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_sqr.h:105
DSPLIB_sqr_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_sqr_priv.h:132
DSPLIB_sqr_PrivArgs::execute
pFxnDSPLIB_sqr_exec execute
Function pointer to point to the right execution variant between DSPLIB_sqr_exec_cn and DSPLIB_sqr_ex...
Definition: DSPLIB_sqr_priv.h:136
DSPLIB_sqr_PrivArgs::blockSize
int32_t blockSize
Size of input buffer for different batches DSPLIB_sqr_init that will be retrieved and used by DSPLIB_...
Definition: DSPLIB_sqr_priv.h:140