diff options
Diffstat (limited to 'Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_fir_sparse_init_q15.c')
-rw-r--r-- | Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_fir_sparse_init_q15.c | 64 |
1 files changed, 31 insertions, 33 deletions
diff --git a/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_fir_sparse_init_q15.c b/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_fir_sparse_init_q15.c index 08c2d0e97..d07d61197 100644 --- a/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_fir_sparse_init_q15.c +++ b/Drivers/CMSIS/DSP/Source/FilteringFunctions/arm_fir_sparse_init_q15.c @@ -3,13 +3,13 @@ * Title: arm_fir_sparse_init_q15.c * Description: Q15 sparse FIR 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,43 +29,42 @@ #include "arm_math.h" /** - * @ingroup groupFilters + @ingroup groupFilters */ /** - * @addtogroup FIR_Sparse - * @{ + @addtogroup FIR_Sparse + @{ */ /** - * @brief Initialization function for the Q15 sparse FIR filter. - * @param[in,out] *S points to an instance of the Q15 sparse FIR structure. - * @param[in] numTaps number of nonzero coefficients in the filter. - * @param[in] *pCoeffs points to the array of filter coefficients. - * @param[in] *pState points to the state buffer. - * @param[in] *pTapDelay points to the array of offset times. - * @param[in] maxDelay maximum offset time supported. - * @param[in] blockSize number of samples that will be processed per block. - * @return none - * - * <b>Description:</b> - * \par - * <code>pCoeffs</code> holds the filter coefficients and has length <code>numTaps</code>. - * <code>pState</code> holds the filter's state variables and must be of length - * <code>maxDelay + blockSize</code>, where <code>maxDelay</code> - * is the maximum number of delay line values. - * <code>blockSize</code> is the - * number of words processed by <code>arm_fir_sparse_q15()</code> function. + @brief Initialization function for the Q15 sparse FIR filter. + @param[in,out] S points to an instance of the Q15 sparse FIR structure + @param[in] numTaps number of nonzero coefficients in the filter + @param[in] pCoeffs points to the array of filter coefficients + @param[in] pState points to the state buffer + @param[in] pTapDelay points to the array of offset times + @param[in] maxDelay maximum offset time supported + @param[in] blockSize number of samples that will be processed per block + @return none + + @par Details + <code>pCoeffs</code> holds the filter coefficients and has length <code>numTaps</code>. + <code>pState</code> holds the filter's state variables and must be of length + <code>maxDelay + blockSize</code>, where <code>maxDelay</code> + is the maximum number of delay line values. + <code>blockSize</code> is the + number of words processed by <code>arm_fir_sparse_q15()</code> function. */ void arm_fir_sparse_init_q15( - arm_fir_sparse_instance_q15 * S, - uint16_t numTaps, - q15_t * pCoeffs, - q15_t * pState, - int32_t * pTapDelay, - uint16_t maxDelay, - uint32_t blockSize) + arm_fir_sparse_instance_q15 * S, + uint16_t numTaps, + const q15_t * pCoeffs, + q15_t * pState, + int32_t * pTapDelay, + uint16_t maxDelay, + uint32_t blockSize) { /* Assign filter taps */ S->numTaps = numTaps; @@ -87,9 +86,8 @@ void arm_fir_sparse_init_q15( /* Assign state pointer */ S->pState = pState; - } /** - * @} end of FIR_Sparse group + @} end of FIR_Sparse group */ |