blob: 010816e24f5ed54115214cc54344fbfa13b6c637 [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 Howellsa1ce39282012-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/*
188 * Other miscellaneous public globals
Bob Moore50df4d82008-12-31 03:01:23 +0800189 */
Lv Zheng739dcbb2012-12-20 01:07:26 +0000190extern u32 acpi_current_gpe_count;
191extern struct acpi_table_fadt acpi_gbl_FADT;
192extern u8 acpi_gbl_system_awake_and_running;
193extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */
Lv Zheng3e8214e52012-12-19 05:37:15 +0000194
Lv Zheng75c80442012-12-19 05:36:49 +0000195/* Runtime configuration of debug print levels */
Lv Zheng3e8214e52012-12-19 05:37:15 +0000196
Bob Moore50df4d82008-12-31 03:01:23 +0800197extern u32 acpi_dbg_level;
198extern u32 acpi_dbg_layer;
Lv Zheng3e8214e52012-12-19 05:37:15 +0000199
Lv Zheng75c80442012-12-19 05:36:49 +0000200/* ACPICA runtime options */
Lv Zheng3e8214e52012-12-19 05:37:15 +0000201
Lv Zhengfab46102014-01-08 13:43:40 +0800202extern u32 acpi_gbl_trace_flags;
203extern acpi_name acpi_gbl_trace_method_name;
Bob Moore50df4d82008-12-31 03:01:23 +0800204
Bob Moore33620c52012-02-14 18:14:27 +0800205/*
206 * Hardware-reduced prototypes. All interfaces that use these macros will
207 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
208 * is set to TRUE.
209 */
210#if (!ACPI_REDUCED_HARDWARE)
211#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
212 prototype;
213
214#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
215 prototype;
216
217#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
218 prototype;
219
220#else
221#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
222 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
223
224#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
225 static ACPI_INLINE prototype {return(AE_OK);}
226
227#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
Bob Moorec26f3c92013-10-29 09:29:16 +0800228 static ACPI_INLINE prototype {return;}
Bob Moore33620c52012-02-14 18:14:27 +0800229
230#endif /* !ACPI_REDUCED_HARDWARE */
231
Bob Moore50df4d82008-12-31 03:01:23 +0800232/*
Lv Zheng75c80442012-12-19 05:36:49 +0000233 * Initialization
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 */
Lv Zheng45c9f782013-10-31 09:31:24 +0800235acpi_status __init
Bob Mooref3d2e782007-02-02 19:48:18 +0300236acpi_initialize_tables(struct acpi_table_desc *initial_storage,
237 u32 initial_table_count, u8 allow_resize);
238
Len Browndd272b52007-05-30 00:26:11 -0400239acpi_status __init acpi_initialize_subsystem(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Lv Zheng45c9f782013-10-31 09:31:24 +0800241acpi_status __init acpi_enable_subsystem(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Lv Zheng45c9f782013-10-31 09:31:24 +0800243acpi_status __init acpi_initialize_objects(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Lv Zheng45c9f782013-10-31 09:31:24 +0800245acpi_status __init acpi_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Lv Zheng75c80442012-12-19 05:36:49 +0000247/*
248 * Miscellaneous global interfaces
249 */
Bob Moore33620c52012-02-14 18:14:27 +0800250ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
251ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
Lv Zheng739dcbb2012-12-20 01:07:26 +0000252#ifdef ACPI_FUTURE_USAGE
Lv Zhenged606942014-01-08 13:44:56 +0800253acpi_status acpi_subsystem_status(void);
Lv Zheng739dcbb2012-12-20 01:07:26 +0000254#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400257acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#endif
259
Lv Zheng9187a412013-10-31 09:30:28 +0800260acpi_status acpi_get_statistics(struct acpi_statistics *stats);
261
Len Brown4be44fc2005-08-05 00:44:28 -0400262const char *acpi_format_exception(acpi_status exception);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Len Brown4be44fc2005-08-05 00:44:28 -0400264acpi_status acpi_purge_cached_objects(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Lin Mingb0ed7a92010-08-06 09:35:51 +0800266acpi_status acpi_install_interface(acpi_string interface_name);
267
268acpi_status acpi_remove_interface(acpi_string interface_name);
269
Lv Zheng2cf9f5b2013-07-22 16:08:16 +0800270acpi_status acpi_update_interfaces(u8 action);
271
Lin Mingf654c0f2012-01-12 13:10:32 +0800272u32
273acpi_check_address_range(acpi_adr_space_type space_id,
274 acpi_physical_address address,
275 acpi_size length, u8 warn);
276
Bob Moorebe030a52012-08-17 13:07:54 +0800277acpi_status
278acpi_decode_pld_buffer(u8 *in_buffer,
279 acpi_size length, struct acpi_pld_info **return_buffer);
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/*
Bob Mooref60d8182012-07-16 10:21:34 +0800282 * ACPI table load/unload interfaces
283 */
Lv Zhengcaf4a152014-04-04 12:39:18 +0800284acpi_status __init
285acpi_install_table(acpi_physical_address address, u8 physical);
286
Bob Mooref60d8182012-07-16 10:21:34 +0800287acpi_status acpi_load_table(struct acpi_table_header *table);
288
289acpi_status acpi_unload_parent_table(acpi_handle object);
290
Lv Zheng45c9f782013-10-31 09:31:24 +0800291acpi_status __init acpi_load_tables(void);
Bob Mooref60d8182012-07-16 10:21:34 +0800292
293/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 * ACPI table manipulation interfaces
295 */
Lv Zheng45c9f782013-10-31 09:31:24 +0800296acpi_status __init acpi_reallocate_root_table(void);
Bob Mooref3d2e782007-02-02 19:48:18 +0300297
Lv Zheng45c9f782013-10-31 09:31:24 +0800298acpi_status __init acpi_find_root_pointer(acpi_size *rsdp_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Bob Mooref3d2e782007-02-02 19:48:18 +0300300acpi_status acpi_unload_table_id(acpi_owner_id id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300303acpi_get_table_header(acpi_string signature,
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000304 u32 instance, struct acpi_table_header *out_table_header);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306acpi_status
Yinghai Lu7d972772009-02-07 15:39:41 -0800307acpi_get_table_with_size(acpi_string signature,
308 u32 instance, struct acpi_table_header **out_table,
309 acpi_size *tbl_size);
Lv Zhengcd27d792013-10-29 09:30:22 +0800310
Yinghai Lu7d972772009-02-07 15:39:41 -0800311acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300312acpi_get_table(acpi_string signature,
Bob Moore67a119f2008-06-10 13:42:13 +0800313 u32 instance, struct acpi_table_header **out_table);
Bob Mooref3d2e782007-02-02 19:48:18 +0300314
315acpi_status
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000316acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Lin Ming3e08e2d2008-04-10 19:06:38 +0400318acpi_status
Lv Zhengb43e1062013-01-12 15:29:38 +0000319acpi_install_table_handler(acpi_table_handler handler, void *context);
Lin Ming3e08e2d2008-04-10 19:06:38 +0400320
Lv Zhengb43e1062013-01-12 15:29:38 +0000321acpi_status acpi_remove_table_handler(acpi_table_handler handler);
Lin Ming3e08e2d2008-04-10 19:06:38 +0400322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323/*
324 * Namespace and name interfaces
325 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400327acpi_walk_namespace(acpi_object_type type,
328 acpi_handle start_object,
329 u32 max_depth,
Bob Moore4ef17502013-08-08 15:30:05 +0800330 acpi_walk_callback descending_callback,
331 acpi_walk_callback ascending_callback,
Len Brown4be44fc2005-08-05 00:44:28 -0400332 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
334acpi_status
Al Viro70b30fb2007-08-21 16:18:20 +0100335acpi_get_devices(const char *HID,
Len Brown4be44fc2005-08-05 00:44:28 -0400336 acpi_walk_callback user_function,
337 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800340acpi_get_name(acpi_handle object,
Len Brown4be44fc2005-08-05 00:44:28 -0400341 u32 name_type, struct acpi_buffer *ret_path_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
343acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400344acpi_get_handle(acpi_handle parent,
345 acpi_string pathname, acpi_handle * ret_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800348acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
349
350acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352acpi_status
Rafael J. Wysocki7c2e1772014-02-04 00:42:46 +0100353acpi_get_data_full(acpi_handle object, acpi_object_handler handler, void **data,
354 void (*callback)(void *));
355
356acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800357acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Bob Moore50eca3e2005-09-30 19:03:00 -0400359acpi_status
360acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362/*
363 * Object manipulation and enumeration
364 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400366acpi_evaluate_object(acpi_handle object,
367 acpi_string pathname,
368 struct acpi_object_list *parameter_objects,
369 struct acpi_buffer *return_object_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400372acpi_evaluate_object_typed(acpi_handle object,
373 acpi_string pathname,
374 struct acpi_object_list *external_params,
375 struct acpi_buffer *return_buffer,
376 acpi_object_type return_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800379acpi_get_object_info(acpi_handle object,
Bob Moore15b8dd52009-06-29 13:39:29 +0800380 struct acpi_device_info **return_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Lin Mingb2f7ddc2009-05-21 10:42:09 +0800382acpi_status acpi_install_method(u8 *buffer);
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400385acpi_get_next_object(acpi_object_type type,
386 acpi_handle parent,
387 acpi_handle child, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Len Brown4be44fc2005-08-05 00:44:28 -0400389acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
John Keller0f0fe1a2006-12-19 12:56:19 -0800391acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
392
Len Brown4be44fc2005-08-05 00:44:28 -0400393acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395/*
Bob Mooreecfbbc72008-12-31 02:55:32 +0800396 * Handler interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398acpi_status
Bob Mooreecfbbc72008-12-31 02:55:32 +0800399acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
400
Bob Moore33620c52012-02-14 18:14:27 +0800401ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
Lv Zhenga2fd4b42013-09-23 09:52:05 +0800402 acpi_install_sci_handler(acpi_sci_handler
403 address,
404 void *context))
405ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
406 acpi_remove_sci_handler(acpi_sci_handler
407 address))
408ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
409 acpi_install_global_event_handler
410 (acpi_gbl_event_handler handler,
411 void *context))
Bob Moore33620c52012-02-14 18:14:27 +0800412ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
413 acpi_install_fixed_event_handler(u32
414 acpi_event,
415 acpi_event_handler
416 handler,
417 void
418 *context))
419ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
420 acpi_remove_fixed_event_handler(u32 acpi_event,
421 acpi_event_handler
422 handler))
423ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
424 acpi_install_gpe_handler(acpi_handle
425 gpe_device,
426 u32 gpe_number,
427 u32 type,
428 acpi_gpe_handler
429 address,
430 void *context))
431ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
432 acpi_remove_gpe_handler(acpi_handle gpe_device,
433 u32 gpe_number,
434 acpi_gpe_handler
435 address))
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000436acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
Lv Zhenged606942014-01-08 13:44:56 +0800437 acpi_notify_handler handler,
438 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
440acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400441acpi_remove_notify_handler(acpi_handle device,
442 u32 handler_type, acpi_notify_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
444acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400445acpi_install_address_space_handler(acpi_handle device,
446 acpi_adr_space_type space_id,
447 acpi_adr_space_handler handler,
448 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400451acpi_remove_address_space_handler(acpi_handle device,
452 acpi_adr_space_type space_id,
453 acpi_adr_space_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400456acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457#endif
458
Lin Mingb0ed7a92010-08-06 09:35:51 +0800459acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461/*
Lin Mingffef6822011-11-16 11:08:30 +0800462 * Global Lock interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 */
Bob Moore33620c52012-02-14 18:14:27 +0800464ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
465 acpi_acquire_global_lock(u16 timeout,
466 u32 *handle))
Lv Zhengcd27d792013-10-29 09:30:22 +0800467
Bob Moore33620c52012-02-14 18:14:27 +0800468ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
469 acpi_release_global_lock(u32 handle))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Lin Mingffef6822011-11-16 11:08:30 +0800471/*
472 * Interfaces to AML mutex objects
473 */
474acpi_status
475acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
476
477acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
478
479/*
480 * Fixed Event interfaces
481 */
Bob Moore33620c52012-02-14 18:14:27 +0800482ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
483 acpi_enable_event(u32 event, u32 flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Bob Moore33620c52012-02-14 18:14:27 +0800485ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
486 acpi_disable_event(u32 event, u32 flags))
Bob Moore33620c52012-02-14 18:14:27 +0800487ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Bob Moore33620c52012-02-14 18:14:27 +0800489ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
490 acpi_get_event_status(u32 event,
491 acpi_event_status
492 *event_status))
Lv Zhengcd27d792013-10-29 09:30:22 +0800493
Bob Moore08ac07b2008-12-30 09:55:48 +0800494/*
Lin Mingffef6822011-11-16 11:08:30 +0800495 * General Purpose Event (GPE) Interfaces
Bob Moore08ac07b2008-12-30 09:55:48 +0800496 */
Bob Moore33620c52012-02-14 18:14:27 +0800497ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
Len Brown4be44fc2005-08-05 00:44:28 -0400498
Bob Moore33620c52012-02-14 18:14:27 +0800499ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
500 acpi_enable_gpe(acpi_handle gpe_device,
501 u32 gpe_number))
Len Brown4be44fc2005-08-05 00:44:28 -0400502
Bob Moore33620c52012-02-14 18:14:27 +0800503ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
504 acpi_disable_gpe(acpi_handle gpe_device,
505 u32 gpe_number))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Bob Moore33620c52012-02-14 18:14:27 +0800507ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
508 acpi_clear_gpe(acpi_handle gpe_device,
509 u32 gpe_number))
Lin Mingbba63a22010-12-13 13:39:17 +0800510
Bob Moore33620c52012-02-14 18:14:27 +0800511ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
512 acpi_set_gpe(acpi_handle gpe_device,
513 u32 gpe_number, u8 action))
Rafael J. Wysockie8b6f972010-06-25 01:18:39 +0200514
Bob Moore33620c52012-02-14 18:14:27 +0800515ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
516 acpi_finish_gpe(acpi_handle gpe_device,
517 u32 gpe_number))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Bob Moore33620c52012-02-14 18:14:27 +0800519ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
520 acpi_setup_gpe_for_wake(acpi_handle
521 parent_device,
522 acpi_handle gpe_device,
523 u32 gpe_number))
524ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
525 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
526 u32 gpe_number,
527 u8 action))
528ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
529 acpi_get_gpe_status(acpi_handle gpe_device,
530 u32 gpe_number,
531 acpi_event_status
532 *event_status))
Bob Moore33620c52012-02-14 18:14:27 +0800533ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
Bob Moore33620c52012-02-14 18:14:27 +0800534ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
Bob Mooree97d6bf2008-12-30 09:45:17 +0800535
Bob Moore33620c52012-02-14 18:14:27 +0800536ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
537 acpi_get_gpe_device(u32 gpe_index,
538 acpi_handle * gpe_device))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Bob Moore33620c52012-02-14 18:14:27 +0800540ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
541 acpi_install_gpe_block(acpi_handle gpe_device,
542 struct
543 acpi_generic_address
544 *gpe_block_address,
545 u32 register_count,
546 u32 interrupt_number))
547ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
548 acpi_remove_gpe_block(acpi_handle gpe_device))
Rafael J. Wysockia2100802010-09-16 00:30:43 +0200549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550/*
551 * Resource interfaces
552 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553typedef
Bob Moore616861242006-03-17 16:44:00 -0500554acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
Len Brown4be44fc2005-08-05 00:44:28 -0400555 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
557acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800558acpi_get_vendor_resource(acpi_handle device,
Bob Moorec51a4de2005-11-17 13:07:00 -0500559 char *name,
560 struct acpi_vendor_uuid *uuid,
561 struct acpi_buffer *ret_buffer);
562
563acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800564acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566#ifdef ACPI_FUTURE_USAGE
567acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800568acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569#endif
570
571acpi_status
Bob Moorea91cdde22011-11-16 14:46:57 +0800572acpi_get_event_resources(acpi_handle device_handle,
573 struct acpi_buffer *ret_buffer);
574
575acpi_status
Bob Mooreafb1bbe2012-12-31 00:03:58 +0000576acpi_walk_resource_buffer(struct acpi_buffer *buffer,
577 acpi_walk_resource_callback user_function,
578 void *context);
579
580acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800581acpi_walk_resources(acpi_handle device,
Bob Moorec51a4de2005-11-17 13:07:00 -0500582 char *name,
Bob Moore616861242006-03-17 16:44:00 -0500583 acpi_walk_resource_callback user_function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
585acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800586acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588acpi_status
Bob Mooreb47cf582010-04-27 11:54:40 +0800589acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
591acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400592acpi_resource_to_address64(struct acpi_resource *resource,
593 struct acpi_resource_address64 *out);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Bob Moore0e243172011-11-16 14:51:01 +0800595acpi_status
596acpi_buffer_to_resource(u8 *aml_buffer,
597 u16 aml_buffer_length,
598 struct acpi_resource **resource_ptr);
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/*
601 * Hardware (ACPI device) interfaces
602 */
Bob Moored3fd9022008-12-30 11:11:57 +0800603acpi_status acpi_reset(void);
604
Lv Zheng739dcbb2012-12-20 01:07:26 +0000605acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
606
607acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
608
Bob Moore33620c52012-02-14 18:14:27 +0800609ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
610 acpi_read_bit_register(u32 register_id,
611 u32 *return_value))
Len Brown4be44fc2005-08-05 00:44:28 -0400612
Bob Moore33620c52012-02-14 18:14:27 +0800613ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
614 acpi_write_bit_register(u32 register_id,
615 u32 value))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Bob Moore33620c52012-02-14 18:14:27 +0800617/*
618 * Sleep/Wake interfaces
619 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620acpi_status
Lv Zhengcd27d792013-10-29 09:30:22 +0800621acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Len Brown4be44fc2005-08-05 00:44:28 -0400623acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Lv Zheng40bce102013-10-31 09:31:18 +0800625acpi_status acpi_enter_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Lv Zheng40bce102013-10-31 09:31:18 +0800627ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Len Brown3f6f49c2012-07-26 20:08:54 -0400629acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100630
Len Brown4be44fc2005-08-05 00:44:28 -0400631acpi_status acpi_leave_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Lv Zheng739dcbb2012-12-20 01:07:26 +0000633ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
634 acpi_set_firmware_waking_vector(u32
635 physical_address))
Lv Zheng739dcbb2012-12-20 01:07:26 +0000636#if ACPI_MACHINE_WIDTH == 64
637ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
638 acpi_set_firmware_waking_vector64(u64
639 physical_address))
640#endif
Bob Moore50df4d82008-12-31 03:01:23 +0800641/*
Bob Moored08310f2012-02-14 15:22:51 +0800642 * ACPI Timer interfaces
643 */
644#ifdef ACPI_FUTURE_USAGE
Bob Moore33620c52012-02-14 18:14:27 +0800645ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
646 acpi_get_timer_resolution(u32 *resolution))
Bob Moore33620c52012-02-14 18:14:27 +0800647ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
Bob Moored08310f2012-02-14 15:22:51 +0800648
Bob Moore33620c52012-02-14 18:14:27 +0800649ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
650 acpi_get_timer_duration(u32 start_ticks,
651 u32 end_ticks,
652 u32 *time_elapsed))
Bob Moored08310f2012-02-14 15:22:51 +0800653#endif /* ACPI_FUTURE_USAGE */
654
655/*
Bob Mooreb74be612009-04-22 10:20:23 +0800656 * Error/Warning output
Bob Moore50df4d82008-12-31 03:01:23 +0800657 */
Lv Zheng4506bf22013-10-29 09:30:16 +0800658ACPI_PRINTF_LIKE(3)
Bob Moore50df4d82008-12-31 03:01:23 +0800659void ACPI_INTERNAL_VAR_XFACE
Lv Zheng4506bf22013-10-29 09:30:16 +0800660acpi_error(const char *module_name, u32 line_number, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800661
Lv Zheng4506bf22013-10-29 09:30:16 +0800662ACPI_PRINTF_LIKE(4)
Bob Moore50df4d82008-12-31 03:01:23 +0800663void ACPI_INTERNAL_VAR_XFACE
664acpi_exception(const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800665 u32 line_number, acpi_status status, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800666
Lv Zheng4506bf22013-10-29 09:30:16 +0800667ACPI_PRINTF_LIKE(3)
Bob Moore50df4d82008-12-31 03:01:23 +0800668void ACPI_INTERNAL_VAR_XFACE
Lv Zheng4506bf22013-10-29 09:30:16 +0800669acpi_warning(const char *module_name, u32 line_number, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800670
Lv Zheng4506bf22013-10-29 09:30:16 +0800671ACPI_PRINTF_LIKE(3)
Bob Moore50df4d82008-12-31 03:01:23 +0800672void ACPI_INTERNAL_VAR_XFACE
Lv Zheng4506bf22013-10-29 09:30:16 +0800673acpi_info(const char *module_name, u32 line_number, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800674
Lv Zheng4506bf22013-10-29 09:30:16 +0800675ACPI_PRINTF_LIKE(3)
Bob Moore62cdd142012-07-16 09:25:27 +0800676void ACPI_INTERNAL_VAR_XFACE
677acpi_bios_error(const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800678 u32 line_number, const char *format, ...);
Bob Moore62cdd142012-07-16 09:25:27 +0800679
Lv Zheng4506bf22013-10-29 09:30:16 +0800680ACPI_PRINTF_LIKE(3)
Bob Moore62cdd142012-07-16 09:25:27 +0800681void ACPI_INTERNAL_VAR_XFACE
682acpi_bios_warning(const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800683 u32 line_number, const char *format, ...);
Bob Moore62cdd142012-07-16 09:25:27 +0800684
Bob Mooreb74be612009-04-22 10:20:23 +0800685/*
686 * Debug output
687 */
Bob Moore50df4d82008-12-31 03:01:23 +0800688#ifdef ACPI_DEBUG_OUTPUT
689
Lv Zheng4506bf22013-10-29 09:30:16 +0800690ACPI_PRINTF_LIKE(6)
Bob Moore50df4d82008-12-31 03:01:23 +0800691void ACPI_INTERNAL_VAR_XFACE
692acpi_debug_print(u32 requested_debug_level,
693 u32 line_number,
694 const char *function_name,
695 const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800696 u32 component_id, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800697
Lv Zheng4506bf22013-10-29 09:30:16 +0800698ACPI_PRINTF_LIKE(6)
Bob Moore50df4d82008-12-31 03:01:23 +0800699void ACPI_INTERNAL_VAR_XFACE
700acpi_debug_print_raw(u32 requested_debug_level,
701 u32 line_number,
702 const char *function_name,
703 const char *module_name,
Lv Zheng4506bf22013-10-29 09:30:16 +0800704 u32 component_id, const char *format, ...);
Bob Moore50df4d82008-12-31 03:01:23 +0800705#endif
706
Len Brown4be44fc2005-08-05 00:44:28 -0400707#endif /* __ACXFACE_H__ */