sys/contrib/dev/acpica/uteval.c

   1 /******************************************************************************
   2  *
   3  * Module Name: uteval - Object evaluation
   4  *              $Revision: 45 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/uteval.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118 #define __UTEVAL_C__
 119
 120 #include "acpi.h"
 121 #include "acnamesp.h"
 122 #include "acinterp.h"
 123
 124
 125 #define _COMPONENT          ACPI_UTILITIES
 126         ACPI_MODULE_NAME    ("uteval")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiUtEvaluateObject
 132  *
 133  * PARAMETERS:  PrefixNode          - Starting node
 134  *              Path                - Path to object from starting node
 135  *              ExpectedReturnTypes - Bitmap of allowed return types
 136  *              ReturnDesc          - Where a return value is stored
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: Evaluates a namespace object and verifies the type of the
 141  *              return object.  Common code that simplifies accessing objects
 142  *              that have required return objects of fixed types.
 143  *
 144  *              NOTE: Internal function, no parameter validation
 145  *
 146  ******************************************************************************/
 147
 148 ACPI_STATUS
 149 AcpiUtEvaluateObject (
 150     ACPI_NAMESPACE_NODE     *PrefixNode,
 151     char                    *Path,
 152     UINT32                  ExpectedReturnBtypes,
 153     ACPI_OPERAND_OBJECT     **ReturnDesc)
 154 {
 155     ACPI_OPERAND_OBJECT     *ObjDesc;
 156     ACPI_STATUS             Status;
 157     UINT32                  ReturnBtype;
 158
 159
 160     ACPI_FUNCTION_TRACE ("UtEvaluateObject");
 161
 162
 163     /* Evaluate the object/method */
 164
 165     Status = AcpiNsEvaluateRelative (PrefixNode, Path, NULL, &ObjDesc);
 166     if (ACPI_FAILURE (Status))
 167     {
 168         if (Status == AE_NOT_FOUND)
 169         {
 170             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n",
 171                 PrefixNode->Name.Ascii, Path));
 172         }
 173         else
 174         {
 175             ACPI_REPORT_METHOD_ERROR ("Method execution failed",
 176                 PrefixNode, Path, Status);
 177         }
 178
 179         return_ACPI_STATUS (Status);
 180     }
 181
 182     /* Did we get a return object? */
 183
 184     if (!ObjDesc)
 185     {
 186         if (ExpectedReturnBtypes)
 187         {
 188             ACPI_REPORT_METHOD_ERROR ("No object was returned from",
 189                 PrefixNode, Path, AE_NOT_EXIST);
 190
 191             return_ACPI_STATUS (AE_NOT_EXIST);
 192         }
 193
 194         return_ACPI_STATUS (AE_OK);
 195     }
 196
 197     /* Map the return object type to the bitmapped type */
 198
 199     switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 200     {
 201     case ACPI_TYPE_INTEGER:
 202         ReturnBtype = ACPI_BTYPE_INTEGER;
 203         break;
 204
 205     case ACPI_TYPE_BUFFER:
 206         ReturnBtype = ACPI_BTYPE_BUFFER;
 207         break;
 208
 209     case ACPI_TYPE_STRING:
 210         ReturnBtype = ACPI_BTYPE_STRING;
 211         break;
 212
 213     case ACPI_TYPE_PACKAGE:
 214         ReturnBtype = ACPI_BTYPE_PACKAGE;
 215         break;
 216
 217     default:
 218         ReturnBtype = 0;
 219         break;
 220     }
 221
 222     /* Is the return object one of the expected types? */
 223
 224     if (!(ExpectedReturnBtypes & ReturnBtype))
 225     {
 226         ACPI_REPORT_METHOD_ERROR ("Return object type is incorrect",
 227             PrefixNode, Path, AE_TYPE);
 228
 229         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 230             "Type returned from %s was incorrect: %X\n",
 231             Path, ACPI_GET_OBJECT_TYPE (ObjDesc)));
 232
 233         /* On error exit, we must delete the return object */
 234
 235         AcpiUtRemoveReference (ObjDesc);
 236         return_ACPI_STATUS (AE_TYPE);
 237     }
 238
 239     /* Object type is OK, return it */
 240
 241     *ReturnDesc = ObjDesc;
 242     return_ACPI_STATUS (AE_OK);
 243 }
 244
 245
 246 /*******************************************************************************
 247  *
 248  * FUNCTION:    AcpiUtEvaluateNumericObject
 249  *
 250  * PARAMETERS:  *ObjectName         - Object name to be evaluated
 251  *              DeviceNode          - Node for the device
 252  *              *Address            - Where the value is returned
 253  *
 254  * RETURN:      Status
 255  *
 256  * DESCRIPTION: Evaluates a numeric namespace object for a selected device
 257  *              and stores result in *Address.
 258  *
 259  *              NOTE: Internal function, no parameter validation
 260  *
 261  ******************************************************************************/
 262
 263 ACPI_STATUS
 264 AcpiUtEvaluateNumericObject (
 265     char                    *ObjectName,
 266     ACPI_NAMESPACE_NODE     *DeviceNode,
 267     ACPI_INTEGER            *Address)
 268 {
 269     ACPI_OPERAND_OBJECT     *ObjDesc;
 270     ACPI_STATUS             Status;
 271
 272
 273     ACPI_FUNCTION_TRACE ("UtEvaluateNumericObject");
 274
 275
 276     Status = AcpiUtEvaluateObject (DeviceNode, ObjectName,
 277                 ACPI_BTYPE_INTEGER, &ObjDesc);
 278     if (ACPI_FAILURE (Status))
 279     {
 280         return_ACPI_STATUS (Status);
 281     }
 282
 283     /* Get the returned Integer */
 284
 285     *Address = ObjDesc->Integer.Value;
 286
 287     /* On exit, we must delete the return object */
 288
 289     AcpiUtRemoveReference (ObjDesc);
 290     return_ACPI_STATUS (Status);
 291 }
 292
 293
 294 /*******************************************************************************
 295  *
 296  * FUNCTION:    AcpiUtExecute_HID
 297  *
 298  * PARAMETERS:  DeviceNode          - Node for the device
 299  *              *Hid                - Where the HID is returned
 300  *
 301  * RETURN:      Status
 302  *
 303  * DESCRIPTION: Executes the _HID control method that returns the hardware
 304  *              ID of the device.
 305  *
 306  *              NOTE: Internal function, no parameter validation
 307  *
 308  ******************************************************************************/
 309
 310 ACPI_STATUS
 311 AcpiUtExecute_HID (
 312     ACPI_NAMESPACE_NODE     *DeviceNode,
 313     ACPI_DEVICE_ID          *Hid)
 314 {
 315     ACPI_OPERAND_OBJECT     *ObjDesc;
 316     ACPI_STATUS             Status;
 317
 318
 319     ACPI_FUNCTION_TRACE ("UtExecute_HID");
 320
 321
 322     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__HID,
 323                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
 324     if (ACPI_FAILURE (Status))
 325     {
 326         return_ACPI_STATUS (Status);
 327     }
 328
 329     if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_INTEGER)
 330     {
 331         /* Convert the Numeric HID to string */
 332
 333         AcpiExEisaIdToString ((UINT32) ObjDesc->Integer.Value, Hid->Buffer);
 334     }
 335     else
 336     {
 337         /* Copy the String HID from the returned object */
 338
 339         ACPI_STRNCPY (Hid->Buffer, ObjDesc->String.Pointer, sizeof(Hid->Buffer));
 340     }
 341
 342     /* On exit, we must delete the return object */
 343
 344     AcpiUtRemoveReference (ObjDesc);
 345     return_ACPI_STATUS (Status);
 346 }
 347
 348
 349 /*******************************************************************************
 350  *
 351  * FUNCTION:    AcpiUtExecute_CID
 352  *
 353  * PARAMETERS:  DeviceNode          - Node for the device
 354  *              *Cid                - Where the CID is returned
 355  *
 356  * RETURN:      Status
 357  *
 358  * DESCRIPTION: Executes the _CID control method that returns one or more
 359  *              compatible hardware IDs for the device.
 360  *
 361  *              NOTE: Internal function, no parameter validation
 362  *
 363  ******************************************************************************/
 364
 365 ACPI_STATUS
 366 AcpiUtExecute_CID (
 367     ACPI_NAMESPACE_NODE     *DeviceNode,
 368     ACPI_DEVICE_ID          *Cid)
 369 {
 370     ACPI_OPERAND_OBJECT     *ObjDesc;
 371     ACPI_STATUS             Status;
 372
 373
 374     ACPI_FUNCTION_TRACE ("UtExecute_CID");
 375
 376
 377     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__CID,
 378                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_PACKAGE, &ObjDesc);
 379     if (ACPI_FAILURE (Status))
 380     {
 381         return_ACPI_STATUS (Status);
 382     }
 383
 384     /*
 385      *  A _CID can return either a single compatible ID or a package of compatible
 386      *  IDs.  Each compatible ID can be a Number (32 bit compressed EISA ID) or
 387      *  string (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss").
 388      */
 389     switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 390     {
 391     case ACPI_TYPE_INTEGER:
 392
 393         /* Convert the Numeric CID to string */
 394
 395         AcpiExEisaIdToString ((UINT32) ObjDesc->Integer.Value, Cid->Buffer);
 396         break;
 397
 398     case ACPI_TYPE_STRING:
 399
 400         /* Copy the String CID from the returned object */
 401
 402         ACPI_STRNCPY (Cid->Buffer, ObjDesc->String.Pointer, sizeof (Cid->Buffer));
 403         break;
 404
 405     case ACPI_TYPE_PACKAGE:
 406
 407         /* TBD: Parse package elements; need different return struct, etc. */
 408
 409         Status = AE_SUPPORT;
 410         break;
 411
 412     default:
 413
 414         Status = AE_TYPE;
 415         break;
 416     }
 417
 418     /* On exit, we must delete the return object */
 419
 420     AcpiUtRemoveReference (ObjDesc);
 421     return_ACPI_STATUS (Status);
 422 }
 423
 424
 425 /*******************************************************************************
 426  *
 427  * FUNCTION:    AcpiUtExecute_UID
 428  *
 429  * PARAMETERS:  DeviceNode          - Node for the device
 430  *              *Uid                - Where the UID is returned
 431  *
 432  * RETURN:      Status
 433  *
 434  * DESCRIPTION: Executes the _UID control method that returns the hardware
 435  *              ID of the device.
 436  *
 437  *              NOTE: Internal function, no parameter validation
 438  *
 439  ******************************************************************************/
 440
 441 ACPI_STATUS
 442 AcpiUtExecute_UID (
 443     ACPI_NAMESPACE_NODE     *DeviceNode,
 444     ACPI_DEVICE_ID          *Uid)
 445 {
 446     ACPI_OPERAND_OBJECT     *ObjDesc;
 447     ACPI_STATUS             Status;
 448
 449
 450     ACPI_FUNCTION_TRACE ("UtExecute_UID");
 451
 452
 453     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__UID,
 454                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
 455     if (ACPI_FAILURE (Status))
 456     {
 457         return_ACPI_STATUS (Status);
 458     }
 459
 460     if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_INTEGER)
 461     {
 462         /* Convert the Numeric UID to string */
 463
 464         AcpiExUnsignedIntegerToString (ObjDesc->Integer.Value, Uid->Buffer);
 465     }
 466     else
 467     {
 468         /* Copy the String UID from the returned object */
 469
 470         ACPI_STRNCPY (Uid->Buffer, ObjDesc->String.Pointer, sizeof (Uid->Buffer));
 471     }
 472
 473     /* On exit, we must delete the return object */
 474
 475     AcpiUtRemoveReference (ObjDesc);
 476     return_ACPI_STATUS (Status);
 477 }
 478
 479
 480 /*******************************************************************************
 481  *
 482  * FUNCTION:    AcpiUtExecute_STA
 483  *
 484  * PARAMETERS:  DeviceNode          - Node for the device
 485  *              *Flags              - Where the status flags are returned
 486  *
 487  * RETURN:      Status
 488  *
 489  * DESCRIPTION: Executes _STA for selected device and stores results in
 490  *              *Flags.
 491  *
 492  *              NOTE: Internal function, no parameter validation
 493  *
 494  ******************************************************************************/
 495
 496 ACPI_STATUS
 497 AcpiUtExecute_STA (
 498     ACPI_NAMESPACE_NODE     *DeviceNode,
 499     UINT32                  *Flags)
 500 {
 501     ACPI_OPERAND_OBJECT     *ObjDesc;
 502     ACPI_STATUS             Status;
 503
 504
 505     ACPI_FUNCTION_TRACE ("UtExecute_STA");
 506
 507
 508     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA,
 509                 ACPI_BTYPE_INTEGER, &ObjDesc);
 510     if (ACPI_FAILURE (Status))
 511     {
 512         if (AE_NOT_FOUND == Status)
 513         {
 514             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 515                 "_STA on %4.4s was not found, assuming device is present\n",
 516                 DeviceNode->Name.Ascii));
 517
 518             *Flags = 0x0F;
 519             Status = AE_OK;
 520         }
 521
 522         return_ACPI_STATUS (Status);
 523     }
 524
 525     /* Extract the status flags */
 526
 527     *Flags = (UINT32) ObjDesc->Integer.Value;
 528
 529     /* On exit, we must delete the return object */
 530
 531     AcpiUtRemoveReference (ObjDesc);
 532     return_ACPI_STATUS (Status);
 533 }