drivers/acpi/components/utilities/utmath.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: utmath - Integer math support routines
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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
  19  * property rights.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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
  64  * make.
  65  *
  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
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  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.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  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
  88  * PARTICULAR PURPOSE.
  89  *
  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
  97  * LIMITED REMEDY.
  98  *
  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.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118
 119
 120 #define _COMPONENT          ACPI_UTILITIES
 121         ACPI_MODULE_NAME    ("utmath")
 122
 123 /*
 124  * Optional support for 64-bit double-precision integer divide. This code
 125  * is configurable and is implemented in order to support 32-bit kernel
 126  * environments where a 64-bit double-precision math library is not available.
 127  *
 128  * Support for a more normal 64-bit divide/modulo (with check for a divide-
 129  * by-zero) appears after this optional section of code.
 130  */
 131 #ifndef ACPI_USE_NATIVE_DIVIDE
 132
 133 /* Structures used only for 64-bit divide */
 134
 135 typedef struct uint64_struct
 136 {
 137     UINT32                          Lo;
 138     UINT32                          Hi;
 139
 140 } UINT64_STRUCT;
 141
 142 typedef union uint64_overlay
 143 {
 144     UINT64                          Full;
 145     UINT64_STRUCT                   Part;
 146
 147 } UINT64_OVERLAY;
 148
 149
 150 /*******************************************************************************
 151  *
 152  * FUNCTION:    AcpiUtShortDivide
 153  *
 154  * PARAMETERS:  Dividend            - 64-bit dividend
 155  *              Divisor             - 32-bit divisor
 156  *              OutQuotient         - Pointer to where the quotient is returned
 157  *              OutRemainder        - Pointer to where the remainder is returned
 158  *
 159  * RETURN:      Status (Checks for divide-by-zero)
 160  *
 161  * DESCRIPTION: Perform a short (maximum 64 bits divided by 32 bits)
 162  *              divide and modulo. The result is a 64-bit quotient and a
 163  *              32-bit remainder.
 164  *
 165  ******************************************************************************/
 166
 167 ACPI_STATUS
 168 AcpiUtShortDivide (
 169     UINT64                  Dividend,
 170     UINT32                  Divisor,
 171     UINT64                  *OutQuotient,
 172     UINT32                  *OutRemainder)
 173 {
 174     UINT64_OVERLAY          DividendOvl;
 175     UINT64_OVERLAY          Quotient;
 176     UINT32                  Remainder32;
 177
 178
 179     ACPI_FUNCTION_TRACE (UtShortDivide);
 180
 181
 182     /* Always check for a zero divisor */
 183
 184     if (Divisor == 0)
 185     {
 186         ACPI_ERROR ((AE_INFO, "Divide by zero"));
 187         return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
 188     }
 189
 190     DividendOvl.Full = Dividend;
 191
 192     /*
 193      * The quotient is 64 bits, the remainder is always 32 bits,
 194      * and is generated by the second divide.
 195      */
 196     ACPI_DIV_64_BY_32 (0, DividendOvl.Part.Hi, Divisor,
 197                        Quotient.Part.Hi, Remainder32);
 198     ACPI_DIV_64_BY_32 (Remainder32, DividendOvl.Part.Lo, Divisor,
 199                        Quotient.Part.Lo, Remainder32);
 200
 201     /* Return only what was requested */
 202
 203     if (OutQuotient)
 204     {
 205         *OutQuotient = Quotient.Full;
 206     }
 207     if (OutRemainder)
 208     {
 209         *OutRemainder = Remainder32;
 210     }
 211
 212     return_ACPI_STATUS (AE_OK);
 213 }
 214
 215
 216 /*******************************************************************************
 217  *
 218  * FUNCTION:    AcpiUtDivide
 219  *
 220  * PARAMETERS:  InDividend          - Dividend
 221  *              InDivisor           - Divisor
 222  *              OutQuotient         - Pointer to where the quotient is returned
 223  *              OutRemainder        - Pointer to where the remainder is returned
 224  *
 225  * RETURN:      Status (Checks for divide-by-zero)
 226  *
 227  * DESCRIPTION: Perform a divide and modulo.
 228  *
 229  ******************************************************************************/
 230
 231 ACPI_STATUS
 232 AcpiUtDivide (
 233     UINT64                  InDividend,
 234     UINT64                  InDivisor,
 235     UINT64                  *OutQuotient,
 236     UINT64                  *OutRemainder)
 237 {
 238     UINT64_OVERLAY          Dividend;
 239     UINT64_OVERLAY          Divisor;
 240     UINT64_OVERLAY          Quotient;
 241     UINT64_OVERLAY          Remainder;
 242     UINT64_OVERLAY          NormalizedDividend;
 243     UINT64_OVERLAY          NormalizedDivisor;
 244     UINT32                  Partial1;
 245     UINT64_OVERLAY          Partial2;
 246     UINT64_OVERLAY          Partial3;
 247
 248
 249     ACPI_FUNCTION_TRACE (UtDivide);
 250
 251
 252     /* Always check for a zero divisor */
 253
 254     if (InDivisor == 0)
 255     {
 256         ACPI_ERROR ((AE_INFO, "Divide by zero"));
 257         return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
 258     }
 259
 260     Divisor.Full  = InDivisor;
 261     Dividend.Full = InDividend;
 262     if (Divisor.Part.Hi == 0)
 263     {
 264         /*
 265          * 1) Simplest case is where the divisor is 32 bits, we can
 266          * just do two divides
 267          */
 268         Remainder.Part.Hi = 0;
 269
 270         /*
 271          * The quotient is 64 bits, the remainder is always 32 bits,
 272          * and is generated by the second divide.
 273          */
 274         ACPI_DIV_64_BY_32 (0, Dividend.Part.Hi, Divisor.Part.Lo,
 275                            Quotient.Part.Hi, Partial1);
 276         ACPI_DIV_64_BY_32 (Partial1, Dividend.Part.Lo, Divisor.Part.Lo,
 277                            Quotient.Part.Lo, Remainder.Part.Lo);
 278     }
 279
 280     else
 281     {
 282         /*
 283          * 2) The general case where the divisor is a full 64 bits
 284          * is more difficult
 285          */
 286         Quotient.Part.Hi   = 0;
 287         NormalizedDividend = Dividend;
 288         NormalizedDivisor  = Divisor;
 289
 290         /* Normalize the operands (shift until the divisor is < 32 bits) */
 291
 292         do
 293         {
 294             ACPI_SHIFT_RIGHT_64 (NormalizedDivisor.Part.Hi,
 295                                  NormalizedDivisor.Part.Lo);
 296             ACPI_SHIFT_RIGHT_64 (NormalizedDividend.Part.Hi,
 297                                  NormalizedDividend.Part.Lo);
 298
 299         } while (NormalizedDivisor.Part.Hi != 0);
 300
 301         /* Partial divide */
 302
 303         ACPI_DIV_64_BY_32 (NormalizedDividend.Part.Hi,
 304                            NormalizedDividend.Part.Lo,
 305                            NormalizedDivisor.Part.Lo,
 306                            Quotient.Part.Lo, Partial1);
 307
 308         /*
 309          * The quotient is always 32 bits, and simply requires adjustment.
 310          * The 64-bit remainder must be generated.
 311          */
 312         Partial1      = Quotient.Part.Lo * Divisor.Part.Hi;
 313         Partial2.Full = (UINT64) Quotient.Part.Lo * Divisor.Part.Lo;
 314         Partial3.Full = (UINT64) Partial2.Part.Hi + Partial1;
 315
 316         Remainder.Part.Hi = Partial3.Part.Lo;
 317         Remainder.Part.Lo = Partial2.Part.Lo;
 318
 319         if (Partial3.Part.Hi == 0)
 320         {
 321             if (Partial3.Part.Lo >= Dividend.Part.Hi)
 322             {
 323                 if (Partial3.Part.Lo == Dividend.Part.Hi)
 324                 {
 325                     if (Partial2.Part.Lo > Dividend.Part.Lo)
 326                     {
 327                         Quotient.Part.Lo--;
 328                         Remainder.Full -= Divisor.Full;
 329                     }
 330                 }
 331                 else
 332                 {
 333                     Quotient.Part.Lo--;
 334                     Remainder.Full -= Divisor.Full;
 335                 }
 336             }
 337
 338             Remainder.Full    = Remainder.Full - Dividend.Full;
 339             Remainder.Part.Hi = (UINT32) -((INT32) Remainder.Part.Hi);
 340             Remainder.Part.Lo = (UINT32) -((INT32) Remainder.Part.Lo);
 341
 342             if (Remainder.Part.Lo)
 343             {
 344                 Remainder.Part.Hi--;
 345             }
 346         }
 347     }
 348
 349     /* Return only what was requested */
 350
 351     if (OutQuotient)
 352     {
 353         *OutQuotient = Quotient.Full;
 354     }
 355     if (OutRemainder)
 356     {
 357         *OutRemainder = Remainder.Full;
 358     }
 359
 360     return_ACPI_STATUS (AE_OK);
 361 }
 362
 363 #else
 364
 365 /*******************************************************************************
 366  *
 367  * FUNCTION:    AcpiUtShortDivide, AcpiUtDivide
 368  *
 369  * PARAMETERS:  See function headers above
 370  *
 371  * DESCRIPTION: Native versions of the UtDivide functions. Use these if either
 372  *              1) The target is a 64-bit platform and therefore 64-bit
 373  *                 integer math is supported directly by the machine.
 374  *              2) The target is a 32-bit or 16-bit platform, and the
 375  *                 double-precision integer math library is available to
 376  *                 perform the divide.
 377  *
 378  ******************************************************************************/
 379
 380 ACPI_STATUS
 381 AcpiUtShortDivide (
 382     UINT64                  InDividend,
 383     UINT32                  Divisor,
 384     UINT64                  *OutQuotient,
 385     UINT32                  *OutRemainder)
 386 {
 387
 388     ACPI_FUNCTION_TRACE (UtShortDivide);
 389
 390
 391     /* Always check for a zero divisor */
 392
 393     if (Divisor == 0)
 394     {
 395         ACPI_ERROR ((AE_INFO, "Divide by zero"));
 396         return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
 397     }
 398
 399     /* Return only what was requested */
 400
 401     if (OutQuotient)
 402     {
 403         *OutQuotient = InDividend / Divisor;
 404     }
 405     if (OutRemainder)
 406     {
 407         *OutRemainder = (UINT32) (InDividend % Divisor);
 408     }
 409
 410     return_ACPI_STATUS (AE_OK);
 411 }
 412
 413 ACPI_STATUS
 414 AcpiUtDivide (
 415     UINT64                  InDividend,
 416     UINT64                  InDivisor,
 417     UINT64                  *OutQuotient,
 418     UINT64                  *OutRemainder)
 419 {
 420     ACPI_FUNCTION_TRACE (UtDivide);
 421
 422
 423     /* Always check for a zero divisor */
 424
 425     if (InDivisor == 0)
 426     {
 427         ACPI_ERROR ((AE_INFO, "Divide by zero"));
 428         return_ACPI_STATUS (AE_AML_DIVIDE_BY_ZERO);
 429     }
 430
 431
 432     /* Return only what was requested */
 433
 434     if (OutQuotient)
 435     {
 436         *OutQuotient = InDividend / InDivisor;
 437     }
 438     if (OutRemainder)
 439     {
 440         *OutRemainder = InDividend % InDivisor;
 441     }
 442
 443     return_ACPI_STATUS (AE_OK);
 444 }
 445
 446 #endif