2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
54 acpi_status acpi_initialize_subsystem(void);
56 acpi_status acpi_enable_subsystem(u32 flags);
58 acpi_status acpi_initialize_objects(u32 flags);
60 acpi_status acpi_terminate(void);
62 #ifdef ACPI_FUTURE_USAGE
63 acpi_status acpi_subsystem_status(void);
66 acpi_status acpi_enable(void);
68 acpi_status acpi_disable(void);
70 #ifdef ACPI_FUTURE_USAGE
71 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
74 const char *acpi_format_exception(acpi_status exception);
76 acpi_status acpi_purge_cached_objects(void);
78 #ifdef ACPI_FUTURE_USAGE
80 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
84 * ACPI Memory managment
86 void *acpi_allocate(u32 size);
88 void *acpi_callocate(u32 size);
90 void acpi_free(void *address);
93 * ACPI table manipulation interfaces
96 acpi_find_root_pointer(u32 flags, struct acpi_pointer *rsdp_address);
98 acpi_status acpi_load_tables(void);
100 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
102 acpi_status acpi_unload_table_id(acpi_table_type table_type, acpi_owner_id id);
104 #ifdef ACPI_FUTURE_USAGE
105 acpi_status acpi_unload_table(acpi_table_type table_type);
107 acpi_get_table_header(acpi_table_type table_type,
108 u32 instance, struct acpi_table_header *out_table_header);
109 #endif /* ACPI_FUTURE_USAGE */
112 acpi_get_table(acpi_table_type table_type,
113 u32 instance, struct acpi_buffer *ret_buffer);
116 acpi_get_firmware_table(acpi_string signature,
118 u32 flags, struct acpi_table_header **table_pointer);
121 * Namespace and name interfaces
124 acpi_walk_namespace(acpi_object_type type,
125 acpi_handle start_object,
127 acpi_walk_callback user_function,
128 void *context, void **return_value);
131 acpi_get_devices(char *HID,
132 acpi_walk_callback user_function,
133 void *context, void **return_value);
136 acpi_get_name(acpi_handle handle,
137 u32 name_type, struct acpi_buffer *ret_path_ptr);
140 acpi_get_handle(acpi_handle parent,
141 acpi_string pathname, acpi_handle * ret_handle);
144 acpi_attach_data(acpi_handle obj_handle,
145 acpi_object_handler handler, void *data);
148 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
151 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
154 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
157 * Object manipulation and enumeration
160 acpi_evaluate_object(acpi_handle object,
161 acpi_string pathname,
162 struct acpi_object_list *parameter_objects,
163 struct acpi_buffer *return_object_buffer);
165 #ifdef ACPI_FUTURE_USAGE
167 acpi_evaluate_object_typed(acpi_handle object,
168 acpi_string pathname,
169 struct acpi_object_list *external_params,
170 struct acpi_buffer *return_buffer,
171 acpi_object_type return_type);
175 acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
178 acpi_get_next_object(acpi_object_type type,
180 acpi_handle child, acpi_handle * out_handle);
182 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
184 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
186 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
189 * Event handler interfaces
192 acpi_install_fixed_event_handler(u32 acpi_event,
193 acpi_event_handler handler, void *context);
196 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
199 acpi_install_notify_handler(acpi_handle device,
201 acpi_notify_handler handler, void *context);
204 acpi_remove_notify_handler(acpi_handle device,
205 u32 handler_type, acpi_notify_handler handler);
208 acpi_install_address_space_handler(acpi_handle device,
209 acpi_adr_space_type space_id,
210 acpi_adr_space_handler handler,
211 acpi_adr_space_setup setup, void *context);
214 acpi_remove_address_space_handler(acpi_handle device,
215 acpi_adr_space_type space_id,
216 acpi_adr_space_handler handler);
219 acpi_install_gpe_handler(acpi_handle gpe_device,
221 u32 type, acpi_event_handler address, void *context);
223 #ifdef ACPI_FUTURE_USAGE
224 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
230 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
232 acpi_status acpi_release_global_lock(u32 handle);
235 acpi_remove_gpe_handler(acpi_handle gpe_device,
236 u32 gpe_number, acpi_event_handler address);
238 acpi_status acpi_enable_event(u32 event, u32 flags);
240 acpi_status acpi_disable_event(u32 event, u32 flags);
242 acpi_status acpi_clear_event(u32 event);
244 #ifdef ACPI_FUTURE_USAGE
245 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
246 #endif /* ACPI_FUTURE_USAGE */
248 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
250 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
252 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
254 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
256 #ifdef ACPI_FUTURE_USAGE
258 acpi_get_gpe_status(acpi_handle gpe_device,
260 u32 flags, acpi_event_status * event_status);
261 #endif /* ACPI_FUTURE_USAGE */
264 acpi_install_gpe_block(acpi_handle gpe_device,
265 struct acpi_generic_address *gpe_block_address,
266 u32 register_count, u32 interrupt_number);
268 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
271 * Resource interfaces
274 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
278 acpi_get_vendor_resource(acpi_handle device_handle,
280 struct acpi_vendor_uuid *uuid,
281 struct acpi_buffer *ret_buffer);
284 acpi_get_current_resources(acpi_handle device_handle,
285 struct acpi_buffer *ret_buffer);
287 #ifdef ACPI_FUTURE_USAGE
289 acpi_get_possible_resources(acpi_handle device_handle,
290 struct acpi_buffer *ret_buffer);
294 acpi_walk_resources(acpi_handle device_handle,
296 acpi_walk_resource_callback user_function, void *context);
299 acpi_set_current_resources(acpi_handle device_handle,
300 struct acpi_buffer *in_buffer);
303 acpi_get_irq_routing_table(acpi_handle bus_device_handle,
304 struct acpi_buffer *ret_buffer);
307 acpi_resource_to_address64(struct acpi_resource *resource,
308 struct acpi_resource_address64 *out);
311 * Hardware (ACPI device) interfaces
313 acpi_status acpi_get_register(u32 register_id, u32 * return_value, u32 flags);
315 acpi_status acpi_set_register(u32 register_id, u32 value, u32 flags);
318 acpi_set_firmware_waking_vector(acpi_physical_address physical_address);
320 #ifdef ACPI_FUTURE_USAGE
322 acpi_get_firmware_waking_vector(acpi_physical_address * physical_address);
326 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
328 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
330 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
332 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
334 acpi_status acpi_leave_sleep_state(u8 sleep_state);
336 #endif /* __ACXFACE_H__ */