[linux-2.6-block.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                 0x20120711

#include <acpi/acconfig.h>
#include <acpi/actypes.h>
#include <acpi/actbl.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 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	*
	4	* Name: acpixf.h - External interfaces to the ACPI subsystem
	5	*
	6	*****************************************************************************/
	7
	8	/*
75e7386b	9	* Copyright (C) 2000 - 2012, Intel Corp.
1da177e4 LT	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
1da177e4 LT	45	#ifndef __ACXFACE_H__
	46	#define __ACXFACE_H__
	47
50df4d8b BM	48	/* Current ACPICA subsystem version in YYYYMMDD format */
50df4d8b BM	49
819f1a64	50	#define ACPI_CA_VERSION 0x20120711
50df4d8b	51
a1ce3928 DH	52	#include <acpi/acconfig.h>
	53	#include <acpi/actypes.h>
	54	#include <acpi/actbl.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
1da177e4	147	/*
aee07ba6	148	* ACPI Memory management
1da177e4	149	*/
4be44fcd	150	void *acpi_allocate(u32 size);
1da177e4	151
4be44fcd	152	void *acpi_callocate(u32 size);
1da177e4	153
4be44fcd	154	void acpi_free(void *address);
1da177e4 LT	155
1da177e4 LT	156	/*
f60d8181	157	* ACPI table load/unload interfaces
1da177e4	158	*/
f60d8181	159	acpi_status acpi_load_table(struct acpi_table_header *table);
f3d2e786	160
f60d8181	161	acpi_status acpi_unload_parent_table(acpi_handle object);
1da177e4	162
4be44fcd	163	acpi_status acpi_load_tables(void);
1da177e4	164
f60d8181 BM	165	/*
	166	* ACPI table manipulation interfaces
	167	*/
	168	acpi_status acpi_reallocate_root_table(void);
	169
	170	acpi_status acpi_find_root_pointer(acpi_size *rsdp_address);
1da177e4	171
f3d2e786	172	acpi_status acpi_unload_table_id(acpi_owner_id id);
1da177e4 LT	173
1da177e4 LT	174	acpi_status
f3d2e786	175	acpi_get_table_header(acpi_string signature,
67a119f9	176	u32 instance,
428f2112	177	struct acpi_table_header *out_table_header);
1da177e4 LT	178
1da177e4 LT	179	acpi_status
7d97277b YL	180	acpi_get_table_with_size(acpi_string signature,
	181	u32 instance, struct acpi_table_header **out_table,
	182	acpi_size *tbl_size);
	183	acpi_status
f3d2e786	184	acpi_get_table(acpi_string signature,
67a119f9	185	u32 instance, struct acpi_table_header **out_table);
1da177e4 LT	186
1da177e4 LT	187	acpi_status
67a119f9	188	acpi_get_table_by_index(u32 table_index,
f3d2e786	189	struct acpi_table_header **out_table);
1da177e4	190
3e08e2d2 LM	191	acpi_status
	192	acpi_install_table_handler(acpi_tbl_handler handler, void *context);
	193
	194	acpi_status acpi_remove_table_handler(acpi_tbl_handler handler);
	195
1da177e4 LT	196	/*
	197	* Namespace and name interfaces
	198	*/
1da177e4	199	acpi_status
4be44fcd LB	200	acpi_walk_namespace(acpi_object_type type,
	201	acpi_handle start_object,
	202	u32 max_depth,
2263576c LM	203	acpi_walk_callback pre_order_visit,
2263576c LM	204	acpi_walk_callback post_order_visit,
4be44fcd	205	void context, void *return_value);
1da177e4 LT	206
1da177e4 LT	207	acpi_status
70b30fb1	208	acpi_get_devices(const char *HID,
4be44fcd LB	209	acpi_walk_callback user_function,
4be44fcd LB	210	void context, void *return_value);
1da177e4 LT	211
1da177e4 LT	212	acpi_status
b47cf58e	213	acpi_get_name(acpi_handle object,
4be44fcd	214	u32 name_type, struct acpi_buffer *ret_path_ptr);
1da177e4 LT	215
1da177e4 LT	216	acpi_status
4be44fcd LB	217	acpi_get_handle(acpi_handle parent,
4be44fcd LB	218	acpi_string pathname, acpi_handle * ret_handle);
1da177e4 LT	219
1da177e4 LT	220	acpi_status
b47cf58e	221	acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data);
1da177e4	222
b47cf58e	223	acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler);
1da177e4 LT	224
1da177e4 LT	225	acpi_status
b47cf58e	226	acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data);
1da177e4	227
50eca3eb BM	228	acpi_status
	229	acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags);
	230
1da177e4 LT	231	/*
	232	* Object manipulation and enumeration
	233	*/
1da177e4	234	acpi_status
4be44fcd LB	235	acpi_evaluate_object(acpi_handle object,
	236	acpi_string pathname,
	237	struct acpi_object_list *parameter_objects,
	238	struct acpi_buffer *return_object_buffer);
1da177e4	239
1da177e4	240	acpi_status
4be44fcd LB	241	acpi_evaluate_object_typed(acpi_handle object,
	242	acpi_string pathname,
	243	struct acpi_object_list *external_params,
	244	struct acpi_buffer *return_buffer,
	245	acpi_object_type return_type);
1da177e4 LT	246
1da177e4 LT	247	acpi_status
b47cf58e	248	acpi_get_object_info(acpi_handle object,
15b8dd53	249	struct acpi_device_info **return_buffer);
1da177e4	250
b2f7ddcf LM	251	acpi_status acpi_install_method(u8 *buffer);
b2f7ddcf LM	252
1da177e4	253	acpi_status
4be44fcd LB	254	acpi_get_next_object(acpi_object_type type,
	255	acpi_handle parent,
	256	acpi_handle child, acpi_handle * out_handle);
1da177e4	257
4be44fcd	258	acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type);
1da177e4	259
0f0fe1a0 JK	260	acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type);
0f0fe1a0 JK	261
4be44fcd	262	acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle);
1da177e4 LT	263
1da177e4 LT	264	/*
ecfbbc7b	265	* Handler interfaces
1da177e4	266	*/
ecfbbc7b BM	267	acpi_status
	268	acpi_install_initialization_handler(acpi_init_handler handler, u32 function);
	269
33620c54 BM	270	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	271	acpi_install_global_event_handler
	272	(ACPI_GBL_EVENT_HANDLER handler, void *context))
	273
	274	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	275	acpi_install_fixed_event_handler(u32
	276	acpi_event,
	277	acpi_event_handler
	278	handler,
	279	void
	280	*context))
	281	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	282	acpi_remove_fixed_event_handler(u32 acpi_event,
	283	acpi_event_handler
	284	handler))
	285	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	286	acpi_install_gpe_handler(acpi_handle
	287	gpe_device,
	288	u32 gpe_number,
	289	u32 type,
	290	acpi_gpe_handler
	291	address,
	292	void *context))
	293	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	294	acpi_remove_gpe_handler(acpi_handle gpe_device,
	295	u32 gpe_number,
	296	acpi_gpe_handler
	297	address))
1da177e4	298	acpi_status
4be44fcd LB	299	acpi_install_notify_handler(acpi_handle device,
	300	u32 handler_type,
	301	acpi_notify_handler handler, void *context);
1da177e4 LT	302
1da177e4 LT	303	acpi_status
4be44fcd LB	304	acpi_remove_notify_handler(acpi_handle device,
4be44fcd LB	305	u32 handler_type, acpi_notify_handler handler);
1da177e4 LT	306
1da177e4 LT	307	acpi_status
4be44fcd LB	308	acpi_install_address_space_handler(acpi_handle device,
	309	acpi_adr_space_type space_id,
	310	acpi_adr_space_handler handler,
	311	acpi_adr_space_setup setup, void *context);
1da177e4 LT	312
1da177e4 LT	313	acpi_status
4be44fcd LB	314	acpi_remove_address_space_handler(acpi_handle device,
	315	acpi_adr_space_type space_id,
	316	acpi_adr_space_handler handler);
1da177e4	317
1da177e4	318	#ifdef ACPI_FUTURE_USAGE
4be44fcd	319	acpi_status acpi_install_exception_handler(acpi_exception_handler handler);
1da177e4 LT	320	#endif
1da177e4 LT	321
b0ed7a91 LM	322	acpi_status acpi_install_interface_handler(acpi_interface_handler handler);
b0ed7a91 LM	323
1da177e4	324	/*
ffef6827	325	* Global Lock interfaces
1da177e4	326	*/
33620c54 BM	327	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	328	acpi_acquire_global_lock(u16 timeout,
	329	u32 *handle))
	330	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	331	acpi_release_global_lock(u32 handle))
1da177e4	332
ffef6827 LM	333	/*
	334	* Interfaces to AML mutex objects
	335	*/
	336	acpi_status
	337	acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout);
	338
	339	acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname);
	340
	341	/*
	342	* Fixed Event interfaces
	343	*/
33620c54 BM	344	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	345	acpi_enable_event(u32 event, u32 flags))
1da177e4	346
33620c54 BM	347	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	348	acpi_disable_event(u32 event, u32 flags))
1da177e4	349
33620c54	350	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
1da177e4	351
33620c54 BM	352	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	353	acpi_get_event_status(u32 event,
	354	acpi_event_status
	355	*event_status))
08ac07b8	356	/*
ffef6827	357	* General Purpose Event (GPE) Interfaces
08ac07b8	358	*/
33620c54 BM	359	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
	360
	361	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	362	acpi_enable_gpe(acpi_handle gpe_device,
	363	u32 gpe_number))
	364
	365	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	366	acpi_disable_gpe(acpi_handle gpe_device,
	367	u32 gpe_number))
	368
	369	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	370	acpi_clear_gpe(acpi_handle gpe_device,
	371	u32 gpe_number))
	372
	373	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	374	acpi_set_gpe(acpi_handle gpe_device,
	375	u32 gpe_number, u8 action))
	376
	377	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	378	acpi_finish_gpe(acpi_handle gpe_device,
	379	u32 gpe_number))
	380
	381	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	382	acpi_setup_gpe_for_wake(acpi_handle
	383	parent_device,
	384	acpi_handle gpe_device,
	385	u32 gpe_number))
	386	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	387	acpi_set_gpe_wake_mask(acpi_handle gpe_device,
	388	u32 gpe_number,
	389	u8 action))
	390	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	391	acpi_get_gpe_status(acpi_handle gpe_device,
	392	u32 gpe_number,
	393	acpi_event_status
	394	*event_status))
	395
	396	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
	397
	398	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
	399
	400	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	401	acpi_get_gpe_device(u32 gpe_index,
	402	acpi_handle * gpe_device))
	403
	404	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	405	acpi_install_gpe_block(acpi_handle gpe_device,
	406	struct
	407	acpi_generic_address
	408	*gpe_block_address,
	409	u32 register_count,
	410	u32 interrupt_number))
	411	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	412	acpi_remove_gpe_block(acpi_handle gpe_device))
a2100801	413
1da177e4 LT	414	/*
	415	* Resource interfaces
	416	*/
1da177e4	417	typedef
61686124	418	acpi_status(acpi_walk_resource_callback) (struct acpi_resource resource,
4be44fcd	419	void *context);
1da177e4	420
c51a4de8	421	acpi_status
b47cf58e	422	acpi_get_vendor_resource(acpi_handle device,
c51a4de8 BM	423	char *name,
	424	struct acpi_vendor_uuid *uuid,
	425	struct acpi_buffer *ret_buffer);
	426
1da177e4	427	acpi_status
b47cf58e	428	acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
1da177e4 LT	429
	430	#ifdef ACPI_FUTURE_USAGE
	431	acpi_status
b47cf58e	432	acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer);
1da177e4 LT	433	#endif
1da177e4 LT	434
a91cdde2 BM	435	acpi_status
	436	acpi_get_event_resources(acpi_handle device_handle,
	437	struct acpi_buffer *ret_buffer);
	438
1da177e4	439	acpi_status
b47cf58e	440	acpi_walk_resources(acpi_handle device,
c51a4de8	441	char *name,
61686124	442	acpi_walk_resource_callback user_function, void *context);
1da177e4 LT	443
1da177e4 LT	444	acpi_status
b47cf58e	445	acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer);
1da177e4 LT	446
1da177e4 LT	447	acpi_status
b47cf58e	448	acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer);
1da177e4 LT	449
1da177e4 LT	450	acpi_status
4be44fcd LB	451	acpi_resource_to_address64(struct acpi_resource *resource,
4be44fcd LB	452	struct acpi_resource_address64 *out);
1da177e4	453
0e243178 BM	454	acpi_status
	455	acpi_buffer_to_resource(u8 *aml_buffer,
	456	u16 aml_buffer_length,
	457	struct acpi_resource **resource_ptr);
	458
1da177e4 LT	459	/*
	460	* Hardware (ACPI device) interfaces
	461	*/
d3fd902d BM	462	acpi_status acpi_reset(void);
d3fd902d BM	463
33620c54 BM	464	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	465	acpi_read_bit_register(u32 register_id,
	466	u32 *return_value))
1da177e4	467
33620c54 BM	468	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	469	acpi_write_bit_register(u32 register_id,
	470	u32 value))
1da177e4	471
33620c54 BM	472	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	473	acpi_set_firmware_waking_vector(u32
	474	physical_address))
1da177e4	475
4f70e371	476	#if ACPI_MACHINE_WIDTH == 64
33620c54 BM	477	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	478	acpi_set_firmware_waking_vector64(u64
	479	physical_address))
4f70e371	480	#endif
1da177e4	481
c6b5774c	482	acpi_status acpi_read(u64 value, struct acpi_generic_address reg);
ecfbbc7b	483
c6b5774c	484	acpi_status acpi_write(u64 value, struct acpi_generic_address *reg);
ecfbbc7b	485
33620c54 BM	486	/*
	487	* Sleep/Wake interfaces
	488	*/
1da177e4	489	acpi_status
4be44fcd	490	acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b);
1da177e4	491
4be44fcd	492	acpi_status acpi_enter_sleep_state_prep(u8 sleep_state);
1da177e4	493
3f6f49c7	494	acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state);
1da177e4	495
33620c54	496	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void))
1da177e4	497
3f6f49c7	498	acpi_status acpi_leave_sleep_state_prep(u8 sleep_state);
c95d47a8	499
4be44fcd	500	acpi_status acpi_leave_sleep_state(u8 sleep_state);
1da177e4	501
d08310fe BM	502	/*
	503	* ACPI Timer interfaces
	504	*/
	505	#ifdef ACPI_FUTURE_USAGE
33620c54 BM	506	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
33620c54 BM	507	acpi_get_timer_resolution(u32 *resolution))
d08310fe	508
33620c54	509	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
d08310fe	510
33620c54 BM	511	ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
	512	acpi_get_timer_duration(u32 start_ticks,
	513	u32 end_ticks,
	514	u32 *time_elapsed))
d08310fe BM	515	#endif /* ACPI_FUTURE_USAGE */
d08310fe BM	516
50df4d8b	517	/*
b74be611	518	* Error/Warning output
50df4d8b BM	519	*/
	520	void ACPI_INTERNAL_VAR_XFACE
	521	acpi_error(const char *module_name,
	522	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	523
	524	void ACPI_INTERNAL_VAR_XFACE
	525	acpi_exception(const char *module_name,
	526	u32 line_number,
	527	acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4);
	528
	529	void ACPI_INTERNAL_VAR_XFACE
	530	acpi_warning(const char *module_name,
	531	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	532
	533	void ACPI_INTERNAL_VAR_XFACE
	534	acpi_info(const char *module_name,
	535	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	536
62cdd141 BM	537	void ACPI_INTERNAL_VAR_XFACE
	538	acpi_bios_error(const char *module_name,
	539	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	540
	541	void ACPI_INTERNAL_VAR_XFACE
	542	acpi_bios_warning(const char *module_name,
	543	u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
	544
b74be611 BM	545	/*
	546	* Debug output
	547	*/
50df4d8b BM	548	#ifdef ACPI_DEBUG_OUTPUT
	549
	550	void ACPI_INTERNAL_VAR_XFACE
	551	acpi_debug_print(u32 requested_debug_level,
	552	u32 line_number,
	553	const char *function_name,
	554	const char *module_name,
	555	u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6);
	556
	557	void ACPI_INTERNAL_VAR_XFACE
	558	acpi_debug_print_raw(u32 requested_debug_level,
	559	u32 line_number,
	560	const char *function_name,
	561	const char *module_name,
	562	u32 component_id,
	563	const char *format, ...) ACPI_PRINTF_LIKE(6);
	564	#endif
	565
4be44fcd	566	#endif /* __ACXFACE_H__ */