1 /******************************************************************************
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
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.
47 #define NAMEOF_LOCAL_NTE "__L0"
48 #define NAMEOF_ARG_NTE "__A0"
51 * dsopcode - support for late evaluation
54 acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc);
56 acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
58 acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
60 acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
63 acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
64 union acpi_parse_object *op);
67 acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
68 union acpi_parse_object *op);
71 acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
72 union acpi_parse_object *op,
73 union acpi_operand_object *obj_desc);
75 acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
78 * dsctrl - Parser/Interpreter interface, control stack routines
81 acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
82 union acpi_parse_object *op);
85 acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
86 union acpi_parse_object *op);
89 * dsexec - Parser/Interpreter interface, method execution callbacks
92 acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
93 union acpi_operand_object *result_obj);
96 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
97 union acpi_parse_object **out_op);
99 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
102 * dsfield - Parser/Interpreter interface for AML fields
105 acpi_ds_create_field(union acpi_parse_object *op,
106 struct acpi_namespace_node *region_node,
107 struct acpi_walk_state *walk_state);
110 acpi_ds_create_bank_field(union acpi_parse_object *op,
111 struct acpi_namespace_node *region_node,
112 struct acpi_walk_state *walk_state);
115 acpi_ds_create_index_field(union acpi_parse_object *op,
116 struct acpi_namespace_node *region_node,
117 struct acpi_walk_state *walk_state);
120 acpi_ds_create_buffer_field(union acpi_parse_object *op,
121 struct acpi_walk_state *walk_state);
124 acpi_ds_init_field_objects(union acpi_parse_object *op,
125 struct acpi_walk_state *walk_state);
128 * dsload - Parser/Interpreter interface, namespace load callbacks
131 acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
132 union acpi_parse_object **out_op);
134 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
137 acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
138 union acpi_parse_object **out_op);
140 acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
143 acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
146 * dsmthdat - method data (locals/args)
149 acpi_ds_store_object_to_local(u16 opcode,
151 union acpi_operand_object *src_desc,
152 struct acpi_walk_state *walk_state);
155 acpi_ds_method_data_get_entry(u16 opcode,
157 struct acpi_walk_state *walk_state,
158 union acpi_operand_object ***node);
160 void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
162 u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
165 acpi_ds_method_data_get_value(u16 opcode,
167 struct acpi_walk_state *walk_state,
168 union acpi_operand_object **dest_desc);
171 acpi_ds_method_data_init_args(union acpi_operand_object **params,
173 struct acpi_walk_state *walk_state);
176 acpi_ds_method_data_get_node(u16 opcode,
178 struct acpi_walk_state *walk_state,
179 struct acpi_namespace_node **node);
181 void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
184 * dsmethod - Parser/Interpreter interface - control method parsing
186 acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node);
189 acpi_ds_call_control_method(struct acpi_thread_state *thread,
190 struct acpi_walk_state *walk_state,
191 union acpi_parse_object *op);
194 acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
195 union acpi_operand_object *return_desc);
198 acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
199 struct acpi_walk_state *walk_state);
202 acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
203 union acpi_operand_object *obj_desc,
204 struct acpi_walk_state *walk_state);
207 acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
213 acpi_ds_initialize_objects(acpi_native_uint table_index,
214 struct acpi_namespace_node *start_node);
217 * dsobject - Parser/Interpreter interface - object initialization and conversion
220 acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
221 union acpi_parse_object *op,
223 union acpi_operand_object **obj_desc_ptr);
226 acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
227 union acpi_parse_object *op,
229 union acpi_operand_object **obj_desc);
232 acpi_ds_init_object_from_op(struct acpi_walk_state *walk_state,
233 union acpi_parse_object *op,
234 u16 opcode, union acpi_operand_object **obj_desc);
237 acpi_ds_create_node(struct acpi_walk_state *walk_state,
238 struct acpi_namespace_node *node,
239 union acpi_parse_object *op);
242 * dsutils - Parser/Interpreter interface utility routines
244 void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
247 acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
248 struct acpi_walk_state *walk_state,
252 acpi_ds_is_result_used(union acpi_parse_object *op,
253 struct acpi_walk_state *walk_state);
256 acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
257 union acpi_operand_object *result_obj,
258 struct acpi_walk_state *walk_state);
261 acpi_ds_create_operand(struct acpi_walk_state *walk_state,
262 union acpi_parse_object *arg, u32 args_remaining);
265 acpi_ds_create_operands(struct acpi_walk_state *walk_state,
266 union acpi_parse_object *first_arg);
268 acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
270 void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
273 * dswscope - Scope Stack manipulation
276 acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
277 acpi_object_type type,
278 struct acpi_walk_state *walk_state);
280 acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
282 void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
285 * dswstate - parser WALK_STATE management routines
288 acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
291 acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
293 struct acpi_walk_state *acpi_ds_create_walk_state(acpi_owner_id owner_id,
294 union acpi_parse_object
296 union acpi_operand_object
298 struct acpi_thread_state
302 acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state,
303 union acpi_parse_object *op,
304 struct acpi_namespace_node *method_node,
307 struct acpi_evaluate_info *info, u8 pass_number);
310 acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
311 struct acpi_walk_state *walk_state);
313 void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
315 struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
319 acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
320 struct acpi_thread_state *thread);
322 acpi_status acpi_ds_result_stack_pop(struct acpi_walk_state *walk_state);
324 acpi_status acpi_ds_result_stack_push(struct acpi_walk_state *walk_state);
326 acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
328 struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
331 #ifdef ACPI_FUTURE_USAGE
333 acpi_ds_result_remove(union acpi_operand_object **object,
334 u32 index, struct acpi_walk_state *walk_state);
338 acpi_ds_result_pop(union acpi_operand_object **object,
339 struct acpi_walk_state *walk_state);
342 acpi_ds_result_push(union acpi_operand_object *object,
343 struct acpi_walk_state *walk_state);
346 acpi_ds_result_pop_from_bottom(union acpi_operand_object **object,
347 struct acpi_walk_state *walk_state);
349 #endif /* _ACDISPAT_H_ */