DSPLIB User Guide
DSPLIB_sqrAdd_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_sqrAdd_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_sqrAdd
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_SQRADD_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_SQRADD_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_sqrAdd.h"
26 
33 /*******************************************************************************
34  *
35  * DEFINES
36  *
37  ******************************************************************************/
38 #define SE_PARAM_BASE (0x0000)
39 #define SE_SE0_PARAM_OFFSET (SE_PARAM_BASE)
40 #define SE_SE1_PARAM_OFFSET (SE_SE0_PARAM_OFFSET + SE_PARAM_SIZE)
41 #define SE_SA0_PARAM_OFFSET (SE_SE1_PARAM_OFFSET + SE_PARAM_SIZE)
47 #define DSPLIB_SQRADD_IXX_IXX_OXX_PBLOCK_SIZE (3 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
53 typedef DSPLIB_STATUS (*pFxnDSPLIB_sqrAdd_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
54 
83 template <typename dataType>
85  const DSPLIB_bufParams1D_t *bufParamsIn,
86  const DSPLIB_bufParams1D_t *bufParamsOut,
87  const DSPLIB_sqrAdd_InitArgs *pKerInitArgs);
88 
114 template <typename dataType>
115 extern DSPLIB_STATUS DSPLIB_sqrAdd_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
116 
141 template <typename dataType>
142 extern DSPLIB_STATUS DSPLIB_sqrAddInt_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
143 
163 template <typename dataType>
164 extern DSPLIB_STATUS DSPLIB_sqrAdd_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
165 
169 typedef struct {
177  int32_t blockSize;
178 
181 
202  DSPLIB_bufParams2D_t *bufParamsIn,
203  DSPLIB_bufParams2D_t *bufParamsOut);
204 
205 #endif /* DSPLIB_SQRADD_IXX_IXX_OXX_PRIV_H_ */
206 
207 /* ======================================================================== */
208 /* End of file: DSPLIB_sqrAdd.h */
209 /* ======================================================================== */
#define DSPLIB_SQRADD_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_sqrAdd_PrivArgs structure.
DSPLIB_STATUS DSPLIB_sqrAdd_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....
DSPLIB_STATUS DSPLIB_sqrAdd_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_sqrAdd_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
DSPLIB_STATUS DSPLIB_sqrAdd_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....
DSPLIB_STATUS DSPLIB_sqrAdd_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....
DSPLIB_STATUS(* pFxnDSPLIB_sqrAdd_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_sqrAdd_exec_ci and DSPLIB_...
DSPLIB_STATUS DSPLIB_sqrAddInt_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....
DSPLIB_STATUS_NAME DSPLIB_STATUS
Return value for DSPLIB functions.
Definition: DSPLIB_types.h:170
DSPLIB_STATUS_NAME
The enumeration of all status codes.
Definition: DSPLIB_types.h:151
void * DSPLIB_kernelHandle
Handle type for DSPLIB operations.
Definition: DSPLIB_types.h:172
A structure for a 1 dimensional buffer descriptor.
A structure for a 2 dimensional buffer descriptor.
Structure containing the parameters to initialize the kernel.
Structure that is reserved for internal use by the kernel.
pFxnDSPLIB_sqrAdd_exec execute
Function pointer to point to the right execution variant between DSPLIB_sqrAdd_exec_cn and DSPLIB_sqr...
int32_t blockSize
Size of input buffer for different batches DSPLIB_sqrAdd_init that will be retrieved and used by DSPL...