mbed official / mbed-dsp

CMSIS DSP library

Dependents:   KL25Z_FFT_Demo Hat_Board_v5_1 KL25Z_FFT_Demo_tony KL25Z_FFT_Demo_tony ... more

Fork of mbed-dsp by mbed official

cmsis_dsp/StatisticsFunctions/arm_rms_q15.c@3:7a284390b0ce, 2013-11-08 (annotated)

Committer:
mbed_official
Date:
Fri Nov 08 13:45:10 2013 +0000
Revision:
3:7a284390b0ce
Parent:
2:da51fb522205 
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_rms_q15.c
emilmont 1:fdd22bb7aa52 9 *
emilmont 2:da51fb522205 10 * Description: Root Mean Square of the elements of a Q15 vector.
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 * @addtogroup RMS
emilmont 1:fdd22bb7aa52 45 * @{
emilmont 1:fdd22bb7aa52 46 */
emilmont 1:fdd22bb7aa52 47
emilmont 1:fdd22bb7aa52 48 /**
emilmont 1:fdd22bb7aa52 49 * @brief Root Mean Square of the elements of a Q15 vector.
emilmont 1:fdd22bb7aa52 50 * @param[in] *pSrc points to the input vector
emilmont 1:fdd22bb7aa52 51 * @param[in] blockSize length of the input vector
emilmont 1:fdd22bb7aa52 52 * @param[out] *pResult rms value returned here
emilmont 1:fdd22bb7aa52 53 * @return none.
emilmont 1:fdd22bb7aa52 54 *
emilmont 1:fdd22bb7aa52 55 * @details
emilmont 1:fdd22bb7aa52 56 * <b>Scaling and Overflow Behavior:</b>
emilmont 1:fdd22bb7aa52 57 *
emilmont 1:fdd22bb7aa52 58 * \par
emilmont 1:fdd22bb7aa52 59 * The function is implemented using a 64-bit internal accumulator.
emilmont 1:fdd22bb7aa52 60 * The input is represented in 1.15 format.
emilmont 1:fdd22bb7aa52 61 * Intermediate multiplication yields a 2.30 format, and this
emilmont 1:fdd22bb7aa52 62 * result is added without saturation to a 64-bit accumulator in 34.30 format.
emilmont 1:fdd22bb7aa52 63 * With 33 guard bits in the accumulator, there is no risk of overflow, and the
emilmont 1:fdd22bb7aa52 64 * full precision of the intermediate multiplication is preserved.
emilmont 1:fdd22bb7aa52 65 * Finally, the 34.30 result is truncated to 34.15 format by discarding the lower
emilmont 1:fdd22bb7aa52 66 * 15 bits, and then saturated to yield a result in 1.15 format.
emilmont 1:fdd22bb7aa52 67 *
emilmont 1:fdd22bb7aa52 68 */
emilmont 1:fdd22bb7aa52 69
emilmont 1:fdd22bb7aa52 70 void arm_rms_q15(
emilmont 1:fdd22bb7aa52 71 q15_t * pSrc,
emilmont 1:fdd22bb7aa52 72 uint32_t blockSize,
emilmont 1:fdd22bb7aa52 73 q15_t * pResult)
emilmont 1:fdd22bb7aa52 74 {
emilmont 1:fdd22bb7aa52 75 q63_t sum = 0; /* accumulator */
emilmont 1:fdd22bb7aa52 76
mbed_official 3:7a284390b0ce 77 #ifndef ARM_MATH_CM0_FAMILY
emilmont 1:fdd22bb7aa52 78
emilmont 1:fdd22bb7aa52 79 /* Run the below code for Cortex-M4 and Cortex-M3 */
emilmont 1:fdd22bb7aa52 80
emilmont 1:fdd22bb7aa52 81 q31_t in; /* temporary variable to store the input value */
emilmont 1:fdd22bb7aa52 82 q15_t in1; /* temporary variable to store the input value */
emilmont 1:fdd22bb7aa52 83 uint32_t blkCnt; /* loop counter */
emilmont 1:fdd22bb7aa52 84
emilmont 1:fdd22bb7aa52 85 /* loop Unrolling */
emilmont 1:fdd22bb7aa52 86 blkCnt = blockSize >> 2u;
emilmont 1:fdd22bb7aa52 87
emilmont 1:fdd22bb7aa52 88 /* First part of the processing with loop unrolling. Compute 4 outputs at a time.
emilmont 1:fdd22bb7aa52 89 ** a second loop below computes the remaining 1 to 3 samples. */
emilmont 1:fdd22bb7aa52 90 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 91 {
emilmont 1:fdd22bb7aa52 92 /* C = (A[0] * A[0] + A[1] * A[1] + ... + A[blockSize-1] * A[blockSize-1]) */
emilmont 1:fdd22bb7aa52 93 /* Compute sum of the squares and then store the results in a temporary variable, sum */
emilmont 1:fdd22bb7aa52 94 in = *__SIMD32(pSrc)++;
emilmont 1:fdd22bb7aa52 95 sum = __SMLALD(in, in, sum);
emilmont 1:fdd22bb7aa52 96 in = *__SIMD32(pSrc)++;
emilmont 1:fdd22bb7aa52 97 sum = __SMLALD(in, in, sum);
emilmont 1:fdd22bb7aa52 98
emilmont 1:fdd22bb7aa52 99 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 100 blkCnt--;
emilmont 1:fdd22bb7aa52 101 }
emilmont 1:fdd22bb7aa52 102
emilmont 1:fdd22bb7aa52 103 /* If the blockSize is not a multiple of 4, compute any remaining output samples here.
emilmont 1:fdd22bb7aa52 104 ** No loop unrolling is used. */
emilmont 1:fdd22bb7aa52 105 blkCnt = blockSize % 0x4u;
emilmont 1:fdd22bb7aa52 106
emilmont 1:fdd22bb7aa52 107 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 108 {
emilmont 1:fdd22bb7aa52 109 /* C = (A[0] * A[0] + A[1] * A[1] + ... + A[blockSize-1] * A[blockSize-1]) */
emilmont 1:fdd22bb7aa52 110 /* Compute sum of the squares and then store the results in a temporary variable, sum */
emilmont 1:fdd22bb7aa52 111 in1 = *pSrc++;
emilmont 1:fdd22bb7aa52 112 sum = __SMLALD(in1, in1, sum);
emilmont 1:fdd22bb7aa52 113
emilmont 1:fdd22bb7aa52 114 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 115 blkCnt--;
emilmont 1:fdd22bb7aa52 116 }
emilmont 1:fdd22bb7aa52 117
emilmont 1:fdd22bb7aa52 118 /* Truncating and saturating the accumulator to 1.15 format */
mbed_official 3:7a284390b0ce 119 in = (q31_t)(sum >> 15);
emilmont 1:fdd22bb7aa52 120
mbed_official 3:7a284390b0ce 121 in1 = __SSAT(in / blockSize, 16);
emilmont 1:fdd22bb7aa52 122
emilmont 1:fdd22bb7aa52 123 /* Store the result in the destination */
emilmont 1:fdd22bb7aa52 124 arm_sqrt_q15(in1, pResult);
emilmont 1:fdd22bb7aa52 125
emilmont 1:fdd22bb7aa52 126 #else
emilmont 1:fdd22bb7aa52 127
emilmont 1:fdd22bb7aa52 128 /* Run the below code for Cortex-M0 */
emilmont 1:fdd22bb7aa52 129
emilmont 1:fdd22bb7aa52 130 q15_t in; /* temporary variable to store the input value */
mbed_official 3:7a284390b0ce 131 q31_t tmp; /* temporary variable to store the input value */
emilmont 1:fdd22bb7aa52 132 uint32_t blkCnt; /* loop counter */
emilmont 1:fdd22bb7aa52 133
emilmont 1:fdd22bb7aa52 134 /* Loop over blockSize number of values */
emilmont 1:fdd22bb7aa52 135 blkCnt = blockSize;
emilmont 1:fdd22bb7aa52 136
emilmont 1:fdd22bb7aa52 137 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 138 {
emilmont 1:fdd22bb7aa52 139 /* C = (A[0] * A[0] + A[1] * A[1] + ... + A[blockSize-1] * A[blockSize-1]) */
emilmont 1:fdd22bb7aa52 140 /* Compute sum of the squares and then store the results in a temporary variable, sum */
emilmont 1:fdd22bb7aa52 141 in = *pSrc++;
emilmont 1:fdd22bb7aa52 142 sum += ((q31_t) in * in);
emilmont 1:fdd22bb7aa52 143
emilmont 1:fdd22bb7aa52 144 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 145 blkCnt--;
emilmont 1:fdd22bb7aa52 146 }
emilmont 1:fdd22bb7aa52 147
emilmont 1:fdd22bb7aa52 148 /* Truncating and saturating the accumulator to 1.15 format */
mbed_official 3:7a284390b0ce 149 tmp = (q31_t)(sum >> 15);
emilmont 1:fdd22bb7aa52 150
mbed_official 3:7a284390b0ce 151 in = __SSAT(tmp / blockSize, 16);
emilmont 1:fdd22bb7aa52 152
emilmont 1:fdd22bb7aa52 153 /* Store the result in the destination */
emilmont 1:fdd22bb7aa52 154 arm_sqrt_q15(in, pResult);
emilmont 1:fdd22bb7aa52 155
mbed_official 3:7a284390b0ce 156 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
emilmont 1:fdd22bb7aa52 157
emilmont 1:fdd22bb7aa52 158 }
emilmont 1:fdd22bb7aa52 159
emilmont 1:fdd22bb7aa52 160 /**
emilmont 1:fdd22bb7aa52 161 * @} end of RMS group
emilmont 1:fdd22bb7aa52 162 */