git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/FilteringFunctions/arm_fir_init_q7.c

   1 /* ----------------------------------------------------------------------
   2 * Copyright (C) 2010 ARM Limited. All rights reserved.
   3 *
   4 * $Date:        15. July 2011
   5 * $Revision:    V1.0.10
   6 *
   7 * Project:          CMSIS DSP Library
   8 * Title:        arm_fir_init_q7.c
   9 *
  10 * Description:  Q7 FIR filter initialization function.
  11 *
  12 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
  13 *
  14 * Version 1.0.10 2011/7/15
  15 *    Big Endian support added and Merged M0 and M3/M4 Source code.
  16 *
  17 * Version 1.0.3 2010/11/29
  18 *    Re-organized the CMSIS folders and updated documentation.
  19 *
  20 * Version 1.0.2 2010/11/11
  21 *    Documentation updated.
  22 *
  23 * Version 1.0.1 2010/10/05
  24 *    Production release and review comments incorporated.
  25 *
  26 * Version 1.0.0 2010/09/20
  27 *    Production release and review comments incorporated.
  28 *
  29 * Version 0.0.5  2010/04/26
  30 *        incorporated review comments and updated with latest CMSIS layer
  31 *
  32 * Version 0.0.3  2010/03/10
  33 *    Initial version
  34 * ------------------------------------------------------------------- */
  35
  36 #include "arm_math.h"
  37
  38 /**
  39  * @ingroup groupFilters
  40  */
  41
  42 /**
  43  * @addtogroup FIR
  44  * @{
  45  */
  46 /**
  47  * @param[in,out] *S points to an instance of the Q7 FIR filter structure.
  48  * @param[in]     numTaps  Number of filter coefficients in the filter.
  49  * @param[in]     *pCoeffs points to the filter coefficients buffer.
  50  * @param[in]     *pState points to the state buffer.
  51  * @param[in]     blockSize number of samples that are processed per call.
  52  * @return        none
  53  *
  54  * <b>Description:</b>
  55  * \par
  56  * <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order:
  57  * <pre>
  58  *    {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]}
  59  * </pre>
  60  * \par
  61  * <code>pState</code> points to the array of state variables.
  62  * <code>pState</code> is of length <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of input samples processed by each call to <code>arm_fir_q7()</code>.
  63  */
  64
  65 void arm_fir_init_q7(
  66   arm_fir_instance_q7 * S,
  67   uint16_t numTaps,
  68   q7_t * pCoeffs,
  69   q7_t * pState,
  70   uint32_t blockSize)
  71 {
  72
  73   /* Assign filter taps */
  74   S->numTaps = numTaps;
  75
  76   /* Assign coefficient pointer */
  77   S->pCoeffs = pCoeffs;
  78
  79   /* Clear the state buffer.  The size is always (blockSize + numTaps - 1) */
  80   memset(pState, 0, (numTaps + (blockSize - 1u)) * sizeof(q7_t));
  81
  82   /* Assign state pointer */
  83   S->pState = pState;
  84
  85 }
  86
  87 /**
  88  * @} end of FIR group
  89  */