2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2010, 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 0x20100304
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 u8 acpi_gbl_use_default_register_widths;
68 extern acpi_name acpi_gbl_trace_method_name;
69 extern u32 acpi_gbl_trace_flags;
70 extern u8 acpi_gbl_enable_aml_debug_object;
72 extern u32 acpi_current_gpe_count;
73 extern struct acpi_table_fadt acpi_gbl_FADT;
75 extern u32 acpi_rsdt_forced;
80 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
81 u32 initial_table_count, u8 allow_resize);
83 acpi_status __init acpi_initialize_subsystem(void);
85 acpi_status acpi_enable_subsystem(u32 flags);
87 acpi_status acpi_initialize_objects(u32 flags);
89 acpi_status acpi_terminate(void);
91 #ifdef ACPI_FUTURE_USAGE
92 acpi_status acpi_subsystem_status(void);
95 acpi_status acpi_enable(void);
97 acpi_status acpi_disable(void);
99 #ifdef ACPI_FUTURE_USAGE
100 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
103 const char *acpi_format_exception(acpi_status exception);
105 acpi_status acpi_purge_cached_objects(void);
108 * ACPI Memory management
110 void *acpi_allocate(u32 size);
112 void *acpi_callocate(u32 size);
114 void acpi_free(void *address);
117 * ACPI table manipulation interfaces
119 acpi_status acpi_reallocate_root_table(void);
121 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
123 acpi_status acpi_load_tables(void);
125 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
127 acpi_status acpi_unload_table_id(acpi_owner_id id);
130 acpi_get_table_header(acpi_string signature,
132 struct acpi_table_header *out_table_header);
135 acpi_get_table_with_size(acpi_string signature,
136 u32 instance, struct acpi_table_header **out_table,
137 acpi_size *tbl_size);
139 acpi_get_table(acpi_string signature,
140 u32 instance, struct acpi_table_header **out_table);
143 acpi_get_table_by_index(u32 table_index,
144 struct acpi_table_header **out_table);
147 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
149 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
152 * Namespace and name interfaces
155 acpi_walk_namespace(acpi_object_type type,
156 acpi_handle start_object,
158 acpi_walk_callback pre_order_visit,
159 acpi_walk_callback post_order_visit,
160 void *context, void **return_value);
163 acpi_get_devices(const char *HID,
164 acpi_walk_callback user_function,
165 void *context, void **return_value);
168 acpi_get_name(acpi_handle handle,
169 u32 name_type, struct acpi_buffer *ret_path_ptr);
172 acpi_get_handle(acpi_handle parent,
173 acpi_string pathname, acpi_handle * ret_handle);
176 acpi_attach_data(acpi_handle obj_handle,
177 acpi_object_handler handler, void *data);
180 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler);
183 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data);
186 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
189 * Object manipulation and enumeration
192 acpi_evaluate_object(acpi_handle object,
193 acpi_string pathname,
194 struct acpi_object_list *parameter_objects,
195 struct acpi_buffer *return_object_buffer);
198 acpi_evaluate_object_typed(acpi_handle object,
199 acpi_string pathname,
200 struct acpi_object_list *external_params,
201 struct acpi_buffer *return_buffer,
202 acpi_object_type return_type);
205 acpi_get_object_info(acpi_handle handle,
206 struct acpi_device_info **return_buffer);
208 acpi_status acpi_install_method(u8 *buffer);
211 acpi_get_next_object(acpi_object_type type,
213 acpi_handle child, acpi_handle * out_handle);
215 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
217 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
219 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
225 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
228 acpi_install_fixed_event_handler(u32 acpi_event,
229 acpi_event_handler handler, void *context);
232 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
235 acpi_install_notify_handler(acpi_handle device,
237 acpi_notify_handler handler, void *context);
240 acpi_remove_notify_handler(acpi_handle device,
241 u32 handler_type, acpi_notify_handler handler);
244 acpi_install_address_space_handler(acpi_handle device,
245 acpi_adr_space_type space_id,
246 acpi_adr_space_handler handler,
247 acpi_adr_space_setup setup, void *context);
250 acpi_remove_address_space_handler(acpi_handle device,
251 acpi_adr_space_type space_id,
252 acpi_adr_space_handler handler);
255 acpi_install_gpe_handler(acpi_handle gpe_device,
257 u32 type, acpi_event_handler address, void *context);
260 acpi_remove_gpe_handler(acpi_handle gpe_device,
261 u32 gpe_number, acpi_event_handler address);
263 #ifdef ACPI_FUTURE_USAGE
264 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
270 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
272 acpi_status acpi_release_global_lock(u32 handle);
274 acpi_status acpi_enable_event(u32 event, u32 flags);
276 acpi_status acpi_disable_event(u32 event, u32 flags);
278 acpi_status acpi_clear_event(u32 event);
280 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
285 acpi_status acpi_set_gpe(acpi_handle gpe_device, u32 gpe_number, u8 action);
287 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u8 type);
289 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u8 type);
291 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number, u32 flags);
294 acpi_get_gpe_status(acpi_handle gpe_device,
296 u32 flags, acpi_event_status * event_status);
298 acpi_status acpi_disable_all_gpes(void);
300 acpi_status acpi_enable_all_runtime_gpes(void);
302 acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);
305 acpi_install_gpe_block(acpi_handle gpe_device,
306 struct acpi_generic_address *gpe_block_address,
307 u32 register_count, u32 interrupt_number);
309 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
312 * Resource interfaces
315 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
319 acpi_get_vendor_resource(acpi_handle device_handle,
321 struct acpi_vendor_uuid *uuid,
322 struct acpi_buffer *ret_buffer);
325 acpi_get_current_resources(acpi_handle device_handle,
326 struct acpi_buffer *ret_buffer);
328 #ifdef ACPI_FUTURE_USAGE
330 acpi_get_possible_resources(acpi_handle device_handle,
331 struct acpi_buffer *ret_buffer);
335 acpi_walk_resources(acpi_handle device_handle,
337 acpi_walk_resource_callback user_function, void *context);
340 acpi_set_current_resources(acpi_handle device_handle,
341 struct acpi_buffer *in_buffer);
344 acpi_get_irq_routing_table(acpi_handle bus_device_handle,
345 struct acpi_buffer *ret_buffer);
348 acpi_resource_to_address64(struct acpi_resource *resource,
349 struct acpi_resource_address64 *out);
352 * Hardware (ACPI device) interfaces
354 acpi_status acpi_reset(void);
356 acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value);
358 acpi_status acpi_write_bit_register(u32 register_id, u32 value);
360 acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
362 #if ACPI_MACHINE_WIDTH == 64
363 acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
366 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
368 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
371 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
373 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
375 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
377 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
379 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
381 acpi_status acpi_leave_sleep_state(u8 sleep_state);
384 * Error/Warning output
386 void ACPI_INTERNAL_VAR_XFACE
387 acpi_error(const char *module_name,
388 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
390 void ACPI_INTERNAL_VAR_XFACE
391 acpi_exception(const char *module_name,
393 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
395 void ACPI_INTERNAL_VAR_XFACE
396 acpi_warning(const char *module_name,
397 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
399 void ACPI_INTERNAL_VAR_XFACE
400 acpi_info(const char *module_name,
401 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
406 #ifdef ACPI_DEBUG_OUTPUT
408 void ACPI_INTERNAL_VAR_XFACE
409 acpi_debug_print(u32 requested_debug_level,
411 const char *function_name,
412 const char *module_name,
413 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
415 void ACPI_INTERNAL_VAR_XFACE
416 acpi_debug_print_raw(u32 requested_debug_level,
418 const char *function_name,
419 const char *module_name,
421 const char *format, ...) ACPI_PRINTF_LIKE(6);
424 #endif /* __ACXFACE_H__ */