sys/contrib/dev/acpica/utilities/uteval.c

   1 /******************************************************************************
   2  *
   3  * Module Name: uteval - Object evaluation
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2010, 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 __UTEVAL_C__
 117
 118 #include <contrib/dev/acpica/include/acpi.h>
 119 #include <contrib/dev/acpica/include/accommon.h>
 120 #include <contrib/dev/acpica/include/acnamesp.h>
 121
 122
 123 #define _COMPONENT          ACPI_UTILITIES
 124         ACPI_MODULE_NAME    ("uteval")
 125
 126
 127 /*
 128  * Strings supported by the _OSI predefined (internal) method.
 129  *
 130  * March 2009: Removed "Linux" as this host no longer wants to respond true
 131  * for this string. Basically, the only safe OS strings are windows-related
 132  * and in many or most cases represent the only test path within the
 133  * BIOS-provided ASL code.
 134  *
 135  * The second element of each entry is used to track the newest version of
 136  * Windows that the BIOS has requested.
 137  */
 138 static const ACPI_INTERFACE_INFO    AcpiInterfacesSupported[] =
 139 {
 140     /* Operating System Vendor Strings */
 141
 142     {"Windows 2000",        ACPI_OSI_WIN_2000},         /* Windows 2000 */
 143     {"Windows 2001",        ACPI_OSI_WIN_XP},           /* Windows XP */
 144     {"Windows 2001 SP1",    ACPI_OSI_WIN_XP_SP1},       /* Windows XP SP1 */
 145     {"Windows 2001.1",      ACPI_OSI_WINSRV_2003},      /* Windows Server 2003 */
 146     {"Windows 2001 SP2",    ACPI_OSI_WIN_XP_SP2},       /* Windows XP SP2 */
 147     {"Windows 2001.1 SP1",  ACPI_OSI_WINSRV_2003_SP1},  /* Windows Server 2003 SP1 - Added 03/2006 */
 148     {"Windows 2006",        ACPI_OSI_WIN_VISTA},        /* Windows Vista - Added 03/2006 */
 149     {"Windows 2006.1",      ACPI_OSI_WINSRV_2008},      /* Windows Server 2008 - Added 09/2009 */
 150     {"Windows 2006 SP1",    ACPI_OSI_WIN_VISTA_SP1},    /* Windows Vista SP1 - Added 09/2009 */
 151     {"Windows 2009",        ACPI_OSI_WIN_7},            /* Windows 7 and Server 2008 R2 - Added 09/2009 */
 152
 153     /* Feature Group Strings */
 154
 155     {"Extended Address Space Descriptor", 0}
 156
 157     /*
 158      * All "optional" feature group strings (features that are implemented
 159      * by the host) should be implemented in the host version of
 160      * AcpiOsValidateInterface and should not be added here.
 161      */
 162 };
 163
 164
 165 /*******************************************************************************
 166  *
 167  * FUNCTION:    AcpiUtOsiImplementation
 168  *
 169  * PARAMETERS:  WalkState           - Current walk state
 170  *
 171  * RETURN:      Status
 172  *
 173  * DESCRIPTION: Implementation of the _OSI predefined control method
 174  *
 175  ******************************************************************************/
 176
 177 ACPI_STATUS
 178 AcpiUtOsiImplementation (
 179     ACPI_WALK_STATE         *WalkState)
 180 {
 181     ACPI_STATUS             Status;
 182     ACPI_OPERAND_OBJECT     *StringDesc;
 183     ACPI_OPERAND_OBJECT     *ReturnDesc;
 184     UINT32                  ReturnValue;
 185     UINT32                  i;
 186
 187
 188     ACPI_FUNCTION_TRACE (UtOsiImplementation);
 189
 190
 191     /* Validate the string input argument */
 192
 193     StringDesc = WalkState->Arguments[0].Object;
 194     if (!StringDesc || (StringDesc->Common.Type != ACPI_TYPE_STRING))
 195     {
 196         return_ACPI_STATUS (AE_TYPE);
 197     }
 198
 199     /* Create a return object */
 200
 201     ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
 202     if (!ReturnDesc)
 203     {
 204         return_ACPI_STATUS (AE_NO_MEMORY);
 205     }
 206
 207     /* Default return value is 0, NOT SUPPORTED */
 208
 209     ReturnValue = 0;
 210
 211     /* Compare input string to static table of supported interfaces */
 212
 213     for (i = 0; i < ACPI_ARRAY_LENGTH (AcpiInterfacesSupported); i++)
 214     {
 215         if (!ACPI_STRCMP (StringDesc->String.Pointer,
 216                 AcpiInterfacesSupported[i].Name))
 217         {
 218             /*
 219              * The interface is supported.
 220              * Update the OsiData if necessary. We keep track of the latest
 221              * version of Windows that has been requested by the BIOS.
 222              */
 223             if (AcpiInterfacesSupported[i].Value > AcpiGbl_OsiData)
 224             {
 225                 AcpiGbl_OsiData = AcpiInterfacesSupported[i].Value;
 226             }
 227
 228             ReturnValue = ACPI_UINT32_MAX;
 229             goto Exit;
 230         }
 231     }
 232
 233     /*
 234      * Did not match the string in the static table, call the host OSL to
 235      * check for a match with one of the optional strings (such as
 236      * "Module Device", "3.0 Thermal Model", etc.)
 237      */
 238     Status = AcpiOsValidateInterface (StringDesc->String.Pointer);
 239     if (ACPI_SUCCESS (Status))
 240     {
 241         /* The interface is supported */
 242
 243         ReturnValue = ACPI_UINT32_MAX;
 244     }
 245
 246
 247 Exit:
 248     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INFO,
 249         "ACPI: BIOS _OSI(%s) is %ssupported\n",
 250         StringDesc->String.Pointer, ReturnValue == 0 ? "not " : ""));
 251
 252     /* Complete the return value */
 253
 254     ReturnDesc->Integer.Value = ReturnValue;
 255     WalkState->ReturnDesc = ReturnDesc;
 256     return_ACPI_STATUS (AE_OK);
 257 }
 258
 259
 260 /*******************************************************************************
 261  *
 262  * FUNCTION:    AcpiUtEvaluateObject
 263  *
 264  * PARAMETERS:  PrefixNode          - Starting node
 265  *              Path                - Path to object from starting node
 266  *              ExpectedReturnTypes - Bitmap of allowed return types
 267  *              ReturnDesc          - Where a return value is stored
 268  *
 269  * RETURN:      Status
 270  *
 271  * DESCRIPTION: Evaluates a namespace object and verifies the type of the
 272  *              return object. Common code that simplifies accessing objects
 273  *              that have required return objects of fixed types.
 274  *
 275  *              NOTE: Internal function, no parameter validation
 276  *
 277  ******************************************************************************/
 278
 279 ACPI_STATUS
 280 AcpiUtEvaluateObject (
 281     ACPI_NAMESPACE_NODE     *PrefixNode,
 282     char                    *Path,
 283     UINT32                  ExpectedReturnBtypes,
 284     ACPI_OPERAND_OBJECT     **ReturnDesc)
 285 {
 286     ACPI_EVALUATE_INFO      *Info;
 287     ACPI_STATUS             Status;
 288     UINT32                  ReturnBtype;
 289
 290
 291     ACPI_FUNCTION_TRACE (UtEvaluateObject);
 292
 293
 294     /* Allocate the evaluation information block */
 295
 296     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
 297     if (!Info)
 298     {
 299         return_ACPI_STATUS (AE_NO_MEMORY);
 300     }
 301
 302     Info->PrefixNode = PrefixNode;
 303     Info->Pathname = Path;
 304
 305     /* Evaluate the object/method */
 306
 307     Status = AcpiNsEvaluate (Info);
 308     if (ACPI_FAILURE (Status))
 309     {
 310         if (Status == AE_NOT_FOUND)
 311         {
 312             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n",
 313                 AcpiUtGetNodeName (PrefixNode), Path));
 314         }
 315         else
 316         {
 317             ACPI_ERROR_METHOD ("Method execution failed",
 318                 PrefixNode, Path, Status);
 319         }
 320
 321         goto Cleanup;
 322     }
 323
 324     /* Did we get a return object? */
 325
 326     if (!Info->ReturnObject)
 327     {
 328         if (ExpectedReturnBtypes)
 329         {
 330             ACPI_ERROR_METHOD ("No object was returned from",
 331                 PrefixNode, Path, AE_NOT_EXIST);
 332
 333             Status = AE_NOT_EXIST;
 334         }
 335
 336         goto Cleanup;
 337     }
 338
 339     /* Map the return object type to the bitmapped type */
 340
 341     switch ((Info->ReturnObject)->Common.Type)
 342     {
 343     case ACPI_TYPE_INTEGER:
 344         ReturnBtype = ACPI_BTYPE_INTEGER;
 345         break;
 346
 347     case ACPI_TYPE_BUFFER:
 348         ReturnBtype = ACPI_BTYPE_BUFFER;
 349         break;
 350
 351     case ACPI_TYPE_STRING:
 352         ReturnBtype = ACPI_BTYPE_STRING;
 353         break;
 354
 355     case ACPI_TYPE_PACKAGE:
 356         ReturnBtype = ACPI_BTYPE_PACKAGE;
 357         break;
 358
 359     default:
 360         ReturnBtype = 0;
 361         break;
 362     }
 363
 364     if ((AcpiGbl_EnableInterpreterSlack) &&
 365         (!ExpectedReturnBtypes))
 366     {
 367         /*
 368          * We received a return object, but one was not expected. This can
 369          * happen frequently if the "implicit return" feature is enabled.
 370          * Just delete the return object and return AE_OK.
 371          */
 372         AcpiUtRemoveReference (Info->ReturnObject);
 373         goto Cleanup;
 374     }
 375
 376     /* Is the return object one of the expected types? */
 377
 378     if (!(ExpectedReturnBtypes & ReturnBtype))
 379     {
 380         ACPI_ERROR_METHOD ("Return object type is incorrect",
 381             PrefixNode, Path, AE_TYPE);
 382
 383         ACPI_ERROR ((AE_INFO,
 384             "Type returned from %s was incorrect: %s, expected Btypes: 0x%X",
 385             Path, AcpiUtGetObjectTypeName (Info->ReturnObject),
 386             ExpectedReturnBtypes));
 387
 388         /* On error exit, we must delete the return object */
 389
 390         AcpiUtRemoveReference (Info->ReturnObject);
 391         Status = AE_TYPE;
 392         goto Cleanup;
 393     }
 394
 395     /* Object type is OK, return it */
 396
 397     *ReturnDesc = Info->ReturnObject;
 398
 399 Cleanup:
 400     ACPI_FREE (Info);
 401     return_ACPI_STATUS (Status);
 402 }
 403
 404
 405 /*******************************************************************************
 406  *
 407  * FUNCTION:    AcpiUtEvaluateNumericObject
 408  *
 409  * PARAMETERS:  ObjectName          - Object name to be evaluated
 410  *              DeviceNode          - Node for the device
 411  *              Value               - Where the value is returned
 412  *
 413  * RETURN:      Status
 414  *
 415  * DESCRIPTION: Evaluates a numeric namespace object for a selected device
 416  *              and stores result in *Value.
 417  *
 418  *              NOTE: Internal function, no parameter validation
 419  *
 420  ******************************************************************************/
 421
 422 ACPI_STATUS
 423 AcpiUtEvaluateNumericObject (
 424     char                    *ObjectName,
 425     ACPI_NAMESPACE_NODE     *DeviceNode,
 426     UINT64                  *Value)
 427 {
 428     ACPI_OPERAND_OBJECT     *ObjDesc;
 429     ACPI_STATUS             Status;
 430
 431
 432     ACPI_FUNCTION_TRACE (UtEvaluateNumericObject);
 433
 434
 435     Status = AcpiUtEvaluateObject (DeviceNode, ObjectName,
 436                 ACPI_BTYPE_INTEGER, &ObjDesc);
 437     if (ACPI_FAILURE (Status))
 438     {
 439         return_ACPI_STATUS (Status);
 440     }
 441
 442     /* Get the returned Integer */
 443
 444     *Value = ObjDesc->Integer.Value;
 445
 446     /* On exit, we must delete the return object */
 447
 448     AcpiUtRemoveReference (ObjDesc);
 449     return_ACPI_STATUS (Status);
 450 }
 451
 452
 453 /*******************************************************************************
 454  *
 455  * FUNCTION:    AcpiUtExecute_STA
 456  *
 457  * PARAMETERS:  DeviceNode          - Node for the device
 458  *              Flags               - Where the status flags are returned
 459  *
 460  * RETURN:      Status
 461  *
 462  * DESCRIPTION: Executes _STA for selected device and stores results in
 463  *              *Flags.
 464  *
 465  *              NOTE: Internal function, no parameter validation
 466  *
 467  ******************************************************************************/
 468
 469 ACPI_STATUS
 470 AcpiUtExecute_STA (
 471     ACPI_NAMESPACE_NODE     *DeviceNode,
 472     UINT32                  *Flags)
 473 {
 474     ACPI_OPERAND_OBJECT     *ObjDesc;
 475     ACPI_STATUS             Status;
 476
 477
 478     ACPI_FUNCTION_TRACE (UtExecute_STA);
 479
 480
 481     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA,
 482                 ACPI_BTYPE_INTEGER, &ObjDesc);
 483     if (ACPI_FAILURE (Status))
 484     {
 485         if (AE_NOT_FOUND == Status)
 486         {
 487             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 488                 "_STA on %4.4s was not found, assuming device is present\n",
 489                 AcpiUtGetNodeName (DeviceNode)));
 490
 491             *Flags = ACPI_UINT32_MAX;
 492             Status = AE_OK;
 493         }
 494
 495         return_ACPI_STATUS (Status);
 496     }
 497
 498     /* Extract the status flags */
 499
 500     *Flags = (UINT32) ObjDesc->Integer.Value;
 501
 502     /* On exit, we must delete the return object */
 503
 504     AcpiUtRemoveReference (ObjDesc);
 505     return_ACPI_STATUS (Status);
 506 }
 507
 508
 509 /*******************************************************************************
 510  *
 511  * FUNCTION:    AcpiUtExecutePowerMethods
 512  *
 513  * PARAMETERS:  DeviceNode          - Node for the device
 514  *              MethodNames         - Array of power method names
 515  *              MethodCount         - Number of methods to execute
 516  *              OutValues           - Where the power method values are returned
 517  *
 518  * RETURN:      Status, OutValues
 519  *
 520  * DESCRIPTION: Executes the specified power methods for the device and returns
 521  *              the result(s).
 522  *
 523  *              NOTE: Internal function, no parameter validation
 524  *
 525  ******************************************************************************/
 526
 527 ACPI_STATUS
 528 AcpiUtExecutePowerMethods (
 529     ACPI_NAMESPACE_NODE     *DeviceNode,
 530     const char              **MethodNames,
 531     UINT8                   MethodCount,
 532     UINT8                   *OutValues)
 533 {
 534     ACPI_OPERAND_OBJECT     *ObjDesc;
 535     ACPI_STATUS             Status;
 536     ACPI_STATUS             FinalStatus = AE_NOT_FOUND;
 537     UINT32                  i;
 538
 539
 540     ACPI_FUNCTION_TRACE (UtExecutePowerMethods);
 541
 542
 543     for (i = 0; i < MethodCount; i++)
 544     {
 545         /*
 546          * Execute the power method (_SxD or _SxW). The only allowable
 547          * return type is an Integer.
 548          */
 549         Status = AcpiUtEvaluateObject (DeviceNode,
 550                     ACPI_CAST_PTR (char, MethodNames[i]),
 551                     ACPI_BTYPE_INTEGER, &ObjDesc);
 552         if (ACPI_SUCCESS (Status))
 553         {
 554             OutValues[i] = (UINT8) ObjDesc->Integer.Value;
 555
 556             /* Delete the return object */
 557
 558             AcpiUtRemoveReference (ObjDesc);
 559             FinalStatus = AE_OK;            /* At least one value is valid */
 560             continue;
 561         }
 562
 563         OutValues[i] = ACPI_UINT8_MAX;
 564         if (Status == AE_NOT_FOUND)
 565         {
 566             continue; /* Ignore if not found */
 567         }
 568
 569         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Failed %s on Device %4.4s, %s\n",
 570             ACPI_CAST_PTR (char, MethodNames[i]),
 571             AcpiUtGetNodeName (DeviceNode), AcpiFormatException (Status)));
 572     }
 573
 574     return_ACPI_STATUS (FinalStatus);
 575 }