c2000ware-core-sdk/libraries/math/IQmath/c28/source/IQNrmpy.asm
2023-12-13 16:46:16 +05:30

345 lines
9.5 KiB
NASM

;;###########################################################################
;;
;; FILE: IQNrmpy.asm
;;
;; TITLE: C Callable IQ Multiply With Rounding Math Function
;;
;;###########################################################################
;;
;; Ver | Date | Who | Description of changes
;; =====|=============|=======|==============================================
;; 1.2 | 11 Oct 2001 | A. T. | Original Release.
;; -----|-------------|-------|----------------------------------------------
;; 1.3 | 19 Nov 2001 | A. T. | No changes.
;; -----|-------------|-------|----------------------------------------------
;; 1.4 | 17 May 2002 | A. T. | Made correction to table pointer.
;; | | | Corrected benchmark cycles.
;; -----|-------------|-------|----------------------------------------------
;; | | |
;;
;;###########################################################################
;;===========================================================================
;; Function: _IQNrmpy
;;===========================================================================
;;
;; C Usage: extern long _IQNrmpy(long M, long X); // with rounding only
;;
;;---------------------------------------------------------------------------
;;
;; On Entry: ACC = M in IQ format
;; [SP-4] = X in IQ format
;;
;; Regs Used: XT, P
;;
;; On Exit: ACC = M * X in IQ format
;;
;; Q range: 30 to 1
;;
;;---------------------------------------------------------------------------
;; Algorithm: The IQmpy operation generates a 64-bit result. The 64-bit
;; number must then be scaled back to a 32-bit value with the
;; same Q value as the original inputs. For example: if Q = 27,
;; then the multiplication of two I5Q27 numbers results in the
;; following 64-bit value:
;;
;; I5Q27 * I5Q27 = I10Q54
;;
;; The value is then scaled back to an I5Q27 value as follows:
;;
;; I5Q27 = I10Q54 >> Q
;;
;; For some of the operations, the value is either rounded or
;; saturated (or both) to its maximum value before scaling.
;;
;;---------------------------------------------------------------------------
;; Benchmark:
;;
;; Cycles = 16 (Q >= 16, if Table in 0-wait SARAM, includes LCR/LRETR)
;; 17 (Q <= 15, if Table in 0-wait SARAM, includes LCR/LRETR)
;;
;; Cycles = 18 (Q >= 16, if Table in 1-wait ROM, includes LCR/LRETR)
;; 19 (Q <= 15, if Table in 1-wait ROM, includes LCR/LRETR)
;;
;;---------------------------------------------------------------------------
;;#############################################################################
;;!
;;! Copyright: Copyright (C) 2023 Texas Instruments Incorporated -
;;! All rights reserved not granted herein.
;;! Limited License.
;;!
;;! Texas Instruments Incorporated grants a world-wide, royalty-free,
;;! non-exclusive license under copyrights and patents it now or hereafter
;;! owns or controls to make, have made, use, import, offer to sell and sell
;;! ("Utilize") this software subject to the terms herein. With respect to the
;;! foregoing patent license, such license is granted solely to the extent that
;;! any such patent is necessary to Utilize the software alone. The patent
;;! license shall not apply to any combinations which include this software,
;;! other than combinations with devices manufactured by or for TI
;;! ("TI Devices").
;;! No hardware patent is licensed hereunder.
;;!
;;! Redistributions must preserve existing copyright notices and reproduce this
;;! license (including the above copyright notice and the disclaimer and
;;! (if applicable) source code license limitations below) in the documentation
;;! and/or other materials provided with the distribution.
;;!
;;! Redistribution and use in binary form, without modification, are permitted
;;! provided that the following conditions are met:
;;!
;;! * No reverse engineering, decompilation, or disassembly of this software is
;;! permitted with respect to any software provided in binary form.
;;! * Any redistribution and use are licensed by TI for use only
;;! with TI Devices.
;;! * Nothing shall obligate TI to provide you with source code for the
;;! software licensed and provided to you in object code.
;;!
;;! If software source code is provided to you, modification and redistribution
;;! of the source code are permitted provided that the following conditions
;;! are met:
;;!
;;! * any redistribution and use of the source code, including any resulting
;;! derivative works, are licensed by TI for use only with TI Devices.
;;! * any redistribution and use of any object code compiled from the source
;;! code and any resulting derivative works, are licensed by TI for use
;;! only with TI Devices.
;;!
;;! Neither the name of Texas Instruments Incorporated nor the names of its
;;! suppliers may be used to endorse or promote products derived from this
;;! software without specific prior written permission.
;;#############################################################################
IQNrmpy .macro q_value, table
MOVL XT,@ACC ; XT = M
IMPYL P,XT,*-SP[4]
QMPYL ACC,XT,*-SP[4] ; ACC:P = M * X
MOVL XAR7,#table
ADDUL P,*XAR7++ ; Round value
ADDCL ACC,*XAR7++
.if q_value >= 16
LSL64 ACC:P,#(32 - q_value) ; Scale back to required IQ value
.endif
.if q_value <= 15
LSL64 ACC:P,#16 ; Scale back to required IQ value
LSL64 ACC:P,#(16 - q_value)
.endif
LRETR
.endm
;; The value "GLOBAL_Q" needs to be supplied by the assembler
;; using the "-dGLOBAL_Q=q_value" directive:
.sect "IQmath"
.if GLOBAL_Q == 30
.ref _IQ30mpyRndSatTable
.def __IQ30rmpy
__IQ30rmpy:
IQNrmpy GLOBAL_Q, _IQ30mpyRndSatTable
.endif
.if GLOBAL_Q == 29
.ref _IQ29mpyRndSatTable
.def __IQ29rmpy
__IQ29rmpy:
IQNrmpy GLOBAL_Q, _IQ29mpyRndSatTable
.endif
.if GLOBAL_Q == 28
.ref _IQ28mpyRndSatTable
.def __IQ28rmpy
__IQ28rmpy:
IQNrmpy GLOBAL_Q, _IQ28mpyRndSatTable
.endif
.if GLOBAL_Q == 27
.ref _IQ27mpyRndSatTable
.def __IQ27rmpy
__IQ27rmpy:
IQNrmpy GLOBAL_Q, _IQ27mpyRndSatTable
.endif
.if GLOBAL_Q == 26
.ref _IQ26mpyRndSatTable
.def __IQ26rmpy
__IQ26rmpy:
IQNrmpy GLOBAL_Q, _IQ26mpyRndSatTable
.endif
.if GLOBAL_Q == 25
.ref _IQ25mpyRndSatTable
.def __IQ25rmpy
__IQ25rmpy:
IQNrmpy GLOBAL_Q, _IQ25mpyRndSatTable
.endif
.if GLOBAL_Q == 24
.ref _IQ24mpyRndSatTable
.def __IQ24rmpy
__IQ24rmpy:
IQNrmpy GLOBAL_Q, _IQ24mpyRndSatTable
.endif
.if GLOBAL_Q == 23
.ref _IQ23mpyRndSatTable
.def __IQ23rmpy
__IQ23rmpy:
IQNrmpy GLOBAL_Q, _IQ23mpyRndSatTable
.endif
.if GLOBAL_Q == 22
.ref _IQ22mpyRndSatTable
.def __IQ22rmpy
__IQ22rmpy:
IQNrmpy GLOBAL_Q, _IQ22mpyRndSatTable
.endif
.if GLOBAL_Q == 21
.ref _IQ21mpyRndSatTable
.def __IQ21rmpy
__IQ21rmpy:
IQNrmpy GLOBAL_Q, _IQ21mpyRndSatTable
.endif
.if GLOBAL_Q == 20
.ref _IQ20mpyRndSatTable
.def __IQ20rmpy
__IQ20rmpy:
IQNrmpy GLOBAL_Q, _IQ20mpyRndSatTable
.endif
.if GLOBAL_Q == 19
.ref _IQ19mpyRndSatTable
.def __IQ19rmpy
__IQ19rmpy:
IQNrmpy GLOBAL_Q, _IQ19mpyRndSatTable
.endif
.if GLOBAL_Q == 18
.ref _IQ18mpyRndSatTable
.def __IQ18rmpy
__IQ18rmpy:
IQNrmpy GLOBAL_Q, _IQ18mpyRndSatTable
.endif
.if GLOBAL_Q == 17
.ref _IQ17mpyRndSatTable
.def __IQ17rmpy
__IQ17rmpy:
IQNrmpy GLOBAL_Q, _IQ17mpyRndSatTable
.endif
.if GLOBAL_Q == 16
.ref _IQ16mpyRndSatTable
.def __IQ16rmpy
__IQ16rmpy:
IQNrmpy GLOBAL_Q, _IQ16mpyRndSatTable
.endif
.if GLOBAL_Q == 15
.ref _IQ15mpyRndSatTable
.def __IQ15rmpy
__IQ15rmpy:
IQNrmpy GLOBAL_Q, _IQ15mpyRndSatTable
.endif
.if GLOBAL_Q == 14
.ref _IQ14mpyRndSatTable
.def __IQ14rmpy
__IQ14rmpy:
IQNrmpy GLOBAL_Q, _IQ14mpyRndSatTable
.endif
.if GLOBAL_Q == 13
.ref _IQ13mpyRndSatTable
.def __IQ13rmpy
__IQ13rmpy:
IQNrmpy GLOBAL_Q, _IQ13mpyRndSatTable
.endif
.if GLOBAL_Q == 12
.ref _IQ12mpyRndSatTable
.def __IQ12rmpy
__IQ12rmpy:
IQNrmpy GLOBAL_Q, _IQ12mpyRndSatTable
.endif
.if GLOBAL_Q == 11
.ref _IQ11mpyRndSatTable
.def __IQ11rmpy
__IQ11rmpy:
IQNrmpy GLOBAL_Q, _IQ11mpyRndSatTable
.endif
.if GLOBAL_Q == 10
.ref _IQ10mpyRndSatTable
.def __IQ10rmpy
__IQ10rmpy:
IQNrmpy GLOBAL_Q, _IQ10mpyRndSatTable
.endif
.if GLOBAL_Q == 9
.ref _IQ9mpyRndSatTable
.def __IQ9rmpy
__IQ9rmpy:
IQNrmpy GLOBAL_Q, _IQ9mpyRndSatTable
.endif
.if GLOBAL_Q == 8
.ref _IQ8mpyRndSatTable
.def __IQ8rmpy
__IQ8rmpy:
IQNrmpy GLOBAL_Q, _IQ8mpyRndSatTable
.endif
.if GLOBAL_Q == 7
.ref _IQ7mpyRndSatTable
.def __IQ7rmpy
__IQ7rmpy:
IQNrmpy GLOBAL_Q, _IQ7mpyRndSatTable
.endif
.if GLOBAL_Q == 6
.ref _IQ6mpyRndSatTable
.def __IQ6rmpy
__IQ6rmpy:
IQNrmpy GLOBAL_Q, _IQ6mpyRndSatTable
.endif
.if GLOBAL_Q == 5
.ref _IQ5mpyRndSatTable
.def __IQ5rmpy
__IQ5rmpy:
IQNrmpy GLOBAL_Q, _IQ5mpyRndSatTable
.endif
.if GLOBAL_Q == 4
.ref _IQ4mpyRndSatTable
.def __IQ4rmpy
__IQ4rmpy:
IQNrmpy GLOBAL_Q, _IQ4mpyRndSatTable
.endif
.if GLOBAL_Q == 3
.ref _IQ3mpyRndSatTable
.def __IQ3rmpy
__IQ3rmpy:
IQNrmpy GLOBAL_Q, _IQ3mpyRndSatTable
.endif
.if GLOBAL_Q == 2
.ref _IQ2mpyRndSatTable
.def __IQ2rmpy
__IQ2rmpy:
IQNrmpy GLOBAL_Q, _IQ2mpyRndSatTable
.endif
.if GLOBAL_Q == 1
.ref _IQ1mpyRndSatTable
.def __IQ1rmpy
__IQ1rmpy:
IQNrmpy GLOBAL_Q, _IQ1mpyRndSatTable
.endif
;;###########################################################################
;; No More.
;;###########################################################################