git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/FilteringFunctions/arm_lms_init_q15.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_lms_init_q15.c
   9 *
  10 * Description:  Q15 LMS 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.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 LMS
  41  * @{
  42  */
  43
  44 /**
  45 * @brief Initialization function for the Q15 LMS filter.
  46 * @param[in] *S points to an instance of the Q15 LMS filter structure.
  47 * @param[in] numTaps  number of filter coefficients.
  48 * @param[in] *pCoeffs points to the coefficient buffer.
  49 * @param[in] *pState points to the state buffer.
  50 * @param[in] mu step size that controls filter coefficient updates.
  51 * @param[in] blockSize number of samples to process.
  52 * @param[in] postShift bit shift applied to coefficients.
  53 * @return    none.
  54 *
  55 * \par Description:
  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 * The initial filter coefficients serve as a starting point for the adaptive filter.
  61 * <code>pState</code> points to the array of state variables and size of array is
  62 * <code>numTaps+blockSize-1</code> samples, where <code>blockSize</code> is the number of
  63 * input samples processed by each call to <code>arm_lms_q15()</code>.
  64 */
  65
  66 void arm_lms_init_q15(
  67   arm_lms_instance_q15 * S,
  68   uint16_t numTaps,
  69   q15_t * pCoeffs,
  70   q15_t * pState,
  71   q15_t mu,
  72   uint32_t blockSize,
  73   uint32_t postShift)
  74 {
  75   /* Assign filter taps */
  76   S->numTaps = numTaps;
  77
  78   /* Assign coefficient pointer */
  79   S->pCoeffs = pCoeffs;
  80
  81   /* Clear state buffer and size is always blockSize + numTaps - 1 */
  82   memset(pState, 0, (numTaps + (blockSize - 1u)) * sizeof(q15_t));
  83
  84   /* Assign state pointer */
  85   S->pState = pState;
  86
  87   /* Assign Step size value */
  88   S->mu = mu;
  89
  90   /* Assign postShift value to be applied */
  91   S->postShift = postShift;
  92
  93 }
  94
  95 /**
  96  * @} end of LMS group
  97  */