1*0Sstevel@tonic-gate /******************************************************************************
2*0Sstevel@tonic-gate  *
3*0Sstevel@tonic-gate  * Name: acstruct.h - Internal structs
4*0Sstevel@tonic-gate  *       $Revision: 31 $
5*0Sstevel@tonic-gate  *
6*0Sstevel@tonic-gate  *****************************************************************************/
7*0Sstevel@tonic-gate 
8*0Sstevel@tonic-gate /******************************************************************************
9*0Sstevel@tonic-gate  *
10*0Sstevel@tonic-gate  * 1. Copyright Notice
11*0Sstevel@tonic-gate  *
12*0Sstevel@tonic-gate  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13*0Sstevel@tonic-gate  * All rights reserved.
14*0Sstevel@tonic-gate  *
15*0Sstevel@tonic-gate  * 2. License
16*0Sstevel@tonic-gate  *
17*0Sstevel@tonic-gate  * 2.1. This is your license from Intel Corp. under its intellectual property
18*0Sstevel@tonic-gate  * rights.  You may have additional license terms from the party that provided
19*0Sstevel@tonic-gate  * you this software, covering your right to use that party's intellectual
20*0Sstevel@tonic-gate  * property rights.
21*0Sstevel@tonic-gate  *
22*0Sstevel@tonic-gate  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23*0Sstevel@tonic-gate  * copy of the source code appearing in this file ("Covered Code") an
24*0Sstevel@tonic-gate  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25*0Sstevel@tonic-gate  * base code distributed originally by Intel ("Original Intel Code") to copy,
26*0Sstevel@tonic-gate  * make derivatives, distribute, use and display any portion of the Covered
27*0Sstevel@tonic-gate  * Code in any form, with the right to sublicense such rights; and
28*0Sstevel@tonic-gate  *
29*0Sstevel@tonic-gate  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30*0Sstevel@tonic-gate  * license (with the right to sublicense), under only those claims of Intel
31*0Sstevel@tonic-gate  * patents that are infringed by the Original Intel Code, to make, use, sell,
32*0Sstevel@tonic-gate  * offer to sell, and import the Covered Code and derivative works thereof
33*0Sstevel@tonic-gate  * solely to the minimum extent necessary to exercise the above copyright
34*0Sstevel@tonic-gate  * license, and in no event shall the patent license extend to any additions
35*0Sstevel@tonic-gate  * to or modifications of the Original Intel Code.  No other license or right
36*0Sstevel@tonic-gate  * is granted directly or by implication, estoppel or otherwise;
37*0Sstevel@tonic-gate  *
38*0Sstevel@tonic-gate  * The above copyright and patent license is granted only if the following
39*0Sstevel@tonic-gate  * conditions are met:
40*0Sstevel@tonic-gate  *
41*0Sstevel@tonic-gate  * 3. Conditions
42*0Sstevel@tonic-gate  *
43*0Sstevel@tonic-gate  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44*0Sstevel@tonic-gate  * Redistribution of source code of any substantial portion of the Covered
45*0Sstevel@tonic-gate  * Code or modification with rights to further distribute source must include
46*0Sstevel@tonic-gate  * the above Copyright Notice, the above License, this list of Conditions,
47*0Sstevel@tonic-gate  * and the following Disclaimer and Export Compliance provision.  In addition,
48*0Sstevel@tonic-gate  * Licensee must cause all Covered Code to which Licensee contributes to
49*0Sstevel@tonic-gate  * contain a file documenting the changes Licensee made to create that Covered
50*0Sstevel@tonic-gate  * Code and the date of any change.  Licensee must include in that file the
51*0Sstevel@tonic-gate  * documentation of any changes made by any predecessor Licensee.  Licensee
52*0Sstevel@tonic-gate  * must include a prominent statement that the modification is derived,
53*0Sstevel@tonic-gate  * directly or indirectly, from Original Intel Code.
54*0Sstevel@tonic-gate  *
55*0Sstevel@tonic-gate  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56*0Sstevel@tonic-gate  * Redistribution of source code of any substantial portion of the Covered
57*0Sstevel@tonic-gate  * Code or modification without rights to further distribute source must
58*0Sstevel@tonic-gate  * include the following Disclaimer and Export Compliance provision in the
59*0Sstevel@tonic-gate  * documentation and/or other materials provided with distribution.  In
60*0Sstevel@tonic-gate  * addition, Licensee may not authorize further sublicense of source of any
61*0Sstevel@tonic-gate  * portion of the Covered Code, and must include terms to the effect that the
62*0Sstevel@tonic-gate  * license from Licensee to its licensee is limited to the intellectual
63*0Sstevel@tonic-gate  * property embodied in the software Licensee provides to its licensee, and
64*0Sstevel@tonic-gate  * not to intellectual property embodied in modifications its licensee may
65*0Sstevel@tonic-gate  * make.
66*0Sstevel@tonic-gate  *
67*0Sstevel@tonic-gate  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68*0Sstevel@tonic-gate  * substantial portion of the Covered Code or modification must reproduce the
69*0Sstevel@tonic-gate  * above Copyright Notice, and the following Disclaimer and Export Compliance
70*0Sstevel@tonic-gate  * provision in the documentation and/or other materials provided with the
71*0Sstevel@tonic-gate  * distribution.
72*0Sstevel@tonic-gate  *
73*0Sstevel@tonic-gate  * 3.4. Intel retains all right, title, and interest in and to the Original
74*0Sstevel@tonic-gate  * Intel Code.
75*0Sstevel@tonic-gate  *
76*0Sstevel@tonic-gate  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77*0Sstevel@tonic-gate  * Intel shall be used in advertising or otherwise to promote the sale, use or
78*0Sstevel@tonic-gate  * other dealings in products derived from or relating to the Covered Code
79*0Sstevel@tonic-gate  * without prior written authorization from Intel.
80*0Sstevel@tonic-gate  *
81*0Sstevel@tonic-gate  * 4. Disclaimer and Export Compliance
82*0Sstevel@tonic-gate  *
83*0Sstevel@tonic-gate  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84*0Sstevel@tonic-gate  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85*0Sstevel@tonic-gate  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86*0Sstevel@tonic-gate  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87*0Sstevel@tonic-gate  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88*0Sstevel@tonic-gate  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89*0Sstevel@tonic-gate  * PARTICULAR PURPOSE.
90*0Sstevel@tonic-gate  *
91*0Sstevel@tonic-gate  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92*0Sstevel@tonic-gate  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93*0Sstevel@tonic-gate  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94*0Sstevel@tonic-gate  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95*0Sstevel@tonic-gate  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96*0Sstevel@tonic-gate  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97*0Sstevel@tonic-gate  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98*0Sstevel@tonic-gate  * LIMITED REMEDY.
99*0Sstevel@tonic-gate  *
100*0Sstevel@tonic-gate  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101*0Sstevel@tonic-gate  * software or system incorporating such software without first obtaining any
102*0Sstevel@tonic-gate  * required license or other approval from the U. S. Department of Commerce or
103*0Sstevel@tonic-gate  * any other agency or department of the United States Government.  In the
104*0Sstevel@tonic-gate  * event Licensee exports any such software from the United States or
105*0Sstevel@tonic-gate  * re-exports any such software from a foreign destination, Licensee shall
106*0Sstevel@tonic-gate  * ensure that the distribution and export/re-export of the software is in
107*0Sstevel@tonic-gate  * compliance with all laws, regulations, orders, or other restrictions of the
108*0Sstevel@tonic-gate  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109*0Sstevel@tonic-gate  * any of its subsidiaries will export/re-export any technical data, process,
110*0Sstevel@tonic-gate  * software, or service, directly or indirectly, to any country for which the
111*0Sstevel@tonic-gate  * United States government or any agency thereof requires an export license,
112*0Sstevel@tonic-gate  * other governmental approval, or letter of assurance, without first obtaining
113*0Sstevel@tonic-gate  * such license, approval or letter.
114*0Sstevel@tonic-gate  *
115*0Sstevel@tonic-gate  *****************************************************************************/
116*0Sstevel@tonic-gate 
117*0Sstevel@tonic-gate #ifndef __ACSTRUCT_H__
118*0Sstevel@tonic-gate #define __ACSTRUCT_H__
119*0Sstevel@tonic-gate 
120*0Sstevel@tonic-gate 
121*0Sstevel@tonic-gate /*****************************************************************************
122*0Sstevel@tonic-gate  *
123*0Sstevel@tonic-gate  * Tree walking typedefs and structs
124*0Sstevel@tonic-gate  *
125*0Sstevel@tonic-gate  ****************************************************************************/
126*0Sstevel@tonic-gate 
127*0Sstevel@tonic-gate 
128*0Sstevel@tonic-gate /*
129*0Sstevel@tonic-gate  * Walk state - current state of a parse tree walk.  Used for both a leisurely stroll through
130*0Sstevel@tonic-gate  * the tree (for whatever reason), and for control method execution.
131*0Sstevel@tonic-gate  */
132*0Sstevel@tonic-gate #define ACPI_NEXT_OP_DOWNWARD       1
133*0Sstevel@tonic-gate #define ACPI_NEXT_OP_UPWARD         2
134*0Sstevel@tonic-gate 
135*0Sstevel@tonic-gate #define ACPI_WALK_NON_METHOD        0
136*0Sstevel@tonic-gate #define ACPI_WALK_METHOD            1
137*0Sstevel@tonic-gate #define ACPI_WALK_METHOD_RESTART    2
138*0Sstevel@tonic-gate #define ACPI_WALK_CONST_REQUIRED    3
139*0Sstevel@tonic-gate #define ACPI_WALK_CONST_OPTIONAL    4
140*0Sstevel@tonic-gate 
141*0Sstevel@tonic-gate typedef struct acpi_walk_state
142*0Sstevel@tonic-gate {
143*0Sstevel@tonic-gate     UINT8                       DataType;                           /* To differentiate various internal objs MUST BE FIRST!*/\
144*0Sstevel@tonic-gate     UINT8                       WalkType;
145*0Sstevel@tonic-gate     ACPI_OWNER_ID               OwnerId;                            /* Owner of objects created during the walk */
146*0Sstevel@tonic-gate     BOOLEAN                     LastPredicate;                      /* Result of last predicate */
147*0Sstevel@tonic-gate     UINT8                       Reserved;                           /* For alignment */
148*0Sstevel@tonic-gate     UINT8                       CurrentResult;                      /* */
149*0Sstevel@tonic-gate     UINT8                       NextOpInfo;                         /* Info about NextOp */
150*0Sstevel@tonic-gate     UINT8                       NumOperands;                        /* Stack pointer for Operands[] array */
151*0Sstevel@tonic-gate     UINT8                       ReturnUsed;
152*0Sstevel@tonic-gate     UINT16                      Opcode;                             /* Current AML opcode */
153*0Sstevel@tonic-gate     UINT8                       ScopeDepth;
154*0Sstevel@tonic-gate     UINT8                       Reserved1;
155*0Sstevel@tonic-gate     UINT32                      ArgCount;                           /* push for fixed or var args */
156*0Sstevel@tonic-gate     UINT32                      AmlOffset;
157*0Sstevel@tonic-gate     UINT32                      ArgTypes;
158*0Sstevel@tonic-gate     UINT32                      MethodBreakpoint;                   /* For single stepping */
159*0Sstevel@tonic-gate     UINT32                      UserBreakpoint;                     /* User AML breakpoint */
160*0Sstevel@tonic-gate     UINT32                      ParseFlags;
161*0Sstevel@tonic-gate     UINT32                      PrevArgTypes;
162*0Sstevel@tonic-gate 
163*0Sstevel@tonic-gate     UINT8                       *AmlLastWhile;
164*0Sstevel@tonic-gate     struct acpi_namespace_node  Arguments[ACPI_METHOD_NUM_ARGS];    /* Control method arguments */
165*0Sstevel@tonic-gate     union acpi_operand_object   **CallerReturnDesc;
166*0Sstevel@tonic-gate     ACPI_GENERIC_STATE          *ControlState;                      /* List of control states (nested IFs) */
167*0Sstevel@tonic-gate     struct acpi_namespace_node  *DeferredNode;                      /* Used when executing deferred opcodes */
168*0Sstevel@tonic-gate     struct acpi_gpe_event_info  *GpeEventInfo;                      /* Info for GPE (_Lxx/_Exx methods only */
169*0Sstevel@tonic-gate     union acpi_operand_object   *ImplicitReturnObj;
170*0Sstevel@tonic-gate     struct acpi_namespace_node  LocalVariables[ACPI_METHOD_NUM_LOCALS];     /* Control method locals */
171*0Sstevel@tonic-gate     struct acpi_namespace_node  *MethodCallNode;                    /* Called method Node*/
172*0Sstevel@tonic-gate     ACPI_PARSE_OBJECT           *MethodCallOp;                      /* MethodCall Op if running a method */
173*0Sstevel@tonic-gate     union acpi_operand_object   *MethodDesc;                        /* Method descriptor if running a method */
174*0Sstevel@tonic-gate     struct acpi_namespace_node  *MethodNode;                        /* Method node if running a method. */
175*0Sstevel@tonic-gate     ACPI_PARSE_OBJECT           *Op;                                /* Current parser op */
176*0Sstevel@tonic-gate     union acpi_operand_object   *Operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
177*0Sstevel@tonic-gate     const ACPI_OPCODE_INFO      *OpInfo;                            /* Info on current opcode */
178*0Sstevel@tonic-gate     ACPI_PARSE_OBJECT           *Origin;                            /* Start of walk [Obsolete] */
179*0Sstevel@tonic-gate     union acpi_operand_object   **Params;
180*0Sstevel@tonic-gate     ACPI_PARSE_STATE            ParserState;                        /* Current state of parser */
181*0Sstevel@tonic-gate     union acpi_operand_object   *ResultObj;
182*0Sstevel@tonic-gate     ACPI_GENERIC_STATE          *Results;                           /* Stack of accumulated results */
183*0Sstevel@tonic-gate     union acpi_operand_object   *ReturnDesc;                        /* Return object, if any */
184*0Sstevel@tonic-gate     ACPI_GENERIC_STATE          *ScopeInfo;                         /* Stack of nested scopes */
185*0Sstevel@tonic-gate 
186*0Sstevel@tonic-gate     ACPI_PARSE_OBJECT           *PrevOp;                            /* Last op that was processed */
187*0Sstevel@tonic-gate     ACPI_PARSE_OBJECT           *NextOp;                            /* next op to be processed */
188*0Sstevel@tonic-gate     ACPI_PARSE_DOWNWARDS        DescendingCallback;
189*0Sstevel@tonic-gate     ACPI_PARSE_UPWARDS          AscendingCallback;
190*0Sstevel@tonic-gate     ACPI_THREAD_STATE           *Thread;
191*0Sstevel@tonic-gate     struct acpi_walk_state      *Next;                              /* Next WalkState in list */
192*0Sstevel@tonic-gate 
193*0Sstevel@tonic-gate } ACPI_WALK_STATE;
194*0Sstevel@tonic-gate 
195*0Sstevel@tonic-gate 
196*0Sstevel@tonic-gate /* Info used by AcpiPsInitObjects */
197*0Sstevel@tonic-gate 
198*0Sstevel@tonic-gate typedef struct acpi_init_walk_info
199*0Sstevel@tonic-gate {
200*0Sstevel@tonic-gate     UINT16                  MethodCount;
201*0Sstevel@tonic-gate     UINT16                  DeviceCount;
202*0Sstevel@tonic-gate     UINT16                  OpRegionCount;
203*0Sstevel@tonic-gate     UINT16                  FieldCount;
204*0Sstevel@tonic-gate     UINT16                  BufferCount;
205*0Sstevel@tonic-gate     UINT16                  PackageCount;
206*0Sstevel@tonic-gate     UINT16                  OpRegionInit;
207*0Sstevel@tonic-gate     UINT16                  FieldInit;
208*0Sstevel@tonic-gate     UINT16                  BufferInit;
209*0Sstevel@tonic-gate     UINT16                  PackageInit;
210*0Sstevel@tonic-gate     UINT16                  ObjectCount;
211*0Sstevel@tonic-gate     ACPI_TABLE_DESC         *TableDesc;
212*0Sstevel@tonic-gate 
213*0Sstevel@tonic-gate } ACPI_INIT_WALK_INFO;
214*0Sstevel@tonic-gate 
215*0Sstevel@tonic-gate 
216*0Sstevel@tonic-gate /* Info used by AcpiNsInitializeDevices */
217*0Sstevel@tonic-gate 
218*0Sstevel@tonic-gate typedef struct acpi_device_walk_info
219*0Sstevel@tonic-gate {
220*0Sstevel@tonic-gate     UINT16                  DeviceCount;
221*0Sstevel@tonic-gate     UINT16                  Num_STA;
222*0Sstevel@tonic-gate     UINT16                  Num_INI;
223*0Sstevel@tonic-gate     ACPI_TABLE_DESC         *TableDesc;
224*0Sstevel@tonic-gate 
225*0Sstevel@tonic-gate } ACPI_DEVICE_WALK_INFO;
226*0Sstevel@tonic-gate 
227*0Sstevel@tonic-gate 
228*0Sstevel@tonic-gate /* TBD: [Restructure] Merge with struct above */
229*0Sstevel@tonic-gate 
230*0Sstevel@tonic-gate typedef struct acpi_walk_info
231*0Sstevel@tonic-gate {
232*0Sstevel@tonic-gate     UINT32                  DebugLevel;
233*0Sstevel@tonic-gate     UINT32                  OwnerId;
234*0Sstevel@tonic-gate     UINT8                   DisplayType;
235*0Sstevel@tonic-gate 
236*0Sstevel@tonic-gate } ACPI_WALK_INFO;
237*0Sstevel@tonic-gate 
238*0Sstevel@tonic-gate /* Display Types */
239*0Sstevel@tonic-gate 
240*0Sstevel@tonic-gate #define ACPI_DISPLAY_SUMMARY    0
241*0Sstevel@tonic-gate #define ACPI_DISPLAY_OBJECTS    1
242*0Sstevel@tonic-gate 
243*0Sstevel@tonic-gate typedef struct acpi_get_devices_info
244*0Sstevel@tonic-gate {
245*0Sstevel@tonic-gate     ACPI_WALK_CALLBACK      UserFunction;
246*0Sstevel@tonic-gate     void                    *Context;
247*0Sstevel@tonic-gate     char                    *Hid;
248*0Sstevel@tonic-gate 
249*0Sstevel@tonic-gate } ACPI_GET_DEVICES_INFO;
250*0Sstevel@tonic-gate 
251*0Sstevel@tonic-gate 
252*0Sstevel@tonic-gate typedef union acpi_aml_operands
253*0Sstevel@tonic-gate {
254*0Sstevel@tonic-gate     ACPI_OPERAND_OBJECT         *Operands[7];
255*0Sstevel@tonic-gate 
256*0Sstevel@tonic-gate     struct
257*0Sstevel@tonic-gate     {
258*0Sstevel@tonic-gate         ACPI_OBJECT_INTEGER     *Type;
259*0Sstevel@tonic-gate         ACPI_OBJECT_INTEGER     *Code;
260*0Sstevel@tonic-gate         ACPI_OBJECT_INTEGER     *Argument;
261*0Sstevel@tonic-gate 
262*0Sstevel@tonic-gate     } Fatal;
263*0Sstevel@tonic-gate 
264*0Sstevel@tonic-gate     struct
265*0Sstevel@tonic-gate     {
266*0Sstevel@tonic-gate         ACPI_OPERAND_OBJECT     *Source;
267*0Sstevel@tonic-gate         ACPI_OBJECT_INTEGER     *Index;
268*0Sstevel@tonic-gate         ACPI_OPERAND_OBJECT     *Target;
269*0Sstevel@tonic-gate 
270*0Sstevel@tonic-gate     } Index;
271*0Sstevel@tonic-gate 
272*0Sstevel@tonic-gate     struct
273*0Sstevel@tonic-gate     {
274*0Sstevel@tonic-gate         ACPI_OPERAND_OBJECT     *Source;
275*0Sstevel@tonic-gate         ACPI_OBJECT_INTEGER     *Index;
276*0Sstevel@tonic-gate         ACPI_OBJECT_INTEGER     *Length;
277*0Sstevel@tonic-gate         ACPI_OPERAND_OBJECT     *Target;
278*0Sstevel@tonic-gate 
279*0Sstevel@tonic-gate     } Mid;
280*0Sstevel@tonic-gate 
281*0Sstevel@tonic-gate } ACPI_AML_OPERANDS;
282*0Sstevel@tonic-gate 
283*0Sstevel@tonic-gate 
284*0Sstevel@tonic-gate /* Internal method parameter list */
285*0Sstevel@tonic-gate 
286*0Sstevel@tonic-gate typedef struct acpi_parameter_info
287*0Sstevel@tonic-gate {
288*0Sstevel@tonic-gate     ACPI_NAMESPACE_NODE     *Node;
289*0Sstevel@tonic-gate     ACPI_OPERAND_OBJECT     **Parameters;
290*0Sstevel@tonic-gate     ACPI_OPERAND_OBJECT     *ReturnObject;
291*0Sstevel@tonic-gate     UINT8                   ParameterType;
292*0Sstevel@tonic-gate     UINT8                   ReturnObjectType;
293*0Sstevel@tonic-gate 
294*0Sstevel@tonic-gate } ACPI_PARAMETER_INFO;
295*0Sstevel@tonic-gate 
296*0Sstevel@tonic-gate /* Types for ParameterType above */
297*0Sstevel@tonic-gate 
298*0Sstevel@tonic-gate #define ACPI_PARAM_ARGS                 0
299*0Sstevel@tonic-gate #define ACPI_PARAM_GPE                  1
300*0Sstevel@tonic-gate 
301*0Sstevel@tonic-gate 
302*0Sstevel@tonic-gate #endif
303