git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/FilteringFunctions/arm_fir_decimate_init_f32.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_decimate_init_f32.c
   9 *
  10 * Description:  Floating-point FIR Decimator 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.7  2010/06/10
  30 *    Misra-C changes done
  31 * ---------------------------------------------------------------------------*/
  32
  33 #include "arm_math.h"
  34
  35 /**
  36  * @ingroup groupFilters
  37  */
  38
  39 /**
  40  * @addtogroup FIR_decimate
  41  * @{
  42  */
  43
  44 /**
  45  * @brief  Initialization function for the floating-point FIR decimator.
  46  * @param[in,out] *S points to an instance of the floating-point FIR decimator structure.
  47  * @param[in] numTaps  number of coefficients in the filter.
  48  * @param[in] M  decimation factor.
  49  * @param[in] *pCoeffs points to the filter coefficients.
  50  * @param[in] *pState points to the state buffer.
  51  * @param[in] blockSize number of input samples to process per call.
  52  * @return    The function returns ARM_MATH_SUCCESS if initialization was successful or ARM_MATH_LENGTH_ERROR if
  53  * <code>blockSize</code> is not a multiple of <code>M</code>.
  54  *
  55  * <b>Description:</b>
  56  * \par
  57  * <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order:
  58  * <pre>
  59  *    {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]}
  60  * </pre>
  61  * \par
  62  * <code>pState</code> points to the array of state variables.
  63  * <code>pState</code> is of length <code>numTaps+blockSize-1</code> words where <code>blockSize</code> is the number of input samples passed to <code>arm_fir_decimate_f32()</code>.
  64  * <code>M</code> is the decimation factor.
  65  */
  66
  67 arm_status arm_fir_decimate_init_f32(
  68   arm_fir_decimate_instance_f32 * S,
  69   uint16_t numTaps,
  70   uint8_t M,
  71   float32_t * pCoeffs,
  72   float32_t * pState,
  73   uint32_t blockSize)
  74 {
  75   arm_status status;
  76
  77   /* The size of the input block must be a multiple of the decimation factor */
  78   if((blockSize % M) != 0u)
  79   {
  80     /* Set status as ARM_MATH_LENGTH_ERROR */
  81     status = ARM_MATH_LENGTH_ERROR;
  82   }
  83   else
  84   {
  85     /* Assign filter taps */
  86     S->numTaps = numTaps;
  87
  88     /* Assign coefficient pointer */
  89     S->pCoeffs = pCoeffs;
  90
  91     /* Clear state buffer and size is always (blockSize + numTaps - 1) */
  92     memset(pState, 0, (numTaps + (blockSize - 1u)) * sizeof(float32_t));
  93
  94     /* Assign state pointer */
  95     S->pState = pState;
  96
  97     /* Assign Decimation Factor */
  98     S->M = M;
  99
 100     status = ARM_MATH_SUCCESS;
 101   }
 102
 103   return (status);
 104
 105 }
 106
 107 /**
 108  * @} end of FIR_decimate group
 109  */