1
2/******************************************************************************
3 *
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2007, R. Byron Moore
10 * 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
45#ifndef __ACXFACE_H__
46#define __ACXFACE_H__
47
48#include "actypes.h"
49#include "actbl.h"
50
51/*
52 * Global interfaces
53 */
54acpi_status
55acpi_initialize_tables(struct acpi_table_desc *initial_storage,
56		       u32 initial_table_count, u8 allow_resize);
57
58acpi_status __init acpi_initialize_subsystem(void);
59
60acpi_status acpi_enable_subsystem(u32 flags);
61
62acpi_status acpi_initialize_objects(u32 flags);
63
64acpi_status acpi_terminate(void);
65
66#ifdef ACPI_FUTURE_USAGE
67acpi_status acpi_subsystem_status(void);
68#endif
69
70acpi_status acpi_enable(void);
71
72acpi_status acpi_disable(void);
73
74#ifdef ACPI_FUTURE_USAGE
75acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
76#endif
77
78const char *acpi_format_exception(acpi_status exception);
79
80acpi_status acpi_purge_cached_objects(void);
81
82#ifdef ACPI_FUTURE_USAGE
83acpi_status
84acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
85#endif
86
87/*
88 * ACPI Memory managment
89 */
90void *acpi_allocate(u32 size);
91
92void *acpi_callocate(u32 size);
93
94void acpi_free(void *address);
95
96/*
97 * ACPI table manipulation interfaces
98 */
99acpi_status acpi_reallocate_root_table(void);
100
101acpi_status acpi_find_root_pointer(acpi_native_uint * rsdp_address);
102
103acpi_status acpi_load_tables(void);
104
105acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
106
107acpi_status acpi_unload_table_id(acpi_owner_id id);
108
109acpi_status
110acpi_get_table_header(acpi_string signature,
111		      acpi_native_uint instance,
112		      struct acpi_table_header *out_table_header);
113
114acpi_status
115acpi_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);
121
122/*
123 * Namespace and name interfaces
124 */
125acpi_status
126acpi_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);
131
132acpi_status
133acpi_get_devices(char *HID,
134		 acpi_walk_callback user_function,
135		 void *context, void **return_value);
136
137acpi_status
138acpi_get_name(acpi_handle handle,
139	      u32 name_type, struct acpi_buffer *ret_path_ptr);
140
141acpi_status
142acpi_get_handle(acpi_handle parent,
143		acpi_string pathname, acpi_handle * ret_handle);
144
145acpi_status
146acpi_attach_data(acpi_handle obj_handle,
147		 acpi_object_handler handler, void *data);
148
149acpi_status
150acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
151
152acpi_status
153acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
154
155acpi_status
156acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
157
158/*
159 * Object manipulation and enumeration
160 */
161acpi_status
162acpi_evaluate_object(acpi_handle object,
163		     acpi_string pathname,
164		     struct acpi_object_list *parameter_objects,
165		     struct acpi_buffer *return_object_buffer);
166
167#ifdef ACPI_FUTURE_USAGE
168acpi_status
169acpi_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);
174#endif
175
176acpi_status
177acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
178
179acpi_status
180acpi_get_next_object(acpi_object_type type,
181		     acpi_handle parent,
182		     acpi_handle child, acpi_handle * out_handle);
183
184acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
185
186acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
187
188acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
189
190/*
191 * Event handler interfaces
192 */
193acpi_status
194acpi_install_fixed_event_handler(u32 acpi_event,
195				 acpi_event_handler handler, void *context);
196
197acpi_status
198acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
199
200acpi_status
201acpi_install_notify_handler(acpi_handle device,
202			    u32 handler_type,
203			    acpi_notify_handler handler, void *context);
204
205acpi_status
206acpi_remove_notify_handler(acpi_handle device,
207			   u32 handler_type, acpi_notify_handler handler);
208
209acpi_status
210acpi_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);
214
215acpi_status
216acpi_remove_address_space_handler(acpi_handle device,
217				  acpi_adr_space_type space_id,
218				  acpi_adr_space_handler handler);
219
220acpi_status
221acpi_install_gpe_handler(acpi_handle gpe_device,
222			 u32 gpe_number,
223			 u32 type, acpi_event_handler address, void *context);
224
225#ifdef ACPI_FUTURE_USAGE
226acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
227#endif
228
229/*
230 * Event interfaces
231 */
232acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
233
234acpi_status acpi_release_global_lock(u32 handle);
235
236acpi_status
237acpi_remove_gpe_handler(acpi_handle gpe_device,
238			u32 gpe_number, acpi_event_handler address);
239
240acpi_status acpi_enable_event(u32 event, u32 flags);
241
242acpi_status acpi_disable_event(u32 event, u32 flags);
243
244acpi_status acpi_clear_event(u32 event);
245
246#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);
257
258#ifdef ACPI_FUTURE_USAGE
259acpi_status
260acpi_get_gpe_status(acpi_handle gpe_device,
261		    u32 gpe_number,
262		    u32 flags, acpi_event_status * event_status);
263#endif				/*  ACPI_FUTURE_USAGE  */
264
265acpi_status
266acpi_install_gpe_block(acpi_handle gpe_device,
267		       struct acpi_generic_address *gpe_block_address,
268		       u32 register_count, u32 interrupt_number);
269
270acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
271
272/*
273 * Resource interfaces
274 */
275typedef
276acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
277					   void *context);
278
279acpi_status
280acpi_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
286acpi_get_current_resources(acpi_handle device_handle,
287			   struct acpi_buffer *ret_buffer);
288
289#ifdef ACPI_FUTURE_USAGE
290acpi_status
291acpi_get_possible_resources(acpi_handle device_handle,
292			    struct acpi_buffer *ret_buffer);
293#endif
294
295acpi_status
296acpi_walk_resources(acpi_handle device_handle,
297		    char *name,
298		    acpi_walk_resource_callback user_function, void *context);
299
300acpi_status
301acpi_set_current_resources(acpi_handle device_handle,
302			   struct acpi_buffer *in_buffer);
303
304acpi_status
305acpi_get_irq_routing_table(acpi_handle bus_device_handle,
306			   struct acpi_buffer *ret_buffer);
307
308acpi_status
309acpi_resource_to_address64(struct acpi_resource *resource,
310			   struct acpi_resource_address64 *out);
311
312/*
313 * Hardware (ACPI device) interfaces
314 */
315acpi_status acpi_get_register(u32 register_id, u32 * return_value);
316
317acpi_status acpi_set_register(u32 register_id, u32 value);
318
319acpi_status
320acpi_set_firmware_waking_vector(acpi_physical_address physical_address);
321
322#ifdef ACPI_FUTURE_USAGE
323acpi_status
324acpi_get_firmware_waking_vector(acpi_physical_address * physical_address);
325#endif
326
327acpi_status
328acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
329
330acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
331
332acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
333
334acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
335
336acpi_status acpi_leave_sleep_state(u8 sleep_state);
337
338#endif				/* __ACXFACE_H__ */
339