drivers/bus/acpi/acpica/executer/exutils.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exutils - interpreter/scanner utilities
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, 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 #define __EXUTILS_C__
 117
 118 /*
 119  * DEFINE_AML_GLOBALS is tested in amlcode.h
 120  * to determine whether certain global names should be "defined" or only
 121  * "declared" in the current compilation. This enhances maintainability
 122  * by enabling a single header file to embody all knowledge of the names
 123  * in question.
 124  *
 125  * Exactly one module of any executable should #define DEFINE_GLOBALS
 126  * before #including the header files which use this convention. The
 127  * names in question will be defined and initialized in that module,
 128  * and declared as extern in all other modules which #include those
 129  * header files.
 130  */
 131
 132 #define DEFINE_AML_GLOBALS
 133
 134 #include "acpi.h"
 135 #include "accommon.h"
 136 #include "acinterp.h"
 137 #include "amlcode.h"
 138
 139 #define _COMPONENT          ACPI_EXECUTER
 140         ACPI_MODULE_NAME    ("exutils")
 141
 142 /* Local prototypes */
 143
 144 static UINT32
 145 AcpiExDigitsNeeded (
 146     UINT64                  Value,
 147     UINT32                  Base);
 148
 149
 150 #ifndef ACPI_NO_METHOD_EXECUTION
 151 /*******************************************************************************
 152  *
 153  * FUNCTION:    AcpiExEnterInterpreter
 154  *
 155  * PARAMETERS:  None
 156  *
 157  * RETURN:      None
 158  *
 159  * DESCRIPTION: Enter the interpreter execution region. Failure to enter
 160  *              the interpreter region is a fatal system error. Used in
 161  *              conjunction with ExitInterpreter.
 162  *
 163  ******************************************************************************/
 164
 165 void
 166 AcpiExEnterInterpreter (
 167     void)
 168 {
 169     ACPI_STATUS             Status;
 170
 171
 172     ACPI_FUNCTION_TRACE (ExEnterInterpreter);
 173
 174
 175     Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
 176     if (ACPI_FAILURE (Status))
 177     {
 178         ACPI_ERROR ((AE_INFO, "Could not acquire AML Interpreter mutex"));
 179     }
 180
 181     return_VOID;
 182 }
 183
 184
 185 /*******************************************************************************
 186  *
 187  * FUNCTION:    AcpiExExitInterpreter
 188  *
 189  * PARAMETERS:  None
 190  *
 191  * RETURN:      None
 192  *
 193  * DESCRIPTION: Exit the interpreter execution region. This is the top level
 194  *              routine used to exit the interpreter when all processing has
 195  *              been completed, or when the method blocks.
 196  *
 197  * Cases where the interpreter is unlocked internally:
 198  *      1) Method will be blocked on a Sleep() AML opcode
 199  *      2) Method will be blocked on an Acquire() AML opcode
 200  *      3) Method will be blocked on a Wait() AML opcode
 201  *      4) Method will be blocked to acquire the global lock
 202  *      5) Method will be blocked waiting to execute a serialized control
 203  *          method that is currently executing
 204  *      6) About to invoke a user-installed opregion handler
 205  *
 206  ******************************************************************************/
 207
 208 void
 209 AcpiExExitInterpreter (
 210     void)
 211 {
 212     ACPI_STATUS             Status;
 213
 214
 215     ACPI_FUNCTION_TRACE (ExExitInterpreter);
 216
 217
 218     Status = AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
 219     if (ACPI_FAILURE (Status))
 220     {
 221         ACPI_ERROR ((AE_INFO, "Could not release AML Interpreter mutex"));
 222     }
 223
 224     return_VOID;
 225 }
 226
 227
 228 /*******************************************************************************
 229  *
 230  * FUNCTION:    AcpiExTruncateFor32bitTable
 231  *
 232  * PARAMETERS:  ObjDesc         - Object to be truncated
 233  *
 234  * RETURN:      TRUE if a truncation was performed, FALSE otherwise.
 235  *
 236  * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is
 237  *              32-bit, as determined by the revision of the DSDT.
 238  *
 239  ******************************************************************************/
 240
 241 BOOLEAN
 242 AcpiExTruncateFor32bitTable (
 243     ACPI_OPERAND_OBJECT     *ObjDesc)
 244 {
 245
 246     ACPI_FUNCTION_ENTRY ();
 247
 248
 249     /*
 250      * Object must be a valid number and we must be executing
 251      * a control method. Object could be NS node for AML_INT_NAMEPATH_OP.
 252      */
 253     if ((!ObjDesc) ||
 254         (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) ||
 255         (ObjDesc->Common.Type != ACPI_TYPE_INTEGER))
 256     {
 257         return (FALSE);
 258     }
 259
 260     if ((AcpiGbl_IntegerByteWidth == 4) &&
 261         (ObjDesc->Integer.Value > (UINT64) ACPI_UINT32_MAX))
 262     {
 263         /*
 264          * We are executing in a 32-bit ACPI table.
 265          * Truncate the value to 32 bits by zeroing out the upper 32-bit field
 266          */
 267         ObjDesc->Integer.Value &= (UINT64) ACPI_UINT32_MAX;
 268         return (TRUE);
 269     }
 270
 271     return (FALSE);
 272 }
 273
 274
 275 /*******************************************************************************
 276  *
 277  * FUNCTION:    AcpiExAcquireGlobalLock
 278  *
 279  * PARAMETERS:  FieldFlags            - Flags with Lock rule:
 280  *                                      AlwaysLock or NeverLock
 281  *
 282  * RETURN:      None
 283  *
 284  * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field
 285  *              flags specifiy that it is to be obtained before field access.
 286  *
 287  ******************************************************************************/
 288
 289 void
 290 AcpiExAcquireGlobalLock (
 291     UINT32                  FieldFlags)
 292 {
 293     ACPI_STATUS             Status;
 294
 295
 296     ACPI_FUNCTION_TRACE (ExAcquireGlobalLock);
 297
 298
 299     /* Only use the lock if the AlwaysLock bit is set */
 300
 301     if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
 302     {
 303         return_VOID;
 304     }
 305
 306     /* Attempt to get the global lock, wait forever */
 307
 308     Status = AcpiExAcquireMutexObject (ACPI_WAIT_FOREVER,
 309                 AcpiGbl_GlobalLockMutex, AcpiOsGetThreadId ());
 310
 311     if (ACPI_FAILURE (Status))
 312     {
 313         ACPI_EXCEPTION ((AE_INFO, Status,
 314             "Could not acquire Global Lock"));
 315     }
 316
 317     return_VOID;
 318 }
 319
 320
 321 /*******************************************************************************
 322  *
 323  * FUNCTION:    AcpiExReleaseGlobalLock
 324  *
 325  * PARAMETERS:  FieldFlags            - Flags with Lock rule:
 326  *                                      AlwaysLock or NeverLock
 327  *
 328  * RETURN:      None
 329  *
 330  * DESCRIPTION: Release the ACPI hardware Global Lock
 331  *
 332  ******************************************************************************/
 333
 334 void
 335 AcpiExReleaseGlobalLock (
 336     UINT32                  FieldFlags)
 337 {
 338     ACPI_STATUS             Status;
 339
 340
 341     ACPI_FUNCTION_TRACE (ExReleaseGlobalLock);
 342
 343
 344     /* Only use the lock if the AlwaysLock bit is set */
 345
 346     if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK))
 347     {
 348         return_VOID;
 349     }
 350
 351     /* Release the global lock */
 352
 353     Status = AcpiExReleaseMutexObject (AcpiGbl_GlobalLockMutex);
 354     if (ACPI_FAILURE (Status))
 355     {
 356         /* Report the error, but there isn't much else we can do */
 357
 358         ACPI_EXCEPTION ((AE_INFO, Status,
 359             "Could not release Global Lock"));
 360     }
 361
 362     return_VOID;
 363 }
 364
 365
 366 /*******************************************************************************
 367  *
 368  * FUNCTION:    AcpiExDigitsNeeded
 369  *
 370  * PARAMETERS:  Value           - Value to be represented
 371  *              Base            - Base of representation
 372  *
 373  * RETURN:      The number of digits.
 374  *
 375  * DESCRIPTION: Calculate the number of digits needed to represent the Value
 376  *              in the given Base (Radix)
 377  *
 378  ******************************************************************************/
 379
 380 static UINT32
 381 AcpiExDigitsNeeded (
 382     UINT64                  Value,
 383     UINT32                  Base)
 384 {
 385     UINT32                  NumDigits;
 386     UINT64                  CurrentValue;
 387
 388
 389     ACPI_FUNCTION_TRACE (ExDigitsNeeded);
 390
 391
 392     /* UINT64 is unsigned, so we don't worry about a '-' prefix */
 393
 394     if (Value == 0)
 395     {
 396         return_UINT32 (1);
 397     }
 398
 399     CurrentValue = Value;
 400     NumDigits = 0;
 401
 402     /* Count the digits in the requested base */
 403
 404     while (CurrentValue)
 405     {
 406         (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL);
 407         NumDigits++;
 408     }
 409
 410     return_UINT32 (NumDigits);
 411 }
 412
 413
 414 /*******************************************************************************
 415  *
 416  * FUNCTION:    AcpiExEisaIdToString
 417  *
 418  * PARAMETERS:  CompressedId    - EISAID to be converted
 419  *              OutString       - Where to put the converted string (8 bytes)
 420  *
 421  * RETURN:      None
 422  *
 423  * DESCRIPTION: Convert a numeric EISAID to string representation. Return
 424  *              buffer must be large enough to hold the string. The string
 425  *              returned is always exactly of length ACPI_EISAID_STRING_SIZE
 426  *              (includes null terminator). The EISAID is always 32 bits.
 427  *
 428  ******************************************************************************/
 429
 430 void
 431 AcpiExEisaIdToString (
 432     char                    *OutString,
 433     UINT64                  CompressedId)
 434 {
 435     UINT32                  SwappedId;
 436
 437
 438     ACPI_FUNCTION_ENTRY ();
 439
 440
 441     /* The EISAID should be a 32-bit integer */
 442
 443     if (CompressedId > ACPI_UINT32_MAX)
 444     {
 445         ACPI_WARNING ((AE_INFO,
 446             "Expected EISAID is larger than 32 bits: 0x%8.8X%8.8X, truncating",
 447             ACPI_FORMAT_UINT64 (CompressedId)));
 448     }
 449
 450     /* Swap ID to big-endian to get contiguous bits */
 451
 452     SwappedId = AcpiUtDwordByteSwap ((UINT32) CompressedId);
 453
 454     /* First 3 bytes are uppercase letters. Next 4 bytes are hexadecimal */
 455
 456     OutString[0] = (char) (0x40 + (((unsigned long) SwappedId >> 26) & 0x1F));
 457     OutString[1] = (char) (0x40 + ((SwappedId >> 21) & 0x1F));
 458     OutString[2] = (char) (0x40 + ((SwappedId >> 16) & 0x1F));
 459     OutString[3] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 12);
 460     OutString[4] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 8);
 461     OutString[5] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 4);
 462     OutString[6] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 0);
 463     OutString[7] = 0;
 464 }
 465
 466
 467 /*******************************************************************************
 468  *
 469  * FUNCTION:    AcpiExIntegerToString
 470  *
 471  * PARAMETERS:  OutString       - Where to put the converted string. At least
 472  *                                21 bytes are needed to hold the largest
 473  *                                possible 64-bit integer.
 474  *              Value           - Value to be converted
 475  *
 476  * RETURN:      None, string
 477  *
 478  * DESCRIPTION: Convert a 64-bit integer to decimal string representation.
 479  *              Assumes string buffer is large enough to hold the string. The
 480  *              largest string is (ACPI_MAX64_DECIMAL_DIGITS + 1).
 481  *
 482  ******************************************************************************/
 483
 484 void
 485 AcpiExIntegerToString (
 486     char                    *OutString,
 487     UINT64                  Value)
 488 {
 489     UINT32                  Count;
 490     UINT32                  DigitsNeeded;
 491     UINT32                  Remainder;
 492
 493
 494     ACPI_FUNCTION_ENTRY ();
 495
 496
 497     DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
 498     OutString[DigitsNeeded] = 0;
 499
 500     for (Count = DigitsNeeded; Count > 0; Count--)
 501     {
 502         (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder);
 503         OutString[Count-1] = (char) ('0' + Remainder);\
 504     }
 505 }
 506
 507
 508 /*******************************************************************************
 509  *
 510  * FUNCTION:    AcpiIsValidSpaceId
 511  *
 512  * PARAMETERS:  SpaceId             - ID to be validated
 513  *
 514  * RETURN:      TRUE if valid/supported ID.
 515  *
 516  * DESCRIPTION: Validate an operation region SpaceID.
 517  *
 518  ******************************************************************************/
 519
 520 BOOLEAN
 521 AcpiIsValidSpaceId (
 522     UINT8                   SpaceId)
 523 {
 524
 525     if ((SpaceId >= ACPI_NUM_PREDEFINED_REGIONS) &&
 526         (SpaceId < ACPI_USER_REGION_BEGIN) &&
 527         (SpaceId != ACPI_ADR_SPACE_DATA_TABLE) &&
 528         (SpaceId != ACPI_ADR_SPACE_FIXED_HARDWARE))
 529     {
 530         return (FALSE);
 531     }
 532
 533     return (TRUE);
 534 }
 535
 536
 537 #endif