git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/DSP_Lib/Source/FilteringFunctions/arm_lms_norm_init_q31.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_norm_init_q31.c
   9 *
  10 * Description:  Q31 NLMS 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 #include "arm_common_tables.h"
  35
  36 /**
  37  * @addtogroup LMS_NORM
  38  * @{
  39  */
  40
  41   /**
  42    * @brief Initialization function for Q31 normalized LMS filter.
  43    * @param[in] *S points to an instance of the Q31 normalized LMS filter structure.
  44    * @param[in] numTaps  number of filter coefficients.
  45    * @param[in] *pCoeffs points to coefficient buffer.
  46    * @param[in] *pState points to state buffer.
  47    * @param[in] mu step size that controls filter coefficient updates.
  48    * @param[in] blockSize number of samples to process.
  49    * @param[in] postShift bit shift applied to coefficients.
  50    * @return none.
  51  *
  52  * <b>Description:</b>
  53  * \par
  54  * <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order:
  55  * <pre>
  56  *    {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]}
  57  * </pre>
  58  * The initial filter coefficients serve as a starting point for the adaptive filter.
  59  * <code>pState</code> points to an array of length <code>numTaps+blockSize-1</code> samples,
  60  * where <code>blockSize</code> is the number of input samples processed by each call to <code>arm_lms_norm_q31()</code>.
  61  */
  62
  63 void arm_lms_norm_init_q31(
  64   arm_lms_norm_instance_q31 * S,
  65   uint16_t numTaps,
  66   q31_t * pCoeffs,
  67   q31_t * pState,
  68   q31_t mu,
  69   uint32_t blockSize,
  70   uint8_t postShift)
  71 {
  72   /* Assign filter taps */
  73   S->numTaps = numTaps;
  74
  75   /* Assign coefficient pointer */
  76   S->pCoeffs = pCoeffs;
  77
  78   /* Clear state buffer and size is always blockSize + numTaps - 1  */
  79   memset(pState, 0, (numTaps + (blockSize - 1u)) * sizeof(q31_t));
  80
  81   /* Assign post Shift value applied to coefficients */
  82   S->postShift = postShift;
  83
  84   /* Assign state pointer */
  85   S->pState = pState;
  86
  87   /* Assign Step size value */
  88   S->mu = mu;
  89
  90   /* Initialize reciprocal pointer table */
  91   S->recipTable = armRecipTableQ31;
  92
  93   /* Initialise Energy to zero */
  94   S->energy = 0;
  95
  96   /* Initialise x0 to zero */
  97   S->x0 = 0;
  98
  99 }
 100
 101 /**
 102  * @} end of LMS_NORM group
 103  */