1 /*******************************************************************************
3 * Module Name: utmath - Integer math support routines
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
156 #define _COMPONENT ACPI_UTILITIES
157 ACPI_MODULE_NAME ("utmath")
159 /* Structures used only for 64-bit divide */
161 typedef struct uint64_struct
168 typedef union uint64_overlay
176 * Optional support for 64-bit double-precision integer multiply and shift.
177 * This code is configurable and is implemented in order to support 32-bit
178 * kernel environments where a 64-bit double-precision math library is not
181 #ifndef ACPI_USE_NATIVE_MATH64
183 /*******************************************************************************
185 * FUNCTION: AcpiUtShortMultiply
187 * PARAMETERS: Multiplicand - 64-bit multiplicand
188 * Multiplier - 32-bit multiplier
189 * OutProduct - Pointer to where the product is returned
191 * DESCRIPTION: Perform a short multiply.
193 ******************************************************************************/
196 AcpiUtShortMultiply (
201 UINT64_OVERLAY MultiplicandOvl;
202 UINT64_OVERLAY Product;
206 ACPI_FUNCTION_TRACE (UtShortMultiply);
209 MultiplicandOvl.Full = Multiplicand;
212 * The Product is 64 bits, the carry is always 32 bits,
213 * and is generated by the second multiply.
215 ACPI_MUL_64_BY_32 (0, MultiplicandOvl.Part.Hi, Multiplier,
216 Product.Part.Hi, Carry32);
218 ACPI_MUL_64_BY_32 (0, MultiplicandOvl.Part.Lo, Multiplier,
219 Product.Part.Lo, Carry32);
221 Product.Part.Hi += Carry32;
223 /* Return only what was requested */
227 *OutProduct = Product.Full;
230 return_ACPI_STATUS (AE_OK);
234 /*******************************************************************************
236 * FUNCTION: AcpiUtShortShiftLeft
238 * PARAMETERS: Operand - 64-bit shift operand
239 * Count - 32-bit shift count
240 * OutResult - Pointer to where the result is returned
242 * DESCRIPTION: Perform a short left shift.
244 ******************************************************************************/
247 AcpiUtShortShiftLeft (
252 UINT64_OVERLAY OperandOvl;
255 ACPI_FUNCTION_TRACE (UtShortShiftLeft);
258 OperandOvl.Full = Operand;
260 if ((Count & 63) >= 32)
262 OperandOvl.Part.Hi = OperandOvl.Part.Lo;
263 OperandOvl.Part.Lo = 0;
264 Count = (Count & 63) - 32;
266 ACPI_SHIFT_LEFT_64_BY_32 (OperandOvl.Part.Hi,
267 OperandOvl.Part.Lo, Count);
269 /* Return only what was requested */
273 *OutResult = OperandOvl.Full;
276 return_ACPI_STATUS (AE_OK);
279 /*******************************************************************************
281 * FUNCTION: AcpiUtShortShiftRight
283 * PARAMETERS: Operand - 64-bit shift operand
284 * Count - 32-bit shift count
285 * OutResult - Pointer to where the result is returned
287 * DESCRIPTION: Perform a short right shift.
289 ******************************************************************************/
292 AcpiUtShortShiftRight (
297 UINT64_OVERLAY OperandOvl;
300 ACPI_FUNCTION_TRACE (UtShortShiftRight);
303 OperandOvl.Full = Operand;
305 if ((Count & 63) >= 32)
307 OperandOvl.Part.Lo = OperandOvl.Part.Hi;
308 OperandOvl.Part.Hi = 0;
309 Count = (Count & 63) - 32;
311 ACPI_SHIFT_RIGHT_64_BY_32 (OperandOvl.Part.Hi,
312 OperandOvl.Part.Lo, Count);
314 /* Return only what was requested */
318 *OutResult = OperandOvl.Full;
321 return_ACPI_STATUS (AE_OK);
325 /*******************************************************************************
327 * FUNCTION: AcpiUtShortMultiply
329 * PARAMETERS: See function headers above
331 * DESCRIPTION: Native version of the UtShortMultiply function.
333 ******************************************************************************/
336 AcpiUtShortMultiply (
342 ACPI_FUNCTION_TRACE (UtShortMultiply);
345 /* Return only what was requested */
349 *OutProduct = Multiplicand * Multiplier;
352 return_ACPI_STATUS (AE_OK);
355 /*******************************************************************************
357 * FUNCTION: AcpiUtShortShiftLeft
359 * PARAMETERS: See function headers above
361 * DESCRIPTION: Native version of the UtShortShiftLeft function.
363 ******************************************************************************/
366 AcpiUtShortShiftLeft (
372 ACPI_FUNCTION_TRACE (UtShortShiftLeft);
375 /* Return only what was requested */
379 *OutResult = Operand << Count;
382 return_ACPI_STATUS (AE_OK);
385 /*******************************************************************************
387 * FUNCTION: AcpiUtShortShiftRight
389 * PARAMETERS: See function headers above
391 * DESCRIPTION: Native version of the UtShortShiftRight function.
393 ******************************************************************************/
396 AcpiUtShortShiftRight (
402 ACPI_FUNCTION_TRACE (UtShortShiftRight);
405 /* Return only what was requested */
409 *OutResult = Operand >> Count;
412 return_ACPI_STATUS (AE_OK);
417 * Optional support for 64-bit double-precision integer divide. This code
418 * is configurable and is implemented in order to support 32-bit kernel
419 * environments where a 64-bit double-precision math library is not available.
421 * Support for a more normal 64-bit divide/modulo (with check for a divide-
422 * by-zero) appears after this optional section of code.
424 #ifndef ACPI_USE_NATIVE_DIVIDE
427 /*******************************************************************************
429 * FUNCTION: AcpiUtShortDivide
431 * PARAMETERS: Dividend - 64-bit dividend
432 * Divisor - 32-bit divisor
433 * OutQuotient - Pointer to where the quotient is returned
434 * OutRemainder - Pointer to where the remainder is returned
436 * RETURN: Status (Checks for divide-by-zero)
438 * DESCRIPTION: Perform a short (maximum 64 bits divided by 32 bits)
439 * divide and modulo. The result is a 64-bit quotient and a
442 ******************************************************************************/
449 UINT32 *OutRemainder)
451 UINT64_OVERLAY DividendOvl;
452 UINT64_OVERLAY Quotient;
456 ACPI_FUNCTION_TRACE (UtShortDivide);
459 /* Always check for a zero divisor */
463 ACPI_ERROR ((AE_INFO, "Divide by zero"));
464 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
467 DividendOvl.Full = Dividend;
470 * The quotient is 64 bits, the remainder is always 32 bits,
471 * and is generated by the second divide.
473 ACPI_DIV_64_BY_32 (0, DividendOvl.Part.Hi, Divisor,
474 Quotient.Part.Hi, Remainder32);
476 ACPI_DIV_64_BY_32 (Remainder32, DividendOvl.Part.Lo, Divisor,
477 Quotient.Part.Lo, Remainder32);
479 /* Return only what was requested */
483 *OutQuotient = Quotient.Full;
487 *OutRemainder = Remainder32;
490 return_ACPI_STATUS (AE_OK);
494 /*******************************************************************************
496 * FUNCTION: AcpiUtDivide
498 * PARAMETERS: InDividend - Dividend
499 * InDivisor - Divisor
500 * OutQuotient - Pointer to where the quotient is returned
501 * OutRemainder - Pointer to where the remainder is returned
503 * RETURN: Status (Checks for divide-by-zero)
505 * DESCRIPTION: Perform a divide and modulo.
507 ******************************************************************************/
514 UINT64 *OutRemainder)
516 UINT64_OVERLAY Dividend;
517 UINT64_OVERLAY Divisor;
518 UINT64_OVERLAY Quotient;
519 UINT64_OVERLAY Remainder;
520 UINT64_OVERLAY NormalizedDividend;
521 UINT64_OVERLAY NormalizedDivisor;
523 UINT64_OVERLAY Partial2;
524 UINT64_OVERLAY Partial3;
527 ACPI_FUNCTION_TRACE (UtDivide);
530 /* Always check for a zero divisor */
534 ACPI_ERROR ((AE_INFO, "Divide by zero"));
535 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
538 Divisor.Full = InDivisor;
539 Dividend.Full = InDividend;
540 if (Divisor.Part.Hi == 0)
543 * 1) Simplest case is where the divisor is 32 bits, we can
544 * just do two divides
546 Remainder.Part.Hi = 0;
549 * The quotient is 64 bits, the remainder is always 32 bits,
550 * and is generated by the second divide.
552 ACPI_DIV_64_BY_32 (0, Dividend.Part.Hi, Divisor.Part.Lo,
553 Quotient.Part.Hi, Partial1);
555 ACPI_DIV_64_BY_32 (Partial1, Dividend.Part.Lo, Divisor.Part.Lo,
556 Quotient.Part.Lo, Remainder.Part.Lo);
562 * 2) The general case where the divisor is a full 64 bits
565 Quotient.Part.Hi = 0;
566 NormalizedDividend = Dividend;
567 NormalizedDivisor = Divisor;
569 /* Normalize the operands (shift until the divisor is < 32 bits) */
573 ACPI_SHIFT_RIGHT_64 (
574 NormalizedDivisor.Part.Hi, NormalizedDivisor.Part.Lo);
575 ACPI_SHIFT_RIGHT_64 (
576 NormalizedDividend.Part.Hi, NormalizedDividend.Part.Lo);
578 } while (NormalizedDivisor.Part.Hi != 0);
583 NormalizedDividend.Part.Hi, NormalizedDividend.Part.Lo,
584 NormalizedDivisor.Part.Lo, Quotient.Part.Lo, Partial1);
587 * The quotient is always 32 bits, and simply requires
588 * adjustment. The 64-bit remainder must be generated.
590 Partial1 = Quotient.Part.Lo * Divisor.Part.Hi;
591 Partial2.Full = (UINT64) Quotient.Part.Lo * Divisor.Part.Lo;
592 Partial3.Full = (UINT64) Partial2.Part.Hi + Partial1;
594 Remainder.Part.Hi = Partial3.Part.Lo;
595 Remainder.Part.Lo = Partial2.Part.Lo;
597 if (Partial3.Part.Hi == 0)
599 if (Partial3.Part.Lo >= Dividend.Part.Hi)
601 if (Partial3.Part.Lo == Dividend.Part.Hi)
603 if (Partial2.Part.Lo > Dividend.Part.Lo)
606 Remainder.Full -= Divisor.Full;
612 Remainder.Full -= Divisor.Full;
616 Remainder.Full = Remainder.Full - Dividend.Full;
617 Remainder.Part.Hi = (UINT32) -((INT32) Remainder.Part.Hi);
618 Remainder.Part.Lo = (UINT32) -((INT32) Remainder.Part.Lo);
620 if (Remainder.Part.Lo)
627 /* Return only what was requested */
631 *OutQuotient = Quotient.Full;
635 *OutRemainder = Remainder.Full;
638 return_ACPI_STATUS (AE_OK);
643 /*******************************************************************************
645 * FUNCTION: AcpiUtShortDivide, AcpiUtDivide
647 * PARAMETERS: See function headers above
649 * DESCRIPTION: Native versions of the UtDivide functions. Use these if either
650 * 1) The target is a 64-bit platform and therefore 64-bit
651 * integer math is supported directly by the machine.
652 * 2) The target is a 32-bit or 16-bit platform, and the
653 * double-precision integer math library is available to
654 * perform the divide.
656 ******************************************************************************/
663 UINT32 *OutRemainder)
666 ACPI_FUNCTION_TRACE (UtShortDivide);
669 /* Always check for a zero divisor */
673 ACPI_ERROR ((AE_INFO, "Divide by zero"));
674 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
677 /* Return only what was requested */
681 *OutQuotient = InDividend / Divisor;
685 *OutRemainder = (UINT32) (InDividend % Divisor);
688 return_ACPI_STATUS (AE_OK);
696 UINT64 *OutRemainder)
698 ACPI_FUNCTION_TRACE (UtDivide);
701 /* Always check for a zero divisor */
705 ACPI_ERROR ((AE_INFO, "Divide by zero"));
706 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
710 /* Return only what was requested */
714 *OutQuotient = InDividend / InDivisor;
718 *OutRemainder = InDividend % InDivisor;
721 return_ACPI_STATUS (AE_OK);