|
1 /****************************************************************************** |
|
2 * |
|
3 * Name: acstruct.h - Internal structs |
|
4 * |
|
5 *****************************************************************************/ |
|
6 |
|
7 /* |
|
8 * Copyright (C) 2000 - 2008, Intel Corp. |
|
9 * All rights reserved. |
|
10 * |
|
11 * Redistribution and use in source and binary forms, with or without |
|
12 * modification, are permitted provided that the following conditions |
|
13 * are met: |
|
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. |
|
25 * |
|
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. |
|
29 * |
|
30 * NO WARRANTY |
|
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. |
|
42 */ |
|
43 |
|
44 #ifndef __ACSTRUCT_H__ |
|
45 #define __ACSTRUCT_H__ |
|
46 |
|
47 /* acpisrc:struct_defs -- for acpisrc conversion */ |
|
48 |
|
49 /***************************************************************************** |
|
50 * |
|
51 * Tree walking typedefs and structs |
|
52 * |
|
53 ****************************************************************************/ |
|
54 |
|
55 /* |
|
56 * Walk state - current state of a parse tree walk. Used for both a leisurely |
|
57 * stroll through the tree (for whatever reason), and for control method |
|
58 * execution. |
|
59 */ |
|
60 #define ACPI_NEXT_OP_DOWNWARD 1 |
|
61 #define ACPI_NEXT_OP_UPWARD 2 |
|
62 |
|
63 /* |
|
64 * Groups of definitions for walk_type used for different implementations of |
|
65 * walkers (never simultaneously) - flags for interpreter: |
|
66 */ |
|
67 #define ACPI_WALK_NON_METHOD 0 |
|
68 #define ACPI_WALK_METHOD 0x01 |
|
69 #define ACPI_WALK_METHOD_RESTART 0x02 |
|
70 |
|
71 /* Flags for i_aSL compiler only */ |
|
72 |
|
73 #define ACPI_WALK_CONST_REQUIRED 0x10 |
|
74 #define ACPI_WALK_CONST_OPTIONAL 0x20 |
|
75 |
|
76 struct acpi_walk_state { |
|
77 struct acpi_walk_state *next; /* Next walk_state in list */ |
|
78 u8 descriptor_type; /* To differentiate various internal objs */ |
|
79 u8 walk_type; |
|
80 u16 opcode; /* Current AML opcode */ |
|
81 u8 next_op_info; /* Info about next_op */ |
|
82 u8 num_operands; /* Stack pointer for Operands[] array */ |
|
83 u8 operand_index; /* Index into operand stack, to be used by acpi_ds_obj_stack_push */ |
|
84 acpi_owner_id owner_id; /* Owner of objects created during the walk */ |
|
85 u8 last_predicate; /* Result of last predicate */ |
|
86 u8 current_result; |
|
87 u8 return_used; |
|
88 u8 scope_depth; |
|
89 u8 pass_number; /* Parse pass during table load */ |
|
90 u8 result_size; /* Total elements for the result stack */ |
|
91 u8 result_count; /* Current number of occupied elements of result stack */ |
|
92 u32 aml_offset; |
|
93 u32 arg_types; |
|
94 u32 method_breakpoint; /* For single stepping */ |
|
95 u32 user_breakpoint; /* User AML breakpoint */ |
|
96 u32 parse_flags; |
|
97 |
|
98 struct acpi_parse_state parser_state; /* Current state of parser */ |
|
99 u32 prev_arg_types; |
|
100 u32 arg_count; /* push for fixed or var args */ |
|
101 |
|
102 struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */ |
|
103 struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */ |
|
104 union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */ |
|
105 union acpi_operand_object **params; |
|
106 |
|
107 u8 *aml_last_while; |
|
108 union acpi_operand_object **caller_return_desc; |
|
109 union acpi_generic_state *control_state; /* List of control states (nested IFs) */ |
|
110 struct acpi_namespace_node *deferred_node; /* Used when executing deferred opcodes */ |
|
111 union acpi_operand_object *implicit_return_obj; |
|
112 struct acpi_namespace_node *method_call_node; /* Called method Node */ |
|
113 union acpi_parse_object *method_call_op; /* method_call Op if running a method */ |
|
114 union acpi_operand_object *method_desc; /* Method descriptor if running a method */ |
|
115 struct acpi_namespace_node *method_node; /* Method node if running a method. */ |
|
116 union acpi_parse_object *op; /* Current parser op */ |
|
117 const struct acpi_opcode_info *op_info; /* Info on current opcode */ |
|
118 union acpi_parse_object *origin; /* Start of walk [Obsolete] */ |
|
119 union acpi_operand_object *result_obj; |
|
120 union acpi_generic_state *results; /* Stack of accumulated results */ |
|
121 union acpi_operand_object *return_desc; /* Return object, if any */ |
|
122 union acpi_generic_state *scope_info; /* Stack of nested scopes */ |
|
123 union acpi_parse_object *prev_op; /* Last op that was processed */ |
|
124 union acpi_parse_object *next_op; /* next op to be processed */ |
|
125 struct acpi_thread_state *thread; |
|
126 acpi_parse_downwards descending_callback; |
|
127 acpi_parse_upwards ascending_callback; |
|
128 }; |
|
129 |
|
130 /* Info used by acpi_ps_init_objects */ |
|
131 |
|
132 struct acpi_init_walk_info { |
|
133 u16 method_count; |
|
134 u16 device_count; |
|
135 u16 op_region_count; |
|
136 u16 field_count; |
|
137 u16 buffer_count; |
|
138 u16 package_count; |
|
139 u16 op_region_init; |
|
140 u16 field_init; |
|
141 u16 buffer_init; |
|
142 u16 package_init; |
|
143 u16 object_count; |
|
144 acpi_owner_id owner_id; |
|
145 u32 table_index; |
|
146 }; |
|
147 |
|
148 struct acpi_get_devices_info { |
|
149 acpi_walk_callback user_function; |
|
150 void *context; |
|
151 const char *hid; |
|
152 }; |
|
153 |
|
154 union acpi_aml_operands { |
|
155 union acpi_operand_object *operands[7]; |
|
156 |
|
157 struct { |
|
158 struct acpi_object_integer *type; |
|
159 struct acpi_object_integer *code; |
|
160 struct acpi_object_integer *argument; |
|
161 |
|
162 } fatal; |
|
163 |
|
164 struct { |
|
165 union acpi_operand_object *source; |
|
166 struct acpi_object_integer *index; |
|
167 union acpi_operand_object *target; |
|
168 |
|
169 } index; |
|
170 |
|
171 struct { |
|
172 union acpi_operand_object *source; |
|
173 struct acpi_object_integer *index; |
|
174 struct acpi_object_integer *length; |
|
175 union acpi_operand_object *target; |
|
176 |
|
177 } mid; |
|
178 }; |
|
179 |
|
180 /* |
|
181 * Structure used to pass object evaluation parameters. |
|
182 * Purpose is to reduce CPU stack use. |
|
183 */ |
|
184 struct acpi_evaluate_info { |
|
185 struct acpi_namespace_node *prefix_node; |
|
186 char *pathname; |
|
187 union acpi_operand_object *obj_desc; |
|
188 union acpi_operand_object **parameters; |
|
189 struct acpi_namespace_node *resolved_node; |
|
190 union acpi_operand_object *return_object; |
|
191 u8 param_count; |
|
192 u8 pass_number; |
|
193 u8 return_object_type; |
|
194 u8 flags; |
|
195 }; |
|
196 |
|
197 /* Values for Flags above */ |
|
198 |
|
199 #define ACPI_IGNORE_RETURN_VALUE 1 |
|
200 |
|
201 /* Info used by acpi_ns_initialize_devices */ |
|
202 |
|
203 struct acpi_device_walk_info { |
|
204 u16 device_count; |
|
205 u16 num_STA; |
|
206 u16 num_INI; |
|
207 struct acpi_table_desc *table_desc; |
|
208 struct acpi_evaluate_info *evaluate_info; |
|
209 }; |
|
210 |
|
211 /* TBD: [Restructure] Merge with struct above */ |
|
212 |
|
213 struct acpi_walk_info { |
|
214 u32 debug_level; |
|
215 u32 count; |
|
216 acpi_owner_id owner_id; |
|
217 u8 display_type; |
|
218 }; |
|
219 |
|
220 /* Display Types */ |
|
221 |
|
222 #define ACPI_DISPLAY_SUMMARY (u8) 0 |
|
223 #define ACPI_DISPLAY_OBJECTS (u8) 1 |
|
224 #define ACPI_DISPLAY_MASK (u8) 1 |
|
225 |
|
226 #define ACPI_DISPLAY_SHORT (u8) 2 |
|
227 |
|
228 #endif |