[mirror_ubuntu-zesty-kernel.git] / include / acpi / acpixf.h

/******************************************************************************
 *
 * Name: acpixf.h - External interfaces to the ACPI subsystem
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2012, 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                 0x20121220

#include <acpi/acconfig.h>
#include <acpi/actypes.h>
#include <acpi/actbl.h>
#include <acpi/acbuffer.h>

extern u8 acpi_gbl_permanent_mmap;

/*
 * 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 */

/* Runtime configuration of debug print levels */

extern u32 acpi_dbg_level;
extern u32 acpi_dbg_layer;

/* ACPICA runtime options */

extern u8 acpi_gbl_enable_interpreter_slack;
extern u8 acpi_gbl_all_methods_serialized;
extern u8 acpi_gbl_create_osi_method;
extern u8 acpi_gbl_use_default_register_widths;
extern acpi_name acpi_gbl_trace_method_name;
extern u32 acpi_gbl_trace_flags;
extern bool acpi_gbl_enable_aml_debug_object;
extern u8 acpi_gbl_copy_dsdt_locally;
extern u8 acpi_gbl_truncate_io_addresses;
extern u8 acpi_gbl_disable_auto_repair;

/*
 * 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 {}

#endif				/* !ACPI_REDUCED_HARDWARE */

extern u32 acpi_rsdt_forced;
/*
 * Initialization
 */
acpi_status
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 acpi_enable_subsystem(u32 flags);

acpi_status acpi_initialize_objects(u32 flags);

acpi_status 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

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);

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 Memory management
 */
void *acpi_allocate(u32 size);

void *acpi_callocate(u32 size);

void acpi_free(void *address);

/*
 * 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 acpi_load_tables(void);

/*
 * ACPI table manipulation interfaces
 */
acpi_status acpi_reallocate_root_table(void);

acpi_status 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_tbl_handler handler, void *context);

acpi_status acpi_remove_table_handler(acpi_tbl_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 pre_order_visit,
		    acpi_walk_callback post_order_visit,
		    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_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 asmlinkage acpi_enter_sleep_state(u8 sleep_state);

ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage 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
 */
void ACPI_INTERNAL_VAR_XFACE
acpi_error(const char *module_name,
	   u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);

void ACPI_INTERNAL_VAR_XFACE
acpi_exception(const char *module_name,
	       u32 line_number,
	       acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);

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, ...) ACPI_PRINTF_LIKE(3);

/*
 * Debug output
 */
#ifdef ACPI_DEBUG_OUTPUT

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, ...) ACPI_PRINTF_LIKE(6);
#endif

#endif				/* __ACXFACE_H__ */
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acpixf.h - External interfaces to the ACPI subsystem
	4	*
	5	*****************************************************************************/
	6
	7	/*
75e7386b	8	* Copyright (C) 2000 - 2012, Intel Corp.
1da177e4 LT	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	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.
	25	*
	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.
	29	*
	30	* NO WARRANTY
	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.
	42	*/
	43
1da177e4 LT	44	#ifndef __ACXFACE_H__
	45	#define __ACXFACE_H__
	46
50df4d8b BM	47	/* Current ACPICA subsystem version in YYYYMMDD format */
50df4d8b BM	48
f55994f2	49	#define ACPI_CA_VERSION 0x20121220
50df4d8b	50
a1ce3928 DH	51	#include <acpi/acconfig.h>
	52	#include <acpi/actypes.h>
	53	#include <acpi/actbl.h>
d8dc91b7	54	#include <acpi/acbuffer.h>
1da177e4	55
889c78be LM	56	extern u8 acpi_gbl_permanent_mmap;
889c78be LM	57
50df4d8b	58	/*
75c8044f	59	* Globals that are publically available
50df4d8b	60	*/
739dcbb9 LZ	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 */
3e8214e5	65
75c8044f	66	/* Runtime configuration of debug print levels */
3e8214e5	67
50df4d8b BM	68	extern u32 acpi_dbg_level;
50df4d8b BM	69	extern u32 acpi_dbg_layer;
3e8214e5	70
75c8044f	71	/* ACPICA runtime options */
3e8214e5	72
50df4d8b BM	73	extern u8 acpi_gbl_enable_interpreter_slack;
	74	extern u8 acpi_gbl_all_methods_serialized;
	75	extern u8 acpi_gbl_create_osi_method;
f8d80cdf	76	extern u8 acpi_gbl_use_default_register_widths;
50df4d8b BM	77	extern acpi_name acpi_gbl_trace_method_name;
50df4d8b BM	78	extern u32 acpi_gbl_trace_flags;
90ab5ee9	79	extern bool acpi_gbl_enable_aml_debug_object;
69ec87ef	80	extern u8 acpi_gbl_copy_dsdt_locally;
b681f7d9	81	extern u8 acpi_gbl_truncate_io_addresses;
d57b23ad	82	extern u8 acpi_gbl_disable_auto_repair;
50df4d8b	83
33620c54 BM	84	/*
	85	* Hardware-reduced prototypes. All interfaces that use these macros will
	86	* be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
	87	* is set to TRUE.
	88	*/
	89	#if (!ACPI_REDUCED_HARDWARE)
	90	#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
	91	prototype;
	92
	93	#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
	94	prototype;
	95
	96	#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
	97	prototype;
	98
	99	#else
	100	#define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
	101	static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
	102
	103	#define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
	104	static ACPI_INLINE prototype {return(AE_OK);}
	105
	106	#define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
	107	static ACPI_INLINE prototype {}
	108
	109	#endif /* !ACPI_REDUCED_HARDWARE */
	110
237889bf	111	extern u32 acpi_rsdt_forced;
44f6c012	112	/*
75c8044f	113	* Initialization
1da177e4	114	*/
f3d2e786 BM	115	acpi_status
	116	acpi_initialize_tables(struct acpi_table_desc *initial_storage,
	117	u32 initial_table_count, u8 allow_resize);
	118
dd272b57	119	acpi_status __init acpi_initialize_subsystem(void);
1da177e4	120
4be44fcd	121	acpi_status acpi_enable_subsystem(u32 flags);
1da177e4	122
4be44fcd	123	acpi_status acpi_initialize_objects(u32 flags);
1da177e4	124
4be44fcd	125	acpi_status acpi_terminate(void);
1da177e4	126
75c8044f LZ	127	/*
	128	* Miscellaneous global interfaces
	129	*/
33620c54 BM	130	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
33620c54 BM	131	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
739dcbb9 LZ	132	#ifdef ACPI_FUTURE_USAGE
	133	acpi_status acpi_subsystem_status(void);
	134	#endif
1da177e4 LT	135
1da177e4 LT	136	#ifdef ACPI_FUTURE_USAGE
4be44fcd	137	acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer);
1da177e4 LT	138	#endif
1da177e4 LT	139
4be44fcd	140	const char *acpi_format_exception(acpi_status exception);
1da177e4	141
4be44fcd	142	acpi_status acpi_purge_cached_objects(void);
1da177e4	143
b0ed7a91 LM	144	acpi_status acpi_install_interface(acpi_string interface_name);
	145
	146	acpi_status acpi_remove_interface(acpi_string interface_name);
	147
f654c0fe LM	148	u32
	149	acpi_check_address_range(acpi_adr_space_type space_id,
	150	acpi_physical_address address,
	151	acpi_size length, u8 warn);
	152
be030a57 BM	153	acpi_status
	154	acpi_decode_pld_buffer(u8 *in_buffer,
	155	acpi_size length, struct acpi_pld_info **return_buffer);
	156
1da177e4	157	/*
aee07ba6	158	* ACPI Memory management
1da177e4	159	*/
4be44fcd	160	void *acpi_allocate(u32 size);
1da177e4	161
4be44fcd	162	void *acpi_callocate(u32 size);
1da177e4	163
4be44fcd	164	void acpi_free(void *address);
1da177e4 LT	165
1da177e4 LT	166	/*
f60d8181	167	* ACPI table load/unload interfaces
1da177e4	168	*/
f60d8181	169	acpi_status acpi_load_table(struct acpi_table_header *table);
f3d2e786	170
f60d8181	171	acpi_status acpi_unload_parent_table(acpi_handle object);
1da177e4	172
4be44fcd	173	acpi_status acpi_load_tables(void);
1da177e4	174
f60d8181 BM	175	/*
	176	* ACPI table manipulation interfaces
	177	*/
	178	acpi_status acpi_reallocate_root_table(void);
	179
	180	acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
1da177e4	181
f3d2e786	182	acpi_status acpi_unload_table_id(acpi_owner_id id);
1da177e4 LT	183
1da177e4 LT	184	acpi_status
f3d2e786	185	acpi_get_table_header(acpi_string signature,
1f86e8c1	186	u32 instance, struct acpi_table_header *out_table_header);
1da177e4 LT	187
1da177e4 LT	188	acpi_status
7d97277b YL	189	acpi_get_table_with_size(acpi_string signature,
	190	u32 instance, struct acpi_table_header **out_table,
	191	acpi_size *tbl_size);
	192	acpi_status
f3d2e786	193	acpi_get_table(acpi_string signature,
67a119f9	194	u32 instance, struct acpi_table_header **out_table);
1da177e4 LT	195
1da177e4 LT	196	acpi_status
1f86e8c1	197	acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table);
1da177e4	198
3e08e2d2 LM	199	acpi_status
	200	acpi_install_table_handler(acpi_tbl_handler handler, void *context);
	201
	202	acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
	203
1da177e4 LT	204	/*
	205	* Namespace and name interfaces
	206	*/
1da177e4	207	acpi_status
4be44fcd LB	208	acpi_walk_namespace(acpi_object_type type,
	209	acpi_handle start_object,
	210	u32 max_depth,
2263576c LM	211	acpi_walk_callback pre_order_visit,
2263576c LM	212	acpi_walk_callback post_order_visit,
4be44fcd	213	void context, void *return_value);
1da177e4 LT	214
1da177e4 LT	215	acpi_status
70b30fb1	216	acpi_get_devices(const char *HID,
4be44fcd LB	217	acpi_walk_callback user_function,
4be44fcd LB	218	void context, void *return_value);
1da177e4 LT	219
1da177e4 LT	220	acpi_status
b47cf58e	221	acpi_get_name(acpi_handle object,
4be44fcd	222	u32 name_type, struct acpi_buffer *ret_path_ptr);
1da177e4 LT	223
1da177e4 LT	224	acpi_status
4be44fcd LB	225	acpi_get_handle(acpi_handle parent,
4be44fcd LB	226	acpi_string pathname, acpi_handle * ret_handle);
1da177e4 LT	227
1da177e4 LT	228	acpi_status
b47cf58e	229	acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
1da177e4	230
b47cf58e	231	acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
1da177e4 LT	232
1da177e4 LT	233	acpi_status
b47cf58e	234	acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
1da177e4	235
50eca3eb BM	236	acpi_status
	237	acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
	238
1da177e4 LT	239	/*
	240	* Object manipulation and enumeration
	241	*/
1da177e4	242	acpi_status
4be44fcd LB	243	acpi_evaluate_object(acpi_handle object,
	244	acpi_string pathname,
	245	struct acpi_object_list *parameter_objects,
	246	struct acpi_buffer *return_object_buffer);
1da177e4	247
1da177e4	248	acpi_status
4be44fcd LB	249	acpi_evaluate_object_typed(acpi_handle object,
	250	acpi_string pathname,
	251	struct acpi_object_list *external_params,
	252	struct acpi_buffer *return_buffer,
	253	acpi_object_type return_type);
1da177e4 LT	254
1da177e4 LT	255	acpi_status
b47cf58e	256	acpi_get_object_info(acpi_handle object,
15b8dd53	257	struct acpi_device_info **return_buffer);
1da177e4	258
b2f7ddcf LM	259	acpi_status acpi_install_method(u8 *buffer);
b2f7ddcf LM	260
1da177e4	261	acpi_status
4be44fcd LB	262	acpi_get_next_object(acpi_object_type type,
	263	acpi_handle parent,
	264	acpi_handle child, acpi_handle * out_handle);
1da177e4	265
4be44fcd	266	acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
1da177e4	267
0f0fe1a0 JK	268	acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
0f0fe1a0 JK	269
4be44fcd	270	acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
1da177e4 LT	271
1da177e4 LT	272	/*
ecfbbc7b	273	* Handler interfaces
1da177e4	274	*/
ecfbbc7b BM	275	acpi_status
	276	acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
	277
33620c54 BM	278	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	279	acpi_install_global_event_handler
644ef74e	280	(acpi_gbl_event_handler handler, void *context))
33620c54 BM	281
	282	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	283	acpi_install_fixed_event_handler(u32
	284	acpi_event,
	285	acpi_event_handler
	286	handler,
	287	void
	288	*context))
	289	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	290	acpi_remove_fixed_event_handler(u32 acpi_event,
	291	acpi_event_handler
	292	handler))
	293	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	294	acpi_install_gpe_handler(acpi_handle
	295	gpe_device,
	296	u32 gpe_number,
	297	u32 type,
	298	acpi_gpe_handler
	299	address,
	300	void *context))
	301	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	302	acpi_remove_gpe_handler(acpi_handle gpe_device,
	303	u32 gpe_number,
	304	acpi_gpe_handler
	305	address))
1f86e8c1 LZ	306	acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type,
	307	acpi_notify_handler handler,
	308	void *context);
1da177e4 LT	309
1da177e4 LT	310	acpi_status
4be44fcd LB	311	acpi_remove_notify_handler(acpi_handle device,
4be44fcd LB	312	u32 handler_type, acpi_notify_handler handler);
1da177e4 LT	313
1da177e4 LT	314	acpi_status
4be44fcd LB	315	acpi_install_address_space_handler(acpi_handle device,
	316	acpi_adr_space_type space_id,
	317	acpi_adr_space_handler handler,
	318	acpi_adr_space_setup setup, void *context);
1da177e4 LT	319
1da177e4 LT	320	acpi_status
4be44fcd LB	321	acpi_remove_address_space_handler(acpi_handle device,
	322	acpi_adr_space_type space_id,
	323	acpi_adr_space_handler handler);
1da177e4	324
1da177e4	325	#ifdef ACPI_FUTURE_USAGE
4be44fcd	326	acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
1da177e4 LT	327	#endif
1da177e4 LT	328
b0ed7a91 LM	329	acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
b0ed7a91 LM	330
1da177e4	331	/*
ffef6827	332	* Global Lock interfaces
1da177e4	333	*/
33620c54 BM	334	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	335	acpi_acquire_global_lock(u16 timeout,
	336	u32 *handle))
	337	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	338	acpi_release_global_lock(u32 handle))
1da177e4	339
ffef6827 LM	340	/*
	341	* Interfaces to AML mutex objects
	342	*/
	343	acpi_status
	344	acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
	345
	346	acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
	347
	348	/*
	349	* Fixed Event interfaces
	350	*/
33620c54 BM	351	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	352	acpi_enable_event(u32 event, u32 flags))
1da177e4	353
33620c54 BM	354	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	355	acpi_disable_event(u32 event, u32 flags))
1da177e4	356
33620c54	357	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
1da177e4	358
33620c54 BM	359	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	360	acpi_get_event_status(u32 event,
	361	acpi_event_status
	362	*event_status))
08ac07b8	363	/*
ffef6827	364	* General Purpose Event (GPE) Interfaces
08ac07b8	365	*/
33620c54 BM	366	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
	367
	368	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	369	acpi_enable_gpe(acpi_handle gpe_device,
	370	u32 gpe_number))
	371
	372	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	373	acpi_disable_gpe(acpi_handle gpe_device,
	374	u32 gpe_number))
	375
	376	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	377	acpi_clear_gpe(acpi_handle gpe_device,
	378	u32 gpe_number))
	379
	380	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	381	acpi_set_gpe(acpi_handle gpe_device,
	382	u32 gpe_number, u8 action))
	383
	384	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	385	acpi_finish_gpe(acpi_handle gpe_device,
	386	u32 gpe_number))
	387
	388	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	389	acpi_setup_gpe_for_wake(acpi_handle
	390	parent_device,
	391	acpi_handle gpe_device,
	392	u32 gpe_number))
	393	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	394	acpi_set_gpe_wake_mask(acpi_handle gpe_device,
	395	u32 gpe_number,
	396	u8 action))
	397	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	398	acpi_get_gpe_status(acpi_handle gpe_device,
	399	u32 gpe_number,
	400	acpi_event_status
	401	*event_status))
	402
	403	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
	404
	405	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
	406
	407	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	408	acpi_get_gpe_device(u32 gpe_index,
	409	acpi_handle * gpe_device))
	410
	411	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	412	acpi_install_gpe_block(acpi_handle gpe_device,
	413	struct
	414	acpi_generic_address
	415	*gpe_block_address,
	416	u32 register_count,
	417	u32 interrupt_number))
	418	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	419	acpi_remove_gpe_block(acpi_handle gpe_device))
a2100801	420
1da177e4 LT	421	/*
	422	* Resource interfaces
	423	*/
1da177e4	424	typedef
61686124	425	acpi_status(acpi_walk_resource_callback) (struct acpi_resource resource,
4be44fcd	426	void *context);
1da177e4	427
c51a4de8	428	acpi_status
b47cf58e	429	acpi_get_vendor_resource(acpi_handle device,
c51a4de8 BM	430	char *name,
	431	struct acpi_vendor_uuid *uuid,
	432	struct acpi_buffer *ret_buffer);
	433
1da177e4	434	acpi_status
b47cf58e	435	acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
1da177e4 LT	436
	437	#ifdef ACPI_FUTURE_USAGE
	438	acpi_status
b47cf58e	439	acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
1da177e4 LT	440	#endif
1da177e4 LT	441
a91cdde2 BM	442	acpi_status
	443	acpi_get_event_resources(acpi_handle device_handle,
	444	struct acpi_buffer *ret_buffer);
	445
afb1bbee BM	446	acpi_status
	447	acpi_walk_resource_buffer(struct acpi_buffer *buffer,
	448	acpi_walk_resource_callback user_function,
	449	void *context);
	450
1da177e4	451	acpi_status
b47cf58e	452	acpi_walk_resources(acpi_handle device,
c51a4de8	453	char *name,
61686124	454	acpi_walk_resource_callback user_function, void *context);
1da177e4 LT	455
1da177e4 LT	456	acpi_status
b47cf58e	457	acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
1da177e4 LT	458
1da177e4 LT	459	acpi_status
b47cf58e	460	acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
1da177e4 LT	461
1da177e4 LT	462	acpi_status
4be44fcd LB	463	acpi_resource_to_address64(struct acpi_resource *resource,
4be44fcd LB	464	struct acpi_resource_address64 *out);
1da177e4	465
0e243178 BM	466	acpi_status
	467	acpi_buffer_to_resource(u8 *aml_buffer,
	468	u16 aml_buffer_length,
	469	struct acpi_resource **resource_ptr);
	470
1da177e4 LT	471	/*
	472	* Hardware (ACPI device) interfaces
	473	*/
d3fd902d BM	474	acpi_status acpi_reset(void);
d3fd902d BM	475
739dcbb9 LZ	476	acpi_status acpi_read(u64 value, struct acpi_generic_address reg);
	477
	478	acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
	479
33620c54 BM	480	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	481	acpi_read_bit_register(u32 register_id,
	482	u32 *return_value))
1da177e4	483
33620c54 BM	484	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	485	acpi_write_bit_register(u32 register_id,
	486	u32 value))
1da177e4	487
33620c54 BM	488	/*
	489	* Sleep/Wake interfaces
	490	*/
1da177e4	491	acpi_status
4be44fcd	492	acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
1da177e4	493
4be44fcd	494	acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
1da177e4	495
3f6f49c7	496	acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
1da177e4	497
33620c54	498	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
1da177e4	499
3f6f49c7	500	acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
c95d47a8	501
4be44fcd	502	acpi_status acpi_leave_sleep_state(u8 sleep_state);
1da177e4	503
739dcbb9 LZ	504	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	505	acpi_set_firmware_waking_vector(u32
	506	physical_address))
	507
	508	#if ACPI_MACHINE_WIDTH == 64
	509	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	510	acpi_set_firmware_waking_vector64(u64
	511	physical_address))
	512	#endif
d08310fe BM	513	/*
	514	* ACPI Timer interfaces
	515	*/
	516	#ifdef ACPI_FUTURE_USAGE
33620c54 BM	517	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	518	acpi_get_timer_resolution(u32 *resolution))
d08310fe	519
33620c54	520	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
d08310fe	521
33620c54 BM	522	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	523	acpi_get_timer_duration(u32 start_ticks,
	524	u32 end_ticks,
	525	u32 *time_elapsed))
d08310fe BM	526	#endif /* ACPI_FUTURE_USAGE */
d08310fe BM	527
50df4d8b	528	/*
b74be611	529	* Error/Warning output
50df4d8b BM	530	*/
	531	void ACPI_INTERNAL_VAR_XFACE
	532	acpi_error(const char *module_name,
	533	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	534
	535	void ACPI_INTERNAL_VAR_XFACE
	536	acpi_exception(const char *module_name,
	537	u32 line_number,
	538	acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
	539
	540	void ACPI_INTERNAL_VAR_XFACE
	541	acpi_warning(const char *module_name,
	542	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	543
	544	void ACPI_INTERNAL_VAR_XFACE
	545	acpi_info(const char *module_name,
	546	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	547
62cdd141 BM	548	void ACPI_INTERNAL_VAR_XFACE
	549	acpi_bios_error(const char *module_name,
	550	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	551
	552	void ACPI_INTERNAL_VAR_XFACE
	553	acpi_bios_warning(const char *module_name,
	554	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	555
b74be611 BM	556	/*
	557	* Debug output
	558	*/
50df4d8b BM	559	#ifdef ACPI_DEBUG_OUTPUT
	560
	561	void ACPI_INTERNAL_VAR_XFACE
	562	acpi_debug_print(u32 requested_debug_level,
	563	u32 line_number,
	564	const char *function_name,
	565	const char *module_name,
	566	u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
	567
	568	void ACPI_INTERNAL_VAR_XFACE
	569	acpi_debug_print_raw(u32 requested_debug_level,
	570	u32 line_number,
	571	const char *function_name,
	572	const char *module_name,
	573	u32 component_id,
	574	const char *format, ...) ACPI_PRINTF_LIKE(6);
	575	#endif
	576
4be44fcd	577	#endif /* __ACXFACE_H__ */