1 /****************************************************************************** 2 * 3 * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These 4 * interfaces must be implemented by OSL to interface the 5 * ACPI components to the host operating system. 6 * 7 *****************************************************************************/ 8 9 /* 10 * Copyright (C) 2000 - 2015, Intel Corp. 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 49 #include <acpi/platform/acenv.h> 50 #include <acpi/actypes.h> 51 52 /* Types for acpi_os_execute */ 53 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, 60 OSL_EC_BURST_HANDLER 61 } acpi_execute_type; 62 63 #define ACPI_NO_UNIT_LIMIT ((u32) -1) 64 #define ACPI_MUTEX_SEM 1 65 66 /* Functions for acpi_os_signal */ 67 68 #define ACPI_SIGNAL_FATAL 0 69 #define ACPI_SIGNAL_BREAKPOINT 1 70 71 struct acpi_signal_fatal_info { 72 u32 type; 73 u32 code; 74 u32 argument; 75 }; 76 77 /* 78 * OSL Initialization and shutdown primitives 79 */ 80 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize 81 acpi_status acpi_os_initialize(void); 82 #endif 83 84 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate 85 acpi_status acpi_os_terminate(void); 86 #endif 87 88 /* 89 * ACPI Table interfaces 90 */ 91 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_root_pointer 92 acpi_physical_address acpi_os_get_root_pointer(void); 93 #endif 94 95 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_predefined_override 96 acpi_status 97 acpi_os_predefined_override(const struct acpi_predefined_names *init_val, 98 acpi_string * new_val); 99 #endif 100 101 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_table_override 102 acpi_status 103 acpi_os_table_override(struct acpi_table_header *existing_table, 104 struct acpi_table_header **new_table); 105 #endif 106 107 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_physical_table_override 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); 112 #endif 113 114 /* 115 * Spinlock primitives 116 */ 117 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock 118 acpi_status acpi_os_create_lock(acpi_spinlock * out_handle); 119 #endif 120 121 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_lock 122 void acpi_os_delete_lock(acpi_spinlock handle); 123 #endif 124 125 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_lock 126 acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle); 127 #endif 128 129 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_lock 130 void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags); 131 #endif 132 133 /* 134 * Semaphore primitives 135 */ 136 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_semaphore 137 acpi_status 138 acpi_os_create_semaphore(u32 max_units, 139 u32 initial_units, acpi_semaphore * out_handle); 140 #endif 141 142 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_semaphore 143 acpi_status acpi_os_delete_semaphore(acpi_semaphore handle); 144 #endif 145 146 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_semaphore 147 acpi_status 148 acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout); 149 #endif 150 151 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal_semaphore 152 acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units); 153 #endif 154 155 /* 156 * Mutex primitives. May be configured to use semaphores instead via 157 * ACPI_MUTEX_TYPE (see platform/acenv.h) 158 */ 159 #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE) 160 161 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_mutex 162 acpi_status acpi_os_create_mutex(acpi_mutex * out_handle); 163 #endif 164 165 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_mutex 166 void acpi_os_delete_mutex(acpi_mutex handle); 167 #endif 168 169 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_mutex 170 acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout); 171 #endif 172 173 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_mutex 174 void acpi_os_release_mutex(acpi_mutex handle); 175 #endif 176 177 #endif 178 179 /* 180 * Memory allocation and mapping 181 */ 182 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate 183 void *acpi_os_allocate(acpi_size size); 184 #endif 185 186 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed 187 void *acpi_os_allocate_zeroed(acpi_size size); 188 #endif 189 190 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free 191 void acpi_os_free(void *memory); 192 #endif 193 194 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory 195 void *acpi_os_map_memory(acpi_physical_address where, acpi_size length); 196 #endif 197 198 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory 199 void acpi_os_unmap_memory(void *logical_address, acpi_size size); 200 #endif 201 202 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_physical_address 203 acpi_status 204 acpi_os_get_physical_address(void *logical_address, 205 acpi_physical_address * physical_address); 206 #endif 207 208 /* 209 * Memory/Object Cache 210 */ 211 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_cache 212 acpi_status 213 acpi_os_create_cache(char *cache_name, 214 u16 object_size, 215 u16 max_depth, acpi_cache_t ** return_cache); 216 #endif 217 218 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_cache 219 acpi_status acpi_os_delete_cache(acpi_cache_t * cache); 220 #endif 221 222 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_purge_cache 223 acpi_status acpi_os_purge_cache(acpi_cache_t * cache); 224 #endif 225 226 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object 227 void *acpi_os_acquire_object(acpi_cache_t * cache); 228 #endif 229 230 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_object 231 acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object); 232 #endif 233 234 /* 235 * Interrupt handlers 236 */ 237 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_install_interrupt_handler 238 acpi_status 239 acpi_os_install_interrupt_handler(u32 interrupt_number, 240 acpi_osd_handler service_routine, 241 void *context); 242 #endif 243 244 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_remove_interrupt_handler 245 acpi_status 246 acpi_os_remove_interrupt_handler(u32 interrupt_number, 247 acpi_osd_handler service_routine); 248 #endif 249 250 /* 251 * Threads and Scheduling 252 */ 253 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id 254 acpi_thread_id acpi_os_get_thread_id(void); 255 #endif 256 257 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_execute 258 acpi_status 259 acpi_os_execute(acpi_execute_type type, 260 acpi_osd_exec_callback function, void *context); 261 #endif 262 263 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_events_complete 264 void acpi_os_wait_events_complete(void); 265 #endif 266 267 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_sleep 268 void acpi_os_sleep(u64 milliseconds); 269 #endif 270 271 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_stall 272 void acpi_os_stall(u32 microseconds); 273 #endif 274 275 /* 276 * Platform and hardware-independent I/O interfaces 277 */ 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 281 282 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_port 283 acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width); 284 #endif 285 286 /* 287 * Platform and hardware-independent physical memory interfaces 288 */ 289 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_memory 290 acpi_status 291 acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width); 292 #endif 293 294 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_memory 295 acpi_status 296 acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width); 297 #endif 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 */ 304 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_pci_configuration 305 acpi_status 306 acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id, 307 u32 reg, u64 *value, u32 width); 308 #endif 309 310 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_pci_configuration 311 acpi_status 312 acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id, 313 u32 reg, u64 value, u32 width); 314 #endif 315 316 /* 317 * Miscellaneous 318 */ 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 328 u64 acpi_os_get_timer(void); 329 #endif 330 331 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal 332 acpi_status acpi_os_signal(u32 function, void *info); 333 #endif 334 335 /* 336 * Debug print routines 337 */ 338 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_printf 339 void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...); 340 #endif 341 342 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_vprintf 343 void acpi_os_vprintf(const char *format, va_list args); 344 #endif 345 346 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output 347 void acpi_os_redirect_output(void *destination); 348 #endif 349 350 /* 351 * Debug input 352 */ 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 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); 379 #endif 380 381 /* 382 * Directory manipulation 383 */ 384 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory 385 void *acpi_os_open_directory(char *pathname, 386 char *wildcard_spec, char requested_file_type); 387 #endif 388 389 /* requeste_file_type values */ 390 391 #define REQUEST_FILE_ONLY 0 392 #define REQUEST_DIR_ONLY 1 393 394 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename 395 char *acpi_os_get_next_filename(void *dir_handle); 396 #endif 397 398 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory 399 void acpi_os_close_directory(void *dir_handle); 400 #endif 401 402 /* 403 * File I/O and related support 404 */ 405 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_file 406 ACPI_FILE acpi_os_open_file(const char *path, u8 modes); 407 #endif 408 409 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_file 410 void acpi_os_close_file(ACPI_FILE file); 411 #endif 412 413 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_file 414 int 415 acpi_os_read_file(ACPI_FILE file, 416 void *buffer, acpi_size size, acpi_size count); 417 #endif 418 419 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_file 420 int 421 acpi_os_write_file(ACPI_FILE file, 422 void *buffer, acpi_size size, acpi_size count); 423 #endif 424 425 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_file_offset 426 long acpi_os_get_file_offset(ACPI_FILE file); 427 #endif 428 429 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_set_file_offset 430 acpi_status acpi_os_set_file_offset(ACPI_FILE file, long offset, u8 from); 431 #endif 432 433 #endif /* __ACPIOSXF_H__ */ 434