1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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 0x20140214
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_auto_serialize_methods
;
75 extern u8 acpi_gbl_copy_dsdt_locally
;
76 extern u8 acpi_gbl_create_osi_method
;
77 extern u8 acpi_gbl_disable_auto_repair
;
78 extern u8 acpi_gbl_disable_ssdt_table_load
;
79 extern u8 acpi_gbl_do_not_use_xsdt
;
80 extern u8 acpi_gbl_enable_aml_debug_object
;
81 extern u8 acpi_gbl_enable_interpreter_slack
;
82 extern u32 acpi_gbl_trace_flags
;
83 extern acpi_name acpi_gbl_trace_method_name
;
84 extern u8 acpi_gbl_truncate_io_addresses
;
85 extern u8 acpi_gbl_use32_bit_fadt_addresses
;
86 extern u8 acpi_gbl_use_default_register_widths
;
89 * Hardware-reduced prototypes. All interfaces that use these macros will
90 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
93 #if (!ACPI_REDUCED_HARDWARE)
94 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
97 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
100 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
104 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
105 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
107 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
108 static ACPI_INLINE prototype {return(AE_OK);}
110 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
111 static ACPI_INLINE prototype {return;}
113 #endif /* !ACPI_REDUCED_HARDWARE */
119 acpi_initialize_tables(struct acpi_table_desc
*initial_storage
,
120 u32 initial_table_count
, u8 allow_resize
);
122 acpi_status __init
acpi_initialize_subsystem(void);
124 acpi_status __init
acpi_enable_subsystem(u32 flags
);
126 acpi_status __init
acpi_initialize_objects(u32 flags
);
128 acpi_status __init
acpi_terminate(void);
131 * Miscellaneous global interfaces
133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enable(void))
134 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_disable(void))
135 #ifdef ACPI_FUTURE_USAGE
136 acpi_status
acpi_subsystem_status(void);
139 #ifdef ACPI_FUTURE_USAGE
140 acpi_status
acpi_get_system_info(struct acpi_buffer
*ret_buffer
);
143 acpi_status
acpi_get_statistics(struct acpi_statistics
*stats
);
145 const char *acpi_format_exception(acpi_status exception
);
147 acpi_status
acpi_purge_cached_objects(void);
149 acpi_status
acpi_install_interface(acpi_string interface_name
);
151 acpi_status
acpi_remove_interface(acpi_string interface_name
);
153 acpi_status
acpi_update_interfaces(u8 action
);
156 acpi_check_address_range(acpi_adr_space_type space_id
,
157 acpi_physical_address address
,
158 acpi_size length
, u8 warn
);
161 acpi_decode_pld_buffer(u8
*in_buffer
,
162 acpi_size length
, struct acpi_pld_info
**return_buffer
);
165 * ACPI table load/unload interfaces
167 acpi_status
acpi_load_table(struct acpi_table_header
*table
);
169 acpi_status
acpi_unload_parent_table(acpi_handle object
);
171 acpi_status __init
acpi_load_tables(void);
174 * ACPI table manipulation interfaces
176 acpi_status __init
acpi_reallocate_root_table(void);
178 acpi_status __init
acpi_find_root_pointer(acpi_size
*rsdp_address
);
180 acpi_status
acpi_unload_table_id(acpi_owner_id id
);
183 acpi_get_table_header(acpi_string signature
,
184 u32 instance
, struct acpi_table_header
*out_table_header
);
187 acpi_get_table_with_size(acpi_string signature
,
188 u32 instance
, struct acpi_table_header
**out_table
,
189 acpi_size
*tbl_size
);
192 acpi_get_table(acpi_string signature
,
193 u32 instance
, struct acpi_table_header
**out_table
);
196 acpi_get_table_by_index(u32 table_index
, struct acpi_table_header
**out_table
);
199 acpi_install_table_handler(acpi_table_handler handler
, void *context
);
201 acpi_status
acpi_remove_table_handler(acpi_table_handler handler
);
204 * Namespace and name interfaces
207 acpi_walk_namespace(acpi_object_type type
,
208 acpi_handle start_object
,
210 acpi_walk_callback descending_callback
,
211 acpi_walk_callback ascending_callback
,
212 void *context
, void **return_value
);
215 acpi_get_devices(const char *HID
,
216 acpi_walk_callback user_function
,
217 void *context
, void **return_value
);
220 acpi_get_name(acpi_handle object
,
221 u32 name_type
, struct acpi_buffer
*ret_path_ptr
);
224 acpi_get_handle(acpi_handle parent
,
225 acpi_string pathname
, acpi_handle
* ret_handle
);
228 acpi_attach_data(acpi_handle object
, acpi_object_handler handler
, void *data
);
230 acpi_status
acpi_detach_data(acpi_handle object
, acpi_object_handler handler
);
233 acpi_get_data_full(acpi_handle object
, acpi_object_handler handler
, void **data
,
234 void (*callback
)(void *));
237 acpi_get_data(acpi_handle object
, acpi_object_handler handler
, void **data
);
240 acpi_debug_trace(char *name
, u32 debug_level
, u32 debug_layer
, u32 flags
);
243 * Object manipulation and enumeration
246 acpi_evaluate_object(acpi_handle object
,
247 acpi_string pathname
,
248 struct acpi_object_list
*parameter_objects
,
249 struct acpi_buffer
*return_object_buffer
);
252 acpi_evaluate_object_typed(acpi_handle object
,
253 acpi_string pathname
,
254 struct acpi_object_list
*external_params
,
255 struct acpi_buffer
*return_buffer
,
256 acpi_object_type return_type
);
259 acpi_get_object_info(acpi_handle object
,
260 struct acpi_device_info
**return_buffer
);
262 acpi_status
acpi_install_method(u8
*buffer
);
265 acpi_get_next_object(acpi_object_type type
,
267 acpi_handle child
, acpi_handle
* out_handle
);
269 acpi_status
acpi_get_type(acpi_handle object
, acpi_object_type
* out_type
);
271 acpi_status
acpi_get_id(acpi_handle object
, acpi_owner_id
* out_type
);
273 acpi_status
acpi_get_parent(acpi_handle object
, acpi_handle
* out_handle
);
279 acpi_install_initialization_handler(acpi_init_handler handler
, u32 function
);
281 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
282 acpi_install_sci_handler(acpi_sci_handler
285 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
286 acpi_remove_sci_handler(acpi_sci_handler
288 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
289 acpi_install_global_event_handler
290 (acpi_gbl_event_handler handler
,
292 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
293 acpi_install_fixed_event_handler(u32
299 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
300 acpi_remove_fixed_event_handler(u32 acpi_event
,
303 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
304 acpi_install_gpe_handler(acpi_handle
311 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
312 acpi_remove_gpe_handler(acpi_handle gpe_device
,
316 acpi_status
acpi_install_notify_handler(acpi_handle device
, u32 handler_type
,
317 acpi_notify_handler handler
,
321 acpi_remove_notify_handler(acpi_handle device
,
322 u32 handler_type
, acpi_notify_handler handler
);
325 acpi_install_address_space_handler(acpi_handle device
,
326 acpi_adr_space_type space_id
,
327 acpi_adr_space_handler handler
,
328 acpi_adr_space_setup setup
, void *context
);
331 acpi_remove_address_space_handler(acpi_handle device
,
332 acpi_adr_space_type space_id
,
333 acpi_adr_space_handler handler
);
335 #ifdef ACPI_FUTURE_USAGE
336 acpi_status
acpi_install_exception_handler(acpi_exception_handler handler
);
339 acpi_status
acpi_install_interface_handler(acpi_interface_handler handler
);
342 * Global Lock interfaces
344 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
345 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
))
367 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_clear_event(u32 event
))
369 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
370 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
,
413 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_disable_all_gpes(void))
414 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enable_all_runtime_gpes(void))
416 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
417 acpi_get_gpe_device(u32 gpe_index
,
418 acpi_handle
* gpe_device
))
420 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
421 acpi_install_gpe_block(acpi_handle gpe_device
,
426 u32 interrupt_number
))
427 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
428 acpi_remove_gpe_block(acpi_handle gpe_device
))
431 * Resource interfaces
434 acpi_status(*acpi_walk_resource_callback
) (struct acpi_resource
* resource
,
438 acpi_get_vendor_resource(acpi_handle device
,
440 struct acpi_vendor_uuid
*uuid
,
441 struct acpi_buffer
*ret_buffer
);
444 acpi_get_current_resources(acpi_handle device
, struct acpi_buffer
*ret_buffer
);
446 #ifdef ACPI_FUTURE_USAGE
448 acpi_get_possible_resources(acpi_handle device
, struct acpi_buffer
*ret_buffer
);
452 acpi_get_event_resources(acpi_handle device_handle
,
453 struct acpi_buffer
*ret_buffer
);
456 acpi_walk_resource_buffer(struct acpi_buffer
*buffer
,
457 acpi_walk_resource_callback user_function
,
461 acpi_walk_resources(acpi_handle device
,
463 acpi_walk_resource_callback user_function
, void *context
);
466 acpi_set_current_resources(acpi_handle device
, struct acpi_buffer
*in_buffer
);
469 acpi_get_irq_routing_table(acpi_handle device
, struct acpi_buffer
*ret_buffer
);
472 acpi_resource_to_address64(struct acpi_resource
*resource
,
473 struct acpi_resource_address64
*out
);
476 acpi_buffer_to_resource(u8
*aml_buffer
,
477 u16 aml_buffer_length
,
478 struct acpi_resource
**resource_ptr
);
481 * Hardware (ACPI device) interfaces
483 acpi_status
acpi_reset(void);
485 acpi_status
acpi_read(u64
*value
, struct acpi_generic_address
*reg
);
487 acpi_status
acpi_write(u64 value
, struct acpi_generic_address
*reg
);
489 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
490 acpi_read_bit_register(u32 register_id
,
493 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
494 acpi_write_bit_register(u32 register_id
,
498 * Sleep/Wake interfaces
501 acpi_get_sleep_type_data(u8 sleep_state
, u8
*slp_typ_a
, u8
*slp_typ_b
);
503 acpi_status
acpi_enter_sleep_state_prep(u8 sleep_state
);
505 acpi_status
acpi_enter_sleep_state(u8 sleep_state
);
507 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_enter_sleep_state_s4bios(void))
509 acpi_status
acpi_leave_sleep_state_prep(u8 sleep_state
);
511 acpi_status
acpi_leave_sleep_state(u8 sleep_state
);
513 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
514 acpi_set_firmware_waking_vector(u32
516 #if ACPI_MACHINE_WIDTH == 64
517 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
518 acpi_set_firmware_waking_vector64(u64
522 * ACPI Timer interfaces
524 #ifdef ACPI_FUTURE_USAGE
525 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
526 acpi_get_timer_resolution(u32
*resolution
))
527 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
acpi_get_timer(u32
*ticks
))
529 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
530 acpi_get_timer_duration(u32 start_ticks
,
533 #endif /* ACPI_FUTURE_USAGE */
536 * Error/Warning output
539 void ACPI_INTERNAL_VAR_XFACE
540 acpi_error(const char *module_name
, u32 line_number
, const char *format
, ...);
543 void ACPI_INTERNAL_VAR_XFACE
544 acpi_exception(const char *module_name
,
545 u32 line_number
, acpi_status status
, const char *format
, ...);
548 void ACPI_INTERNAL_VAR_XFACE
549 acpi_warning(const char *module_name
, u32 line_number
, const char *format
, ...);
552 void ACPI_INTERNAL_VAR_XFACE
553 acpi_info(const char *module_name
, u32 line_number
, const char *format
, ...);
556 void ACPI_INTERNAL_VAR_XFACE
557 acpi_bios_error(const char *module_name
,
558 u32 line_number
, const char *format
, ...);
561 void ACPI_INTERNAL_VAR_XFACE
562 acpi_bios_warning(const char *module_name
,
563 u32 line_number
, const char *format
, ...);
568 #ifdef ACPI_DEBUG_OUTPUT
571 void ACPI_INTERNAL_VAR_XFACE
572 acpi_debug_print(u32 requested_debug_level
,
574 const char *function_name
,
575 const char *module_name
,
576 u32 component_id
, const char *format
, ...);
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
,
584 u32 component_id
, const char *format
, ...);
587 #endif /* __ACXFACE_H__ */