1 /*******************************************************************************
3 * Module Name: utmath - Integer math support routines
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
47 #define _COMPONENT ACPI_UTILITIES
48 ACPI_MODULE_NAME("utmath")
51 * Support for double-precision integer divide. This code is included here
52 * in order to support kernel environments where the double-precision math
53 * library is not available.
55 #ifndef ACPI_USE_NATIVE_DIVIDE
56 /*******************************************************************************
58 * FUNCTION: acpi_ut_short_divide
60 * PARAMETERS: Dividend - 64-bit dividend
61 * Divisor - 32-bit divisor
62 * out_quotient - Pointer to where the quotient is returned
63 * out_remainder - Pointer to where the remainder is returned
65 * RETURN: Status (Checks for divide-by-zero)
67 * DESCRIPTION: Perform a short (maximum 64 bits divided by 32 bits)
68 * divide and modulo. The result is a 64-bit quotient and a
71 ******************************************************************************/
73 acpi_ut_short_divide(acpi_integer dividend,
75 acpi_integer * out_quotient, u32 * out_remainder)
77 union uint64_overlay dividend_ovl;
78 union uint64_overlay quotient;
81 ACPI_FUNCTION_TRACE(ut_short_divide);
83 /* Always check for a zero divisor */
86 ACPI_ERROR((AE_INFO, "Divide by zero"));
87 return_ACPI_STATUS(AE_AML_DIVIDE_BY_ZERO);
90 dividend_ovl.full = dividend;
93 * The quotient is 64 bits, the remainder is always 32 bits,
94 * and is generated by the second divide.
96 ACPI_DIV_64_BY_32(0, dividend_ovl.part.hi, divisor,
97 quotient.part.hi, remainder32);
98 ACPI_DIV_64_BY_32(remainder32, dividend_ovl.part.lo, divisor,
99 quotient.part.lo, remainder32);
101 /* Return only what was requested */
104 *out_quotient = quotient.full;
107 *out_remainder = remainder32;
110 return_ACPI_STATUS(AE_OK);
113 /*******************************************************************************
115 * FUNCTION: acpi_ut_divide
117 * PARAMETERS: in_dividend - Dividend
118 * in_divisor - Divisor
119 * out_quotient - Pointer to where the quotient is returned
120 * out_remainder - Pointer to where the remainder is returned
122 * RETURN: Status (Checks for divide-by-zero)
124 * DESCRIPTION: Perform a divide and modulo.
126 ******************************************************************************/
129 acpi_ut_divide(acpi_integer in_dividend,
130 acpi_integer in_divisor,
131 acpi_integer * out_quotient, acpi_integer * out_remainder)
133 union uint64_overlay dividend;
134 union uint64_overlay divisor;
135 union uint64_overlay quotient;
136 union uint64_overlay remainder;
137 union uint64_overlay normalized_dividend;
138 union uint64_overlay normalized_divisor;
140 union uint64_overlay partial2;
141 union uint64_overlay partial3;
143 ACPI_FUNCTION_TRACE(ut_divide);
145 /* Always check for a zero divisor */
147 if (in_divisor == 0) {
148 ACPI_ERROR((AE_INFO, "Divide by zero"));
149 return_ACPI_STATUS(AE_AML_DIVIDE_BY_ZERO);
152 divisor.full = in_divisor;
153 dividend.full = in_dividend;
154 if (divisor.part.hi == 0) {
156 * 1) Simplest case is where the divisor is 32 bits, we can
157 * just do two divides
159 remainder.part.hi = 0;
162 * The quotient is 64 bits, the remainder is always 32 bits,
163 * and is generated by the second divide.
165 ACPI_DIV_64_BY_32(0, dividend.part.hi, divisor.part.lo,
166 quotient.part.hi, partial1);
167 ACPI_DIV_64_BY_32(partial1, dividend.part.lo, divisor.part.lo,
168 quotient.part.lo, remainder.part.lo);
173 * 2) The general case where the divisor is a full 64 bits
176 quotient.part.hi = 0;
177 normalized_dividend = dividend;
178 normalized_divisor = divisor;
180 /* Normalize the operands (shift until the divisor is < 32 bits) */
183 ACPI_SHIFT_RIGHT_64(normalized_divisor.part.hi,
184 normalized_divisor.part.lo);
185 ACPI_SHIFT_RIGHT_64(normalized_dividend.part.hi,
186 normalized_dividend.part.lo);
188 } while (normalized_divisor.part.hi != 0);
192 ACPI_DIV_64_BY_32(normalized_dividend.part.hi,
193 normalized_dividend.part.lo,
194 normalized_divisor.part.lo,
195 quotient.part.lo, partial1);
198 * The quotient is always 32 bits, and simply requires adjustment.
199 * The 64-bit remainder must be generated.
201 partial1 = quotient.part.lo * divisor.part.hi;
203 (acpi_integer) quotient.part.lo * divisor.part.lo;
204 partial3.full = (acpi_integer) partial2.part.hi + partial1;
206 remainder.part.hi = partial3.part.lo;
207 remainder.part.lo = partial2.part.lo;
209 if (partial3.part.hi == 0) {
210 if (partial3.part.lo >= dividend.part.hi) {
211 if (partial3.part.lo == dividend.part.hi) {
212 if (partial2.part.lo > dividend.part.lo) {
214 remainder.full -= divisor.full;
218 remainder.full -= divisor.full;
222 remainder.full = remainder.full - dividend.full;
223 remainder.part.hi = (u32) - ((s32) remainder.part.hi);
224 remainder.part.lo = (u32) - ((s32) remainder.part.lo);
226 if (remainder.part.lo) {
232 /* Return only what was requested */
235 *out_quotient = quotient.full;
238 *out_remainder = remainder.full;
241 return_ACPI_STATUS(AE_OK);
245 /*******************************************************************************
247 * FUNCTION: acpi_ut_short_divide, acpi_ut_divide
249 * PARAMETERS: See function headers above
251 * DESCRIPTION: Native versions of the ut_divide functions. Use these if either
252 * 1) The target is a 64-bit platform and therefore 64-bit
253 * integer math is supported directly by the machine.
254 * 2) The target is a 32-bit or 16-bit platform, and the
255 * double-precision integer math library is available to
256 * perform the divide.
258 ******************************************************************************/
260 acpi_ut_short_divide(acpi_integer in_dividend,
262 acpi_integer * out_quotient, u32 * out_remainder)
265 ACPI_FUNCTION_TRACE(ut_short_divide);
267 /* Always check for a zero divisor */
270 ACPI_ERROR((AE_INFO, "Divide by zero"));
271 return_ACPI_STATUS(AE_AML_DIVIDE_BY_ZERO);
274 /* Return only what was requested */
277 *out_quotient = in_dividend / divisor;
280 *out_remainder = (u32) (in_dividend % divisor);
283 return_ACPI_STATUS(AE_OK);
287 acpi_ut_divide(acpi_integer in_dividend,
288 acpi_integer in_divisor,
289 acpi_integer * out_quotient, acpi_integer * out_remainder)
291 ACPI_FUNCTION_TRACE(ut_divide);
293 /* Always check for a zero divisor */
295 if (in_divisor == 0) {
296 ACPI_ERROR((AE_INFO, "Divide by zero"));
297 return_ACPI_STATUS(AE_AML_DIVIDE_BY_ZERO);
300 /* Return only what was requested */
303 *out_quotient = in_dividend / in_divisor;
306 *out_remainder = in_dividend % in_divisor;
309 return_ACPI_STATUS(AE_OK);