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.
55 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
56 u32 initial_table_count, u8 allow_resize);
58 acpi_status acpi_initialize_subsystem(void);
60 acpi_status acpi_enable_subsystem(u32 flags);
62 acpi_status acpi_initialize_objects(u32 flags);
64 acpi_status acpi_terminate(void);
66 #ifdef ACPI_FUTURE_USAGE
67 acpi_status acpi_subsystem_status(void);
70 acpi_status acpi_enable(void);
72 acpi_status acpi_disable(void);
74 #ifdef ACPI_FUTURE_USAGE
75 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
78 const char *acpi_format_exception(acpi_status exception);
80 acpi_status acpi_purge_cached_objects(void);
82 #ifdef ACPI_FUTURE_USAGE
84 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
88 * ACPI Memory managment
90 void *acpi_allocate(u32 size);
92 void *acpi_callocate(u32 size);
94 void acpi_free(void *address);
97 * ACPI table manipulation interfaces
99 acpi_status acpi_reallocate_root_table(void);
101 acpi_status acpi_find_root_pointer(acpi_native_uint * rsdp_address);
103 acpi_status acpi_load_tables(void);
105 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
107 acpi_status acpi_unload_table_id(acpi_owner_id id);
110 acpi_get_table_header(acpi_string signature,
111 acpi_native_uint instance,
112 struct acpi_table_header **out_table_header);
115 acpi_get_table(acpi_string signature,
116 acpi_native_uint instance, struct acpi_table_header **out_table);
119 acpi_get_table_by_index(acpi_native_uint table_index,
120 struct acpi_table_header **out_table);
123 * Namespace and name interfaces
126 acpi_walk_namespace(acpi_object_type type,
127 acpi_handle start_object,
129 acpi_walk_callback user_function,
130 void *context, void **return_value);
133 acpi_get_devices(char *HID,
134 acpi_walk_callback user_function,
135 void *context, void **return_value);
138 acpi_get_name(acpi_handle handle,
139 u32 name_type, struct acpi_buffer *ret_path_ptr);
142 acpi_get_handle(acpi_handle parent,
143 acpi_string pathname, acpi_handle * ret_handle);
146 acpi_attach_data(acpi_handle obj_handle,
147 acpi_object_handler handler, void *data);
150 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
153 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
156 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
159 * Object manipulation and enumeration
162 acpi_evaluate_object(acpi_handle object,
163 acpi_string pathname,
164 struct acpi_object_list *parameter_objects,
165 struct acpi_buffer *return_object_buffer);
167 #ifdef ACPI_FUTURE_USAGE
169 acpi_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);
177 acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
180 acpi_get_next_object(acpi_object_type type,
182 acpi_handle child, acpi_handle * out_handle);
184 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
186 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
188 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
191 * Event handler interfaces
194 acpi_install_fixed_event_handler(u32 acpi_event,
195 acpi_event_handler handler, void *context);
198 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
201 acpi_install_notify_handler(acpi_handle device,
203 acpi_notify_handler handler, void *context);
206 acpi_remove_notify_handler(acpi_handle device,
207 u32 handler_type, acpi_notify_handler handler);
210 acpi_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);
216 acpi_remove_address_space_handler(acpi_handle device,
217 acpi_adr_space_type space_id,
218 acpi_adr_space_handler handler);
221 acpi_install_gpe_handler(acpi_handle gpe_device,
223 u32 type, acpi_event_handler address, void *context);
225 #ifdef ACPI_FUTURE_USAGE
226 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
232 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
234 acpi_status acpi_release_global_lock(u32 handle);
237 acpi_remove_gpe_handler(acpi_handle gpe_device,
238 u32 gpe_number, acpi_event_handler address);
240 acpi_status acpi_enable_event(u32 event, u32 flags);
242 acpi_status acpi_disable_event(u32 event, u32 flags);
244 acpi_status acpi_clear_event(u32 event);
246 #ifdef ACPI_FUTURE_USAGE
247 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
248 #endif /* ACPI_FUTURE_USAGE */
250 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
252 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
254 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
256 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
258 #ifdef ACPI_FUTURE_USAGE
260 acpi_get_gpe_status(acpi_handle gpe_device,
262 u32 flags, acpi_event_status * event_status);
263 #endif /* ACPI_FUTURE_USAGE */
266 acpi_install_gpe_block(acpi_handle gpe_device,
267 struct acpi_generic_address *gpe_block_address,
268 u32 register_count, u32 interrupt_number);
270 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
273 * Resource interfaces
276 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
280 acpi_get_vendor_resource(acpi_handle device_handle,
282 struct acpi_vendor_uuid *uuid,
283 struct acpi_buffer *ret_buffer);
286 acpi_get_current_resources(acpi_handle device_handle,
287 struct acpi_buffer *ret_buffer);
289 #ifdef ACPI_FUTURE_USAGE
291 acpi_get_possible_resources(acpi_handle device_handle,
292 struct acpi_buffer *ret_buffer);
296 acpi_walk_resources(acpi_handle device_handle,
298 acpi_walk_resource_callback user_function, void *context);
301 acpi_set_current_resources(acpi_handle device_handle,
302 struct acpi_buffer *in_buffer);
305 acpi_get_irq_routing_table(acpi_handle bus_device_handle,
306 struct acpi_buffer *ret_buffer);
309 acpi_resource_to_address64(struct acpi_resource *resource,
310 struct acpi_resource_address64 *out);
313 * Hardware (ACPI device) interfaces
315 acpi_status acpi_get_register(u32 register_id, u32 * return_value);
317 acpi_status acpi_set_register(u32 register_id, u32 value);
320 acpi_set_firmware_waking_vector(acpi_physical_address physical_address);
322 #ifdef ACPI_FUTURE_USAGE
324 acpi_get_firmware_waking_vector(acpi_physical_address * physical_address);
328 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
330 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
332 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
334 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
336 acpi_status acpi_leave_sleep_state(u8 sleep_state);
338 #endif /* __ACXFACE_H__ */