Linux 2.6.35-rc2
[linux/fpc-iii.git] / include / acpi / acpixf.h
blob0e4ab1fe5966e09897d51b85e710f784a990c6d8
2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
8 /*
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
14 * are met:
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.
31 * NO WARRANTY
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.
45 #ifndef __ACXFACE_H__
46 #define __ACXFACE_H__
48 /* Current ACPICA subsystem version in YYYYMMDD format */
50 #define ACPI_CA_VERSION 0x20100428
52 #include "actypes.h"
53 #include "actbl.h"
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;
71 extern u8 acpi_gbl_copy_dsdt_locally;
73 extern u32 acpi_current_gpe_count;
74 extern struct acpi_table_fadt acpi_gbl_FADT;
76 extern u32 acpi_rsdt_forced;
78 * Global interfaces
80 acpi_status
81 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
82 u32 initial_table_count, u8 allow_resize);
84 acpi_status __init acpi_initialize_subsystem(void);
86 acpi_status acpi_enable_subsystem(u32 flags);
88 acpi_status acpi_initialize_objects(u32 flags);
90 acpi_status acpi_terminate(void);
92 #ifdef ACPI_FUTURE_USAGE
93 acpi_status acpi_subsystem_status(void);
94 #endif
96 acpi_status acpi_enable(void);
98 acpi_status acpi_disable(void);
100 #ifdef ACPI_FUTURE_USAGE
101 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
102 #endif
104 const char *acpi_format_exception(acpi_status exception);
106 acpi_status acpi_purge_cached_objects(void);
109 * ACPI Memory management
111 void *acpi_allocate(u32 size);
113 void *acpi_callocate(u32 size);
115 void acpi_free(void *address);
118 * ACPI table manipulation interfaces
120 acpi_status acpi_reallocate_root_table(void);
122 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
124 acpi_status acpi_load_tables(void);
126 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
128 acpi_status acpi_unload_table_id(acpi_owner_id id);
130 acpi_status
131 acpi_get_table_header(acpi_string signature,
132 u32 instance,
133 struct acpi_table_header *out_table_header);
135 acpi_status
136 acpi_get_table_with_size(acpi_string signature,
137 u32 instance, struct acpi_table_header **out_table,
138 acpi_size *tbl_size);
139 acpi_status
140 acpi_get_table(acpi_string signature,
141 u32 instance, struct acpi_table_header **out_table);
143 acpi_status
144 acpi_get_table_by_index(u32 table_index,
145 struct acpi_table_header **out_table);
147 acpi_status
148 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
150 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
153 * Namespace and name interfaces
155 acpi_status
156 acpi_walk_namespace(acpi_object_type type,
157 acpi_handle start_object,
158 u32 max_depth,
159 acpi_walk_callback pre_order_visit,
160 acpi_walk_callback post_order_visit,
161 void *context, void **return_value);
163 acpi_status
164 acpi_get_devices(const char *HID,
165 acpi_walk_callback user_function,
166 void *context, void **return_value);
168 acpi_status
169 acpi_get_name(acpi_handle object,
170 u32 name_type, struct acpi_buffer *ret_path_ptr);
172 acpi_status
173 acpi_get_handle(acpi_handle parent,
174 acpi_string pathname, acpi_handle * ret_handle);
176 acpi_status
177 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
179 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
181 acpi_status
182 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
184 acpi_status
185 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
188 * Object manipulation and enumeration
190 acpi_status
191 acpi_evaluate_object(acpi_handle object,
192 acpi_string pathname,
193 struct acpi_object_list *parameter_objects,
194 struct acpi_buffer *return_object_buffer);
196 acpi_status
197 acpi_evaluate_object_typed(acpi_handle object,
198 acpi_string pathname,
199 struct acpi_object_list *external_params,
200 struct acpi_buffer *return_buffer,
201 acpi_object_type return_type);
203 acpi_status
204 acpi_get_object_info(acpi_handle object,
205 struct acpi_device_info **return_buffer);
207 acpi_status acpi_install_method(u8 *buffer);
209 acpi_status
210 acpi_get_next_object(acpi_object_type type,
211 acpi_handle parent,
212 acpi_handle child, acpi_handle * out_handle);
214 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
216 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
218 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
221 * Handler interfaces
223 acpi_status
224 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
226 acpi_status
227 acpi_install_fixed_event_handler(u32 acpi_event,
228 acpi_event_handler handler, void *context);
230 acpi_status
231 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
233 acpi_status
234 acpi_install_notify_handler(acpi_handle device,
235 u32 handler_type,
236 acpi_notify_handler handler, void *context);
238 acpi_status
239 acpi_remove_notify_handler(acpi_handle device,
240 u32 handler_type, acpi_notify_handler handler);
242 acpi_status
243 acpi_install_address_space_handler(acpi_handle device,
244 acpi_adr_space_type space_id,
245 acpi_adr_space_handler handler,
246 acpi_adr_space_setup setup, void *context);
248 acpi_status
249 acpi_remove_address_space_handler(acpi_handle device,
250 acpi_adr_space_type space_id,
251 acpi_adr_space_handler handler);
253 acpi_status
254 acpi_install_gpe_handler(acpi_handle gpe_device,
255 u32 gpe_number,
256 u32 type, acpi_event_handler address, void *context);
258 acpi_status
259 acpi_remove_gpe_handler(acpi_handle gpe_device,
260 u32 gpe_number, acpi_event_handler address);
262 #ifdef ACPI_FUTURE_USAGE
263 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
264 #endif
267 * Event interfaces
269 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
271 acpi_status acpi_release_global_lock(u32 handle);
273 acpi_status acpi_enable_event(u32 event, u32 flags);
275 acpi_status acpi_disable_event(u32 event, u32 flags);
277 acpi_status acpi_clear_event(u32 event);
279 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
282 * GPE Interfaces
284 acpi_status acpi_set_gpe(acpi_handle gpe_device, u32 gpe_number, u8 action);
286 acpi_status
287 acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number, u8 gpe_type);
289 acpi_status
290 acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number, u8 gpe_type);
292 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number);
294 acpi_status
295 acpi_get_gpe_status(acpi_handle gpe_device,
296 u32 gpe_number, 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);
304 acpi_status
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
314 typedef
315 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
316 void *context);
318 acpi_status
319 acpi_get_vendor_resource(acpi_handle device,
320 char *name,
321 struct acpi_vendor_uuid *uuid,
322 struct acpi_buffer *ret_buffer);
324 acpi_status
325 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
327 #ifdef ACPI_FUTURE_USAGE
328 acpi_status
329 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
330 #endif
332 acpi_status
333 acpi_walk_resources(acpi_handle device,
334 char *name,
335 acpi_walk_resource_callback user_function, void *context);
337 acpi_status
338 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
340 acpi_status
341 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
343 acpi_status
344 acpi_resource_to_address64(struct acpi_resource *resource,
345 struct acpi_resource_address64 *out);
348 * Hardware (ACPI device) interfaces
350 acpi_status acpi_reset(void);
352 acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value);
354 acpi_status acpi_write_bit_register(u32 register_id, u32 value);
356 acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
358 #if ACPI_MACHINE_WIDTH == 64
359 acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
360 #endif
362 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
364 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
366 acpi_status
367 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
369 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
371 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
373 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
375 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
377 acpi_status acpi_leave_sleep_state(u8 sleep_state);
380 * Error/Warning output
382 void ACPI_INTERNAL_VAR_XFACE
383 acpi_error(const char *module_name,
384 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
386 void ACPI_INTERNAL_VAR_XFACE
387 acpi_exception(const char *module_name,
388 u32 line_number,
389 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
391 void ACPI_INTERNAL_VAR_XFACE
392 acpi_warning(const char *module_name,
393 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
395 void ACPI_INTERNAL_VAR_XFACE
396 acpi_info(const char *module_name,
397 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
400 * Debug output
402 #ifdef ACPI_DEBUG_OUTPUT
404 void ACPI_INTERNAL_VAR_XFACE
405 acpi_debug_print(u32 requested_debug_level,
406 u32 line_number,
407 const char *function_name,
408 const char *module_name,
409 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
411 void ACPI_INTERNAL_VAR_XFACE
412 acpi_debug_print_raw(u32 requested_debug_level,
413 u32 line_number,
414 const char *function_name,
415 const char *module_name,
416 u32 component_id,
417 const char *format, ...) ACPI_PRINTF_LIKE(6);
418 #endif
420 #endif /* __ACXFACE_H__ */