[deliverable/linux.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                 0x20121018

#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 publicly available, allowing for
 * run time configuration
 */
extern u32 acpi_dbg_level;
extern u32 acpi_dbg_layer;
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_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 u32 acpi_rsdt_forced;
/*
 * Global interfaces
 */
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);

#ifdef ACPI_FUTURE_USAGE
acpi_status acpi_subsystem_status(void);
#endif

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

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_status acpi_read(u64 *value, struct acpi_generic_address *reg);

acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);

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