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 *****************************************************************************/
153 #include "accommon.h"
156 #define _COMPONENT ACPI_UTILITIES
157 ACPI_MODULE_NAME ("utmath")
160 * Optional support for 64-bit double-precision integer divide. This code
161 * is configurable and is implemented in order to support 32-bit kernel
162 * environments where a 64-bit double-precision math library is not available.
164 * Support for a more normal 64-bit divide/modulo (with check for a divide-
165 * by-zero) appears after this optional section of code.
167 #ifndef ACPI_USE_NATIVE_DIVIDE
169 /* Structures used only for 64-bit divide */
171 typedef struct uint64_struct
178 typedef union uint64_overlay
186 /*******************************************************************************
188 * FUNCTION: AcpiUtShortDivide
190 * PARAMETERS: Dividend - 64-bit dividend
191 * Divisor - 32-bit divisor
192 * OutQuotient - Pointer to where the quotient is returned
193 * OutRemainder - Pointer to where the remainder is returned
195 * RETURN: Status (Checks for divide-by-zero)
197 * DESCRIPTION: Perform a short (maximum 64 bits divided by 32 bits)
198 * divide and modulo. The result is a 64-bit quotient and a
201 ******************************************************************************/
208 UINT32 *OutRemainder)
210 UINT64_OVERLAY DividendOvl;
211 UINT64_OVERLAY Quotient;
215 ACPI_FUNCTION_TRACE (UtShortDivide);
218 /* Always check for a zero divisor */
222 ACPI_ERROR ((AE_INFO, "Divide by zero"));
223 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
226 DividendOvl.Full = Dividend;
229 * The quotient is 64 bits, the remainder is always 32 bits,
230 * and is generated by the second divide.
232 ACPI_DIV_64_BY_32 (0, DividendOvl.Part.Hi, Divisor,
233 Quotient.Part.Hi, Remainder32);
235 ACPI_DIV_64_BY_32 (Remainder32, DividendOvl.Part.Lo, Divisor,
236 Quotient.Part.Lo, Remainder32);
238 /* Return only what was requested */
242 *OutQuotient = Quotient.Full;
246 *OutRemainder = Remainder32;
249 return_ACPI_STATUS (AE_OK);
253 /*******************************************************************************
255 * FUNCTION: AcpiUtDivide
257 * PARAMETERS: InDividend - Dividend
258 * InDivisor - Divisor
259 * OutQuotient - Pointer to where the quotient is returned
260 * OutRemainder - Pointer to where the remainder is returned
262 * RETURN: Status (Checks for divide-by-zero)
264 * DESCRIPTION: Perform a divide and modulo.
266 ******************************************************************************/
273 UINT64 *OutRemainder)
275 UINT64_OVERLAY Dividend;
276 UINT64_OVERLAY Divisor;
277 UINT64_OVERLAY Quotient;
278 UINT64_OVERLAY Remainder;
279 UINT64_OVERLAY NormalizedDividend;
280 UINT64_OVERLAY NormalizedDivisor;
282 UINT64_OVERLAY Partial2;
283 UINT64_OVERLAY Partial3;
286 ACPI_FUNCTION_TRACE (UtDivide);
289 /* Always check for a zero divisor */
293 ACPI_ERROR ((AE_INFO, "Divide by zero"));
294 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
297 Divisor.Full = InDivisor;
298 Dividend.Full = InDividend;
299 if (Divisor.Part.Hi == 0)
302 * 1) Simplest case is where the divisor is 32 bits, we can
303 * just do two divides
305 Remainder.Part.Hi = 0;
308 * The quotient is 64 bits, the remainder is always 32 bits,
309 * and is generated by the second divide.
311 ACPI_DIV_64_BY_32 (0, Dividend.Part.Hi, Divisor.Part.Lo,
312 Quotient.Part.Hi, Partial1);
314 ACPI_DIV_64_BY_32 (Partial1, Dividend.Part.Lo, Divisor.Part.Lo,
315 Quotient.Part.Lo, Remainder.Part.Lo);
321 * 2) The general case where the divisor is a full 64 bits
324 Quotient.Part.Hi = 0;
325 NormalizedDividend = Dividend;
326 NormalizedDivisor = Divisor;
328 /* Normalize the operands (shift until the divisor is < 32 bits) */
332 ACPI_SHIFT_RIGHT_64 (
333 NormalizedDivisor.Part.Hi, NormalizedDivisor.Part.Lo);
334 ACPI_SHIFT_RIGHT_64 (
335 NormalizedDividend.Part.Hi, NormalizedDividend.Part.Lo);
337 } while (NormalizedDivisor.Part.Hi != 0);
342 NormalizedDividend.Part.Hi, NormalizedDividend.Part.Lo,
343 NormalizedDivisor.Part.Lo, Quotient.Part.Lo, Partial1);
346 * The quotient is always 32 bits, and simply requires
347 * adjustment. The 64-bit remainder must be generated.
349 Partial1 = Quotient.Part.Lo * Divisor.Part.Hi;
350 Partial2.Full = (UINT64) Quotient.Part.Lo * Divisor.Part.Lo;
351 Partial3.Full = (UINT64) Partial2.Part.Hi + Partial1;
353 Remainder.Part.Hi = Partial3.Part.Lo;
354 Remainder.Part.Lo = Partial2.Part.Lo;
356 if (Partial3.Part.Hi == 0)
358 if (Partial3.Part.Lo >= Dividend.Part.Hi)
360 if (Partial3.Part.Lo == Dividend.Part.Hi)
362 if (Partial2.Part.Lo > Dividend.Part.Lo)
365 Remainder.Full -= Divisor.Full;
371 Remainder.Full -= Divisor.Full;
375 Remainder.Full = Remainder.Full - Dividend.Full;
376 Remainder.Part.Hi = (UINT32) -((INT32) Remainder.Part.Hi);
377 Remainder.Part.Lo = (UINT32) -((INT32) Remainder.Part.Lo);
379 if (Remainder.Part.Lo)
386 /* Return only what was requested */
390 *OutQuotient = Quotient.Full;
394 *OutRemainder = Remainder.Full;
397 return_ACPI_STATUS (AE_OK);
402 /*******************************************************************************
404 * FUNCTION: AcpiUtShortDivide, AcpiUtDivide
406 * PARAMETERS: See function headers above
408 * DESCRIPTION: Native versions of the UtDivide functions. Use these if either
409 * 1) The target is a 64-bit platform and therefore 64-bit
410 * integer math is supported directly by the machine.
411 * 2) The target is a 32-bit or 16-bit platform, and the
412 * double-precision integer math library is available to
413 * perform the divide.
415 ******************************************************************************/
422 UINT32 *OutRemainder)
425 ACPI_FUNCTION_TRACE (UtShortDivide);
428 /* Always check for a zero divisor */
432 ACPI_ERROR ((AE_INFO, "Divide by zero"));
433 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
436 /* Return only what was requested */
440 *OutQuotient = InDividend / Divisor;
444 *OutRemainder = (UINT32) (InDividend % Divisor);
447 return_ACPI_STATUS (AE_OK);
455 UINT64 *OutRemainder)
457 ACPI_FUNCTION_TRACE (UtDivide);
460 /* Always check for a zero divisor */
464 ACPI_ERROR ((AE_INFO, "Divide by zero"));
465 return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
469 /* Return only what was requested */
473 *OutQuotient = InDividend / InDivisor;
477 *OutRemainder = InDividend % InDivisor;
480 return_ACPI_STATUS (AE_OK);