arm_fir_lattice_init_q15.c

00001 /*-----------------------------------------------------------------------------    
00002 * Copyright (C) 2010-2013 ARM Limited. All rights reserved.    
00003 *    
00004 * $Date:        17. January 2013
00005 * $Revision:    V1.4.1
00006 *    
00007 * Project:      CMSIS DSP Library    
00008 * Title:        arm_fir_lattice_init_q15.c    
00009 *    
00010 * Description:  Q15 FIR Lattice filter 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 
00043 /**    
00044  * @ingroup groupFilters    
00045  */
00046 
00047 /**    
00048  * @addtogroup FIR_Lattice    
00049  * @{    
00050  */
00051 
00052   /**    
00053    * @brief Initialization function for the Q15 FIR lattice filter.    
00054    * @param[in] *S points to an instance of the Q15 FIR lattice structure.    
00055    * @param[in] numStages  number of filter stages.    
00056    * @param[in] *pCoeffs points to the coefficient buffer.  The array is of length numStages.     
00057    * @param[in] *pState points to the state buffer.  The array is of length numStages.     
00058    * @return none.    
00059    */
00060 
00061 void arm_fir_lattice_init_q15(
00062   arm_fir_lattice_instance_q15 * S,
00063   uint16_t numStages,
00064   q15_t * pCoeffs,
00065   q15_t * pState)
00066 {
00067   /* Assign filter taps */
00068   S->numStages = numStages;
00069 
00070   /* Assign coefficient pointer */
00071   S->pCoeffs = pCoeffs;
00072 
00073   /* Clear state buffer and size is always numStages */
00074   memset(pState, 0, (numStages) * sizeof(q15_t));
00075 
00076   /* Assign state pointer */
00077   S->pState = pState;
00078 
00079 }
00080 
00081 /**    
00082  * @} end of FIR_Lattice group    
00083  */