blob: a3252a5ead669d360c37c1403c1fa0de9945a50d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070010/*
Bob Mooreb4e104e2011-01-17 11:05:40 +080011 * Copyright (C) 2000 - 2011, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * 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
Bob Moore958dd242006-05-12 17:12:00 -040053/* Types for acpi_os_execute */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Bob Moore958dd242006-05-12 17:12:00 -040055typedef enum {
56 OSL_GLOBAL_LOCK_HANDLER,
57 OSL_NOTIFY_HANDLER,
58 OSL_GPE_HANDLER,
59 OSL_DEBUGGER_THREAD,
60 OSL_EC_POLL_HANDLER,
Bob Moore41195322006-05-26 16:36:00 -040061 OSL_EC_BURST_HANDLER
Bob Moore958dd242006-05-12 17:12:00 -040062} acpi_execute_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64#define ACPI_NO_UNIT_LIMIT ((u32) -1)
65#define ACPI_MUTEX_SEM 1
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/* Functions for acpi_os_signal */
68
69#define ACPI_SIGNAL_FATAL 0
70#define ACPI_SIGNAL_BREAKPOINT 1
71
Len Brown4be44fc2005-08-05 00:44:28 -040072struct acpi_signal_fatal_info {
73 u32 type;
74 u32 code;
75 u32 argument;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076};
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078/*
79 * OSL Initialization and shutdown primitives
80 */
Len Browndd272b52007-05-30 00:26:11 -040081acpi_status __initdata acpi_os_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Len Brown4be44fc2005-08-05 00:44:28 -040083acpi_status acpi_os_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85/*
86 * ACPI Table interfaces
87 */
Bob Mooref3d2e782007-02-02 19:48:18 +030088acpi_physical_address acpi_os_get_root_pointer(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040091acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
92 acpi_string * new_val);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040095acpi_os_table_override(struct acpi_table_header *existing_table,
96 struct acpi_table_header **new_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98/*
Bob Moore967440e2006-06-23 17:04:00 -040099 * Spinlock primitives
100 */
Bob Moore967440e2006-06-23 17:04:00 -0400101void acpi_os_delete_lock(acpi_spinlock handle);
102
103acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
104
105void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
106
107/*
108 * Semaphore primitives
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400111acpi_os_create_semaphore(u32 max_units,
Bob Moore967440e2006-06-23 17:04:00 -0400112 u32 initial_units, acpi_semaphore * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Bob Moore967440e2006-06-23 17:04:00 -0400114acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Bob Moore967440e2006-06-23 17:04:00 -0400116acpi_status
117acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Bob Moore967440e2006-06-23 17:04:00 -0400119acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Bob Moore967440e2006-06-23 17:04:00 -0400121/*
Bob Moore1685bd42008-12-31 03:03:29 +0800122 * Mutex primitives. May be configured to use semaphores instead via
123 * ACPI_MUTEX_TYPE (see platform/acenv.h)
Bob Moore967440e2006-06-23 17:04:00 -0400124 */
Bob Moore1685bd42008-12-31 03:03:29 +0800125#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
126
Bob Moore967440e2006-06-23 17:04:00 -0400127acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Bob Moore967440e2006-06-23 17:04:00 -0400129void acpi_os_delete_mutex(acpi_mutex handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Bob Moore967440e2006-06-23 17:04:00 -0400131acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Bob Moore967440e2006-06-23 17:04:00 -0400133void acpi_os_release_mutex(acpi_mutex handle);
Bob Moore1685bd42008-12-31 03:03:29 +0800134#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/*
137 * Memory allocation and mapping
138 */
Len Brown4be44fc2005-08-05 00:44:28 -0400139void *acpi_os_allocate(acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Len Brownfd350942007-05-09 23:34:35 -0400141void __iomem *acpi_os_map_memory(acpi_physical_address where,
Bob Moore67a119f2008-06-10 13:42:13 +0800142 acpi_size length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Len Brown4be44fc2005-08-05 00:44:28 -0400144void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
Yinghai Lu7d972772009-02-07 15:39:41 -0800145void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147#ifdef ACPI_FUTURE_USAGE
148acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400149acpi_os_get_physical_address(void *logical_address,
150 acpi_physical_address * physical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151#endif
152
Robert Moore73459f72005-06-24 00:00:00 -0400153/*
154 * Memory/Object Cache
155 */
156acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400157acpi_os_create_cache(char *cache_name,
158 u16 object_size,
159 u16 max_depth, acpi_cache_t ** return_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400160
Len Brown4be44fc2005-08-05 00:44:28 -0400161acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400162
Len Brown4be44fc2005-08-05 00:44:28 -0400163acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400164
Len Brown4be44fc2005-08-05 00:44:28 -0400165void *acpi_os_acquire_object(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400166
Len Brown4be44fc2005-08-05 00:44:28 -0400167acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
Robert Moore73459f72005-06-24 00:00:00 -0400168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169/*
170 * Interrupt handlers
171 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400173acpi_os_install_interrupt_handler(u32 gsi,
174 acpi_osd_handler service_routine,
175 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400178acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Len Brown5229e872008-02-06 01:26:55 -0500180void acpi_os_gpe_count(u32 gpe_number);
181void acpi_os_fixed_event_count(u32 fixed_event_number);
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183/*
184 * Threads and Scheduling
185 */
Bob Moore83135242006-10-03 00:00:00 -0400186acpi_thread_id acpi_os_get_thread_id(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188acpi_status
Bob Moore958dd242006-05-12 17:12:00 -0400189acpi_os_execute(acpi_execute_type type,
190 acpi_osd_exec_callback function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Zhang Rui19cd8472008-08-28 10:05:06 +0800192acpi_status
193acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context);
194
Len Brown4be44fc2005-08-05 00:44:28 -0400195void acpi_os_wait_events_complete(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Bob Moore5df7e6c2010-01-21 10:06:32 +0800197void acpi_os_sleep(u64 milliseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Len Brown4be44fc2005-08-05 00:44:28 -0400199void acpi_os_stall(u32 microseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201/*
202 * Platform and hardware-independent I/O interfaces
203 */
Len Brown4be44fc2005-08-05 00:44:28 -0400204acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Len Brown4be44fc2005-08-05 00:44:28 -0400206acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/*
209 * Platform and hardware-independent physical memory interfaces
210 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400212acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217/*
218 * Platform and hardware-independent PCI configuration space access
219 * Note: Can't use "Register" as a parameter, changed to "Reg" --
220 * certain compilers complain.
221 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400223acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
Bob Moorec5f02312010-08-06 08:57:53 +0800224 u32 reg, u64 *value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400227acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800228 u32 reg, u64 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 * Miscellaneous
232 */
Len Brown7cb7f452009-07-27 18:42:38 -0400233acpi_status
234acpi_os_validate_address(u8 space_id, acpi_physical_address address,
235 acpi_size length, char *name);
Lin Minga5fe1a02009-08-13 10:43:27 +0800236acpi_status
237acpi_os_invalidate_address(u8 space_id, acpi_physical_address address,
238 acpi_size length);
Len Brown7cb7f452009-07-27 18:42:38 -0400239
Len Brown4be44fc2005-08-05 00:44:28 -0400240u64 acpi_os_get_timer(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Len Brown4be44fc2005-08-05 00:44:28 -0400242acpi_status acpi_os_signal(u32 function, void *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244/*
245 * Debug print routines
246 */
Len Brown4be44fc2005-08-05 00:44:28 -0400247void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Len Brown4be44fc2005-08-05 00:44:28 -0400249void acpi_os_vprintf(const char *format, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Len Brown4be44fc2005-08-05 00:44:28 -0400251void acpi_os_redirect_output(void *destination);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Robert Moore44f6c012005-04-18 22:49:35 -0400253#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254/*
255 * Debug input
256 */
Len Brown4be44fc2005-08-05 00:44:28 -0400257u32 acpi_os_get_line(char *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#endif
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260/*
261 * Directory manipulation
262 */
Len Brown4be44fc2005-08-05 00:44:28 -0400263void *acpi_os_open_directory(char *pathname,
264 char *wildcard_spec, char requested_file_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266/* requeste_file_type values */
267
268#define REQUEST_FILE_ONLY 0
269#define REQUEST_DIR_ONLY 1
270
Len Brown4be44fc2005-08-05 00:44:28 -0400271char *acpi_os_get_next_filename(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Len Brown4be44fc2005-08-05 00:44:28 -0400273void acpi_os_close_directory(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Len Brown4be44fc2005-08-05 00:44:28 -0400275#endif /* __ACPIOSXF_H__ */