blob: 6291904be01e564d7b4433a1d35fbd30144f2774 [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/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
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
Lin Mingef805d92008-04-10 19:06:41 +040056acpi_status
57acpi_ds_get_bank_field_arguments(union acpi_operand_object *obj_desc);
58
Len Brown4be44fc2005-08-05 00:44:28 -040059acpi_status acpi_ds_get_region_arguments(union acpi_operand_object *rgn_desc);
60
61acpi_status acpi_ds_get_buffer_arguments(union acpi_operand_object *obj_desc);
62
63acpi_status acpi_ds_get_package_arguments(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040066acpi_ds_eval_buffer_field_operands(struct acpi_walk_state *walk_state,
67 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040070acpi_ds_eval_region_operands(struct acpi_walk_state *walk_state,
71 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73acpi_status
Lin Ming941f48b2008-04-10 19:06:41 +040074acpi_ds_eval_table_region_operands(struct acpi_walk_state *walk_state,
75 union acpi_parse_object *op);
76
77acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040078acpi_ds_eval_data_object_operands(struct acpi_walk_state *walk_state,
79 union acpi_parse_object *op,
80 union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Lin Mingef805d92008-04-10 19:06:41 +040082acpi_status
83acpi_ds_eval_bank_field_operands(struct acpi_walk_state *walk_state,
84 union acpi_parse_object *op);
85
Len Brown4be44fc2005-08-05 00:44:28 -040086acpi_status acpi_ds_initialize_region(acpi_handle obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Robert Moore44f6c012005-04-18 22:49:35 -040088/*
89 * dsctrl - Parser/Interpreter interface, control stack routines
90 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040092acpi_ds_exec_begin_control_op(struct acpi_walk_state *walk_state,
93 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040096acpi_ds_exec_end_control_op(struct acpi_walk_state *walk_state,
97 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Robert Moore44f6c012005-04-18 22:49:35 -040099/*
100 * dsexec - Parser/Interpreter interface, method execution callbacks
101 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400103acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
104 union acpi_operand_object *result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400107acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
108 union acpi_parse_object **out_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Len Brown4be44fc2005-08-05 00:44:28 -0400110acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Robert Moore44f6c012005-04-18 22:49:35 -0400112/*
113 * dsfield - Parser/Interpreter interface for AML fields
114 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400116acpi_ds_create_field(union acpi_parse_object *op,
117 struct acpi_namespace_node *region_node,
118 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400121acpi_ds_create_bank_field(union acpi_parse_object *op,
122 struct acpi_namespace_node *region_node,
123 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400126acpi_ds_create_index_field(union acpi_parse_object *op,
127 struct acpi_namespace_node *region_node,
128 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400131acpi_ds_create_buffer_field(union acpi_parse_object *op,
132 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400135acpi_ds_init_field_objects(union acpi_parse_object *op,
136 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Robert Moore44f6c012005-04-18 22:49:35 -0400138/*
139 * dsload - Parser/Interpreter interface, namespace load callbacks
140 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400142acpi_ds_load1_begin_op(struct acpi_walk_state *walk_state,
143 union acpi_parse_object **out_op);
144
145acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400148acpi_ds_load2_begin_op(struct acpi_walk_state *walk_state,
149 union acpi_parse_object **out_op);
150
151acpi_status acpi_ds_load2_end_op(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400154acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Robert Moore44f6c012005-04-18 22:49:35 -0400156/*
157 * dsmthdat - method data (locals/args)
158 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159acpi_status
Bob Moore1044f1f2008-09-27 11:08:41 +0800160acpi_ds_store_object_to_local(u8 type,
Len Brown4be44fc2005-08-05 00:44:28 -0400161 u32 index,
162 union acpi_operand_object *src_desc,
163 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400166acpi_ds_method_data_get_entry(u16 opcode,
167 u32 index,
168 struct acpi_walk_state *walk_state,
169 union acpi_operand_object ***node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Len Brown4be44fc2005-08-05 00:44:28 -0400171void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Len Brown4be44fc2005-08-05 00:44:28 -0400173u8 acpi_ds_is_method_value(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175acpi_status
Bob Moore1044f1f2008-09-27 11:08:41 +0800176acpi_ds_method_data_get_value(u8 type,
Len Brown4be44fc2005-08-05 00:44:28 -0400177 u32 index,
178 struct acpi_walk_state *walk_state,
179 union acpi_operand_object **dest_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400182acpi_ds_method_data_init_args(union acpi_operand_object **params,
183 u32 max_param_count,
184 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186acpi_status
Bob Moore1044f1f2008-09-27 11:08:41 +0800187acpi_ds_method_data_get_node(u8 type,
Len Brown4be44fc2005-08-05 00:44:28 -0400188 u32 index,
189 struct acpi_walk_state *walk_state,
190 struct acpi_namespace_node **node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Len Brown4be44fc2005-08-05 00:44:28 -0400192void acpi_ds_method_data_init(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Robert Moore44f6c012005-04-18 22:49:35 -0400194/*
195 * dsmethod - Parser/Interpreter interface - control method parsing
196 */
Len Brown4be44fc2005-08-05 00:44:28 -0400197acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400200acpi_ds_call_control_method(struct acpi_thread_state *thread,
201 struct acpi_walk_state *walk_state,
202 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400205acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
206 union acpi_operand_object *return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Bob Mooreb229cf92006-04-21 17:15:00 -0400208void
209acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
210 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400213acpi_ds_begin_method_execution(struct acpi_namespace_node *method_node,
214 union acpi_operand_object *obj_desc,
Bob Moore967440e32006-06-23 17:04:00 -0400215 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Bob Mooredefba1d2005-12-16 17:05:00 -0500217acpi_status
218acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state);
219
Robert Moore44f6c012005-04-18 22:49:35 -0400220/*
221 * dsinit
222 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223acpi_status
Bob Moore67a119f2008-06-10 13:42:13 +0800224acpi_ds_initialize_objects(u32 table_index,
Len Brown4be44fc2005-08-05 00:44:28 -0400225 struct acpi_namespace_node *start_node);
Robert Moore44f6c012005-04-18 22:49:35 -0400226
227/*
228 * dsobject - Parser/Interpreter interface - object initialization and conversion
229 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400231acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400237acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400243acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400248acpi_ds_create_node(struct acpi_walk_state *walk_state,
249 struct acpi_namespace_node *node,
250 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Robert Moore44f6c012005-04-18 22:49:35 -0400252/*
253 * dsutils - Parser/Interpreter interface utility routines
254 */
Len Brown4be44fc2005-08-05 00:44:28 -0400255void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257u8
Len Brown4be44fc2005-08-05 00:44:28 -0400258acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
259 struct acpi_walk_state *walk_state,
260 u8 add_reference);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
262u8
Len Brown4be44fc2005-08-05 00:44:28 -0400263acpi_ds_is_result_used(union acpi_parse_object *op,
264 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266void
Len Brown4be44fc2005-08-05 00:44:28 -0400267acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400272acpi_ds_create_operand(struct acpi_walk_state *walk_state,
273 union acpi_parse_object *arg, u32 args_remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400276acpi_ds_create_operands(struct acpi_walk_state *walk_state,
277 union acpi_parse_object *first_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Len Brown4be44fc2005-08-05 00:44:28 -0400279acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Len Brown4be44fc2005-08-05 00:44:28 -0400281void acpi_ds_clear_operands(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Bob Moore4e3156b2008-04-10 19:06:37 +0400283acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state);
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/*
286 * dswscope - Scope Stack manipulation
287 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400289acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
290 acpi_object_type type,
291 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Len Brown4be44fc2005-08-05 00:44:28 -0400293acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Len Brown4be44fc2005-08-05 00:44:28 -0400295void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Robert Moore44f6c012005-04-18 22:49:35 -0400297/*
298 * dswstate - parser WALK_STATE management routines
299 */
300acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400301acpi_ds_obj_stack_push(void *object, struct acpi_walk_state *walk_state);
Robert Moore44f6c012005-04-18 22:49:35 -0400302
303acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400304acpi_ds_obj_stack_pop(u32 pop_count, struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
Len Brownfd350942007-05-09 23:34:35 -0400306struct 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
Len Brown4be44fc2005-08-05 00:44:28 -0400309 *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400312acpi_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,
Bob Moore41195322006-05-26 16:36:00 -0400317 struct acpi_evaluate_info *info, u8 pass_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
Bob Moore773069d2008-04-10 19:06:36 +0400319void
Len Brown4be44fc2005-08-05 00:44:28 -0400320acpi_ds_obj_stack_pop_and_delete(u32 pop_count,
321 struct acpi_walk_state *walk_state);
322
323void acpi_ds_delete_walk_state(struct acpi_walk_state *walk_state);
324
325struct acpi_walk_state *acpi_ds_pop_walk_state(struct acpi_thread_state
326 *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328void
Len Brown4be44fc2005-08-05 00:44:28 -0400329acpi_ds_push_walk_state(struct acpi_walk_state *walk_state,
330 struct acpi_thread_state *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Len Brown4be44fc2005-08-05 00:44:28 -0400332acpi_status acpi_ds_result_stack_clear(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Len Brown4be44fc2005-08-05 00:44:28 -0400334struct acpi_walk_state *acpi_ds_get_current_walk_state(struct acpi_thread_state
335 *thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337acpi_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
Len Brown4be44fc2005-08-05 00:44:28 -0400345#endif /* _ACDISPAT_H_ */