DSPLIB User Guide
DSPLIB_min_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_min_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_min
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_MIN_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_MIN_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_min.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_SE1_PARAM_OFFSET (SE_SE0_PARAM_OFFSET + SE_PARAM_SIZE)
40 
46 #define DSPLIB_MIN_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
47 
53 typedef DSPLIB_STATUS (*pFxnDSPLIB_min_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
54 
81 template <typename dataType>
83  const DSPLIB_bufParams1D_t *bufParamsIn,
84  const DSPLIB_bufParams1D_t *bufParamsOut,
85  const DSPLIB_min_InitArgs *pKerInitArgs);
86 
111 template <typename dataType, int32_t dataIn>
112 extern DSPLIB_STATUS DSPLIB_min_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
113 
128 template <typename dataType, int32_t dataIn>
129 extern DSPLIB_STATUS DSPLIB_min_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
130 
134 typedef struct {
142  int32_t blockSize;
145 
161 template <typename T, typename vec> vec DSPLIB_min_loopLogic(size_t length, size_t width, T *pSrc);
162 
163 #endif /* DSPLIB_MIN_IXX_IXX_OXX_PRIV_H_ */
164 
165 /* ======================================================================== */
166 /* End of file: DSPLIB_min.h */
167 /* ======================================================================== */
DSPLIB_STATUS DSPLIB_min_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....
vec DSPLIB_min_loopLogic(size_t length, size_t width, T *pSrc)
This function is the kernel loop helper function for the optimized implementation of the kernel....
DSPLIB_STATUS DSPLIB_min_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_min_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
#define DSPLIB_MIN_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_min_PrivArgs structure.
DSPLIB_STATUS(* pFxnDSPLIB_min_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_min_exec_ci and DSPLIB_min...
DSPLIB_STATUS DSPLIB_min_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.
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_min.h:105
Structure that is reserved for internal use by the kernel.
int32_t blockSize
Size of input buffer for different batches DSPLIB_min_init that will be retrieved and used by DSPLIB_...
pFxnDSPLIB_min_exec execute
Function pointer to point to the right execution variant between DSPLIB_min_exec_cn and DSPLIB_min_ex...