0a49afb4850732a5ba0e524bf7302cbd268f7a8b
[ep-processor-libraries/dsplib.git] / ti / dsplib / src / DSP_fft16x16 / c64P / DSP_fft16x16.h
1 /* ======================================================================= */
2 /* DSP_fft16x16.h -- 16x16 Mixed Radix FFT                                 */
3 /*                   Serial ASM Implementation                             */
4 /*                                                                         */
5 /* Rev 0.0.1                                                               */
6 /*                                                                         */
7 /* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/  */ 
8 /*                                                                         */
9 /*                                                                         */
10 /*  Redistribution and use in source and binary forms, with or without     */
11 /*  modification, are permitted provided that the following conditions     */
12 /*  are met:                                                               */
13 /*                                                                         */
14 /*    Redistributions of source code must retain the above copyright       */
15 /*    notice, this list of conditions and the following disclaimer.        */
16 /*                                                                         */
17 /*    Redistributions in binary form must reproduce the above copyright    */
18 /*    notice, this list of conditions and the following disclaimer in the  */
19 /*    documentation and/or other materials provided with the               */
20 /*    distribution.                                                        */
21 /*                                                                         */
22 /*    Neither the name of Texas Instruments Incorporated nor the names of  */
23 /*    its contributors may be used to endorse or promote products derived  */
24 /*    from this software without specific prior written permission.        */
25 /*                                                                         */
26 /*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    */
27 /*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      */
28 /*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  */
29 /*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
30 /*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  */
31 /*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT       */
32 /*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  */
33 /*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  */
34 /*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT    */
35 /*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  */
36 /*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   */
37 /*                                                                         */
38 /* ======================================================================= */
40 #ifndef DSP_FFT16X16_H_
41 #define DSP_FFT16X16_H_ 1
43 #ifndef __TI_COMPILER_VERSION__           // for non TI compiler
44 #include "assert.h"                       // intrinsics prototypes
45 #include "C6xSimulator.h"                 // intrinsics prototypes
46 #include "C6xSimulator_type_modifiers.h"  // define/undefine typing keywords
47 #endif
49 /** @ingroup FFT */
50 /* @{ */
52 /** @defgroup DSP_fft16x16 */
53 /** @ingroup DSP_fft16x16 */
54 /* @{ */
56 /**
57  *      This routine computes a complex forward mixed radix FFT with
58  *      rounding and digit reversal. Input data x[ ], output data y[ ],
59  *      and coefficients w[ ] are 16-bit. The output is returned in the 
60  *      separate array y[ ] in normal order. Each complex value is stored 
61  *      with interleaved real and imaginary parts. The code uses a special 
62  *      ordering of FFT coefficients (also called twiddle factors) and
63  *      memory accesses to improve performance in the presence of cache.
64  *
65  *          @param  ptr_w   =  input twiddle factors    
66  *          @param  npoints =  number of points         
67  *          @param  ptr_x   =  transformed data reversed
68  *          @param  ptr_y   =  linear transformed data  
69  *
70  * @par Algorithm:
71  * DSP_fft16x16_cn.c is the natural C equivalent of the optimized intrinsic C
72  * code without restrictions. Note that the intrinsic C code is optimized and
73  * restrictions may apply.  
74  * 
75  * @par Assumptions:
76  *     In-place computation is not allowed. <BR>                            
77  *     Size of FFT, nx, must be power of 2 and 16<=nx<=65536. <BR>                                 
78  *     The arrays for the complex input data x[], complex output data y[]
79  *        and twiddle factor w[] must be double word aligned. <BR>
80  *     The input and output data are complex, with the real/imaginary 
81  *        components stored in adjacent locations in the array.  The real
82  *        components are stored at even array indices, and the imaginary 
83  *        components are stored at odd array indices. <BR>                    
84  *
85  * @par Implementation Notes:
86  * @b Endian Support: 
87  *    The intrinsic optimized C code supports both big and little endian modes. <BR> 
88  *    The linear assembly code supports little endian mode only. <BR> 
89  * @b Interruptibility: The code is interruptible. <BR>
90  *
91  */
93 void DSP_fft16x16 (
94     const short * restrict ptr_w,
95     int npoints,
96     short * restrict ptr_x,
97     short * restrict ptr_y
98 );
100 #endif
102 /* ======================================================================== */
103 /*  End of file:  DSP_fft16x16.h                                            */
104 /* ------------------------------------------------------------------------ */
105 /*            Copyright (c) 2011 Texas Instruments, Incorporated.           */
106 /*                           All Rights Reserved.                           */
107 /* ======================================================================== */