DSPLIB User Guide
DSPLIB_dotprod_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_dotprod_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_dotprod
16  *
17  * @version 0.1 - Aug 2023 :
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_DOTPROD_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_DOTPROD_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_dotprod.h"
26 
39 #define DSPLIB_DOTPROD_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
45 typedef DSPLIB_STATUS (*pFxnDSPLIB_dotprod_exec)(DSPLIB_kernelHandle handle,
46  void *restrict pIn1,
47  void *restrict pIn2,
48  void *restrict pOut);
49 
78 template <typename dataType>
79 extern DSPLIB_STATUS DSPLIB_dotprod_init_ci(DSPLIB_kernelHandle handle,
80  const DSPLIB_bufParams1D_t *bufParamsIn,
81  const DSPLIB_bufParams1D_t *bufParamsOut,
82  const DSPLIB_dotprod_InitArgs *pKerInitArgs);
83 
109 template <typename dataType>
110 extern DSPLIB_STATUS
111 DSPLIB_dotprod_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut);
112 
132 template <typename dataType>
133 extern DSPLIB_STATUS
134 DSPLIB_dotprod_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut);
135 
139 typedef struct {
143  pFxnDSPLIB_dotprod_exec execute;
147  int32_t blockSize;
148 
149  uint8_t bufPblock[DSPLIB_DOTPROD_IXX_IXX_OXX_PBLOCK_SIZE];
150 } DSPLIB_dotprod_PrivArgs;
151 
171 DSPLIB_STATUS
172 DSPLIB_dotprod_init_cn(DSPLIB_kernelHandle handle,
173  DSPLIB_bufParams2D_t *bufParamsIn,
174  DSPLIB_bufParams2D_t *bufParamsOut);
175 
176 #endif /* DSPLIB_dotprod_IXX_IXX_OXX_PRIV_H_ */
177 
178 /* ======================================================================== */
179 /* End of file: DSPLIB_dotprod.h */
180 /* ======================================================================== */
DSPLIB_dotprod.h
DSPLIB_dotprod_exec_cn
DSPLIB_STATUS DSPLIB_dotprod_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_dotprod_cn.cpp:39
DSPLIB_DOTPROD_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_DOTPROD_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_dotprod_PrivArgs structure.
Definition: DSPLIB_dotprod_priv.h:39
pFxnDSPLIB_dotprod_exec
DSPLIB_STATUS(* pFxnDSPLIB_dotprod_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_dotprod_exec_ci and DSPLIB...
Definition: DSPLIB_dotprod_priv.h:45
DSPLIB_dotprod_exec_ci
DSPLIB_STATUS DSPLIB_dotprod_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_dotprod_ci.cpp:229
DSPLIB_dotprod_init_cn
DSPLIB_STATUS DSPLIB_dotprod_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_dotprod_init_ci
DSPLIB_STATUS DSPLIB_dotprod_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_dotprod_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_dotprod_ci.cpp:62
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_dotprod_InitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_dotprod.h:108
DSPLIB_dotprod_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_dotprod_priv.h:139
DSPLIB_dotprod_PrivArgs::execute
pFxnDSPLIB_dotprod_exec execute
Function pointer to point to the right execution variant between DSPLIB_dotprod_exec_cn and DSPLIB_do...
Definition: DSPLIB_dotprod_priv.h:143
DSPLIB_dotprod_PrivArgs::blockSize
int32_t blockSize
Size of input buffer for different batches DSPLIB_dotprod_init that will be retrieved and used by DSP...
Definition: DSPLIB_dotprod_priv.h:147