ACPI: ACPICA 20060526
[linux-3.10.git] / include / acpi / acpiosxf.h
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 - 2006, R. Byron Moore
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 acpi_os_initialize(void);
82
83 acpi_status acpi_os_terminate(void);
84
85 /*
86  * ACPI Table interfaces
87  */
88 acpi_status acpi_os_get_root_pointer(u32 flags, struct acpi_pointer *address);
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  * Synchronization primitives
100  */
101 acpi_status
102 acpi_os_create_semaphore(u32 max_units,
103                          u32 initial_units, acpi_handle * out_handle);
104
105 acpi_status acpi_os_delete_semaphore(acpi_handle handle);
106
107 acpi_status acpi_os_wait_semaphore(acpi_handle handle, u32 units, u16 timeout);
108
109 acpi_status acpi_os_signal_semaphore(acpi_handle handle, u32 units);
110
111 acpi_status acpi_os_create_lock(acpi_handle * out_handle);
112
113 void acpi_os_delete_lock(acpi_handle handle);
114
115 acpi_cpu_flags acpi_os_acquire_lock(acpi_handle handle);
116
117 void acpi_os_release_lock(acpi_handle handle, acpi_cpu_flags flags);
118
119 /*
120  * Memory allocation and mapping
121  */
122 void *acpi_os_allocate(acpi_size size);
123
124 void acpi_os_free(void *memory);
125
126 acpi_status
127 acpi_os_map_memory(acpi_physical_address physical_address,
128                    acpi_size size, void __iomem ** logical_address);
129
130 void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
131
132 #ifdef ACPI_FUTURE_USAGE
133 acpi_status
134 acpi_os_get_physical_address(void *logical_address,
135                              acpi_physical_address * physical_address);
136 #endif
137
138 /*
139  * Memory/Object Cache
140  */
141 acpi_status
142 acpi_os_create_cache(char *cache_name,
143                      u16 object_size,
144                      u16 max_depth, acpi_cache_t ** return_cache);
145
146 acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
147
148 acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
149
150 void *acpi_os_acquire_object(acpi_cache_t * cache);
151
152 acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
153
154 /*
155  * Interrupt handlers
156  */
157 acpi_status
158 acpi_os_install_interrupt_handler(u32 gsi,
159                                   acpi_osd_handler service_routine,
160                                   void *context);
161
162 acpi_status
163 acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
164
165 /*
166  * Threads and Scheduling
167  */
168 acpi_thread_id acpi_os_get_thread_id(void);
169
170 acpi_status
171 acpi_os_execute(acpi_execute_type type,
172                 acpi_osd_exec_callback function, void *context);
173
174 void acpi_os_wait_events_complete(void *context);
175
176 void acpi_os_sleep(acpi_integer milliseconds);
177
178 void acpi_os_stall(u32 microseconds);
179
180 /*
181  * Platform and hardware-independent I/O interfaces
182  */
183 acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
184
185 acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
186
187 /*
188  * Platform and hardware-independent physical memory interfaces
189  */
190 acpi_status
191 acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
192
193 acpi_status
194 acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
195
196 /*
197  * Platform and hardware-independent PCI configuration space access
198  * Note: Can't use "Register" as a parameter, changed to "Reg" --
199  * certain compilers complain.
200  */
201 acpi_status
202 acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
203                                u32 reg, void *value, u32 width);
204
205 acpi_status
206 acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
207                                 u32 reg, acpi_integer value, u32 width);
208
209 /*
210  * Interim function needed for PCI IRQ routing
211  */
212 void
213 acpi_os_derive_pci_id(acpi_handle rhandle,
214                       acpi_handle chandle, struct acpi_pci_id **pci_id);
215
216 /*
217  * Miscellaneous
218  */
219 acpi_status acpi_os_validate_interface(char *interface);
220
221 acpi_status
222 acpi_os_validate_address(u8 space_id,
223                          acpi_physical_address address, acpi_size length);
224
225 u8 acpi_os_readable(void *pointer, acpi_size length);
226
227 #ifdef ACPI_FUTURE_USAGE
228 u8 acpi_os_writable(void *pointer, acpi_size length);
229 #endif
230
231 u64 acpi_os_get_timer(void);
232
233 acpi_status acpi_os_signal(u32 function, void *info);
234
235 /*
236  * Debug print routines
237  */
238 void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
239
240 void acpi_os_vprintf(const char *format, va_list args);
241
242 void acpi_os_redirect_output(void *destination);
243
244 #ifdef ACPI_FUTURE_USAGE
245 /*
246  * Debug input
247  */
248 u32 acpi_os_get_line(char *buffer);
249 #endif
250
251 /*
252  * Directory manipulation
253  */
254 void *acpi_os_open_directory(char *pathname,
255                              char *wildcard_spec, char requested_file_type);
256
257 /* requeste_file_type values */
258
259 #define REQUEST_FILE_ONLY                   0
260 #define REQUEST_DIR_ONLY                    1
261
262 char *acpi_os_get_next_filename(void *dir_handle);
263
264 void acpi_os_close_directory(void *dir_handle);
265
266 #endif                          /* __ACPIOSXF_H__ */