blob: d970f7f99549639183b73d8324043c2805020dd5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2/******************************************************************************
3 *
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *
6 *****************************************************************************/
7
8/*
Bob Moore6c9deb72007-02-02 19:48:24 +03009 * Copyright (C) 2000 - 2007, R. Byron Moore
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
30 *
31 * NO WARRANTY
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
43 */
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifndef __ACXFACE_H__
46#define __ACXFACE_H__
47
48#include "actypes.h"
49#include "actbl.h"
50
Robert Moore44f6c012005-04-18 22:49:35 -040051/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * Global interfaces
53 */
Bob Mooref3d2e782007-02-02 19:48:18 +030054acpi_status
55acpi_initialize_tables(struct acpi_table_desc *initial_storage,
56 u32 initial_table_count, u8 allow_resize);
57
Len Browndd272b52007-05-30 00:26:11 -040058acpi_status __init acpi_initialize_subsystem(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Len Brown4be44fc2005-08-05 00:44:28 -040060acpi_status acpi_enable_subsystem(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Len Brown4be44fc2005-08-05 00:44:28 -040062acpi_status acpi_initialize_objects(u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Len Brown4be44fc2005-08-05 00:44:28 -040064acpi_status acpi_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -040067acpi_status acpi_subsystem_status(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#endif
69
Len Brown4be44fc2005-08-05 00:44:28 -040070acpi_status acpi_enable(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Len Brown4be44fc2005-08-05 00:44:28 -040072acpi_status acpi_disable(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -040075acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076#endif
77
Len Brown4be44fc2005-08-05 00:44:28 -040078const char *acpi_format_exception(acpi_status exception);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Len Brown4be44fc2005-08-05 00:44:28 -040080acpi_status acpi_purge_cached_objects(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82#ifdef ACPI_FUTURE_USAGE
83acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040084acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085#endif
86
87/*
Joe Perchesaee07ba2008-02-03 17:07:16 +020088 * ACPI Memory management
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 */
Len Brown4be44fc2005-08-05 00:44:28 -040090void *acpi_allocate(u32 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Len Brown4be44fc2005-08-05 00:44:28 -040092void *acpi_callocate(u32 size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Len Brown4be44fc2005-08-05 00:44:28 -040094void acpi_free(void *address);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96/*
97 * ACPI table manipulation interfaces
98 */
Bob Mooref3d2e782007-02-02 19:48:18 +030099acpi_status acpi_reallocate_root_table(void);
100
101acpi_status acpi_find_root_pointer(acpi_native_uint * rsdp_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Len Brown4be44fc2005-08-05 00:44:28 -0400103acpi_status acpi_load_tables(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Len Brown4be44fc2005-08-05 00:44:28 -0400105acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
106
Bob Mooref3d2e782007-02-02 19:48:18 +0300107acpi_status acpi_unload_table_id(acpi_owner_id id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300110acpi_get_table_header(acpi_string signature,
111 acpi_native_uint instance,
Alexey Starikovskiy428f2112007-02-02 19:48:22 +0300112 struct acpi_table_header *out_table_header);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300115acpi_get_table(acpi_string signature,
116 acpi_native_uint instance, struct acpi_table_header **out_table);
117
118acpi_status
119acpi_get_table_by_index(acpi_native_uint table_index,
120 struct acpi_table_header **out_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122/*
123 * Namespace and name interfaces
124 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400126acpi_walk_namespace(acpi_object_type type,
127 acpi_handle start_object,
128 u32 max_depth,
129 acpi_walk_callback user_function,
130 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132acpi_status
Al Viro70b30fb2007-08-21 16:18:20 +0100133acpi_get_devices(const char *HID,
Len Brown4be44fc2005-08-05 00:44:28 -0400134 acpi_walk_callback user_function,
135 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400138acpi_get_name(acpi_handle handle,
139 u32 name_type, struct acpi_buffer *ret_path_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400142acpi_get_handle(acpi_handle parent,
143 acpi_string pathname, acpi_handle * ret_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400146acpi_attach_data(acpi_handle obj_handle,
147 acpi_object_handler handler, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400150acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400153acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Bob Moore50eca3e2005-09-30 19:03:00 -0400155acpi_status
156acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158/*
159 * Object manipulation and enumeration
160 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400162acpi_evaluate_object(acpi_handle object,
163 acpi_string pathname,
164 struct acpi_object_list *parameter_objects,
165 struct acpi_buffer *return_object_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167#ifdef ACPI_FUTURE_USAGE
168acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400169acpi_evaluate_object_typed(acpi_handle object,
170 acpi_string pathname,
171 struct acpi_object_list *external_params,
172 struct acpi_buffer *return_buffer,
173 acpi_object_type return_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174#endif
175
176acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400177acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400180acpi_get_next_object(acpi_object_type type,
181 acpi_handle parent,
182 acpi_handle child, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Len Brown4be44fc2005-08-05 00:44:28 -0400184acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
John Keller0f0fe1a2006-12-19 12:56:19 -0800186acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
187
Len Brown4be44fc2005-08-05 00:44:28 -0400188acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190/*
191 * Event handler interfaces
192 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400194acpi_install_fixed_event_handler(u32 acpi_event,
195 acpi_event_handler handler, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400198acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400201acpi_install_notify_handler(acpi_handle device,
202 u32 handler_type,
203 acpi_notify_handler handler, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400206acpi_remove_notify_handler(acpi_handle device,
207 u32 handler_type, acpi_notify_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400210acpi_install_address_space_handler(acpi_handle device,
211 acpi_adr_space_type space_id,
212 acpi_adr_space_handler handler,
213 acpi_adr_space_setup setup, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
215acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400216acpi_remove_address_space_handler(acpi_handle device,
217 acpi_adr_space_type space_id,
218 acpi_adr_space_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400221acpi_install_gpe_handler(acpi_handle gpe_device,
222 u32 gpe_number,
223 u32 type, acpi_event_handler address, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400226acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#endif
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229/*
230 * Event interfaces
231 */
Len Brown4be44fc2005-08-05 00:44:28 -0400232acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
233
234acpi_status acpi_release_global_lock(u32 handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400237acpi_remove_gpe_handler(acpi_handle gpe_device,
238 u32 gpe_number, acpi_event_handler address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Len Brown4be44fc2005-08-05 00:44:28 -0400240acpi_status acpi_enable_event(u32 event, u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Len Brown4be44fc2005-08-05 00:44:28 -0400242acpi_status acpi_disable_event(u32 event, u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Len Brown4be44fc2005-08-05 00:44:28 -0400244acpi_status acpi_clear_event(u32 event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Len Brown4be44fc2005-08-05 00:44:28 -0400246#ifdef ACPI_FUTURE_USAGE
247acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
248#endif /* ACPI_FUTURE_USAGE */
249
250acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
251
252acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
253
254acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
255
256acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258#ifdef ACPI_FUTURE_USAGE
259acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400260acpi_get_gpe_status(acpi_handle gpe_device,
261 u32 gpe_number,
262 u32 flags, acpi_event_status * event_status);
263#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
265acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400266acpi_install_gpe_block(acpi_handle gpe_device,
267 struct acpi_generic_address *gpe_block_address,
268 u32 register_count, u32 interrupt_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Len Brown4be44fc2005-08-05 00:44:28 -0400270acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272/*
273 * Resource interfaces
274 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275typedef
Bob Moore616861242006-03-17 16:44:00 -0500276acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
Len Brown4be44fc2005-08-05 00:44:28 -0400277 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279acpi_status
Bob Moorec51a4de2005-11-17 13:07:00 -0500280acpi_get_vendor_resource(acpi_handle device_handle,
281 char *name,
282 struct acpi_vendor_uuid *uuid,
283 struct acpi_buffer *ret_buffer);
284
285acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400286acpi_get_current_resources(acpi_handle device_handle,
287 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289#ifdef ACPI_FUTURE_USAGE
290acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400291acpi_get_possible_resources(acpi_handle device_handle,
292 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293#endif
294
295acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400296acpi_walk_resources(acpi_handle device_handle,
Bob Moorec51a4de2005-11-17 13:07:00 -0500297 char *name,
Bob Moore616861242006-03-17 16:44:00 -0500298 acpi_walk_resource_callback user_function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
300acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400301acpi_set_current_resources(acpi_handle device_handle,
302 struct acpi_buffer *in_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400305acpi_get_irq_routing_table(acpi_handle bus_device_handle,
306 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
308acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400309acpi_resource_to_address64(struct acpi_resource *resource,
310 struct acpi_resource_address64 *out);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312/*
313 * Hardware (ACPI device) interfaces
314 */
Bob Moored8c71b62007-02-02 19:48:21 +0300315acpi_status acpi_get_register(u32 register_id, u32 * return_value);
Len Brown4be44fc2005-08-05 00:44:28 -0400316
Alexey Starikovskiy2d571b32007-09-30 22:39:42 +0400317acpi_status acpi_get_register_unlocked(u32 register_id, u32 *return_value);
318
Bob Moored8c71b62007-02-02 19:48:21 +0300319acpi_status acpi_set_register(u32 register_id, u32 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
321acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400322acpi_set_firmware_waking_vector(acpi_physical_address physical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324#ifdef ACPI_FUTURE_USAGE
325acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400326acpi_get_firmware_waking_vector(acpi_physical_address * physical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327#endif
328
329acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400330acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Len Brown4be44fc2005-08-05 00:44:28 -0400332acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Len Brown4be44fc2005-08-05 00:44:28 -0400334acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Len Brown4be44fc2005-08-05 00:44:28 -0400336acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100338acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
339
Len Brown4be44fc2005-08-05 00:44:28 -0400340acpi_status acpi_leave_sleep_state(u8 sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
Len Brown4be44fc2005-08-05 00:44:28 -0400342#endif /* __ACXFACE_H__ */