DSPLIB User Guide
DSPLIB_fltoq15_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_fltoq15_priv.h
14  *
15  * @brief File to hold private parameter of function DSPLIB_fltoq15
16  *
17  * @version 0.1 - Aug 2023 : Initial Version
18  *
19  ********************************************************************************/
20 
21 #ifndef DSPLIB_FLTOQ15_IXX_IXX_OXX_PRIV_H_
22 #define DSPLIB_FLTOQ15_IXX_IXX_OXX_PRIV_H_
23 
24 #include "../common/DSPLIB_utility.h"
25 #include "DSPLIB_fltoq15.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)
41 
47 #define DSPLIB_FLTOQ15_IXX_IXX_OXX_PBLOCK_SIZE (2 * SE_PARAM_SIZE)
48 
54 typedef DSPLIB_STATUS (*pFxnDSPLIB_fltoq15_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
58 typedef struct {
66  int32_t blockSize;
71 
74 
103 template <typename dataTypeIn>
105  const DSPLIB_bufParams1D_t *bufParamsIn,
106  const DSPLIB_bufParams1D_t *bufParamsOut,
107  const DSPLIB_fltoq15_InitArgs *pKerInitArgs);
108 
131 template <typename dataTypeIn>
132 extern DSPLIB_STATUS DSPLIB_fltoq15_exec_ci(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
133 
154  DSPLIB_bufParams1D_t *bufParamsIn,
155  DSPLIB_bufParams1D_t *bufParamsOut,
156  const DSPLIB_fltoq15_InitArgs *pKerInitArgs);
157 
174 template <typename dataTypeIn>
175 DSPLIB_STATUS DSPLIB_fltoq15_exec_cn(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut);
176 
177 #endif /* DSPLIB_FLTOQ15_IXX_IXX_OXX_PRIV_H_ */
178 
179 /* ======================================================================== */
180 /* End of file: DSPLIB_fltoq15.h */
181 /* ======================================================================== */
DSPLIB_STATUS DSPLIB_fltoq15_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....
DSPLIB_STATUS(* pFxnDSPLIB_fltoq15_exec)(DSPLIB_kernelHandle handle, void *restrict pIn, void *restrict pOut)
This is a function pointer type that conforms to the declaration of DSPLIB_fltoq15_exec_ci and DSPLIB...
DSPLIB_STATUS DSPLIB_fltoq15_init_ci(DSPLIB_kernelHandle handle, const DSPLIB_bufParams1D_t *bufParamsIn, const DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_fltoq15_InitArgs *pKerInitArgs)
This function is the initialization function for the C7x implementation of the kernel....
#define DSPLIB_FLTOQ15_IXX_IXX_OXX_PBLOCK_SIZE
Macro to define the size of bufPblock array of DSPLIB_fltoq15_PrivArgs structure.
DSPLIB_STATUS DSPLIB_fltoq15_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....
DSPLIB_STATUS DSPLIB_fltoq15_init_cn(DSPLIB_kernelHandle handle, DSPLIB_bufParams1D_t *bufParamsIn, DSPLIB_bufParams1D_t *bufParamsOut, const DSPLIB_fltoq15_InitArgs *pKerInitArgs)
This function is the initialization function for the natural C 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.
Structure containing the parameters to initialize the kernel.
Structure that is reserved for internal use by the kernel.
int32_t blockSize
Size of input buffer for different batches DSPLIB_fltoq15_init that will be retrieved and used by DSP...
bool isSEReadEnabled
Flag indicating if SE reads and stores are enabled, set by DSPLIB_fltoq15_init_ci that will be retrie...
pFxnDSPLIB_fltoq15_exec execute
Function pointer to point to the right execution variant between DSPLIB_fltoq15_exec_cn and DSPLIB_fl...