blob: 288f84903af76634e292d7d71615c5c3acbc0db6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acdispat.h - dispatcher (parser to interpreter interface)
4 *
5 *****************************************************************************/
6
7/*
Bob Moore4a90c7e2006-01-13 16:22:00 -05008 * Copyright (C) 2000 - 2006, R. Byron Moore
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifndef _ACDISPAT_H_
45#define _ACDISPAT_H_
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define NAMEOF_LOCAL_NTE "__L0"
48#define NAMEOF_ARG_NTE "__A0"
49
Robert Moore44f6c012005-04-18 22:49:35 -040050/*
51 * dsopcode - support for late evaluation
52 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040054acpi_ds_get_buffer_field_arguments(union acpi_operand_object *obj_desc);
55
56acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
57
58acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
59
60acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040063acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
64 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040067acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
68 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040071acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
72 union acpi_parse_object *op,
73 union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Len Brown4be44fc2005-08-05 00:44:28 -040075acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Robert Moore44f6c012005-04-18 22:49:35 -040077/*
78 * dsctrl - Parser/Interpreter interface, control stack routines
79 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040081acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
82 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040085acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
86 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Robert Moore44f6c012005-04-18 22:49:35 -040088/*
89 * dsexec - Parser/Interpreter interface, method execution callbacks
90 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040092acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
93 union acpi_operand_object *result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040096acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
97 union acpi_parse_object **out_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Len Brown4be44fc2005-08-05 00:44:28 -040099acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Robert Moore44f6c012005-04-18 22:49:35 -0400101/*
102 * dsfield - Parser/Interpreter interface for AML fields
103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400105acpi_ds_create_field(union acpi_parse_object *op,
106 struct acpi_namespace_node *region_node,
107 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400110acpi_ds_create_bank_field(union acpi_parse_object *op,
111 struct acpi_namespace_node *region_node,
112 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400115acpi_ds_create_index_field(union acpi_parse_object *op,
116 struct acpi_namespace_node *region_node,
117 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400120acpi_ds_create_buffer_field(union acpi_parse_object *op,
121 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400124acpi_ds_init_field_objects(union acpi_parse_object *op,
125 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Robert Moore44f6c012005-04-18 22:49:35 -0400127/*
128 * dsload - Parser/Interpreter interface, namespace load callbacks
129 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400131acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
132 union acpi_parse_object **out_op);
133
134acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400137acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
138 union acpi_parse_object **out_op);
139
140acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400143acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
Robert Moore44f6c012005-04-18 22:49:35 -0400145/*
146 * dsmthdat - method data (locals/args)
147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400149acpi_ds_store_object_to_local(u16 opcode,
150 u32 index,
151 union acpi_operand_object *src_desc,
152 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
154acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400155acpi_ds_method_data_get_entry(u16 opcode,
156 u32 index,
157 struct acpi_walk_state *walk_state,
158 union acpi_operand_object ***node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Len Brown4be44fc2005-08-05 00:44:28 -0400160void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Len Brown4be44fc2005-08-05 00:44:28 -0400162u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400165acpi_ds_method_data_get_value(u16 opcode,
166 u32 index,
167 struct acpi_walk_state *walk_state,
168 union acpi_operand_object **dest_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400171acpi_ds_method_data_init_args(union acpi_operand_object **params,
172 u32 max_param_count,
173 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400176acpi_ds_method_data_get_node(u16 opcode,
177 u32 index,
178 struct acpi_walk_state *walk_state,
179 struct acpi_namespace_node **node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Len Brown4be44fc2005-08-05 00:44:28 -0400181void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Robert Moore44f6c012005-04-18 22:49:35 -0400183/*
184 * dsmethod - Parser/Interpreter interface - control method parsing
185 */
Len Brown4be44fc2005-08-05 00:44:28 -0400186acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400189acpi_ds_call_control_method(struct acpi_thread_state *thread,
190 struct acpi_walk_state *walk_state,
191 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400194acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
195 union acpi_operand_object *return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Bob Mooreb229cf92006-04-21 17:15:00 -0400197void
198acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
199 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400202acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
203 union acpi_operand_object *obj_desc,
204 struct acpi_namespace_node *calling_method_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Bob Mooredefba1d2005-12-16 17:05:00 -0500206acpi_status
207acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
208
Robert Moore44f6c012005-04-18 22:49:35 -0400209/*
210 * dsinit
211 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400213acpi_ds_initialize_objects(struct acpi_table_desc *table_desc,
214 struct acpi_namespace_node *start_node);
Robert Moore44f6c012005-04-18 22:49:35 -0400215
216/*
217 * dsobject - Parser/Interpreter interface - object initialization and conversion
218 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400220acpi_ds_build_internal_buffer_obj(struct acpi_walk_state *walk_state,
221 union acpi_parse_object *op,
222 u32 buffer_length,
223 union acpi_operand_object **obj_desc_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400226acpi_ds_build_internal_package_obj(struct acpi_walk_state *walk_state,
227 union acpi_parse_object *op,
228 u32 package_length,
229 union acpi_operand_object **obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400232acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400237acpi_ds_create_node(struct acpi_walk_state *walk_state,
238 struct acpi_namespace_node *node,
239 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Robert Moore44f6c012005-04-18 22:49:35 -0400241/*
242 * dsutils - Parser/Interpreter interface utility routines
243 */
Len Brown4be44fc2005-08-05 00:44:28 -0400244void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246u8
Len Brown4be44fc2005-08-05 00:44:28 -0400247acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
248 struct acpi_walk_state *walk_state,
249 u8 add_reference);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251u8
Len Brown4be44fc2005-08-05 00:44:28 -0400252acpi_ds_is_result_used(union acpi_parse_object *op,
253 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255void
Len Brown4be44fc2005-08-05 00:44:28 -0400256acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
260acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400261acpi_ds_create_operand(struct acpi_walk_state *walk_state,
262 union acpi_parse_object *arg, u32 args_remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400265acpi_ds_create_operands(struct acpi_walk_state *walk_state,
266 union acpi_parse_object *first_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Len Brown4be44fc2005-08-05 00:44:28 -0400268acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Len Brown4be44fc2005-08-05 00:44:28 -0400270void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272/*
273 * dswscope - Scope Stack manipulation
274 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400276acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
277 acpi_object_type type,
278 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Len Brown4be44fc2005-08-05 00:44:28 -0400280acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Len Brown4be44fc2005-08-05 00:44:28 -0400282void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Robert Moore44f6c012005-04-18 22:49:35 -0400284/*
285 * dswstate - parser WALK_STATE management routines
286 */
287acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400288acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
Robert Moore44f6c012005-04-18 22:49:35 -0400289
290acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400291acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Len Brown4be44fc2005-08-05 00:44:28 -0400293struct acpi_walk_state *acpi_ds_create_walk_state(acpi_owner_id owner_id,
294 union acpi_parse_object
295 *origin,
296 union acpi_operand_object
297 *mth_desc,
298 struct acpi_thread_state
299 *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400302acpi_ds_init_aml_walk(struct acpi_walk_state *walk_state,
303 union acpi_parse_object *op,
304 struct acpi_namespace_node *method_node,
305 u8 * aml_start,
306 u32 aml_length,
Bob Moore41195322006-05-26 16:36:00 -0400307 struct acpi_evaluate_info *info, u8 pass_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400310acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
311 struct acpi_walk_state *walk_state);
312
313void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
314
315struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
316 *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318void
Len Brown4be44fc2005-08-05 00:44:28 -0400319acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
320 struct acpi_thread_state *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Len Brown4be44fc2005-08-05 00:44:28 -0400322acpi_status acpi_ds_result_stack_pop(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
Len Brown4be44fc2005-08-05 00:44:28 -0400324acpi_status acpi_ds_result_stack_push(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Len Brown4be44fc2005-08-05 00:44:28 -0400326acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Len Brown4be44fc2005-08-05 00:44:28 -0400328struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
329 *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331#ifdef ACPI_FUTURE_USAGE
332acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400333acpi_ds_result_remove(union acpi_operand_object **object,
334 u32 index, struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335#endif
336
337acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400338acpi_ds_result_pop(union acpi_operand_object **object,
339 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400342acpi_ds_result_push(union acpi_operand_object *object,
343 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400346acpi_ds_result_pop_from_bottom(union acpi_operand_object **object,
347 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Len Brown4be44fc2005-08-05 00:44:28 -0400349#endif /* _ACDISPAT_H_ */