FFTLIB User Guide
FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h
Go to the documentation of this file.
1 /*******************************************************************************
2 **+--------------------------------------------------------------------------+**
3 **| **** |**
4 **| **** |**
5 **| ******o*** |**
6 **| ********_///_**** |**
7 **| ***** /_//_/ **** |**
8 **| ** ** (__/ **** |**
9 **| ********* |**
10 **| **** |**
11 **| *** |**
12 **| |**
13 **| Copyright (c) 2016 Texas Instruments Incorporated |**
14 **| |**
15 **| All rights reserved not granted herein. |**
16 **| |**
17 **| Limited License. |**
18 **| |**
19 **| Texas Instruments Incorporated grants a world-wide, royalty-free, |**
20 **| non-exclusive license under copyrights and patents it now or |**
21 **| hereafter owns or controls to make, have made, use, import, offer to |**
22 **| sell and sell ("Utilize") this software subject to the terms herein. |**
23 **| With respect to the foregoing patent license, such license is granted |**
24 **| solely to the extent that any such patent is necessary to Utilize the |**
25 **| software alone. The patent license shall not apply to any |**
26 **| combinations which include this software, other than combinations |**
27 **| with devices manufactured by or for TI ("TI Devices"). No hardware |**
28 **| patent is licensed hereunder. |**
29 **| |**
30 **| Redistributions must preserve existing copyright notices and |**
31 **| reproduce this license (including the above copyright notice and the |**
32 **| disclaimer and (if applicable) source code license limitations below) |**
33 **| in the documentation and/or other materials provided with the |**
34 **| distribution |**
35 **| |**
36 **| Redistribution and use in binary form, without modification, are |**
37 **| permitted provided that the following conditions are met: |**
38 **| |**
39 **| * No reverse engineering, decompilation, or disassembly of this |**
40 **| software is permitted with respect to any software provided in binary |**
41 **| form. |**
42 **| |**
43 **| * any redistribution and use are licensed by TI for use only with |**
44 **| TI Devices. |**
45 **| |**
46 **| * Nothing shall obligate TI to provide you with source code for |**
47 **| the software licensed and provided to you in object code. |**
48 **| |**
49 **| If software source code is provided to you, modification and |**
50 **| redistribution of the source code are permitted provided that the |**
51 **| following conditions are met: |**
52 **| |**
53 **| * any redistribution and use of the source code, including any |**
54 **| resulting derivative works, are licensed by TI for use only with TI |**
55 **| Devices. |**
56 **| |**
57 **| * any redistribution and use of any object code compiled from the |**
58 **| source code and any resulting derivative works, are licensed by TI |**
59 **| for use only with TI Devices. |**
60 **| |**
61 **| Neither the name of Texas Instruments Incorporated nor the names of |**
62 **| its suppliers may be used to endorse or promote products derived from |**
63 **| this software without specific prior written permission. |**
64 **| |**
65 **| DISCLAIMER. |**
66 **| |**
67 **| THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY |**
68 **| EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |**
69 **| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |**
70 **| PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI'S LICENSORS BE |**
71 **| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |**
72 **| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |**
73 **| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |**
74 **| BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |**
75 **| WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE |**
76 **| OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |**
77 **| EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |**
78 **+--------------------------------------------------------------------------+**
79 *******************************************************************************/
80 
81 #ifndef FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_H_
82 #define FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_H_
83 
84 #include "../../common/FFTLIB_types.h"
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
111 #define FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS 1
112 
116 typedef struct {
118  int8_t funcStyle;
121  uint32_t fftSize;
123  uint32_t batchSize;
128  uint32_t interleave;
137  uint32_t shiftVector[FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS];
138 } FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs;
139 
148 int32_t FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize (
149  FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs);
150 
171 FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes (
172  const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs,
173  FFTLIB_bufParams1D_t *bufParamsX,
174  FFTLIB_bufParams1D_t *bufParamsW,
175  FFTLIB_bufParams1D_t *bufParamsY);
176 
194 FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen (
195  const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs,
196  void *pW,
197  const FFTLIB_bufParams1D_t *bufParamsW);
198 
222 FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init (
223  FFTLIB_kernelHandle handle,
224  FFTLIB_bufParams1D_t *bufParamsX,
225  FFTLIB_bufParams1D_t *bufParamsW,
226  FFTLIB_bufParams1D_t *bufParamsY,
227  FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs);
228 
252 FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams (
253  FFTLIB_kernelHandle handle,
254  const FFTLIB_bufParams1D_t *bufParamsX,
255  const FFTLIB_bufParams1D_t *bufParamsW,
256  const FFTLIB_bufParams1D_t *bufParamsY,
257  const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs);
258 
288 FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec (FFTLIB_kernelHandle handle,
289  void *restrict pX,
290  void *restrict pW,
291  void *restrict pY);
292 
312 FFTLIB_STATUS
313 FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams (FFTLIB_kernelHandle handle,
314  const void *restrict pX,
315  const void *restrict pW,
316  const void *restrict pY);
317 
340 void FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst (
341  FFTLIB_kernelHandle handle,
342  const FFTLIB_bufParams1D_t *bufParamsX,
343  const FFTLIB_bufParams1D_t *bufParamsY,
344  const FFTLIB_bufParams1D_t *bufParamsW,
345  uint32_t fftSize,
346  uint32_t batchSize,
347  uint64_t *archCycles,
348  uint64_t *estCycles);
349 
352 #ifdef __cplusplus
353 }
354 #endif
355 
356 #endif /* FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_H_ */
357 
358 /* ======================================================================== */
359 /* End of file: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h */
360 /* ======================================================================== */
FFTLIB_kernelHandle
void * FFTLIB_kernelHandle
Handle type for FFTLIB operations.
Definition: FFTLIB_types.h:217
FFTLIB_STATUS_NAME
FFTLIB_STATUS_NAME
The enumeration of all status codes.
Definition: FFTLIB_types.h:172
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes
FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getSizes(const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs, FFTLIB_bufParams1D_t *bufParamsX, FFTLIB_bufParams1D_t *bufParamsW, FFTLIB_bufParams1D_t *bufParamsY)
This is a query function to calculate the sizes of input, output and the DFT computational matrix buf...
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX_ci.cpp:125
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams
FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init_checkParams(FFTLIB_kernelHandle handle, const FFTLIB_bufParams1D_t *bufParamsX, const FFTLIB_bufParams1D_t *bufParamsW, const FFTLIB_bufParams1D_t *bufParamsY, const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs)
This function checks the validity of the parameters passed to FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init fu...
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp:32
FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS
#define FFTLIB_FFT_DFTSMALL_IXX_CXX_OXX_NUMSHIFTS
Macro to define the number of bit-shifts that are to be provided for use in the internal DFT computat...
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h:111
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams
FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec_checkParams(FFTLIB_kernelHandle handle, const void *restrict pX, const void *restrict pW, const void *restrict pY)
This function checks the validity of the parameters passed to FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec fu...
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp:77
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize
int32_t FFTLIB_FFT_dftSmall_ixX_cxX_oxX_getHandleSize(FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs)
This is a query function to calculate the size of internal handle.
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp:25
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst
void FFTLIB_FFT_dftSmall_ixX_cxX_oxX_perfEst(FFTLIB_kernelHandle handle, const FFTLIB_bufParams1D_t *bufParamsX, const FFTLIB_bufParams1D_t *bufParamsY, const FFTLIB_bufParams1D_t *bufParamsW, uint32_t fftSize, uint32_t batchSize, uint64_t *archCycles, uint64_t *estCycles)
This is a utility function that gives an estimate of the cycles consumed for the kernel execution.
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX_ci.cpp:64
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init
FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_init(FFTLIB_kernelHandle handle, FFTLIB_bufParams1D_t *bufParamsX, FFTLIB_bufParams1D_t *bufParamsW, FFTLIB_bufParams1D_t *bufParamsY, FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs)
This function should be called before the FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec function is called....
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp:141
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen
FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_twGen(const FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs *pKerInitArgs, void *pW, const FFTLIB_bufParams1D_t *bufParamsW)
This is a utility function that generates the DFT computational matrix into the provided buffer.
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp:119
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec
FFTLIB_STATUS FFTLIB_FFT_dftSmall_ixX_cxX_oxX_exec(FFTLIB_kernelHandle handle, void *restrict pX, void *restrict pW, void *restrict pY)
This function is the main kernel compute function.
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.cpp:205
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs
Structure containing the parameters for DFT computation.
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h:116
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs::interleave
uint32_t interleave
Flag to indicate if the real and imaginary parts of data are interleaved or not. A value of 1 indicat...
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h:128
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs::funcStyle
int8_t funcStyle
Variant of the function refer to FFTLIB_FUNCTION_STYLE
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h:118
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs::fftSize
uint32_t fftSize
Size of each channel's data in terms of number of complex points.
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h:121
FFTLIB_FFT_dftSmall_ixX_cxX_oxX_InitArgs::batchSize
uint32_t batchSize
Size of the batch in terms of number of channels of DFT's
Definition: FFTLIB_FFT_dftSmall_ixX_cxX_oxX.h:123
FFTLIB_bufParams1D_t
A structure for a 1 dimensional buffer descriptor.
Definition: FFTLIB_bufParams.h:83