DSPLIB User Guide
DSPLIB_sub_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_sub_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_sub
16  *
17  * @version 0.1 - Mar 2022 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_SUB_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_SUB_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_sub.h"
26 
39 #define DSPLIB_SUB_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE + 1 * DSPLIB_PARAM_SIZE + 2 * sizeof(int32_t))
46  void *restrict pIn1,
47  void *restrict pIn2,
48  void *restrict pOut);
49 
76 template <typename dataType>
78  const DSPLIB_bufParams1D_t *bufParamsIn,
79  const DSPLIB_bufParams1D_t *bufParamsOut,
80  const DSPLIB_sub_InitArgs *pKerInitArgs);
81 
106 template <typename dataType>
107 extern DSPLIB_STATUS
108 DSPLIB_sub_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut);
109 
126 template <typename dataType>
127 extern DSPLIB_STATUS
128 DSPLIB_sub_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn1, void *restrict pIn2, void *restrict pOut);
129 
133 typedef struct {
141  int32_t blockSize;
142 
145 
165 
166 #endif /* DSPLIB_SUB_IXX_IXX_OXX_PRIV_H_ */
167 
168 /* ======================================================================== */
169 /* End of file: DSPLIB_sub.h */
170 /* ======================================================================== */
DSPLIB_STATUS DSPLIB_sub_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_sub_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
DSPLIB_STATUS(* pFxnDSPLIB_sub_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_sub_exec_ci and DSPLIB_sub...
#define DSPLIB_SUB_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_sub_PrivArgs structure.
DSPLIB_STATUS DSPLIB_sub_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_sub_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....
DSPLIB_STATUS DSPLIB_sub_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....
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.
Definition: DSPLIB_sub.h:107
Structure that is reserved for internal use by the kernel.
pFxnDSPLIB_sub_exec execute
Function pointer to point to the right execution variant between DSPLIB_sub_exec_cn and DSPLIB_sub_ex...
int32_t blockSize
Size of input buffer for different batches DSPLIB_sub_init that will be retrieved and used by DSPLIB_...