Merge remote-tracking branch 'moduleh/module.h-split'
[linux-2.6/next.git] / drivers / acpi / acpica / acinterp.h
blob3731e1c34b83b5d75ab25f08d0eefb706d7f85bc
1 /******************************************************************************
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * All rights reserved.
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.
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.
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.
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))
64 #pragma pack(1)
65 #endif
67 typedef const struct acpi_exdump_info {
68 u8 opcode;
69 u8 offset;
70 char *name;
72 } 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 */
93 #pragma pack()
96 * exconvrt - object conversion
98 acpi_status
99 acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
100 union acpi_operand_object **result_desc, u32 flags);
102 acpi_status
103 acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
104 union acpi_operand_object **result_desc);
106 acpi_status
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
117 acpi_status
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 * exdebug - AML debug object
126 void
127 acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
128 u32 level, u32 index);
131 * exfield - ACPI AML (p-code) execution - field manipulation
133 acpi_status
134 acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
135 u32 buffer_length, u32 * datum_count);
137 acpi_status
138 acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
139 u64 mask,
140 u64 field_value, u32 field_datum_byte_offset);
142 void
143 acpi_ex_get_buffer_datum(u64 *datum,
144 void *buffer,
145 u32 buffer_length,
146 u32 byte_granularity, u32 buffer_offset);
148 void
149 acpi_ex_set_buffer_datum(u64 merged_datum,
150 void *buffer,
151 u32 buffer_length,
152 u32 byte_granularity, u32 buffer_offset);
154 acpi_status
155 acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
156 union acpi_operand_object *obj_desc,
157 union acpi_operand_object **ret_buffer_desc);
159 acpi_status
160 acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
161 union acpi_operand_object *obj_desc,
162 union acpi_operand_object **result_desc);
165 * exfldio - low level field I/O
167 acpi_status
168 acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
169 void *buffer, u32 buffer_length);
171 acpi_status
172 acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
173 void *buffer, u32 buffer_length);
175 acpi_status
176 acpi_ex_access_region(union acpi_operand_object *obj_desc,
177 u32 field_datum_byte_offset, u64 *value, u32 read_write);
180 * exmisc - misc support routines
182 acpi_status
183 acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
184 union acpi_operand_object **return_desc,
185 struct acpi_walk_state *walk_state);
187 acpi_status
188 acpi_ex_concat_template(union acpi_operand_object *obj_desc,
189 union acpi_operand_object *obj_desc2,
190 union acpi_operand_object **actual_return_desc,
191 struct acpi_walk_state *walk_state);
193 acpi_status
194 acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
195 union acpi_operand_object *obj_desc2,
196 union acpi_operand_object **actual_return_desc,
197 struct acpi_walk_state *walk_state);
199 acpi_status
200 acpi_ex_do_logical_numeric_op(u16 opcode,
201 u64 integer0, u64 integer1, u8 *logical_result);
203 acpi_status
204 acpi_ex_do_logical_op(u16 opcode,
205 union acpi_operand_object *operand0,
206 union acpi_operand_object *operand1, u8 *logical_result);
208 u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 operand1);
210 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
212 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
214 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
216 acpi_status
217 acpi_ex_create_region(u8 * aml_start,
218 u32 aml_length,
219 u8 region_space, struct acpi_walk_state *walk_state);
221 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
223 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
225 acpi_status
226 acpi_ex_create_method(u8 * aml_start,
227 u32 aml_length, struct acpi_walk_state *walk_state);
230 * exconfig - dynamic table load/unload
232 acpi_status
233 acpi_ex_load_op(union acpi_operand_object *obj_desc,
234 union acpi_operand_object *target,
235 struct acpi_walk_state *walk_state);
237 acpi_status
238 acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
239 union acpi_operand_object **return_desc);
241 acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
244 * exmutex - mutex support
246 acpi_status
247 acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
248 union acpi_operand_object *obj_desc,
249 struct acpi_walk_state *walk_state);
251 acpi_status
252 acpi_ex_acquire_mutex_object(u16 timeout,
253 union acpi_operand_object *obj_desc,
254 acpi_thread_id thread_id);
256 acpi_status
257 acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
258 struct acpi_walk_state *walk_state);
260 acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
262 void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
264 void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
267 * exprep - ACPI AML execution - prep utilities
269 acpi_status
270 acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
271 u8 field_flags,
272 u8 field_attribute,
273 u32 field_bit_position, u32 field_bit_length);
275 acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
278 * exsystem - Interface to OS services
280 acpi_status
281 acpi_ex_system_do_notify_op(union acpi_operand_object *value,
282 union acpi_operand_object *obj_desc);
284 acpi_status acpi_ex_system_do_sleep(u64 time);
286 acpi_status acpi_ex_system_do_stall(u32 time);
288 acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
290 acpi_status
291 acpi_ex_system_wait_event(union acpi_operand_object *time,
292 union acpi_operand_object *obj_desc);
294 acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
296 acpi_status
297 acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
299 acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
302 * exoparg1 - ACPI AML execution, 1 operand
304 acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
306 acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
308 acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
310 acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
312 acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
315 * exoparg2 - ACPI AML execution, 2 operands
317 acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
319 acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
321 acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
323 acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
326 * exoparg3 - ACPI AML execution, 3 operands
328 acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
330 acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
333 * exoparg6 - ACPI AML execution, 6 operands
335 acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
338 * exresolv - Object resolution and get value functions
340 acpi_status
341 acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
342 struct acpi_walk_state *walk_state);
344 acpi_status
345 acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
346 union acpi_operand_object *operand,
347 acpi_object_type * return_type,
348 union acpi_operand_object **return_desc);
351 * exresnte - resolve namespace node
353 acpi_status
354 acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
355 struct acpi_walk_state *walk_state);
358 * exresop - resolve operand to value
360 acpi_status
361 acpi_ex_resolve_operands(u16 opcode,
362 union acpi_operand_object **stack_ptr,
363 struct acpi_walk_state *walk_state);
366 * exdump - Interpreter debug output routines
368 void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
370 void
371 acpi_ex_dump_operands(union acpi_operand_object **operands,
372 const char *opcode_name, u32 num_opcodes);
374 #ifdef ACPI_FUTURE_USAGE
375 void
376 acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
378 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
379 #endif /* ACPI_FUTURE_USAGE */
382 * exnames - AML namestring support
384 acpi_status
385 acpi_ex_get_name_string(acpi_object_type data_type,
386 u8 * in_aml_address,
387 char **out_name_string, u32 * out_name_length);
390 * exstore - Object store support
392 acpi_status
393 acpi_ex_store(union acpi_operand_object *val_desc,
394 union acpi_operand_object *dest_desc,
395 struct acpi_walk_state *walk_state);
397 acpi_status
398 acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
399 struct acpi_namespace_node *node,
400 struct acpi_walk_state *walk_state,
401 u8 implicit_conversion);
403 #define ACPI_IMPLICIT_CONVERSION TRUE
404 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
407 * exstoren - resolve/store object
409 acpi_status
410 acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
411 acpi_object_type target_type,
412 struct acpi_walk_state *walk_state);
414 acpi_status
415 acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
416 union acpi_operand_object *dest_desc,
417 union acpi_operand_object **new_desc,
418 struct acpi_walk_state *walk_state);
421 * exstorob - store object - buffer/string
423 acpi_status
424 acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
425 union acpi_operand_object *target_desc);
427 acpi_status
428 acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
429 union acpi_operand_object *target_desc);
432 * excopy - object copy
434 acpi_status
435 acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
436 union acpi_operand_object *target_desc);
438 acpi_status
439 acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
440 union acpi_operand_object *target_desc);
442 acpi_status
443 acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
444 struct acpi_namespace_node *node);
446 acpi_status
447 acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
448 union acpi_operand_object *target_desc);
451 * exutils - interpreter/scanner utilities
453 void acpi_ex_enter_interpreter(void);
455 void acpi_ex_exit_interpreter(void);
457 void acpi_ex_reacquire_interpreter(void);
459 void acpi_ex_relinquish_interpreter(void);
461 void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
463 void acpi_ex_acquire_global_lock(u32 rule);
465 void acpi_ex_release_global_lock(u32 rule);
467 void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);
469 void acpi_ex_integer_to_string(char *dest, u64 value);
472 * exregion - default op_region handlers
474 acpi_status
475 acpi_ex_system_memory_space_handler(u32 function,
476 acpi_physical_address address,
477 u32 bit_width,
478 u64 *value,
479 void *handler_context,
480 void *region_context);
482 acpi_status
483 acpi_ex_system_io_space_handler(u32 function,
484 acpi_physical_address address,
485 u32 bit_width,
486 u64 *value,
487 void *handler_context, void *region_context);
489 acpi_status
490 acpi_ex_pci_config_space_handler(u32 function,
491 acpi_physical_address address,
492 u32 bit_width,
493 u64 *value,
494 void *handler_context, void *region_context);
496 acpi_status
497 acpi_ex_cmos_space_handler(u32 function,
498 acpi_physical_address address,
499 u32 bit_width,
500 u64 *value,
501 void *handler_context, void *region_context);
503 acpi_status
504 acpi_ex_pci_bar_space_handler(u32 function,
505 acpi_physical_address address,
506 u32 bit_width,
507 u64 *value,
508 void *handler_context, void *region_context);
510 acpi_status
511 acpi_ex_embedded_controller_space_handler(u32 function,
512 acpi_physical_address address,
513 u32 bit_width,
514 u64 *value,
515 void *handler_context,
516 void *region_context);
518 acpi_status
519 acpi_ex_sm_bus_space_handler(u32 function,
520 acpi_physical_address address,
521 u32 bit_width,
522 u64 *value,
523 void *handler_context, void *region_context);
525 acpi_status
526 acpi_ex_data_table_space_handler(u32 function,
527 acpi_physical_address address,
528 u32 bit_width,
529 u64 *value,
530 void *handler_context, void *region_context);
532 #endif /* __INTERP_H__ */