sys/contrib/dev/acpica-unix/include/acobject.h

   1
   2 /******************************************************************************
   3  *
   4  * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT  (Internal object only)
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2011, 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
 117 #ifndef _ACOBJECT_H
 118 #define _ACOBJECT_H
 119
 120 /* acpisrc:StructDefs -- for acpisrc conversion */
 121
 122
 123 /*
 124  * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher
 125  * to the interpreter, and to keep track of the various handlers such as
 126  * address space handlers and notify handlers. The object is a constant
 127  * size in order to allow it to be cached and reused.
 128  *
 129  * Note: The object is optimized to be aligned and will not work if it is
 130  * byte-packed.
 131  */
 132 #if ACPI_MACHINE_WIDTH == 64
 133 #pragma pack(8)
 134 #else
 135 #pragma pack(4)
 136 #endif
 137
 138 /*******************************************************************************
 139  *
 140  * Common Descriptors
 141  *
 142  ******************************************************************************/
 143
 144 /*
 145  * Common area for all objects.
 146  *
 147  * DescriptorType is used to differentiate between internal descriptors, and
 148  * must be in the same place across all descriptors
 149  *
 150  * Note: The DescriptorType and Type fields must appear in the identical
 151  * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
 152  * structures.
 153  */
 154 #define ACPI_OBJECT_COMMON_HEADER \
 155     union acpi_operand_object       *NextObject;        /* Objects linked to parent NS node */\
 156     UINT8                           DescriptorType;     /* To differentiate various internal objs */\
 157     UINT8                           Type;               /* ACPI_OBJECT_TYPE */\
 158     UINT16                          ReferenceCount;     /* For object deletion management */\
 159     UINT8                           Flags;
 160     /*
 161      * Note: There are 3 bytes available here before the
 162      * next natural alignment boundary (for both 32/64 cases)
 163      */
 164
 165 /* Values for Flag byte above */
 166
 167 #define AOPOBJ_AML_CONSTANT         0x01    /* Integer is an AML constant */
 168 #define AOPOBJ_STATIC_POINTER       0x02    /* Data is part of an ACPI table, don't delete */
 169 #define AOPOBJ_DATA_VALID           0x04    /* Object is intialized and data is valid */
 170 #define AOPOBJ_OBJECT_INITIALIZED   0x08    /* Region is initialized, _REG was run */
 171 #define AOPOBJ_SETUP_COMPLETE       0x10    /* Region setup is complete */
 172 #define AOPOBJ_INVALID              0x20    /* Host OS won't allow a Region address */
 173
 174
 175 /******************************************************************************
 176  *
 177  * Basic data types
 178  *
 179  *****************************************************************************/
 180
 181 typedef struct acpi_object_common
 182 {
 183     ACPI_OBJECT_COMMON_HEADER
 184
 185 } ACPI_OBJECT_COMMON;
 186
 187
 188 typedef struct acpi_object_integer
 189 {
 190     ACPI_OBJECT_COMMON_HEADER
 191     UINT8                           Fill[3];            /* Prevent warning on some compilers */
 192     UINT64                          Value;
 193
 194 } ACPI_OBJECT_INTEGER;
 195
 196
 197 /*
 198  * Note: The String and Buffer object must be identical through the Pointer
 199  * and length elements.  There is code that depends on this.
 200  *
 201  * Fields common to both Strings and Buffers
 202  */
 203 #define ACPI_COMMON_BUFFER_INFO(_Type) \
 204     _Type                           *Pointer; \
 205     UINT32                          Length;
 206
 207
 208 typedef struct acpi_object_string   /* Null terminated, ASCII characters only */
 209 {
 210     ACPI_OBJECT_COMMON_HEADER
 211     ACPI_COMMON_BUFFER_INFO         (char)              /* String in AML stream or allocated string */
 212
 213 } ACPI_OBJECT_STRING;
 214
 215
 216 typedef struct acpi_object_buffer
 217 {
 218     ACPI_OBJECT_COMMON_HEADER
 219     ACPI_COMMON_BUFFER_INFO         (UINT8)             /* Buffer in AML stream or allocated buffer */
 220     UINT32                          AmlLength;
 221     UINT8                           *AmlStart;
 222     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
 223
 224 } ACPI_OBJECT_BUFFER;
 225
 226
 227 typedef struct acpi_object_package
 228 {
 229     ACPI_OBJECT_COMMON_HEADER
 230     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
 231     union acpi_operand_object       **Elements;         /* Array of pointers to AcpiObjects */
 232     UINT8                           *AmlStart;
 233     UINT32                          AmlLength;
 234     UINT32                          Count;              /* # of elements in package */
 235
 236 } ACPI_OBJECT_PACKAGE;
 237
 238
 239 /******************************************************************************
 240  *
 241  * Complex data types
 242  *
 243  *****************************************************************************/
 244
 245 typedef struct acpi_object_event
 246 {
 247     ACPI_OBJECT_COMMON_HEADER
 248     ACPI_SEMAPHORE                  OsSemaphore;        /* Actual OS synchronization object */
 249
 250 } ACPI_OBJECT_EVENT;
 251
 252
 253 typedef struct acpi_object_mutex
 254 {
 255     ACPI_OBJECT_COMMON_HEADER
 256     UINT8                           SyncLevel;          /* 0-15, specified in Mutex() call */
 257     UINT16                          AcquisitionDepth;   /* Allow multiple Acquires, same thread */
 258     ACPI_MUTEX                      OsMutex;            /* Actual OS synchronization object */
 259     ACPI_THREAD_ID                  ThreadId;           /* Current owner of the mutex */
 260     struct acpi_thread_state        *OwnerThread;       /* Current owner of the mutex */
 261     union acpi_operand_object       *Prev;              /* Link for list of acquired mutexes */
 262     union acpi_operand_object       *Next;              /* Link for list of acquired mutexes */
 263     ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
 264     UINT8                           OriginalSyncLevel;  /* Owner's original sync level (0-15) */
 265
 266 } ACPI_OBJECT_MUTEX;
 267
 268
 269 typedef struct acpi_object_region
 270 {
 271     ACPI_OBJECT_COMMON_HEADER
 272     UINT8                           SpaceId;
 273     ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
 274     union acpi_operand_object       *Handler;           /* Handler for region access */
 275     union acpi_operand_object       *Next;
 276     ACPI_PHYSICAL_ADDRESS           Address;
 277     UINT32                          Length;
 278
 279 } ACPI_OBJECT_REGION;
 280
 281
 282 typedef struct acpi_object_method
 283 {
 284     ACPI_OBJECT_COMMON_HEADER
 285     UINT8                           InfoFlags;
 286     UINT8                           ParamCount;
 287     UINT8                           SyncLevel;
 288     union acpi_operand_object       *Mutex;
 289     UINT8                           *AmlStart;
 290     union
 291     {
 292         ACPI_INTERNAL_METHOD            Implementation;
 293         union acpi_operand_object       *Handler;
 294     } Dispatch;
 295
 296     UINT32                          AmlLength;
 297     UINT8                           ThreadCount;
 298     ACPI_OWNER_ID                   OwnerId;
 299
 300 } ACPI_OBJECT_METHOD;
 301
 302 /* Flags for InfoFlags field above */
 303
 304 #define ACPI_METHOD_MODULE_LEVEL        0x01    /* Method is actually module-level code */
 305 #define ACPI_METHOD_INTERNAL_ONLY       0x02    /* Method is implemented internally (_OSI) */
 306 #define ACPI_METHOD_SERIALIZED          0x04    /* Method is serialized */
 307 #define ACPI_METHOD_SERIALIZED_PENDING  0x08    /* Method is to be marked serialized */
 308 #define ACPI_METHOD_MODIFIED_NAMESPACE  0x10    /* Method modified the namespace */
 309
 310
 311 /******************************************************************************
 312  *
 313  * Objects that can be notified.  All share a common NotifyInfo area.
 314  *
 315  *****************************************************************************/
 316
 317 /*
 318  * Common fields for objects that support ASL notifications
 319  */
 320 #define ACPI_COMMON_NOTIFY_INFO \
 321     union acpi_operand_object       *SystemNotify;      /* Handler for system notifies */\
 322     union acpi_operand_object       *DeviceNotify;      /* Handler for driver notifies */\
 323     union acpi_operand_object       *Handler;           /* Handler for Address space */
 324
 325
 326 typedef struct acpi_object_notify_common    /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
 327 {
 328     ACPI_OBJECT_COMMON_HEADER
 329     ACPI_COMMON_NOTIFY_INFO
 330
 331 } ACPI_OBJECT_NOTIFY_COMMON;
 332
 333
 334 typedef struct acpi_object_device
 335 {
 336     ACPI_OBJECT_COMMON_HEADER
 337     ACPI_COMMON_NOTIFY_INFO
 338     ACPI_GPE_BLOCK_INFO             *GpeBlock;
 339
 340 } ACPI_OBJECT_DEVICE;
 341
 342
 343 typedef struct acpi_object_power_resource
 344 {
 345     ACPI_OBJECT_COMMON_HEADER
 346     ACPI_COMMON_NOTIFY_INFO
 347     UINT32                          SystemLevel;
 348     UINT32                          ResourceOrder;
 349
 350 } ACPI_OBJECT_POWER_RESOURCE;
 351
 352
 353 typedef struct acpi_object_processor
 354 {
 355     ACPI_OBJECT_COMMON_HEADER
 356
 357     /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
 358
 359     UINT8                           ProcId;
 360     UINT8                           Length;
 361     ACPI_COMMON_NOTIFY_INFO
 362     ACPI_IO_ADDRESS                 Address;
 363
 364 } ACPI_OBJECT_PROCESSOR;
 365
 366
 367 typedef struct acpi_object_thermal_zone
 368 {
 369     ACPI_OBJECT_COMMON_HEADER
 370     ACPI_COMMON_NOTIFY_INFO
 371
 372 } ACPI_OBJECT_THERMAL_ZONE;
 373
 374
 375 /******************************************************************************
 376  *
 377  * Fields.  All share a common header/info field.
 378  *
 379  *****************************************************************************/
 380
 381 /*
 382  * Common bitfield for the field objects
 383  * "Field Datum"  -- a datum from the actual field object
 384  * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
 385  */
 386 #define ACPI_COMMON_FIELD_INFO \
 387     UINT8                           FieldFlags;         /* Access, update, and lock bits */\
 388     UINT8                           Attribute;          /* From AccessAs keyword */\
 389     UINT8                           AccessByteWidth;    /* Read/Write size in bytes */\
 390     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */\
 391     UINT32                          BitLength;          /* Length of field in bits */\
 392     UINT32                          BaseByteOffset;     /* Byte offset within containing object */\
 393     UINT32                          Value;              /* Value to store into the Bank or Index register */\
 394     UINT8                           StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
 395
 396
 397 typedef struct acpi_object_field_common                 /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
 398 {
 399     ACPI_OBJECT_COMMON_HEADER
 400     ACPI_COMMON_FIELD_INFO
 401     union acpi_operand_object       *RegionObj;         /* Parent Operation Region object (REGION/BANK fields only) */
 402
 403 } ACPI_OBJECT_FIELD_COMMON;
 404
 405
 406 typedef struct acpi_object_region_field
 407 {
 408     ACPI_OBJECT_COMMON_HEADER
 409     ACPI_COMMON_FIELD_INFO
 410     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
 411
 412 } ACPI_OBJECT_REGION_FIELD;
 413
 414
 415 typedef struct acpi_object_bank_field
 416 {
 417     ACPI_OBJECT_COMMON_HEADER
 418     ACPI_COMMON_FIELD_INFO
 419     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
 420     union acpi_operand_object       *BankObj;           /* BankSelect Register object */
 421
 422 } ACPI_OBJECT_BANK_FIELD;
 423
 424
 425 typedef struct acpi_object_index_field
 426 {
 427     ACPI_OBJECT_COMMON_HEADER
 428     ACPI_COMMON_FIELD_INFO
 429
 430     /*
 431      * No "RegionObj" pointer needed since the Index and Data registers
 432      * are each field definitions unto themselves.
 433      */
 434     union acpi_operand_object       *IndexObj;          /* Index register */
 435     union acpi_operand_object       *DataObj;           /* Data register */
 436
 437 } ACPI_OBJECT_INDEX_FIELD;
 438
 439
 440 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
 441
 442 typedef struct acpi_object_buffer_field
 443 {
 444     ACPI_OBJECT_COMMON_HEADER
 445     ACPI_COMMON_FIELD_INFO
 446     union acpi_operand_object       *BufferObj;         /* Containing Buffer object */
 447
 448 } ACPI_OBJECT_BUFFER_FIELD;
 449
 450
 451 /******************************************************************************
 452  *
 453  * Objects for handlers
 454  *
 455  *****************************************************************************/
 456
 457 typedef struct acpi_object_notify_handler
 458 {
 459     ACPI_OBJECT_COMMON_HEADER
 460     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
 461     ACPI_NOTIFY_HANDLER             Handler;
 462     void                            *Context;
 463
 464 } ACPI_OBJECT_NOTIFY_HANDLER;
 465
 466
 467 typedef struct acpi_object_addr_handler
 468 {
 469     ACPI_OBJECT_COMMON_HEADER
 470     UINT8                           SpaceId;
 471     UINT8                           HandlerFlags;
 472     ACPI_ADR_SPACE_HANDLER          Handler;
 473     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
 474     void                            *Context;
 475     ACPI_ADR_SPACE_SETUP            Setup;
 476     union acpi_operand_object       *RegionList;        /* regions using this handler */
 477     union acpi_operand_object       *Next;
 478
 479 } ACPI_OBJECT_ADDR_HANDLER;
 480
 481 /* Flags for address handler (HandlerFlags) */
 482
 483 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x01
 484
 485
 486 /******************************************************************************
 487  *
 488  * Special internal objects
 489  *
 490  *****************************************************************************/
 491
 492 /*
 493  * The Reference object is used for these opcodes:
 494  * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp
 495  * The Reference.Class differentiates these types.
 496  */
 497 typedef struct acpi_object_reference
 498 {
 499     ACPI_OBJECT_COMMON_HEADER
 500      UINT8                           Class;              /* Reference Class */
 501      UINT8                           TargetType;         /* Used for Index Op */
 502      UINT8                           Reserved;
 503      void                            *Object;            /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
 504      ACPI_NAMESPACE_NODE             *Node;              /* RefOf or Namepath */
 505      union acpi_operand_object       **Where;            /* Target of Index */
 506      UINT32                          Value;              /* Used for Local/Arg/Index/DdbHandle */
 507
 508 } ACPI_OBJECT_REFERENCE;
 509
 510 /* Values for Reference.Class above */
 511
 512 typedef enum
 513 {
 514     ACPI_REFCLASS_LOCAL             = 0,        /* Method local */
 515     ACPI_REFCLASS_ARG               = 1,        /* Method argument */
 516     ACPI_REFCLASS_REFOF             = 2,        /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */
 517     ACPI_REFCLASS_INDEX             = 3,        /* Result of Index() */
 518     ACPI_REFCLASS_TABLE             = 4,        /* DdbHandle - Load(), LoadTable() */
 519     ACPI_REFCLASS_NAME              = 5,        /* Reference to a named object */
 520     ACPI_REFCLASS_DEBUG             = 6,        /* Debug object */
 521
 522     ACPI_REFCLASS_MAX               = 6
 523
 524 } ACPI_REFERENCE_CLASSES;
 525
 526
 527 /*
 528  * Extra object is used as additional storage for types that
 529  * have AML code in their declarations (TermArgs) that must be
 530  * evaluated at run time.
 531  *
 532  * Currently: Region and FieldUnit types
 533  */
 534 typedef struct acpi_object_extra
 535 {
 536     ACPI_OBJECT_COMMON_HEADER
 537     ACPI_NAMESPACE_NODE             *Method_REG;        /* _REG method for this region (if any) */
 538     void                            *RegionContext;     /* Region-specific data */
 539     UINT8                           *AmlStart;
 540     UINT32                          AmlLength;
 541
 542 } ACPI_OBJECT_EXTRA;
 543
 544
 545 /* Additional data that can be attached to namespace nodes */
 546
 547 typedef struct acpi_object_data
 548 {
 549     ACPI_OBJECT_COMMON_HEADER
 550     ACPI_OBJECT_HANDLER             Handler;
 551     void                            *Pointer;
 552
 553 } ACPI_OBJECT_DATA;
 554
 555
 556 /* Structure used when objects are cached for reuse */
 557
 558 typedef struct acpi_object_cache_list
 559 {
 560     ACPI_OBJECT_COMMON_HEADER
 561     union acpi_operand_object       *Next;              /* Link for object cache and internal lists*/
 562
 563 } ACPI_OBJECT_CACHE_LIST;
 564
 565
 566 /******************************************************************************
 567  *
 568  * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
 569  *
 570  *****************************************************************************/
 571
 572 typedef union acpi_operand_object
 573 {
 574     ACPI_OBJECT_COMMON                  Common;
 575     ACPI_OBJECT_INTEGER                 Integer;
 576     ACPI_OBJECT_STRING                  String;
 577     ACPI_OBJECT_BUFFER                  Buffer;
 578     ACPI_OBJECT_PACKAGE                 Package;
 579     ACPI_OBJECT_EVENT                   Event;
 580     ACPI_OBJECT_METHOD                  Method;
 581     ACPI_OBJECT_MUTEX                   Mutex;
 582     ACPI_OBJECT_REGION                  Region;
 583     ACPI_OBJECT_NOTIFY_COMMON           CommonNotify;
 584     ACPI_OBJECT_DEVICE                  Device;
 585     ACPI_OBJECT_POWER_RESOURCE          PowerResource;
 586     ACPI_OBJECT_PROCESSOR               Processor;
 587     ACPI_OBJECT_THERMAL_ZONE            ThermalZone;
 588     ACPI_OBJECT_FIELD_COMMON            CommonField;
 589     ACPI_OBJECT_REGION_FIELD            Field;
 590     ACPI_OBJECT_BUFFER_FIELD            BufferField;
 591     ACPI_OBJECT_BANK_FIELD              BankField;
 592     ACPI_OBJECT_INDEX_FIELD             IndexField;
 593     ACPI_OBJECT_NOTIFY_HANDLER          Notify;
 594     ACPI_OBJECT_ADDR_HANDLER            AddressSpace;
 595     ACPI_OBJECT_REFERENCE               Reference;
 596     ACPI_OBJECT_EXTRA                   Extra;
 597     ACPI_OBJECT_DATA                    Data;
 598     ACPI_OBJECT_CACHE_LIST              Cache;
 599
 600     /*
 601      * Add namespace node to union in order to simplify code that accepts both
 602      * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
 603      * a common DescriptorType field in order to differentiate them.
 604      */
 605     ACPI_NAMESPACE_NODE                 Node;
 606
 607 } ACPI_OPERAND_OBJECT;
 608
 609
 610 /******************************************************************************
 611  *
 612  * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
 613  *
 614  *****************************************************************************/
 615
 616 /* Object descriptor types */
 617
 618 #define ACPI_DESC_TYPE_CACHED           0x01        /* Used only when object is cached */
 619 #define ACPI_DESC_TYPE_STATE            0x02
 620 #define ACPI_DESC_TYPE_STATE_UPDATE     0x03
 621 #define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
 622 #define ACPI_DESC_TYPE_STATE_CONTROL    0x05
 623 #define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
 624 #define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
 625 #define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
 626 #define ACPI_DESC_TYPE_STATE_RESULT     0x09
 627 #define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
 628 #define ACPI_DESC_TYPE_STATE_THREAD     0x0B
 629 #define ACPI_DESC_TYPE_WALK             0x0C
 630 #define ACPI_DESC_TYPE_PARSER           0x0D
 631 #define ACPI_DESC_TYPE_OPERAND          0x0E
 632 #define ACPI_DESC_TYPE_NAMED            0x0F
 633 #define ACPI_DESC_TYPE_MAX              0x0F
 634
 635
 636 typedef struct acpi_common_descriptor
 637 {
 638     void                            *CommonPointer;
 639     UINT8                           DescriptorType; /* To differentiate various internal objs */
 640
 641 } ACPI_COMMON_DESCRIPTOR;
 642
 643 typedef union acpi_descriptor
 644 {
 645     ACPI_COMMON_DESCRIPTOR          Common;
 646     ACPI_OPERAND_OBJECT             Object;
 647     ACPI_NAMESPACE_NODE             Node;
 648     ACPI_PARSE_OBJECT               Op;
 649
 650 } ACPI_DESCRIPTOR;
 651
 652 #pragma pack()
 653
 654 #endif /* _ACOBJECT_H */