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