Commit | Line | Data |
---|---|---|
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 | /* |
4a90c7e8 | 11 | * Copyright (C) 2000 - 2006, R. Byron Moore |
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 |
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 | ||
63 | } acpi_execute_type; | |
1da177e4 LT |
64 | |
65 | #define ACPI_NO_UNIT_LIMIT ((u32) -1) | |
66 | #define ACPI_MUTEX_SEM 1 | |
67 | ||
1da177e4 LT |
68 | /* Functions for acpi_os_signal */ |
69 | ||
70 | #define ACPI_SIGNAL_FATAL 0 | |
71 | #define ACPI_SIGNAL_BREAKPOINT 1 | |
72 | ||
4be44fcd LB |
73 | struct acpi_signal_fatal_info { |
74 | u32 type; | |
75 | u32 code; | |
76 | u32 argument; | |
1da177e4 LT |
77 | }; |
78 | ||
1da177e4 LT |
79 | /* |
80 | * OSL Initialization and shutdown primitives | |
81 | */ | |
4be44fcd | 82 | acpi_status acpi_os_initialize(void); |
1da177e4 | 83 | |
4be44fcd | 84 | acpi_status acpi_os_terminate(void); |
1da177e4 LT |
85 | |
86 | /* | |
87 | * ACPI Table interfaces | |
88 | */ | |
4be44fcd | 89 | acpi_status acpi_os_get_root_pointer(u32 flags, struct acpi_pointer *address); |
1da177e4 LT |
90 | |
91 | acpi_status | |
4be44fcd LB |
92 | acpi_os_predefined_override(const struct acpi_predefined_names *init_val, |
93 | acpi_string * new_val); | |
1da177e4 LT |
94 | |
95 | acpi_status | |
4be44fcd LB |
96 | acpi_os_table_override(struct acpi_table_header *existing_table, |
97 | struct acpi_table_header **new_table); | |
1da177e4 LT |
98 | |
99 | /* | |
100 | * Synchronization primitives | |
101 | */ | |
1da177e4 | 102 | acpi_status |
4be44fcd LB |
103 | acpi_os_create_semaphore(u32 max_units, |
104 | u32 initial_units, acpi_handle * out_handle); | |
1da177e4 | 105 | |
4be44fcd | 106 | acpi_status acpi_os_delete_semaphore(acpi_handle handle); |
1da177e4 | 107 | |
4be44fcd | 108 | acpi_status acpi_os_wait_semaphore(acpi_handle handle, u32 units, u16 timeout); |
1da177e4 | 109 | |
4be44fcd | 110 | acpi_status acpi_os_signal_semaphore(acpi_handle handle, u32 units); |
1da177e4 | 111 | |
4be44fcd | 112 | acpi_status acpi_os_create_lock(acpi_handle * out_handle); |
1da177e4 | 113 | |
4be44fcd | 114 | void acpi_os_delete_lock(acpi_handle handle); |
1da177e4 | 115 | |
b8e4d893 | 116 | acpi_cpu_flags acpi_os_acquire_lock(acpi_handle handle); |
1da177e4 | 117 | |
b8e4d893 | 118 | void acpi_os_release_lock(acpi_handle handle, acpi_cpu_flags flags); |
1da177e4 LT |
119 | |
120 | /* | |
121 | * Memory allocation and mapping | |
122 | */ | |
4be44fcd | 123 | void *acpi_os_allocate(acpi_size size); |
1da177e4 | 124 | |
4be44fcd | 125 | void acpi_os_free(void *memory); |
1da177e4 LT |
126 | |
127 | acpi_status | |
4be44fcd LB |
128 | acpi_os_map_memory(acpi_physical_address physical_address, |
129 | acpi_size size, void __iomem ** logical_address); | |
1da177e4 | 130 | |
4be44fcd | 131 | void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size); |
1da177e4 LT |
132 | |
133 | #ifdef ACPI_FUTURE_USAGE | |
134 | acpi_status | |
4be44fcd LB |
135 | acpi_os_get_physical_address(void *logical_address, |
136 | acpi_physical_address * physical_address); | |
1da177e4 LT |
137 | #endif |
138 | ||
73459f73 RM |
139 | /* |
140 | * Memory/Object Cache | |
141 | */ | |
142 | acpi_status | |
4be44fcd LB |
143 | acpi_os_create_cache(char *cache_name, |
144 | u16 object_size, | |
145 | u16 max_depth, acpi_cache_t ** return_cache); | |
73459f73 | 146 | |
4be44fcd | 147 | acpi_status acpi_os_delete_cache(acpi_cache_t * cache); |
73459f73 | 148 | |
4be44fcd | 149 | acpi_status acpi_os_purge_cache(acpi_cache_t * cache); |
73459f73 | 150 | |
4be44fcd | 151 | void *acpi_os_acquire_object(acpi_cache_t * cache); |
73459f73 | 152 | |
4be44fcd | 153 | acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object); |
73459f73 | 154 | |
1da177e4 LT |
155 | /* |
156 | * Interrupt handlers | |
157 | */ | |
1da177e4 | 158 | acpi_status |
4be44fcd LB |
159 | acpi_os_install_interrupt_handler(u32 gsi, |
160 | acpi_osd_handler service_routine, | |
161 | void *context); | |
1da177e4 LT |
162 | |
163 | acpi_status | |
4be44fcd | 164 | acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine); |
1da177e4 LT |
165 | |
166 | /* | |
167 | * Threads and Scheduling | |
168 | */ | |
8313524a | 169 | acpi_thread_id acpi_os_get_thread_id(void); |
1da177e4 LT |
170 | |
171 | acpi_status | |
958dd242 BM |
172 | acpi_os_execute(acpi_execute_type type, |
173 | acpi_osd_exec_callback function, void *context); | |
1da177e4 | 174 | |
4be44fcd | 175 | void acpi_os_wait_events_complete(void *context); |
1da177e4 | 176 | |
4be44fcd | 177 | void acpi_os_sleep(acpi_integer milliseconds); |
1da177e4 | 178 | |
4be44fcd | 179 | void acpi_os_stall(u32 microseconds); |
1da177e4 LT |
180 | |
181 | /* | |
182 | * Platform and hardware-independent I/O interfaces | |
183 | */ | |
4be44fcd | 184 | acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width); |
1da177e4 | 185 | |
4be44fcd | 186 | acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width); |
1da177e4 LT |
187 | |
188 | /* | |
189 | * Platform and hardware-independent physical memory interfaces | |
190 | */ | |
1da177e4 | 191 | acpi_status |
4be44fcd | 192 | acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width); |
1da177e4 LT |
193 | |
194 | acpi_status | |
4be44fcd | 195 | acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width); |
1da177e4 LT |
196 | |
197 | /* | |
198 | * Platform and hardware-independent PCI configuration space access | |
199 | * Note: Can't use "Register" as a parameter, changed to "Reg" -- | |
200 | * certain compilers complain. | |
201 | */ | |
1da177e4 | 202 | acpi_status |
4be44fcd LB |
203 | acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id, |
204 | u32 reg, void *value, u32 width); | |
1da177e4 LT |
205 | |
206 | acpi_status | |
4be44fcd LB |
207 | acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id, |
208 | u32 reg, acpi_integer value, u32 width); | |
1da177e4 LT |
209 | |
210 | /* | |
211 | * Interim function needed for PCI IRQ routing | |
212 | */ | |
1da177e4 | 213 | void |
4be44fcd LB |
214 | acpi_os_derive_pci_id(acpi_handle rhandle, |
215 | acpi_handle chandle, struct acpi_pci_id **pci_id); | |
1da177e4 LT |
216 | |
217 | /* | |
218 | * Miscellaneous | |
219 | */ | |
b229cf92 BM |
220 | |
221 | acpi_status acpi_os_validate_interface(char *interface); | |
222 | ||
223 | acpi_status | |
224 | acpi_os_validate_address(u8 space_id, | |
225 | acpi_physical_address address, acpi_size length); | |
226 | ||
4be44fcd | 227 | u8 acpi_os_readable(void *pointer, acpi_size length); |
1da177e4 LT |
228 | |
229 | #ifdef ACPI_FUTURE_USAGE | |
4be44fcd | 230 | u8 acpi_os_writable(void *pointer, acpi_size length); |
1da177e4 LT |
231 | #endif |
232 | ||
4be44fcd | 233 | u64 acpi_os_get_timer(void); |
1da177e4 | 234 | |
4be44fcd | 235 | acpi_status acpi_os_signal(u32 function, void *info); |
1da177e4 LT |
236 | |
237 | /* | |
238 | * Debug print routines | |
239 | */ | |
4be44fcd | 240 | void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...); |
1da177e4 | 241 | |
4be44fcd | 242 | void acpi_os_vprintf(const char *format, va_list args); |
1da177e4 | 243 | |
4be44fcd | 244 | void acpi_os_redirect_output(void *destination); |
1da177e4 | 245 | |
44f6c012 | 246 | #ifdef ACPI_FUTURE_USAGE |
1da177e4 LT |
247 | /* |
248 | * Debug input | |
249 | */ | |
4be44fcd | 250 | u32 acpi_os_get_line(char *buffer); |
1da177e4 LT |
251 | #endif |
252 | ||
1da177e4 LT |
253 | /* |
254 | * Directory manipulation | |
255 | */ | |
4be44fcd LB |
256 | void *acpi_os_open_directory(char *pathname, |
257 | char *wildcard_spec, char requested_file_type); | |
1da177e4 LT |
258 | |
259 | /* requeste_file_type values */ | |
260 | ||
261 | #define REQUEST_FILE_ONLY 0 | |
262 | #define REQUEST_DIR_ONLY 1 | |
263 | ||
4be44fcd | 264 | char *acpi_os_get_next_filename(void *dir_handle); |
1da177e4 | 265 | |
4be44fcd | 266 | void acpi_os_close_directory(void *dir_handle); |
1da177e4 LT |
267 | |
268 | /* | |
269 | * Debug | |
270 | */ | |
1da177e4 | 271 | void |
4be44fcd LB |
272 | acpi_os_dbg_assert(void *failed_assertion, |
273 | void *file_name, u32 line_number, char *message); | |
1da177e4 | 274 | |
4be44fcd | 275 | #endif /* __ACPIOSXF_H__ */ |