Fixed documentation issues tracked by PRSDK-4872, PRSDK-4873, PRSDK-4875.
[ep-processor-libraries/dsplib.git] / ti / dsplib / src / DSP_fft16x16_imre / c66 / DSP_fft16x16_imre.h
1 /* ======================================================================= */
2 /* DSP_fft16x16_imre.h -- 16x16 Mixed Radix FFT                            */
3 /*                        Intrinsic C 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 __TI_COMPILER_VERSION__           // for non TI compiler
41 #include "assert.h"                       // intrinsics prototypes
42 #include "C6xSimulator.h"                 // intrinsics prototypes
43 #include "C6xSimulator_type_modifiers.h"  // define/undefine typing keywords
44 #endif
46 /** @ingroup FFT */
47 /* @{ */
49 /** @defgroup  DSP_fft16x16_imre */
50 /** @ingroup DSP_fft16x16_imre */
51 /* @{ */
53 /**
54  *      This routine computes a complex forward mixed radix FFT 
55  *      with rounding and digit reversal. Input data x[ ], output 
56  *      data y[ ], and coefficients w[ ] are 16-bit. The output is 
57  *      returned in the separate array y[ ] in normal order. Each complex
58  *      value is stored with interleaved imaginary and real parts.
59  *
60  *          @param  ptr_w   =  input twiddle factors    
61  *          @param  npoints =  number of points         
62  *          @param  ptr_x   =  transformed data reversed
63  *          @param  ptr_y   =  linear transformed data  
64  *
65  * @par Algorithm:
66  * DSP_fft16x16_imre_cn.c is the natural C equivalent of the optimized intrinsic
67  * C code without restrictions. Note that the intrinsic C code is optimized 
68  * and restrictions may apply.  
69  * 
70  * @par Assumptions:
71  *     In-place computation is not allowed. <BR>                             
72  *     Size of FFT, nx, must be power of 2 and 16<=nx<=65536. <BR>                                 
73  *     The arrays for the complex input data x[], complex output data y[]
74  *        and twiddle factor w[] must be double word aligned. <BR>
75  *     The input and output data are complex, with the imaginary/real
76  *        components stored in adjacent locations in the array. The imaginary
77  *        components are stored at even array indices, and the real components are
78  *        stored at odd array indices. <BR>
79  *     All data are in short precision or Q.15 format. Allowed maximum absolute 
80  *        value of input is 2^(16 - log2(nx)). <BR>                    
81  *
82  * @par Implementation Notes:
83  * @b Endian Support: The code supports both big and little endian modes. <BR> 
84  * @b Interruptibility: The code is interruptible. <BR>
85  *
86  */
88 #ifndef FFT16X16_IMRE_H_
89 #define FFT16X16_IMRE_H_ 1
91 void DSP_fft16x16_imre (
92     const short * restrict ptr_w,
93     int npoints,
94     short * restrict ptr_x,
95     short * restrict ptr_y
96 );
98 #endif
100 /* ======================================================================== */
101 /*  End of file:  fft16x16_imre.h                                           */
102 /* ------------------------------------------------------------------------ */
103 /*            Copyright (c) 2011 Texas Instruments, Incorporated.           */
104 /*                           All Rights Reserved.                           */
105 /* ======================================================================== */