drm: Fix shifts of EDID vsync offset/width fields.
[linux-2.6-block.git] / include / acpi / acpiosxf.h
CommitLineData
1da177e4
LT
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
1da177e4 10/*
75a44ce0 11 * Copyright (C) 2000 - 2008, Intel Corp.
1da177e4
LT
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
958dd242 53/* Types for acpi_os_execute */
1da177e4 54
958dd242
BM
55typedef enum {
56 OSL_GLOBAL_LOCK_HANDLER,
57 OSL_NOTIFY_HANDLER,
58 OSL_GPE_HANDLER,
59 OSL_DEBUGGER_THREAD,
60 OSL_EC_POLL_HANDLER,
4119532c 61 OSL_EC_BURST_HANDLER
958dd242 62} acpi_execute_type;
1da177e4
LT
63
64#define ACPI_NO_UNIT_LIMIT ((u32) -1)
65#define ACPI_MUTEX_SEM 1
66
1da177e4
LT
67/* Functions for acpi_os_signal */
68
69#define ACPI_SIGNAL_FATAL 0
70#define ACPI_SIGNAL_BREAKPOINT 1
71
4be44fcd
LB
72struct acpi_signal_fatal_info {
73 u32 type;
74 u32 code;
75 u32 argument;
1da177e4
LT
76};
77
1da177e4
LT
78/*
79 * OSL Initialization and shutdown primitives
80 */
dd272b57 81acpi_status __initdata acpi_os_initialize(void);
1da177e4 82
4be44fcd 83acpi_status acpi_os_terminate(void);
1da177e4
LT
84
85/*
86 * ACPI Table interfaces
87 */
f3d2e786 88acpi_physical_address acpi_os_get_root_pointer(void);
1da177e4
LT
89
90acpi_status
4be44fcd
LB
91acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
92 acpi_string * new_val);
1da177e4
LT
93
94acpi_status
4be44fcd
LB
95acpi_os_table_override(struct acpi_table_header *existing_table,
96 struct acpi_table_header **new_table);
1da177e4
LT
97
98/*
967440e3
BM
99 * 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
1da177e4 111 */
1da177e4 112acpi_status
4be44fcd 113acpi_os_create_semaphore(u32 max_units,
967440e3 114 u32 initial_units, acpi_semaphore * out_handle);
1da177e4 115
967440e3 116acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
1da177e4 117
967440e3
BM
118acpi_status
119acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
120
121acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
122
123/*
1685bd40
BM
124 * Mutex primitives. May be configured to use semaphores instead via
125 * ACPI_MUTEX_TYPE (see platform/acenv.h)
967440e3 126 */
1685bd40
BM
127#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
128
967440e3 129acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
1da177e4 130
967440e3 131void acpi_os_delete_mutex(acpi_mutex handle);
1da177e4 132
967440e3 133acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
1da177e4 134
967440e3 135void acpi_os_release_mutex(acpi_mutex handle);
1685bd40 136#endif
1da177e4
LT
137
138/*
139 * Memory allocation and mapping
140 */
4be44fcd 141void *acpi_os_allocate(acpi_size size);
1da177e4 142
fd350943 143void __iomem *acpi_os_map_memory(acpi_physical_address where,
67a119f9 144 acpi_size length);
1da177e4 145
4be44fcd 146void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
1da177e4
LT
147
148#ifdef ACPI_FUTURE_USAGE
149acpi_status
4be44fcd
LB
150acpi_os_get_physical_address(void *logical_address,
151 acpi_physical_address * physical_address);
1da177e4
LT
152#endif
153
73459f73
RM
154/*
155 * Memory/Object Cache
156 */
157acpi_status
4be44fcd
LB
158acpi_os_create_cache(char *cache_name,
159 u16 object_size,
160 u16 max_depth, acpi_cache_t ** return_cache);
73459f73 161
4be44fcd 162acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
73459f73 163
4be44fcd 164acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
73459f73 165
4be44fcd 166void *acpi_os_acquire_object(acpi_cache_t * cache);
73459f73 167
4be44fcd 168acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
73459f73 169
1da177e4
LT
170/*
171 * Interrupt handlers
172 */
1da177e4 173acpi_status
4be44fcd
LB
174acpi_os_install_interrupt_handler(u32 gsi,
175 acpi_osd_handler service_routine,
176 void *context);
1da177e4
LT
177
178acpi_status
4be44fcd 179acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
1da177e4 180
5229e87d
LB
181void acpi_os_gpe_count(u32 gpe_number);
182void acpi_os_fixed_event_count(u32 fixed_event_number);
183
1da177e4
LT
184/*
185 * Threads and Scheduling
186 */
8313524a 187acpi_thread_id acpi_os_get_thread_id(void);
1da177e4
LT
188
189acpi_status
958dd242
BM
190acpi_os_execute(acpi_execute_type type,
191 acpi_osd_exec_callback function, void *context);
1da177e4 192
19cd847a
ZR
193acpi_status
194acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context);
195
4be44fcd 196void acpi_os_wait_events_complete(void *context);
1da177e4 197
4be44fcd 198void acpi_os_sleep(acpi_integer milliseconds);
1da177e4 199
4be44fcd 200void acpi_os_stall(u32 microseconds);
1da177e4
LT
201
202/*
203 * Platform and hardware-independent I/O interfaces
204 */
4be44fcd 205acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
1da177e4 206
4be44fcd 207acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
1da177e4
LT
208
209/*
210 * Platform and hardware-independent physical memory interfaces
211 */
1da177e4 212acpi_status
4be44fcd 213acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
1da177e4
LT
214
215acpi_status
4be44fcd 216acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
1da177e4
LT
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 */
1da177e4 223acpi_status
4be44fcd 224acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
10270d48 225 u32 reg, u32 *value, u32 width);
1da177e4
LT
226
227acpi_status
4be44fcd
LB
228acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
229 u32 reg, acpi_integer value, u32 width);
1da177e4
LT
230
231/*
232 * Interim function needed for PCI IRQ routing
233 */
1da177e4 234void
4be44fcd
LB
235acpi_os_derive_pci_id(acpi_handle rhandle,
236 acpi_handle chandle, struct acpi_pci_id **pci_id);
1da177e4
LT
237
238/*
239 * Miscellaneous
240 */
b229cf92 241acpi_status acpi_os_validate_interface(char *interface);
ae00d812 242acpi_status acpi_osi_invalidate(char* interface);
b229cf92
BM
243
244acpi_status
df92e695
TR
245acpi_os_validate_address(u8 space_id, acpi_physical_address address,
246 acpi_size length, char *name);
b229cf92 247
4be44fcd 248u64 acpi_os_get_timer(void);
1da177e4 249
4be44fcd 250acpi_status acpi_os_signal(u32 function, void *info);
1da177e4
LT
251
252/*
253 * Debug print routines
254 */
4be44fcd 255void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
1da177e4 256
4be44fcd 257void acpi_os_vprintf(const char *format, va_list args);
1da177e4 258
4be44fcd 259void acpi_os_redirect_output(void *destination);
1da177e4 260
44f6c012 261#ifdef ACPI_FUTURE_USAGE
1da177e4
LT
262/*
263 * Debug input
264 */
4be44fcd 265u32 acpi_os_get_line(char *buffer);
1da177e4
LT
266#endif
267
1da177e4
LT
268/*
269 * Directory manipulation
270 */
4be44fcd
LB
271void *acpi_os_open_directory(char *pathname,
272 char *wildcard_spec, char requested_file_type);
1da177e4
LT
273
274/* requeste_file_type values */
275
276#define REQUEST_FILE_ONLY 0
277#define REQUEST_DIR_ONLY 1
278
4be44fcd 279char *acpi_os_get_next_filename(void *dir_handle);
1da177e4 280
4be44fcd 281void acpi_os_close_directory(void *dir_handle);
1da177e4 282
4be44fcd 283#endif /* __ACPIOSXF_H__ */