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.
48 /* Current ACPICA subsystem version in YYYYMMDD format */
50 #define ACPI_CA_VERSION 0x20081204
55 extern u8 acpi_gbl_permanent_mmap;
58 * Globals that are publically available, allowing for
59 * run time configuration
61 extern u32 acpi_dbg_level;
62 extern u32 acpi_dbg_layer;
63 extern u8 acpi_gbl_enable_interpreter_slack;
64 extern u8 acpi_gbl_all_methods_serialized;
65 extern u8 acpi_gbl_create_osi_method;
66 extern u8 acpi_gbl_leave_wake_gpes_disabled;
67 extern acpi_name acpi_gbl_trace_method_name;
68 extern u32 acpi_gbl_trace_flags;
70 extern u32 acpi_current_gpe_count;
71 extern struct acpi_table_fadt acpi_gbl_FADT;
77 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
78 u32 initial_table_count, u8 allow_resize);
80 acpi_status __init acpi_initialize_subsystem(void);
82 acpi_status acpi_enable_subsystem(u32 flags);
84 acpi_status acpi_initialize_objects(u32 flags);
86 acpi_status acpi_terminate(void);
88 #ifdef ACPI_FUTURE_USAGE
89 acpi_status acpi_subsystem_status(void);
92 acpi_status acpi_enable(void);
94 acpi_status acpi_disable(void);
96 #ifdef ACPI_FUTURE_USAGE
97 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
100 const char *acpi_format_exception(acpi_status exception);
102 acpi_status acpi_purge_cached_objects(void);
105 * ACPI Memory management
107 void *acpi_allocate(u32 size);
109 void *acpi_callocate(u32 size);
111 void acpi_free(void *address);
114 * ACPI table manipulation interfaces
116 acpi_status acpi_reallocate_root_table(void);
118 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
120 acpi_status acpi_load_tables(void);
122 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
124 acpi_status acpi_unload_table_id(acpi_owner_id id);
127 acpi_get_table_header(acpi_string signature,
129 struct acpi_table_header *out_table_header);
132 acpi_get_table(acpi_string signature,
133 u32 instance, struct acpi_table_header **out_table);
136 acpi_get_table_by_index(u32 table_index,
137 struct acpi_table_header **out_table);
140 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
142 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
145 * Namespace and name interfaces
148 acpi_walk_namespace(acpi_object_type type,
149 acpi_handle start_object,
151 acpi_walk_callback user_function,
152 void *context, void **return_value);
155 acpi_get_devices(const char *HID,
156 acpi_walk_callback user_function,
157 void *context, void **return_value);
160 acpi_get_name(acpi_handle handle,
161 u32 name_type, struct acpi_buffer *ret_path_ptr);
164 acpi_get_handle(acpi_handle parent,
165 acpi_string pathname, acpi_handle * ret_handle);
168 acpi_attach_data(acpi_handle obj_handle,
169 acpi_object_handler handler, void *data);
172 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
175 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
178 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
181 * Object manipulation and enumeration
184 acpi_evaluate_object(acpi_handle object,
185 acpi_string pathname,
186 struct acpi_object_list *parameter_objects,
187 struct acpi_buffer *return_object_buffer);
189 #ifdef ACPI_FUTURE_USAGE
191 acpi_evaluate_object_typed(acpi_handle object,
192 acpi_string pathname,
193 struct acpi_object_list *external_params,
194 struct acpi_buffer *return_buffer,
195 acpi_object_type return_type);
199 acpi_get_object_info(acpi_handle handle, struct acpi_buffer *return_buffer);
202 acpi_get_next_object(acpi_object_type type,
204 acpi_handle child, acpi_handle * out_handle);
206 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
208 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
210 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
216 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
219 acpi_install_fixed_event_handler(u32 acpi_event,
220 acpi_event_handler handler, void *context);
223 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
226 acpi_install_notify_handler(acpi_handle device,
228 acpi_notify_handler handler, void *context);
231 acpi_remove_notify_handler(acpi_handle device,
232 u32 handler_type, acpi_notify_handler handler);
235 acpi_install_address_space_handler(acpi_handle device,
236 acpi_adr_space_type space_id,
237 acpi_adr_space_handler handler,
238 acpi_adr_space_setup setup, void *context);
241 acpi_remove_address_space_handler(acpi_handle device,
242 acpi_adr_space_type space_id,
243 acpi_adr_space_handler handler);
246 acpi_install_gpe_handler(acpi_handle gpe_device,
248 u32 type, acpi_event_handler address, void *context);
251 acpi_remove_gpe_handler(acpi_handle gpe_device,
252 u32 gpe_number, acpi_event_handler address);
254 #ifdef ACPI_FUTURE_USAGE
255 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
261 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
263 acpi_status acpi_release_global_lock(u32 handle);
265 acpi_status acpi_enable_event(u32 event, u32 flags);
267 acpi_status acpi_disable_event(u32 event, u32 flags);
269 acpi_status acpi_clear_event(u32 event);
271 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
276 acpi_status acpi_set_gpe_type(acpi_handle gpe_device, u32 gpe_number, u8 type);
278 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
280 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number);
282 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
285 acpi_get_gpe_status(acpi_handle gpe_device,
287 u32 flags, acpi_event_status * event_status);
289 acpi_status acpi_disable_all_gpes(void);
291 acpi_status acpi_enable_all_runtime_gpes(void);
293 acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);
296 acpi_install_gpe_block(acpi_handle gpe_device,
297 struct acpi_generic_address *gpe_block_address,
298 u32 register_count, u32 interrupt_number);
300 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
303 * Resource interfaces
306 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
310 acpi_get_vendor_resource(acpi_handle device_handle,
312 struct acpi_vendor_uuid *uuid,
313 struct acpi_buffer *ret_buffer);
316 acpi_get_current_resources(acpi_handle device_handle,
317 struct acpi_buffer *ret_buffer);
319 #ifdef ACPI_FUTURE_USAGE
321 acpi_get_possible_resources(acpi_handle device_handle,
322 struct acpi_buffer *ret_buffer);
326 acpi_walk_resources(acpi_handle device_handle,
328 acpi_walk_resource_callback user_function, void *context);
331 acpi_set_current_resources(acpi_handle device_handle,
332 struct acpi_buffer *in_buffer);
335 acpi_get_irq_routing_table(acpi_handle bus_device_handle,
336 struct acpi_buffer *ret_buffer);
339 acpi_resource_to_address64(struct acpi_resource *resource,
340 struct acpi_resource_address64 *out);
343 * Hardware (ACPI device) interfaces
345 acpi_status acpi_reset(void);
347 acpi_status acpi_get_register(u32 register_id, u32 * return_value);
349 acpi_status acpi_get_register_unlocked(u32 register_id, u32 *return_value);
351 acpi_status acpi_set_register(u32 register_id, u32 value);
354 acpi_set_firmware_waking_vector(u32 physical_address);
357 acpi_set_firmware_waking_vector64(u64 physical_address);
359 acpi_status acpi_read(u32 *value, struct acpi_generic_address *reg);
361 acpi_status acpi_write(u32 value, struct acpi_generic_address *reg);
364 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
366 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
368 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
370 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
372 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
374 acpi_status acpi_leave_sleep_state(u8 sleep_state);
379 void ACPI_INTERNAL_VAR_XFACE
380 acpi_error(const char *module_name,
381 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
383 void ACPI_INTERNAL_VAR_XFACE
384 acpi_exception(const char *module_name,
386 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
388 void ACPI_INTERNAL_VAR_XFACE
389 acpi_warning(const char *module_name,
390 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
392 void ACPI_INTERNAL_VAR_XFACE
393 acpi_info(const char *module_name,
394 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
396 #ifdef ACPI_DEBUG_OUTPUT
398 void ACPI_INTERNAL_VAR_XFACE
399 acpi_debug_print(u32 requested_debug_level,
401 const char *function_name,
402 const char *module_name,
403 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
405 void ACPI_INTERNAL_VAR_XFACE
406 acpi_debug_print_raw(u32 requested_debug_level,
408 const char *function_name,
409 const char *module_name,
411 const char *format, ...) ACPI_PRINTF_LIKE(6);
414 #endif /* __ACXFACE_H__ */