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