DSPLIB User Guide
DSPLIB_minEvery_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_minEvery_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_minEvery
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_MINEVERY_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_MINEVERY_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_minEvery.h"
26 
32 /*******************************************************************************
33  *
34  * DEFINES
35  *
36  ******************************************************************************/
37 #define SE_PARAM_BASE (0x0000)
38 #define SE_SE0_PARAM_OFFSET (SE_PARAM_BASE)
39 #define SE_SA0_PARAM_OFFSET (SE_SE0_PARAM_OFFSET + SE_PARAM_SIZE)
45 #define DSPLIB_MINEVERY_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
46 
52 typedef DSPLIB_STATUS (*pFxnDSPLIB_minEvery_exec)(DSPLIB_kernelHandle handle,
53  void *restrict pIn1,
54  void *restrict pIn2,
55  void *restrict pOut);
56 
87 template <typename dataType>
88 extern DSPLIB_STATUS DSPLIB_minEvery_init_ci(DSPLIB_kernelHandle handle,
89  const DSPLIB_bufParams1D_t *bufParamsIn,
90  const DSPLIB_bufParams1D_t *bufParamsOut,
91  const DSPLIB_minEvery_InitArgs *pKerInitArgs);
92 
117 template <typename dataType, int32_t dataIn>
118 extern DSPLIB_STATUS
119 DSPLIB_minEvery_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut);
120 
137 template <typename dataType, int32_t dataIn>
138 extern DSPLIB_STATUS
139 DSPLIB_minEvery_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut);
140 
144 typedef struct {
148  pFxnDSPLIB_minEvery_exec execute;
152  int32_t blockSize;
153  uint8_t bufPblock[DSPLIB_MINEVERY_IXX_IXX_OXX_PBLOCK_SIZE];
154 } DSPLIB_minEvery_PrivArgs;
155 
173 DSPLIB_STATUS
174 DSPLIB_minEvery_init_cn(DSPLIB_kernelHandle handle,
175  DSPLIB_bufParams2D_t *bufParamsIn,
176  DSPLIB_bufParams2D_t *bufParamsOut);
177 
178 #endif /* DSPLIB_MINEVERY_IXX_IXX_OXX_PRIV_H_ */
179 
180 /* ======================================================================== */
181 /* End of file: DSPLIB_minEvery.h */
182 /* ======================================================================== */
DSPLIB_minEvery.h
DSPLIB_minEvery_init_ci
DSPLIB_STATUS DSPLIB_minEvery_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_minEvery_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_minEvery_ci.cpp:52
pFxnDSPLIB_minEvery_exec
DSPLIB_STATUS(* pFxnDSPLIB_minEvery_exec)(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_minEvery_exec_ci and DSPLI...
Definition: DSPLIB_minEvery_priv.h:52
DSPLIB_minEvery_init_cn
DSPLIB_STATUS DSPLIB_minEvery_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_minEvery_exec_cn
DSPLIB_STATUS DSPLIB_minEvery_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
This function is the main execution function for the natural C implementation of the kernel....
Definition: DSPLIB_minEvery_cn.cpp:33
DSPLIB_minEvery_exec_ci
DSPLIB_STATUS DSPLIB_minEvery_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut)
This function is the main execution function for the C7x implementation of the kernel....
Definition: DSPLIB_minEvery_ci.cpp:148
DSPLIB_MINEVERY_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_MINEVERY_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_minEvery_PrivArgs structure.
Definition: DSPLIB_minEvery_priv.h:45
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_minEvery_InitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_minEvery.h:105
DSPLIB_minEvery_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_minEvery_priv.h:144
DSPLIB_minEvery_PrivArgs::blockSize
int32_t blockSize
Size of input buffer for different batches DSPLIB_minEvery_init that will be retrieved and used by DS...
Definition: DSPLIB_minEvery_priv.h:152
DSPLIB_minEvery_PrivArgs::execute
pFxnDSPLIB_minEvery_exec execute
Function pointer to point to the right execution variant between DSPLIB_minEvery_exec_cn and DSPLIB_m...
Definition: DSPLIB_minEvery_priv.h:148