reactos/drivers/bus/acpi/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 - 2015, 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 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acnamesp.h"
 119
 120
 121 #define _COMPONENT          ACPI_UTILITIES
 122         ACPI_MODULE_NAME    ("uteval")
 123
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiUtEvaluateObject
 128  *
 129  * PARAMETERS:  PrefixNode          - Starting node
 130  *              Path                - Path to object from starting node
 131  *              ExpectedReturnTypes - Bitmap of allowed return types
 132  *              ReturnDesc          - Where a return value is stored
 133  *
 134  * RETURN:      Status
 135  *
 136  * DESCRIPTION: Evaluates a namespace object and verifies the type of the
 137  *              return object. Common code that simplifies accessing objects
 138  *              that have required return objects of fixed types.
 139  *
 140  *              NOTE: Internal function, no parameter validation
 141  *
 142  ******************************************************************************/
 143
 144 ACPI_STATUS
 145 AcpiUtEvaluateObject (
 146     ACPI_NAMESPACE_NODE     *PrefixNode,
 147     char                    *Path,
 148     UINT32                  ExpectedReturnBtypes,
 149     ACPI_OPERAND_OBJECT     **ReturnDesc)
 150 {
 151     ACPI_EVALUATE_INFO      *Info;
 152     ACPI_STATUS             Status;
 153     UINT32                  ReturnBtype;
 154
 155
 156     ACPI_FUNCTION_TRACE (UtEvaluateObject);
 157
 158
 159     /* Allocate the evaluation information block */
 160
 161     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
 162     if (!Info)
 163     {
 164         return_ACPI_STATUS (AE_NO_MEMORY);
 165     }
 166
 167     Info->PrefixNode = PrefixNode;
 168     Info->RelativePathname = Path;
 169
 170     /* Evaluate the object/method */
 171
 172     Status = AcpiNsEvaluate (Info);
 173     if (ACPI_FAILURE (Status))
 174     {
 175         if (Status == AE_NOT_FOUND)
 176         {
 177             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n",
 178                 AcpiUtGetNodeName (PrefixNode), Path));
 179         }
 180         else
 181         {
 182             ACPI_ERROR_METHOD ("Method execution failed",
 183                 PrefixNode, Path, Status);
 184         }
 185
 186         goto Cleanup;
 187     }
 188
 189     /* Did we get a return object? */
 190
 191     if (!Info->ReturnObject)
 192     {
 193         if (ExpectedReturnBtypes)
 194         {
 195             ACPI_ERROR_METHOD ("No object was returned from",
 196                 PrefixNode, Path, AE_NOT_EXIST);
 197
 198             Status = AE_NOT_EXIST;
 199         }
 200
 201         goto Cleanup;
 202     }
 203
 204     /* Map the return object type to the bitmapped type */
 205
 206     switch ((Info->ReturnObject)->Common.Type)
 207     {
 208     case ACPI_TYPE_INTEGER:
 209
 210         ReturnBtype = ACPI_BTYPE_INTEGER;
 211         break;
 212
 213     case ACPI_TYPE_BUFFER:
 214
 215         ReturnBtype = ACPI_BTYPE_BUFFER;
 216         break;
 217
 218     case ACPI_TYPE_STRING:
 219
 220         ReturnBtype = ACPI_BTYPE_STRING;
 221         break;
 222
 223     case ACPI_TYPE_PACKAGE:
 224
 225         ReturnBtype = ACPI_BTYPE_PACKAGE;
 226         break;
 227
 228     default:
 229
 230         ReturnBtype = 0;
 231         break;
 232     }
 233
 234     if ((AcpiGbl_EnableInterpreterSlack) &&
 235         (!ExpectedReturnBtypes))
 236     {
 237         /*
 238          * We received a return object, but one was not expected. This can
 239          * happen frequently if the "implicit return" feature is enabled.
 240          * Just delete the return object and return AE_OK.
 241          */
 242         AcpiUtRemoveReference (Info->ReturnObject);
 243         goto Cleanup;
 244     }
 245
 246     /* Is the return object one of the expected types? */
 247
 248     if (!(ExpectedReturnBtypes & ReturnBtype))
 249     {
 250         ACPI_ERROR_METHOD ("Return object type is incorrect",
 251             PrefixNode, Path, AE_TYPE);
 252
 253         ACPI_ERROR ((AE_INFO,
 254             "Type returned from %s was incorrect: %s, expected Btypes: 0x%X",
 255             Path, AcpiUtGetObjectTypeName (Info->ReturnObject),
 256             ExpectedReturnBtypes));
 257
 258         /* On error exit, we must delete the return object */
 259
 260         AcpiUtRemoveReference (Info->ReturnObject);
 261         Status = AE_TYPE;
 262         goto Cleanup;
 263     }
 264
 265     /* Object type is OK, return it */
 266
 267     *ReturnDesc = Info->ReturnObject;
 268
 269 Cleanup:
 270     ACPI_FREE (Info);
 271     return_ACPI_STATUS (Status);
 272 }
 273
 274
 275 /*******************************************************************************
 276  *
 277  * FUNCTION:    AcpiUtEvaluateNumericObject
 278  *
 279  * PARAMETERS:  ObjectName          - Object name to be evaluated
 280  *              DeviceNode          - Node for the device
 281  *              Value               - Where the value is returned
 282  *
 283  * RETURN:      Status
 284  *
 285  * DESCRIPTION: Evaluates a numeric namespace object for a selected device
 286  *              and stores result in *Value.
 287  *
 288  *              NOTE: Internal function, no parameter validation
 289  *
 290  ******************************************************************************/
 291
 292 ACPI_STATUS
 293 AcpiUtEvaluateNumericObject (
 294     char                    *ObjectName,
 295     ACPI_NAMESPACE_NODE     *DeviceNode,
 296     UINT64                  *Value)
 297 {
 298     ACPI_OPERAND_OBJECT     *ObjDesc;
 299     ACPI_STATUS             Status;
 300
 301
 302     ACPI_FUNCTION_TRACE (UtEvaluateNumericObject);
 303
 304
 305     Status = AcpiUtEvaluateObject (DeviceNode, ObjectName,
 306         ACPI_BTYPE_INTEGER, &ObjDesc);
 307     if (ACPI_FAILURE (Status))
 308     {
 309         return_ACPI_STATUS (Status);
 310     }
 311
 312     /* Get the returned Integer */
 313
 314     *Value = ObjDesc->Integer.Value;
 315
 316     /* On exit, we must delete the return object */
 317
 318     AcpiUtRemoveReference (ObjDesc);
 319     return_ACPI_STATUS (Status);
 320 }
 321
 322
 323 /*******************************************************************************
 324  *
 325  * FUNCTION:    AcpiUtExecute_STA
 326  *
 327  * PARAMETERS:  DeviceNode          - Node for the device
 328  *              Flags               - Where the status flags are returned
 329  *
 330  * RETURN:      Status
 331  *
 332  * DESCRIPTION: Executes _STA for selected device and stores results in
 333  *              *Flags. If _STA does not exist, then the device is assumed
 334  *              to be present/functional/enabled (as per the ACPI spec).
 335  *
 336  *              NOTE: Internal function, no parameter validation
 337  *
 338  ******************************************************************************/
 339
 340 ACPI_STATUS
 341 AcpiUtExecute_STA (
 342     ACPI_NAMESPACE_NODE     *DeviceNode,
 343     UINT32                  *Flags)
 344 {
 345     ACPI_OPERAND_OBJECT     *ObjDesc;
 346     ACPI_STATUS             Status;
 347
 348
 349     ACPI_FUNCTION_TRACE (UtExecute_STA);
 350
 351
 352     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA,
 353         ACPI_BTYPE_INTEGER, &ObjDesc);
 354     if (ACPI_FAILURE (Status))
 355     {
 356         if (AE_NOT_FOUND == Status)
 357         {
 358             /*
 359              * if _STA does not exist, then (as per the ACPI specification),
 360              * the returned flags will indicate that the device is present,
 361              * functional, and enabled.
 362              */
 363             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 364                 "_STA on %4.4s was not found, assuming device is present\n",
 365                 AcpiUtGetNodeName (DeviceNode)));
 366
 367             *Flags = ACPI_UINT32_MAX;
 368             Status = AE_OK;
 369         }
 370
 371         return_ACPI_STATUS (Status);
 372     }
 373
 374     /* Extract the status flags */
 375
 376     *Flags = (UINT32) ObjDesc->Integer.Value;
 377
 378     /* On exit, we must delete the return object */
 379
 380     AcpiUtRemoveReference (ObjDesc);
 381     return_ACPI_STATUS (Status);
 382 }
 383
 384
 385 /*******************************************************************************
 386  *
 387  * FUNCTION:    AcpiUtExecutePowerMethods
 388  *
 389  * PARAMETERS:  DeviceNode          - Node for the device
 390  *              MethodNames         - Array of power method names
 391  *              MethodCount         - Number of methods to execute
 392  *              OutValues           - Where the power method values are returned
 393  *
 394  * RETURN:      Status, OutValues
 395  *
 396  * DESCRIPTION: Executes the specified power methods for the device and returns
 397  *              the result(s).
 398  *
 399  *              NOTE: Internal function, no parameter validation
 400  *
 401  ******************************************************************************/
 402
 403 ACPI_STATUS
 404 AcpiUtExecutePowerMethods (
 405     ACPI_NAMESPACE_NODE     *DeviceNode,
 406     const char              **MethodNames,
 407     UINT8                   MethodCount,
 408     UINT8                   *OutValues)
 409 {
 410     ACPI_OPERAND_OBJECT     *ObjDesc;
 411     ACPI_STATUS             Status;
 412     ACPI_STATUS             FinalStatus = AE_NOT_FOUND;
 413     UINT32                  i;
 414
 415
 416     ACPI_FUNCTION_TRACE (UtExecutePowerMethods);
 417
 418
 419     for (i = 0; i < MethodCount; i++)
 420     {
 421         /*
 422          * Execute the power method (_SxD or _SxW). The only allowable
 423          * return type is an Integer.
 424          */
 425         Status = AcpiUtEvaluateObject (DeviceNode,
 426             ACPI_CAST_PTR (char, MethodNames[i]),
 427             ACPI_BTYPE_INTEGER, &ObjDesc);
 428         if (ACPI_SUCCESS (Status))
 429         {
 430             OutValues[i] = (UINT8) ObjDesc->Integer.Value;
 431
 432             /* Delete the return object */
 433
 434             AcpiUtRemoveReference (ObjDesc);
 435             FinalStatus = AE_OK;            /* At least one value is valid */
 436             continue;
 437         }
 438
 439         OutValues[i] = ACPI_UINT8_MAX;
 440         if (Status == AE_NOT_FOUND)
 441         {
 442             continue; /* Ignore if not found */
 443         }
 444
 445         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Failed %s on Device %4.4s, %s\n",
 446             ACPI_CAST_PTR (char, MethodNames[i]),
 447             AcpiUtGetNodeName (DeviceNode), AcpiFormatException (Status)));
 448     }
 449
 450     return_ACPI_STATUS (FinalStatus);
 451 }