Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acdispat.h - dispatcher (parser to interpreter interface) | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
b4e104ea | 8 | * Copyright (C) 2000 - 2011, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 LT |
44 | #ifndef _ACDISPAT_H_ |
45 | #define _ACDISPAT_H_ | |
46 | ||
1da177e4 LT |
47 | #define NAMEOF_LOCAL_NTE "__L0" |
48 | #define NAMEOF_ARG_NTE "__A0" | |
49 | ||
44f6c012 RM |
50 | /* |
51 | * dsopcode - support for late evaluation | |
52 | */ | |
1da177e4 | 53 | acpi_status |
4be44fcd | 54 | acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc); |
1da177e4 | 55 | |
ef805d95 LM |
56 | acpi_status |
57 | acpi_ds_get_bank_field_arguments(union acpi_operand_object *obj_desc); | |
58 | ||
4be44fcd | 59 | acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc); |
1da177e4 | 60 | |
4be44fcd | 61 | acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc); |
1da177e4 | 62 | |
4be44fcd | 63 | acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc); |
1da177e4 LT |
64 | |
65 | acpi_status | |
4be44fcd LB |
66 | acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state, |
67 | union acpi_parse_object *op); | |
1da177e4 LT |
68 | |
69 | acpi_status | |
4be44fcd LB |
70 | acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state, |
71 | union acpi_parse_object *op); | |
1da177e4 | 72 | |
941f48bb LM |
73 | acpi_status |
74 | acpi_ds_eval_table_region_operands(struct acpi_walk_state *walk_state, | |
75 | union acpi_parse_object *op); | |
76 | ||
1da177e4 | 77 | acpi_status |
4be44fcd LB |
78 | acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state, |
79 | union acpi_parse_object *op, | |
80 | union acpi_operand_object *obj_desc); | |
1da177e4 | 81 | |
ef805d95 LM |
82 | acpi_status |
83 | acpi_ds_eval_bank_field_operands(struct acpi_walk_state *walk_state, | |
84 | union acpi_parse_object *op); | |
85 | ||
4be44fcd | 86 | acpi_status acpi_ds_initialize_region(acpi_handle obj_handle); |
1da177e4 | 87 | |
44f6c012 RM |
88 | /* |
89 | * dsctrl - Parser/Interpreter interface, control stack routines | |
90 | */ | |
1da177e4 | 91 | acpi_status |
4be44fcd LB |
92 | acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state, |
93 | union acpi_parse_object *op); | |
1da177e4 LT |
94 | |
95 | acpi_status | |
4be44fcd LB |
96 | acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state, |
97 | union acpi_parse_object *op); | |
1da177e4 | 98 | |
44f6c012 RM |
99 | /* |
100 | * dsexec - Parser/Interpreter interface, method execution callbacks | |
101 | */ | |
1da177e4 | 102 | acpi_status |
4be44fcd LB |
103 | acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state, |
104 | union acpi_operand_object *result_obj); | |
1da177e4 LT |
105 | |
106 | acpi_status | |
4be44fcd LB |
107 | acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state, |
108 | union acpi_parse_object **out_op); | |
1da177e4 | 109 | |
4be44fcd | 110 | acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state); |
1da177e4 | 111 | |
44f6c012 RM |
112 | /* |
113 | * dsfield - Parser/Interpreter interface for AML fields | |
114 | */ | |
1da177e4 | 115 | acpi_status |
4be44fcd LB |
116 | acpi_ds_create_field(union acpi_parse_object *op, |
117 | struct acpi_namespace_node *region_node, | |
118 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
119 | |
120 | acpi_status | |
4be44fcd LB |
121 | acpi_ds_create_bank_field(union acpi_parse_object *op, |
122 | struct acpi_namespace_node *region_node, | |
123 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
124 | |
125 | acpi_status | |
4be44fcd LB |
126 | acpi_ds_create_index_field(union acpi_parse_object *op, |
127 | struct acpi_namespace_node *region_node, | |
128 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
129 | |
130 | acpi_status | |
4be44fcd LB |
131 | acpi_ds_create_buffer_field(union acpi_parse_object *op, |
132 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
133 | |
134 | acpi_status | |
4be44fcd LB |
135 | acpi_ds_init_field_objects(union acpi_parse_object *op, |
136 | struct acpi_walk_state *walk_state); | |
1da177e4 | 137 | |
44f6c012 RM |
138 | /* |
139 | * dsload - Parser/Interpreter interface, namespace load callbacks | |
140 | */ | |
1da177e4 | 141 | acpi_status |
4be44fcd LB |
142 | acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state, |
143 | union acpi_parse_object **out_op); | |
1da177e4 | 144 | |
4be44fcd | 145 | acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state); |
1da177e4 LT |
146 | |
147 | acpi_status | |
4be44fcd LB |
148 | acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state, |
149 | union acpi_parse_object **out_op); | |
1da177e4 | 150 | |
4be44fcd | 151 | acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state); |
1da177e4 LT |
152 | |
153 | acpi_status | |
4be44fcd | 154 | acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number); |
1da177e4 | 155 | |
44f6c012 RM |
156 | /* |
157 | * dsmthdat - method data (locals/args) | |
158 | */ | |
1da177e4 | 159 | acpi_status |
1044f1f6 | 160 | acpi_ds_store_object_to_local(u8 type, |
4be44fcd LB |
161 | u32 index, |
162 | union acpi_operand_object *src_desc, | |
163 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
164 | |
165 | acpi_status | |
4be44fcd LB |
166 | acpi_ds_method_data_get_entry(u16 opcode, |
167 | u32 index, | |
168 | struct acpi_walk_state *walk_state, | |
169 | union acpi_operand_object ***node); | |
1da177e4 | 170 | |
4be44fcd | 171 | void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state); |
1da177e4 | 172 | |
4be44fcd | 173 | u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc); |
1da177e4 | 174 | |
1da177e4 | 175 | acpi_status |
1044f1f6 | 176 | acpi_ds_method_data_get_value(u8 type, |
4be44fcd LB |
177 | u32 index, |
178 | struct acpi_walk_state *walk_state, | |
179 | union acpi_operand_object **dest_desc); | |
1da177e4 | 180 | |
1da177e4 | 181 | acpi_status |
4be44fcd LB |
182 | acpi_ds_method_data_init_args(union acpi_operand_object **params, |
183 | u32 max_param_count, | |
184 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
185 | |
186 | acpi_status | |
1044f1f6 | 187 | acpi_ds_method_data_get_node(u8 type, |
4be44fcd LB |
188 | u32 index, |
189 | struct acpi_walk_state *walk_state, | |
190 | struct acpi_namespace_node **node); | |
1da177e4 | 191 | |
4be44fcd | 192 | void acpi_ds_method_data_init(struct acpi_walk_state *walk_state); |
1da177e4 | 193 | |
44f6c012 RM |
194 | /* |
195 | * dsmethod - Parser/Interpreter interface - control method parsing | |
196 | */ | |
4be44fcd | 197 | acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node); |
1da177e4 LT |
198 | |
199 | acpi_status | |
4be44fcd LB |
200 | acpi_ds_call_control_method(struct acpi_thread_state *thread, |
201 | struct acpi_walk_state *walk_state, | |
202 | union acpi_parse_object *op); | |
1da177e4 LT |
203 | |
204 | acpi_status | |
4be44fcd LB |
205 | acpi_ds_restart_control_method(struct acpi_walk_state *walk_state, |
206 | union acpi_operand_object *return_desc); | |
1da177e4 | 207 | |
b229cf92 BM |
208 | void |
209 | acpi_ds_terminate_control_method(union acpi_operand_object *method_desc, | |
210 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
211 | |
212 | acpi_status | |
4be44fcd LB |
213 | acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node, |
214 | union acpi_operand_object *obj_desc, | |
967440e3 | 215 | struct acpi_walk_state *walk_state); |
1da177e4 | 216 | |
defba1d8 BM |
217 | acpi_status |
218 | acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state); | |
219 | ||
44f6c012 RM |
220 | /* |
221 | * dsinit | |
222 | */ | |
1da177e4 | 223 | acpi_status |
67a119f9 | 224 | acpi_ds_initialize_objects(u32 table_index, |
4be44fcd | 225 | struct acpi_namespace_node *start_node); |
44f6c012 RM |
226 | |
227 | /* | |
228 | * dsobject - Parser/Interpreter interface - object initialization and conversion | |
229 | */ | |
1da177e4 | 230 | acpi_status |
4be44fcd LB |
231 | acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state, |
232 | union acpi_parse_object *op, | |
233 | u32 buffer_length, | |
234 | union acpi_operand_object **obj_desc_ptr); | |
1da177e4 LT |
235 | |
236 | acpi_status | |
4be44fcd LB |
237 | acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state, |
238 | union acpi_parse_object *op, | |
239 | u32 package_length, | |
240 | union acpi_operand_object **obj_desc); | |
1da177e4 | 241 | |
1da177e4 | 242 | acpi_status |
4be44fcd LB |
243 | acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state, |
244 | union acpi_parse_object *op, | |
245 | u16 opcode, union acpi_operand_object **obj_desc); | |
1da177e4 LT |
246 | |
247 | acpi_status | |
4be44fcd LB |
248 | acpi_ds_create_node(struct acpi_walk_state *walk_state, |
249 | struct acpi_namespace_node *node, | |
250 | union acpi_parse_object *op); | |
1da177e4 | 251 | |
44f6c012 RM |
252 | /* |
253 | * dsutils - Parser/Interpreter interface utility routines | |
254 | */ | |
4be44fcd | 255 | void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state); |
1da177e4 LT |
256 | |
257 | u8 | |
4be44fcd LB |
258 | acpi_ds_do_implicit_return(union acpi_operand_object *return_desc, |
259 | struct acpi_walk_state *walk_state, | |
260 | u8 add_reference); | |
1da177e4 LT |
261 | |
262 | u8 | |
4be44fcd LB |
263 | acpi_ds_is_result_used(union acpi_parse_object *op, |
264 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
265 | |
266 | void | |
4be44fcd LB |
267 | acpi_ds_delete_result_if_not_used(union acpi_parse_object *op, |
268 | union acpi_operand_object *result_obj, | |
269 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
270 | |
271 | acpi_status | |
4be44fcd LB |
272 | acpi_ds_create_operand(struct acpi_walk_state *walk_state, |
273 | union acpi_parse_object *arg, u32 args_remaining); | |
1da177e4 LT |
274 | |
275 | acpi_status | |
4be44fcd LB |
276 | acpi_ds_create_operands(struct acpi_walk_state *walk_state, |
277 | union acpi_parse_object *first_arg); | |
1da177e4 | 278 | |
4be44fcd | 279 | acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state); |
1da177e4 | 280 | |
4be44fcd | 281 | void acpi_ds_clear_operands(struct acpi_walk_state *walk_state); |
1da177e4 | 282 | |
4e3156b1 BM |
283 | acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state); |
284 | ||
1da177e4 LT |
285 | /* |
286 | * dswscope - Scope Stack manipulation | |
287 | */ | |
1da177e4 | 288 | acpi_status |
4be44fcd LB |
289 | acpi_ds_scope_stack_push(struct acpi_namespace_node *node, |
290 | acpi_object_type type, | |
291 | struct acpi_walk_state *walk_state); | |
1da177e4 | 292 | |
4be44fcd | 293 | acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state); |
1da177e4 | 294 | |
4be44fcd | 295 | void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state); |
1da177e4 | 296 | |
44f6c012 RM |
297 | /* |
298 | * dswstate - parser WALK_STATE management routines | |
299 | */ | |
300 | acpi_status | |
4be44fcd | 301 | acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state); |
44f6c012 RM |
302 | |
303 | acpi_status | |
4be44fcd | 304 | acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state); |
1da177e4 | 305 | |
fd350943 LB |
306 | struct acpi_walk_state *acpi_ds_create_walk_state(acpi_owner_id owner_id, union acpi_parse_object |
307 | *origin, union acpi_operand_object | |
308 | *mth_desc, struct acpi_thread_state | |
4be44fcd | 309 | *thread); |
1da177e4 LT |
310 | |
311 | acpi_status | |
4be44fcd LB |
312 | acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state, |
313 | union acpi_parse_object *op, | |
314 | struct acpi_namespace_node *method_node, | |
315 | u8 * aml_start, | |
316 | u32 aml_length, | |
4119532c | 317 | struct acpi_evaluate_info *info, u8 pass_number); |
1da177e4 | 318 | |
773069d4 | 319 | void |
4be44fcd LB |
320 | acpi_ds_obj_stack_pop_and_delete(u32 pop_count, |
321 | struct acpi_walk_state *walk_state); | |
1da177e4 | 322 | |
4be44fcd | 323 | void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state); |
1da177e4 | 324 | |
4be44fcd LB |
325 | struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state |
326 | *thread); | |
1da177e4 LT |
327 | |
328 | void | |
4be44fcd LB |
329 | acpi_ds_push_walk_state(struct acpi_walk_state *walk_state, |
330 | struct acpi_thread_state *thread); | |
1da177e4 | 331 | |
4be44fcd | 332 | acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state); |
1da177e4 | 333 | |
4be44fcd LB |
334 | struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state |
335 | *thread); | |
1da177e4 | 336 | |
1da177e4 | 337 | acpi_status |
4be44fcd LB |
338 | acpi_ds_result_pop(union acpi_operand_object **object, |
339 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
340 | |
341 | acpi_status | |
4be44fcd LB |
342 | acpi_ds_result_push(union acpi_operand_object *object, |
343 | struct acpi_walk_state *walk_state); | |
1da177e4 | 344 | |
4be44fcd | 345 | #endif /* _ACDISPAT_H_ */ |