[deliverable/linux.git] / include / acpi / acpiosxf.h


/******************************************************************************
 *
 * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL).  These
 *                    interfaces must be implemented by OSL to interface the
 *                    ACPI components to the host operating system.
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2008, 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 __ACPIOSXF_H__
#define __ACPIOSXF_H__

#include "platform/acenv.h"
#include "actypes.h"

/* Types for acpi_os_execute */

typedef enum {
	OSL_GLOBAL_LOCK_HANDLER,
	OSL_NOTIFY_HANDLER,
	OSL_GPE_HANDLER,
	OSL_DEBUGGER_THREAD,
	OSL_EC_POLL_HANDLER,
	OSL_EC_BURST_HANDLER
} acpi_execute_type;

#define ACPI_NO_UNIT_LIMIT          ((u32) -1)
#define ACPI_MUTEX_SEM              1

/* Functions for acpi_os_signal */

#define ACPI_SIGNAL_FATAL           0
#define ACPI_SIGNAL_BREAKPOINT      1

struct acpi_signal_fatal_info {
	u32 type;
	u32 code;
	u32 argument;
};

/*
 * OSL Initialization and shutdown primitives
 */
acpi_status __initdata acpi_os_initialize(void);

acpi_status acpi_os_terminate(void);

/*
 * ACPI Table interfaces
 */
acpi_physical_address acpi_os_get_root_pointer(void);

acpi_status
acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
			    acpi_string * new_val);

acpi_status
acpi_os_table_override(struct acpi_table_header *existing_table,
		       struct acpi_table_header **new_table);

/*
 * Spinlock primitives
 */
acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);

void acpi_os_delete_lock(acpi_spinlock handle);

acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);

void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);

/*
 * Semaphore primitives
 */
acpi_status
acpi_os_create_semaphore(u32 max_units,
			 u32 initial_units, acpi_semaphore * out_handle);

acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);

acpi_status
acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);

acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);

/*
 * Mutex primitives
 */
acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);

void acpi_os_delete_mutex(acpi_mutex handle);

acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);

void acpi_os_release_mutex(acpi_mutex handle);

/* Temporary macros for Mutex* interfaces, map to existing semaphore xfaces */

#define acpi_os_create_mutex(out_handle)    acpi_os_create_semaphore (1, 1, out_handle)
#define acpi_os_delete_mutex(handle)        (void) acpi_os_delete_semaphore (handle)
#define acpi_os_acquire_mutex(handle,time)  acpi_os_wait_semaphore (handle, 1, time)
#define acpi_os_release_mutex(handle)       (void) acpi_os_signal_semaphore (handle, 1)

/*
 * Memory allocation and mapping
 */
void *acpi_os_allocate(acpi_size size);

void __iomem *acpi_os_map_memory(acpi_physical_address where,
				acpi_size length);

void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);

#ifdef ACPI_FUTURE_USAGE
acpi_status
acpi_os_get_physical_address(void *logical_address,
			     acpi_physical_address * physical_address);
#endif

/*
 * Memory/Object Cache
 */
acpi_status
acpi_os_create_cache(char *cache_name,
		     u16 object_size,
		     u16 max_depth, acpi_cache_t ** return_cache);

acpi_status acpi_os_delete_cache(acpi_cache_t * cache);

acpi_status acpi_os_purge_cache(acpi_cache_t * cache);

void *acpi_os_acquire_object(acpi_cache_t * cache);

acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);

/*
 * Interrupt handlers
 */
acpi_status
acpi_os_install_interrupt_handler(u32 gsi,
				  acpi_osd_handler service_routine,
				  void *context);

acpi_status
acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);

void acpi_os_gpe_count(u32 gpe_number);
void acpi_os_fixed_event_count(u32 fixed_event_number);

/*
 * Threads and Scheduling
 */
acpi_thread_id acpi_os_get_thread_id(void);

acpi_status
acpi_os_execute(acpi_execute_type type,
		acpi_osd_exec_callback function, void *context);

void acpi_os_wait_events_complete(void *context);

void acpi_os_sleep(acpi_integer milliseconds);

void acpi_os_stall(u32 microseconds);

/*
 * Platform and hardware-independent I/O interfaces
 */
acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);

acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);

/*
 * Platform and hardware-independent physical memory interfaces
 */
acpi_status
acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);

acpi_status
acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);

/*
 * Platform and hardware-independent PCI configuration space access
 * Note: Can't use "Register" as a parameter, changed to "Reg" --
 * certain compilers complain.
 */
acpi_status
acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
			       u32 reg, u32 *value, u32 width);

acpi_status
acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
				u32 reg, acpi_integer value, u32 width);

/*
 * Interim function needed for PCI IRQ routing
 */
void
acpi_os_derive_pci_id(acpi_handle rhandle,
		      acpi_handle chandle, struct acpi_pci_id **pci_id);

/*
 * Miscellaneous
 */
acpi_status acpi_os_validate_interface(char *interface);
acpi_status acpi_osi_invalidate(char* interface);

acpi_status
acpi_os_validate_address(u8 space_id, acpi_physical_address address,
			 acpi_size length, char *name);

u64 acpi_os_get_timer(void);

acpi_status acpi_os_signal(u32 function, void *info);

/*
 * Debug print routines
 */
void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);

void acpi_os_vprintf(const char *format, va_list args);

void acpi_os_redirect_output(void *destination);

#ifdef ACPI_FUTURE_USAGE
/*
 * Debug input
 */
u32 acpi_os_get_line(char *buffer);
#endif

/*
 * Directory manipulation
 */
void *acpi_os_open_directory(char *pathname,
			     char *wildcard_spec, char requested_file_type);

/* requeste_file_type values */

#define REQUEST_FILE_ONLY                   0
#define REQUEST_DIR_ONLY                    1

char *acpi_os_get_next_filename(void *dir_handle);

void acpi_os_close_directory(void *dir_handle);

#endif				/* __ACPIOSXF_H__ */
Commit	Line	Data
	1
	2	/******************************************************************************
	3	*
	4	* Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These
	5	* interfaces must be implemented by OSL to interface the
	6	* ACPI components to the host operating system.
	7	*
	8	*****************************************************************************/
	9
	10	/*
	11	* Copyright (C) 2000 - 2008, Intel Corp.
	12	* All rights reserved.
	13	*
	14	* Redistribution and use in source and binary forms, with or without
	15	* modification, are permitted provided that the following conditions
	16	* are met:
	17	* 1. Redistributions of source code must retain the above copyright
	18	* notice, this list of conditions, and the following disclaimer,
	19	* without modification.
	20	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	21	* substantially similar to the "NO WARRANTY" disclaimer below
	22	* ("Disclaimer") and any redistribution must be conditioned upon
	23	* including a substantially similar Disclaimer requirement for further
	24	* binary redistribution.
	25	* 3. Neither the names of the above-listed copyright holders nor the names
	26	* of any contributors may be used to endorse or promote products derived
	27	* from this software without specific prior written permission.
	28	*
	29	* Alternatively, this software may be distributed under the terms of the
	30	* GNU General Public License ("GPL") version 2 as published by the Free
	31	* Software Foundation.
	32	*
	33	* NO WARRANTY
	34	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	35	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	36	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	37	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	38	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	39	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	40	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	41	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	42	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	43	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	44	* POSSIBILITY OF SUCH DAMAGES.
	45	*/
	46
	47	#ifndef __ACPIOSXF_H__
	48	#define __ACPIOSXF_H__
	49
	50	#include "platform/acenv.h"
	51	#include "actypes.h"
	52
	53	/* Types for acpi_os_execute */
	54
	55	typedef enum {
	56	OSL_GLOBAL_LOCK_HANDLER,
	57	OSL_NOTIFY_HANDLER,
	58	OSL_GPE_HANDLER,
	59	OSL_DEBUGGER_THREAD,
	60	OSL_EC_POLL_HANDLER,
	61	OSL_EC_BURST_HANDLER
	62	} acpi_execute_type;
	63
	64	#define ACPI_NO_UNIT_LIMIT ((u32) -1)
	65	#define ACPI_MUTEX_SEM 1
	66
	67	/* Functions for acpi_os_signal */
	68
	69	#define ACPI_SIGNAL_FATAL 0
	70	#define ACPI_SIGNAL_BREAKPOINT 1
	71
	72	struct acpi_signal_fatal_info {
	73	u32 type;
	74	u32 code;
	75	u32 argument;
	76	};
	77
	78	/*
	79	* OSL Initialization and shutdown primitives
	80	*/
	81	acpi_status __initdata acpi_os_initialize(void);
	82
	83	acpi_status acpi_os_terminate(void);
	84
	85	/*
	86	* ACPI Table interfaces
	87	*/
	88	acpi_physical_address acpi_os_get_root_pointer(void);
	89
	90	acpi_status
	91	acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
	92	acpi_string * new_val);
	93
	94	acpi_status
	95	acpi_os_table_override(struct acpi_table_header *existing_table,
	96	struct acpi_table_header **new_table);
	97
	98	/*
	99	* Spinlock primitives
	100	*/
	101	acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
	102
	103	void acpi_os_delete_lock(acpi_spinlock handle);
	104
	105	acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
	106
	107	void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
	108
	109	/*
	110	* Semaphore primitives
	111	*/
	112	acpi_status
	113	acpi_os_create_semaphore(u32 max_units,
	114	u32 initial_units, acpi_semaphore * out_handle);
	115
	116	acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
	117
	118	acpi_status
	119	acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
	120
	121	acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
	122
	123	/*
	124	* Mutex primitives
	125	*/
	126	acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
	127
	128	void acpi_os_delete_mutex(acpi_mutex handle);
	129
	130	acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
	131
	132	void acpi_os_release_mutex(acpi_mutex handle);
	133
	134	/* Temporary macros for Mutex* interfaces, map to existing semaphore xfaces */
	135
	136	#define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
	137	#define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
	138	#define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
	139	#define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
	140
	141	/*
	142	* Memory allocation and mapping
	143	*/
	144	void *acpi_os_allocate(acpi_size size);
	145
	146	void __iomem *acpi_os_map_memory(acpi_physical_address where,
	147	acpi_size length);
	148
	149	void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
	150
	151	#ifdef ACPI_FUTURE_USAGE
	152	acpi_status
	153	acpi_os_get_physical_address(void *logical_address,
	154	acpi_physical_address * physical_address);
	155	#endif
	156
	157	/*
	158	* Memory/Object Cache
	159	*/
	160	acpi_status
	161	acpi_os_create_cache(char *cache_name,
	162	u16 object_size,
	163	u16 max_depth, acpi_cache_t ** return_cache);
	164
	165	acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
	166
	167	acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
	168
	169	void acpi_os_acquire_object(acpi_cache_t cache);
	170
	171	acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
	172
	173	/*
	174	* Interrupt handlers
	175	*/
	176	acpi_status
	177	acpi_os_install_interrupt_handler(u32 gsi,
	178	acpi_osd_handler service_routine,
	179	void *context);
	180
	181	acpi_status
	182	acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
	183
	184	void acpi_os_gpe_count(u32 gpe_number);
	185	void acpi_os_fixed_event_count(u32 fixed_event_number);
	186
	187	/*
	188	* Threads and Scheduling
	189	*/
	190	acpi_thread_id acpi_os_get_thread_id(void);
	191
	192	acpi_status
	193	acpi_os_execute(acpi_execute_type type,
	194	acpi_osd_exec_callback function, void *context);
	195
	196	void acpi_os_wait_events_complete(void *context);
	197
	198	void acpi_os_sleep(acpi_integer milliseconds);
	199
	200	void acpi_os_stall(u32 microseconds);
	201
	202	/*
	203	* Platform and hardware-independent I/O interfaces
	204	*/
	205	acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
	206
	207	acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
	208
	209	/*
	210	* Platform and hardware-independent physical memory interfaces
	211	*/
	212	acpi_status
	213	acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
	214
	215	acpi_status
	216	acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
	217
	218	/*
	219	* Platform and hardware-independent PCI configuration space access
	220	* Note: Can't use "Register" as a parameter, changed to "Reg" --
	221	* certain compilers complain.
	222	*/
	223	acpi_status
	224	acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
	225	u32 reg, u32 *value, u32 width);
	226
	227	acpi_status
	228	acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
	229	u32 reg, acpi_integer value, u32 width);
	230
	231	/*
	232	* Interim function needed for PCI IRQ routing
	233	*/
	234	void
	235	acpi_os_derive_pci_id(acpi_handle rhandle,
	236	acpi_handle chandle, struct acpi_pci_id **pci_id);
	237
	238	/*
	239	* Miscellaneous
	240	*/
	241	acpi_status acpi_os_validate_interface(char *interface);
	242	acpi_status acpi_osi_invalidate(char* interface);
	243
	244	acpi_status
	245	acpi_os_validate_address(u8 space_id, acpi_physical_address address,
	246	acpi_size length, char *name);
	247
	248	u64 acpi_os_get_timer(void);
	249
	250	acpi_status acpi_os_signal(u32 function, void *info);
	251
	252	/*
	253	* Debug print routines
	254	*/
	255	void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
	256
	257	void acpi_os_vprintf(const char *format, va_list args);
	258
	259	void acpi_os_redirect_output(void *destination);
	260
	261	#ifdef ACPI_FUTURE_USAGE
	262	/*
	263	* Debug input
	264	*/
	265	u32 acpi_os_get_line(char *buffer);
	266	#endif
	267
	268	/*
	269	* Directory manipulation
	270	*/
	271	void acpi_os_open_directory(char pathname,
	272	char *wildcard_spec, char requested_file_type);
	273
	274	/* requeste_file_type values */
	275
	276	#define REQUEST_FILE_ONLY 0
	277	#define REQUEST_DIR_ONLY 1
	278
	279	char acpi_os_get_next_filename(void dir_handle);
	280
	281	void acpi_os_close_directory(void *dir_handle);
	282
	283	#endif /* __ACPIOSXF_H__ */