1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
47 /* Current ACPICA subsystem version in YYYYMMDD format */
49 #define ACPI_CA_VERSION 0x20121018
51 #include <acpi/acconfig.h>
52 #include <acpi/actypes.h>
53 #include <acpi/actbl.h>
54 #include <acpi/acbuffer.h>
56 extern u8 acpi_gbl_permanent_mmap;
59 * Globals that are publicly available, allowing for
60 * run time configuration
62 extern u32 acpi_dbg_level;
63 extern u32 acpi_dbg_layer;
64 extern u8 acpi_gbl_enable_interpreter_slack;
65 extern u8 acpi_gbl_all_methods_serialized;
66 extern u8 acpi_gbl_create_osi_method;
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 bool acpi_gbl_enable_aml_debug_object;
71 extern u8 acpi_gbl_copy_dsdt_locally;
72 extern u8 acpi_gbl_truncate_io_addresses;
73 extern u8 acpi_gbl_disable_auto_repair;
76 * Hardware-reduced prototypes. All interfaces that use these macros will
77 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
80 #if (!ACPI_REDUCED_HARDWARE)
81 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
84 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
87 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
91 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
92 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
94 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
95 static ACPI_INLINE prototype {return(AE_OK);}
97 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
98 static ACPI_INLINE prototype {}
100 #endif /* !ACPI_REDUCED_HARDWARE */
102 extern u32 acpi_current_gpe_count;
103 extern struct acpi_table_fadt acpi_gbl_FADT;
104 extern u8 acpi_gbl_system_awake_and_running;
105 extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */
107 extern u32 acpi_rsdt_forced;
112 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
113 u32 initial_table_count, u8 allow_resize);
115 acpi_status __init acpi_initialize_subsystem(void);
117 acpi_status acpi_enable_subsystem(u32 flags);
119 acpi_status acpi_initialize_objects(u32 flags);
121 acpi_status acpi_terminate(void);
123 #ifdef ACPI_FUTURE_USAGE
124 acpi_status acpi_subsystem_status(void);
127 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
128 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
130 #ifdef ACPI_FUTURE_USAGE
131 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
134 const char *acpi_format_exception(acpi_status exception);
136 acpi_status acpi_purge_cached_objects(void);
138 acpi_status acpi_install_interface(acpi_string interface_name);
140 acpi_status acpi_remove_interface(acpi_string interface_name);
143 acpi_check_address_range(acpi_adr_space_type space_id,
144 acpi_physical_address address,
145 acpi_size length, u8 warn);
148 acpi_decode_pld_buffer(u8 *in_buffer,
149 acpi_size length, struct acpi_pld_info **return_buffer);
152 * ACPI Memory management
154 void *acpi_allocate(u32 size);
156 void *acpi_callocate(u32 size);
158 void acpi_free(void *address);
161 * ACPI table load/unload interfaces
163 acpi_status acpi_load_table(struct acpi_table_header *table);
165 acpi_status acpi_unload_parent_table(acpi_handle object);
167 acpi_status acpi_load_tables(void);
170 * ACPI table manipulation interfaces
172 acpi_status acpi_reallocate_root_table(void);
174 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
176 acpi_status acpi_unload_table_id(acpi_owner_id id);
179 acpi_get_table_header(acpi_string signature,
180 u32 instance, struct acpi_table_header *out_table_header);
183 acpi_get_table_with_size(acpi_string signature,
184 u32 instance, struct acpi_table_header **out_table,
185 acpi_size *tbl_size);
187 acpi_get_table(acpi_string signature,
188 u32 instance, struct acpi_table_header **out_table);
191 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
194 acpi_install_table_handler(acpi_tbl_handler handler, void *context);
196 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
199 * Namespace and name interfaces
202 acpi_walk_namespace(acpi_object_type type,
203 acpi_handle start_object,
205 acpi_walk_callback pre_order_visit,
206 acpi_walk_callback post_order_visit,
207 void *context, void **return_value);
210 acpi_get_devices(const char *HID,
211 acpi_walk_callback user_function,
212 void *context, void **return_value);
215 acpi_get_name(acpi_handle object,
216 u32 name_type, struct acpi_buffer *ret_path_ptr);
219 acpi_get_handle(acpi_handle parent,
220 acpi_string pathname, acpi_handle * ret_handle);
223 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
225 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
228 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
231 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
234 * Object manipulation and enumeration
237 acpi_evaluate_object(acpi_handle object,
238 acpi_string pathname,
239 struct acpi_object_list *parameter_objects,
240 struct acpi_buffer *return_object_buffer);
243 acpi_evaluate_object_typed(acpi_handle object,
244 acpi_string pathname,
245 struct acpi_object_list *external_params,
246 struct acpi_buffer *return_buffer,
247 acpi_object_type return_type);
250 acpi_get_object_info(acpi_handle object,
251 struct acpi_device_info **return_buffer);
253 acpi_status acpi_install_method(u8 *buffer);
256 acpi_get_next_object(acpi_object_type type,
258 acpi_handle child, acpi_handle * out_handle);
260 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
262 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
264 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
270 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
272 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
273 acpi_install_global_event_handler
274 (acpi_gbl_event_handler handler, void *context))
276 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
277 acpi_install_fixed_event_handler(u32
283 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
284 acpi_remove_fixed_event_handler(u32 acpi_event,
287 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
288 acpi_install_gpe_handler(acpi_handle
295 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
296 acpi_remove_gpe_handler(acpi_handle gpe_device,
300 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
301 acpi_notify_handler handler,
305 acpi_remove_notify_handler(acpi_handle device,
306 u32 handler_type, acpi_notify_handler handler);
309 acpi_install_address_space_handler(acpi_handle device,
310 acpi_adr_space_type space_id,
311 acpi_adr_space_handler handler,
312 acpi_adr_space_setup setup, void *context);
315 acpi_remove_address_space_handler(acpi_handle device,
316 acpi_adr_space_type space_id,
317 acpi_adr_space_handler handler);
319 #ifdef ACPI_FUTURE_USAGE
320 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
323 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
326 * Global Lock interfaces
328 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
329 acpi_acquire_global_lock(u16 timeout,
331 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
332 acpi_release_global_lock(u32 handle))
335 * Interfaces to AML mutex objects
338 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
340 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
343 * Fixed Event interfaces
345 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
346 acpi_enable_event(u32 event, u32 flags))
348 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
349 acpi_disable_event(u32 event, u32 flags))
351 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
353 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
354 acpi_get_event_status(u32 event,
358 * General Purpose Event (GPE) Interfaces
360 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
362 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
363 acpi_enable_gpe(acpi_handle gpe_device,
366 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
367 acpi_disable_gpe(acpi_handle gpe_device,
370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
371 acpi_clear_gpe(acpi_handle gpe_device,
374 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
375 acpi_set_gpe(acpi_handle gpe_device,
376 u32 gpe_number, u8 action))
378 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
379 acpi_finish_gpe(acpi_handle gpe_device,
382 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
383 acpi_setup_gpe_for_wake(acpi_handle
385 acpi_handle gpe_device,
387 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
388 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
391 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
392 acpi_get_gpe_status(acpi_handle gpe_device,
397 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
399 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
401 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
402 acpi_get_gpe_device(u32 gpe_index,
403 acpi_handle * gpe_device))
405 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
406 acpi_install_gpe_block(acpi_handle gpe_device,
411 u32 interrupt_number))
412 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
413 acpi_remove_gpe_block(acpi_handle gpe_device))
416 * Resource interfaces
419 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
423 acpi_get_vendor_resource(acpi_handle device,
425 struct acpi_vendor_uuid *uuid,
426 struct acpi_buffer *ret_buffer);
429 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
431 #ifdef ACPI_FUTURE_USAGE
433 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
437 acpi_get_event_resources(acpi_handle device_handle,
438 struct acpi_buffer *ret_buffer);
441 acpi_walk_resources(acpi_handle device,
443 acpi_walk_resource_callback user_function, void *context);
446 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
449 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
452 acpi_resource_to_address64(struct acpi_resource *resource,
453 struct acpi_resource_address64 *out);
456 acpi_buffer_to_resource(u8 *aml_buffer,
457 u16 aml_buffer_length,
458 struct acpi_resource **resource_ptr);
461 * Hardware (ACPI device) interfaces
463 acpi_status acpi_reset(void);
465 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
466 acpi_read_bit_register(u32 register_id,
469 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
470 acpi_write_bit_register(u32 register_id,
473 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
474 acpi_set_firmware_waking_vector(u32
477 #if ACPI_MACHINE_WIDTH == 64
478 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
479 acpi_set_firmware_waking_vector64(u64
483 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
485 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
488 * Sleep/Wake interfaces
491 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
493 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
495 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
497 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
499 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
501 acpi_status acpi_leave_sleep_state(u8 sleep_state);
504 * ACPI Timer interfaces
506 #ifdef ACPI_FUTURE_USAGE
507 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
508 acpi_get_timer_resolution(u32 *resolution))
510 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
512 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
513 acpi_get_timer_duration(u32 start_ticks,
516 #endif /* ACPI_FUTURE_USAGE */
519 * Error/Warning output
521 void ACPI_INTERNAL_VAR_XFACE
522 acpi_error(const char *module_name,
523 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
525 void ACPI_INTERNAL_VAR_XFACE
526 acpi_exception(const char *module_name,
528 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
530 void ACPI_INTERNAL_VAR_XFACE
531 acpi_warning(const char *module_name,
532 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
534 void ACPI_INTERNAL_VAR_XFACE
535 acpi_info(const char *module_name,
536 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
538 void ACPI_INTERNAL_VAR_XFACE
539 acpi_bios_error(const char *module_name,
540 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
542 void ACPI_INTERNAL_VAR_XFACE
543 acpi_bios_warning(const char *module_name,
544 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
549 #ifdef ACPI_DEBUG_OUTPUT
551 void ACPI_INTERNAL_VAR_XFACE
552 acpi_debug_print(u32 requested_debug_level,
554 const char *function_name,
555 const char *module_name,
556 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
558 void ACPI_INTERNAL_VAR_XFACE
559 acpi_debug_print_raw(u32 requested_debug_level,
561 const char *function_name,
562 const char *module_name,
564 const char *format, ...) ACPI_PRINTF_LIKE(6);
567 #endif /* __ACXFACE_H__ */