CMSIS DSP library

Dependents:   performance_timer Surfboard_ gps2rtty Capstone ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Committer:
mbed_official
Date:
Fri Nov 08 13:45:10 2013 +0000
Revision:
3:7a284390b0ce
Parent:
2:da51fb522205
Child:
5:3762170b6d4d
Synchronized with git revision e69956aba2f68a2a26ac26b051f8d349deaa1ce8

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 1:fdd22bb7aa52 1 /* ----------------------------------------------------------------------
mbed_official 3:7a284390b0ce 2 * Copyright (C) 2010-2013 ARM Limited. All rights reserved.
emilmont 1:fdd22bb7aa52 3 *
mbed_official 3:7a284390b0ce 4 * $Date: 17. January 2013
mbed_official 3:7a284390b0ce 5 * $Revision: V1.4.1
emilmont 1:fdd22bb7aa52 6 *
emilmont 2:da51fb522205 7 * Project: CMSIS DSP Library
emilmont 2:da51fb522205 8 * Title: arm_fir_decimate_q31.c
emilmont 1:fdd22bb7aa52 9 *
emilmont 2:da51fb522205 10 * Description: Q31 FIR Decimator.
emilmont 1:fdd22bb7aa52 11 *
emilmont 1:fdd22bb7aa52 12 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
emilmont 1:fdd22bb7aa52 13 *
mbed_official 3:7a284390b0ce 14 * Redistribution and use in source and binary forms, with or without
mbed_official 3:7a284390b0ce 15 * modification, are permitted provided that the following conditions
mbed_official 3:7a284390b0ce 16 * are met:
mbed_official 3:7a284390b0ce 17 * - Redistributions of source code must retain the above copyright
mbed_official 3:7a284390b0ce 18 * notice, this list of conditions and the following disclaimer.
mbed_official 3:7a284390b0ce 19 * - Redistributions in binary form must reproduce the above copyright
mbed_official 3:7a284390b0ce 20 * notice, this list of conditions and the following disclaimer in
mbed_official 3:7a284390b0ce 21 * the documentation and/or other materials provided with the
mbed_official 3:7a284390b0ce 22 * distribution.
mbed_official 3:7a284390b0ce 23 * - Neither the name of ARM LIMITED nor the names of its contributors
mbed_official 3:7a284390b0ce 24 * may be used to endorse or promote products derived from this
mbed_official 3:7a284390b0ce 25 * software without specific prior written permission.
mbed_official 3:7a284390b0ce 26 *
mbed_official 3:7a284390b0ce 27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
mbed_official 3:7a284390b0ce 28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
mbed_official 3:7a284390b0ce 29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
mbed_official 3:7a284390b0ce 30 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
mbed_official 3:7a284390b0ce 31 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
mbed_official 3:7a284390b0ce 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
mbed_official 3:7a284390b0ce 33 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
mbed_official 3:7a284390b0ce 34 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 3:7a284390b0ce 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
mbed_official 3:7a284390b0ce 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
mbed_official 3:7a284390b0ce 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
mbed_official 3:7a284390b0ce 38 * POSSIBILITY OF SUCH DAMAGE.
emilmont 1:fdd22bb7aa52 39 * -------------------------------------------------------------------- */
emilmont 1:fdd22bb7aa52 40
emilmont 1:fdd22bb7aa52 41 #include "arm_math.h"
emilmont 1:fdd22bb7aa52 42
emilmont 1:fdd22bb7aa52 43 /**
emilmont 1:fdd22bb7aa52 44 * @ingroup groupFilters
emilmont 1:fdd22bb7aa52 45 */
emilmont 1:fdd22bb7aa52 46
emilmont 1:fdd22bb7aa52 47 /**
emilmont 1:fdd22bb7aa52 48 * @addtogroup FIR_decimate
emilmont 1:fdd22bb7aa52 49 * @{
emilmont 1:fdd22bb7aa52 50 */
emilmont 1:fdd22bb7aa52 51
emilmont 1:fdd22bb7aa52 52 /**
emilmont 1:fdd22bb7aa52 53 * @brief Processing function for the Q31 FIR decimator.
emilmont 1:fdd22bb7aa52 54 * @param[in] *S points to an instance of the Q31 FIR decimator structure.
emilmont 1:fdd22bb7aa52 55 * @param[in] *pSrc points to the block of input data.
emilmont 1:fdd22bb7aa52 56 * @param[out] *pDst points to the block of output data
emilmont 1:fdd22bb7aa52 57 * @param[in] blockSize number of input samples to process per call.
emilmont 1:fdd22bb7aa52 58 * @return none
emilmont 1:fdd22bb7aa52 59 *
emilmont 1:fdd22bb7aa52 60 * <b>Scaling and Overflow Behavior:</b>
emilmont 1:fdd22bb7aa52 61 * \par
emilmont 1:fdd22bb7aa52 62 * The function is implemented using an internal 64-bit accumulator.
emilmont 1:fdd22bb7aa52 63 * The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit.
emilmont 1:fdd22bb7aa52 64 * Thus, if the accumulator result overflows it wraps around rather than clip.
emilmont 1:fdd22bb7aa52 65 * In order to avoid overflows completely the input signal must be scaled down by log2(numTaps) bits (where log2 is read as log to the base 2).
emilmont 1:fdd22bb7aa52 66 * After all multiply-accumulates are performed, the 2.62 accumulator is truncated to 1.32 format and then saturated to 1.31 format.
emilmont 1:fdd22bb7aa52 67 *
emilmont 1:fdd22bb7aa52 68 * \par
emilmont 1:fdd22bb7aa52 69 * Refer to the function <code>arm_fir_decimate_fast_q31()</code> for a faster but less precise implementation of this function for Cortex-M3 and Cortex-M4.
emilmont 1:fdd22bb7aa52 70 */
emilmont 1:fdd22bb7aa52 71
emilmont 1:fdd22bb7aa52 72 void arm_fir_decimate_q31(
emilmont 1:fdd22bb7aa52 73 const arm_fir_decimate_instance_q31 * S,
emilmont 1:fdd22bb7aa52 74 q31_t * pSrc,
emilmont 1:fdd22bb7aa52 75 q31_t * pDst,
emilmont 1:fdd22bb7aa52 76 uint32_t blockSize)
emilmont 1:fdd22bb7aa52 77 {
emilmont 1:fdd22bb7aa52 78 q31_t *pState = S->pState; /* State pointer */
emilmont 1:fdd22bb7aa52 79 q31_t *pCoeffs = S->pCoeffs; /* Coefficient pointer */
emilmont 1:fdd22bb7aa52 80 q31_t *pStateCurnt; /* Points to the current sample of the state */
emilmont 1:fdd22bb7aa52 81 q31_t x0, c0; /* Temporary variables to hold state and coefficient values */
emilmont 1:fdd22bb7aa52 82 q31_t *px; /* Temporary pointers for state buffer */
emilmont 1:fdd22bb7aa52 83 q31_t *pb; /* Temporary pointers for coefficient buffer */
emilmont 1:fdd22bb7aa52 84 q63_t sum0; /* Accumulator */
emilmont 1:fdd22bb7aa52 85 uint32_t numTaps = S->numTaps; /* Number of taps */
emilmont 1:fdd22bb7aa52 86 uint32_t i, tapCnt, blkCnt, outBlockSize = blockSize / S->M; /* Loop counters */
emilmont 1:fdd22bb7aa52 87
emilmont 1:fdd22bb7aa52 88
mbed_official 3:7a284390b0ce 89 #ifndef ARM_MATH_CM0_FAMILY
emilmont 1:fdd22bb7aa52 90
emilmont 1:fdd22bb7aa52 91 /* Run the below code for Cortex-M4 and Cortex-M3 */
emilmont 1:fdd22bb7aa52 92
emilmont 1:fdd22bb7aa52 93 /* S->pState buffer contains previous frame (numTaps - 1) samples */
emilmont 1:fdd22bb7aa52 94 /* pStateCurnt points to the location where the new input data should be written */
emilmont 1:fdd22bb7aa52 95 pStateCurnt = S->pState + (numTaps - 1u);
emilmont 1:fdd22bb7aa52 96
emilmont 1:fdd22bb7aa52 97 /* Total number of output samples to be computed */
emilmont 1:fdd22bb7aa52 98 blkCnt = outBlockSize;
emilmont 1:fdd22bb7aa52 99
emilmont 1:fdd22bb7aa52 100 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 101 {
emilmont 1:fdd22bb7aa52 102 /* Copy decimation factor number of new input samples into the state buffer */
emilmont 1:fdd22bb7aa52 103 i = S->M;
emilmont 1:fdd22bb7aa52 104
emilmont 1:fdd22bb7aa52 105 do
emilmont 1:fdd22bb7aa52 106 {
emilmont 1:fdd22bb7aa52 107 *pStateCurnt++ = *pSrc++;
emilmont 1:fdd22bb7aa52 108
emilmont 1:fdd22bb7aa52 109 } while(--i);
emilmont 1:fdd22bb7aa52 110
emilmont 1:fdd22bb7aa52 111 /* Set accumulator to zero */
emilmont 1:fdd22bb7aa52 112 sum0 = 0;
emilmont 1:fdd22bb7aa52 113
emilmont 1:fdd22bb7aa52 114 /* Initialize state pointer */
emilmont 1:fdd22bb7aa52 115 px = pState;
emilmont 1:fdd22bb7aa52 116
emilmont 1:fdd22bb7aa52 117 /* Initialize coeff pointer */
emilmont 1:fdd22bb7aa52 118 pb = pCoeffs;
emilmont 1:fdd22bb7aa52 119
emilmont 1:fdd22bb7aa52 120 /* Loop unrolling. Process 4 taps at a time. */
emilmont 1:fdd22bb7aa52 121 tapCnt = numTaps >> 2;
emilmont 1:fdd22bb7aa52 122
emilmont 1:fdd22bb7aa52 123 /* Loop over the number of taps. Unroll by a factor of 4.
emilmont 1:fdd22bb7aa52 124 ** Repeat until we've computed numTaps-4 coefficients. */
emilmont 1:fdd22bb7aa52 125 while(tapCnt > 0u)
emilmont 1:fdd22bb7aa52 126 {
emilmont 1:fdd22bb7aa52 127 /* Read the b[numTaps-1] coefficient */
emilmont 1:fdd22bb7aa52 128 c0 = *(pb++);
emilmont 1:fdd22bb7aa52 129
emilmont 1:fdd22bb7aa52 130 /* Read x[n-numTaps-1] sample */
emilmont 1:fdd22bb7aa52 131 x0 = *(px++);
emilmont 1:fdd22bb7aa52 132
emilmont 1:fdd22bb7aa52 133 /* Perform the multiply-accumulate */
emilmont 1:fdd22bb7aa52 134 sum0 += (q63_t) x0 *c0;
emilmont 1:fdd22bb7aa52 135
emilmont 1:fdd22bb7aa52 136 /* Read the b[numTaps-2] coefficient */
emilmont 1:fdd22bb7aa52 137 c0 = *(pb++);
emilmont 1:fdd22bb7aa52 138
emilmont 1:fdd22bb7aa52 139 /* Read x[n-numTaps-2] sample */
emilmont 1:fdd22bb7aa52 140 x0 = *(px++);
emilmont 1:fdd22bb7aa52 141
emilmont 1:fdd22bb7aa52 142 /* Perform the multiply-accumulate */
emilmont 1:fdd22bb7aa52 143 sum0 += (q63_t) x0 *c0;
emilmont 1:fdd22bb7aa52 144
emilmont 1:fdd22bb7aa52 145 /* Read the b[numTaps-3] coefficient */
emilmont 1:fdd22bb7aa52 146 c0 = *(pb++);
emilmont 1:fdd22bb7aa52 147
emilmont 1:fdd22bb7aa52 148 /* Read x[n-numTaps-3] sample */
emilmont 1:fdd22bb7aa52 149 x0 = *(px++);
emilmont 1:fdd22bb7aa52 150
emilmont 1:fdd22bb7aa52 151 /* Perform the multiply-accumulate */
emilmont 1:fdd22bb7aa52 152 sum0 += (q63_t) x0 *c0;
emilmont 1:fdd22bb7aa52 153
emilmont 1:fdd22bb7aa52 154 /* Read the b[numTaps-4] coefficient */
emilmont 1:fdd22bb7aa52 155 c0 = *(pb++);
emilmont 1:fdd22bb7aa52 156
emilmont 1:fdd22bb7aa52 157 /* Read x[n-numTaps-4] sample */
emilmont 1:fdd22bb7aa52 158 x0 = *(px++);
emilmont 1:fdd22bb7aa52 159
emilmont 1:fdd22bb7aa52 160 /* Perform the multiply-accumulate */
emilmont 1:fdd22bb7aa52 161 sum0 += (q63_t) x0 *c0;
emilmont 1:fdd22bb7aa52 162
emilmont 1:fdd22bb7aa52 163 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 164 tapCnt--;
emilmont 1:fdd22bb7aa52 165 }
emilmont 1:fdd22bb7aa52 166
emilmont 1:fdd22bb7aa52 167 /* If the filter length is not a multiple of 4, compute the remaining filter taps */
emilmont 1:fdd22bb7aa52 168 tapCnt = numTaps % 0x4u;
emilmont 1:fdd22bb7aa52 169
emilmont 1:fdd22bb7aa52 170 while(tapCnt > 0u)
emilmont 1:fdd22bb7aa52 171 {
emilmont 1:fdd22bb7aa52 172 /* Read coefficients */
emilmont 1:fdd22bb7aa52 173 c0 = *(pb++);
emilmont 1:fdd22bb7aa52 174
emilmont 1:fdd22bb7aa52 175 /* Fetch 1 state variable */
emilmont 1:fdd22bb7aa52 176 x0 = *(px++);
emilmont 1:fdd22bb7aa52 177
emilmont 1:fdd22bb7aa52 178 /* Perform the multiply-accumulate */
emilmont 1:fdd22bb7aa52 179 sum0 += (q63_t) x0 *c0;
emilmont 1:fdd22bb7aa52 180
emilmont 1:fdd22bb7aa52 181 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 182 tapCnt--;
emilmont 1:fdd22bb7aa52 183 }
emilmont 1:fdd22bb7aa52 184
emilmont 1:fdd22bb7aa52 185 /* Advance the state pointer by the decimation factor
emilmont 1:fdd22bb7aa52 186 * to process the next group of decimation factor number samples */
emilmont 1:fdd22bb7aa52 187 pState = pState + S->M;
emilmont 1:fdd22bb7aa52 188
emilmont 1:fdd22bb7aa52 189 /* The result is in the accumulator, store in the destination buffer. */
emilmont 1:fdd22bb7aa52 190 *pDst++ = (q31_t) (sum0 >> 31);
emilmont 1:fdd22bb7aa52 191
emilmont 1:fdd22bb7aa52 192 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 193 blkCnt--;
emilmont 1:fdd22bb7aa52 194 }
emilmont 1:fdd22bb7aa52 195
emilmont 1:fdd22bb7aa52 196 /* Processing is complete.
emilmont 1:fdd22bb7aa52 197 ** Now copy the last numTaps - 1 samples to the satrt of the state buffer.
emilmont 1:fdd22bb7aa52 198 ** This prepares the state buffer for the next function call. */
emilmont 1:fdd22bb7aa52 199
emilmont 1:fdd22bb7aa52 200 /* Points to the start of the state buffer */
emilmont 1:fdd22bb7aa52 201 pStateCurnt = S->pState;
emilmont 1:fdd22bb7aa52 202
emilmont 1:fdd22bb7aa52 203 i = (numTaps - 1u) >> 2u;
emilmont 1:fdd22bb7aa52 204
emilmont 1:fdd22bb7aa52 205 /* copy data */
emilmont 1:fdd22bb7aa52 206 while(i > 0u)
emilmont 1:fdd22bb7aa52 207 {
emilmont 1:fdd22bb7aa52 208 *pStateCurnt++ = *pState++;
emilmont 1:fdd22bb7aa52 209 *pStateCurnt++ = *pState++;
emilmont 1:fdd22bb7aa52 210 *pStateCurnt++ = *pState++;
emilmont 1:fdd22bb7aa52 211 *pStateCurnt++ = *pState++;
emilmont 1:fdd22bb7aa52 212
emilmont 1:fdd22bb7aa52 213 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 214 i--;
emilmont 1:fdd22bb7aa52 215 }
emilmont 1:fdd22bb7aa52 216
emilmont 1:fdd22bb7aa52 217 i = (numTaps - 1u) % 0x04u;
emilmont 1:fdd22bb7aa52 218
emilmont 1:fdd22bb7aa52 219 /* copy data */
emilmont 1:fdd22bb7aa52 220 while(i > 0u)
emilmont 1:fdd22bb7aa52 221 {
emilmont 1:fdd22bb7aa52 222 *pStateCurnt++ = *pState++;
emilmont 1:fdd22bb7aa52 223
emilmont 1:fdd22bb7aa52 224 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 225 i--;
emilmont 1:fdd22bb7aa52 226 }
emilmont 1:fdd22bb7aa52 227
emilmont 1:fdd22bb7aa52 228 #else
emilmont 1:fdd22bb7aa52 229
emilmont 1:fdd22bb7aa52 230 /* Run the below code for Cortex-M0 */
emilmont 1:fdd22bb7aa52 231
emilmont 1:fdd22bb7aa52 232 /* S->pState buffer contains previous frame (numTaps - 1) samples */
emilmont 1:fdd22bb7aa52 233 /* pStateCurnt points to the location where the new input data should be written */
emilmont 1:fdd22bb7aa52 234 pStateCurnt = S->pState + (numTaps - 1u);
emilmont 1:fdd22bb7aa52 235
emilmont 1:fdd22bb7aa52 236 /* Total number of output samples to be computed */
emilmont 1:fdd22bb7aa52 237 blkCnt = outBlockSize;
emilmont 1:fdd22bb7aa52 238
emilmont 1:fdd22bb7aa52 239 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 240 {
emilmont 1:fdd22bb7aa52 241 /* Copy decimation factor number of new input samples into the state buffer */
emilmont 1:fdd22bb7aa52 242 i = S->M;
emilmont 1:fdd22bb7aa52 243
emilmont 1:fdd22bb7aa52 244 do
emilmont 1:fdd22bb7aa52 245 {
emilmont 1:fdd22bb7aa52 246 *pStateCurnt++ = *pSrc++;
emilmont 1:fdd22bb7aa52 247
emilmont 1:fdd22bb7aa52 248 } while(--i);
emilmont 1:fdd22bb7aa52 249
emilmont 1:fdd22bb7aa52 250 /* Set accumulator to zero */
emilmont 1:fdd22bb7aa52 251 sum0 = 0;
emilmont 1:fdd22bb7aa52 252
emilmont 1:fdd22bb7aa52 253 /* Initialize state pointer */
emilmont 1:fdd22bb7aa52 254 px = pState;
emilmont 1:fdd22bb7aa52 255
emilmont 1:fdd22bb7aa52 256 /* Initialize coeff pointer */
emilmont 1:fdd22bb7aa52 257 pb = pCoeffs;
emilmont 1:fdd22bb7aa52 258
emilmont 1:fdd22bb7aa52 259 tapCnt = numTaps;
emilmont 1:fdd22bb7aa52 260
emilmont 1:fdd22bb7aa52 261 while(tapCnt > 0u)
emilmont 1:fdd22bb7aa52 262 {
emilmont 1:fdd22bb7aa52 263 /* Read coefficients */
emilmont 1:fdd22bb7aa52 264 c0 = *pb++;
emilmont 1:fdd22bb7aa52 265
emilmont 1:fdd22bb7aa52 266 /* Fetch 1 state variable */
emilmont 1:fdd22bb7aa52 267 x0 = *px++;
emilmont 1:fdd22bb7aa52 268
emilmont 1:fdd22bb7aa52 269 /* Perform the multiply-accumulate */
emilmont 1:fdd22bb7aa52 270 sum0 += (q63_t) x0 *c0;
emilmont 1:fdd22bb7aa52 271
emilmont 1:fdd22bb7aa52 272 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 273 tapCnt--;
emilmont 1:fdd22bb7aa52 274 }
emilmont 1:fdd22bb7aa52 275
emilmont 1:fdd22bb7aa52 276 /* Advance the state pointer by the decimation factor
emilmont 1:fdd22bb7aa52 277 * to process the next group of decimation factor number samples */
emilmont 1:fdd22bb7aa52 278 pState = pState + S->M;
emilmont 1:fdd22bb7aa52 279
emilmont 1:fdd22bb7aa52 280 /* The result is in the accumulator, store in the destination buffer. */
emilmont 1:fdd22bb7aa52 281 *pDst++ = (q31_t) (sum0 >> 31);
emilmont 1:fdd22bb7aa52 282
emilmont 1:fdd22bb7aa52 283 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 284 blkCnt--;
emilmont 1:fdd22bb7aa52 285 }
emilmont 1:fdd22bb7aa52 286
emilmont 1:fdd22bb7aa52 287 /* Processing is complete.
emilmont 1:fdd22bb7aa52 288 ** Now copy the last numTaps - 1 samples to the start of the state buffer.
emilmont 1:fdd22bb7aa52 289 ** This prepares the state buffer for the next function call. */
emilmont 1:fdd22bb7aa52 290
emilmont 1:fdd22bb7aa52 291 /* Points to the start of the state buffer */
emilmont 1:fdd22bb7aa52 292 pStateCurnt = S->pState;
emilmont 1:fdd22bb7aa52 293
emilmont 1:fdd22bb7aa52 294 i = numTaps - 1u;
emilmont 1:fdd22bb7aa52 295
emilmont 1:fdd22bb7aa52 296 /* copy data */
emilmont 1:fdd22bb7aa52 297 while(i > 0u)
emilmont 1:fdd22bb7aa52 298 {
emilmont 1:fdd22bb7aa52 299 *pStateCurnt++ = *pState++;
emilmont 1:fdd22bb7aa52 300
emilmont 1:fdd22bb7aa52 301 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 302 i--;
emilmont 1:fdd22bb7aa52 303 }
emilmont 1:fdd22bb7aa52 304
mbed_official 3:7a284390b0ce 305 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
emilmont 1:fdd22bb7aa52 306
emilmont 1:fdd22bb7aa52 307 }
emilmont 1:fdd22bb7aa52 308
emilmont 1:fdd22bb7aa52 309 /**
emilmont 1:fdd22bb7aa52 310 * @} end of FIR_decimate group
emilmont 1:fdd22bb7aa52 311 */