Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/cjb/mmc
[cris-mirror.git] / include / acpi / acpixf.h
blobf6ad63d25b739fbba1d41eabed483db4abf7feb1
2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
8 /*
9 * Copyright (C) 2000 - 2011, 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 0x20110316
52 #include "actypes.h"
53 #include "actbl.h"
55 extern u8 acpi_gbl_permanent_mmap;
58 * Globals that are publicly 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_use_default_register_widths;
67 extern acpi_name acpi_gbl_trace_method_name;
68 extern u32 acpi_gbl_trace_flags;
69 extern u32 acpi_gbl_enable_aml_debug_object;
70 extern u8 acpi_gbl_copy_dsdt_locally;
71 extern u8 acpi_gbl_truncate_io_addresses;
73 extern u32 acpi_current_gpe_count;
74 extern struct acpi_table_fadt acpi_gbl_FADT;
75 extern u8 acpi_gbl_system_awake_and_running;
77 extern u32 acpi_rsdt_forced;
79 * Global interfaces
81 acpi_status
82 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
83 u32 initial_table_count, u8 allow_resize);
85 acpi_status __init acpi_initialize_subsystem(void);
87 acpi_status acpi_enable_subsystem(u32 flags);
89 acpi_status acpi_initialize_objects(u32 flags);
91 acpi_status acpi_terminate(void);
93 #ifdef ACPI_FUTURE_USAGE
94 acpi_status acpi_subsystem_status(void);
95 #endif
97 acpi_status acpi_enable(void);
99 acpi_status acpi_disable(void);
101 #ifdef ACPI_FUTURE_USAGE
102 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
103 #endif
105 const char *acpi_format_exception(acpi_status exception);
107 acpi_status acpi_purge_cached_objects(void);
109 acpi_status acpi_install_interface(acpi_string interface_name);
111 acpi_status acpi_remove_interface(acpi_string interface_name);
114 * ACPI Memory management
116 void *acpi_allocate(u32 size);
118 void *acpi_callocate(u32 size);
120 void acpi_free(void *address);
123 * ACPI table manipulation interfaces
125 acpi_status acpi_reallocate_root_table(void);
127 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
129 acpi_status acpi_load_tables(void);
131 acpi_status acpi_load_table(struct acpi_table_header *table_ptr);
133 acpi_status acpi_unload_table_id(acpi_owner_id id);
135 acpi_status
136 acpi_get_table_header(acpi_string signature,
137 u32 instance,
138 struct acpi_table_header *out_table_header);
140 acpi_status
141 acpi_get_table_with_size(acpi_string signature,
142 u32 instance, struct acpi_table_header **out_table,
143 acpi_size *tbl_size);
144 acpi_status
145 acpi_get_table(acpi_string signature,
146 u32 instance, struct acpi_table_header **out_table);
148 acpi_status
149 acpi_get_table_by_index(u32 table_index,
150 struct acpi_table_header **out_table);
152 acpi_status
153 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
155 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
158 * Namespace and name interfaces
160 acpi_status
161 acpi_walk_namespace(acpi_object_type type,
162 acpi_handle start_object,
163 u32 max_depth,
164 acpi_walk_callback pre_order_visit,
165 acpi_walk_callback post_order_visit,
166 void *context, void **return_value);
168 acpi_status
169 acpi_get_devices(const char *HID,
170 acpi_walk_callback user_function,
171 void *context, void **return_value);
173 acpi_status
174 acpi_get_name(acpi_handle object,
175 u32 name_type, struct acpi_buffer *ret_path_ptr);
177 acpi_status
178 acpi_get_handle(acpi_handle parent,
179 acpi_string pathname, acpi_handle * ret_handle);
181 acpi_status
182 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
184 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
186 acpi_status
187 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
189 acpi_status
190 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
193 * Object manipulation and enumeration
195 acpi_status
196 acpi_evaluate_object(acpi_handle object,
197 acpi_string pathname,
198 struct acpi_object_list *parameter_objects,
199 struct acpi_buffer *return_object_buffer);
201 acpi_status
202 acpi_evaluate_object_typed(acpi_handle object,
203 acpi_string pathname,
204 struct acpi_object_list *external_params,
205 struct acpi_buffer *return_buffer,
206 acpi_object_type return_type);
208 acpi_status
209 acpi_get_object_info(acpi_handle object,
210 struct acpi_device_info **return_buffer);
212 acpi_status acpi_install_method(u8 *buffer);
214 acpi_status
215 acpi_get_next_object(acpi_object_type type,
216 acpi_handle parent,
217 acpi_handle child, acpi_handle * out_handle);
219 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
221 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
223 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
226 * Handler interfaces
228 acpi_status
229 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
231 acpi_status
232 acpi_install_global_event_handler(ACPI_GBL_EVENT_HANDLER handler,
233 void *context);
235 acpi_status
236 acpi_install_fixed_event_handler(u32 acpi_event,
237 acpi_event_handler handler, void *context);
239 acpi_status
240 acpi_remove_fixed_event_handler(u32 acpi_event, acpi_event_handler handler);
242 acpi_status
243 acpi_install_notify_handler(acpi_handle device,
244 u32 handler_type,
245 acpi_notify_handler handler, void *context);
247 acpi_status
248 acpi_remove_notify_handler(acpi_handle device,
249 u32 handler_type, acpi_notify_handler handler);
251 acpi_status
252 acpi_install_address_space_handler(acpi_handle device,
253 acpi_adr_space_type space_id,
254 acpi_adr_space_handler handler,
255 acpi_adr_space_setup setup, void *context);
257 acpi_status
258 acpi_remove_address_space_handler(acpi_handle device,
259 acpi_adr_space_type space_id,
260 acpi_adr_space_handler handler);
262 acpi_status
263 acpi_install_gpe_handler(acpi_handle gpe_device,
264 u32 gpe_number,
265 u32 type, acpi_gpe_handler address, void *context);
267 acpi_status
268 acpi_remove_gpe_handler(acpi_handle gpe_device,
269 u32 gpe_number, acpi_gpe_handler address);
271 #ifdef ACPI_FUTURE_USAGE
272 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
273 #endif
275 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
278 * Event interfaces
280 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle);
282 acpi_status acpi_release_global_lock(u32 handle);
284 acpi_status acpi_enable_event(u32 event, u32 flags);
286 acpi_status acpi_disable_event(u32 event, u32 flags);
288 acpi_status acpi_clear_event(u32 event);
290 acpi_status acpi_get_event_status(u32 event, acpi_event_status * event_status);
293 * GPE Interfaces
295 acpi_status acpi_enable_gpe(acpi_handle gpe_device, u32 gpe_number);
297 acpi_status acpi_disable_gpe(acpi_handle gpe_device, u32 gpe_number);
299 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number);
301 acpi_status
302 acpi_setup_gpe_for_wake(acpi_handle parent_device,
303 acpi_handle gpe_device, u32 gpe_number);
305 acpi_status acpi_set_gpe_wake_mask(acpi_handle gpe_device, u32 gpe_number, u8 action);
307 acpi_status
308 acpi_get_gpe_status(acpi_handle gpe_device,
309 u32 gpe_number, acpi_event_status *event_status);
311 acpi_status acpi_disable_all_gpes(void);
313 acpi_status acpi_enable_all_runtime_gpes(void);
315 acpi_status acpi_get_gpe_device(u32 gpe_index, acpi_handle *gpe_device);
317 acpi_status
318 acpi_install_gpe_block(acpi_handle gpe_device,
319 struct acpi_generic_address *gpe_block_address,
320 u32 register_count, u32 interrupt_number);
322 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device);
324 acpi_status acpi_update_all_gpes(void);
327 * Resource interfaces
329 typedef
330 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
331 void *context);
333 acpi_status
334 acpi_get_vendor_resource(acpi_handle device,
335 char *name,
336 struct acpi_vendor_uuid *uuid,
337 struct acpi_buffer *ret_buffer);
339 acpi_status
340 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
342 #ifdef ACPI_FUTURE_USAGE
343 acpi_status
344 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
345 #endif
347 acpi_status
348 acpi_walk_resources(acpi_handle device,
349 char *name,
350 acpi_walk_resource_callback user_function, void *context);
352 acpi_status
353 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
355 acpi_status
356 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
358 acpi_status
359 acpi_resource_to_address64(struct acpi_resource *resource,
360 struct acpi_resource_address64 *out);
363 * Hardware (ACPI device) interfaces
365 acpi_status acpi_reset(void);
367 acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value);
369 acpi_status acpi_write_bit_register(u32 register_id, u32 value);
371 acpi_status acpi_set_firmware_waking_vector(u32 physical_address);
373 #if ACPI_MACHINE_WIDTH == 64
374 acpi_status acpi_set_firmware_waking_vector64(u64 physical_address);
375 #endif
377 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
379 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
381 acpi_status
382 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
384 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
386 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
388 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void);
390 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
392 acpi_status acpi_leave_sleep_state(u8 sleep_state);
395 * Error/Warning output
397 void ACPI_INTERNAL_VAR_XFACE
398 acpi_error(const char *module_name,
399 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
401 void ACPI_INTERNAL_VAR_XFACE
402 acpi_exception(const char *module_name,
403 u32 line_number,
404 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
406 void ACPI_INTERNAL_VAR_XFACE
407 acpi_warning(const char *module_name,
408 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
410 void ACPI_INTERNAL_VAR_XFACE
411 acpi_info(const char *module_name,
412 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
415 * Debug output
417 #ifdef ACPI_DEBUG_OUTPUT
419 void ACPI_INTERNAL_VAR_XFACE
420 acpi_debug_print(u32 requested_debug_level,
421 u32 line_number,
422 const char *function_name,
423 const char *module_name,
424 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
426 void ACPI_INTERNAL_VAR_XFACE
427 acpi_debug_print_raw(u32 requested_debug_level,
428 u32 line_number,
429 const char *function_name,
430 const char *module_name,
431 u32 component_id,
432 const char *format, ...) ACPI_PRINTF_LIKE(6);
433 #endif
435 #endif /* __ACXFACE_H__ */