xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acstruct.h (revision 35786f6866ae52207d0f1a25fe7ca5f652f32ce0)
1 /******************************************************************************
2  *
3  * Name: acstruct.h - Internal structs
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, 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 __ACSTRUCT_H__
153 #define __ACSTRUCT_H__
154 
155 /* acpisrc:StructDefs -- for acpisrc conversion */
156 
157 /*****************************************************************************
158  *
159  * Tree walking typedefs and structs
160  *
161  ****************************************************************************/
162 
163 
164 /*
165  * Walk state - current state of a parse tree walk. Used for both a leisurely
166  * stroll through the tree (for whatever reason), and for control method
167  * execution.
168  */
169 #define ACPI_NEXT_OP_DOWNWARD       1
170 #define ACPI_NEXT_OP_UPWARD         2
171 
172 /*
173  * Groups of definitions for WalkType used for different implementations of
174  * walkers (never simultaneously) - flags for interpreter:
175  */
176 #define ACPI_WALK_NON_METHOD        0
177 #define ACPI_WALK_METHOD            0x01
178 #define ACPI_WALK_METHOD_RESTART    0x02
179 
180 
181 typedef struct acpi_walk_state
182 {
183     struct acpi_walk_state          *Next;              /* Next WalkState in list */
184     UINT8                           DescriptorType;     /* To differentiate various internal objs */
185     UINT8                           WalkType;
186     UINT16                          Opcode;             /* Current AML opcode */
187     UINT8                           NextOpInfo;         /* Info about NextOp */
188     UINT8                           NumOperands;        /* Stack pointer for Operands[] array */
189     UINT8                           OperandIndex;       /* Index into operand stack, to be used by AcpiDsObjStackPush */
190     ACPI_OWNER_ID                   OwnerId;            /* Owner of objects created during the walk */
191     BOOLEAN                         LastPredicate;      /* Result of last predicate */
192     UINT8                           CurrentResult;
193     UINT8                           ReturnUsed;
194     UINT8                           ScopeDepth;
195     UINT8                           PassNumber;         /* Parse pass during table load */
196     BOOLEAN                         NamespaceOverride;  /* Override existing objects */
197     UINT8                           ResultSize;         /* Total elements for the result stack */
198     UINT8                           ResultCount;        /* Current number of occupied elements of result stack */
199     UINT8                           *Aml;
200     UINT32                          ArgTypes;
201     UINT32                          MethodBreakpoint;   /* For single stepping */
202     UINT32                          UserBreakpoint;     /* User AML breakpoint */
203     UINT32                          ParseFlags;
204 
205     ACPI_PARSE_STATE                ParserState;        /* Current state of parser */
206     UINT32                          PrevArgTypes;
207     UINT32                          ArgCount;           /* push for fixed or var args */
208 
209     struct acpi_namespace_node      Arguments[ACPI_METHOD_NUM_ARGS];        /* Control method arguments */
210     struct acpi_namespace_node      LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
211     union acpi_operand_object       *Operands[ACPI_OBJ_NUM_OPERANDS + 1];   /* Operands passed to the interpreter (+1 for NULL terminator) */
212     union acpi_operand_object       **Params;
213 
214     UINT8                           *AmlLastWhile;
215     union acpi_operand_object       **CallerReturnDesc;
216     ACPI_GENERIC_STATE              *ControlState;      /* List of control states (nested IFs) */
217     struct acpi_namespace_node      *DeferredNode;      /* Used when executing deferred opcodes */
218     union acpi_operand_object       *ImplicitReturnObj;
219     struct acpi_namespace_node      *MethodCallNode;    /* Called method Node*/
220     ACPI_PARSE_OBJECT               *MethodCallOp;      /* MethodCall Op if running a method */
221     union acpi_operand_object       *MethodDesc;        /* Method descriptor if running a method */
222     struct acpi_namespace_node      *MethodNode;        /* Method node if running a method. */
223     ACPI_PARSE_OBJECT               *Op;                /* Current parser op */
224     const ACPI_OPCODE_INFO          *OpInfo;            /* Info on current opcode */
225     ACPI_PARSE_OBJECT               *Origin;            /* Start of walk [Obsolete] */
226     union acpi_operand_object       *ResultObj;
227     ACPI_GENERIC_STATE              *Results;           /* Stack of accumulated results */
228     union acpi_operand_object       *ReturnDesc;        /* Return object, if any */
229     ACPI_GENERIC_STATE              *ScopeInfo;         /* Stack of nested scopes */
230     ACPI_PARSE_OBJECT               *PrevOp;            /* Last op that was processed */
231     ACPI_PARSE_OBJECT               *NextOp;            /* next op to be processed */
232     ACPI_THREAD_STATE               *Thread;
233     ACPI_PARSE_DOWNWARDS            DescendingCallback;
234     ACPI_PARSE_UPWARDS              AscendingCallback;
235 
236 } ACPI_WALK_STATE;
237 
238 
239 /* Info used by AcpiNsInitializeObjects and AcpiDsInitializeObjects */
240 
241 typedef struct acpi_init_walk_info
242 {
243     UINT32                          TableIndex;
244     UINT32                          ObjectCount;
245     UINT32                          MethodCount;
246     UINT32                          SerialMethodCount;
247     UINT32                          NonSerialMethodCount;
248     UINT32                          SerializedMethodCount;
249     UINT32                          DeviceCount;
250     UINT32                          OpRegionCount;
251     UINT32                          FieldCount;
252     UINT32                          BufferCount;
253     UINT32                          PackageCount;
254     UINT32                          OpRegionInit;
255     UINT32                          FieldInit;
256     UINT32                          BufferInit;
257     UINT32                          PackageInit;
258     ACPI_OWNER_ID                   OwnerId;
259 
260 } ACPI_INIT_WALK_INFO;
261 
262 
263 typedef struct acpi_get_devices_info
264 {
265     ACPI_WALK_CALLBACK              UserFunction;
266     void                            *Context;
267     char                            *Hid;
268 
269 } ACPI_GET_DEVICES_INFO;
270 
271 
272 typedef union acpi_aml_operands
273 {
274     ACPI_OPERAND_OBJECT             *Operands[7];
275 
276     struct
277     {
278         ACPI_OBJECT_INTEGER             *Type;
279         ACPI_OBJECT_INTEGER             *Code;
280         ACPI_OBJECT_INTEGER             *Argument;
281 
282     } Fatal;
283 
284     struct
285     {
286         ACPI_OPERAND_OBJECT             *Source;
287         ACPI_OBJECT_INTEGER             *Index;
288         ACPI_OPERAND_OBJECT             *Target;
289 
290     } Index;
291 
292     struct
293     {
294         ACPI_OPERAND_OBJECT             *Source;
295         ACPI_OBJECT_INTEGER             *Index;
296         ACPI_OBJECT_INTEGER             *Length;
297         ACPI_OPERAND_OBJECT             *Target;
298 
299     } Mid;
300 
301 } ACPI_AML_OPERANDS;
302 
303 
304 /*
305  * Structure used to pass object evaluation information and parameters.
306  * Purpose is to reduce CPU stack use.
307  */
308 typedef struct acpi_evaluate_info
309 {
310     /* The first 3 elements are passed by the caller to AcpiNsEvaluate */
311 
312     ACPI_NAMESPACE_NODE             *PrefixNode;        /* Input: starting node */
313     const char                      *RelativePathname;  /* Input: path relative to PrefixNode */
314     ACPI_OPERAND_OBJECT             **Parameters;       /* Input: argument list */
315 
316     ACPI_NAMESPACE_NODE             *Node;              /* Resolved node (PrefixNode:RelativePathname) */
317     ACPI_OPERAND_OBJECT             *ObjDesc;           /* Object attached to the resolved node */
318     char                            *FullPathname;      /* Full pathname of the resolved node */
319 
320     const ACPI_PREDEFINED_INFO      *Predefined;        /* Used if Node is a predefined name */
321     ACPI_OPERAND_OBJECT             *ReturnObject;      /* Object returned from the evaluation */
322     union acpi_operand_object       *ParentPackage;     /* Used if return object is a Package */
323 
324     UINT32                          ReturnFlags;        /* Used for return value analysis */
325     UINT32                          ReturnBtype;        /* Bitmapped type of the returned object */
326     UINT16                          ParamCount;         /* Count of the input argument list */
327     UINT8                           PassNumber;         /* Parser pass number */
328     UINT8                           ReturnObjectType;   /* Object type of the returned object */
329     UINT8                           NodeFlags;          /* Same as Node->Flags */
330     UINT8                           Flags;              /* General flags */
331 
332 } ACPI_EVALUATE_INFO;
333 
334 /* Values for Flags above */
335 
336 #define ACPI_IGNORE_RETURN_VALUE    1
337 
338 /* Defines for ReturnFlags field above */
339 
340 #define ACPI_OBJECT_REPAIRED        1
341 #define ACPI_OBJECT_WRAPPED         2
342 
343 
344 /* Info used by AcpiNsInitializeDevices */
345 
346 typedef struct acpi_device_walk_info
347 {
348     ACPI_TABLE_DESC                 *TableDesc;
349     ACPI_EVALUATE_INFO              *EvaluateInfo;
350     UINT32                          DeviceCount;
351     UINT32                          Num_STA;
352     UINT32                          Num_INI;
353 
354 } ACPI_DEVICE_WALK_INFO;
355 
356 
357 /* TBD: [Restructure] Merge with struct above */
358 
359 typedef struct acpi_walk_info
360 {
361     UINT32                          DebugLevel;
362     UINT32                          Count;
363     ACPI_OWNER_ID                   OwnerId;
364     UINT8                           DisplayType;
365 
366 } ACPI_WALK_INFO;
367 
368 /* Display Types */
369 
370 #define ACPI_DISPLAY_SUMMARY        (UINT8) 0
371 #define ACPI_DISPLAY_OBJECTS        (UINT8) 1
372 #define ACPI_DISPLAY_MASK           (UINT8) 1
373 
374 #define ACPI_DISPLAY_SHORT          (UINT8) 2
375 
376 
377 #endif
378