blob: 9a5ffcf88f59b153ece10a402524537ed7c3438c [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 Moore4a90c7e2006-01-13 16:22:00 -050011 * Copyright (C) 2000 - 2006, R. Byron Moore
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 Brown4be44fc2005-08-05 00:44:28 -040081acpi_status 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 */
101acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
102
103void acpi_os_delete_lock(acpi_spinlock handle);
104
105acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
106
107void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
108
109/*
110 * Semaphore primitives
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400113acpi_os_create_semaphore(u32 max_units,
Bob Moore967440e2006-06-23 17:04:00 -0400114 u32 initial_units, acpi_semaphore * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Bob Moore967440e2006-06-23 17:04:00 -0400116acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Bob Moore967440e2006-06-23 17:04:00 -0400118acpi_status
119acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Bob Moore967440e2006-06-23 17:04:00 -0400121acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Bob Moore967440e2006-06-23 17:04:00 -0400123/*
124 * Mutex primitives
125 */
126acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Bob Moore967440e2006-06-23 17:04:00 -0400128void acpi_os_delete_mutex(acpi_mutex handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Bob Moore967440e2006-06-23 17:04:00 -0400130acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Bob Moore967440e2006-06-23 17:04:00 -0400132void 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141/*
142 * Memory allocation and mapping
143 */
Len Brown4be44fc2005-08-05 00:44:28 -0400144void *acpi_os_allocate(acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Bob Mooref3d2e782007-02-02 19:48:18 +0300146void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_native_uint length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Len Brown4be44fc2005-08-05 00:44:28 -0400148void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150#ifdef ACPI_FUTURE_USAGE
151acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400152acpi_os_get_physical_address(void *logical_address,
153 acpi_physical_address * physical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#endif
155
Robert Moore73459f72005-06-24 00:00:00 -0400156/*
157 * Memory/Object Cache
158 */
159acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400160acpi_os_create_cache(char *cache_name,
161 u16 object_size,
162 u16 max_depth, acpi_cache_t ** return_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400163
Len Brown4be44fc2005-08-05 00:44:28 -0400164acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400165
Len Brown4be44fc2005-08-05 00:44:28 -0400166acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400167
Len Brown4be44fc2005-08-05 00:44:28 -0400168void *acpi_os_acquire_object(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400169
Len Brown4be44fc2005-08-05 00:44:28 -0400170acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
Robert Moore73459f72005-06-24 00:00:00 -0400171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172/*
173 * Interrupt handlers
174 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400176acpi_os_install_interrupt_handler(u32 gsi,
177 acpi_osd_handler service_routine,
178 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400181acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183/*
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
Len Brown4be44fc2005-08-05 00:44:28 -0400192void acpi_os_wait_events_complete(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Len Brown4be44fc2005-08-05 00:44:28 -0400194void acpi_os_sleep(acpi_integer milliseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Len Brown4be44fc2005-08-05 00:44:28 -0400196void acpi_os_stall(u32 microseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198/*
199 * Platform and hardware-independent I/O interfaces
200 */
Len Brown4be44fc2005-08-05 00:44:28 -0400201acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Len Brown4be44fc2005-08-05 00:44:28 -0400203acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205/*
206 * Platform and hardware-independent physical memory interfaces
207 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400209acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400212acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214/*
215 * Platform and hardware-independent PCI configuration space access
216 * Note: Can't use "Register" as a parameter, changed to "Reg" --
217 * certain compilers complain.
218 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400220acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
221 u32 reg, void *value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400224acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
225 u32 reg, acpi_integer value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227/*
228 * Interim function needed for PCI IRQ routing
229 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230void
Len Brown4be44fc2005-08-05 00:44:28 -0400231acpi_os_derive_pci_id(acpi_handle rhandle,
232 acpi_handle chandle, struct acpi_pci_id **pci_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
234/*
235 * Miscellaneous
236 */
Bob Mooreb229cf92006-04-21 17:15:00 -0400237acpi_status acpi_os_validate_interface(char *interface);
238
239acpi_status
240acpi_os_validate_address(u8 space_id,
241 acpi_physical_address address, acpi_size length);
242
Len Brown4be44fc2005-08-05 00:44:28 -0400243u8 acpi_os_readable(void *pointer, acpi_size length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400246u8 acpi_os_writable(void *pointer, acpi_size length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247#endif
248
Len Brown4be44fc2005-08-05 00:44:28 -0400249u64 acpi_os_get_timer(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Len Brown4be44fc2005-08-05 00:44:28 -0400251acpi_status acpi_os_signal(u32 function, void *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253/*
254 * Debug print routines
255 */
Len Brown4be44fc2005-08-05 00:44:28 -0400256void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Len Brown4be44fc2005-08-05 00:44:28 -0400258void acpi_os_vprintf(const char *format, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Len Brown4be44fc2005-08-05 00:44:28 -0400260void acpi_os_redirect_output(void *destination);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Robert Moore44f6c012005-04-18 22:49:35 -0400262#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263/*
264 * Debug input
265 */
Len Brown4be44fc2005-08-05 00:44:28 -0400266u32 acpi_os_get_line(char *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#endif
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269/*
270 * Directory manipulation
271 */
Len Brown4be44fc2005-08-05 00:44:28 -0400272void *acpi_os_open_directory(char *pathname,
273 char *wildcard_spec, char requested_file_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275/* requeste_file_type values */
276
277#define REQUEST_FILE_ONLY 0
278#define REQUEST_DIR_ONLY 1
279
Len Brown4be44fc2005-08-05 00:44:28 -0400280char *acpi_os_get_next_filename(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Len Brown4be44fc2005-08-05 00:44:28 -0400282void acpi_os_close_directory(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Len Brown4be44fc2005-08-05 00:44:28 -0400284#endif /* __ACPIOSXF_H__ */