]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
abf95c36 | 3 | * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These |
1da177e4 LT |
4 | * interfaces must be implemented by OSL to interface the |
5 | * ACPI components to the host operating system. | |
6 | * | |
7 | *****************************************************************************/ | |
8 | ||
1da177e4 | 9 | /* |
25f044e6 | 10 | * Copyright (C) 2000 - 2013, Intel Corp. |
1da177e4 LT |
11 | * All rights reserved. |
12 | * | |
13 | * Redistribution and use in source and binary forms, with or without | |
14 | * modification, are permitted provided that the following conditions | |
15 | * are met: | |
16 | * 1. Redistributions of source code must retain the above copyright | |
17 | * notice, this list of conditions, and the following disclaimer, | |
18 | * without modification. | |
19 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
20 | * substantially similar to the "NO WARRANTY" disclaimer below | |
21 | * ("Disclaimer") and any redistribution must be conditioned upon | |
22 | * including a substantially similar Disclaimer requirement for further | |
23 | * binary redistribution. | |
24 | * 3. Neither the names of the above-listed copyright holders nor the names | |
25 | * of any contributors may be used to endorse or promote products derived | |
26 | * from this software without specific prior written permission. | |
27 | * | |
28 | * Alternatively, this software may be distributed under the terms of the | |
29 | * GNU General Public License ("GPL") version 2 as published by the Free | |
30 | * Software Foundation. | |
31 | * | |
32 | * NO WARRANTY | |
33 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
34 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
35 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
36 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
37 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
38 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
39 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
40 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
41 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
42 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
43 | * POSSIBILITY OF SUCH DAMAGES. | |
44 | */ | |
45 | ||
46 | #ifndef __ACPIOSXF_H__ | |
47 | #define __ACPIOSXF_H__ | |
48 | ||
a1ce3928 DH |
49 | #include <acpi/platform/acenv.h> |
50 | #include <acpi/actypes.h> | |
1da177e4 | 51 | |
958dd242 | 52 | /* Types for acpi_os_execute */ |
1da177e4 | 53 | |
958dd242 BM |
54 | typedef enum { |
55 | OSL_GLOBAL_LOCK_HANDLER, | |
56 | OSL_NOTIFY_HANDLER, | |
57 | OSL_GPE_HANDLER, | |
58 | OSL_DEBUGGER_THREAD, | |
59 | OSL_EC_POLL_HANDLER, | |
4119532c | 60 | OSL_EC_BURST_HANDLER |
958dd242 | 61 | } acpi_execute_type; |
1da177e4 LT |
62 | |
63 | #define ACPI_NO_UNIT_LIMIT ((u32) -1) | |
64 | #define ACPI_MUTEX_SEM 1 | |
65 | ||
1da177e4 LT |
66 | /* Functions for acpi_os_signal */ |
67 | ||
68 | #define ACPI_SIGNAL_FATAL 0 | |
69 | #define ACPI_SIGNAL_BREAKPOINT 1 | |
70 | ||
4be44fcd LB |
71 | struct acpi_signal_fatal_info { |
72 | u32 type; | |
73 | u32 code; | |
74 | u32 argument; | |
1da177e4 LT |
75 | }; |
76 | ||
1da177e4 LT |
77 | /* |
78 | * OSL Initialization and shutdown primitives | |
79 | */ | |
7e94632f | 80 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize |
93220587 | 81 | acpi_status acpi_os_initialize(void); |
7e94632f | 82 | #endif |
1da177e4 | 83 | |
7e94632f | 84 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate |
4be44fcd | 85 | acpi_status acpi_os_terminate(void); |
7e94632f | 86 | #endif |
1da177e4 LT |
87 | |
88 | /* | |
89 | * ACPI Table interfaces | |
90 | */ | |
7e94632f | 91 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_root_pointer |
f3d2e786 | 92 | acpi_physical_address acpi_os_get_root_pointer(void); |
7e94632f | 93 | #endif |
1da177e4 | 94 | |
7e94632f | 95 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_predefined_override |
1da177e4 | 96 | acpi_status |
4be44fcd LB |
97 | acpi_os_predefined_override(const struct acpi_predefined_names *init_val, |
98 | acpi_string * new_val); | |
7e94632f | 99 | #endif |
1da177e4 | 100 | |
7e94632f | 101 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_table_override |
1da177e4 | 102 | acpi_status |
4be44fcd LB |
103 | acpi_os_table_override(struct acpi_table_header *existing_table, |
104 | struct acpi_table_header **new_table); | |
7e94632f | 105 | #endif |
1da177e4 | 106 | |
7e94632f | 107 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_physical_table_override |
f7b004a1 BM |
108 | acpi_status |
109 | acpi_os_physical_table_override(struct acpi_table_header *existing_table, | |
110 | acpi_physical_address * new_address, | |
111 | u32 *new_table_length); | |
7e94632f | 112 | #endif |
f7b004a1 | 113 | |
1da177e4 | 114 | /* |
967440e3 BM |
115 | * Spinlock primitives |
116 | */ | |
7e94632f | 117 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock |
3e8214e5 | 118 | acpi_status acpi_os_create_lock(acpi_spinlock * out_handle); |
07e49a7a | 119 | #endif |
9f63b88b | 120 | |
7e94632f | 121 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_lock |
967440e3 | 122 | void acpi_os_delete_lock(acpi_spinlock handle); |
7e94632f | 123 | #endif |
967440e3 | 124 | |
7e94632f | 125 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_lock |
967440e3 | 126 | acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle); |
7e94632f | 127 | #endif |
967440e3 | 128 | |
7e94632f | 129 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_lock |
967440e3 | 130 | void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags); |
7e94632f | 131 | #endif |
967440e3 BM |
132 | |
133 | /* | |
134 | * Semaphore primitives | |
1da177e4 | 135 | */ |
7e94632f | 136 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_semaphore |
1da177e4 | 137 | acpi_status |
4be44fcd | 138 | acpi_os_create_semaphore(u32 max_units, |
967440e3 | 139 | u32 initial_units, acpi_semaphore * out_handle); |
7e94632f | 140 | #endif |
1da177e4 | 141 | |
7e94632f | 142 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_semaphore |
967440e3 | 143 | acpi_status acpi_os_delete_semaphore(acpi_semaphore handle); |
7e94632f | 144 | #endif |
1da177e4 | 145 | |
7e94632f | 146 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_semaphore |
967440e3 BM |
147 | acpi_status |
148 | acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout); | |
7e94632f | 149 | #endif |
967440e3 | 150 | |
7e94632f | 151 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal_semaphore |
967440e3 | 152 | acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units); |
7e94632f | 153 | #endif |
967440e3 BM |
154 | |
155 | /* | |
1685bd40 BM |
156 | * Mutex primitives. May be configured to use semaphores instead via |
157 | * ACPI_MUTEX_TYPE (see platform/acenv.h) | |
967440e3 | 158 | */ |
1685bd40 BM |
159 | #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE) |
160 | ||
7e94632f | 161 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_mutex |
967440e3 | 162 | acpi_status acpi_os_create_mutex(acpi_mutex * out_handle); |
7e94632f | 163 | #endif |
1da177e4 | 164 | |
7e94632f | 165 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_mutex |
967440e3 | 166 | void acpi_os_delete_mutex(acpi_mutex handle); |
7e94632f | 167 | #endif |
1da177e4 | 168 | |
7e94632f | 169 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_mutex |
967440e3 | 170 | acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout); |
7e94632f | 171 | #endif |
1da177e4 | 172 | |
7e94632f | 173 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_mutex |
967440e3 | 174 | void acpi_os_release_mutex(acpi_mutex handle); |
1685bd40 | 175 | #endif |
1da177e4 | 176 | |
7e94632f LZ |
177 | #endif |
178 | ||
1da177e4 LT |
179 | /* |
180 | * Memory allocation and mapping | |
181 | */ | |
7e94632f | 182 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate |
4be44fcd | 183 | void *acpi_os_allocate(acpi_size size); |
7e94632f | 184 | #endif |
1da177e4 | 185 | |
7e94632f | 186 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed |
b3c86c30 | 187 | void *acpi_os_allocate_zeroed(acpi_size size); |
7e94632f | 188 | #endif |
b3c86c30 | 189 | |
7e94632f | 190 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free |
739dcbb9 | 191 | void acpi_os_free(void *memory); |
7e94632f | 192 | #endif |
739dcbb9 | 193 | |
7e94632f | 194 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory |
93220587 | 195 | void *acpi_os_map_memory(acpi_physical_address where, acpi_size length); |
7e94632f | 196 | #endif |
1da177e4 | 197 | |
7e94632f | 198 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory |
93220587 | 199 | void acpi_os_unmap_memory(void *logical_address, acpi_size size); |
7e94632f | 200 | #endif |
1da177e4 | 201 | |
7e94632f | 202 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_physical_address |
1da177e4 | 203 | acpi_status |
4be44fcd LB |
204 | acpi_os_get_physical_address(void *logical_address, |
205 | acpi_physical_address * physical_address); | |
1da177e4 LT |
206 | #endif |
207 | ||
73459f73 RM |
208 | /* |
209 | * Memory/Object Cache | |
210 | */ | |
7e94632f | 211 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_cache |
73459f73 | 212 | acpi_status |
4be44fcd LB |
213 | acpi_os_create_cache(char *cache_name, |
214 | u16 object_size, | |
215 | u16 max_depth, acpi_cache_t ** return_cache); | |
7e94632f | 216 | #endif |
73459f73 | 217 | |
7e94632f | 218 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_cache |
4be44fcd | 219 | acpi_status acpi_os_delete_cache(acpi_cache_t * cache); |
7e94632f | 220 | #endif |
73459f73 | 221 | |
7e94632f | 222 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_purge_cache |
4be44fcd | 223 | acpi_status acpi_os_purge_cache(acpi_cache_t * cache); |
7e94632f | 224 | #endif |
73459f73 | 225 | |
7e94632f | 226 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object |
4be44fcd | 227 | void *acpi_os_acquire_object(acpi_cache_t * cache); |
7e94632f | 228 | #endif |
73459f73 | 229 | |
7e94632f | 230 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_object |
4be44fcd | 231 | acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object); |
7e94632f | 232 | #endif |
73459f73 | 233 | |
1da177e4 LT |
234 | /* |
235 | * Interrupt handlers | |
236 | */ | |
7e94632f | 237 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_install_interrupt_handler |
1da177e4 | 238 | acpi_status |
739dcbb9 | 239 | acpi_os_install_interrupt_handler(u32 interrupt_number, |
4be44fcd LB |
240 | acpi_osd_handler service_routine, |
241 | void *context); | |
7e94632f | 242 | #endif |
1da177e4 | 243 | |
7e94632f | 244 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_remove_interrupt_handler |
1da177e4 | 245 | acpi_status |
739dcbb9 LZ |
246 | acpi_os_remove_interrupt_handler(u32 interrupt_number, |
247 | acpi_osd_handler service_routine); | |
7e94632f | 248 | #endif |
1da177e4 LT |
249 | |
250 | /* | |
251 | * Threads and Scheduling | |
252 | */ | |
7e94632f | 253 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id |
8313524a | 254 | acpi_thread_id acpi_os_get_thread_id(void); |
7e94632f | 255 | #endif |
1da177e4 | 256 | |
7e94632f | 257 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_execute |
1da177e4 | 258 | acpi_status |
958dd242 BM |
259 | acpi_os_execute(acpi_execute_type type, |
260 | acpi_osd_exec_callback function, void *context); | |
7e94632f | 261 | #endif |
1da177e4 | 262 | |
7e94632f | 263 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_events_complete |
bd6f10a5 | 264 | void acpi_os_wait_events_complete(void); |
7e94632f | 265 | #endif |
1da177e4 | 266 | |
7e94632f | 267 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_sleep |
5df7e6cb | 268 | void acpi_os_sleep(u64 milliseconds); |
7e94632f | 269 | #endif |
1da177e4 | 270 | |
7e94632f | 271 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_stall |
4be44fcd | 272 | void acpi_os_stall(u32 microseconds); |
7e94632f | 273 | #endif |
1da177e4 LT |
274 | |
275 | /* | |
276 | * Platform and hardware-independent I/O interfaces | |
277 | */ | |
7e94632f LZ |
278 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_port |
279 | acpi_status acpi_os_read_port(acpi_io_address address, u32 *value, u32 width); | |
280 | #endif | |
1da177e4 | 281 | |
7e94632f | 282 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_port |
4be44fcd | 283 | acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width); |
7e94632f | 284 | #endif |
1da177e4 LT |
285 | |
286 | /* | |
287 | * Platform and hardware-independent physical memory interfaces | |
288 | */ | |
7e94632f | 289 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_memory |
1da177e4 | 290 | acpi_status |
653f4b53 | 291 | acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width); |
7e94632f | 292 | #endif |
1da177e4 | 293 | |
7e94632f | 294 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_memory |
1da177e4 | 295 | acpi_status |
653f4b53 | 296 | acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width); |
7e94632f | 297 | #endif |
1da177e4 LT |
298 | |
299 | /* | |
300 | * Platform and hardware-independent PCI configuration space access | |
301 | * Note: Can't use "Register" as a parameter, changed to "Reg" -- | |
302 | * certain compilers complain. | |
303 | */ | |
7e94632f | 304 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_pci_configuration |
1da177e4 | 305 | acpi_status |
4be44fcd | 306 | acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id, |
c5f0231e | 307 | u32 reg, u64 *value, u32 width); |
7e94632f | 308 | #endif |
1da177e4 | 309 | |
7e94632f | 310 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_pci_configuration |
1da177e4 | 311 | acpi_status |
4be44fcd | 312 | acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id, |
5df7e6cb | 313 | u32 reg, u64 value, u32 width); |
7e94632f | 314 | #endif |
1da177e4 | 315 | |
1da177e4 LT |
316 | /* |
317 | * Miscellaneous | |
318 | */ | |
7e94632f LZ |
319 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable |
320 | u8 acpi_os_readable(void *pointer, acpi_size length); | |
321 | #endif | |
322 | ||
323 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable | |
324 | u8 acpi_os_writable(void *pointer, acpi_size length); | |
325 | #endif | |
326 | ||
327 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_timer | |
4be44fcd | 328 | u64 acpi_os_get_timer(void); |
7e94632f | 329 | #endif |
1da177e4 | 330 | |
7e94632f | 331 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal |
4be44fcd | 332 | acpi_status acpi_os_signal(u32 function, void *info); |
7e94632f | 333 | #endif |
1da177e4 LT |
334 | |
335 | /* | |
336 | * Debug print routines | |
337 | */ | |
7e94632f | 338 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_printf |
4be44fcd | 339 | void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...); |
7e94632f | 340 | #endif |
1da177e4 | 341 | |
7e94632f | 342 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_vprintf |
4be44fcd | 343 | void acpi_os_vprintf(const char *format, va_list args); |
7e94632f | 344 | #endif |
1da177e4 | 345 | |
7e94632f | 346 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output |
4be44fcd | 347 | void acpi_os_redirect_output(void *destination); |
7e94632f | 348 | #endif |
1da177e4 LT |
349 | |
350 | /* | |
351 | * Debug input | |
352 | */ | |
7e94632f LZ |
353 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line |
354 | acpi_status acpi_os_get_line(char *buffer, u32 buffer_length, u32 *bytes_read); | |
355 | #endif | |
7e94632f LZ |
356 | |
357 | /* | |
358 | * Obtain ACPI table(s) | |
359 | */ | |
360 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name | |
361 | acpi_status | |
362 | acpi_os_get_table_by_name(char *signature, | |
363 | u32 instance, | |
364 | struct acpi_table_header **table, | |
365 | acpi_physical_address * address); | |
366 | #endif | |
367 | ||
368 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index | |
369 | acpi_status | |
370 | acpi_os_get_table_by_index(u32 index, | |
371 | struct acpi_table_header **table, | |
372 | u32 *instance, acpi_physical_address * address); | |
373 | #endif | |
374 | ||
375 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address | |
376 | acpi_status | |
377 | acpi_os_get_table_by_address(acpi_physical_address address, | |
378 | struct acpi_table_header **table); | |
1da177e4 LT |
379 | #endif |
380 | ||
1da177e4 LT |
381 | /* |
382 | * Directory manipulation | |
383 | */ | |
7e94632f | 384 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory |
4be44fcd LB |
385 | void *acpi_os_open_directory(char *pathname, |
386 | char *wildcard_spec, char requested_file_type); | |
7e94632f | 387 | #endif |
1da177e4 LT |
388 | |
389 | /* requeste_file_type values */ | |
390 | ||
391 | #define REQUEST_FILE_ONLY 0 | |
392 | #define REQUEST_DIR_ONLY 1 | |
393 | ||
7e94632f | 394 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename |
4be44fcd | 395 | char *acpi_os_get_next_filename(void *dir_handle); |
7e94632f | 396 | #endif |
1da177e4 | 397 | |
7e94632f | 398 | #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory |
4be44fcd | 399 | void acpi_os_close_directory(void *dir_handle); |
7e94632f | 400 | #endif |
1da177e4 | 401 | |
4be44fcd | 402 | #endif /* __ACPIOSXF_H__ */ |