mbed official / mbed-dsp

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.

cmsis_dsp/BasicMathFunctions/arm_scale_q7.c@5:3762170b6d4d, 2015-11-20 (annotated)

Committer:
mbed_official
Date:
Fri Nov 20 08:45:18 2015 +0000
Revision:
5:3762170b6d4d
Parent:
3:7a284390b0ce 
Synchronized with git revision 2eb940b9a73af188d3004a2575fdfbb05febe62b



Full URL: https://github.com/mbedmicro/mbed/commit/2eb940b9a73af188d3004a2575fdfbb05febe62b/



Added option to build rpc library. closes #1426

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 1:fdd22bb7aa52 1 /* ----------------------------------------------------------------------
mbed_official 5:3762170b6d4d 2 * Copyright (C) 2010-2014 ARM Limited. All rights reserved.
emilmont 1:fdd22bb7aa52 3 *
mbed_official 5:3762170b6d4d 4 * $Date: 19. March 2015
mbed_official 5:3762170b6d4d 5 * $Revision: V.1.4.5
emilmont 1:fdd22bb7aa52 6 *
emilmont 2:da51fb522205 7 * Project: CMSIS DSP Library
emilmont 2:da51fb522205 8 * Title: arm_scale_q7.c
emilmont 1:fdd22bb7aa52 9 *
emilmont 2:da51fb522205 10 * Description: Multiplies a Q7 vector by a scalar.
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 groupMath
emilmont 1:fdd22bb7aa52 45 */
emilmont 1:fdd22bb7aa52 46
emilmont 1:fdd22bb7aa52 47 /**
emilmont 1:fdd22bb7aa52 48 * @addtogroup scale
emilmont 1:fdd22bb7aa52 49 * @{
emilmont 1:fdd22bb7aa52 50 */
emilmont 1:fdd22bb7aa52 51
emilmont 1:fdd22bb7aa52 52 /**
emilmont 1:fdd22bb7aa52 53 * @brief Multiplies a Q7 vector by a scalar.
emilmont 1:fdd22bb7aa52 54 * @param[in] *pSrc points to the input vector
emilmont 1:fdd22bb7aa52 55 * @param[in] scaleFract fractional portion of the scale value
emilmont 1:fdd22bb7aa52 56 * @param[in] shift number of bits to shift the result by
emilmont 1:fdd22bb7aa52 57 * @param[out] *pDst points to the output vector
emilmont 1:fdd22bb7aa52 58 * @param[in] blockSize number of samples in the vector
emilmont 1:fdd22bb7aa52 59 * @return none.
emilmont 1:fdd22bb7aa52 60 *
emilmont 1:fdd22bb7aa52 61 * <b>Scaling and Overflow Behavior:</b>
emilmont 1:fdd22bb7aa52 62 * \par
emilmont 1:fdd22bb7aa52 63 * The input data <code>*pSrc</code> and <code>scaleFract</code> are in 1.7 format.
emilmont 1:fdd22bb7aa52 64 * These are multiplied to yield a 2.14 intermediate result and this is shifted with saturation to 1.7 format.
emilmont 1:fdd22bb7aa52 65 */
emilmont 1:fdd22bb7aa52 66
emilmont 1:fdd22bb7aa52 67 void arm_scale_q7(
emilmont 1:fdd22bb7aa52 68 q7_t * pSrc,
emilmont 1:fdd22bb7aa52 69 q7_t scaleFract,
emilmont 1:fdd22bb7aa52 70 int8_t shift,
emilmont 1:fdd22bb7aa52 71 q7_t * pDst,
emilmont 1:fdd22bb7aa52 72 uint32_t blockSize)
emilmont 1:fdd22bb7aa52 73 {
emilmont 1:fdd22bb7aa52 74 int8_t kShift = 7 - shift; /* shift to apply after scaling */
emilmont 1:fdd22bb7aa52 75 uint32_t blkCnt; /* loop counter */
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 q7_t in1, in2, in3, in4, out1, out2, out3, out4; /* Temporary variables to store input & output */
emilmont 1:fdd22bb7aa52 81
emilmont 1:fdd22bb7aa52 82
emilmont 1:fdd22bb7aa52 83 /*loop Unrolling */
emilmont 1:fdd22bb7aa52 84 blkCnt = blockSize >> 2u;
emilmont 1:fdd22bb7aa52 85
emilmont 1:fdd22bb7aa52 86
emilmont 1:fdd22bb7aa52 87 /* First part of the processing with loop unrolling. Compute 4 outputs at a time.
emilmont 1:fdd22bb7aa52 88 ** a second loop below computes the remaining 1 to 3 samples. */
emilmont 1:fdd22bb7aa52 89 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 90 {
emilmont 1:fdd22bb7aa52 91 /* Reading 4 inputs from memory */
emilmont 1:fdd22bb7aa52 92 in1 = *pSrc++;
emilmont 1:fdd22bb7aa52 93 in2 = *pSrc++;
emilmont 1:fdd22bb7aa52 94 in3 = *pSrc++;
emilmont 1:fdd22bb7aa52 95 in4 = *pSrc++;
emilmont 1:fdd22bb7aa52 96
emilmont 1:fdd22bb7aa52 97 /* C = A * scale */
emilmont 1:fdd22bb7aa52 98 /* Scale the inputs and then store the results in the temporary variables. */
emilmont 1:fdd22bb7aa52 99 out1 = (q7_t) (__SSAT(((in1) * scaleFract) >> kShift, 8));
emilmont 1:fdd22bb7aa52 100 out2 = (q7_t) (__SSAT(((in2) * scaleFract) >> kShift, 8));
emilmont 1:fdd22bb7aa52 101 out3 = (q7_t) (__SSAT(((in3) * scaleFract) >> kShift, 8));
emilmont 1:fdd22bb7aa52 102 out4 = (q7_t) (__SSAT(((in4) * scaleFract) >> kShift, 8));
emilmont 1:fdd22bb7aa52 103
emilmont 1:fdd22bb7aa52 104 /* Packing the individual outputs into 32bit and storing in
emilmont 1:fdd22bb7aa52 105 * destination buffer in single write */
emilmont 1:fdd22bb7aa52 106 *__SIMD32(pDst)++ = __PACKq7(out1, out2, out3, out4);
emilmont 1:fdd22bb7aa52 107
emilmont 1:fdd22bb7aa52 108 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 109 blkCnt--;
emilmont 1:fdd22bb7aa52 110 }
emilmont 1:fdd22bb7aa52 111
emilmont 1:fdd22bb7aa52 112 /* If the blockSize is not a multiple of 4, compute any remaining output samples here.
emilmont 1:fdd22bb7aa52 113 ** No loop unrolling is used. */
emilmont 1:fdd22bb7aa52 114 blkCnt = blockSize % 0x4u;
emilmont 1:fdd22bb7aa52 115
emilmont 1:fdd22bb7aa52 116 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 117 {
emilmont 1:fdd22bb7aa52 118 /* C = A * scale */
emilmont 1:fdd22bb7aa52 119 /* Scale the input and then store the result in the destination buffer. */
emilmont 1:fdd22bb7aa52 120 *pDst++ = (q7_t) (__SSAT(((*pSrc++) * scaleFract) >> kShift, 8));
emilmont 1:fdd22bb7aa52 121
emilmont 1:fdd22bb7aa52 122 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 123 blkCnt--;
emilmont 1:fdd22bb7aa52 124 }
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 /* Initialize blkCnt with number of samples */
emilmont 1:fdd22bb7aa52 131 blkCnt = blockSize;
emilmont 1:fdd22bb7aa52 132
emilmont 1:fdd22bb7aa52 133 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 134 {
emilmont 1:fdd22bb7aa52 135 /* C = A * scale */
emilmont 1:fdd22bb7aa52 136 /* Scale the input and then store the result in the destination buffer. */
emilmont 1:fdd22bb7aa52 137 *pDst++ = (q7_t) (__SSAT((((q15_t) * pSrc++ * scaleFract) >> kShift), 8));
emilmont 1:fdd22bb7aa52 138
emilmont 1:fdd22bb7aa52 139 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 140 blkCnt--;
emilmont 1:fdd22bb7aa52 141 }
emilmont 1:fdd22bb7aa52 142
mbed_official 3:7a284390b0ce 143 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
emilmont 1:fdd22bb7aa52 144
emilmont 1:fdd22bb7aa52 145 }
emilmont 1:fdd22bb7aa52 146
emilmont 1:fdd22bb7aa52 147 /**
emilmont 1:fdd22bb7aa52 148 * @} end of scale group
emilmont 1:fdd22bb7aa52 149 */