arm_offset_q31.c

00001 /* ----------------------------------------------------------------------    
00002 * Copyright (C) 2010-2013 ARM Limited. All rights reserved.    
00003 *    
00004 * $Date:        17. January 2013
00005 * $Revision:    V1.4.1
00006 *    
00007 * Project:      CMSIS DSP Library    
00008 * Title:        arm_offset_q31.c    
00009 *    
00010 * Description:  Q31 vector offset.    
00011 *    
00012 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
00013 *  
00014 * Redistribution and use in source and binary forms, with or without 
00015 * modification, are permitted provided that the following conditions
00016 * are met:
00017 *   - Redistributions of source code must retain the above copyright
00018 *     notice, this list of conditions and the following disclaimer.
00019 *   - Redistributions in binary form must reproduce the above copyright
00020 *     notice, this list of conditions and the following disclaimer in
00021 *     the documentation and/or other materials provided with the 
00022 *     distribution.
00023 *   - Neither the name of ARM LIMITED nor the names of its contributors
00024 *     may be used to endorse or promote products derived from this
00025 *     software without specific prior written permission.
00026 *
00027 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00028 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00029 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00030 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
00031 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00032 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00033 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00034 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00036 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00037 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00038 * POSSIBILITY OF SUCH DAMAGE. 
00039 * -------------------------------------------------------------------- */
00040 
00041 #include "arm_math.h"
00042 
00043 /**    
00044  * @ingroup groupMath    
00045  */
00046 
00047 /**    
00048  * @addtogroup offset    
00049  * @{    
00050  */
00051 
00052 /**    
00053  * @brief  Adds a constant offset to a Q31 vector.    
00054  * @param[in]  *pSrc points to the input vector    
00055  * @param[in]  offset is the offset to be added    
00056  * @param[out]  *pDst points to the output vector    
00057  * @param[in]  blockSize number of samples in the vector    
00058  * @return none.    
00059  *    
00060  * <b>Scaling and Overflow Behavior:</b>    
00061  * \par    
00062  * The function uses saturating arithmetic.    
00063  * Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] are saturated.    
00064  */
00065 
00066 void arm_offset_q31(
00067   q31_t * pSrc,
00068   q31_t offset,
00069   q31_t * pDst,
00070   uint32_t blockSize)
00071 {
00072   uint32_t blkCnt;                               /* loop counter */
00073 
00074 #ifndef ARM_MATH_CM0_FAMILY
00075 
00076 /* Run the below code for Cortex-M4 and Cortex-M3 */
00077   q31_t in1, in2, in3, in4;
00078 
00079 
00080   /*loop Unrolling */
00081   blkCnt = blockSize >> 2u;
00082 
00083   /* First part of the processing with loop unrolling.  Compute 4 outputs at a time.    
00084    ** a second loop below computes the remaining 1 to 3 samples. */
00085   while(blkCnt > 0u)
00086   {
00087     /* C = A + offset */
00088     /* Add offset and then store the results in the destination buffer. */
00089     in1 = *pSrc++;
00090     in2 = *pSrc++;
00091     in3 = *pSrc++;
00092     in4 = *pSrc++;
00093 
00094     *pDst++ = __QADD(in1, offset);
00095     *pDst++ = __QADD(in2, offset);
00096     *pDst++ = __QADD(in3, offset);
00097     *pDst++ = __QADD(in4, offset);
00098 
00099     /* Decrement the loop counter */
00100     blkCnt--;
00101   }
00102 
00103   /* If the blockSize is not a multiple of 4, compute any remaining output samples here.    
00104    ** No loop unrolling is used. */
00105   blkCnt = blockSize % 0x4u;
00106 
00107   while(blkCnt > 0u)
00108   {
00109     /* C = A + offset */
00110     /* Add offset and then store the result in the destination buffer. */
00111     *pDst++ = __QADD(*pSrc++, offset);
00112 
00113     /* Decrement the loop counter */
00114     blkCnt--;
00115   }
00116 
00117 #else
00118 
00119   /* Run the below code for Cortex-M0 */
00120 
00121   /* Initialize blkCnt with number of samples */
00122   blkCnt = blockSize;
00123 
00124   while(blkCnt > 0u)
00125   {
00126     /* C = A + offset */
00127     /* Add offset and then store the result in the destination buffer. */
00128     *pDst++ = (q31_t) clip_q63_to_q31((q63_t) * pSrc++ + offset);
00129 
00130     /* Decrement the loop counter */
00131     blkCnt--;
00132   }
00133 
00134 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
00135 
00136 }
00137 
00138 /**    
00139  * @} end of offset group    
00140  */