sys/contrib/dev/acpica-unix-20031203/interpreter/executer/exutils.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exutils - interpreter/scanner utilities
   5  *              $Revision: 110 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #define __EXUTILS_C__
 119
 120 /*
 121  * DEFINE_AML_GLOBALS is tested in amlcode.h
 122  * to determine whether certain global names should be "defined" or only
 123  * "declared" in the current compilation.  This enhances maintainability
 124  * by enabling a single header file to embody all knowledge of the names
 125  * in question.
 126  *
 127  * Exactly one module of any executable should #define DEFINE_GLOBALS
 128  * before #including the header files which use this convention.  The
 129  * names in question will be defined and initialized in that module,
 130  * and declared as extern in all other modules which #include those
 131  * header files.
 132  */
 133
 134 #define DEFINE_AML_GLOBALS
 135
 136 #include "acpi.h"
 137 #include "acinterp.h"
 138 #include "amlcode.h"
 139 #include "acevents.h"
 140
 141 #define _COMPONENT          ACPI_EXECUTER
 142         ACPI_MODULE_NAME    ("exutils")
 143
 144
 145 #ifndef ACPI_NO_METHOD_EXECUTION
 146
 147 /*******************************************************************************
 148  *
 149  * FUNCTION:    AcpiExEnterInterpreter
 150  *
 151  * PARAMETERS:  None
 152  *
 153  * DESCRIPTION: Enter the interpreter execution region.  Failure to enter
 154  *              the interpreter region is a fatal system error
 155  *
 156  ******************************************************************************/
 157
 158 ACPI_STATUS
 159 AcpiExEnterInterpreter (void)
 160 {
 161     ACPI_STATUS             Status;
 162
 163     ACPI_FUNCTION_TRACE ("ExEnterInterpreter");
 164
 165
 166     Status = AcpiUtAcquireMutex (ACPI_MTX_EXECUTE);
 167     if (ACPI_FAILURE (Status))
 168     {
 169         ACPI_REPORT_ERROR (("Could not acquire interpreter mutex\n"));
 170     }
 171
 172     return_ACPI_STATUS (Status);
 173 }
 174
 175
 176 /*******************************************************************************
 177  *
 178  * FUNCTION:    AcpiExExitInterpreter
 179  *
 180  * PARAMETERS:  None
 181  *
 182  * DESCRIPTION: Exit the interpreter execution region
 183  *
 184  * Cases where the interpreter is unlocked:
 185  *      1) Completion of the execution of a control method
 186  *      2) Method blocked on a Sleep() AML opcode
 187  *      3) Method blocked on an Acquire() AML opcode
 188  *      4) Method blocked on a Wait() AML opcode
 189  *      5) Method blocked to acquire the global lock
 190  *      6) Method blocked to execute a serialized control method that is
 191  *          already executing
 192  *      7) About to invoke a user-installed opregion handler
 193  *
 194  ******************************************************************************/
 195
 196 void
 197 AcpiExExitInterpreter (void)
 198 {
 199     ACPI_STATUS             Status;
 200
 201
 202     ACPI_FUNCTION_TRACE ("ExExitInterpreter");
 203
 204
 205     Status = AcpiUtReleaseMutex (ACPI_MTX_EXECUTE);
 206     if (ACPI_FAILURE (Status))
 207     {
 208         ACPI_REPORT_ERROR (("Could not release interpreter mutex\n"));
 209     }
 210
 211     return_VOID;
 212 }
 213
 214
 215 /*******************************************************************************
 216  *
 217  * FUNCTION:    AcpiExTruncateFor32bitTable
 218  *
 219  * PARAMETERS:  ObjDesc         - Object to be truncated
 220  *
 221  * RETURN:      none
 222  *
 223  * DESCRIPTION: Truncate a number to 32-bits if the currently executing method
 224  *              belongs to a 32-bit ACPI table.
 225  *
 226  ******************************************************************************/
 227
 228 void
 229 AcpiExTruncateFor32bitTable (
 230     ACPI_OPERAND_OBJECT     *ObjDesc)
 231 {
 232
 233     ACPI_FUNCTION_ENTRY ();
 234
 235
 236     /*
 237      * Object must be a valid number and we must be executing
 238      * a control method
 239      */
 240     if ((!ObjDesc) ||
 241         (ACPI_GET_OBJECT_TYPE (ObjDesc) != ACPI_TYPE_INTEGER))
 242     {
 243         return;
 244     }
 245
 246     if (AcpiGbl_IntegerByteWidth == 4)
 247     {
 248         /*
 249          * We are running a method that exists in a 32-bit ACPI table.
 250          * Truncate the value to 32 bits by zeroing out the upper 32-bit field
 251          */
 252         ObjDesc->Integer.Value &= (ACPI_INTEGER) ACPI_UINT32_MAX;
 253     }
 254 }
 255
 256
 257 /*******************************************************************************
 258  *
 259  * FUNCTION:    AcpiExAcquireGlobalLock
 260  *
 261  * PARAMETERS:  FieldFlags            - Flags with Lock rule:
 262  *                                      AlwaysLock or NeverLock
 263  *
 264  * RETURN:      TRUE/FALSE indicating whether the lock was actually acquired
 265  *
 266  * DESCRIPTION: Obtain the global lock and keep track of this fact via two
 267  *              methods.  A global variable keeps the state of the lock, and
 268  *              the state is returned to the caller.
 269  *
 270  ******************************************************************************/
 271
 272 BOOLEAN
 273 AcpiExAcquireGlobalLock (
 274     UINT32                  FieldFlags)
 275 {
 276     BOOLEAN                 Locked = FALSE;
 277     ACPI_STATUS             Status;
 278
 279
 280     ACPI_FUNCTION_TRACE ("ExAcquireGlobalLock");
 281
 282
 283     /* Only attempt lock if the AlwaysLock bit is set */
 284
 285     if (FieldFlags & AML_FIELD_LOCK_RULE_MASK)
 286     {
 287         /* We should attempt to get the lock, wait forever */
 288
 289         Status = AcpiEvAcquireGlobalLock (ACPI_WAIT_FOREVER);
 290         if (ACPI_SUCCESS (Status))
 291         {
 292             Locked = TRUE;
 293         }
 294         else
 295         {
 296             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not acquire Global Lock, %s\n",
 297                 AcpiFormatException (Status)));
 298         }
 299     }
 300
 301     return_VALUE (Locked);
 302 }
 303
 304
 305 /*******************************************************************************
 306  *
 307  * FUNCTION:    AcpiExReleaseGlobalLock
 308  *
 309  * PARAMETERS:  LockedByMe      - Return value from corresponding call to
 310  *                                AcquireGlobalLock.
 311  *
 312  * RETURN:      Status
 313  *
 314  * DESCRIPTION: Release the global lock if it is locked.
 315  *
 316  ******************************************************************************/
 317
 318 void
 319 AcpiExReleaseGlobalLock (
 320     BOOLEAN                 LockedByMe)
 321 {
 322     ACPI_STATUS             Status;
 323
 324
 325     ACPI_FUNCTION_TRACE ("ExReleaseGlobalLock");
 326
 327
 328     /* Only attempt unlock if the caller locked it */
 329
 330     if (LockedByMe)
 331     {
 332         /* OK, now release the lock */
 333
 334         Status = AcpiEvReleaseGlobalLock ();
 335         if (ACPI_FAILURE (Status))
 336         {
 337             /* Report the error, but there isn't much else we can do */
 338
 339             ACPI_REPORT_ERROR (("Could not release ACPI Global Lock, %s\n",
 340                 AcpiFormatException (Status)));
 341         }
 342     }
 343
 344     return_VOID;
 345 }
 346
 347
 348 /*******************************************************************************
 349  *
 350  * FUNCTION:    AcpiExDigitsNeeded
 351  *
 352  * PARAMETERS:  Value           - Value to be represented
 353  *              Base            - Base of representation
 354  *
 355  * RETURN:      the number of digits needed to represent Value in Base
 356  *
 357  ******************************************************************************/
 358
 359 UINT32
 360 AcpiExDigitsNeeded (
 361     ACPI_INTEGER            Value,
 362     UINT32                  Base)
 363 {
 364     UINT32                  NumDigits;
 365     ACPI_INTEGER            CurrentValue;
 366     ACPI_INTEGER            Quotient;
 367
 368
 369     ACPI_FUNCTION_TRACE ("ExDigitsNeeded");
 370
 371
 372     /*
 373      * ACPI_INTEGER is unsigned, so we don't worry about a '-'
 374      */
 375     if ((CurrentValue = Value) == 0)
 376     {
 377         return_VALUE (1);
 378     }
 379
 380     NumDigits = 0;
 381
 382     while (CurrentValue)
 383     {
 384         (void) AcpiUtShortDivide (&CurrentValue, Base, &Quotient, NULL);
 385         NumDigits++;
 386         CurrentValue = Quotient;
 387     }
 388
 389     return_VALUE (NumDigits);
 390 }
 391
 392
 393 /*******************************************************************************
 394  *
 395  * FUNCTION:    AcpiExEisaIdToString
 396  *
 397  * PARAMETERS:  NumericId       - EISA ID to be converted
 398  *              OutString       - Where to put the converted string (8 bytes)
 399  *
 400  * DESCRIPTION: Convert a numeric EISA ID to string representation
 401  *
 402  ******************************************************************************/
 403
 404 void
 405 AcpiExEisaIdToString (
 406     UINT32                  NumericId,
 407     char                    *OutString)
 408 {
 409     UINT32                  EisaId;
 410
 411
 412     ACPI_FUNCTION_ENTRY ();
 413
 414
 415     /* Swap ID to big-endian to get contiguous bits */
 416
 417     EisaId = AcpiUtDwordByteSwap (NumericId);
 418
 419     OutString[0] = (char) ('@' + (((unsigned long) EisaId >> 26) & 0x1f));
 420     OutString[1] = (char) ('@' + ((EisaId >> 21) & 0x1f));
 421     OutString[2] = (char) ('@' + ((EisaId >> 16) & 0x1f));
 422     OutString[3] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 12);
 423     OutString[4] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 8);
 424     OutString[5] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 4);
 425     OutString[6] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 0);
 426     OutString[7] = 0;
 427 }
 428
 429
 430 /*******************************************************************************
 431  *
 432  * FUNCTION:    AcpiExUnsignedIntegerToString
 433  *
 434  * PARAMETERS:  Value           - Value to be converted
 435  *              OutString       - Where to put the converted string (8 bytes)
 436  *
 437  * RETURN:      Convert a number to string representation
 438  *
 439  ******************************************************************************/
 440
 441 void
 442 AcpiExUnsignedIntegerToString (
 443     ACPI_INTEGER            Value,
 444     char                    *OutString)
 445 {
 446     UINT32                  Count;
 447     UINT32                  DigitsNeeded;
 448     UINT32                  Remainder;
 449     ACPI_INTEGER            Quotient;
 450
 451
 452     ACPI_FUNCTION_ENTRY ();
 453
 454
 455     DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
 456     OutString[DigitsNeeded] = 0;
 457
 458     for (Count = DigitsNeeded; Count > 0; Count--)
 459     {
 460         (void) AcpiUtShortDivide (&Value, 10, &Quotient, &Remainder);
 461         OutString[Count-1] = (char) ('0' + Remainder);\
 462         Value = Quotient;
 463     }
 464 }
 465
 466 #endif