ACPICA: Utilities: Add formatted printing APIs
[linux-2.6-block.git] / include / acpi / acpixf.h
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
4 *
5 *****************************************************************************/
6
7/*
fbb7a2dc 8 * Copyright (C) 2000 - 2014, 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
1da177e4
LT
44#ifndef __ACXFACE_H__
45#define __ACXFACE_H__
46
50df4d8b
BM
47/* Current ACPICA subsystem version in YYYYMMDD format */
48
bc381eeb 49#define ACPI_CA_VERSION 0x20140424
50df4d8b 50
a1ce3928
DH
51#include <acpi/acconfig.h>
52#include <acpi/actypes.h>
53#include <acpi/actbl.h>
d8dc91b7 54#include <acpi/acbuffer.h>
1da177e4 55
889c78be
LM
56extern u8 acpi_gbl_permanent_mmap;
57
1011080d
BM
58/*****************************************************************************
59 *
60 * Macros used for ACPICA globals and configuration
61 *
62 ****************************************************************************/
63
50df4d8b 64/*
1011080d 65 * Ensure that global variables are defined and initialized only once.
3035ff70 66 *
1011080d
BM
67 * The use of these macros allows for a single list of globals (here)
68 * in order to simplify maintenance of the code.
50df4d8b 69 */
3035ff70
LZ
70#ifdef DEFINE_ACPI_GLOBALS
71#define ACPI_GLOBAL(type,name) \
72 extern type name; \
73 type name
3e8214e5 74
3035ff70
LZ
75#define ACPI_INIT_GLOBAL(type,name,value) \
76 type name=value
3e8214e5 77
3035ff70
LZ
78#else
79#ifndef ACPI_GLOBAL
80#define ACPI_GLOBAL(type,name) \
81 extern type name
82#endif
3e8214e5 83
3035ff70
LZ
84#ifndef ACPI_INIT_GLOBAL
85#define ACPI_INIT_GLOBAL(type,name,value) \
86 extern type name
87#endif
88#endif
50df4d8b 89
33620c54 90/*
1011080d
BM
91 * These macros configure the various ACPICA interfaces. They are
92 * useful for generating stub inline functions for features that are
93 * configured out of the current kernel or ACPICA application.
33620c54 94 */
8b9c1152
LZ
95#ifndef ACPI_EXTERNAL_RETURN_STATUS
96#define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
33620c54 97 prototype;
8b9c1152 98#endif
33620c54 99
8b9c1152
LZ
100#ifndef ACPI_EXTERNAL_RETURN_OK
101#define ACPI_EXTERNAL_RETURN_OK(prototype) \
33620c54 102 prototype;
8b9c1152 103#endif
33620c54 104
8b9c1152
LZ
105#ifndef ACPI_EXTERNAL_RETURN_VOID
106#define ACPI_EXTERNAL_RETURN_VOID(prototype) \
33620c54 107 prototype;
8b9c1152 108#endif
33620c54 109
8b9c1152
LZ
110#ifndef ACPI_EXTERNAL_RETURN_UINT32
111#define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
112 prototype;
113#endif
33620c54 114
8b9c1152
LZ
115#ifndef ACPI_EXTERNAL_RETURN_PTR
116#define ACPI_EXTERNAL_RETURN_PTR(prototype) \
117 prototype;
118#endif
33620c54 119
3035ff70
LZ
120/*****************************************************************************
121 *
1011080d 122 * Public globals and runtime configuration options
3035ff70
LZ
123 *
124 ****************************************************************************/
33620c54 125
44f6c012 126/*
1011080d 127 * Enable "slack mode" of the AML interpreter? Default is FALSE, and the
3035ff70
LZ
128 * interpreter strictly follows the ACPI specification. Setting to TRUE
129 * allows the interpreter to ignore certain errors and/or bad AML constructs.
130 *
131 * Currently, these features are enabled by this flag:
132 *
133 * 1) Allow "implicit return" of last value in a control method
134 * 2) Allow access beyond the end of an operation region
135 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
136 * 4) Allow ANY object type to be a source operand for the Store() operator
137 * 5) Allow unresolved references (invalid target name) in package objects
138 * 6) Enable warning messages for behavior that is not ACPI spec compliant
1da177e4 139 */
3035ff70 140ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_interpreter_slack, FALSE);
1da177e4 141
3035ff70
LZ
142/*
143 * Automatically serialize all methods that create named objects? Default
144 * is TRUE, meaning that all non_serialized methods are scanned once at
145 * table load time to determine those that create named objects. Methods
146 * that create named objects are marked Serialized in order to prevent
147 * possible run-time problems if they are entered by more than one thread.
148 */
149ACPI_INIT_GLOBAL(u8, acpi_gbl_auto_serialize_methods, TRUE);
1da177e4 150
75c8044f 151/*
3035ff70
LZ
152 * Create the predefined _OSI method in the namespace? Default is TRUE
153 * because ACPICA is fully compatible with other ACPI implementations.
154 * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
75c8044f 155 */
3035ff70 156ACPI_INIT_GLOBAL(u8, acpi_gbl_create_osi_method, TRUE);
1da177e4 157
3035ff70
LZ
158/*
159 * Optionally use default values for the ACPI register widths. Set this to
160 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
161 */
162ACPI_INIT_GLOBAL(u8, acpi_gbl_use_default_register_widths, TRUE);
1da177e4 163
47d68c7f
LZ
164/*
165 * Whether or not to verify the table checksum before installation. Set
166 * this to TRUE to verify the table checksum before install it to the table
167 * manager. Note that enabling this option causes errors to happen in some
168 * OSPMs during early initialization stages. Default behavior is to do such
169 * verification.
170 */
171ACPI_INIT_GLOBAL(u8, acpi_gbl_verify_table_checksum, TRUE);
172
3035ff70
LZ
173/*
174 * Optionally enable output from the AML Debug Object.
175 */
176ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_aml_debug_object, FALSE);
9187a415 177
3035ff70
LZ
178/*
179 * Optionally copy the entire DSDT to local memory (instead of simply
180 * mapping it.) There are some BIOSs that corrupt or replace the original
181 * DSDT, creating the need for this option. Default is FALSE, do not copy
182 * the DSDT.
183 */
184ACPI_INIT_GLOBAL(u8, acpi_gbl_copy_dsdt_locally, FALSE);
1da177e4 185
3035ff70
LZ
186/*
187 * Optionally ignore an XSDT if present and use the RSDT instead.
188 * Although the ACPI specification requires that an XSDT be used instead
189 * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
190 * some machines. Default behavior is to use the XSDT if present.
191 */
192ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
1da177e4 193
3035ff70
LZ
194/*
195 * Optionally use 32-bit FADT addresses if and when there is a conflict
196 * (address mismatch) between the 32-bit and 64-bit versions of the
197 * address. Although ACPICA adheres to the ACPI specification which
198 * requires the use of the corresponding 64-bit address if it is non-zero,
199 * some machines have been found to have a corrupted non-zero 64-bit
c9b77a40 200 * address. Default is TRUE, favor the 32-bit addresses.
3035ff70 201 */
c9b77a40 202ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, TRUE);
b0ed7a91 203
3035ff70
LZ
204/*
205 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
206 * with other ACPI implementations. NOTE: During ACPICA initialization,
207 * this value is set to TRUE if any Windows OSI strings have been
208 * requested by the BIOS.
209 */
210ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
b0ed7a91 211
3035ff70
LZ
212/*
213 * Disable runtime checking and repair of values returned by control methods.
214 * Use only if the repair is causing a problem on a particular machine.
215 */
216ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
2cf9f5bc 217
3035ff70
LZ
218/*
219 * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
220 * This can be useful for debugging ACPI problems on some machines.
221 */
222ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
f654c0fe 223
3035ff70
LZ
224/*
225 * We keep track of the latest version of Windows that has been requested by
fea79bc0 226 * the BIOS. ACPI 5.0.
3035ff70
LZ
227 */
228ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
be030a57 229
1da177e4 230/*
3a2f3a33
LZ
231 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
232 * that the ACPI hardware is no longer required. A flag in the FADT indicates
233 * a reduced HW machine, and that flag is duplicated here for convenience.
1da177e4 234 */
3a2f3a33 235ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
f3d2e786 236
3a2f3a33
LZ
237/*
238 * This mechanism is used to trace a specified AML method. The method is
239 * traced each time it is executed.
240 */
241ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
242ACPI_INIT_GLOBAL(acpi_name, acpi_gbl_trace_method_name, 0);
1da177e4 243
3a2f3a33
LZ
244/*
245 * Runtime configuration of debug output control masks. We want the debug
246 * switches statically initialized so they are already set when the debugger
247 * is entered.
248 */
249ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
250ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
1da177e4 251
f60d8181 252/*
1011080d 253 * Other miscellaneous globals
f60d8181 254 */
3a2f3a33 255ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
1011080d 256ACPI_GLOBAL(u32, acpi_current_gpe_count);
3a2f3a33 257ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
f60d8181 258
1011080d
BM
259/*****************************************************************************
260 *
261 * ACPICA public interface configuration.
262 *
263 * Interfaces that are configured out of the ACPICA build are replaced
264 * by inlined stubs by default.
265 *
266 ****************************************************************************/
1da177e4 267
33620c54 268/*
1011080d
BM
269 * Hardware-reduced prototypes (default: Not hardware reduced).
270 *
271 * All ACPICA hardware-related interfaces that use these macros will be
272 * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
33620c54 273 * is set to TRUE.
1011080d
BM
274 *
275 * Note: This static build option for reduced hardware is intended to
276 * reduce ACPICA code size if desired or necessary. However, even if this
277 * option is not specified, the runtime behavior of ACPICA is dependent
278 * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
279 * the flag will enable similar behavior -- ACPICA will not attempt
280 * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
33620c54
BM
281 */
282#if (!ACPI_REDUCED_HARDWARE)
283#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
8b9c1152 284 ACPI_EXTERNAL_RETURN_STATUS(prototype)
1da177e4 285
33620c54 286#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
8b9c1152 287 ACPI_EXTERNAL_RETURN_OK(prototype)
1da177e4 288
33620c54 289#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
8b9c1152 290 ACPI_EXTERNAL_RETURN_VOID(prototype)
cd27d79f 291
33620c54
BM
292#else
293#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
294 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
1da177e4 295
33620c54
BM
296#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
297 static ACPI_INLINE prototype {return(AE_OK);}
1da177e4 298
33620c54 299#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
c26f3c90 300 static ACPI_INLINE prototype {return;}
3e08e2d2 301
33620c54 302#endif /* !ACPI_REDUCED_HARDWARE */
3e08e2d2 303
1da177e4 304/*
1011080d
BM
305 * Error message prototypes (default: error messages enabled).
306 *
307 * All interfaces related to error and warning messages
308 * will be configured out of the ACPICA build if the
309 * ACPI_NO_ERROR_MESSAGE flag is defined.
1da177e4 310 */
407e22af
LZ
311#ifndef ACPI_NO_ERROR_MESSAGES
312#define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
313 prototype;
1da177e4 314
407e22af
LZ
315#else
316#define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
317 static ACPI_INLINE prototype {return;}
1da177e4 318
407e22af 319#endif /* ACPI_NO_ERROR_MESSAGES */
1da177e4 320
1ce28c32 321/*
1011080d
BM
322 * Debugging output prototypes (default: no debug output).
323 *
324 * All interfaces related to debug output messages
325 * will be configured out of the ACPICA build unless the
326 * ACPI_DEBUG_OUTPUT flag is defined.
1ce28c32
LZ
327 */
328#ifdef ACPI_DEBUG_OUTPUT
329#define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
330 prototype;
1da177e4 331
1ce28c32
LZ
332#else
333#define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
334 static ACPI_INLINE prototype {return;}
1da177e4 335
1ce28c32 336#endif /* ACPI_DEBUG_OUTPUT */
1da177e4 337
1011080d
BM
338/*****************************************************************************
339 *
340 * ACPICA public interface prototypes
341 *
342 ****************************************************************************/
7c2e1771 343
44f6c012 344/*
75c8044f 345 * Initialization
1da177e4 346 */
8b9c1152
LZ
347ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
348 acpi_initialize_tables(struct acpi_table_desc
349 *initial_storage,
350 u32 initial_table_count,
351 u8 allow_resize))
352ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_initialize_subsystem(void))
1da177e4 353
8b9c1152 354ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_enable_subsystem(u32 flags))
1da177e4 355
8b9c1152
LZ
356ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
357 acpi_initialize_objects(u32 flags))
358ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_terminate(void))
50eca3eb 359
1da177e4 360/*
75c8044f 361 * Miscellaneous global interfaces
1da177e4 362 */
33620c54
BM
363ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
364ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
739dcbb9 365#ifdef ACPI_FUTURE_USAGE
8b9c1152 366ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
739dcbb9 367#endif
1da177e4 368
1da177e4 369#ifdef ACPI_FUTURE_USAGE
8b9c1152
LZ
370ACPI_EXTERNAL_RETURN_STATUS(acpi_status
371 acpi_get_system_info(struct acpi_buffer
372 *ret_buffer))
1da177e4 373#endif
8b9c1152
LZ
374ACPI_EXTERNAL_RETURN_STATUS(acpi_status
375 acpi_get_statistics(struct acpi_statistics *stats))
376ACPI_EXTERNAL_RETURN_PTR(const char
377 *acpi_format_exception(acpi_status exception))
378ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
379
380ACPI_EXTERNAL_RETURN_STATUS(acpi_status
381 acpi_install_interface(acpi_string interface_name))
382
383ACPI_EXTERNAL_RETURN_STATUS(acpi_status
384 acpi_remove_interface(acpi_string interface_name))
385ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
386
387ACPI_EXTERNAL_RETURN_UINT32(u32
388 acpi_check_address_range(acpi_adr_space_type
389 space_id,
390 acpi_physical_address
391 address, acpi_size length,
392 u8 warn))
393ACPI_EXTERNAL_RETURN_STATUS(acpi_status
394 acpi_decode_pld_buffer(u8 *in_buffer,
395 acpi_size length,
396 struct acpi_pld_info
397 **return_buffer))
1da177e4 398
1da177e4 399/*
f60d8181 400 * ACPI table load/unload interfaces
1da177e4 401 */
8b9c1152
LZ
402ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
403 acpi_install_table(acpi_physical_address address,
404 u8 physical))
1da177e4 405
8b9c1152
LZ
406ACPI_EXTERNAL_RETURN_STATUS(acpi_status
407 acpi_load_table(struct acpi_table_header *table))
b2f7ddcf 408
8b9c1152
LZ
409ACPI_EXTERNAL_RETURN_STATUS(acpi_status
410 acpi_unload_parent_table(acpi_handle object))
411ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_load_tables(void))
1da177e4 412
f60d8181
BM
413/*
414 * ACPI table manipulation interfaces
415 */
8b9c1152
LZ
416ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_reallocate_root_table(void))
417
418ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
419 acpi_find_root_pointer(acpi_size * rsdp_address))
420
421ACPI_EXTERNAL_RETURN_STATUS(acpi_status
422 acpi_get_table_header(acpi_string signature,
423 u32 instance,
424 struct acpi_table_header
425 *out_table_header))
426ACPI_EXTERNAL_RETURN_STATUS(acpi_status
427 acpi_get_table(acpi_string signature, u32 instance,
428 struct acpi_table_header
429 **out_table))
430ACPI_EXTERNAL_RETURN_STATUS(acpi_status
431 acpi_get_table_by_index(u32 table_index,
432 struct acpi_table_header
433 **out_table))
434ACPI_EXTERNAL_RETURN_STATUS(acpi_status
435 acpi_install_table_handler(acpi_table_handler
436 handler, void *context))
437ACPI_EXTERNAL_RETURN_STATUS(acpi_status
438 acpi_remove_table_handler(acpi_table_handler
439 handler))
1da177e4 440
1da177e4
LT
441/*
442 * Namespace and name interfaces
443 */
8b9c1152
LZ
444ACPI_EXTERNAL_RETURN_STATUS(acpi_status
445 acpi_walk_namespace(acpi_object_type type,
446 acpi_handle start_object,
447 u32 max_depth,
448 acpi_walk_callback
449 descending_callback,
450 acpi_walk_callback
451 ascending_callback,
452 void *context,
453 void **return_value))
454ACPI_EXTERNAL_RETURN_STATUS(acpi_status
455 acpi_get_devices(const char *HID,
456 acpi_walk_callback user_function,
457 void *context,
458 void **return_value))
459ACPI_EXTERNAL_RETURN_STATUS(acpi_status
460 acpi_get_name(acpi_handle object, u32 name_type,
461 struct acpi_buffer *ret_path_ptr))
462ACPI_EXTERNAL_RETURN_STATUS(acpi_status
463 acpi_get_handle(acpi_handle parent,
464 acpi_string pathname,
465 acpi_handle * ret_handle))
466ACPI_EXTERNAL_RETURN_STATUS(acpi_status
467 acpi_attach_data(acpi_handle object,
468 acpi_object_handler handler,
469 void *data))
470ACPI_EXTERNAL_RETURN_STATUS(acpi_status
471 acpi_detach_data(acpi_handle object,
472 acpi_object_handler handler))
473ACPI_EXTERNAL_RETURN_STATUS(acpi_status
474 acpi_get_data(acpi_handle object,
475 acpi_object_handler handler,
476 void **data))
477ACPI_EXTERNAL_RETURN_STATUS(acpi_status
478 acpi_debug_trace(char *name, u32 debug_level,
479 u32 debug_layer, u32 flags))
0f0fe1a0 480
1da177e4
LT
481/*
482 * Object manipulation and enumeration
483 */
8b9c1152
LZ
484ACPI_EXTERNAL_RETURN_STATUS(acpi_status
485 acpi_evaluate_object(acpi_handle object,
486 acpi_string pathname,
487 struct acpi_object_list
488 *parameter_objects,
489 struct acpi_buffer
490 *return_object_buffer))
491ACPI_EXTERNAL_RETURN_STATUS(acpi_status
492 acpi_evaluate_object_typed(acpi_handle object,
493 acpi_string pathname,
494 struct acpi_object_list
495 *external_params,
496 struct acpi_buffer
497 *return_buffer,
498 acpi_object_type
499 return_type))
500ACPI_EXTERNAL_RETURN_STATUS(acpi_status
501 acpi_get_object_info(acpi_handle object,
502 struct acpi_device_info
503 **return_buffer))
504ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
505
506ACPI_EXTERNAL_RETURN_STATUS(acpi_status
507 acpi_get_next_object(acpi_object_type type,
508 acpi_handle parent,
509 acpi_handle child,
510 acpi_handle * out_handle))
511
512ACPI_EXTERNAL_RETURN_STATUS(acpi_status
513 acpi_get_type(acpi_handle object,
514 acpi_object_type * out_type))
515
516ACPI_EXTERNAL_RETURN_STATUS(acpi_status
517 acpi_get_parent(acpi_handle object,
518 acpi_handle * out_handle))
1da177e4
LT
519
520/*
ecfbbc7b 521 * Handler interfaces
1da177e4 522 */
8b9c1152
LZ
523ACPI_EXTERNAL_RETURN_STATUS(acpi_status
524 acpi_install_initialization_handler
525 (acpi_init_handler handler, u32 function))
33620c54 526ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
8b9c1152
LZ
527 acpi_install_sci_handler(acpi_sci_handler
528 address,
529 void *context))
a2fd4b4b
LZ
530ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
531 acpi_remove_sci_handler(acpi_sci_handler
532 address))
533ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
534 acpi_install_global_event_handler
535 (acpi_gbl_event_handler handler,
536 void *context))
33620c54
BM
537ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
538 acpi_install_fixed_event_handler(u32
539 acpi_event,
540 acpi_event_handler
541 handler,
542 void
543 *context))
544ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
545 acpi_remove_fixed_event_handler(u32 acpi_event,
546 acpi_event_handler
547 handler))
548ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
549 acpi_install_gpe_handler(acpi_handle
550 gpe_device,
551 u32 gpe_number,
552 u32 type,
553 acpi_gpe_handler
554 address,
555 void *context))
556ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
557 acpi_remove_gpe_handler(acpi_handle gpe_device,
558 u32 gpe_number,
559 acpi_gpe_handler
560 address))
8b9c1152
LZ
561ACPI_EXTERNAL_RETURN_STATUS(acpi_status
562 acpi_install_notify_handler(acpi_handle device,
563 u32 handler_type,
564 acpi_notify_handler
565 handler,
566 void *context))
567ACPI_EXTERNAL_RETURN_STATUS(acpi_status
568 acpi_remove_notify_handler(acpi_handle device,
569 u32 handler_type,
570 acpi_notify_handler
571 handler))
572ACPI_EXTERNAL_RETURN_STATUS(acpi_status
573 acpi_install_address_space_handler(acpi_handle
574 device,
575 acpi_adr_space_type
576 space_id,
577 acpi_adr_space_handler
578 handler,
579 acpi_adr_space_setup
580 setup,
581 void *context))
582ACPI_EXTERNAL_RETURN_STATUS(acpi_status
583 acpi_remove_address_space_handler(acpi_handle
584 device,
585 acpi_adr_space_type
586 space_id,
587 acpi_adr_space_handler
588 handler))
1da177e4 589#ifdef ACPI_FUTURE_USAGE
8b9c1152
LZ
590ACPI_EXTERNAL_RETURN_STATUS(acpi_status
591 acpi_install_exception_handler
592 (acpi_exception_handler handler))
1da177e4 593#endif
8b9c1152
LZ
594ACPI_EXTERNAL_RETURN_STATUS(acpi_status
595 acpi_install_interface_handler
596 (acpi_interface_handler handler))
b0ed7a91 597
1da177e4 598/*
ffef6827 599 * Global Lock interfaces
1da177e4 600 */
33620c54
BM
601ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
602 acpi_acquire_global_lock(u16 timeout,
603 u32 *handle))
cd27d79f 604
33620c54
BM
605ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
606 acpi_release_global_lock(u32 handle))
1da177e4 607
ffef6827
LM
608/*
609 * Interfaces to AML mutex objects
610 */
8b9c1152
LZ
611ACPI_EXTERNAL_RETURN_STATUS(acpi_status
612 acpi_acquire_mutex(acpi_handle handle,
613 acpi_string pathname,
614 u16 timeout))
ffef6827 615
8b9c1152
LZ
616ACPI_EXTERNAL_RETURN_STATUS(acpi_status
617 acpi_release_mutex(acpi_handle handle,
618 acpi_string pathname))
ffef6827
LM
619
620/*
621 * Fixed Event interfaces
622 */
33620c54
BM
623ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
624 acpi_enable_event(u32 event, u32 flags))
1da177e4 625
33620c54
BM
626ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
627 acpi_disable_event(u32 event, u32 flags))
33620c54 628ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
1da177e4 629
33620c54
BM
630ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
631 acpi_get_event_status(u32 event,
632 acpi_event_status
633 *event_status))
cd27d79f 634
08ac07b8 635/*
ffef6827 636 * General Purpose Event (GPE) Interfaces
08ac07b8 637 */
33620c54
BM
638ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
639
640ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
641 acpi_enable_gpe(acpi_handle gpe_device,
642 u32 gpe_number))
643
644ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
645 acpi_disable_gpe(acpi_handle gpe_device,
646 u32 gpe_number))
647
648ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
649 acpi_clear_gpe(acpi_handle gpe_device,
650 u32 gpe_number))
651
652ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
653 acpi_set_gpe(acpi_handle gpe_device,
654 u32 gpe_number, u8 action))
655
656ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
657 acpi_finish_gpe(acpi_handle gpe_device,
658 u32 gpe_number))
659
660ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
661 acpi_setup_gpe_for_wake(acpi_handle
662 parent_device,
663 acpi_handle gpe_device,
664 u32 gpe_number))
665ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
666 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
667 u32 gpe_number,
668 u8 action))
669ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
670 acpi_get_gpe_status(acpi_handle gpe_device,
671 u32 gpe_number,
672 acpi_event_status
673 *event_status))
33620c54 674ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
33620c54
BM
675ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
676
677ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
678 acpi_get_gpe_device(u32 gpe_index,
679 acpi_handle * gpe_device))
680
681ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
682 acpi_install_gpe_block(acpi_handle gpe_device,
683 struct
684 acpi_generic_address
685 *gpe_block_address,
686 u32 register_count,
687 u32 interrupt_number))
688ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
689 acpi_remove_gpe_block(acpi_handle gpe_device))
a2100801 690
1da177e4
LT
691/*
692 * Resource interfaces
693 */
1da177e4 694typedef
61686124 695acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
4be44fcd 696 void *context);
1da177e4 697
8b9c1152
LZ
698ACPI_EXTERNAL_RETURN_STATUS(acpi_status
699 acpi_get_vendor_resource(acpi_handle device,
700 char *name,
701 struct acpi_vendor_uuid
702 *uuid,
703 struct acpi_buffer
704 *ret_buffer))
705ACPI_EXTERNAL_RETURN_STATUS(acpi_status
706 acpi_get_current_resources(acpi_handle device,
707 struct acpi_buffer
708 *ret_buffer))
1da177e4 709#ifdef ACPI_FUTURE_USAGE
8b9c1152
LZ
710ACPI_EXTERNAL_RETURN_STATUS(acpi_status
711 acpi_get_possible_resources(acpi_handle device,
712 struct acpi_buffer
713 *ret_buffer))
1da177e4 714#endif
8b9c1152
LZ
715ACPI_EXTERNAL_RETURN_STATUS(acpi_status
716 acpi_get_event_resources(acpi_handle device_handle,
717 struct acpi_buffer
718 *ret_buffer))
719ACPI_EXTERNAL_RETURN_STATUS(acpi_status
720 acpi_walk_resource_buffer(struct acpi_buffer
721 *buffer,
722 acpi_walk_resource_callback
723 user_function,
724 void *context))
725ACPI_EXTERNAL_RETURN_STATUS(acpi_status
726 acpi_walk_resources(acpi_handle device, char *name,
727 acpi_walk_resource_callback
728 user_function, void *context))
729ACPI_EXTERNAL_RETURN_STATUS(acpi_status
730 acpi_set_current_resources(acpi_handle device,
731 struct acpi_buffer
732 *in_buffer))
733ACPI_EXTERNAL_RETURN_STATUS(acpi_status
734 acpi_get_irq_routing_table(acpi_handle device,
735 struct acpi_buffer
736 *ret_buffer))
737ACPI_EXTERNAL_RETURN_STATUS(acpi_status
738 acpi_resource_to_address64(struct acpi_resource
739 *resource,
740 struct
741 acpi_resource_address64
742 *out))
743ACPI_EXTERNAL_RETURN_STATUS(acpi_status
744 acpi_buffer_to_resource(u8 *aml_buffer,
745 u16 aml_buffer_length,
746 struct acpi_resource
747 **resource_ptr))
0e243178 748
1da177e4
LT
749/*
750 * Hardware (ACPI device) interfaces
751 */
8b9c1152 752ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
d3fd902d 753
8b9c1152
LZ
754ACPI_EXTERNAL_RETURN_STATUS(acpi_status
755 acpi_read(u64 *value,
756 struct acpi_generic_address *reg))
739dcbb9 757
8b9c1152
LZ
758ACPI_EXTERNAL_RETURN_STATUS(acpi_status
759 acpi_write(u64 value,
760 struct acpi_generic_address *reg))
739dcbb9 761
33620c54
BM
762ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
763 acpi_read_bit_register(u32 register_id,
764 u32 *return_value))
1da177e4 765
33620c54
BM
766ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
767 acpi_write_bit_register(u32 register_id,
768 u32 value))
1da177e4 769
33620c54
BM
770/*
771 * Sleep/Wake interfaces
772 */
8b9c1152
LZ
773ACPI_EXTERNAL_RETURN_STATUS(acpi_status
774 acpi_get_sleep_type_data(u8 sleep_state,
775 u8 *slp_typ_a,
776 u8 *slp_typ_b))
1da177e4 777
8b9c1152
LZ
778ACPI_EXTERNAL_RETURN_STATUS(acpi_status
779 acpi_enter_sleep_state_prep(u8 sleep_state))
780ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
1da177e4 781
40bce100 782ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
1da177e4 783
8b9c1152
LZ
784ACPI_EXTERNAL_RETURN_STATUS(acpi_status
785 acpi_leave_sleep_state_prep(u8 sleep_state))
786ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
1da177e4 787
739dcbb9
LZ
788ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
789 acpi_set_firmware_waking_vector(u32
790 physical_address))
739dcbb9
LZ
791#if ACPI_MACHINE_WIDTH == 64
792ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
793 acpi_set_firmware_waking_vector64(u64
794 physical_address))
795#endif
d08310fe
BM
796/*
797 * ACPI Timer interfaces
798 */
799#ifdef ACPI_FUTURE_USAGE
33620c54
BM
800ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
801 acpi_get_timer_resolution(u32 *resolution))
33620c54 802ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
d08310fe 803
33620c54
BM
804ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
805 acpi_get_timer_duration(u32 start_ticks,
806 u32 end_ticks,
807 u32 *time_elapsed))
d08310fe
BM
808#endif /* ACPI_FUTURE_USAGE */
809
50df4d8b 810/*
b74be611 811 * Error/Warning output
50df4d8b 812 */
407e22af
LZ
813ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
814 void ACPI_INTERNAL_VAR_XFACE
815 acpi_error(const char *module_name,
816 u32 line_number,
817 const char *format, ...))
818ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
819 void ACPI_INTERNAL_VAR_XFACE
820 acpi_exception(const char *module_name,
821 u32 line_number,
822 acpi_status status,
823 const char *format, ...))
824ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
825 void ACPI_INTERNAL_VAR_XFACE
826 acpi_warning(const char *module_name,
827 u32 line_number,
828 const char *format, ...))
829ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
830 void ACPI_INTERNAL_VAR_XFACE
831 acpi_info(const char *module_name,
832 u32 line_number,
833 const char *format, ...))
834ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
835 void ACPI_INTERNAL_VAR_XFACE
836 acpi_bios_error(const char *module_name,
837 u32 line_number,
838 const char *format, ...))
839ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
840 void ACPI_INTERNAL_VAR_XFACE
841 acpi_bios_warning(const char *module_name,
842 u32 line_number,
843 const char *format, ...))
62cdd141 844
b74be611
BM
845/*
846 * Debug output
847 */
1ce28c32
LZ
848ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
849 void ACPI_INTERNAL_VAR_XFACE
850 acpi_debug_print(u32 requested_debug_level,
851 u32 line_number,
852 const char *function_name,
853 const char *module_name,
854 u32 component_id,
855 const char *format, ...))
856ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
857 void ACPI_INTERNAL_VAR_XFACE
858 acpi_debug_print_raw(u32 requested_debug_level,
859 u32 line_number,
860 const char *function_name,
861 const char *module_name,
862 u32 component_id,
863 const char *format, ...))
50df4d8b 864
0dedb3c4
LZ
865/*
866 * Divergences
867 */
868acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
869
870acpi_status acpi_unload_table_id(acpi_owner_id id);
871
872acpi_status
873acpi_get_table_with_size(acpi_string signature,
874 u32 instance, struct acpi_table_header **out_table,
875 acpi_size *tbl_size);
876
877acpi_status
878acpi_get_data_full(acpi_handle object, acpi_object_handler handler, void **data,
879 void (*callback)(void *));
50df4d8b 880
4be44fcd 881#endif /* __ACXFACE_H__ */