arm_cfft_radix4_init_q15.c

00001 /* ----------------------------------------------------------------------    
00002 * Copyright (C) 2010-2014 ARM Limited. All rights reserved.    
00003 *    
00004 * $Date:        19. March 2015 
00005 * $Revision:    V.1.4.5  
00006 *    
00007 * Project:      CMSIS DSP Library    
00008 * Title:        arm_cfft_radix4_init_q15.c    
00009 *    
00010 * Description:  Radix-4 Decimation in Frequency Q15 FFT & IFFT initialization function    
00011 *    
00012 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
00013 *  
00014 * Redistribution and use in source and binary forms, with or without 
00015 * modification, are permitted provided that the following conditions
00016 * are met:
00017 *   - Redistributions of source code must retain the above copyright
00018 *     notice, this list of conditions and the following disclaimer.
00019 *   - Redistributions in binary form must reproduce the above copyright
00020 *     notice, this list of conditions and the following disclaimer in
00021 *     the documentation and/or other materials provided with the 
00022 *     distribution.
00023 *   - Neither the name of ARM LIMITED nor the names of its contributors
00024 *     may be used to endorse or promote products derived from this
00025 *     software without specific prior written permission.
00026 *
00027 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00028 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00029 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00030 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
00031 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00032 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00033 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00034 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00036 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00037 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00038 * POSSIBILITY OF SUCH DAMAGE.    
00039 * -------------------------------------------------------------------- */
00040 
00041 #include "arm_math.h"
00042 #include "arm_common_tables.h"
00043 
00044 /**    
00045  * @ingroup groupTransforms    
00046  */
00047 
00048 
00049 /**    
00050  * @addtogroup ComplexFFT    
00051  * @{    
00052  */
00053 
00054 
00055 /**    
00056 * @brief Initialization function for the Q15 CFFT/CIFFT.   
00057 * @deprecated Do not use this function.  It has been superseded by \ref arm_cfft_q15 and will be removed
00058 * @param[in,out] *S             points to an instance of the Q15 CFFT/CIFFT structure.   
00059 * @param[in]     fftLen         length of the FFT.   
00060 * @param[in]     ifftFlag       flag that selects forward (ifftFlag=0) or inverse (ifftFlag=1) transform.   
00061 * @param[in]     bitReverseFlag flag that enables (bitReverseFlag=1) or disables (bitReverseFlag=0) bit reversal of output.   
00062 * @return        The function returns ARM_MATH_SUCCESS if initialization is successful or ARM_MATH_ARGUMENT_ERROR if <code>fftLen</code> is not a supported value.   
00063 *    
00064 * \par Description:   
00065 * \par    
00066 * The parameter <code>ifftFlag</code> controls whether a forward or inverse transform is computed.    
00067 * Set(=1) ifftFlag for calculation of CIFFT otherwise  CFFT is calculated   
00068 * \par    
00069 * The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.    
00070 * Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.    
00071 * \par    
00072 * The parameter <code>fftLen</code> Specifies length of CFFT/CIFFT process. Supported FFT Lengths are 16, 64, 256, 1024.    
00073 * \par    
00074 * This Function also initializes Twiddle factor table pointer and Bit reversal table pointer.    
00075 */
00076 
00077 arm_status arm_cfft_radix4_init_q15(
00078   arm_cfft_radix4_instance_q15 * S,
00079   uint16_t fftLen,
00080   uint8_t ifftFlag,
00081   uint8_t bitReverseFlag)
00082 {
00083   /*  Initialise the default arm status */
00084   arm_status status = ARM_MATH_SUCCESS;
00085   /*  Initialise the FFT length */
00086   S->fftLen = fftLen;
00087   /*  Initialise the Twiddle coefficient pointer */
00088   S->pTwiddle = (q15_t *) twiddleCoef_4096_q15 ;
00089   /*  Initialise the Flag for selection of CFFT or CIFFT */
00090   S->ifftFlag = ifftFlag;
00091   /*  Initialise the Flag for calculation Bit reversal or not */
00092   S->bitReverseFlag = bitReverseFlag;
00093 
00094   /*  Initializations of structure parameters depending on the FFT length */
00095   switch (S->fftLen)
00096   {
00097   case 4096u:
00098     /*  Initializations of structure parameters for 4096 point FFT */
00099 
00100     /*  Initialise the twiddle coef modifier value */
00101     S->twidCoefModifier = 1u;
00102     /*  Initialise the bit reversal table modifier */
00103     S->bitRevFactor = 1u;
00104     /*  Initialise the bit reversal table pointer */
00105     S->pBitRevTable = (uint16_t *) armBitRevTable ;
00106 
00107     break;
00108 
00109   case 1024u:
00110     /*  Initializations of structure parameters for 1024 point FFT */
00111     S->twidCoefModifier = 4u;
00112     S->bitRevFactor = 4u;
00113     S->pBitRevTable = (uint16_t *) & armBitRevTable [3];
00114 
00115     break;
00116 
00117   case 256u:
00118     /*  Initializations of structure parameters for 256 point FFT */
00119     S->twidCoefModifier = 16u;
00120     S->bitRevFactor = 16u;
00121     S->pBitRevTable = (uint16_t *) & armBitRevTable [15];
00122 
00123     break;
00124 
00125   case 64u:
00126     /*  Initializations of structure parameters for 64 point FFT */
00127     S->twidCoefModifier = 64u;
00128     S->bitRevFactor = 64u;
00129     S->pBitRevTable = (uint16_t *) & armBitRevTable [63];
00130 
00131     break;
00132 
00133   case 16u:
00134     /*  Initializations of structure parameters for 16 point FFT */
00135     S->twidCoefModifier = 256u;
00136     S->bitRevFactor = 256u;
00137     S->pBitRevTable = (uint16_t *) & armBitRevTable [255];
00138 
00139     break;
00140 
00141   default:
00142     /*  Reporting argument error if fftSize is not valid value */
00143     status = ARM_MATH_ARGUMENT_ERROR;
00144     break;
00145   }
00146 
00147   return (status);
00148 }
00149 
00150 /**    
00151  * @} end of ComplexFFT group    
00152  */