| /****************************************************************************** |
| * |
| * Name: acpixf.h - External interfaces to the ACPI subsystem |
| * |
| *****************************************************************************/ |
| |
| /* |
| * Copyright (C) 2000 - 2014, Intel Corp. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions, and the following disclaimer, |
| * without modification. |
| * 2. Redistributions in binary form must reproduce at minimum a disclaimer |
| * substantially similar to the "NO WARRANTY" disclaimer below |
| * ("Disclaimer") and any redistribution must be conditioned upon |
| * including a substantially similar Disclaimer requirement for further |
| * binary redistribution. |
| * 3. Neither the names of the above-listed copyright holders nor the names |
| * of any contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * Alternatively, this software may be distributed under the terms of the |
| * GNU General Public License ("GPL") version 2 as published by the Free |
| * Software Foundation. |
| * |
| * NO WARRANTY |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGES. |
| */ |
| |
| #ifndef __ACXFACE_H__ |
| #define __ACXFACE_H__ |
| |
| /* Current ACPICA subsystem version in YYYYMMDD format */ |
| |
| #define ACPI_CA_VERSION 0x20140114 |
| |
| #include <acpi/acconfig.h> |
| #include <acpi/actypes.h> |
| #include <acpi/actbl.h> |
| #include <acpi/acbuffer.h> |
| |
| extern u8 acpi_gbl_permanent_mmap; |
| |
| #pragma pack(push) /* Set default struct packing */ |
| |
| /* |
| * Globals that are publically available |
| */ |
| extern u32 acpi_current_gpe_count; |
| extern struct acpi_table_fadt acpi_gbl_FADT; |
| extern u8 acpi_gbl_system_awake_and_running; |
| extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */ |
| extern u8 acpi_gbl_osi_data; |
| |
| /* Runtime configuration of debug print levels */ |
| |
| extern u32 acpi_dbg_level; |
| extern u32 acpi_dbg_layer; |
| |
| /* ACPICA runtime options */ |
| |
| extern u8 acpi_gbl_all_methods_serialized; |
| extern u8 acpi_gbl_copy_dsdt_locally; |
| extern u8 acpi_gbl_create_osi_method; |
| extern u8 acpi_gbl_disable_auto_repair; |
| extern u8 acpi_gbl_disable_ssdt_table_load; |
| extern u8 acpi_gbl_do_not_use_xsdt; |
| extern u8 acpi_gbl_enable_aml_debug_object; |
| extern u8 acpi_gbl_enable_interpreter_slack; |
| extern u32 acpi_gbl_trace_flags; |
| extern acpi_name acpi_gbl_trace_method_name; |
| extern u8 acpi_gbl_truncate_io_addresses; |
| extern u8 acpi_gbl_use32_bit_fadt_addresses; |
| extern u8 acpi_gbl_use_default_register_widths; |
| |
| /* |
| * Hardware-reduced prototypes. All interfaces that use these macros will |
| * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag |
| * is set to TRUE. |
| */ |
| #if (!ACPI_REDUCED_HARDWARE) |
| #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \ |
| prototype; |
| |
| #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \ |
| prototype; |
| |
| #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \ |
| prototype; |
| |
| #else |
| #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \ |
| static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);} |
| |
| #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \ |
| static ACPI_INLINE prototype {return(AE_OK);} |
| |
| #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \ |
| static ACPI_INLINE prototype {return;} |
| |
| #endif /* !ACPI_REDUCED_HARDWARE */ |
| |
| /* |
| * Initialization |
| */ |
| acpi_status __init |
| acpi_initialize_tables(struct acpi_table_desc *initial_storage, |
| u32 initial_table_count, u8 allow_resize); |
| |
| acpi_status __init acpi_initialize_subsystem(void); |
| |
| acpi_status __init acpi_enable_subsystem(u32 flags); |
| |
| acpi_status __init acpi_initialize_objects(u32 flags); |
| |
| acpi_status __init acpi_terminate(void); |
| |
| /* |
| * Miscellaneous global interfaces |
| */ |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void)) |
| #ifdef ACPI_FUTURE_USAGE |
| acpi_status acpi_subsystem_status(void); |
| #endif |
| |
| #ifdef ACPI_FUTURE_USAGE |
| acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer); |
| #endif |
| |
| acpi_status acpi_get_statistics(struct acpi_statistics *stats); |
| |
| const char *acpi_format_exception(acpi_status exception); |
| |
| acpi_status acpi_purge_cached_objects(void); |
| |
| acpi_status acpi_install_interface(acpi_string interface_name); |
| |
| acpi_status acpi_remove_interface(acpi_string interface_name); |
| |
| acpi_status acpi_update_interfaces(u8 action); |
| |
| u32 |
| acpi_check_address_range(acpi_adr_space_type space_id, |
| acpi_physical_address address, |
| acpi_size length, u8 warn); |
| |
| acpi_status |
| acpi_decode_pld_buffer(u8 *in_buffer, |
| acpi_size length, struct acpi_pld_info **return_buffer); |
| |
| /* |
| * ACPI table load/unload interfaces |
| */ |
| acpi_status acpi_load_table(struct acpi_table_header *table); |
| |
| acpi_status acpi_unload_parent_table(acpi_handle object); |
| |
| acpi_status __init acpi_load_tables(void); |
| |
| /* |
| * ACPI table manipulation interfaces |
| */ |
| acpi_status __init acpi_reallocate_root_table(void); |
| |
| acpi_status __init acpi_find_root_pointer(acpi_size *rsdp_address); |
| |
| acpi_status acpi_unload_table_id(acpi_owner_id id); |
| |
| acpi_status |
| acpi_get_table_header(acpi_string signature, |
| u32 instance, struct acpi_table_header *out_table_header); |
| |
| acpi_status |
| acpi_get_table_with_size(acpi_string signature, |
| u32 instance, struct acpi_table_header **out_table, |
| acpi_size *tbl_size); |
| |
| acpi_status |
| acpi_get_table(acpi_string signature, |
| u32 instance, struct acpi_table_header **out_table); |
| |
| acpi_status |
| acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table); |
| |
| acpi_status |
| acpi_install_table_handler(acpi_table_handler handler, void *context); |
| |
| acpi_status acpi_remove_table_handler(acpi_table_handler handler); |
| |
| /* |
| * Namespace and name interfaces |
| */ |
| acpi_status |
| acpi_walk_namespace(acpi_object_type type, |
| acpi_handle start_object, |
| u32 max_depth, |
| acpi_walk_callback descending_callback, |
| acpi_walk_callback ascending_callback, |
| void *context, void **return_value); |
| |
| acpi_status |
| acpi_get_devices(const char *HID, |
| acpi_walk_callback user_function, |
| void *context, void **return_value); |
| |
| acpi_status |
| acpi_get_name(acpi_handle object, |
| u32 name_type, struct acpi_buffer *ret_path_ptr); |
| |
| acpi_status |
| acpi_get_handle(acpi_handle parent, |
| acpi_string pathname, acpi_handle * ret_handle); |
| |
| acpi_status |
| acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data); |
| |
| acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler); |
| |
| acpi_status |
| acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data); |
| |
| acpi_status |
| acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags); |
| |
| /* |
| * Object manipulation and enumeration |
| */ |
| acpi_status |
| acpi_evaluate_object(acpi_handle object, |
| acpi_string pathname, |
| struct acpi_object_list *parameter_objects, |
| struct acpi_buffer *return_object_buffer); |
| |
| acpi_status |
| acpi_evaluate_object_typed(acpi_handle object, |
| acpi_string pathname, |
| struct acpi_object_list *external_params, |
| struct acpi_buffer *return_buffer, |
| acpi_object_type return_type); |
| |
| acpi_status |
| acpi_get_object_info(acpi_handle object, |
| struct acpi_device_info **return_buffer); |
| |
| acpi_status acpi_install_method(u8 *buffer); |
| |
| acpi_status |
| acpi_get_next_object(acpi_object_type type, |
| acpi_handle parent, |
| acpi_handle child, acpi_handle * out_handle); |
| |
| acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type); |
| |
| acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type); |
| |
| acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle); |
| |
| /* |
| * Handler interfaces |
| */ |
| acpi_status |
| acpi_install_initialization_handler(acpi_init_handler handler, u32 function); |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_install_sci_handler(acpi_sci_handler |
| address, |
| void *context)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_remove_sci_handler(acpi_sci_handler |
| address)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_install_global_event_handler |
| (acpi_gbl_event_handler handler, |
| void *context)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_install_fixed_event_handler(u32 |
| acpi_event, |
| acpi_event_handler |
| handler, |
| void |
| *context)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_remove_fixed_event_handler(u32 acpi_event, |
| acpi_event_handler |
| handler)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_install_gpe_handler(acpi_handle |
| gpe_device, |
| u32 gpe_number, |
| u32 type, |
| acpi_gpe_handler |
| address, |
| void *context)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_remove_gpe_handler(acpi_handle gpe_device, |
| u32 gpe_number, |
| acpi_gpe_handler |
| address)) |
| acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type, |
| acpi_notify_handler handler, |
| void *context); |
| |
| acpi_status |
| acpi_remove_notify_handler(acpi_handle device, |
| u32 handler_type, acpi_notify_handler handler); |
| |
| acpi_status |
| acpi_install_address_space_handler(acpi_handle device, |
| acpi_adr_space_type space_id, |
| acpi_adr_space_handler handler, |
| acpi_adr_space_setup setup, void *context); |
| |
| acpi_status |
| acpi_remove_address_space_handler(acpi_handle device, |
| acpi_adr_space_type space_id, |
| acpi_adr_space_handler handler); |
| |
| #ifdef ACPI_FUTURE_USAGE |
| acpi_status acpi_install_exception_handler(acpi_exception_handler handler); |
| #endif |
| |
| acpi_status acpi_install_interface_handler(acpi_interface_handler handler); |
| |
| /* |
| * Global Lock interfaces |
| */ |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_acquire_global_lock(u16 timeout, |
| u32 *handle)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_release_global_lock(u32 handle)) |
| |
| /* |
| * Interfaces to AML mutex objects |
| */ |
| acpi_status |
| acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout); |
| |
| acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname); |
| |
| /* |
| * Fixed Event interfaces |
| */ |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_enable_event(u32 event, u32 flags)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_disable_event(u32 event, u32 flags)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_get_event_status(u32 event, |
| acpi_event_status |
| *event_status)) |
| |
| /* |
| * General Purpose Event (GPE) Interfaces |
| */ |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_enable_gpe(acpi_handle gpe_device, |
| u32 gpe_number)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_disable_gpe(acpi_handle gpe_device, |
| u32 gpe_number)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_clear_gpe(acpi_handle gpe_device, |
| u32 gpe_number)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_set_gpe(acpi_handle gpe_device, |
| u32 gpe_number, u8 action)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_finish_gpe(acpi_handle gpe_device, |
| u32 gpe_number)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_setup_gpe_for_wake(acpi_handle |
| parent_device, |
| acpi_handle gpe_device, |
| u32 gpe_number)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_set_gpe_wake_mask(acpi_handle gpe_device, |
| u32 gpe_number, |
| u8 action)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_get_gpe_status(acpi_handle gpe_device, |
| u32 gpe_number, |
| acpi_event_status |
| *event_status)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_get_gpe_device(u32 gpe_index, |
| acpi_handle * gpe_device)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_install_gpe_block(acpi_handle gpe_device, |
| struct |
| acpi_generic_address |
| *gpe_block_address, |
| u32 register_count, |
| u32 interrupt_number)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_remove_gpe_block(acpi_handle gpe_device)) |
| |
| /* |
| * Resource interfaces |
| */ |
| typedef |
| acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource, |
| void *context); |
| |
| acpi_status |
| acpi_get_vendor_resource(acpi_handle device, |
| char *name, |
| struct acpi_vendor_uuid *uuid, |
| struct acpi_buffer *ret_buffer); |
| |
| acpi_status |
| acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer); |
| |
| #ifdef ACPI_FUTURE_USAGE |
| acpi_status |
| acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer); |
| #endif |
| |
| acpi_status |
| acpi_get_event_resources(acpi_handle device_handle, |
| struct acpi_buffer *ret_buffer); |
| |
| acpi_status |
| acpi_walk_resource_buffer(struct acpi_buffer *buffer, |
| acpi_walk_resource_callback user_function, |
| void *context); |
| |
| acpi_status |
| acpi_walk_resources(acpi_handle device, |
| char *name, |
| acpi_walk_resource_callback user_function, void *context); |
| |
| acpi_status |
| acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer); |
| |
| acpi_status |
| acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer); |
| |
| acpi_status |
| acpi_resource_to_address64(struct acpi_resource *resource, |
| struct acpi_resource_address64 *out); |
| |
| acpi_status |
| acpi_buffer_to_resource(u8 *aml_buffer, |
| u16 aml_buffer_length, |
| struct acpi_resource **resource_ptr); |
| |
| /* |
| * Hardware (ACPI device) interfaces |
| */ |
| acpi_status acpi_reset(void); |
| |
| acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg); |
| |
| acpi_status acpi_write(u64 value, struct acpi_generic_address *reg); |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_read_bit_register(u32 register_id, |
| u32 *return_value)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_write_bit_register(u32 register_id, |
| u32 value)) |
| |
| /* |
| * Sleep/Wake interfaces |
| */ |
| acpi_status |
| acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b); |
| |
| acpi_status acpi_enter_sleep_state_prep(u8 sleep_state); |
| |
| acpi_status acpi_enter_sleep_state(u8 sleep_state); |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void)) |
| |
| acpi_status acpi_leave_sleep_state_prep(u8 sleep_state); |
| |
| acpi_status acpi_leave_sleep_state(u8 sleep_state); |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_set_firmware_waking_vector(u32 |
| physical_address)) |
| #if ACPI_MACHINE_WIDTH == 64 |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_set_firmware_waking_vector64(u64 |
| physical_address)) |
| #endif |
| /* |
| * ACPI Timer interfaces |
| */ |
| #ifdef ACPI_FUTURE_USAGE |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_get_timer_resolution(u32 *resolution)) |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks)) |
| |
| ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status |
| acpi_get_timer_duration(u32 start_ticks, |
| u32 end_ticks, |
| u32 *time_elapsed)) |
| #endif /* ACPI_FUTURE_USAGE */ |
| |
| /* |
| * Error/Warning output |
| */ |
| ACPI_PRINTF_LIKE(3) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_error(const char *module_name, u32 line_number, const char *format, ...); |
| |
| ACPI_PRINTF_LIKE(4) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_exception(const char *module_name, |
| u32 line_number, acpi_status status, const char *format, ...); |
| |
| ACPI_PRINTF_LIKE(3) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_warning(const char *module_name, u32 line_number, const char *format, ...); |
| |
| ACPI_PRINTF_LIKE(3) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_info(const char *module_name, u32 line_number, const char *format, ...); |
| |
| ACPI_PRINTF_LIKE(3) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_bios_error(const char *module_name, |
| u32 line_number, const char *format, ...); |
| |
| ACPI_PRINTF_LIKE(3) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_bios_warning(const char *module_name, |
| u32 line_number, const char *format, ...); |
| |
| /* |
| * Debug output |
| */ |
| #ifdef ACPI_DEBUG_OUTPUT |
| |
| ACPI_PRINTF_LIKE(6) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_debug_print(u32 requested_debug_level, |
| u32 line_number, |
| const char *function_name, |
| const char *module_name, |
| u32 component_id, const char *format, ...); |
| |
| ACPI_PRINTF_LIKE(6) |
| void ACPI_INTERNAL_VAR_XFACE |
| acpi_debug_print_raw(u32 requested_debug_level, |
| u32 line_number, |
| const char *function_name, |
| const char *module_name, |
| u32 component_id, const char *format, ...); |
| #endif |
| |
| #pragma pack(pop) /* Restore original struct packing */ |
| |
| #endif /* __ACXFACE_H__ */ |
