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