Merge branch 'acpidump' into acpica
[deliverable/linux.git] / drivers / acpi / acpica / acinterp.h
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
77848130 8 * Copyright (C) 2000 - 2012, Intel Corp.
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 122
4cdf1a56
LM
123/*
124 * exdebug - AML debug object
125 */
126void
127acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
128 u32 level, u32 index);
129
1da177e4
LT
130/*
131 * exfield - ACPI AML (p-code) execution - field manipulation
132 */
1da177e4 133acpi_status
4be44fcd
LB
134acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
135 u32 buffer_length, u32 * datum_count);
1da177e4 136
1da177e4 137acpi_status
4be44fcd 138acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
5df7e6cb
BM
139 u64 mask,
140 u64 field_value, u32 field_datum_byte_offset);
1da177e4
LT
141
142void
5df7e6cb 143acpi_ex_get_buffer_datum(u64 *datum,
4be44fcd
LB
144 void *buffer,
145 u32 buffer_length,
146 u32 byte_granularity, u32 buffer_offset);
1da177e4
LT
147
148void
5df7e6cb 149acpi_ex_set_buffer_datum(u64 merged_datum,
4be44fcd
LB
150 void *buffer,
151 u32 buffer_length,
152 u32 byte_granularity, u32 buffer_offset);
1da177e4
LT
153
154acpi_status
4be44fcd
LB
155acpi_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);
1da177e4
LT
158
159acpi_status
4be44fcd
LB
160acpi_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);
44f6c012 163
1da177e4 164/*
44f6c012 165 * exfldio - low level field I/O
1da177e4 166 */
1da177e4 167acpi_status
4be44fcd
LB
168acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
169 void *buffer, u32 buffer_length);
1da177e4
LT
170
171acpi_status
4be44fcd
LB
172acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
173 void *buffer, u32 buffer_length);
1da177e4
LT
174
175acpi_status
4be44fcd 176acpi_ex_access_region(union acpi_operand_object *obj_desc,
5df7e6cb 177 u32 field_datum_byte_offset, u64 *value, u32 read_write);
1da177e4 178
44f6c012
RM
179/*
180 * exmisc - misc support routines
181 */
1da177e4 182acpi_status
4be44fcd
LB
183acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
184 union acpi_operand_object **return_desc,
185 struct acpi_walk_state *walk_state);
1da177e4 186
1da177e4 187acpi_status
4be44fcd
LB
188acpi_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);
1da177e4
LT
192
193acpi_status
4be44fcd
LB
194acpi_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);
1da177e4
LT
198
199acpi_status
4be44fcd 200acpi_ex_do_logical_numeric_op(u16 opcode,
5df7e6cb 201 u64 integer0, u64 integer1, u8 *logical_result);
1da177e4
LT
202
203acpi_status
4be44fcd
LB
204acpi_ex_do_logical_op(u16 opcode,
205 union acpi_operand_object *operand0,
5df7e6cb 206 union acpi_operand_object *operand1, u8 *logical_result);
1da177e4 207
5df7e6cb 208u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 operand1);
1da177e4 209
4be44fcd 210acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
1da177e4 211
4be44fcd 212acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
1da177e4 213
4be44fcd 214acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
1da177e4
LT
215
216acpi_status
4be44fcd
LB
217acpi_ex_create_region(u8 * aml_start,
218 u32 aml_length,
219 u8 region_space, struct acpi_walk_state *walk_state);
1da177e4 220
4be44fcd 221acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
1da177e4 222
4be44fcd 223acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
1da177e4
LT
224
225acpi_status
4be44fcd
LB
226acpi_ex_create_method(u8 * aml_start,
227 u32 aml_length, struct acpi_walk_state *walk_state);
1da177e4
LT
228
229/*
230 * exconfig - dynamic table load/unload
231 */
1da177e4 232acpi_status
4be44fcd
LB
233acpi_ex_load_op(union acpi_operand_object *obj_desc,
234 union acpi_operand_object *target,
235 struct acpi_walk_state *walk_state);
1da177e4
LT
236
237acpi_status
4be44fcd
LB
238acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
239 union acpi_operand_object **return_desc);
1da177e4 240
4be44fcd 241acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
1da177e4
LT
242
243/*
244 * exmutex - mutex support
245 */
1da177e4 246acpi_status
4be44fcd
LB
247acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
248 union acpi_operand_object *obj_desc,
249 struct acpi_walk_state *walk_state);
1da177e4 250
ba886cd4
BM
251acpi_status
252acpi_ex_acquire_mutex_object(u16 timeout,
253 union acpi_operand_object *obj_desc,
254 acpi_thread_id thread_id);
255
1da177e4 256acpi_status
4be44fcd
LB
257acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
258 struct acpi_walk_state *walk_state);
1da177e4 259
ba886cd4
BM
260acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
261
4be44fcd 262void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
1da177e4 263
262a7a28 264void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
1da177e4
LT
265
266/*
44f6c012 267 * exprep - ACPI AML execution - prep utilities
1da177e4 268 */
1da177e4 269acpi_status
4be44fcd
LB
270acpi_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);
1da177e4 274
4be44fcd 275acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
44f6c012 276
1da177e4
LT
277/*
278 * exsystem - Interface to OS services
279 */
1da177e4 280acpi_status
4be44fcd
LB
281acpi_ex_system_do_notify_op(union acpi_operand_object *value,
282 union acpi_operand_object *obj_desc);
1da177e4 283
ada241dc 284acpi_status acpi_ex_system_do_sleep(u64 time);
1da177e4 285
4be44fcd 286acpi_status acpi_ex_system_do_stall(u32 time);
1da177e4 287
4be44fcd 288acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
1da177e4
LT
289
290acpi_status
4be44fcd
LB
291acpi_ex_system_wait_event(union acpi_operand_object *time,
292 union acpi_operand_object *obj_desc);
1da177e4 293
4be44fcd 294acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
1da177e4 295
967440e3
BM
296acpi_status
297acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
298
299acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
1da177e4
LT
300
301/*
44f6c012 302 * exoparg1 - ACPI AML execution, 1 operand
1da177e4 303 */
4be44fcd 304acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4 305
4be44fcd 306acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
1da177e4 307
4be44fcd 308acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4 309
4be44fcd 310acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
1da177e4 311
4be44fcd 312acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
1da177e4
LT
313
314/*
44f6c012 315 * exoparg2 - ACPI AML execution, 2 operands
1da177e4 316 */
4be44fcd 317acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
1da177e4 318
4be44fcd 319acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4 320
4be44fcd 321acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
1da177e4 322
4be44fcd 323acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
1da177e4
LT
324
325/*
44f6c012
RM
326 * exoparg3 - ACPI AML execution, 3 operands
327 */
4be44fcd 328acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
44f6c012 329
4be44fcd 330acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
44f6c012
RM
331
332/*
333 * exoparg6 - ACPI AML execution, 6 operands
1da177e4 334 */
4be44fcd 335acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
1da177e4 336
44f6c012
RM
337/*
338 * exresolv - Object resolution and get value functions
339 */
1da177e4 340acpi_status
4be44fcd
LB
341acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
342 struct acpi_walk_state *walk_state);
1da177e4
LT
343
344acpi_status
4be44fcd
LB
345acpi_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);
44f6c012
RM
349
350/*
351 * exresnte - resolve namespace node
352 */
353acpi_status
4be44fcd
LB
354acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
355 struct acpi_walk_state *walk_state);
44f6c012
RM
356
357/*
358 * exresop - resolve operand to value
359 */
1da177e4 360acpi_status
4be44fcd
LB
361acpi_ex_resolve_operands(u16 opcode,
362 union acpi_operand_object **stack_ptr,
363 struct acpi_walk_state *walk_state);
1da177e4
LT
364
365/*
366 * exdump - Interpreter debug output routines
367 */
4be44fcd 368void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
1da177e4
LT
369
370void
4be44fcd 371acpi_ex_dump_operands(union acpi_operand_object **operands,
71d993e1 372 const char *opcode_name, u32 num_opcodes);
1da177e4 373
44f6c012 374#ifdef ACPI_FUTURE_USAGE
1da177e4 375void
4be44fcd 376acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
1da177e4 377
96db255c 378void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
4be44fcd 379#endif /* ACPI_FUTURE_USAGE */
1da177e4
LT
380
381/*
44f6c012 382 * exnames - AML namestring support
1da177e4 383 */
1da177e4 384acpi_status
4be44fcd
LB
385acpi_ex_get_name_string(acpi_object_type data_type,
386 u8 * in_aml_address,
387 char **out_name_string, u32 * out_name_length);
1da177e4
LT
388
389/*
390 * exstore - Object store support
391 */
1da177e4 392acpi_status
4be44fcd
LB
393acpi_ex_store(union acpi_operand_object *val_desc,
394 union acpi_operand_object *dest_desc,
395 struct acpi_walk_state *walk_state);
1da177e4 396
1da177e4 397acpi_status
4be44fcd
LB
398acpi_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);
1da177e4
LT
402
403#define ACPI_IMPLICIT_CONVERSION TRUE
404#define ACPI_NO_IMPLICIT_CONVERSION FALSE
405
406/*
44f6c012 407 * exstoren - resolve/store object
1da177e4 408 */
1da177e4 409acpi_status
4be44fcd
LB
410acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
411 acpi_object_type target_type,
412 struct acpi_walk_state *walk_state);
1da177e4
LT
413
414acpi_status
4be44fcd
LB
415acpi_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);
1da177e4
LT
419
420/*
44f6c012 421 * exstorob - store object - buffer/string
1da177e4 422 */
1da177e4 423acpi_status
4be44fcd
LB
424acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
425 union acpi_operand_object *target_desc);
1da177e4
LT
426
427acpi_status
4be44fcd
LB
428acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
429 union acpi_operand_object *target_desc);
44f6c012
RM
430
431/*
432 * excopy - object copy
433 */
1da177e4 434acpi_status
4be44fcd
LB
435acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
436 union acpi_operand_object *target_desc);
1da177e4
LT
437
438acpi_status
4be44fcd
LB
439acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
440 union acpi_operand_object *target_desc);
1da177e4
LT
441
442acpi_status
4be44fcd
LB
443acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
444 struct acpi_namespace_node *node);
1da177e4
LT
445
446acpi_status
4be44fcd
LB
447acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
448 union acpi_operand_object *target_desc);
44f6c012 449
1da177e4
LT
450/*
451 * exutils - interpreter/scanner utilities
452 */
4d2acd9e 453void acpi_ex_enter_interpreter(void);
1da177e4 454
4be44fcd 455void acpi_ex_exit_interpreter(void);
1da177e4 456
4d2acd9e
LB
457void acpi_ex_reacquire_interpreter(void);
458
459void acpi_ex_relinquish_interpreter(void);
460
4be44fcd 461void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
1da177e4 462
ba886cd4 463void acpi_ex_acquire_global_lock(u32 rule);
1da177e4 464
f02e9fa1 465void acpi_ex_release_global_lock(u32 rule);
1da177e4 466
5df7e6cb 467void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);
1da177e4 468
5df7e6cb 469void acpi_ex_integer_to_string(char *dest, u64 value);
1da177e4 470
ec463666
BM
471u8 acpi_is_valid_space_id(u8 space_id);
472
1da177e4
LT
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,
5df7e6cb 480 u64 *value,
4be44fcd
LB
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,
5df7e6cb 488 u64 *value,
4be44fcd
LB
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,
5df7e6cb 495 u64 *value,
4be44fcd
LB
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,
5df7e6cb 502 u64 *value,
4be44fcd
LB
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,
5df7e6cb 509 u64 *value,
4be44fcd
LB
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,
5df7e6cb 516 u64 *value,
4be44fcd
LB
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,
5df7e6cb 524 u64 *value,
4be44fcd
LB
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,
5df7e6cb 531 u64 *value,
4be44fcd
LB
532 void *handler_context, void *region_context);
533
534#endif /* __INTERP_H__ */
This page took 0.575596 seconds and 5 git commands to generate.