2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
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.
51 extern u8 acpi_gbl_permanent_mmap;
57 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
58 u32 initial_table_count, u8 allow_resize);
60 acpi_status __init acpi_initialize_subsystem(void);
62 acpi_status acpi_enable_subsystem(u32 flags);
64 acpi_status acpi_initialize_objects(u32 flags);
66 acpi_status acpi_terminate(void);
68 #ifdef ACPI_FUTURE_USAGE
69 acpi_status acpi_subsystem_status(void);
72 acpi_status acpi_enable(void);
74 acpi_status acpi_disable(void);
76 #ifdef ACPI_FUTURE_USAGE
77 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
80 const char *acpi_format_exception(acpi_status exception);
82 acpi_status acpi_purge_cached_objects(void);
84 #ifdef ACPI_FUTURE_USAGE
86 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
90 * ACPI Memory management
92 void *acpi_allocate(u32 size);
94 void *acpi_callocate(u32 size);
96 void acpi_free(void *address);
99 * ACPI table manipulation interfaces
101 acpi_status acpi_reallocate_root_table(void);
103 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
105 acpi_status acpi_load_tables(void);
107 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
109 acpi_status acpi_unload_table_id(acpi_owner_id id);
112 acpi_get_table_header(acpi_string signature,
114 struct acpi_table_header *out_table_header);
117 acpi_get_table(acpi_string signature,
118 u32 instance, struct acpi_table_header **out_table);
121 acpi_get_table_by_index(u32 table_index,
122 struct acpi_table_header **out_table);
125 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
127 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
130 * Namespace and name interfaces
133 acpi_walk_namespace(acpi_object_type type,
134 acpi_handle start_object,
136 acpi_walk_callback user_function,
137 void *context, void **return_value);
140 acpi_get_devices(const char *HID,
141 acpi_walk_callback user_function,
142 void *context, void **return_value);
145 acpi_get_name(acpi_handle handle,
146 u32 name_type, struct acpi_buffer *ret_path_ptr);
149 acpi_get_handle(acpi_handle parent,
150 acpi_string pathname, acpi_handle * ret_handle);
153 acpi_attach_data(acpi_handle obj_handle,
154 acpi_object_handler handler, void *data);
157 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
160 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
163 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
166 * Object manipulation and enumeration
169 acpi_evaluate_object(acpi_handle object,
170 acpi_string pathname,
171 struct acpi_object_list *parameter_objects,
172 struct acpi_buffer *return_object_buffer);
174 #ifdef ACPI_FUTURE_USAGE
176 acpi_evaluate_object_typed(acpi_handle object,
177 acpi_string pathname,
178 struct acpi_object_list *external_params,
179 struct acpi_buffer *return_buffer,
180 acpi_object_type return_type);
184 acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
187 acpi_get_next_object(acpi_object_type type,
189 acpi_handle child, acpi_handle * out_handle);
191 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
193 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
195 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
198 * Event handler interfaces
201 acpi_install_fixed_event_handler(u32 acpi_event,
202 acpi_event_handler handler, void *context);
205 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
208 acpi_install_notify_handler(acpi_handle device,
210 acpi_notify_handler handler, void *context);
213 acpi_remove_notify_handler(acpi_handle device,
214 u32 handler_type, acpi_notify_handler handler);
217 acpi_install_address_space_handler(acpi_handle device,
218 acpi_adr_space_type space_id,
219 acpi_adr_space_handler handler,
220 acpi_adr_space_setup setup, void *context);
223 acpi_remove_address_space_handler(acpi_handle device,
224 acpi_adr_space_type space_id,
225 acpi_adr_space_handler handler);
228 acpi_install_gpe_handler(acpi_handle gpe_device,
230 u32 type, acpi_event_handler address, void *context);
232 #ifdef ACPI_FUTURE_USAGE
233 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
239 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
241 acpi_status acpi_release_global_lock(u32 handle);
244 acpi_remove_gpe_handler(acpi_handle gpe_device,
245 u32 gpe_number, acpi_event_handler address);
247 acpi_status acpi_enable_event(u32 event, u32 flags);
249 acpi_status acpi_disable_event(u32 event, u32 flags);
251 acpi_status acpi_clear_event(u32 event);
253 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
255 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
257 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
259 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number);
261 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
264 acpi_get_gpe_status(acpi_handle gpe_device,
266 u32 flags, acpi_event_status * event_status);
269 acpi_install_gpe_block(acpi_handle gpe_device,
270 struct acpi_generic_address *gpe_block_address,
271 u32 register_count, u32 interrupt_number);
273 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
276 * Resource interfaces
279 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
283 acpi_get_vendor_resource(acpi_handle device_handle,
285 struct acpi_vendor_uuid *uuid,
286 struct acpi_buffer *ret_buffer);
289 acpi_get_current_resources(acpi_handle device_handle,
290 struct acpi_buffer *ret_buffer);
292 #ifdef ACPI_FUTURE_USAGE
294 acpi_get_possible_resources(acpi_handle device_handle,
295 struct acpi_buffer *ret_buffer);
299 acpi_walk_resources(acpi_handle device_handle,
301 acpi_walk_resource_callback user_function, void *context);
304 acpi_set_current_resources(acpi_handle device_handle,
305 struct acpi_buffer *in_buffer);
308 acpi_get_irq_routing_table(acpi_handle bus_device_handle,
309 struct acpi_buffer *ret_buffer);
312 acpi_resource_to_address64(struct acpi_resource *resource,
313 struct acpi_resource_address64 *out);
316 * Hardware (ACPI device) interfaces
318 acpi_status acpi_get_register(u32 register_id, u32 * return_value);
320 acpi_status acpi_get_register_unlocked(u32 register_id, u32 *return_value);
322 acpi_status acpi_set_register(u32 register_id, u32 value);
325 acpi_set_firmware_waking_vector(u32 physical_address);
328 acpi_set_firmware_waking_vector64(u64 physical_address);
331 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
333 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
335 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
337 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
339 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
341 acpi_status acpi_leave_sleep_state(u8 sleep_state);
343 #endif /* __ACXFACE_H__ */