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