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