sys/contrib/dev/acpica/exutils.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exutils - interpreter/scanner utilities
   5  *              $Revision: 1.118 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2005, 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 <contrib/dev/acpica/acpi.h>
 137 #include <contrib/dev/acpica/acinterp.h>
 138 #include <contrib/dev/acpica/amlcode.h>
 139 #include <contrib/dev/acpica/acevents.h>
 140
 141 #define _COMPONENT          ACPI_EXECUTER
 142         ACPI_MODULE_NAME    ("exutils")
 143
 144 /* Local prototypes */
 145
 146 static UINT32
 147 AcpiExDigitsNeeded (
 148     ACPI_INTEGER            Value,
 149     UINT32                  Base);
 150
 151
 152 #ifndef ACPI_NO_METHOD_EXECUTION
 153 /*******************************************************************************
 154  *
 155  * FUNCTION:    AcpiExEnterInterpreter
 156  *
 157  * PARAMETERS:  None
 158  *
 159  * RETURN:      Status
 160  *
 161  * DESCRIPTION: Enter the interpreter execution region.  Failure to enter
 162  *              the interpreter region is a fatal system error
 163  *
 164  ******************************************************************************/
 165
 166 ACPI_STATUS
 167 AcpiExEnterInterpreter (
 168     void)
 169 {
 170     ACPI_STATUS             Status;
 171
 172     ACPI_FUNCTION_TRACE ("ExEnterInterpreter");
 173
 174
 175     Status = AcpiUtAcquireMutex (ACPI_MTX_EXECUTE);
 176     if (ACPI_FAILURE (Status))
 177     {
 178         ACPI_REPORT_ERROR (("Could not acquire interpreter mutex\n"));
 179     }
 180
 181     return_ACPI_STATUS (Status);
 182 }
 183
 184
 185 /*******************************************************************************
 186  *
 187  * FUNCTION:    AcpiExExitInterpreter
 188  *
 189  * PARAMETERS:  None
 190  *
 191  * RETURN:      None
 192  *
 193  * DESCRIPTION: Exit the interpreter execution region
 194  *
 195  * Cases where the interpreter is unlocked:
 196  *      1) Completion of the execution of a control method
 197  *      2) Method blocked on a Sleep() AML opcode
 198  *      3) Method blocked on an Acquire() AML opcode
 199  *      4) Method blocked on a Wait() AML opcode
 200  *      5) Method blocked to acquire the global lock
 201  *      6) Method blocked to execute a serialized control method that is
 202  *          already executing
 203  *      7) About to invoke a user-installed opregion handler
 204  *
 205  ******************************************************************************/
 206
 207 void
 208 AcpiExExitInterpreter (
 209     void)
 210 {
 211     ACPI_STATUS             Status;
 212
 213
 214     ACPI_FUNCTION_TRACE ("ExExitInterpreter");
 215
 216
 217     Status = AcpiUtReleaseMutex (ACPI_MTX_EXECUTE);
 218     if (ACPI_FAILURE (Status))
 219     {
 220         ACPI_REPORT_ERROR (("Could not release interpreter mutex\n"));
 221     }
 222
 223     return_VOID;
 224 }
 225
 226
 227 /*******************************************************************************
 228  *
 229  * FUNCTION:    AcpiExTruncateFor32bitTable
 230  *
 231  * PARAMETERS:  ObjDesc         - Object to be truncated
 232  *
 233  * RETURN:      none
 234  *
 235  * DESCRIPTION: Truncate a number to 32-bits if the currently executing method
 236  *              belongs to a 32-bit ACPI table.
 237  *
 238  ******************************************************************************/
 239
 240 void
 241 AcpiExTruncateFor32bitTable (
 242     ACPI_OPERAND_OBJECT     *ObjDesc)
 243 {
 244
 245     ACPI_FUNCTION_ENTRY ();
 246
 247
 248     /*
 249      * Object must be a valid number and we must be executing
 250      * a control method
 251      */
 252     if ((!ObjDesc) ||
 253         (ACPI_GET_OBJECT_TYPE (ObjDesc) != ACPI_TYPE_INTEGER))
 254     {
 255         return;
 256     }
 257
 258     if (AcpiGbl_IntegerByteWidth == 4)
 259     {
 260         /*
 261          * We are running a method that exists in a 32-bit ACPI table.
 262          * Truncate the value to 32 bits by zeroing out the upper 32-bit field
 263          */
 264         ObjDesc->Integer.Value &= (ACPI_INTEGER) ACPI_UINT32_MAX;
 265     }
 266 }
 267
 268
 269 /*******************************************************************************
 270  *
 271  * FUNCTION:    AcpiExAcquireGlobalLock
 272  *
 273  * PARAMETERS:  FieldFlags            - Flags with Lock rule:
 274  *                                      AlwaysLock or NeverLock
 275  *
 276  * RETURN:      TRUE/FALSE indicating whether the lock was actually acquired
 277  *
 278  * DESCRIPTION: Obtain the global lock and keep track of this fact via two
 279  *              methods.  A global variable keeps the state of the lock, and
 280  *              the state is returned to the caller.
 281  *
 282  ******************************************************************************/
 283
 284 BOOLEAN
 285 AcpiExAcquireGlobalLock (
 286     UINT32                  FieldFlags)
 287 {
 288     BOOLEAN                 Locked = FALSE;
 289     ACPI_STATUS             Status;
 290
 291
 292     ACPI_FUNCTION_TRACE ("ExAcquireGlobalLock");
 293
 294
 295     /* Only attempt lock if the AlwaysLock bit is set */
 296
 297     if (FieldFlags & AML_FIELD_LOCK_RULE_MASK)
 298     {
 299         /* We should attempt to get the lock, wait forever */
 300
 301         Status = AcpiEvAcquireGlobalLock (ACPI_WAIT_FOREVER);
 302         if (ACPI_SUCCESS (Status))
 303         {
 304             Locked = TRUE;
 305         }
 306         else
 307         {
 308             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 309                 "Could not acquire Global Lock, %s\n",
 310                 AcpiFormatException (Status)));
 311         }
 312     }
 313
 314     return_UINT8 (Locked);
 315 }
 316
 317
 318 /*******************************************************************************
 319  *
 320  * FUNCTION:    AcpiExReleaseGlobalLock
 321  *
 322  * PARAMETERS:  LockedByMe      - Return value from corresponding call to
 323  *                                AcquireGlobalLock.
 324  *
 325  * RETURN:      None
 326  *
 327  * DESCRIPTION: Release the global lock if it is locked.
 328  *
 329  ******************************************************************************/
 330
 331 void
 332 AcpiExReleaseGlobalLock (
 333     BOOLEAN                 LockedByMe)
 334 {
 335     ACPI_STATUS             Status;
 336
 337
 338     ACPI_FUNCTION_TRACE ("ExReleaseGlobalLock");
 339
 340
 341     /* Only attempt unlock if the caller locked it */
 342
 343     if (LockedByMe)
 344     {
 345         /* OK, now release the lock */
 346
 347         Status = AcpiEvReleaseGlobalLock ();
 348         if (ACPI_FAILURE (Status))
 349         {
 350             /* Report the error, but there isn't much else we can do */
 351
 352             ACPI_REPORT_ERROR (("Could not release ACPI Global Lock, %s\n",
 353                 AcpiFormatException (Status)));
 354         }
 355     }
 356
 357     return_VOID;
 358 }
 359
 360
 361 /*******************************************************************************
 362  *
 363  * FUNCTION:    AcpiExDigitsNeeded
 364  *
 365  * PARAMETERS:  Value           - Value to be represented
 366  *              Base            - Base of representation
 367  *
 368  * RETURN:      The number of digits.
 369  *
 370  * DESCRIPTION: Calculate the number of digits needed to represent the Value
 371  *              in the given Base (Radix)
 372  *
 373  ******************************************************************************/
 374
 375 static UINT32
 376 AcpiExDigitsNeeded (
 377     ACPI_INTEGER            Value,
 378     UINT32                  Base)
 379 {
 380     UINT32                  NumDigits;
 381     ACPI_INTEGER            CurrentValue;
 382
 383
 384     ACPI_FUNCTION_TRACE ("ExDigitsNeeded");
 385
 386
 387     /* ACPI_INTEGER is unsigned, so we don't worry about a '-' prefix */
 388
 389     if (Value == 0)
 390     {
 391         return_UINT32 (1);
 392     }
 393
 394     CurrentValue = Value;
 395     NumDigits = 0;
 396
 397     /* Count the digits in the requested base */
 398
 399     while (CurrentValue)
 400     {
 401         (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL);
 402         NumDigits++;
 403     }
 404
 405     return_UINT32 (NumDigits);
 406 }
 407
 408
 409 /*******************************************************************************
 410  *
 411  * FUNCTION:    AcpiExEisaIdToString
 412  *
 413  * PARAMETERS:  NumericId       - EISA ID to be converted
 414  *              OutString       - Where to put the converted string (8 bytes)
 415  *
 416  * RETURN:      None
 417  *
 418  * DESCRIPTION: Convert a numeric EISA ID to string representation
 419  *
 420  ******************************************************************************/
 421
 422 void
 423 AcpiExEisaIdToString (
 424     UINT32                  NumericId,
 425     char                    *OutString)
 426 {
 427     UINT32                  EisaId;
 428
 429
 430     ACPI_FUNCTION_ENTRY ();
 431
 432
 433     /* Swap ID to big-endian to get contiguous bits */
 434
 435     EisaId = AcpiUtDwordByteSwap (NumericId);
 436
 437     OutString[0] = (char) ('@' + (((unsigned long) EisaId >> 26) & 0x1f));
 438     OutString[1] = (char) ('@' + ((EisaId >> 21) & 0x1f));
 439     OutString[2] = (char) ('@' + ((EisaId >> 16) & 0x1f));
 440     OutString[3] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 12);
 441     OutString[4] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 8);
 442     OutString[5] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 4);
 443     OutString[6] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 0);
 444     OutString[7] = 0;
 445 }
 446
 447
 448 /*******************************************************************************
 449  *
 450  * FUNCTION:    AcpiExUnsignedIntegerToString
 451  *
 452  * PARAMETERS:  Value           - Value to be converted
 453  *              OutString       - Where to put the converted string (8 bytes)
 454  *
 455  * RETURN:      None, string
 456  *
 457  * DESCRIPTION: Convert a number to string representation. Assumes string
 458  *              buffer is large enough to hold the string.
 459  *
 460  ******************************************************************************/
 461
 462 void
 463 AcpiExUnsignedIntegerToString (
 464     ACPI_INTEGER            Value,
 465     char                    *OutString)
 466 {
 467     UINT32                  Count;
 468     UINT32                  DigitsNeeded;
 469     UINT32                  Remainder;
 470
 471
 472     ACPI_FUNCTION_ENTRY ();
 473
 474
 475     DigitsNeeded = AcpiExDigitsNeeded (Value, 10);
 476     OutString[DigitsNeeded] = 0;
 477
 478     for (Count = DigitsNeeded; Count > 0; Count--)
 479     {
 480         (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder);
 481         OutString[Count-1] = (char) ('0' + Remainder);\
 482     }
 483 }
 484
 485 #endif