blob: 923775a5e9e9ce85975014a6410654c339b687e2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
4 *
5 *****************************************************************************/
6
7/*
Bob Moorefbb7a2d2014-02-08 09:42:25 +08008 * Copyright (C) 2000 - 2014, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifndef __ACXFACE_H__
45#define __ACXFACE_H__
46
Bob Moore50df4d82008-12-31 03:01:23 +080047/* Current ACPICA subsystem version in YYYYMMDD format */
48
Bob Moore35476c72014-04-04 12:40:16 +080049#define ACPI_CA_VERSION 0x20140325
Bob Moore50df4d82008-12-31 03:01:23 +080050
David Howellsa1ce3922012-10-02 18:01:25 +010051#include <acpi/acconfig.h>
52#include <acpi/actypes.h>
53#include <acpi/actbl.h>
Linus Torvaldsd8dc91b2012-10-08 07:14:06 +090054#include <acpi/acbuffer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Lin Ming889c78b2008-12-31 09:23:57 +080056extern u8 acpi_gbl_permanent_mmap;
57
Robert Moore44f6c012005-04-18 22:49:35 -040058/*
Lv Zheng3035ff72014-04-30 10:03:52 +080059 * Ensure that the globals are actually defined and initialized only once.
60 *
61 * The use of these macros allows a single list of globals (here) in order
62 * to simplify maintenance of the code.
63 */
64#ifdef DEFINE_ACPI_GLOBALS
65#define ACPI_GLOBAL(type,name) \
66 extern type name; \
67 type name
68
69#define ACPI_INIT_GLOBAL(type,name,value) \
70 type name=value
71
72#else
73#ifndef ACPI_GLOBAL
74#define ACPI_GLOBAL(type,name) \
75 extern type name
76#endif
77
78#ifndef ACPI_INIT_GLOBAL
79#define ACPI_INIT_GLOBAL(type,name,value) \
80 extern type name
81#endif
82#endif
83
84/* Public globals, available from outside ACPICA subsystem */
85
86/*****************************************************************************
87 *
88 * Runtime configuration (static defaults that can be overriden at runtime)
89 *
90 ****************************************************************************/
91
92/*
93 * Enable "slack" in the AML interpreter? Default is FALSE, and the
94 * interpreter strictly follows the ACPI specification. Setting to TRUE
95 * allows the interpreter to ignore certain errors and/or bad AML constructs.
96 *
97 * Currently, these features are enabled by this flag:
98 *
99 * 1) Allow "implicit return" of last value in a control method
100 * 2) Allow access beyond the end of an operation region
101 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
102 * 4) Allow ANY object type to be a source operand for the Store() operator
103 * 5) Allow unresolved references (invalid target name) in package objects
104 * 6) Enable warning messages for behavior that is not ACPI spec compliant
105 */
106ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_interpreter_slack, FALSE);
107
108/*
109 * Automatically serialize all methods that create named objects? Default
110 * is TRUE, meaning that all non_serialized methods are scanned once at
111 * table load time to determine those that create named objects. Methods
112 * that create named objects are marked Serialized in order to prevent
113 * possible run-time problems if they are entered by more than one thread.
114 */
115ACPI_INIT_GLOBAL(u8, acpi_gbl_auto_serialize_methods, TRUE);
116
117/*
118 * Create the predefined _OSI method in the namespace? Default is TRUE
119 * because ACPICA is fully compatible with other ACPI implementations.
120 * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
121 */
122ACPI_INIT_GLOBAL(u8, acpi_gbl_create_osi_method, TRUE);
123
124/*
125 * Optionally use default values for the ACPI register widths. Set this to
126 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
127 */
128ACPI_INIT_GLOBAL(u8, acpi_gbl_use_default_register_widths, TRUE);
129
130/*
131 * Optionally enable output from the AML Debug Object.
132 */
133ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_aml_debug_object, FALSE);
134
135/*
136 * Optionally copy the entire DSDT to local memory (instead of simply
137 * mapping it.) There are some BIOSs that corrupt or replace the original
138 * DSDT, creating the need for this option. Default is FALSE, do not copy
139 * the DSDT.
140 */
141ACPI_INIT_GLOBAL(u8, acpi_gbl_copy_dsdt_locally, FALSE);
142
143/*
144 * Optionally ignore an XSDT if present and use the RSDT instead.
145 * Although the ACPI specification requires that an XSDT be used instead
146 * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
147 * some machines. Default behavior is to use the XSDT if present.
148 */
149ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
150
151/*
152 * Optionally use 32-bit FADT addresses if and when there is a conflict
153 * (address mismatch) between the 32-bit and 64-bit versions of the
154 * address. Although ACPICA adheres to the ACPI specification which
155 * requires the use of the corresponding 64-bit address if it is non-zero,
156 * some machines have been found to have a corrupted non-zero 64-bit
157 * address. Default is FALSE, do not favor the 32-bit addresses.
158 */
159ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, FALSE);
160
161/*
162 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
163 * with other ACPI implementations. NOTE: During ACPICA initialization,
164 * this value is set to TRUE if any Windows OSI strings have been
165 * requested by the BIOS.
166 */
167ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
168
169/*
170 * Disable runtime checking and repair of values returned by control methods.
171 * Use only if the repair is causing a problem on a particular machine.
172 */
173ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
174
175/*
176 * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
177 * This can be useful for debugging ACPI problems on some machines.
178 */
179ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
180
181/*
182 * We keep track of the latest version of Windows that has been requested by
183 * the BIOS. ACPI 5.0.
184 */
185ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
186
187/*
Lv Zheng3a2f3a32014-04-30 10:04:35 +0800188 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
189 * that the ACPI hardware is no longer required. A flag in the FADT indicates
190 * a reduced HW machine, and that flag is duplicated here for convenience.
Bob Moore50df4d82008-12-31 03:01:23 +0800191 */
Lv Zheng3a2f3a32014-04-30 10:04:35 +0800192ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
Lv Zheng3e8214e2012-12-19 05:37:15 +0000193
Lv Zheng3a2f3a32014-04-30 10:04:35 +0800194/*
195 * This mechanism is used to trace a specified AML method. The method is
196 * traced each time it is executed.
197 */
198ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
199ACPI_INIT_GLOBAL(acpi_name, acpi_gbl_trace_method_name, 0);
Lv Zheng3e8214e2012-12-19 05:37:15 +0000200
Lv Zheng3a2f3a32014-04-30 10:04:35 +0800201/*
202 * Runtime configuration of debug output control masks. We want the debug
203 * switches statically initialized so they are already set when the debugger
204 * is entered.
205 */
206ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
207ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
Lv Zheng3e8214e2012-12-19 05:37:15 +0000208
Lv Zheng3a2f3a32014-04-30 10:04:35 +0800209/*
210 * Globals that are publically available
211 */
212ACPI_GLOBAL(u32, acpi_current_gpe_count);
213ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
214ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
Bob Moore50df4d82008-12-31 03:01:23 +0800215
Bob Moore33620c52012-02-14 18:14:27 +0800216/*
217 * Hardware-reduced prototypes. All interfaces that use these macros will
218 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
219 * is set to TRUE.
220 */
221#if (!ACPI_REDUCED_HARDWARE)
222#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
223 prototype;
224
225#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
226 prototype;
227
228#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
229 prototype;
230
231#else
232#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
233 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
234
235#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
236 static ACPI_INLINE prototype {return(AE_OK);}
237
238#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
Bob Moorec26f3c92013-10-29 09:29:16 +0800239 static ACPI_INLINE prototype {return;}
Bob Moore33620c52012-02-14 18:14:27 +0800240
241#endif /* !ACPI_REDUCED_HARDWARE */
242
Bob Moore50df4d82008-12-31 03:01:23 +0800243/*
Lv Zheng407e22a2014-04-30 10:04:48 +0800244 * Error-message prototypes. All interfaces that use these macros will
245 * be configured out of the ACPICA build if the ACPI_NO_ERROR_MESSAGE flag
246 * is defined.
247 */
248#ifndef ACPI_NO_ERROR_MESSAGES
249#define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
250 prototype;
251
252#else
253#define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
254 static ACPI_INLINE prototype {return;}
255
256#endif /* ACPI_NO_ERROR_MESSAGES */
257
258/*
Lv Zheng1ce28c32014-04-30 10:04:55 +0800259 * Debugging-output prototypes. All interfaces that use these macros will
260 * be configured out of the ACPICA build if the ACPI_DEBUG_OUTPUT flag is
261 * not defined.
262 */
263#ifdef ACPI_DEBUG_OUTPUT
264#define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
265 prototype;
266
267#else
268#define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
269 static ACPI_INLINE prototype {return;}
270
271#endif /* ACPI_DEBUG_OUTPUT */
272
273/*
Lv Zheng75c80442012-12-19 05:36:49 +0000274 * Initialization
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 */
Lv Zheng45c9f782013-10-31 09:31:24 +0800276acpi_status __init
Bob Mooref3d2e782007-02-02 19:48:18 +0300277acpi_initialize_tables(struct acpi_table_desc *initial_storage,
278 u32 initial_table_count, u8 allow_resize);
279
Len Browndd272b52007-05-30 00:26:11 -0400280acpi_status __init acpi_initialize_subsystem(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Lv Zheng45c9f782013-10-31 09:31:24 +0800282acpi_status __init acpi_enable_subsystem(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Lv Zheng45c9f782013-10-31 09:31:24 +0800284acpi_status __init acpi_initialize_objects(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Lv Zheng45c9f782013-10-31 09:31:24 +0800286acpi_status __init acpi_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Lv Zheng75c80442012-12-19 05:36:49 +0000288/*
289 * Miscellaneous global interfaces
290 */
Bob Moore33620c52012-02-14 18:14:27 +0800291ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
292ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
Lv Zheng739dcbb2012-12-20 01:07:26 +0000293#ifdef ACPI_FUTURE_USAGE
Lv Zhenged606942014-01-08 13:44:56 +0800294acpi_status acpi_subsystem_status(void);
Lv Zheng739dcbb2012-12-20 01:07:26 +0000295#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400298acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299#endif
300
Lv Zheng9187a412013-10-31 09:30:28 +0800301acpi_status acpi_get_statistics(struct acpi_statistics *stats);
302
Len Brown4be44fc2005-08-05 00:44:28 -0400303const char *acpi_format_exception(acpi_status exception);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Len Brown4be44fc2005-08-05 00:44:28 -0400305acpi_status acpi_purge_cached_objects(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Lin Mingb0ed7a92010-08-06 09:35:51 +0800307acpi_status acpi_install_interface(acpi_string interface_name);
308
309acpi_status acpi_remove_interface(acpi_string interface_name);
310
Lv Zheng2cf9f5b2013-07-22 16:08:16 +0800311acpi_status acpi_update_interfaces(u8 action);
312
Lin Mingf654c0f2012-01-12 13:10:32 +0800313u32
314acpi_check_address_range(acpi_adr_space_type space_id,
315 acpi_physical_address address,
316 acpi_size length, u8 warn);
317
Bob Moorebe030a52012-08-17 13:07:54 +0800318acpi_status
319acpi_decode_pld_buffer(u8 *in_buffer,
320 acpi_size length, struct acpi_pld_info **return_buffer);
321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322/*
Bob Mooref60d8182012-07-16 10:21:34 +0800323 * ACPI table load/unload interfaces
324 */
Lv Zhengcaf4a152014-04-04 12:39:18 +0800325acpi_status __init
326acpi_install_table(acpi_physical_address address, u8 physical);
327
Bob Mooref60d8182012-07-16 10:21:34 +0800328acpi_status acpi_load_table(struct acpi_table_header *table);
329
330acpi_status acpi_unload_parent_table(acpi_handle object);
331
Lv Zheng45c9f782013-10-31 09:31:24 +0800332acpi_status __init acpi_load_tables(void);
Bob Mooref60d8182012-07-16 10:21:34 +0800333
334/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 * ACPI table manipulation interfaces
336 */
Lv Zheng45c9f782013-10-31 09:31:24 +0800337acpi_status __init acpi_reallocate_root_table(void);
Bob Mooref3d2e782007-02-02 19:48:18 +0300338
Lv Zheng45c9f782013-10-31 09:31:24 +0800339acpi_status __init acpi_find_root_pointer(acpi_size *rsdp_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Bob Mooref3d2e782007-02-02 19:48:18 +0300341acpi_status acpi_unload_table_id(acpi_owner_id id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
343acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300344acpi_get_table_header(acpi_string signature,
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000345 u32 instance, struct acpi_table_header *out_table_header);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347acpi_status
Yinghai Lu7d972772009-02-07 15:39:41 -0800348acpi_get_table_with_size(acpi_string signature,
349 u32 instance, struct acpi_table_header **out_table,
350 acpi_size *tbl_size);
Lv Zhengcd27d792013-10-29 09:30:22 +0800351
Yinghai Lu7d972772009-02-07 15:39:41 -0800352acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300353acpi_get_table(acpi_string signature,
Bob Moore67a119f2008-06-10 13:42:13 +0800354 u32 instance, struct acpi_table_header **out_table);
Bob Mooref3d2e782007-02-02 19:48:18 +0300355
356acpi_status
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000357acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Lin Ming3e08e2d2008-04-10 19:06:38 +0400359acpi_status
Lv Zhengb43e1062013-01-12 15:29:38 +0000360acpi_install_table_handler(acpi_table_handler handler, void *context);
Lin Ming3e08e2d2008-04-10 19:06:38 +0400361
Lv Zhengb43e1062013-01-12 15:29:38 +0000362acpi_status acpi_remove_table_handler(acpi_table_handler handler);
Lin Ming3e08e2d2008-04-10 19:06:38 +0400363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364/*
365 * Namespace and name interfaces
366 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400368acpi_walk_namespace(acpi_object_type type,
369 acpi_handle start_object,
370 u32 max_depth,
Bob Moore4ef17502013-08-08 15:30:05 +0800371 acpi_walk_callback descending_callback,
372 acpi_walk_callback ascending_callback,
Len Brown4be44fc2005-08-05 00:44:28 -0400373 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375acpi_status
Al Viro70b30fb2007-08-21 16:18:20 +0100376acpi_get_devices(const char *HID,
Len Brown4be44fc2005-08-05 00:44:28 -0400377 acpi_walk_callback user_function,
378 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800381acpi_get_name(acpi_handle object,
Len Brown4be44fc2005-08-05 00:44:28 -0400382 u32 name_type, struct acpi_buffer *ret_path_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400385acpi_get_handle(acpi_handle parent,
386 acpi_string pathname, acpi_handle * ret_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800389acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
390
391acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393acpi_status
Rafael J. Wysocki7c2e1772014-02-04 00:42:46 +0100394acpi_get_data_full(acpi_handle object, acpi_object_handler handler, void **data,
395 void (*callback)(void *));
396
397acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800398acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
Bob Moore50eca3e2005-09-30 19:03:00 -0400400acpi_status
401acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403/*
404 * Object manipulation and enumeration
405 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400407acpi_evaluate_object(acpi_handle object,
408 acpi_string pathname,
409 struct acpi_object_list *parameter_objects,
410 struct acpi_buffer *return_object_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400413acpi_evaluate_object_typed(acpi_handle object,
414 acpi_string pathname,
415 struct acpi_object_list *external_params,
416 struct acpi_buffer *return_buffer,
417 acpi_object_type return_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800420acpi_get_object_info(acpi_handle object,
Bob Moore15b8dd52009-06-29 13:39:29 +0800421 struct acpi_device_info **return_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Lin Mingb2f7ddc2009-05-21 10:42:09 +0800423acpi_status acpi_install_method(u8 *buffer);
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400426acpi_get_next_object(acpi_object_type type,
427 acpi_handle parent,
428 acpi_handle child, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Len Brown4be44fc2005-08-05 00:44:28 -0400430acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
John Keller0f0fe1a2006-12-19 12:56:19 -0800432acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
433
Len Brown4be44fc2005-08-05 00:44:28 -0400434acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436/*
Bob Mooreecfbbc72008-12-31 02:55:32 +0800437 * Handler interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439acpi_status
Bob Mooreecfbbc72008-12-31 02:55:32 +0800440acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
441
Bob Moore33620c52012-02-14 18:14:27 +0800442ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
Lv Zhenga2fd4b42013-09-23 09:52:05 +0800443 acpi_install_sci_handler(acpi_sci_handler
444 address,
445 void *context))
446ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
447 acpi_remove_sci_handler(acpi_sci_handler
448 address))
449ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
450 acpi_install_global_event_handler
451 (acpi_gbl_event_handler handler,
452 void *context))
Bob Moore33620c52012-02-14 18:14:27 +0800453ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
454 acpi_install_fixed_event_handler(u32
455 acpi_event,
456 acpi_event_handler
457 handler,
458 void
459 *context))
460ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
461 acpi_remove_fixed_event_handler(u32 acpi_event,
462 acpi_event_handler
463 handler))
464ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
465 acpi_install_gpe_handler(acpi_handle
466 gpe_device,
467 u32 gpe_number,
468 u32 type,
469 acpi_gpe_handler
470 address,
471 void *context))
472ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
473 acpi_remove_gpe_handler(acpi_handle gpe_device,
474 u32 gpe_number,
475 acpi_gpe_handler
476 address))
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000477acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
Lv Zhenged606942014-01-08 13:44:56 +0800478 acpi_notify_handler handler,
479 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400482acpi_remove_notify_handler(acpi_handle device,
483 u32 handler_type, acpi_notify_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
485acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400486acpi_install_address_space_handler(acpi_handle device,
487 acpi_adr_space_type space_id,
488 acpi_adr_space_handler handler,
489 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
491acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400492acpi_remove_address_space_handler(acpi_handle device,
493 acpi_adr_space_type space_id,
494 acpi_adr_space_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400497acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498#endif
499
Lin Mingb0ed7a92010-08-06 09:35:51 +0800500acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502/*
Lin Mingffef6822011-11-16 11:08:30 +0800503 * Global Lock interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 */
Bob Moore33620c52012-02-14 18:14:27 +0800505ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
506 acpi_acquire_global_lock(u16 timeout,
507 u32 *handle))
Lv Zhengcd27d792013-10-29 09:30:22 +0800508
Bob Moore33620c52012-02-14 18:14:27 +0800509ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
510 acpi_release_global_lock(u32 handle))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Lin Mingffef6822011-11-16 11:08:30 +0800512/*
513 * Interfaces to AML mutex objects
514 */
515acpi_status
516acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
517
518acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
519
520/*
521 * Fixed Event interfaces
522 */
Bob Moore33620c52012-02-14 18:14:27 +0800523ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
524 acpi_enable_event(u32 event, u32 flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Bob Moore33620c52012-02-14 18:14:27 +0800526ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
527 acpi_disable_event(u32 event, u32 flags))
Bob Moore33620c52012-02-14 18:14:27 +0800528ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Bob Moore33620c52012-02-14 18:14:27 +0800530ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
531 acpi_get_event_status(u32 event,
532 acpi_event_status
533 *event_status))
Lv Zhengcd27d792013-10-29 09:30:22 +0800534
Bob Moore08ac07b2008-12-30 09:55:48 +0800535/*
Lin Mingffef6822011-11-16 11:08:30 +0800536 * General Purpose Event (GPE) Interfaces
Bob Moore08ac07b2008-12-30 09:55:48 +0800537 */
Bob Moore33620c52012-02-14 18:14:27 +0800538ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
Len Brown4be44fc2005-08-05 00:44:28 -0400539
Bob Moore33620c52012-02-14 18:14:27 +0800540ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
541 acpi_enable_gpe(acpi_handle gpe_device,
542 u32 gpe_number))
Len Brown4be44fc2005-08-05 00:44:28 -0400543
Bob Moore33620c52012-02-14 18:14:27 +0800544ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
545 acpi_disable_gpe(acpi_handle gpe_device,
546 u32 gpe_number))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Bob Moore33620c52012-02-14 18:14:27 +0800548ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
549 acpi_clear_gpe(acpi_handle gpe_device,
550 u32 gpe_number))
Lin Mingbba63a22010-12-13 13:39:17 +0800551
Bob Moore33620c52012-02-14 18:14:27 +0800552ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
553 acpi_set_gpe(acpi_handle gpe_device,
554 u32 gpe_number, u8 action))
Rafael J. Wysockie8b6f972010-06-25 01:18:39 +0200555
Bob Moore33620c52012-02-14 18:14:27 +0800556ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
557 acpi_finish_gpe(acpi_handle gpe_device,
558 u32 gpe_number))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Bob Moore33620c52012-02-14 18:14:27 +0800560ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
561 acpi_setup_gpe_for_wake(acpi_handle
562 parent_device,
563 acpi_handle gpe_device,
564 u32 gpe_number))
565ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
566 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
567 u32 gpe_number,
568 u8 action))
569ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
570 acpi_get_gpe_status(acpi_handle gpe_device,
571 u32 gpe_number,
572 acpi_event_status
573 *event_status))
Bob Moore33620c52012-02-14 18:14:27 +0800574ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
Bob Moore33620c52012-02-14 18:14:27 +0800575ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
Bob Mooree97d6bf2008-12-30 09:45:17 +0800576
Bob Moore33620c52012-02-14 18:14:27 +0800577ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
578 acpi_get_gpe_device(u32 gpe_index,
579 acpi_handle * gpe_device))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Bob Moore33620c52012-02-14 18:14:27 +0800581ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
582 acpi_install_gpe_block(acpi_handle gpe_device,
583 struct
584 acpi_generic_address
585 *gpe_block_address,
586 u32 register_count,
587 u32 interrupt_number))
588ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
589 acpi_remove_gpe_block(acpi_handle gpe_device))
Rafael J. Wysockia2100802010-09-16 00:30:43 +0200590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/*
592 * Resource interfaces
593 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594typedef
Bob Moore616861242006-03-17 16:44:00 -0500595acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
Len Brown4be44fc2005-08-05 00:44:28 -0400596 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800599acpi_get_vendor_resource(acpi_handle device,
Bob Moorec51a4de2005-11-17 13:07:00 -0500600 char *name,
601 struct acpi_vendor_uuid *uuid,
602 struct acpi_buffer *ret_buffer);
603
604acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800605acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607#ifdef ACPI_FUTURE_USAGE
608acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800609acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610#endif
611
612acpi_status
Bob Moorea91cdde2011-11-16 14:46:57 +0800613acpi_get_event_resources(acpi_handle device_handle,
614 struct acpi_buffer *ret_buffer);
615
616acpi_status
Bob Mooreafb1bbe2012-12-31 00:03:58 +0000617acpi_walk_resource_buffer(struct acpi_buffer *buffer,
618 acpi_walk_resource_callback user_function,
619 void *context);
620
621acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800622acpi_walk_resources(acpi_handle device,
Bob Moorec51a4de2005-11-17 13:07:00 -0500623 char *name,
Bob Moore616861242006-03-17 16:44:00 -0500624 acpi_walk_resource_callback user_function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800627acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
629acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800630acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
632acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400633acpi_resource_to_address64(struct acpi_resource *resource,
634 struct acpi_resource_address64 *out);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Bob Moore0e243172011-11-16 14:51:01 +0800636acpi_status
637acpi_buffer_to_resource(u8 *aml_buffer,
638 u16 aml_buffer_length,
639 struct acpi_resource **resource_ptr);
640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641/*
642 * Hardware (ACPI device) interfaces
643 */
Bob Moored3fd9022008-12-30 11:11:57 +0800644acpi_status acpi_reset(void);
645
Lv Zheng739dcbb2012-12-20 01:07:26 +0000646acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
647
648acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
649
Bob Moore33620c52012-02-14 18:14:27 +0800650ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
651 acpi_read_bit_register(u32 register_id,
652 u32 *return_value))
Len Brown4be44fc2005-08-05 00:44:28 -0400653
Bob Moore33620c52012-02-14 18:14:27 +0800654ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
655 acpi_write_bit_register(u32 register_id,
656 u32 value))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Bob Moore33620c52012-02-14 18:14:27 +0800658/*
659 * Sleep/Wake interfaces
660 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661acpi_status
Lv Zhengcd27d792013-10-29 09:30:22 +0800662acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Len Brown4be44fc2005-08-05 00:44:28 -0400664acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Lv Zheng40bce102013-10-31 09:31:18 +0800666acpi_status acpi_enter_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Lv Zheng40bce102013-10-31 09:31:18 +0800668ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Len Brown3f6f49c2012-07-26 20:08:54 -0400670acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100671
Len Brown4be44fc2005-08-05 00:44:28 -0400672acpi_status acpi_leave_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
Lv Zheng739dcbb2012-12-20 01:07:26 +0000674ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
675 acpi_set_firmware_waking_vector(u32
676 physical_address))
Lv Zheng739dcbb2012-12-20 01:07:26 +0000677#if ACPI_MACHINE_WIDTH == 64
678ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
679 acpi_set_firmware_waking_vector64(u64
680 physical_address))
681#endif
Bob Moore50df4d82008-12-31 03:01:23 +0800682/*
Bob Moored08310f2012-02-14 15:22:51 +0800683 * ACPI Timer interfaces
684 */
685#ifdef ACPI_FUTURE_USAGE
Bob Moore33620c52012-02-14 18:14:27 +0800686ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
687 acpi_get_timer_resolution(u32 *resolution))
Bob Moore33620c52012-02-14 18:14:27 +0800688ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
Bob Moored08310f2012-02-14 15:22:51 +0800689
Bob Moore33620c52012-02-14 18:14:27 +0800690ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
691 acpi_get_timer_duration(u32 start_ticks,
692 u32 end_ticks,
693 u32 *time_elapsed))
Bob Moored08310f2012-02-14 15:22:51 +0800694#endif /* ACPI_FUTURE_USAGE */
695
696/*
Bob Mooreb74be612009-04-22 10:20:23 +0800697 * Error/Warning output
Bob Moore50df4d82008-12-31 03:01:23 +0800698 */
Lv Zheng407e22a2014-04-30 10:04:48 +0800699ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
700 void ACPI_INTERNAL_VAR_XFACE
701 acpi_error(const char *module_name,
702 u32 line_number,
703 const char *format, ...))
704ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
705 void ACPI_INTERNAL_VAR_XFACE
706 acpi_exception(const char *module_name,
707 u32 line_number,
708 acpi_status status,
709 const char *format, ...))
710ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
711 void ACPI_INTERNAL_VAR_XFACE
712 acpi_warning(const char *module_name,
713 u32 line_number,
714 const char *format, ...))
715ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
716 void ACPI_INTERNAL_VAR_XFACE
717 acpi_info(const char *module_name,
718 u32 line_number,
719 const char *format, ...))
720ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
721 void ACPI_INTERNAL_VAR_XFACE
722 acpi_bios_error(const char *module_name,
723 u32 line_number,
724 const char *format, ...))
725ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
726 void ACPI_INTERNAL_VAR_XFACE
727 acpi_bios_warning(const char *module_name,
728 u32 line_number,
729 const char *format, ...))
Bob Moore62cdd142012-07-16 09:25:27 +0800730
Bob Mooreb74be612009-04-22 10:20:23 +0800731/*
732 * Debug output
733 */
Lv Zheng1ce28c32014-04-30 10:04:55 +0800734ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
735 void ACPI_INTERNAL_VAR_XFACE
736 acpi_debug_print(u32 requested_debug_level,
737 u32 line_number,
738 const char *function_name,
739 const char *module_name,
740 u32 component_id,
741 const char *format, ...))
742ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
743 void ACPI_INTERNAL_VAR_XFACE
744 acpi_debug_print_raw(u32 requested_debug_level,
745 u32 line_number,
746 const char *function_name,
747 const char *module_name,
748 u32 component_id,
749 const char *format, ...))
Len Brown4be44fc2005-08-05 00:44:28 -0400750#endif /* __ACXFACE_H__ */