arm_fir_lattice_init_q31.c

00001 /*-----------------------------------------------------------------------------  
00002 * Copyright (C) 2010 ARM Limited. All rights reserved.  
00003 *  
00004 * $Date:        29. November 2010  
00005 * $Revision:    V1.0.3  
00006 *  
00007 * Project:      CMSIS DSP Library  
00008 * Title:        arm_fir_lattice_init_q31.c  
00009 *  
00010 * Description:  Q31 FIR lattice filter initialization function.  
00011 *  
00012 * Target Processor: Cortex-M4/Cortex-M3
00013 *  
00014 * Version 1.0.3 2010/11/29 
00015 *    Re-organized the CMSIS folders and updated documentation.  
00016 *   
00017 * Version 1.0.2 2010/11/11  
00018 *    Documentation updated.   
00019 *  
00020 * Version 1.0.1 2010/10/05   
00021 *    Production release and review comments incorporated.  
00022 *  
00023 * Version 1.0.0 2010/09/20   
00024 *    Production release and review comments incorporated  
00025 *  
00026 * Version 0.0.7  2010/06/10   
00027 *    Misra-C changes done  
00028 * ---------------------------------------------------------------------------*/ 
00029  
00030 #include "arm_math.h" 
00031  
00032 /**  
00033  * @ingroup groupFilters  
00034  */ 
00035  
00036 /**  
00037  * @addtogroup FIR_Lattice  
00038  * @{  
00039  */ 
00040  
00041   /**  
00042    * @brief Initialization function for the Q31 FIR lattice filter.  
00043    * @param[in] *S points to an instance of the Q31 FIR lattice structure.  
00044    * @param[in] numStages  number of filter stages.  
00045    * @param[in] *pCoeffs points to the coefficient buffer.  The array is of length numStages.  
00046    * @param[in] *pState points to the state buffer.   The array is of length numStages.  
00047    * @return none.  
00048    */ 
00049  
00050 void arm_fir_lattice_init_q31( 
00051   arm_fir_lattice_instance_q31 * S, 
00052   uint16_t numStages, 
00053   q31_t * pCoeffs, 
00054   q31_t * pState) 
00055 { 
00056   /* Assign filter taps */ 
00057   S->numStages = numStages; 
00058  
00059   /* Assign coefficient pointer */ 
00060   S->pCoeffs = pCoeffs; 
00061  
00062   /* Clear state buffer and size is always numStages */ 
00063   memset(pState, 0, (numStages) * sizeof(q31_t)); 
00064  
00065   /* Assign state pointer */ 
00066   S->pState = pState; 
00067  
00068 } 
00069  
00070 /**  
00071  * @} end of FIR_Lattice group  
00072  */