DSPLIB User Guide
DSPLIB_w_vec_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_w_vec_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_w_vec
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_W_VEC_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_W_VEC_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_w_vec.h"
26 
39 #define DSPLIB_W_VEC_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
46 typedef DSPLIB_STATUS (*pFxnDSPLIB_w_vec_exec)(DSPLIB_kernelHandle handle,
47  void *restrict pIn1,
48  void *restrict pIn2,
49  void *restrict pM,
50  void *restrict pOut);
51 
80 template <typename dataType>
81 extern DSPLIB_STATUS DSPLIB_w_vec_init_ci(DSPLIB_kernelHandle handle,
82  const DSPLIB_bufParams1D_t *bufParamsIn,
83  const DSPLIB_bufParams1D_t *bufParamsOut,
84  const DSPLIB_w_vec_InitArgs *pKerInitArgs);
85 
108 template <typename dataType>
109 extern DSPLIB_STATUS DSPLIB_w_vec_exec_ci(DSPLIB_kernelHandle handle,
110  void *restrict pIn1,
111  void *restrict pIn2,
112  void *restrict pM,
113  void *restrict pOut);
114 
134 template <typename dataType>
135 extern DSPLIB_STATUS DSPLIB_w_vec_exec_cn(DSPLIB_kernelHandle handle,
136  void *restrict pIn1,
137  void *restrict pIn2,
138  void *restrict pM,
139  void *restrict pOut);
140 
144 typedef struct {
148  pFxnDSPLIB_w_vec_exec execute;
152  int32_t blockSize;
153 
154  uint8_t bufPblock[DSPLIB_W_VEC_IXX_IXX_OXX_PBLOCK_SIZE];
155  // Init Arguments
156  DSPLIB_w_vec_InitArgs initArgs;
157 } DSPLIB_w_vec_PrivArgs;
158 
159 #endif /* DSPLIB_W_VEC_IXX_IXX_OXX_PRIV_H_ */
160 
161 /* ======================================================================== */
162 /* End of file: DSPLIB_w_vec.h */
163 /* ======================================================================== */
DSPLIB_w_vec.h
DSPLIB_w_vec_exec_ci
DSPLIB_STATUS DSPLIB_w_vec_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pM, void *restrict pOut)
This function is the main execution function for the C7x implementation of the kernel....
Definition: DSPLIB_w_vec_ci.cpp:211
DSPLIB_W_VEC_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_W_VEC_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_w_vec_PrivArgs structure.
Definition: DSPLIB_w_vec_priv.h:39
pFxnDSPLIB_w_vec_exec
DSPLIB_STATUS(* pFxnDSPLIB_w_vec_exec)(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pM, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_w_vec_s_exec_ci,...
Definition: DSPLIB_w_vec_priv.h:46
DSPLIB_w_vec_init_ci
DSPLIB_STATUS DSPLIB_w_vec_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_w_vec_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_w_vec_ci.cpp:59
DSPLIB_w_vec_exec_cn
DSPLIB_STATUS DSPLIB_w_vec_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pM, void *restrict pOut)
This function is the main execution function for the natural C implementation of the kernel....
Definition: DSPLIB_w_vec_cn.cpp:32
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_w_vec_InitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_w_vec.h:117
DSPLIB_w_vec_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_w_vec_priv.h:144
DSPLIB_w_vec_PrivArgs::execute
pFxnDSPLIB_w_vec_exec execute
Function pointer to point to the right execution variant between DSPLIB_w_vec_exec_cn DSPLIB_w_vec_ex...
Definition: DSPLIB_w_vec_priv.h:148
DSPLIB_w_vec_PrivArgs::initArgs
DSPLIB_w_vec_InitArgs initArgs
Definition: DSPLIB_w_vec_priv.h:156
DSPLIB_w_vec_PrivArgs::blockSize
int32_t blockSize
Size of input buffer for different batches DSPLIB_w_vec_init that will be retrieved and used by DSPLI...
Definition: DSPLIB_w_vec_priv.h:152