1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #ifndef __ACINTERP_H__
45 #define __ACINTERP_H__
47 #define ACPI_WALK_OPERANDS (&(walk_state->operands [walk_state->num_operands -1]))
49 /* Macros for tables used for debug output */
51 #define ACPI_EXD_OFFSET(f) (u8) ACPI_OFFSET (union acpi_operand_object,f)
52 #define ACPI_EXD_NSOFFSET(f) (u8) ACPI_OFFSET (struct acpi_namespace_node,f)
53 #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (struct acpi_exdump_info))
56 * If possible, pack the following structures to byte alignment, since we
57 * don't care about performance for debug output. Two cases where we cannot
58 * pack the structures:
60 * 1) Hardware does not support misaligned memory transfers
61 * 2) Compiler does not support pointers within packed structures
63 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
67 typedef const struct acpi_exdump_info {
74 /* Values for the Opcode field above */
76 #define ACPI_EXD_INIT 0
77 #define ACPI_EXD_TYPE 1
78 #define ACPI_EXD_UINT8 2
79 #define ACPI_EXD_UINT16 3
80 #define ACPI_EXD_UINT32 4
81 #define ACPI_EXD_UINT64 5
82 #define ACPI_EXD_LITERAL 6
83 #define ACPI_EXD_POINTER 7
84 #define ACPI_EXD_ADDRESS 8
85 #define ACPI_EXD_STRING 9
86 #define ACPI_EXD_BUFFER 10
87 #define ACPI_EXD_PACKAGE 11
88 #define ACPI_EXD_FIELD 12
89 #define ACPI_EXD_REFERENCE 13
91 /* restore default alignment */
96 * exconvrt - object conversion
99 acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
100 union acpi_operand_object **result_desc, u32 flags);
103 acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
104 union acpi_operand_object **result_desc);
107 acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
108 union acpi_operand_object **result_desc, u32 type);
110 /* Types for ->String conversion */
112 #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
113 #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
114 #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
115 #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
118 acpi_ex_convert_to_target_type(acpi_object_type destination_type,
119 union acpi_operand_object *source_desc,
120 union acpi_operand_object **result_desc,
121 struct acpi_walk_state *walk_state);
124 * exfield - ACPI AML (p-code) execution - field manipulation
127 acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
128 u32 buffer_length, u32 * datum_count);
131 acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
133 acpi_integer field_value,
134 u32 field_datum_byte_offset);
137 acpi_ex_get_buffer_datum(acpi_integer * datum,
140 u32 byte_granularity, u32 buffer_offset);
143 acpi_ex_set_buffer_datum(acpi_integer merged_datum,
146 u32 byte_granularity, u32 buffer_offset);
149 acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
150 union acpi_operand_object *obj_desc,
151 union acpi_operand_object **ret_buffer_desc);
154 acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
155 union acpi_operand_object *obj_desc,
156 union acpi_operand_object **result_desc);
159 * exfldio - low level field I/O
162 acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
163 void *buffer, u32 buffer_length);
166 acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
167 void *buffer, u32 buffer_length);
170 acpi_ex_access_region(union acpi_operand_object *obj_desc,
171 u32 field_datum_byte_offset,
172 acpi_integer * value, u32 read_write);
175 * exmisc - misc support routines
178 acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
179 union acpi_operand_object **return_desc,
180 struct acpi_walk_state *walk_state);
183 acpi_ex_concat_template(union acpi_operand_object *obj_desc,
184 union acpi_operand_object *obj_desc2,
185 union acpi_operand_object **actual_return_desc,
186 struct acpi_walk_state *walk_state);
189 acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
190 union acpi_operand_object *obj_desc2,
191 union acpi_operand_object **actual_return_desc,
192 struct acpi_walk_state *walk_state);
195 acpi_ex_do_logical_numeric_op(u16 opcode,
196 acpi_integer integer0,
197 acpi_integer integer1, u8 * logical_result);
200 acpi_ex_do_logical_op(u16 opcode,
201 union acpi_operand_object *operand0,
202 union acpi_operand_object *operand1, u8 * logical_result);
205 acpi_ex_do_math_op(u16 opcode, acpi_integer operand0, acpi_integer operand1);
207 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
209 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
211 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
214 acpi_ex_create_region(u8 * aml_start,
216 u8 region_space, struct acpi_walk_state *walk_state);
218 acpi_status acpi_ex_create_table_region(struct acpi_walk_state *walk_state);
220 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
222 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
225 acpi_ex_create_method(u8 * aml_start,
226 u32 aml_length, struct acpi_walk_state *walk_state);
229 * exconfig - dynamic table load/unload
232 acpi_ex_load_op(union acpi_operand_object *obj_desc,
233 union acpi_operand_object *target,
234 struct acpi_walk_state *walk_state);
237 acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
238 union acpi_operand_object **return_desc);
240 acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
243 * exmutex - mutex support
246 acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
247 union acpi_operand_object *obj_desc,
248 struct acpi_walk_state *walk_state);
251 acpi_ex_acquire_mutex_object(u16 timeout,
252 union acpi_operand_object *obj_desc,
253 acpi_thread_id thread_id);
256 acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
257 struct acpi_walk_state *walk_state);
259 acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
261 void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
263 void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
266 * exprep - ACPI AML execution - prep utilities
269 acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
272 u32 field_bit_position, u32 field_bit_length);
274 acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
277 * exsystem - Interface to OS services
280 acpi_ex_system_do_notify_op(union acpi_operand_object *value,
281 union acpi_operand_object *obj_desc);
283 acpi_status acpi_ex_system_do_suspend(acpi_integer time);
285 acpi_status acpi_ex_system_do_stall(u32 time);
287 acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
290 acpi_ex_system_wait_event(union acpi_operand_object *time,
291 union acpi_operand_object *obj_desc);
293 acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
296 acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
298 acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
301 * exoparg1 - ACPI AML execution, 1 operand
303 acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
305 acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
307 acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
309 acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
311 acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
314 * exoparg2 - ACPI AML execution, 2 operands
316 acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
318 acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
320 acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
322 acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
325 * exoparg3 - ACPI AML execution, 3 operands
327 acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
329 acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
332 * exoparg6 - ACPI AML execution, 6 operands
334 acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
337 * exresolv - Object resolution and get value functions
340 acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
341 struct acpi_walk_state *walk_state);
344 acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
345 union acpi_operand_object *operand,
346 acpi_object_type * return_type,
347 union acpi_operand_object **return_desc);
350 * exresnte - resolve namespace node
353 acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
354 struct acpi_walk_state *walk_state);
357 * exresop - resolve operand to value
360 acpi_ex_resolve_operands(u16 opcode,
361 union acpi_operand_object **stack_ptr,
362 struct acpi_walk_state *walk_state);
365 * exdump - Interpreter debug output routines
367 void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
370 acpi_ex_dump_operands(union acpi_operand_object **operands,
371 acpi_interpreter_mode interpreter_mode,
374 char *note, char *module_name, u32 line_number);
376 #ifdef ACPI_FUTURE_USAGE
378 acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
380 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
381 #endif /* ACPI_FUTURE_USAGE */
384 * exnames - AML namestring support
387 acpi_ex_get_name_string(acpi_object_type data_type,
389 char **out_name_string, u32 * out_name_length);
392 * exstore - Object store support
395 acpi_ex_store(union acpi_operand_object *val_desc,
396 union acpi_operand_object *dest_desc,
397 struct acpi_walk_state *walk_state);
400 acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
401 struct acpi_namespace_node *node,
402 struct acpi_walk_state *walk_state,
403 u8 implicit_conversion);
405 #define ACPI_IMPLICIT_CONVERSION TRUE
406 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
409 * exstoren - resolve/store object
412 acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
413 acpi_object_type target_type,
414 struct acpi_walk_state *walk_state);
417 acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
418 union acpi_operand_object *dest_desc,
419 union acpi_operand_object **new_desc,
420 struct acpi_walk_state *walk_state);
423 * exstorob - store object - buffer/string
426 acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
427 union acpi_operand_object *target_desc);
430 acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
431 union acpi_operand_object *target_desc);
434 * excopy - object copy
437 acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
438 union acpi_operand_object *target_desc);
441 acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
442 union acpi_operand_object *target_desc);
445 acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
446 struct acpi_namespace_node *node);
449 acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
450 union acpi_operand_object *target_desc);
453 * exutils - interpreter/scanner utilities
455 void acpi_ex_enter_interpreter(void);
457 void acpi_ex_exit_interpreter(void);
459 void acpi_ex_reacquire_interpreter(void);
461 void acpi_ex_relinquish_interpreter(void);
463 void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
465 void acpi_ex_acquire_global_lock(u32 rule);
467 void acpi_ex_release_global_lock(u32 rule);
469 void acpi_ex_eisa_id_to_string(u32 numeric_id, char *out_string);
471 void acpi_ex_unsigned_integer_to_string(acpi_integer value, char *out_string);
474 * exregion - default op_region handlers
477 acpi_ex_system_memory_space_handler(u32 function,
478 acpi_physical_address address,
480 acpi_integer * value,
481 void *handler_context,
482 void *region_context);
485 acpi_ex_system_io_space_handler(u32 function,
486 acpi_physical_address address,
488 acpi_integer * value,
489 void *handler_context, void *region_context);
492 acpi_ex_pci_config_space_handler(u32 function,
493 acpi_physical_address address,
495 acpi_integer * value,
496 void *handler_context, void *region_context);
499 acpi_ex_cmos_space_handler(u32 function,
500 acpi_physical_address address,
502 acpi_integer * value,
503 void *handler_context, void *region_context);
506 acpi_ex_pci_bar_space_handler(u32 function,
507 acpi_physical_address address,
509 acpi_integer * value,
510 void *handler_context, void *region_context);
513 acpi_ex_embedded_controller_space_handler(u32 function,
514 acpi_physical_address address,
516 acpi_integer * value,
517 void *handler_context,
518 void *region_context);
521 acpi_ex_sm_bus_space_handler(u32 function,
522 acpi_physical_address address,
524 acpi_integer * value,
525 void *handler_context, void *region_context);
528 acpi_ex_data_table_space_handler(u32 function,
529 acpi_physical_address address,
531 acpi_integer * value,
532 void *handler_context, void *region_context);
534 #endif /* __INTERP_H__ */