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