1 /******************************************************************************
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.
7 *****************************************************************************/
10 * Copyright (C) 2000 - 2013, Intel Corp.
11 * All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
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.
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.
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.
46 #ifndef __ACPIOSXF_H__
47 #define __ACPIOSXF_H__
49 #include <acpi/platform/acenv.h>
50 #include <acpi/actypes.h>
52 /* Types for acpi_os_execute */
55 OSL_GLOBAL_LOCK_HANDLER,
63 #define ACPI_NO_UNIT_LIMIT ((u32) -1)
64 #define ACPI_MUTEX_SEM 1
66 /* Functions for acpi_os_signal */
68 #define ACPI_SIGNAL_FATAL 0
69 #define ACPI_SIGNAL_BREAKPOINT 1
71 struct acpi_signal_fatal_info {
78 * OSL Initialization and shutdown primitives
80 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
81 acpi_status __init acpi_os_initialize(void);
84 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
85 acpi_status acpi_os_terminate(void);
89 * ACPI Table interfaces
91 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_root_pointer
92 acpi_physical_address acpi_os_get_root_pointer(void);
95 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_predefined_override
97 acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
98 acpi_string * new_val);
101 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_table_override
103 acpi_os_table_override(struct acpi_table_header *existing_table,
104 struct acpi_table_header **new_table);
107 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_physical_table_override
109 acpi_os_physical_table_override(struct acpi_table_header *existing_table,
110 acpi_physical_address * new_address,
111 u32 *new_table_length);
115 * Spinlock primitives
117 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
118 acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
121 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_lock
122 void acpi_os_delete_lock(acpi_spinlock handle);
125 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_lock
126 acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
129 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_lock
130 void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
134 * Semaphore primitives
136 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_semaphore
138 acpi_os_create_semaphore(u32 max_units,
139 u32 initial_units, acpi_semaphore * out_handle);
142 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_semaphore
143 acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
146 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_semaphore
148 acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
151 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal_semaphore
152 acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
156 * Mutex primitives. May be configured to use semaphores instead via
157 * ACPI_MUTEX_TYPE (see platform/acenv.h)
159 #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
161 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_mutex
162 acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
165 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_mutex
166 void acpi_os_delete_mutex(acpi_mutex handle);
169 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_mutex
170 acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
173 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_mutex
174 void acpi_os_release_mutex(acpi_mutex handle);
180 * Memory allocation and mapping
182 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
183 void *acpi_os_allocate(acpi_size size);
186 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
187 void *acpi_os_allocate_zeroed(acpi_size size);
190 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
191 void acpi_os_free(void *memory);
194 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
195 void __iomem *acpi_os_map_memory(acpi_physical_address where,
199 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
200 void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
202 void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
204 #ifdef ACPI_FUTURE_USAGE
205 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_physical_address
207 acpi_os_get_physical_address(void *logical_address,
208 acpi_physical_address * physical_address);
213 * Memory/Object Cache
215 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_cache
217 acpi_os_create_cache(char *cache_name,
219 u16 max_depth, acpi_cache_t ** return_cache);
222 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_delete_cache
223 acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
226 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_purge_cache
227 acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
230 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
231 void *acpi_os_acquire_object(acpi_cache_t * cache);
234 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_release_object
235 acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
241 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_install_interrupt_handler
243 acpi_os_install_interrupt_handler(u32 interrupt_number,
244 acpi_osd_handler service_routine,
248 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_remove_interrupt_handler
250 acpi_os_remove_interrupt_handler(u32 interrupt_number,
251 acpi_osd_handler service_routine);
254 void acpi_os_gpe_count(u32 gpe_number);
255 void acpi_os_fixed_event_count(u32 fixed_event_number);
258 * Threads and Scheduling
260 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
261 acpi_thread_id acpi_os_get_thread_id(void);
264 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_execute
266 acpi_os_execute(acpi_execute_type type,
267 acpi_osd_exec_callback function, void *context);
271 acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context);
273 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_wait_events_complete
274 void acpi_os_wait_events_complete(void);
277 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_sleep
278 void acpi_os_sleep(u64 milliseconds);
281 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_stall
282 void acpi_os_stall(u32 microseconds);
286 * Platform and hardware-independent I/O interfaces
288 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_port
289 acpi_status acpi_os_read_port(acpi_io_address address, u32 *value, u32 width);
292 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_port
293 acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
297 * Platform and hardware-independent physical memory interfaces
299 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_memory
301 acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width);
304 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_memory
306 acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width);
310 * Platform and hardware-independent PCI configuration space access
311 * Note: Can't use "Register" as a parameter, changed to "Reg" --
312 * certain compilers complain.
314 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_read_pci_configuration
316 acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
317 u32 reg, u64 *value, u32 width);
320 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_write_pci_configuration
322 acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
323 u32 reg, u64 value, u32 width);
329 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
330 u8 acpi_os_readable(void *pointer, acpi_size length);
333 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
334 u8 acpi_os_writable(void *pointer, acpi_size length);
337 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_timer
338 u64 acpi_os_get_timer(void);
341 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_signal
342 acpi_status acpi_os_signal(u32 function, void *info);
346 * Debug print routines
348 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_printf
349 void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
352 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_vprintf
353 void acpi_os_vprintf(const char *format, va_list args);
356 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
357 void acpi_os_redirect_output(void *destination);
360 #ifdef ACPI_FUTURE_USAGE
364 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
365 acpi_status acpi_os_get_line(char *buffer, u32 buffer_length, u32 *bytes_read);
370 * Obtain ACPI table(s)
372 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
374 acpi_os_get_table_by_name(char *signature,
376 struct acpi_table_header **table,
377 acpi_physical_address * address);
380 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
382 acpi_os_get_table_by_index(u32 index,
383 struct acpi_table_header **table,
384 u32 *instance, acpi_physical_address * address);
387 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
389 acpi_os_get_table_by_address(acpi_physical_address address,
390 struct acpi_table_header **table);
394 * Directory manipulation
396 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
397 void *acpi_os_open_directory(char *pathname,
398 char *wildcard_spec, char requested_file_type);
401 /* requeste_file_type values */
403 #define REQUEST_FILE_ONLY 0
404 #define REQUEST_DIR_ONLY 1
406 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
407 char *acpi_os_get_next_filename(void *dir_handle);
410 #ifndef ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
411 void acpi_os_close_directory(void *dir_handle);
414 #endif /* __ACPIOSXF_H__ */