DSPLIB User Guide
DSPLIB_blk_move_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_blk_move_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_blk_move
16  *
17  * @version 0.1 - Aug 2023 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_BLK_MOVE_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_BLK_MOVE_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_blk_move.h"
26 
33 /*******************************************************************************
34  *
35  * DEFINES
36  *
37  ******************************************************************************/
38 #define SE_PARAM_BASE (0x0000)
39 #define SE_SE0_PARAM_OFFSET (SE_PARAM_BASE)
40 #define SE_SA0_PARAM_OFFSET (SE_SE0_PARAM_OFFSET + SE_PARAM_SIZE)
46 #define DSPLIB_BLK_MOVE_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE)
52 typedef DSPLIB_STATUS (*pFxnDSPLIB_blk_move_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
53 
82 template <typename dataType>
83 extern DSPLIB_STATUS DSPLIB_blk_move_init_ci(DSPLIB_kernelHandle handle,
84  const DSPLIB_bufParams1D_t *bufParamsIn,
85  const DSPLIB_bufParams1D_t *bufParamsOut,
86  const DSPLIB_blk_move_InitArgs *pKerInitArgs);
87 
109 template <typename dataType>
110 extern DSPLIB_STATUS DSPLIB_blk_move_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
111 
132 template <typename dataType>
133 extern DSPLIB_STATUS DSPLIB_blk_move_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
134 
154 DSPLIB_STATUS DSPLIB_blk_move_init_cn(DSPLIB_kernelHandle handle,
155  DSPLIB_bufParams1D_t *bufParamsIn,
156  DSPLIB_bufParams1D_t *bufParamsOut,
157  const DSPLIB_blk_move_InitArgs *pKerInitArgs);
158 
162 typedef struct {
166  pFxnDSPLIB_blk_move_exec execute;
170  int32_t blockSize;
172  uint8_t bufPblock[DSPLIB_BLK_MOVE_IXX_IXX_OXX_PBLOCK_SIZE];
173 } DSPLIB_blk_move_PrivArgs;
174 
175 #endif /* DSPLIB_BLK_MOVE_IXX_IXX_OXX_PRIV_H_ */
176 
177 /* ======================================================================== */
178 /* End of file: DSPLIB_blk_move.h */
179 /* ======================================================================== */
DSPLIB_blk_move.h
DSPLIB_BLK_MOVE_IXX_IXX_OXX_PBLOCK_SIZE
#define DSPLIB_BLK_MOVE_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_blk_move_PrivArgs structure.
Definition: DSPLIB_blk_move_priv.h:46
DSPLIB_blk_move_exec_ci
DSPLIB_STATUS DSPLIB_blk_move_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....
Definition: DSPLIB_blk_move_ci.cpp:145
DSPLIB_blk_move_init_ci
DSPLIB_STATUS DSPLIB_blk_move_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_blk_move_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
Definition: DSPLIB_blk_move_ci.cpp:49
DSPLIB_blk_move_exec_cn
DSPLIB_STATUS DSPLIB_blk_move_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....
Definition: DSPLIB_blk_move_cn.cpp:41
DSPLIB_blk_move_init_cn
DSPLIB_STATUS DSPLIB_blk_move_init_cn(DSPLIB_kernelHandle handle, DSPLIB_bufParams1D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_blk_move_InitArgs *pKerInitArgs)
This function is the initialization function for the natural C implementation of the kernel....
Definition: DSPLIB_blk_move_cn.cpp:31
pFxnDSPLIB_blk_move_exec
DSPLIB_STATUS(* pFxnDSPLIB_blk_move_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_blk_move_exec_ci and DSPLI...
Definition: DSPLIB_blk_move_priv.h:52
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_blk_move_InitArgs
Structure containing the parameters to initialize the kernel.
Definition: DSPLIB_blk_move.h:108
DSPLIB_blk_move_PrivArgs
Structure that is reserved for internal use by the kernel.
Definition: DSPLIB_blk_move_priv.h:162
DSPLIB_blk_move_PrivArgs::blockSize
int32_t blockSize
Size of input buffer for different batches DSPLIB_blk_move_init that will be retrieved and used by DS...
Definition: DSPLIB_blk_move_priv.h:170
DSPLIB_blk_move_PrivArgs::execute
pFxnDSPLIB_blk_move_exec execute
Function pointer to point to the right execution variant between DSPLIB_blk_move_exec_cn and DSPLIB_b...
Definition: DSPLIB_blk_move_priv.h:166
DSPLIB_bufParams1D_t
A structure for a 1 dimensional buffer descriptor.
Definition: DSPLIB_bufParams.h:70