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