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 - 2013, 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 acpi_status __init acpi_os_initialize(void); 81 82 acpi_status acpi_os_terminate(void); 83 84 /* 85 * ACPI Table interfaces 86 */ 87 acpi_physical_address acpi_os_get_root_pointer(void); 88 89 acpi_status 90 acpi_os_predefined_override(const struct acpi_predefined_names *init_val, 91 acpi_string * new_val); 92 93 acpi_status 94 acpi_os_table_override(struct acpi_table_header *existing_table, 95 struct acpi_table_header **new_table); 96 97 acpi_status 98 acpi_os_physical_table_override(struct acpi_table_header *existing_table, 99 acpi_physical_address * new_address, 100 u32 *new_table_length); 101 102 /* 103 * Spinlock primitives 104 */ 105 #ifndef acpi_os_create_lock 106 acpi_status acpi_os_create_lock(acpi_spinlock * out_handle); 107 #endif 108 109 void acpi_os_delete_lock(acpi_spinlock handle); 110 111 acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle); 112 113 void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags); 114 115 /* 116 * Semaphore primitives 117 */ 118 acpi_status 119 acpi_os_create_semaphore(u32 max_units, 120 u32 initial_units, acpi_semaphore * out_handle); 121 122 acpi_status acpi_os_delete_semaphore(acpi_semaphore handle); 123 124 acpi_status 125 acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout); 126 127 acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units); 128 129 /* 130 * Mutex primitives. May be configured to use semaphores instead via 131 * ACPI_MUTEX_TYPE (see platform/acenv.h) 132 */ 133 #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE) 134 135 acpi_status acpi_os_create_mutex(acpi_mutex * out_handle); 136 137 void acpi_os_delete_mutex(acpi_mutex handle); 138 139 acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout); 140 141 void acpi_os_release_mutex(acpi_mutex handle); 142 #endif 143 144 /* 145 * Memory allocation and mapping 146 */ 147 void *acpi_os_allocate(acpi_size size); 148 149 void acpi_os_free(void *memory); 150 151 void __iomem *acpi_os_map_memory(acpi_physical_address where, 152 acpi_size length); 153 154 void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size); 155 void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size); 156 157 #ifdef ACPI_FUTURE_USAGE 158 acpi_status 159 acpi_os_get_physical_address(void *logical_address, 160 acpi_physical_address * physical_address); 161 #endif 162 163 /* 164 * Memory/Object Cache 165 */ 166 acpi_status 167 acpi_os_create_cache(char *cache_name, 168 u16 object_size, 169 u16 max_depth, acpi_cache_t ** return_cache); 170 171 acpi_status acpi_os_delete_cache(acpi_cache_t * cache); 172 173 acpi_status acpi_os_purge_cache(acpi_cache_t * cache); 174 175 void *acpi_os_acquire_object(acpi_cache_t * cache); 176 177 acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object); 178 179 /* 180 * Interrupt handlers 181 */ 182 acpi_status 183 acpi_os_install_interrupt_handler(u32 interrupt_number, 184 acpi_osd_handler service_routine, 185 void *context); 186 187 acpi_status 188 acpi_os_remove_interrupt_handler(u32 interrupt_number, 189 acpi_osd_handler service_routine); 190 191 void acpi_os_gpe_count(u32 gpe_number); 192 void acpi_os_fixed_event_count(u32 fixed_event_number); 193 194 /* 195 * Threads and Scheduling 196 */ 197 acpi_thread_id acpi_os_get_thread_id(void); 198 199 acpi_status 200 acpi_os_execute(acpi_execute_type type, 201 acpi_osd_exec_callback function, void *context); 202 203 acpi_status 204 acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context); 205 206 void acpi_os_wait_events_complete(void); 207 208 void acpi_os_sleep(u64 milliseconds); 209 210 void acpi_os_stall(u32 microseconds); 211 212 /* 213 * Platform and hardware-independent I/O interfaces 214 */ 215 acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width); 216 217 acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width); 218 219 /* 220 * Platform and hardware-independent physical memory interfaces 221 */ 222 acpi_status 223 acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width); 224 225 acpi_status 226 acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width); 227 228 /* 229 * Platform and hardware-independent PCI configuration space access 230 * Note: Can't use "Register" as a parameter, changed to "Reg" -- 231 * certain compilers complain. 232 */ 233 acpi_status 234 acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id, 235 u32 reg, u64 *value, u32 width); 236 237 acpi_status 238 acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id, 239 u32 reg, u64 value, u32 width); 240 241 /* 242 * Miscellaneous 243 */ 244 u64 acpi_os_get_timer(void); 245 246 acpi_status acpi_os_signal(u32 function, void *info); 247 248 /* 249 * Debug print routines 250 */ 251 void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...); 252 253 void acpi_os_vprintf(const char *format, va_list args); 254 255 void acpi_os_redirect_output(void *destination); 256 257 #ifdef ACPI_FUTURE_USAGE 258 /* 259 * Debug input 260 */ 261 u32 acpi_os_get_line(char *buffer); 262 #endif 263 264 /* 265 * Directory manipulation 266 */ 267 void *acpi_os_open_directory(char *pathname, 268 char *wildcard_spec, char requested_file_type); 269 270 /* requeste_file_type values */ 271 272 #define REQUEST_FILE_ONLY 0 273 #define REQUEST_DIR_ONLY 1 274 275 char *acpi_os_get_next_filename(void *dir_handle); 276 277 void acpi_os_close_directory(void *dir_handle); 278 279 #endif /* __ACPIOSXF_H__ */ 280