DSPLIB User Guide
DSPLIB_lud_priv.h
Go to the documentation of this file.
1 /******************************************************************************
2  * *
3  * module name :DSPLIB *
4  * *
5  * module descripton :Digital Signal Processing 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_lud_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_lud
16  *
17  * @version 1.0 Date Sep 2023 Author: Asheesh Bhardwaj
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_LUD_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_LUD_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_lud.h"
26 
38 #define DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE (22 * SE_PARAM_SIZE)
39 
45 typedef DSPLIB_STATUS (*pFxnDSPLIB_lud_exec)(DSPLIB_kernelHandle handle,
46  void *restrict pA,
47  void *restrict pL,
48  void *restrict pU,
49  void *restrict pP);
50 
83 template <typename dataType>
84 extern DSPLIB_STATUS DSPLIB_lud_init_ci(DSPLIB_kernelHandle handle,
85  const DSPLIB_bufParams2D_t *bufParamsA,
86  const DSPLIB_bufParams2D_t *bufParamsL,
87  const DSPLIB_bufParams2D_t *bufParamsU,
88  const DSPLIB_bufParams2D_t *bufParamsP,
89  const DSPLIB_ludInitArgs * pKerInitArgs);
90 
114 template <typename dataType>
115 extern DSPLIB_STATUS DSPLIB_lud_exec_ci(DSPLIB_kernelHandle handle,
116  void *restrict pA,
117  void *restrict pL,
118  void *restrict pU,
119  void *restrict pP);
120 
143 DSPLIB_STATUS DSPLIB_lud_init_cn(DSPLIB_kernelHandle handle,
144  const DSPLIB_bufParams2D_t *bufParamsA,
145  const DSPLIB_bufParams2D_t *bufParamsL,
146  const DSPLIB_bufParams2D_t *bufParamsU,
147  const DSPLIB_bufParams2D_t *bufParamsP,
148  const DSPLIB_ludInitArgs * pKerInitArgs);
149 
167 template <typename dataType>
168 extern DSPLIB_STATUS DSPLIB_lud_exec_cn(DSPLIB_kernelHandle handle,
169  void *restrict pA,
170  void *restrict pL,
171  void *restrict pU,
172  void *restrict pP);
173 
177 typedef struct {
181  pFxnDSPLIB_lud_exec execute;
186  int32_t order;
188  int32_t strideOrder;
190  int32_t strideP;
192  uint8_t bufPblock[DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE];
193 } DSPLIB_lud_PrivArgs;
194 
195 #endif /* DSPLIB_LUD_IXX_IXX_OXX_PRIV_H_ */
196 
197 /* ======================================================================== */
198 /* End of file: DSPLIB_lud_priv.h */
199 /* ======================================================================== */
DSPLIB_lud.h
DSPLIB_lud_init_ci
DSPLIB_STATUS DSPLIB_lud_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsA, const DSPLIB_bufParams2D_t *bufParamsL, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsP, const DSPLIB_ludInitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_lud_ci.cpp:59
DSPLIB_lud_init_cn
DSPLIB_STATUS DSPLIB_lud_init_cn(DSPLIB_kernelHandle handle, const DSPLIB_bufParams2D_t *bufParamsA, const DSPLIB_bufParams2D_t *bufParamsL, const DSPLIB_bufParams2D_t *bufParamsU, const DSPLIB_bufParams2D_t *bufParamsP, const DSPLIB_ludInitArgs *pKerInitArgs)
This function is the initialization function for the natural C implementation of the kernel....
Definition: DSPLIB_lud_cn.cpp:41
pFxnDSPLIB_lud_exec
DSPLIB_STATUS(* pFxnDSPLIB_lud_exec)(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)
This is a function pointer type that conforms to the declaration of DSPLIB_lud_exec_ci and DSPLIB_lud...
Definition: DSPLIB_lud_priv.h:45
DSPLIB_lud_exec_cn
DSPLIB_STATUS DSPLIB_lud_exec_cn(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)
This function is the main execution function for the natural C implementation of the kernel....
Definition: DSPLIB_lud_cn.cpp:179
DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_LUD_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_lud_PrivArgs structure.
Definition: DSPLIB_lud_priv.h:38
DSPLIB_lud_exec_ci
DSPLIB_STATUS DSPLIB_lud_exec_ci(DSPLIB_kernelHandle handle, void *restrict pA, void *restrict pL, void *restrict pU, void *restrict pP)
This function is the main execution function for the C7x implementation of the kernel....
Definition: DSPLIB_lud_ci.cpp:976
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_bufParams2D_t
A structure for a 2 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:78
DSPLIB_ludInitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_lud.h:117
DSPLIB_lud_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_lud_priv.h:177
DSPLIB_lud_PrivArgs::order
int32_t order
Size of input buffer for different batches DSPLIB_lud_init that will be retrieved and used by DSPLIB_...
Definition: DSPLIB_lud_priv.h:186
DSPLIB_lud_PrivArgs::strideOrder
int32_t strideOrder
Stride between rows of input and output data matrix
Definition: DSPLIB_lud_priv.h:188
DSPLIB_lud_PrivArgs::strideP
int32_t strideP
Stride between rows of output data matrix P
Definition: DSPLIB_lud_priv.h:190
DSPLIB_lud_PrivArgs::execute
pFxnDSPLIB_lud_exec execute
Function pointer to point to the right execution variant between DSPLIB_lud_exec_cn and DSPLIB_lud_ex...
Definition: DSPLIB_lud_priv.h:181