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