blob: 39f432e513f2f009d12f33590575500c2032999b [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 Zheng75c80442012-12-19 05:36:49 +0000259 * Initialization
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 */
Lv Zheng45c9f782013-10-31 09:31:24 +0800261acpi_status __init
Bob Mooref3d2e782007-02-02 19:48:18 +0300262acpi_initialize_tables(struct acpi_table_desc *initial_storage,
263 u32 initial_table_count, u8 allow_resize);
264
Len Browndd272b52007-05-30 00:26:11 -0400265acpi_status __init acpi_initialize_subsystem(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Lv Zheng45c9f782013-10-31 09:31:24 +0800267acpi_status __init acpi_enable_subsystem(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Lv Zheng45c9f782013-10-31 09:31:24 +0800269acpi_status __init acpi_initialize_objects(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Lv Zheng45c9f782013-10-31 09:31:24 +0800271acpi_status __init acpi_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Lv Zheng75c80442012-12-19 05:36:49 +0000273/*
274 * Miscellaneous global interfaces
275 */
Bob Moore33620c52012-02-14 18:14:27 +0800276ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
277ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
Lv Zheng739dcbb2012-12-20 01:07:26 +0000278#ifdef ACPI_FUTURE_USAGE
Lv Zhenged606942014-01-08 13:44:56 +0800279acpi_status acpi_subsystem_status(void);
Lv Zheng739dcbb2012-12-20 01:07:26 +0000280#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400283acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#endif
285
Lv Zheng9187a412013-10-31 09:30:28 +0800286acpi_status acpi_get_statistics(struct acpi_statistics *stats);
287
Len Brown4be44fc2005-08-05 00:44:28 -0400288const char *acpi_format_exception(acpi_status exception);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Len Brown4be44fc2005-08-05 00:44:28 -0400290acpi_status acpi_purge_cached_objects(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Lin Mingb0ed7a92010-08-06 09:35:51 +0800292acpi_status acpi_install_interface(acpi_string interface_name);
293
294acpi_status acpi_remove_interface(acpi_string interface_name);
295
Lv Zheng2cf9f5b2013-07-22 16:08:16 +0800296acpi_status acpi_update_interfaces(u8 action);
297
Lin Mingf654c0f2012-01-12 13:10:32 +0800298u32
299acpi_check_address_range(acpi_adr_space_type space_id,
300 acpi_physical_address address,
301 acpi_size length, u8 warn);
302
Bob Moorebe030a52012-08-17 13:07:54 +0800303acpi_status
304acpi_decode_pld_buffer(u8 *in_buffer,
305 acpi_size length, struct acpi_pld_info **return_buffer);
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307/*
Bob Mooref60d8182012-07-16 10:21:34 +0800308 * ACPI table load/unload interfaces
309 */
Lv Zhengcaf4a152014-04-04 12:39:18 +0800310acpi_status __init
311acpi_install_table(acpi_physical_address address, u8 physical);
312
Bob Mooref60d8182012-07-16 10:21:34 +0800313acpi_status acpi_load_table(struct acpi_table_header *table);
314
315acpi_status acpi_unload_parent_table(acpi_handle object);
316
Lv Zheng45c9f782013-10-31 09:31:24 +0800317acpi_status __init acpi_load_tables(void);
Bob Mooref60d8182012-07-16 10:21:34 +0800318
319/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * ACPI table manipulation interfaces
321 */
Lv Zheng45c9f782013-10-31 09:31:24 +0800322acpi_status __init acpi_reallocate_root_table(void);
Bob Mooref3d2e782007-02-02 19:48:18 +0300323
Lv Zheng45c9f782013-10-31 09:31:24 +0800324acpi_status __init acpi_find_root_pointer(acpi_size *rsdp_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Bob Mooref3d2e782007-02-02 19:48:18 +0300326acpi_status acpi_unload_table_id(acpi_owner_id id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300329acpi_get_table_header(acpi_string signature,
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000330 u32 instance, struct acpi_table_header *out_table_header);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332acpi_status
Yinghai Lu7d972772009-02-07 15:39:41 -0800333acpi_get_table_with_size(acpi_string signature,
334 u32 instance, struct acpi_table_header **out_table,
335 acpi_size *tbl_size);
Lv Zhengcd27d792013-10-29 09:30:22 +0800336
Yinghai Lu7d972772009-02-07 15:39:41 -0800337acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300338acpi_get_table(acpi_string signature,
Bob Moore67a119f2008-06-10 13:42:13 +0800339 u32 instance, struct acpi_table_header **out_table);
Bob Mooref3d2e782007-02-02 19:48:18 +0300340
341acpi_status
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000342acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Lin Ming3e08e2d2008-04-10 19:06:38 +0400344acpi_status
Lv Zhengb43e1062013-01-12 15:29:38 +0000345acpi_install_table_handler(acpi_table_handler handler, void *context);
Lin Ming3e08e2d2008-04-10 19:06:38 +0400346
Lv Zhengb43e1062013-01-12 15:29:38 +0000347acpi_status acpi_remove_table_handler(acpi_table_handler handler);
Lin Ming3e08e2d2008-04-10 19:06:38 +0400348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/*
350 * Namespace and name interfaces
351 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400353acpi_walk_namespace(acpi_object_type type,
354 acpi_handle start_object,
355 u32 max_depth,
Bob Moore4ef17502013-08-08 15:30:05 +0800356 acpi_walk_callback descending_callback,
357 acpi_walk_callback ascending_callback,
Len Brown4be44fc2005-08-05 00:44:28 -0400358 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360acpi_status
Al Viro70b30fb2007-08-21 16:18:20 +0100361acpi_get_devices(const char *HID,
Len Brown4be44fc2005-08-05 00:44:28 -0400362 acpi_walk_callback user_function,
363 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800366acpi_get_name(acpi_handle object,
Len Brown4be44fc2005-08-05 00:44:28 -0400367 u32 name_type, struct acpi_buffer *ret_path_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400370acpi_get_handle(acpi_handle parent,
371 acpi_string pathname, acpi_handle * ret_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800374acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
375
376acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378acpi_status
Rafael J. Wysocki7c2e1772014-02-04 00:42:46 +0100379acpi_get_data_full(acpi_handle object, acpi_object_handler handler, void **data,
380 void (*callback)(void *));
381
382acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800383acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Bob Moore50eca3e2005-09-30 19:03:00 -0400385acpi_status
386acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388/*
389 * Object manipulation and enumeration
390 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400392acpi_evaluate_object(acpi_handle object,
393 acpi_string pathname,
394 struct acpi_object_list *parameter_objects,
395 struct acpi_buffer *return_object_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400398acpi_evaluate_object_typed(acpi_handle object,
399 acpi_string pathname,
400 struct acpi_object_list *external_params,
401 struct acpi_buffer *return_buffer,
402 acpi_object_type return_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
404acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800405acpi_get_object_info(acpi_handle object,
Bob Moore15b8dd52009-06-29 13:39:29 +0800406 struct acpi_device_info **return_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Lin Mingb2f7ddc2009-05-21 10:42:09 +0800408acpi_status acpi_install_method(u8 *buffer);
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400411acpi_get_next_object(acpi_object_type type,
412 acpi_handle parent,
413 acpi_handle child, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
Len Brown4be44fc2005-08-05 00:44:28 -0400415acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
John Keller0f0fe1a2006-12-19 12:56:19 -0800417acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
418
Len Brown4be44fc2005-08-05 00:44:28 -0400419acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421/*
Bob Mooreecfbbc72008-12-31 02:55:32 +0800422 * Handler interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424acpi_status
Bob Mooreecfbbc72008-12-31 02:55:32 +0800425acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
426
Bob Moore33620c52012-02-14 18:14:27 +0800427ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
Lv Zhenga2fd4b42013-09-23 09:52:05 +0800428 acpi_install_sci_handler(acpi_sci_handler
429 address,
430 void *context))
431ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
432 acpi_remove_sci_handler(acpi_sci_handler
433 address))
434ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
435 acpi_install_global_event_handler
436 (acpi_gbl_event_handler handler,
437 void *context))
Bob Moore33620c52012-02-14 18:14:27 +0800438ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
439 acpi_install_fixed_event_handler(u32
440 acpi_event,
441 acpi_event_handler
442 handler,
443 void
444 *context))
445ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
446 acpi_remove_fixed_event_handler(u32 acpi_event,
447 acpi_event_handler
448 handler))
449ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
450 acpi_install_gpe_handler(acpi_handle
451 gpe_device,
452 u32 gpe_number,
453 u32 type,
454 acpi_gpe_handler
455 address,
456 void *context))
457ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
458 acpi_remove_gpe_handler(acpi_handle gpe_device,
459 u32 gpe_number,
460 acpi_gpe_handler
461 address))
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000462acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
Lv Zhenged606942014-01-08 13:44:56 +0800463 acpi_notify_handler handler,
464 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400467acpi_remove_notify_handler(acpi_handle device,
468 u32 handler_type, acpi_notify_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
470acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400471acpi_install_address_space_handler(acpi_handle device,
472 acpi_adr_space_type space_id,
473 acpi_adr_space_handler handler,
474 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400477acpi_remove_address_space_handler(acpi_handle device,
478 acpi_adr_space_type space_id,
479 acpi_adr_space_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400482acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483#endif
484
Lin Mingb0ed7a92010-08-06 09:35:51 +0800485acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
486
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487/*
Lin Mingffef6822011-11-16 11:08:30 +0800488 * Global Lock interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 */
Bob Moore33620c52012-02-14 18:14:27 +0800490ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
491 acpi_acquire_global_lock(u16 timeout,
492 u32 *handle))
Lv Zhengcd27d792013-10-29 09:30:22 +0800493
Bob Moore33620c52012-02-14 18:14:27 +0800494ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
495 acpi_release_global_lock(u32 handle))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Lin Mingffef6822011-11-16 11:08:30 +0800497/*
498 * Interfaces to AML mutex objects
499 */
500acpi_status
501acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
502
503acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
504
505/*
506 * Fixed Event interfaces
507 */
Bob Moore33620c52012-02-14 18:14:27 +0800508ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
509 acpi_enable_event(u32 event, u32 flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Bob Moore33620c52012-02-14 18:14:27 +0800511ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
512 acpi_disable_event(u32 event, u32 flags))
Bob Moore33620c52012-02-14 18:14:27 +0800513ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Bob Moore33620c52012-02-14 18:14:27 +0800515ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
516 acpi_get_event_status(u32 event,
517 acpi_event_status
518 *event_status))
Lv Zhengcd27d792013-10-29 09:30:22 +0800519
Bob Moore08ac07b2008-12-30 09:55:48 +0800520/*
Lin Mingffef6822011-11-16 11:08:30 +0800521 * General Purpose Event (GPE) Interfaces
Bob Moore08ac07b2008-12-30 09:55:48 +0800522 */
Bob Moore33620c52012-02-14 18:14:27 +0800523ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
Len Brown4be44fc2005-08-05 00:44:28 -0400524
Bob Moore33620c52012-02-14 18:14:27 +0800525ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
526 acpi_enable_gpe(acpi_handle gpe_device,
527 u32 gpe_number))
Len Brown4be44fc2005-08-05 00:44:28 -0400528
Bob Moore33620c52012-02-14 18:14:27 +0800529ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
530 acpi_disable_gpe(acpi_handle gpe_device,
531 u32 gpe_number))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Bob Moore33620c52012-02-14 18:14:27 +0800533ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
534 acpi_clear_gpe(acpi_handle gpe_device,
535 u32 gpe_number))
Lin Mingbba63a22010-12-13 13:39:17 +0800536
Bob Moore33620c52012-02-14 18:14:27 +0800537ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
538 acpi_set_gpe(acpi_handle gpe_device,
539 u32 gpe_number, u8 action))
Rafael J. Wysockie8b6f972010-06-25 01:18:39 +0200540
Bob Moore33620c52012-02-14 18:14:27 +0800541ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
542 acpi_finish_gpe(acpi_handle gpe_device,
543 u32 gpe_number))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Bob Moore33620c52012-02-14 18:14:27 +0800545ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
546 acpi_setup_gpe_for_wake(acpi_handle
547 parent_device,
548 acpi_handle gpe_device,
549 u32 gpe_number))
550ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
551 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
552 u32 gpe_number,
553 u8 action))
554ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
555 acpi_get_gpe_status(acpi_handle gpe_device,
556 u32 gpe_number,
557 acpi_event_status
558 *event_status))
Bob Moore33620c52012-02-14 18:14:27 +0800559ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
Bob Moore33620c52012-02-14 18:14:27 +0800560ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
Bob Mooree97d6bf2008-12-30 09:45:17 +0800561
Bob Moore33620c52012-02-14 18:14:27 +0800562ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
563 acpi_get_gpe_device(u32 gpe_index,
564 acpi_handle * gpe_device))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Bob Moore33620c52012-02-14 18:14:27 +0800566ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
567 acpi_install_gpe_block(acpi_handle gpe_device,
568 struct
569 acpi_generic_address
570 *gpe_block_address,
571 u32 register_count,
572 u32 interrupt_number))
573ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
574 acpi_remove_gpe_block(acpi_handle gpe_device))
Rafael J. Wysockia2100802010-09-16 00:30:43 +0200575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576/*
577 * Resource interfaces
578 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579typedef
Bob Moore616861242006-03-17 16:44:00 -0500580acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
Len Brown4be44fc2005-08-05 00:44:28 -0400581 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
583acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800584acpi_get_vendor_resource(acpi_handle device,
Bob Moorec51a4de2005-11-17 13:07:00 -0500585 char *name,
586 struct acpi_vendor_uuid *uuid,
587 struct acpi_buffer *ret_buffer);
588
589acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800590acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592#ifdef ACPI_FUTURE_USAGE
593acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800594acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595#endif
596
597acpi_status
Bob Moorea91cdde2011-11-16 14:46:57 +0800598acpi_get_event_resources(acpi_handle device_handle,
599 struct acpi_buffer *ret_buffer);
600
601acpi_status
Bob Mooreafb1bbe2012-12-31 00:03:58 +0000602acpi_walk_resource_buffer(struct acpi_buffer *buffer,
603 acpi_walk_resource_callback user_function,
604 void *context);
605
606acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800607acpi_walk_resources(acpi_handle device,
Bob Moorec51a4de2005-11-17 13:07:00 -0500608 char *name,
Bob Moore616861242006-03-17 16:44:00 -0500609 acpi_walk_resource_callback user_function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
611acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800612acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
614acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800615acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400618acpi_resource_to_address64(struct acpi_resource *resource,
619 struct acpi_resource_address64 *out);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Bob Moore0e243172011-11-16 14:51:01 +0800621acpi_status
622acpi_buffer_to_resource(u8 *aml_buffer,
623 u16 aml_buffer_length,
624 struct acpi_resource **resource_ptr);
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626/*
627 * Hardware (ACPI device) interfaces
628 */
Bob Moored3fd9022008-12-30 11:11:57 +0800629acpi_status acpi_reset(void);
630
Lv Zheng739dcbb2012-12-20 01:07:26 +0000631acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
632
633acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
634
Bob Moore33620c52012-02-14 18:14:27 +0800635ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
636 acpi_read_bit_register(u32 register_id,
637 u32 *return_value))
Len Brown4be44fc2005-08-05 00:44:28 -0400638
Bob Moore33620c52012-02-14 18:14:27 +0800639ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
640 acpi_write_bit_register(u32 register_id,
641 u32 value))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Bob Moore33620c52012-02-14 18:14:27 +0800643/*
644 * Sleep/Wake interfaces
645 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646acpi_status
Lv Zhengcd27d792013-10-29 09:30:22 +0800647acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Len Brown4be44fc2005-08-05 00:44:28 -0400649acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Lv Zheng40bce102013-10-31 09:31:18 +0800651acpi_status acpi_enter_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Lv Zheng40bce102013-10-31 09:31:18 +0800653ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Len Brown3f6f49c2012-07-26 20:08:54 -0400655acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100656
Len Brown4be44fc2005-08-05 00:44:28 -0400657acpi_status acpi_leave_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Lv Zheng739dcbb2012-12-20 01:07:26 +0000659ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
660 acpi_set_firmware_waking_vector(u32
661 physical_address))
Lv Zheng739dcbb2012-12-20 01:07:26 +0000662#if ACPI_MACHINE_WIDTH == 64
663ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
664 acpi_set_firmware_waking_vector64(u64
665 physical_address))
666#endif
Bob Moore50df4d82008-12-31 03:01:23 +0800667/*
Bob Moored08310f2012-02-14 15:22:51 +0800668 * ACPI Timer interfaces
669 */
670#ifdef ACPI_FUTURE_USAGE
Bob Moore33620c52012-02-14 18:14:27 +0800671ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
672 acpi_get_timer_resolution(u32 *resolution))
Bob Moore33620c52012-02-14 18:14:27 +0800673ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
Bob Moored08310f2012-02-14 15:22:51 +0800674
Bob Moore33620c52012-02-14 18:14:27 +0800675ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
676 acpi_get_timer_duration(u32 start_ticks,
677 u32 end_ticks,
678 u32 *time_elapsed))
Bob Moored08310f2012-02-14 15:22:51 +0800679#endif /* ACPI_FUTURE_USAGE */
680
681/*
Bob Mooreb74be612009-04-22 10:20:23 +0800682 * Error/Warning output
Bob Moore50df4d82008-12-31 03:01:23 +0800683 */
Lv Zheng407e22a2014-04-30 10:04:48 +0800684ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
685 void ACPI_INTERNAL_VAR_XFACE
686 acpi_error(const char *module_name,
687 u32 line_number,
688 const char *format, ...))
689ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
690 void ACPI_INTERNAL_VAR_XFACE
691 acpi_exception(const char *module_name,
692 u32 line_number,
693 acpi_status status,
694 const char *format, ...))
695ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
696 void ACPI_INTERNAL_VAR_XFACE
697 acpi_warning(const char *module_name,
698 u32 line_number,
699 const char *format, ...))
700ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
701 void ACPI_INTERNAL_VAR_XFACE
702 acpi_info(const char *module_name,
703 u32 line_number,
704 const char *format, ...))
705ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
706 void ACPI_INTERNAL_VAR_XFACE
707 acpi_bios_error(const char *module_name,
708 u32 line_number,
709 const char *format, ...))
710ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
711 void ACPI_INTERNAL_VAR_XFACE
712 acpi_bios_warning(const char *module_name,
713 u32 line_number,
714 const char *format, ...))
Bob Moore62cdd142012-07-16 09:25:27 +0800715
Bob Mooreb74be612009-04-22 10:20:23 +0800716/*
717 * Debug output
718 */
Bob Moore50df4d82008-12-31 03:01:23 +0800719#ifdef ACPI_DEBUG_OUTPUT
Lv Zheng4506bf22013-10-29 09:30:16 +0800720ACPI_PRINTF_LIKE(6)
Bob Moore50df4d82008-12-31 03:01:23 +0800721void ACPI_INTERNAL_VAR_XFACE
722acpi_debug_print(u32 requested_debug_level,
723 u32 line_number,
724 const char *function_name,
725 const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800726 u32 component_id, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800727
Lv Zheng4506bf22013-10-29 09:30:16 +0800728ACPI_PRINTF_LIKE(6)
Bob Moore50df4d82008-12-31 03:01:23 +0800729void ACPI_INTERNAL_VAR_XFACE
730acpi_debug_print_raw(u32 requested_debug_level,
731 u32 line_number,
732 const char *function_name,
733 const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800734 u32 component_id, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800735#endif
736
Len Brown4be44fc2005-08-05 00:44:28 -0400737#endif /* __ACXFACE_H__ */