Renesas / mbed-dsp-neon

Fork of mbed-dsp. CMSIS-DSP library of supporting NEON

Dependents:   mbed-os-example-cmsis_dsp_neon

Fork of mbed-dsp by mbed official

Information

Japanese version is available in lower part of this page.
このページの後半に日本語版が用意されています．

CMSIS-DSP of supporting NEON

What is this ?

A library for CMSIS-DSP of supporting NEON.
We supported the NEON to CMSIS-DSP Ver1.4.3(CMSIS V4.1) that ARM supplied, has achieved the processing speed improvement.
If you use the mbed-dsp library, you can use to replace this library.
CMSIS-DSP of supporting NEON is provied as a library.

Library Creation environment

CMSIS-DSP library of supporting NEON was created by the following environment.

  • Compiler
    ARMCC Version 5.03
  • Compile option switch[C Compiler]
   -DARM_MATH_MATRIX_CHECK -DARM_MATH_ROUNDING -O3 -Otime --cpu=Cortex-A9 --littleend --arm 
   --apcs=/interwork --no_unaligned_access --fpu=vfpv3_fp16 --fpmode=fast --apcs=/hardfp 
   --vectorize --asm
  • Compile option switch[Assembler]
   --cpreproc --cpu=Cortex-A9 --littleend --arm --apcs=/interwork --no_unaligned_access 
   --fpu=vfpv3_fp16 --fpmode=fast --apcs=/hardfp


Effects of NEON support

In the data which passes to each function, large size will be expected more effective than small size.
Also if the data is a multiple of 16, effect will be expected in every function in the CMSIS-DSP.


NEON対応CMSIS-DSP

概要

NEON対応したCMSIS-DSPのライブラリです。
ARM社提供のCMSIS-DSP Ver1.4.3(CMSIS V4.1)をターゲットにNEON対応を行ない、処理速度向上を実現しております。
mbed-dspライブラリを使用している場合は、本ライブラリに置き換えて使用することができます。
NEON対応したCMSIS-DSPはライブラリで提供します。

ライブラリ作成環境

NEON対応CMSIS-DSPライブラリは、以下の環境で作成しています。

  • コンパイラ
    ARMCC Version 5.03
  • コンパイルオプションスイッチ[C Compiler]
   -DARM_MATH_MATRIX_CHECK -DARM_MATH_ROUNDING -O3 -Otime --cpu=Cortex-A9 --littleend --arm 
   --apcs=/interwork --no_unaligned_access --fpu=vfpv3_fp16 --fpmode=fast --apcs=/hardfp 
   --vectorize --asm
  • コンパイルオプションスイッチ[Assembler]
   --cpreproc --cpu=Cortex-A9 --littleend --arm --apcs=/interwork --no_unaligned_access 
   --fpu=vfpv3_fp16 --fpmode=fast --apcs=/hardfp


NEON対応による効果について

CMSIS-DSP内の各関数へ渡すデータは、小さいサイズよりも大きいサイズの方が効果が見込めます。
また、16の倍数のデータであれば、CMSIS-DSP内のどの関数でも効果が見込めます。


cmsis_dsp/BasicMathFunctions/arm_dot_prod_q31.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_dot_prod_q31.c
emilmont 1:fdd22bb7aa52 9 *
emilmont 2:da51fb522205 10 * Description: Q31 dot product.
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 dot_prod
emilmont 1:fdd22bb7aa52 49 * @{
emilmont 1:fdd22bb7aa52 50 */
emilmont 1:fdd22bb7aa52 51
emilmont 1:fdd22bb7aa52 52 /**
emilmont 1:fdd22bb7aa52 53 * @brief Dot product of Q31 vectors.
emilmont 1:fdd22bb7aa52 54 * @param[in] *pSrcA points to the first input vector
emilmont 1:fdd22bb7aa52 55 * @param[in] *pSrcB points to the second input vector
emilmont 1:fdd22bb7aa52 56 * @param[in] blockSize number of samples in each vector
emilmont 1:fdd22bb7aa52 57 * @param[out] *result output result returned here
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 intermediate multiplications are in 1.31 x 1.31 = 2.62 format and these
emilmont 1:fdd22bb7aa52 63 * are truncated to 2.48 format by discarding the lower 14 bits.
emilmont 1:fdd22bb7aa52 64 * The 2.48 result is then added without saturation to a 64-bit accumulator in 16.48 format.
emilmont 1:fdd22bb7aa52 65 * There are 15 guard bits in the accumulator and there is no risk of overflow as long as
emilmont 1:fdd22bb7aa52 66 * the length of the vectors is less than 2^16 elements.
emilmont 1:fdd22bb7aa52 67 * The return result is in 16.48 format.
emilmont 1:fdd22bb7aa52 68 */
emilmont 1:fdd22bb7aa52 69
emilmont 1:fdd22bb7aa52 70 void arm_dot_prod_q31(
emilmont 1:fdd22bb7aa52 71 q31_t * pSrcA,
emilmont 1:fdd22bb7aa52 72 q31_t * pSrcB,
emilmont 1:fdd22bb7aa52 73 uint32_t blockSize,
emilmont 1:fdd22bb7aa52 74 q63_t * result)
emilmont 1:fdd22bb7aa52 75 {
emilmont 1:fdd22bb7aa52 76 q63_t sum = 0; /* Temporary result storage */
emilmont 1:fdd22bb7aa52 77 uint32_t blkCnt; /* loop counter */
emilmont 1:fdd22bb7aa52 78
emilmont 1:fdd22bb7aa52 79
mbed_official 3:7a284390b0ce 80 #ifndef ARM_MATH_CM0_FAMILY
emilmont 1:fdd22bb7aa52 81
emilmont 1:fdd22bb7aa52 82 /* Run the below code for Cortex-M4 and Cortex-M3 */
emilmont 1:fdd22bb7aa52 83 q31_t inA1, inA2, inA3, inA4;
emilmont 1:fdd22bb7aa52 84 q31_t inB1, inB2, inB3, inB4;
emilmont 1:fdd22bb7aa52 85
emilmont 1:fdd22bb7aa52 86 /*loop Unrolling */
emilmont 1:fdd22bb7aa52 87 blkCnt = blockSize >> 2u;
emilmont 1:fdd22bb7aa52 88
emilmont 1:fdd22bb7aa52 89 /* First part of the processing with loop unrolling. Compute 4 outputs at a time.
emilmont 1:fdd22bb7aa52 90 ** a second loop below computes the remaining 1 to 3 samples. */
emilmont 1:fdd22bb7aa52 91 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 92 {
emilmont 1:fdd22bb7aa52 93 /* C = A[0]* B[0] + A[1]* B[1] + A[2]* B[2] + .....+ A[blockSize-1]* B[blockSize-1] */
emilmont 1:fdd22bb7aa52 94 /* Calculate dot product and then store the result in a temporary buffer. */
emilmont 1:fdd22bb7aa52 95 inA1 = *pSrcA++;
emilmont 1:fdd22bb7aa52 96 inA2 = *pSrcA++;
emilmont 1:fdd22bb7aa52 97 inA3 = *pSrcA++;
emilmont 1:fdd22bb7aa52 98 inA4 = *pSrcA++;
emilmont 1:fdd22bb7aa52 99 inB1 = *pSrcB++;
emilmont 1:fdd22bb7aa52 100 inB2 = *pSrcB++;
emilmont 1:fdd22bb7aa52 101 inB3 = *pSrcB++;
emilmont 1:fdd22bb7aa52 102 inB4 = *pSrcB++;
emilmont 1:fdd22bb7aa52 103
emilmont 1:fdd22bb7aa52 104 sum += ((q63_t) inA1 * inB1) >> 14u;
emilmont 1:fdd22bb7aa52 105 sum += ((q63_t) inA2 * inB2) >> 14u;
emilmont 1:fdd22bb7aa52 106 sum += ((q63_t) inA3 * inB3) >> 14u;
emilmont 1:fdd22bb7aa52 107 sum += ((q63_t) inA4 * inB4) >> 14u;
emilmont 1:fdd22bb7aa52 108
emilmont 1:fdd22bb7aa52 109 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 110 blkCnt--;
emilmont 1:fdd22bb7aa52 111 }
emilmont 1:fdd22bb7aa52 112
emilmont 1:fdd22bb7aa52 113 /* If the blockSize is not a multiple of 4, compute any remaining output samples here.
emilmont 1:fdd22bb7aa52 114 ** No loop unrolling is used. */
emilmont 1:fdd22bb7aa52 115 blkCnt = blockSize % 0x4u;
emilmont 1:fdd22bb7aa52 116
emilmont 1:fdd22bb7aa52 117 #else
emilmont 1:fdd22bb7aa52 118
emilmont 1:fdd22bb7aa52 119 /* Run the below code for Cortex-M0 */
emilmont 1:fdd22bb7aa52 120
emilmont 1:fdd22bb7aa52 121 /* Initialize blkCnt with number of samples */
emilmont 1:fdd22bb7aa52 122 blkCnt = blockSize;
emilmont 1:fdd22bb7aa52 123
mbed_official 3:7a284390b0ce 124 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
emilmont 1:fdd22bb7aa52 125
emilmont 1:fdd22bb7aa52 126
emilmont 1:fdd22bb7aa52 127 while(blkCnt > 0u)
emilmont 1:fdd22bb7aa52 128 {
emilmont 1:fdd22bb7aa52 129 /* C = A[0]* B[0] + A[1]* B[1] + A[2]* B[2] + .....+ A[blockSize-1]* B[blockSize-1] */
emilmont 1:fdd22bb7aa52 130 /* Calculate dot product and then store the result in a temporary buffer. */
emilmont 1:fdd22bb7aa52 131 sum += ((q63_t) * pSrcA++ * *pSrcB++) >> 14u;
emilmont 1:fdd22bb7aa52 132
emilmont 1:fdd22bb7aa52 133 /* Decrement the loop counter */
emilmont 1:fdd22bb7aa52 134 blkCnt--;
emilmont 1:fdd22bb7aa52 135 }
emilmont 1:fdd22bb7aa52 136
emilmont 1:fdd22bb7aa52 137 /* Store the result in the destination buffer in 16.48 format */
emilmont 1:fdd22bb7aa52 138 *result = sum;
emilmont 1:fdd22bb7aa52 139 }
emilmont 1:fdd22bb7aa52 140
emilmont 1:fdd22bb7aa52 141 /**
emilmont 1:fdd22bb7aa52 142 * @} end of dot_prod group
emilmont 1:fdd22bb7aa52 143 */