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