1 /******************************************************************************
3 * Name: acstruct.h - Internal structs
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2019, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACSTRUCT_H__
45 #define __ACSTRUCT_H__
47 /* acpisrc:StructDefs -- for acpisrc conversion */
49 /*****************************************************************************
51 * Tree walking typedefs and structs
53 ****************************************************************************/
57 * Walk state - current state of a parse tree walk. Used for both a leisurely
58 * stroll through the tree (for whatever reason), and for control method
61 #define ACPI_NEXT_OP_DOWNWARD 1
62 #define ACPI_NEXT_OP_UPWARD 2
65 * Groups of definitions for WalkType used for different implementations of
66 * walkers (never simultaneously) - flags for interpreter:
68 #define ACPI_WALK_NON_METHOD 0
69 #define ACPI_WALK_METHOD 0x01
70 #define ACPI_WALK_METHOD_RESTART 0x02
73 typedef struct acpi_walk_state
75 struct acpi_walk_state
*Next
; /* Next WalkState in list */
76 UINT8 DescriptorType
; /* To differentiate various internal objs */
78 UINT16 Opcode
; /* Current AML opcode */
79 UINT8 NextOpInfo
; /* Info about NextOp */
80 UINT8 NumOperands
; /* Stack pointer for Operands[] array */
81 UINT8 OperandIndex
; /* Index into operand stack, to be used by AcpiDsObjStackPush */
82 ACPI_OWNER_ID OwnerId
; /* Owner of objects created during the walk */
83 BOOLEAN LastPredicate
; /* Result of last predicate */
87 UINT8 PassNumber
; /* Parse pass during table load */
88 BOOLEAN NamespaceOverride
; /* Override existing objects */
89 UINT8 ResultSize
; /* Total elements for the result stack */
90 UINT8 ResultCount
; /* Current number of occupied elements of result stack */
93 UINT32 MethodBreakpoint
; /* For single stepping */
94 UINT32 UserBreakpoint
; /* User AML breakpoint */
97 ACPI_PARSE_STATE ParserState
; /* Current state of parser */
99 UINT32 ArgCount
; /* push for fixed or var args */
100 UINT16 MethodNestingDepth
;
101 UINT8 MethodIsNested
;
103 struct acpi_namespace_node Arguments
[ACPI_METHOD_NUM_ARGS
]; /* Control method arguments */
104 struct acpi_namespace_node LocalVariables
[ACPI_METHOD_NUM_LOCALS
]; /* Control method locals */
105 union acpi_operand_object
*Operands
[ACPI_OBJ_NUM_OPERANDS
+ 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
106 union acpi_operand_object
**Params
;
109 union acpi_operand_object
**CallerReturnDesc
;
110 ACPI_GENERIC_STATE
*ControlState
; /* List of control states (nested IFs) */
111 struct acpi_namespace_node
*DeferredNode
; /* Used when executing deferred opcodes */
112 union acpi_operand_object
*ImplicitReturnObj
;
113 struct acpi_namespace_node
*MethodCallNode
; /* Called method Node*/
114 ACPI_PARSE_OBJECT
*MethodCallOp
; /* MethodCall Op if running a method */
115 union acpi_operand_object
*MethodDesc
; /* Method descriptor if running a method */
116 struct acpi_namespace_node
*MethodNode
; /* Method node if running a method */
117 char *MethodPathname
; /* Full pathname of running method */
118 ACPI_PARSE_OBJECT
*Op
; /* Current parser op */
119 const ACPI_OPCODE_INFO
*OpInfo
; /* Info on current opcode */
120 ACPI_PARSE_OBJECT
*Origin
; /* Start of walk [Obsolete] */
121 union acpi_operand_object
*ResultObj
;
122 ACPI_GENERIC_STATE
*Results
; /* Stack of accumulated results */
123 union acpi_operand_object
*ReturnDesc
; /* Return object, if any */
124 ACPI_GENERIC_STATE
*ScopeInfo
; /* Stack of nested scopes */
125 ACPI_PARSE_OBJECT
*PrevOp
; /* Last op that was processed */
126 ACPI_PARSE_OBJECT
*NextOp
; /* next op to be processed */
127 ACPI_THREAD_STATE
*Thread
;
128 ACPI_PARSE_DOWNWARDS DescendingCallback
;
129 ACPI_PARSE_UPWARDS AscendingCallback
;
134 /* Info used by AcpiNsInitializeObjects and AcpiDsInitializeObjects */
136 typedef struct acpi_init_walk_info
141 UINT32 SerialMethodCount
;
142 UINT32 NonSerialMethodCount
;
143 UINT32 SerializedMethodCount
;
145 UINT32 OpRegionCount
;
153 ACPI_OWNER_ID OwnerId
;
155 } ACPI_INIT_WALK_INFO
;
158 typedef struct acpi_get_devices_info
160 ACPI_WALK_CALLBACK UserFunction
;
164 } ACPI_GET_DEVICES_INFO
;
167 typedef union acpi_aml_operands
169 ACPI_OPERAND_OBJECT
*Operands
[7];
173 ACPI_OBJECT_INTEGER
*Type
;
174 ACPI_OBJECT_INTEGER
*Code
;
175 ACPI_OBJECT_INTEGER
*Argument
;
181 ACPI_OPERAND_OBJECT
*Source
;
182 ACPI_OBJECT_INTEGER
*Index
;
183 ACPI_OPERAND_OBJECT
*Target
;
189 ACPI_OPERAND_OBJECT
*Source
;
190 ACPI_OBJECT_INTEGER
*Index
;
191 ACPI_OBJECT_INTEGER
*Length
;
192 ACPI_OPERAND_OBJECT
*Target
;
200 * Structure used to pass object evaluation information and parameters.
201 * Purpose is to reduce CPU stack use.
203 typedef struct acpi_evaluate_info
205 /* The first 3 elements are passed by the caller to AcpiNsEvaluate */
207 ACPI_NAMESPACE_NODE
*PrefixNode
; /* Input: starting node */
208 const char *RelativePathname
; /* Input: path relative to PrefixNode */
209 ACPI_OPERAND_OBJECT
**Parameters
; /* Input: argument list */
211 ACPI_NAMESPACE_NODE
*Node
; /* Resolved node (PrefixNode:RelativePathname) */
212 ACPI_OPERAND_OBJECT
*ObjDesc
; /* Object attached to the resolved node */
213 char *FullPathname
; /* Full pathname of the resolved node */
215 const ACPI_PREDEFINED_INFO
*Predefined
; /* Used if Node is a predefined name */
216 ACPI_OPERAND_OBJECT
*ReturnObject
; /* Object returned from the evaluation */
217 union acpi_operand_object
*ParentPackage
; /* Used if return object is a Package */
219 UINT32 ReturnFlags
; /* Used for return value analysis */
220 UINT32 ReturnBtype
; /* Bitmapped type of the returned object */
221 UINT16 ParamCount
; /* Count of the input argument list */
222 UINT8 PassNumber
; /* Parser pass number */
223 UINT8 ReturnObjectType
; /* Object type of the returned object */
224 UINT8 NodeFlags
; /* Same as Node->Flags */
225 UINT8 Flags
; /* General flags */
227 } ACPI_EVALUATE_INFO
;
229 /* Values for Flags above */
231 #define ACPI_IGNORE_RETURN_VALUE 1
233 /* Defines for ReturnFlags field above */
235 #define ACPI_OBJECT_REPAIRED 1
236 #define ACPI_OBJECT_WRAPPED 2
239 /* Info used by AcpiNsInitializeDevices */
241 typedef struct acpi_device_walk_info
243 ACPI_TABLE_DESC
*TableDesc
;
244 ACPI_EVALUATE_INFO
*EvaluateInfo
;
249 } ACPI_DEVICE_WALK_INFO
;
252 /* TBD: [Restructure] Merge with struct above */
254 typedef struct acpi_walk_info
258 ACPI_OWNER_ID OwnerId
;
265 #define ACPI_DISPLAY_SUMMARY (UINT8) 0
266 #define ACPI_DISPLAY_OBJECTS (UINT8) 1
267 #define ACPI_DISPLAY_MASK (UINT8) 1
269 #define ACPI_DISPLAY_SHORT (UINT8) 2