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