diff options
Diffstat (limited to 'Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_lms_init_q31.c')
| -rw-r--r-- | Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_lms_init_q31.c | 57 |
1 files changed, 28 insertions, 29 deletions
diff --git a/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_lms_init_q31.c b/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_lms_init_q31.c index 5859c8433..3410b9f21 100644 --- a/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_lms_init_q31.c +++ b/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_lms_init_q31.c @@ -3,13 +3,13 @@ * Title: arm_lms_init_q31.c * Description: Q31 LMS filter initialization function * - * $Date: 27. January 2017 - * $Revision: V.1.5.1 + * $Date: 18. March 2019 + * $Revision: V1.6.0 * * Target Processor: Cortex-M cores * -------------------------------------------------------------------- */ /* - * Copyright (C) 2010-2017 ARM Limited or its affiliates. All rights reserved. + * Copyright (C) 2010-2019 ARM Limited or its affiliates. All rights reserved. * * SPDX-License-Identifier: Apache-2.0 * @@ -29,34 +29,34 @@ #include "arm_math.h" /** - * @ingroup groupFilters + @ingroup groupFilters */ /** - * @addtogroup LMS - * @{ + @addtogroup LMS + @{ */ - /** - * @brief Initialization function for Q31 LMS filter. - * @param[in] *S points to an instance of the Q31 LMS filter structure. - * @param[in] numTaps number of filter coefficients. - * @param[in] *pCoeffs points to coefficient buffer. - * @param[in] *pState points to state buffer. - * @param[in] mu step size that controls filter coefficient updates. - * @param[in] blockSize number of samples to process. - * @param[in] postShift bit shift applied to coefficients. - * @return none. - * - * \par Description: - * <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: - * <pre> - * {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} - * </pre> - * The initial filter coefficients serve as a starting point for the adaptive filter. - * <code>pState</code> points to an array 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_lms_q31()</code>. +/** + @brief Initialization function for Q31 LMS filter. + @param[in] S points to an instance of the Q31 LMS filter structure + @param[in] numTaps number of filter coefficients + @param[in] pCoeffs points to coefficient buffer + @param[in] pState points to state buffer + @param[in] mu step size that controls filter coefficient updates + @param[in] blockSize number of samples to process + @param[in] postShift bit shift applied to coefficients + @return none + + @par Details + <code>pCoeffs</code> points to the array of filter coefficients stored in time reversed order: + <pre> + {b[numTaps-1], b[numTaps-2], b[N-2], ..., b[1], b[0]} + </pre> + The initial filter coefficients serve as a starting point for the adaptive filter. + <code>pState</code> points to an array 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_lms_q31()</code>. */ void arm_lms_init_q31( @@ -75,7 +75,7 @@ void arm_lms_init_q31( S->pCoeffs = pCoeffs; /* Clear state buffer and size is always blockSize + numTaps - 1 */ - memset(pState, 0, ((uint32_t) numTaps + (blockSize - 1U)) * sizeof(q31_t)); + memset(pState, 0, (numTaps + (blockSize - 1U)) * sizeof(q31_t)); /* Assign state pointer */ S->pState = pState; @@ -85,9 +85,8 @@ void arm_lms_init_q31( /* Assign postShift value to be applied */ S->postShift = postShift; - } /** - * @} end of LMS group + @} end of LMS group */ |