xref: /dflybsd-src/sys/contrib/dev/acpica/source/include/acobject.h (revision aab122a655a344f78225be7816e4d6f856867832)
10d02842fSSascha Wildner /******************************************************************************
20d02842fSSascha Wildner  *
30d02842fSSascha Wildner  * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT  (Internal object only)
40d02842fSSascha Wildner  *
50d02842fSSascha Wildner  *****************************************************************************/
60d02842fSSascha Wildner 
7b4315fc7SSascha Wildner /******************************************************************************
8b4315fc7SSascha Wildner  *
9b4315fc7SSascha Wildner  * 1. Copyright Notice
10b4315fc7SSascha Wildner  *
11383048acSSascha Wildner  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
120d02842fSSascha Wildner  * All rights reserved.
130d02842fSSascha Wildner  *
14b4315fc7SSascha Wildner  * 2. License
15b4315fc7SSascha Wildner  *
16b4315fc7SSascha Wildner  * 2.1. This is your license from Intel Corp. under its intellectual property
17b4315fc7SSascha Wildner  * rights. You may have additional license terms from the party that provided
18b4315fc7SSascha Wildner  * you this software, covering your right to use that party's intellectual
19b4315fc7SSascha Wildner  * property rights.
20b4315fc7SSascha Wildner  *
21b4315fc7SSascha Wildner  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22b4315fc7SSascha Wildner  * copy of the source code appearing in this file ("Covered Code") an
23b4315fc7SSascha Wildner  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24b4315fc7SSascha Wildner  * base code distributed originally by Intel ("Original Intel Code") to copy,
25b4315fc7SSascha Wildner  * make derivatives, distribute, use and display any portion of the Covered
26b4315fc7SSascha Wildner  * Code in any form, with the right to sublicense such rights; and
27b4315fc7SSascha Wildner  *
28b4315fc7SSascha Wildner  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29b4315fc7SSascha Wildner  * license (with the right to sublicense), under only those claims of Intel
30b4315fc7SSascha Wildner  * patents that are infringed by the Original Intel Code, to make, use, sell,
31b4315fc7SSascha Wildner  * offer to sell, and import the Covered Code and derivative works thereof
32b4315fc7SSascha Wildner  * solely to the minimum extent necessary to exercise the above copyright
33b4315fc7SSascha Wildner  * license, and in no event shall the patent license extend to any additions
34b4315fc7SSascha Wildner  * to or modifications of the Original Intel Code. No other license or right
35b4315fc7SSascha Wildner  * is granted directly or by implication, estoppel or otherwise;
36b4315fc7SSascha Wildner  *
37b4315fc7SSascha Wildner  * The above copyright and patent license is granted only if the following
38b4315fc7SSascha Wildner  * conditions are met:
39b4315fc7SSascha Wildner  *
40b4315fc7SSascha Wildner  * 3. Conditions
41b4315fc7SSascha Wildner  *
42b4315fc7SSascha Wildner  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43b4315fc7SSascha Wildner  * Redistribution of source code of any substantial portion of the Covered
44b4315fc7SSascha Wildner  * Code or modification with rights to further distribute source must include
45b4315fc7SSascha Wildner  * the above Copyright Notice, the above License, this list of Conditions,
46b4315fc7SSascha Wildner  * and the following Disclaimer and Export Compliance provision. In addition,
47b4315fc7SSascha Wildner  * Licensee must cause all Covered Code to which Licensee contributes to
48b4315fc7SSascha Wildner  * contain a file documenting the changes Licensee made to create that Covered
49b4315fc7SSascha Wildner  * Code and the date of any change. Licensee must include in that file the
50b4315fc7SSascha Wildner  * documentation of any changes made by any predecessor Licensee. Licensee
51b4315fc7SSascha Wildner  * must include a prominent statement that the modification is derived,
52b4315fc7SSascha Wildner  * directly or indirectly, from Original Intel Code.
53b4315fc7SSascha Wildner  *
54b4315fc7SSascha Wildner  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55b4315fc7SSascha Wildner  * Redistribution of source code of any substantial portion of the Covered
56b4315fc7SSascha Wildner  * Code or modification without rights to further distribute source must
57b4315fc7SSascha Wildner  * include the following Disclaimer and Export Compliance provision in the
58b4315fc7SSascha Wildner  * documentation and/or other materials provided with distribution. In
59b4315fc7SSascha Wildner  * addition, Licensee may not authorize further sublicense of source of any
60b4315fc7SSascha Wildner  * portion of the Covered Code, and must include terms to the effect that the
61b4315fc7SSascha Wildner  * license from Licensee to its licensee is limited to the intellectual
62b4315fc7SSascha Wildner  * property embodied in the software Licensee provides to its licensee, and
63b4315fc7SSascha Wildner  * not to intellectual property embodied in modifications its licensee may
64b4315fc7SSascha Wildner  * make.
65b4315fc7SSascha Wildner  *
66b4315fc7SSascha Wildner  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67b4315fc7SSascha Wildner  * substantial portion of the Covered Code or modification must reproduce the
68b4315fc7SSascha Wildner  * above Copyright Notice, and the following Disclaimer and Export Compliance
69b4315fc7SSascha Wildner  * provision in the documentation and/or other materials provided with the
70b4315fc7SSascha Wildner  * distribution.
71b4315fc7SSascha Wildner  *
72b4315fc7SSascha Wildner  * 3.4. Intel retains all right, title, and interest in and to the Original
73b4315fc7SSascha Wildner  * Intel Code.
74b4315fc7SSascha Wildner  *
75b4315fc7SSascha Wildner  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76b4315fc7SSascha Wildner  * Intel shall be used in advertising or otherwise to promote the sale, use or
77b4315fc7SSascha Wildner  * other dealings in products derived from or relating to the Covered Code
78b4315fc7SSascha Wildner  * without prior written authorization from Intel.
79b4315fc7SSascha Wildner  *
80b4315fc7SSascha Wildner  * 4. Disclaimer and Export Compliance
81b4315fc7SSascha Wildner  *
82b4315fc7SSascha Wildner  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83b4315fc7SSascha Wildner  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84b4315fc7SSascha Wildner  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85b4315fc7SSascha Wildner  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86b4315fc7SSascha Wildner  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87b4315fc7SSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88b4315fc7SSascha Wildner  * PARTICULAR PURPOSE.
89b4315fc7SSascha Wildner  *
90b4315fc7SSascha Wildner  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91b4315fc7SSascha Wildner  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92b4315fc7SSascha Wildner  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93b4315fc7SSascha Wildner  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94b4315fc7SSascha Wildner  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95b4315fc7SSascha Wildner  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96b4315fc7SSascha Wildner  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97b4315fc7SSascha Wildner  * LIMITED REMEDY.
98b4315fc7SSascha Wildner  *
99b4315fc7SSascha Wildner  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100b4315fc7SSascha Wildner  * software or system incorporating such software without first obtaining any
101b4315fc7SSascha Wildner  * required license or other approval from the U. S. Department of Commerce or
102b4315fc7SSascha Wildner  * any other agency or department of the United States Government. In the
103b4315fc7SSascha Wildner  * event Licensee exports any such software from the United States or
104b4315fc7SSascha Wildner  * re-exports any such software from a foreign destination, Licensee shall
105b4315fc7SSascha Wildner  * ensure that the distribution and export/re-export of the software is in
106b4315fc7SSascha Wildner  * compliance with all laws, regulations, orders, or other restrictions of the
107b4315fc7SSascha Wildner  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108b4315fc7SSascha Wildner  * any of its subsidiaries will export/re-export any technical data, process,
109b4315fc7SSascha Wildner  * software, or service, directly or indirectly, to any country for which the
110b4315fc7SSascha Wildner  * United States government or any agency thereof requires an export license,
111b4315fc7SSascha Wildner  * other governmental approval, or letter of assurance, without first obtaining
112b4315fc7SSascha Wildner  * such license, approval or letter.
113b4315fc7SSascha Wildner  *
114b4315fc7SSascha Wildner  *****************************************************************************
115b4315fc7SSascha Wildner  *
116b4315fc7SSascha Wildner  * Alternatively, you may choose to be licensed under the terms of the
117b4315fc7SSascha Wildner  * following license:
118b4315fc7SSascha Wildner  *
1190d02842fSSascha Wildner  * Redistribution and use in source and binary forms, with or without
1200d02842fSSascha Wildner  * modification, are permitted provided that the following conditions
1210d02842fSSascha Wildner  * are met:
1220d02842fSSascha Wildner  * 1. Redistributions of source code must retain the above copyright
1230d02842fSSascha Wildner  *    notice, this list of conditions, and the following disclaimer,
1240d02842fSSascha Wildner  *    without modification.
1250d02842fSSascha Wildner  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1260d02842fSSascha Wildner  *    substantially similar to the "NO WARRANTY" disclaimer below
1270d02842fSSascha Wildner  *    ("Disclaimer") and any redistribution must be conditioned upon
1280d02842fSSascha Wildner  *    including a substantially similar Disclaimer requirement for further
1290d02842fSSascha Wildner  *    binary redistribution.
1300d02842fSSascha Wildner  * 3. Neither the names of the above-listed copyright holders nor the names
1310d02842fSSascha Wildner  *    of any contributors may be used to endorse or promote products derived
1320d02842fSSascha Wildner  *    from this software without specific prior written permission.
1330d02842fSSascha Wildner  *
134b4315fc7SSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135b4315fc7SSascha Wildner  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136b4315fc7SSascha Wildner  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137b4315fc7SSascha Wildner  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138b4315fc7SSascha Wildner  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139b4315fc7SSascha Wildner  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140b4315fc7SSascha Wildner  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141b4315fc7SSascha Wildner  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142b4315fc7SSascha Wildner  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143b4315fc7SSascha Wildner  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144b4315fc7SSascha Wildner  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145b4315fc7SSascha Wildner  *
146b4315fc7SSascha Wildner  * Alternatively, you may choose to be licensed under the terms of the
1470d02842fSSascha Wildner  * GNU General Public License ("GPL") version 2 as published by the Free
1480d02842fSSascha Wildner  * Software Foundation.
1490d02842fSSascha Wildner  *
150b4315fc7SSascha Wildner  *****************************************************************************/
1510d02842fSSascha Wildner 
1520d02842fSSascha Wildner #ifndef _ACOBJECT_H
1530d02842fSSascha Wildner #define _ACOBJECT_H
1540d02842fSSascha Wildner 
1550d02842fSSascha Wildner /* acpisrc:StructDefs -- for acpisrc conversion */
1560d02842fSSascha Wildner 
1570d02842fSSascha Wildner 
1580d02842fSSascha Wildner /*
1590d02842fSSascha Wildner  * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher
1600d02842fSSascha Wildner  * to the interpreter, and to keep track of the various handlers such as
1610d02842fSSascha Wildner  * address space handlers and notify handlers. The object is a constant
1620d02842fSSascha Wildner  * size in order to allow it to be cached and reused.
1630d02842fSSascha Wildner  *
1640d02842fSSascha Wildner  * Note: The object is optimized to be aligned and will not work if it is
1650d02842fSSascha Wildner  * byte-packed.
1660d02842fSSascha Wildner  */
1670d02842fSSascha Wildner #if ACPI_MACHINE_WIDTH == 64
1680d02842fSSascha Wildner #pragma pack(8)
1690d02842fSSascha Wildner #else
1700d02842fSSascha Wildner #pragma pack(4)
1710d02842fSSascha Wildner #endif
1720d02842fSSascha Wildner 
1730d02842fSSascha Wildner /*******************************************************************************
1740d02842fSSascha Wildner  *
1750d02842fSSascha Wildner  * Common Descriptors
1760d02842fSSascha Wildner  *
1770d02842fSSascha Wildner  ******************************************************************************/
1780d02842fSSascha Wildner 
1790d02842fSSascha Wildner /*
1800d02842fSSascha Wildner  * Common area for all objects.
1810d02842fSSascha Wildner  *
1820d02842fSSascha Wildner  * DescriptorType is used to differentiate between internal descriptors, and
1830d02842fSSascha Wildner  * must be in the same place across all descriptors
1840d02842fSSascha Wildner  *
1850d02842fSSascha Wildner  * Note: The DescriptorType and Type fields must appear in the identical
1860d02842fSSascha Wildner  * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
1870d02842fSSascha Wildner  * structures.
1880d02842fSSascha Wildner  */
1890d02842fSSascha Wildner #define ACPI_OBJECT_COMMON_HEADER \
1900d02842fSSascha Wildner     union acpi_operand_object       *NextObject;        /* Objects linked to parent NS node */\
1910d02842fSSascha Wildner     UINT8                           DescriptorType;     /* To differentiate various internal objs */\
1920d02842fSSascha Wildner     UINT8                           Type;               /* ACPI_OBJECT_TYPE */\
1930d02842fSSascha Wildner     UINT16                          ReferenceCount;     /* For object deletion management */\
1940d02842fSSascha Wildner     UINT8                           Flags;
1950d02842fSSascha Wildner     /*
1960d02842fSSascha Wildner      * Note: There are 3 bytes available here before the
1970d02842fSSascha Wildner      * next natural alignment boundary (for both 32/64 cases)
1980d02842fSSascha Wildner      */
1990d02842fSSascha Wildner 
2000d02842fSSascha Wildner /* Values for Flag byte above */
2010d02842fSSascha Wildner 
2020d02842fSSascha Wildner #define AOPOBJ_AML_CONSTANT         0x01    /* Integer is an AML constant */
2030d02842fSSascha Wildner #define AOPOBJ_STATIC_POINTER       0x02    /* Data is part of an ACPI table, don't delete */
2040d02842fSSascha Wildner #define AOPOBJ_DATA_VALID           0x04    /* Object is initialized and data is valid */
205f5f76cf2SSascha Wildner #define AOPOBJ_OBJECT_INITIALIZED   0x08    /* Region is initialized */
206f5f76cf2SSascha Wildner #define AOPOBJ_REG_CONNECTED        0x10    /* _REG was run */
207f5f76cf2SSascha Wildner #define AOPOBJ_SETUP_COMPLETE       0x20    /* Region setup is complete */
208f5f76cf2SSascha Wildner #define AOPOBJ_INVALID              0x40    /* Host OS won't allow a Region address */
2090d02842fSSascha Wildner 
2100d02842fSSascha Wildner 
2110d02842fSSascha Wildner /******************************************************************************
2120d02842fSSascha Wildner  *
2130d02842fSSascha Wildner  * Basic data types
2140d02842fSSascha Wildner  *
2150d02842fSSascha Wildner  *****************************************************************************/
2160d02842fSSascha Wildner 
2170d02842fSSascha Wildner typedef struct acpi_object_common
2180d02842fSSascha Wildner {
2190d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2200d02842fSSascha Wildner 
2210d02842fSSascha Wildner } ACPI_OBJECT_COMMON;
2220d02842fSSascha Wildner 
2230d02842fSSascha Wildner 
2240d02842fSSascha Wildner typedef struct acpi_object_integer
2250d02842fSSascha Wildner {
2260d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2270d02842fSSascha Wildner     UINT8                           Fill[3];            /* Prevent warning on some compilers */
2280d02842fSSascha Wildner     UINT64                          Value;
2290d02842fSSascha Wildner 
2300d02842fSSascha Wildner } ACPI_OBJECT_INTEGER;
2310d02842fSSascha Wildner 
2320d02842fSSascha Wildner 
2330d02842fSSascha Wildner /*
2340d02842fSSascha Wildner  * Note: The String and Buffer object must be identical through the
2350d02842fSSascha Wildner  * pointer and length elements. There is code that depends on this.
2360d02842fSSascha Wildner  *
2370d02842fSSascha Wildner  * Fields common to both Strings and Buffers
2380d02842fSSascha Wildner  */
2390d02842fSSascha Wildner #define ACPI_COMMON_BUFFER_INFO(_Type) \
2400d02842fSSascha Wildner     _Type                           *Pointer; \
2410d02842fSSascha Wildner     UINT32                          Length;
2420d02842fSSascha Wildner 
2430d02842fSSascha Wildner 
2441093ca81SSascha Wildner /* Null terminated, ASCII characters only */
2451093ca81SSascha Wildner 
2461093ca81SSascha Wildner typedef struct acpi_object_string
2470d02842fSSascha Wildner {
2480d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2490d02842fSSascha Wildner     ACPI_COMMON_BUFFER_INFO         (char)              /* String in AML stream or allocated string */
2500d02842fSSascha Wildner 
2510d02842fSSascha Wildner } ACPI_OBJECT_STRING;
2520d02842fSSascha Wildner 
2530d02842fSSascha Wildner 
2540d02842fSSascha Wildner typedef struct acpi_object_buffer
2550d02842fSSascha Wildner {
2560d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2570d02842fSSascha Wildner     ACPI_COMMON_BUFFER_INFO         (UINT8)             /* Buffer in AML stream or allocated buffer */
2580d02842fSSascha Wildner     UINT32                          AmlLength;
2590d02842fSSascha Wildner     UINT8                           *AmlStart;
2600d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
2610d02842fSSascha Wildner 
2620d02842fSSascha Wildner } ACPI_OBJECT_BUFFER;
2630d02842fSSascha Wildner 
2640d02842fSSascha Wildner 
2650d02842fSSascha Wildner typedef struct acpi_object_package
2660d02842fSSascha Wildner {
2670d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2680d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */
2690d02842fSSascha Wildner     union acpi_operand_object       **Elements;         /* Array of pointers to AcpiObjects */
2700d02842fSSascha Wildner     UINT8                           *AmlStart;
2710d02842fSSascha Wildner     UINT32                          AmlLength;
2720d02842fSSascha Wildner     UINT32                          Count;              /* # of elements in package */
2730d02842fSSascha Wildner 
2740d02842fSSascha Wildner } ACPI_OBJECT_PACKAGE;
2750d02842fSSascha Wildner 
2760d02842fSSascha Wildner 
2770d02842fSSascha Wildner /******************************************************************************
2780d02842fSSascha Wildner  *
2790d02842fSSascha Wildner  * Complex data types
2800d02842fSSascha Wildner  *
2810d02842fSSascha Wildner  *****************************************************************************/
2820d02842fSSascha Wildner 
2830d02842fSSascha Wildner typedef struct acpi_object_event
2840d02842fSSascha Wildner {
2850d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2860d02842fSSascha Wildner     ACPI_SEMAPHORE                  OsSemaphore;        /* Actual OS synchronization object */
2870d02842fSSascha Wildner 
2880d02842fSSascha Wildner } ACPI_OBJECT_EVENT;
2890d02842fSSascha Wildner 
2900d02842fSSascha Wildner 
2910d02842fSSascha Wildner typedef struct acpi_object_mutex
2920d02842fSSascha Wildner {
2930d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
2940d02842fSSascha Wildner     UINT8                           SyncLevel;          /* 0-15, specified in Mutex() call */
2950d02842fSSascha Wildner     UINT16                          AcquisitionDepth;   /* Allow multiple Acquires, same thread */
2960d02842fSSascha Wildner     ACPI_MUTEX                      OsMutex;            /* Actual OS synchronization object */
2970d02842fSSascha Wildner     ACPI_THREAD_ID                  ThreadId;           /* Current owner of the mutex */
2980d02842fSSascha Wildner     struct acpi_thread_state        *OwnerThread;       /* Current owner of the mutex */
2990d02842fSSascha Wildner     union acpi_operand_object       *Prev;              /* Link for list of acquired mutexes */
3000d02842fSSascha Wildner     union acpi_operand_object       *Next;              /* Link for list of acquired mutexes */
3010d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
3020d02842fSSascha Wildner     UINT8                           OriginalSyncLevel;  /* Owner's original sync level (0-15) */
3030d02842fSSascha Wildner 
3040d02842fSSascha Wildner } ACPI_OBJECT_MUTEX;
3050d02842fSSascha Wildner 
3060d02842fSSascha Wildner 
3070d02842fSSascha Wildner typedef struct acpi_object_region
3080d02842fSSascha Wildner {
3090d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
3100d02842fSSascha Wildner     UINT8                           SpaceId;
3110d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Containing namespace node */
3120d02842fSSascha Wildner     union acpi_operand_object       *Handler;           /* Handler for region access */
3130d02842fSSascha Wildner     union acpi_operand_object       *Next;
3140d02842fSSascha Wildner     ACPI_PHYSICAL_ADDRESS           Address;
3150d02842fSSascha Wildner     UINT32                          Length;
316*aab122a6SSascha Wildner     void                            *Pointer;           /* Only for data table regions */
3170d02842fSSascha Wildner 
3180d02842fSSascha Wildner } ACPI_OBJECT_REGION;
3190d02842fSSascha Wildner 
3200d02842fSSascha Wildner 
3210d02842fSSascha Wildner typedef struct acpi_object_method
3220d02842fSSascha Wildner {
3230d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
3240d02842fSSascha Wildner     UINT8                           InfoFlags;
3250d02842fSSascha Wildner     UINT8                           ParamCount;
3260d02842fSSascha Wildner     UINT8                           SyncLevel;
3270d02842fSSascha Wildner     union acpi_operand_object       *Mutex;
328267c04fdSSascha Wildner     union acpi_operand_object       *Node;
3290d02842fSSascha Wildner     UINT8                           *AmlStart;
3300d02842fSSascha Wildner     union
3310d02842fSSascha Wildner     {
3320d02842fSSascha Wildner         ACPI_INTERNAL_METHOD            Implementation;
3330d02842fSSascha Wildner         union acpi_operand_object       *Handler;
3340d02842fSSascha Wildner     } Dispatch;
3350d02842fSSascha Wildner 
3360d02842fSSascha Wildner     UINT32                          AmlLength;
3370d02842fSSascha Wildner     ACPI_OWNER_ID                   OwnerId;
338e5412f1eSSascha Wildner     UINT8                           ThreadCount;
3390d02842fSSascha Wildner 
3400d02842fSSascha Wildner } ACPI_OBJECT_METHOD;
3410d02842fSSascha Wildner 
3420d02842fSSascha Wildner /* Flags for InfoFlags field above */
3430d02842fSSascha Wildner 
3440d02842fSSascha Wildner #define ACPI_METHOD_MODULE_LEVEL        0x01    /* Method is actually module-level code */
3450d02842fSSascha Wildner #define ACPI_METHOD_INTERNAL_ONLY       0x02    /* Method is implemented internally (_OSI) */
3460d02842fSSascha Wildner #define ACPI_METHOD_SERIALIZED          0x04    /* Method is serialized */
3470d02842fSSascha Wildner #define ACPI_METHOD_SERIALIZED_PENDING  0x08    /* Method is to be marked serialized */
348d4972a9cSSascha Wildner #define ACPI_METHOD_IGNORE_SYNC_LEVEL   0x10    /* Method was auto-serialized at table load time */
349d4972a9cSSascha Wildner #define ACPI_METHOD_MODIFIED_NAMESPACE  0x20    /* Method modified the namespace */
3500d02842fSSascha Wildner 
3510d02842fSSascha Wildner 
3520d02842fSSascha Wildner /******************************************************************************
3530d02842fSSascha Wildner  *
3540d02842fSSascha Wildner  * Objects that can be notified. All share a common NotifyInfo area.
3550d02842fSSascha Wildner  *
3560d02842fSSascha Wildner  *****************************************************************************/
3570d02842fSSascha Wildner 
3580d02842fSSascha Wildner /*
3590d02842fSSascha Wildner  * Common fields for objects that support ASL notifications
3600d02842fSSascha Wildner  */
3610d02842fSSascha Wildner #define ACPI_COMMON_NOTIFY_INFO \
3620d02842fSSascha Wildner     union acpi_operand_object       *NotifyList[2];     /* Handlers for system/device notifies */\
3630d02842fSSascha Wildner     union acpi_operand_object       *Handler;           /* Handler for Address space */
3640d02842fSSascha Wildner 
3651093ca81SSascha Wildner /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
3660d02842fSSascha Wildner 
3671093ca81SSascha Wildner typedef struct acpi_object_notify_common
3680d02842fSSascha Wildner {
3690d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
3700d02842fSSascha Wildner     ACPI_COMMON_NOTIFY_INFO
3710d02842fSSascha Wildner 
3720d02842fSSascha Wildner } ACPI_OBJECT_NOTIFY_COMMON;
3730d02842fSSascha Wildner 
3740d02842fSSascha Wildner 
3750d02842fSSascha Wildner typedef struct acpi_object_device
3760d02842fSSascha Wildner {
3770d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
3780d02842fSSascha Wildner     ACPI_COMMON_NOTIFY_INFO
3790d02842fSSascha Wildner     ACPI_GPE_BLOCK_INFO             *GpeBlock;
3800d02842fSSascha Wildner 
3810d02842fSSascha Wildner } ACPI_OBJECT_DEVICE;
3820d02842fSSascha Wildner 
3830d02842fSSascha Wildner 
3840d02842fSSascha Wildner typedef struct acpi_object_power_resource
3850d02842fSSascha Wildner {
3860d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
3870d02842fSSascha Wildner     ACPI_COMMON_NOTIFY_INFO
3880d02842fSSascha Wildner     UINT32                          SystemLevel;
3890d02842fSSascha Wildner     UINT32                          ResourceOrder;
3900d02842fSSascha Wildner 
3910d02842fSSascha Wildner } ACPI_OBJECT_POWER_RESOURCE;
3920d02842fSSascha Wildner 
3930d02842fSSascha Wildner 
3940d02842fSSascha Wildner typedef struct acpi_object_processor
3950d02842fSSascha Wildner {
3960d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
3970d02842fSSascha Wildner 
3980d02842fSSascha Wildner     /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
3990d02842fSSascha Wildner 
4000d02842fSSascha Wildner     UINT8                           ProcId;
4010d02842fSSascha Wildner     UINT8                           Length;
4020d02842fSSascha Wildner     ACPI_COMMON_NOTIFY_INFO
4030d02842fSSascha Wildner     ACPI_IO_ADDRESS                 Address;
4040d02842fSSascha Wildner 
4050d02842fSSascha Wildner } ACPI_OBJECT_PROCESSOR;
4060d02842fSSascha Wildner 
4070d02842fSSascha Wildner 
4080d02842fSSascha Wildner typedef struct acpi_object_thermal_zone
4090d02842fSSascha Wildner {
4100d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
4110d02842fSSascha Wildner     ACPI_COMMON_NOTIFY_INFO
4120d02842fSSascha Wildner 
4130d02842fSSascha Wildner } ACPI_OBJECT_THERMAL_ZONE;
4140d02842fSSascha Wildner 
4150d02842fSSascha Wildner 
4160d02842fSSascha Wildner /******************************************************************************
4170d02842fSSascha Wildner  *
4180d02842fSSascha Wildner  * Fields. All share a common header/info field.
4190d02842fSSascha Wildner  *
4200d02842fSSascha Wildner  *****************************************************************************/
4210d02842fSSascha Wildner 
4220d02842fSSascha Wildner /*
4230d02842fSSascha Wildner  * Common bitfield for the field objects
4240d02842fSSascha Wildner  * "Field Datum"  -- a datum from the actual field object
4250d02842fSSascha Wildner  * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
4260d02842fSSascha Wildner  */
4270d02842fSSascha Wildner #define ACPI_COMMON_FIELD_INFO \
4280d02842fSSascha Wildner     UINT8                           FieldFlags;         /* Access, update, and lock bits */\
4290d02842fSSascha Wildner     UINT8                           Attribute;          /* From AccessAs keyword */\
4300d02842fSSascha Wildner     UINT8                           AccessByteWidth;    /* Read/Write size in bytes */\
4310d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Link back to parent node */\
4320d02842fSSascha Wildner     UINT32                          BitLength;          /* Length of field in bits */\
4330d02842fSSascha Wildner     UINT32                          BaseByteOffset;     /* Byte offset within containing object */\
4340d02842fSSascha Wildner     UINT32                          Value;              /* Value to store into the Bank or Index register */\
4350d02842fSSascha Wildner     UINT8                           StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\
4360d02842fSSascha Wildner     UINT8                           AccessLength;       /* For serial regions/fields */
4370d02842fSSascha Wildner 
4381093ca81SSascha Wildner /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
4390d02842fSSascha Wildner 
4401093ca81SSascha Wildner typedef struct acpi_object_field_common
4410d02842fSSascha Wildner {
4420d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
4430d02842fSSascha Wildner     ACPI_COMMON_FIELD_INFO
4440d02842fSSascha Wildner     union acpi_operand_object       *RegionObj;         /* Parent Operation Region object (REGION/BANK fields only) */
4450d02842fSSascha Wildner 
4460d02842fSSascha Wildner } ACPI_OBJECT_FIELD_COMMON;
4470d02842fSSascha Wildner 
4480d02842fSSascha Wildner 
4490d02842fSSascha Wildner typedef struct acpi_object_region_field
4500d02842fSSascha Wildner {
4510d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
4520d02842fSSascha Wildner     ACPI_COMMON_FIELD_INFO
4530d02842fSSascha Wildner     UINT16                          ResourceLength;
4540d02842fSSascha Wildner     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
4550d02842fSSascha Wildner     UINT8                           *ResourceBuffer;    /* ResourceTemplate for serial regions/fields */
4562e2672b8SSascha Wildner     UINT16                          PinNumberIndex;     /* Index relative to previous Connection/Template */
45700ffa116SSascha Wildner     UINT8                           *InternalPccBuffer; /* Internal buffer for fields associated with PCC */
4580d02842fSSascha Wildner 
4590d02842fSSascha Wildner } ACPI_OBJECT_REGION_FIELD;
4600d02842fSSascha Wildner 
4610d02842fSSascha Wildner 
4620d02842fSSascha Wildner typedef struct acpi_object_bank_field
4630d02842fSSascha Wildner {
4640d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
4650d02842fSSascha Wildner     ACPI_COMMON_FIELD_INFO
4660d02842fSSascha Wildner     union acpi_operand_object       *RegionObj;         /* Containing OpRegion object */
4670d02842fSSascha Wildner     union acpi_operand_object       *BankObj;           /* BankSelect Register object */
4680d02842fSSascha Wildner 
4690d02842fSSascha Wildner } ACPI_OBJECT_BANK_FIELD;
4700d02842fSSascha Wildner 
4710d02842fSSascha Wildner 
4720d02842fSSascha Wildner typedef struct acpi_object_index_field
4730d02842fSSascha Wildner {
4740d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
4750d02842fSSascha Wildner     ACPI_COMMON_FIELD_INFO
4760d02842fSSascha Wildner 
4770d02842fSSascha Wildner     /*
4780d02842fSSascha Wildner      * No "RegionObj" pointer needed since the Index and Data registers
4790d02842fSSascha Wildner      * are each field definitions unto themselves.
4800d02842fSSascha Wildner      */
4810d02842fSSascha Wildner     union acpi_operand_object       *IndexObj;          /* Index register */
4820d02842fSSascha Wildner     union acpi_operand_object       *DataObj;           /* Data register */
4830d02842fSSascha Wildner 
4840d02842fSSascha Wildner } ACPI_OBJECT_INDEX_FIELD;
4850d02842fSSascha Wildner 
4860d02842fSSascha Wildner 
4870d02842fSSascha Wildner /* The BufferField is different in that it is part of a Buffer, not an OpRegion */
4880d02842fSSascha Wildner 
4890d02842fSSascha Wildner typedef struct acpi_object_buffer_field
4900d02842fSSascha Wildner {
4910d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
4920d02842fSSascha Wildner     ACPI_COMMON_FIELD_INFO
493e5412f1eSSascha Wildner     BOOLEAN                         IsCreateField;      /* Special case for objects created by CreateField() */
4940d02842fSSascha Wildner     union acpi_operand_object       *BufferObj;         /* Containing Buffer object */
4950d02842fSSascha Wildner 
4960d02842fSSascha Wildner } ACPI_OBJECT_BUFFER_FIELD;
4970d02842fSSascha Wildner 
4980d02842fSSascha Wildner 
4990d02842fSSascha Wildner /******************************************************************************
5000d02842fSSascha Wildner  *
5010d02842fSSascha Wildner  * Objects for handlers
5020d02842fSSascha Wildner  *
5030d02842fSSascha Wildner  *****************************************************************************/
5040d02842fSSascha Wildner 
5050d02842fSSascha Wildner typedef struct acpi_object_notify_handler
5060d02842fSSascha Wildner {
5070d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
5080d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
5090d02842fSSascha Wildner     UINT32                          HandlerType;        /* Type: Device/System/Both */
5100d02842fSSascha Wildner     ACPI_NOTIFY_HANDLER             Handler;            /* Handler address */
5110d02842fSSascha Wildner     void                            *Context;
5120d02842fSSascha Wildner     union acpi_operand_object       *Next[2];           /* Device and System handler lists */
5130d02842fSSascha Wildner 
5140d02842fSSascha Wildner } ACPI_OBJECT_NOTIFY_HANDLER;
5150d02842fSSascha Wildner 
5160d02842fSSascha Wildner 
5170d02842fSSascha Wildner typedef struct acpi_object_addr_handler
5180d02842fSSascha Wildner {
5190d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
5200d02842fSSascha Wildner     UINT8                           SpaceId;
5210d02842fSSascha Wildner     UINT8                           HandlerFlags;
5220d02842fSSascha Wildner     ACPI_ADR_SPACE_HANDLER          Handler;
5230d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* Parent device */
5240d02842fSSascha Wildner     void                            *Context;
52501d5d5dfSSascha Wildner     ACPI_MUTEX                      ContextMutex;
5260d02842fSSascha Wildner     ACPI_ADR_SPACE_SETUP            Setup;
5270d02842fSSascha Wildner     union acpi_operand_object       *RegionList;        /* Regions using this handler */
5280d02842fSSascha Wildner     union acpi_operand_object       *Next;
5290d02842fSSascha Wildner 
5300d02842fSSascha Wildner } ACPI_OBJECT_ADDR_HANDLER;
5310d02842fSSascha Wildner 
5320d02842fSSascha Wildner /* Flags for address handler (HandlerFlags) */
5330d02842fSSascha Wildner 
5340d02842fSSascha Wildner #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED  0x01
5350d02842fSSascha Wildner 
5360d02842fSSascha Wildner 
5370d02842fSSascha Wildner /******************************************************************************
5380d02842fSSascha Wildner  *
5390d02842fSSascha Wildner  * Special internal objects
5400d02842fSSascha Wildner  *
5410d02842fSSascha Wildner  *****************************************************************************/
5420d02842fSSascha Wildner 
5430d02842fSSascha Wildner /*
5440d02842fSSascha Wildner  * The Reference object is used for these opcodes:
5450d02842fSSascha Wildner  * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp
5460d02842fSSascha Wildner  * The Reference.Class differentiates these types.
5470d02842fSSascha Wildner  */
5480d02842fSSascha Wildner typedef struct acpi_object_reference
5490d02842fSSascha Wildner {
5500d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
5510d02842fSSascha Wildner     UINT8                           Class;              /* Reference Class */
5520d02842fSSascha Wildner     UINT8                           TargetType;         /* Used for Index Op */
5533c639e0cSSascha Wildner     UINT8                           Resolved;           /* Reference has been resolved to a value */
5540d02842fSSascha Wildner     void                            *Object;            /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */
5550d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Node;              /* RefOf or Namepath */
5560d02842fSSascha Wildner     union acpi_operand_object       **Where;            /* Target of Index */
55725ca8c79SSascha Wildner     UINT8                           *IndexPointer;      /* Used for Buffers and Strings */
5583c639e0cSSascha Wildner     UINT8                           *Aml;               /* Used for deferred resolution of the ref */
5590d02842fSSascha Wildner     UINT32                          Value;              /* Used for Local/Arg/Index/DdbHandle */
5600d02842fSSascha Wildner 
5610d02842fSSascha Wildner } ACPI_OBJECT_REFERENCE;
5620d02842fSSascha Wildner 
5630d02842fSSascha Wildner /* Values for Reference.Class above */
5640d02842fSSascha Wildner 
5650d02842fSSascha Wildner typedef enum
5660d02842fSSascha Wildner {
5670d02842fSSascha Wildner     ACPI_REFCLASS_LOCAL             = 0,        /* Method local */
5680d02842fSSascha Wildner     ACPI_REFCLASS_ARG               = 1,        /* Method argument */
5690d02842fSSascha Wildner     ACPI_REFCLASS_REFOF             = 2,        /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */
5700d02842fSSascha Wildner     ACPI_REFCLASS_INDEX             = 3,        /* Result of Index() */
5710d02842fSSascha Wildner     ACPI_REFCLASS_TABLE             = 4,        /* DdbHandle - Load(), LoadTable() */
5720d02842fSSascha Wildner     ACPI_REFCLASS_NAME              = 5,        /* Reference to a named object */
5730d02842fSSascha Wildner     ACPI_REFCLASS_DEBUG             = 6,        /* Debug object */
5740d02842fSSascha Wildner 
5750d02842fSSascha Wildner     ACPI_REFCLASS_MAX               = 6
5760d02842fSSascha Wildner 
5770d02842fSSascha Wildner } ACPI_REFERENCE_CLASSES;
5780d02842fSSascha Wildner 
5790d02842fSSascha Wildner /*
5800d02842fSSascha Wildner  * Extra object is used as additional storage for types that
5810d02842fSSascha Wildner  * have AML code in their declarations (TermArgs) that must be
5820d02842fSSascha Wildner  * evaluated at run time.
5830d02842fSSascha Wildner  *
5840d02842fSSascha Wildner  * Currently: Region and FieldUnit types
5850d02842fSSascha Wildner  */
5860d02842fSSascha Wildner typedef struct acpi_object_extra
5870d02842fSSascha Wildner {
5880d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
5890d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *Method_REG;        /* _REG method for this region (if any) */
5900d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             *ScopeNode;
5910d02842fSSascha Wildner     void                            *RegionContext;     /* Region-specific data */
5920d02842fSSascha Wildner     UINT8                           *AmlStart;
5930d02842fSSascha Wildner     UINT32                          AmlLength;
5940d02842fSSascha Wildner 
5950d02842fSSascha Wildner } ACPI_OBJECT_EXTRA;
5960d02842fSSascha Wildner 
5970d02842fSSascha Wildner 
5980d02842fSSascha Wildner /* Additional data that can be attached to namespace nodes */
5990d02842fSSascha Wildner 
6000d02842fSSascha Wildner typedef struct acpi_object_data
6010d02842fSSascha Wildner {
6020d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
6030d02842fSSascha Wildner     ACPI_OBJECT_HANDLER             Handler;
6040d02842fSSascha Wildner     void                            *Pointer;
6050d02842fSSascha Wildner 
6060d02842fSSascha Wildner } ACPI_OBJECT_DATA;
6070d02842fSSascha Wildner 
6080d02842fSSascha Wildner 
6090d02842fSSascha Wildner /* Structure used when objects are cached for reuse */
6100d02842fSSascha Wildner 
6110d02842fSSascha Wildner typedef struct acpi_object_cache_list
6120d02842fSSascha Wildner {
6130d02842fSSascha Wildner     ACPI_OBJECT_COMMON_HEADER
6140d02842fSSascha Wildner     union acpi_operand_object       *Next;              /* Link for object cache and internal lists*/
6150d02842fSSascha Wildner 
6160d02842fSSascha Wildner } ACPI_OBJECT_CACHE_LIST;
6170d02842fSSascha Wildner 
6180d02842fSSascha Wildner 
6190d02842fSSascha Wildner /******************************************************************************
6200d02842fSSascha Wildner  *
6210d02842fSSascha Wildner  * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above
6220d02842fSSascha Wildner  *
6230d02842fSSascha Wildner  *****************************************************************************/
6240d02842fSSascha Wildner 
6250d02842fSSascha Wildner typedef union acpi_operand_object
6260d02842fSSascha Wildner {
6270d02842fSSascha Wildner     ACPI_OBJECT_COMMON                  Common;
6280d02842fSSascha Wildner     ACPI_OBJECT_INTEGER                 Integer;
6290d02842fSSascha Wildner     ACPI_OBJECT_STRING                  String;
6300d02842fSSascha Wildner     ACPI_OBJECT_BUFFER                  Buffer;
6310d02842fSSascha Wildner     ACPI_OBJECT_PACKAGE                 Package;
6320d02842fSSascha Wildner     ACPI_OBJECT_EVENT                   Event;
6330d02842fSSascha Wildner     ACPI_OBJECT_METHOD                  Method;
6340d02842fSSascha Wildner     ACPI_OBJECT_MUTEX                   Mutex;
6350d02842fSSascha Wildner     ACPI_OBJECT_REGION                  Region;
6360d02842fSSascha Wildner     ACPI_OBJECT_NOTIFY_COMMON           CommonNotify;
6370d02842fSSascha Wildner     ACPI_OBJECT_DEVICE                  Device;
6380d02842fSSascha Wildner     ACPI_OBJECT_POWER_RESOURCE          PowerResource;
6390d02842fSSascha Wildner     ACPI_OBJECT_PROCESSOR               Processor;
6400d02842fSSascha Wildner     ACPI_OBJECT_THERMAL_ZONE            ThermalZone;
6410d02842fSSascha Wildner     ACPI_OBJECT_FIELD_COMMON            CommonField;
6420d02842fSSascha Wildner     ACPI_OBJECT_REGION_FIELD            Field;
6430d02842fSSascha Wildner     ACPI_OBJECT_BUFFER_FIELD            BufferField;
6440d02842fSSascha Wildner     ACPI_OBJECT_BANK_FIELD              BankField;
6450d02842fSSascha Wildner     ACPI_OBJECT_INDEX_FIELD             IndexField;
6460d02842fSSascha Wildner     ACPI_OBJECT_NOTIFY_HANDLER          Notify;
6470d02842fSSascha Wildner     ACPI_OBJECT_ADDR_HANDLER            AddressSpace;
6480d02842fSSascha Wildner     ACPI_OBJECT_REFERENCE               Reference;
6490d02842fSSascha Wildner     ACPI_OBJECT_EXTRA                   Extra;
6500d02842fSSascha Wildner     ACPI_OBJECT_DATA                    Data;
6510d02842fSSascha Wildner     ACPI_OBJECT_CACHE_LIST              Cache;
6520d02842fSSascha Wildner 
6530d02842fSSascha Wildner     /*
6540d02842fSSascha Wildner      * Add namespace node to union in order to simplify code that accepts both
6550d02842fSSascha Wildner      * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
6560d02842fSSascha Wildner      * a common DescriptorType field in order to differentiate them.
6570d02842fSSascha Wildner      */
6580d02842fSSascha Wildner     ACPI_NAMESPACE_NODE                 Node;
6590d02842fSSascha Wildner 
6600d02842fSSascha Wildner } ACPI_OPERAND_OBJECT;
6610d02842fSSascha Wildner 
6620d02842fSSascha Wildner 
6630d02842fSSascha Wildner /******************************************************************************
6640d02842fSSascha Wildner  *
6650d02842fSSascha Wildner  * ACPI_DESCRIPTOR - objects that share a common descriptor identifier
6660d02842fSSascha Wildner  *
6670d02842fSSascha Wildner  *****************************************************************************/
6680d02842fSSascha Wildner 
6690d02842fSSascha Wildner /* Object descriptor types */
6700d02842fSSascha Wildner 
6710d02842fSSascha Wildner #define ACPI_DESC_TYPE_CACHED           0x01        /* Used only when object is cached */
6720d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE            0x02
6730d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_UPDATE     0x03
6740d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_PACKAGE    0x04
6750d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_CONTROL    0x05
6760d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_RPSCOPE    0x06
6770d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_PSCOPE     0x07
6780d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_WSCOPE     0x08
6790d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_RESULT     0x09
6800d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_NOTIFY     0x0A
6810d02842fSSascha Wildner #define ACPI_DESC_TYPE_STATE_THREAD     0x0B
6820d02842fSSascha Wildner #define ACPI_DESC_TYPE_WALK             0x0C
6830d02842fSSascha Wildner #define ACPI_DESC_TYPE_PARSER           0x0D
6840d02842fSSascha Wildner #define ACPI_DESC_TYPE_OPERAND          0x0E
6850d02842fSSascha Wildner #define ACPI_DESC_TYPE_NAMED            0x0F
6860d02842fSSascha Wildner #define ACPI_DESC_TYPE_MAX              0x0F
6870d02842fSSascha Wildner 
6880d02842fSSascha Wildner 
6890d02842fSSascha Wildner typedef struct acpi_common_descriptor
6900d02842fSSascha Wildner {
6910d02842fSSascha Wildner     void                            *CommonPointer;
6920d02842fSSascha Wildner     UINT8                           DescriptorType; /* To differentiate various internal objs */
6930d02842fSSascha Wildner 
6940d02842fSSascha Wildner } ACPI_COMMON_DESCRIPTOR;
6950d02842fSSascha Wildner 
6960d02842fSSascha Wildner typedef union acpi_descriptor
6970d02842fSSascha Wildner {
6980d02842fSSascha Wildner     ACPI_COMMON_DESCRIPTOR          Common;
6990d02842fSSascha Wildner     ACPI_OPERAND_OBJECT             Object;
7000d02842fSSascha Wildner     ACPI_NAMESPACE_NODE             Node;
7010d02842fSSascha Wildner     ACPI_PARSE_OBJECT               Op;
7020d02842fSSascha Wildner 
7030d02842fSSascha Wildner } ACPI_DESCRIPTOR;
7040d02842fSSascha Wildner 
705d4972a9cSSascha Wildner #pragma pack()
7060d02842fSSascha Wildner 
7070d02842fSSascha Wildner #endif /* _ACOBJECT_H */
708