Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/******************************************************************************
2 *
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, 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 __ACINTERP_H__
45#define __ACINTERP_H__
46
47#define ACPI_WALK_OPERANDS (&(walk_state->operands [walk_state->num_operands -1]))
48
49/*
50 * exconvrt - object conversion
51 */
52acpi_status
53acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
54 union acpi_operand_object **result_desc, u32 flags);
55
56acpi_status
57acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
58 union acpi_operand_object **result_desc);
59
60acpi_status
61acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
62 union acpi_operand_object **result_desc, u32 type);
63
64/* Types for ->String conversion */
65
66#define ACPI_EXPLICIT_BYTE_COPY 0x00000000
67#define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
68#define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
69#define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
70
71acpi_status
72acpi_ex_convert_to_target_type(acpi_object_type destination_type,
73 union acpi_operand_object *source_desc,
74 union acpi_operand_object **result_desc,
75 struct acpi_walk_state *walk_state);
76
77/*
78 * exfield - ACPI AML (p-code) execution - field manipulation
79 */
80acpi_status
81acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
82 u32 buffer_length, u32 * datum_count);
83
84acpi_status
85acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
86 acpi_integer mask,
87 acpi_integer field_value,
88 u32 field_datum_byte_offset);
89
90void
91acpi_ex_get_buffer_datum(acpi_integer * datum,
92 void *buffer,
93 u32 buffer_length,
94 u32 byte_granularity, u32 buffer_offset);
95
96void
97acpi_ex_set_buffer_datum(acpi_integer merged_datum,
98 void *buffer,
99 u32 buffer_length,
100 u32 byte_granularity, u32 buffer_offset);
101
102acpi_status
103acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
104 union acpi_operand_object *obj_desc,
105 union acpi_operand_object **ret_buffer_desc);
106
107acpi_status
108acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
109 union acpi_operand_object *obj_desc,
110 union acpi_operand_object **result_desc);
111
112/*
113 * exfldio - low level field I/O
114 */
115acpi_status
116acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
117 void *buffer, u32 buffer_length);
118
119acpi_status
120acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
121 void *buffer, u32 buffer_length);
122
123acpi_status
124acpi_ex_access_region(union acpi_operand_object *obj_desc,
125 u32 field_datum_byte_offset,
126 acpi_integer * value, u32 read_write);
127
128/*
129 * exmisc - misc support routines
130 */
131acpi_status
132acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
133 union acpi_operand_object **return_desc,
134 struct acpi_walk_state *walk_state);
135
136acpi_status
137acpi_ex_concat_template(union acpi_operand_object *obj_desc,
138 union acpi_operand_object *obj_desc2,
139 union acpi_operand_object **actual_return_desc,
140 struct acpi_walk_state *walk_state);
141
142acpi_status
143acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
144 union acpi_operand_object *obj_desc2,
145 union acpi_operand_object **actual_return_desc,
146 struct acpi_walk_state *walk_state);
147
148acpi_status
149acpi_ex_do_logical_numeric_op(u16 opcode,
150 acpi_integer integer0,
151 acpi_integer integer1, u8 * logical_result);
152
153acpi_status
154acpi_ex_do_logical_op(u16 opcode,
155 union acpi_operand_object *operand0,
156 union acpi_operand_object *operand1, u8 * logical_result);
157
158acpi_integer
159acpi_ex_do_math_op(u16 opcode, acpi_integer operand0, acpi_integer operand1);
160
161acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
162
163acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
164
165acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
166
167acpi_status
168acpi_ex_create_region(u8 * aml_start,
169 u32 aml_length,
170 u8 region_space, struct acpi_walk_state *walk_state);
171
172acpi_status acpi_ex_create_table_region(struct acpi_walk_state *walk_state);
173
174acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
175
176acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
177
178acpi_status
179acpi_ex_create_method(u8 * aml_start,
180 u32 aml_length, struct acpi_walk_state *walk_state);
181
182/*
183 * exconfig - dynamic table load/unload
184 */
185acpi_status
186acpi_ex_load_op(union acpi_operand_object *obj_desc,
187 union acpi_operand_object *target,
188 struct acpi_walk_state *walk_state);
189
190acpi_status
191acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
192 union acpi_operand_object **return_desc);
193
194acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
195
196/*
197 * exmutex - mutex support
198 */
199acpi_status
200acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
201 union acpi_operand_object *obj_desc,
202 struct acpi_walk_state *walk_state);
203
204acpi_status
205acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
206 struct acpi_walk_state *walk_state);
207
208void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
209
210void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
211
212/*
213 * exprep - ACPI AML execution - prep utilities
214 */
215acpi_status
216acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
217 u8 field_flags,
218 u8 field_attribute,
219 u32 field_bit_position, u32 field_bit_length);
220
221acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
222
223/*
224 * exsystem - Interface to OS services
225 */
226acpi_status
227acpi_ex_system_do_notify_op(union acpi_operand_object *value,
228 union acpi_operand_object *obj_desc);
229
230acpi_status acpi_ex_system_do_suspend(acpi_integer time);
231
232acpi_status acpi_ex_system_do_stall(u32 time);
233
234acpi_status
235acpi_ex_system_acquire_mutex(union acpi_operand_object *time,
236 union acpi_operand_object *obj_desc);
237
238acpi_status acpi_ex_system_release_mutex(union acpi_operand_object *obj_desc);
239
240acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
241
242acpi_status
243acpi_ex_system_wait_event(union acpi_operand_object *time,
244 union acpi_operand_object *obj_desc);
245
246acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
247
248acpi_status acpi_ex_system_wait_semaphore(acpi_handle semaphore, u16 timeout);
249
250/*
251 * exoparg1 - ACPI AML execution, 1 operand
252 */
253acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
254
255acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
256
257acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
258
259acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
260
261acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
262
263/*
264 * exoparg2 - ACPI AML execution, 2 operands
265 */
266acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
267
268acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
269
270acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
271
272acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
273
274/*
275 * exoparg3 - ACPI AML execution, 3 operands
276 */
277acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
278
279acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
280
281/*
282 * exoparg6 - ACPI AML execution, 6 operands
283 */
284acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
285
286/*
287 * exresolv - Object resolution and get value functions
288 */
289acpi_status
290acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
291 struct acpi_walk_state *walk_state);
292
293acpi_status
294acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
295 union acpi_operand_object *operand,
296 acpi_object_type * return_type,
297 union acpi_operand_object **return_desc);
298
299/*
300 * exresnte - resolve namespace node
301 */
302acpi_status
303acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
304 struct acpi_walk_state *walk_state);
305
306/*
307 * exresop - resolve operand to value
308 */
309acpi_status
310acpi_ex_resolve_operands(u16 opcode,
311 union acpi_operand_object **stack_ptr,
312 struct acpi_walk_state *walk_state);
313
314/*
315 * exdump - Interpreter debug output routines
316 */
317void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
318
319void
320acpi_ex_dump_operands(union acpi_operand_object **operands,
321 acpi_interpreter_mode interpreter_mode,
322 char *ident,
323 u32 num_levels,
324 char *note, char *module_name, u32 line_number);
325
326#ifdef ACPI_FUTURE_USAGE
327void
328acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
329
330void acpi_ex_dump_node(struct acpi_namespace_node *node, u32 flags);
331#endif /* ACPI_FUTURE_USAGE */
332
333/*
334 * exnames - AML namestring support
335 */
336acpi_status
337acpi_ex_get_name_string(acpi_object_type data_type,
338 u8 * in_aml_address,
339 char **out_name_string, u32 * out_name_length);
340
341/*
342 * exstore - Object store support
343 */
344acpi_status
345acpi_ex_store(union acpi_operand_object *val_desc,
346 union acpi_operand_object *dest_desc,
347 struct acpi_walk_state *walk_state);
348
349acpi_status
350acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
351 struct acpi_namespace_node *node,
352 struct acpi_walk_state *walk_state,
353 u8 implicit_conversion);
354
355#define ACPI_IMPLICIT_CONVERSION TRUE
356#define ACPI_NO_IMPLICIT_CONVERSION FALSE
357
358/*
359 * exstoren - resolve/store object
360 */
361acpi_status
362acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
363 acpi_object_type target_type,
364 struct acpi_walk_state *walk_state);
365
366acpi_status
367acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
368 union acpi_operand_object *dest_desc,
369 union acpi_operand_object **new_desc,
370 struct acpi_walk_state *walk_state);
371
372/*
373 * exstorob - store object - buffer/string
374 */
375acpi_status
376acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
377 union acpi_operand_object *target_desc);
378
379acpi_status
380acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
381 union acpi_operand_object *target_desc);
382
383/*
384 * excopy - object copy
385 */
386acpi_status
387acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
388 union acpi_operand_object *target_desc);
389
390acpi_status
391acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
392 union acpi_operand_object *target_desc);
393
394acpi_status
395acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
396 struct acpi_namespace_node *node);
397
398acpi_status
399acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
400 union acpi_operand_object *target_desc);
401
402/*
403 * exutils - interpreter/scanner utilities
404 */
405acpi_status acpi_ex_enter_interpreter(void);
406
407void acpi_ex_exit_interpreter(void);
408
409void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
410
411u8 acpi_ex_acquire_global_lock(u32 rule);
412
413void acpi_ex_release_global_lock(u8 locked);
414
415void acpi_ex_eisa_id_to_string(u32 numeric_id, char *out_string);
416
417void acpi_ex_unsigned_integer_to_string(acpi_integer value, char *out_string);
418
419/*
420 * exregion - default op_region handlers
421 */
422acpi_status
423acpi_ex_system_memory_space_handler(u32 function,
424 acpi_physical_address address,
425 u32 bit_width,
426 acpi_integer * value,
427 void *handler_context,
428 void *region_context);
429
430acpi_status
431acpi_ex_system_io_space_handler(u32 function,
432 acpi_physical_address address,
433 u32 bit_width,
434 acpi_integer * value,
435 void *handler_context, void *region_context);
436
437acpi_status
438acpi_ex_pci_config_space_handler(u32 function,
439 acpi_physical_address address,
440 u32 bit_width,
441 acpi_integer * value,
442 void *handler_context, void *region_context);
443
444acpi_status
445acpi_ex_cmos_space_handler(u32 function,
446 acpi_physical_address address,
447 u32 bit_width,
448 acpi_integer * value,
449 void *handler_context, void *region_context);
450
451acpi_status
452acpi_ex_pci_bar_space_handler(u32 function,
453 acpi_physical_address address,
454 u32 bit_width,
455 acpi_integer * value,
456 void *handler_context, void *region_context);
457
458acpi_status
459acpi_ex_embedded_controller_space_handler(u32 function,
460 acpi_physical_address address,
461 u32 bit_width,
462 acpi_integer * value,
463 void *handler_context,
464 void *region_context);
465
466acpi_status
467acpi_ex_sm_bus_space_handler(u32 function,
468 acpi_physical_address address,
469 u32 bit_width,
470 acpi_integer * value,
471 void *handler_context, void *region_context);
472
473acpi_status
474acpi_ex_data_table_space_handler(u32 function,
475 acpi_physical_address address,
476 u32 bit_width,
477 acpi_integer * value,
478 void *handler_context, void *region_context);
479
480#endif /* __INTERP_H__ */