1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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 0x20130823
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 publically available
61 extern u32 acpi_current_gpe_count;
62 extern struct acpi_table_fadt acpi_gbl_FADT;
63 extern u8 acpi_gbl_system_awake_and_running;
64 extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */
65 extern u8 acpi_gbl_osi_data;
67 /* Runtime configuration of debug print levels */
69 extern u32 acpi_dbg_level;
70 extern u32 acpi_dbg_layer;
72 /* ACPICA runtime options */
74 extern u8 acpi_gbl_enable_interpreter_slack;
75 extern u8 acpi_gbl_all_methods_serialized;
76 extern u8 acpi_gbl_create_osi_method;
77 extern u8 acpi_gbl_use_default_register_widths;
78 extern acpi_name acpi_gbl_trace_method_name;
79 extern u32 acpi_gbl_trace_flags;
80 extern bool acpi_gbl_enable_aml_debug_object;
81 extern u8 acpi_gbl_copy_dsdt_locally;
82 extern u8 acpi_gbl_truncate_io_addresses;
83 extern u8 acpi_gbl_disable_auto_repair;
84 extern u8 acpi_gbl_disable_ssdt_table_load;
87 * Hardware-reduced prototypes. All interfaces that use these macros will
88 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
91 #if (!ACPI_REDUCED_HARDWARE)
92 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
95 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
98 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
102 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
103 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
105 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
106 static ACPI_INLINE prototype {return(AE_OK);}
108 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
109 static ACPI_INLINE prototype {}
111 #endif /* !ACPI_REDUCED_HARDWARE */
113 extern u32 acpi_rsdt_forced;
118 acpi_initialize_tables(struct acpi_table_desc *initial_storage,
119 u32 initial_table_count, u8 allow_resize);
121 acpi_status __init acpi_initialize_subsystem(void);
123 acpi_status acpi_enable_subsystem(u32 flags);
125 acpi_status acpi_initialize_objects(u32 flags);
127 acpi_status acpi_terminate(void);
130 * Miscellaneous global interfaces
132 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
134 #ifdef ACPI_FUTURE_USAGE
135 acpi_status acpi_subsystem_status(void);
138 #ifdef ACPI_FUTURE_USAGE
139 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
142 const char *acpi_format_exception(acpi_status exception);
144 acpi_status acpi_purge_cached_objects(void);
146 acpi_status acpi_install_interface(acpi_string interface_name);
148 acpi_status acpi_remove_interface(acpi_string interface_name);
150 acpi_status acpi_update_interfaces(u8 action);
153 acpi_check_address_range(acpi_adr_space_type space_id,
154 acpi_physical_address address,
155 acpi_size length, u8 warn);
158 acpi_decode_pld_buffer(u8 *in_buffer,
159 acpi_size length, struct acpi_pld_info **return_buffer);
162 * ACPI Memory management
164 void *acpi_allocate(u32 size);
166 void *acpi_callocate(u32 size);
168 void acpi_free(void *address);
171 * ACPI table load/unload interfaces
173 acpi_status acpi_load_table(struct acpi_table_header *table);
175 acpi_status acpi_unload_parent_table(acpi_handle object);
177 acpi_status acpi_load_tables(void);
180 * ACPI table manipulation interfaces
182 acpi_status acpi_reallocate_root_table(void);
184 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
186 acpi_status acpi_unload_table_id(acpi_owner_id id);
189 acpi_get_table_header(acpi_string signature,
190 u32 instance, struct acpi_table_header *out_table_header);
193 acpi_get_table_with_size(acpi_string signature,
194 u32 instance, struct acpi_table_header **out_table,
195 acpi_size *tbl_size);
197 acpi_get_table(acpi_string signature,
198 u32 instance, struct acpi_table_header **out_table);
201 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
204 acpi_install_table_handler(acpi_table_handler handler, void *context);
206 acpi_status acpi_remove_table_handler(acpi_table_handler handler);
209 * Namespace and name interfaces
212 acpi_walk_namespace(acpi_object_type type,
213 acpi_handle start_object,
215 acpi_walk_callback descending_callback,
216 acpi_walk_callback ascending_callback,
217 void *context, void **return_value);
220 acpi_get_devices(const char *HID,
221 acpi_walk_callback user_function,
222 void *context, void **return_value);
225 acpi_get_name(acpi_handle object,
226 u32 name_type, struct acpi_buffer *ret_path_ptr);
229 acpi_get_handle(acpi_handle parent,
230 acpi_string pathname, acpi_handle * ret_handle);
233 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
235 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
238 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
241 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
244 * Object manipulation and enumeration
247 acpi_evaluate_object(acpi_handle object,
248 acpi_string pathname,
249 struct acpi_object_list *parameter_objects,
250 struct acpi_buffer *return_object_buffer);
253 acpi_evaluate_object_typed(acpi_handle object,
254 acpi_string pathname,
255 struct acpi_object_list *external_params,
256 struct acpi_buffer *return_buffer,
257 acpi_object_type return_type);
260 acpi_get_object_info(acpi_handle object,
261 struct acpi_device_info **return_buffer);
263 acpi_status acpi_install_method(u8 *buffer);
266 acpi_get_next_object(acpi_object_type type,
268 acpi_handle child, acpi_handle * out_handle);
270 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
272 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
274 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
280 acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
282 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
283 acpi_install_sci_handler(acpi_sci_handler
286 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
287 acpi_remove_sci_handler(acpi_sci_handler
289 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
290 acpi_install_global_event_handler
291 (acpi_gbl_event_handler handler,
293 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
294 acpi_install_fixed_event_handler(u32
300 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
301 acpi_remove_fixed_event_handler(u32 acpi_event,
304 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
305 acpi_install_gpe_handler(acpi_handle
312 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
313 acpi_remove_gpe_handler(acpi_handle gpe_device,
317 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
318 acpi_notify_handler handler,
322 acpi_remove_notify_handler(acpi_handle device,
323 u32 handler_type, acpi_notify_handler handler);
326 acpi_install_address_space_handler(acpi_handle device,
327 acpi_adr_space_type space_id,
328 acpi_adr_space_handler handler,
329 acpi_adr_space_setup setup, void *context);
332 acpi_remove_address_space_handler(acpi_handle device,
333 acpi_adr_space_type space_id,
334 acpi_adr_space_handler handler);
336 #ifdef ACPI_FUTURE_USAGE
337 acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
340 acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
343 * Global Lock interfaces
345 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
346 acpi_acquire_global_lock(u16 timeout,
348 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
349 acpi_release_global_lock(u32 handle))
352 * Interfaces to AML mutex objects
355 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
357 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
360 * Fixed Event interfaces
362 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
363 acpi_enable_event(u32 event, u32 flags))
365 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
366 acpi_disable_event(u32 event, u32 flags))
368 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
371 acpi_get_event_status(u32 event,
375 * General Purpose Event (GPE) Interfaces
377 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
379 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
380 acpi_enable_gpe(acpi_handle gpe_device,
383 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
384 acpi_disable_gpe(acpi_handle gpe_device,
387 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
388 acpi_clear_gpe(acpi_handle gpe_device,
391 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
392 acpi_set_gpe(acpi_handle gpe_device,
393 u32 gpe_number, u8 action))
395 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
396 acpi_finish_gpe(acpi_handle gpe_device,
399 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
400 acpi_setup_gpe_for_wake(acpi_handle
402 acpi_handle gpe_device,
404 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
405 acpi_set_gpe_wake_mask(acpi_handle gpe_device,
408 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
409 acpi_get_gpe_status(acpi_handle gpe_device,
414 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
416 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
418 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
419 acpi_get_gpe_device(u32 gpe_index,
420 acpi_handle * gpe_device))
422 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
423 acpi_install_gpe_block(acpi_handle gpe_device,
428 u32 interrupt_number))
429 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
430 acpi_remove_gpe_block(acpi_handle gpe_device))
433 * Resource interfaces
436 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
440 acpi_get_vendor_resource(acpi_handle device,
442 struct acpi_vendor_uuid *uuid,
443 struct acpi_buffer *ret_buffer);
446 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
448 #ifdef ACPI_FUTURE_USAGE
450 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
454 acpi_get_event_resources(acpi_handle device_handle,
455 struct acpi_buffer *ret_buffer);
458 acpi_walk_resource_buffer(struct acpi_buffer *buffer,
459 acpi_walk_resource_callback user_function,
463 acpi_walk_resources(acpi_handle device,
465 acpi_walk_resource_callback user_function, void *context);
468 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
471 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
474 acpi_resource_to_address64(struct acpi_resource *resource,
475 struct acpi_resource_address64 *out);
478 acpi_buffer_to_resource(u8 *aml_buffer,
479 u16 aml_buffer_length,
480 struct acpi_resource **resource_ptr);
483 * Hardware (ACPI device) interfaces
485 acpi_status acpi_reset(void);
487 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg);
489 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
491 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
492 acpi_read_bit_register(u32 register_id,
495 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
496 acpi_write_bit_register(u32 register_id,
500 * Sleep/Wake interfaces
503 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
505 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
507 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
509 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
511 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
513 acpi_status acpi_leave_sleep_state(u8 sleep_state);
515 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
516 acpi_set_firmware_waking_vector(u32
519 #if ACPI_MACHINE_WIDTH == 64
520 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
521 acpi_set_firmware_waking_vector64(u64
525 * ACPI Timer interfaces
527 #ifdef ACPI_FUTURE_USAGE
528 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
529 acpi_get_timer_resolution(u32 *resolution))
531 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
533 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
534 acpi_get_timer_duration(u32 start_ticks,
537 #endif /* ACPI_FUTURE_USAGE */
540 * Error/Warning output
542 void ACPI_INTERNAL_VAR_XFACE
543 acpi_error(const char *module_name,
544 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
546 void ACPI_INTERNAL_VAR_XFACE
547 acpi_exception(const char *module_name,
549 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
551 void ACPI_INTERNAL_VAR_XFACE
552 acpi_warning(const char *module_name,
553 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
555 void ACPI_INTERNAL_VAR_XFACE
556 acpi_info(const char *module_name,
557 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
559 void ACPI_INTERNAL_VAR_XFACE
560 acpi_bios_error(const char *module_name,
561 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
563 void ACPI_INTERNAL_VAR_XFACE
564 acpi_bios_warning(const char *module_name,
565 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
570 #ifdef ACPI_DEBUG_OUTPUT
572 void ACPI_INTERNAL_VAR_XFACE
573 acpi_debug_print(u32 requested_debug_level,
575 const char *function_name,
576 const char *module_name,
577 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
579 void ACPI_INTERNAL_VAR_XFACE
580 acpi_debug_print_raw(u32 requested_debug_level,
582 const char *function_name,
583 const char *module_name,
585 const char *format, ...) ACPI_PRINTF_LIKE(6);
588 #endif /* __ACXFACE_H__ */