2 /******************************************************************************
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.
8 *****************************************************************************/
11 * Copyright (C) 2000 - 2011, Intel Corp.
12 * All rights reserved.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
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.
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.
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.
47 #ifndef __ACPIOSXF_H__
48 #define __ACPIOSXF_H__
50 #include "platform/acenv.h"
53 /* Types for acpi_os_execute */
56 OSL_GLOBAL_LOCK_HANDLER
,
64 #define ACPI_NO_UNIT_LIMIT ((u32) -1)
65 #define ACPI_MUTEX_SEM 1
67 /* Functions for acpi_os_signal */
69 #define ACPI_SIGNAL_FATAL 0
70 #define ACPI_SIGNAL_BREAKPOINT 1
72 struct acpi_signal_fatal_info
{
79 * OSL Initialization and shutdown primitives
81 acpi_status __initdata
acpi_os_initialize(void);
83 acpi_status
acpi_os_terminate(void);
86 * ACPI Table interfaces
88 acpi_physical_address
acpi_os_get_root_pointer(void);
91 acpi_os_predefined_override(const struct acpi_predefined_names
*init_val
,
92 acpi_string
* new_val
);
95 acpi_os_table_override(struct acpi_table_header
*existing_table
,
96 struct acpi_table_header
**new_table
);
102 #ifndef acpi_os_create_lock
104 acpi_os_create_lock(acpi_spinlock
*out_handle
);
107 void acpi_os_delete_lock(acpi_spinlock handle
);
109 acpi_cpu_flags
acpi_os_acquire_lock(acpi_spinlock handle
);
111 void acpi_os_release_lock(acpi_spinlock handle
, acpi_cpu_flags flags
);
114 * Semaphore primitives
117 acpi_os_create_semaphore(u32 max_units
,
118 u32 initial_units
, acpi_semaphore
* out_handle
);
120 acpi_status
acpi_os_delete_semaphore(acpi_semaphore handle
);
123 acpi_os_wait_semaphore(acpi_semaphore handle
, u32 units
, u16 timeout
);
125 acpi_status
acpi_os_signal_semaphore(acpi_semaphore handle
, u32 units
);
128 * Mutex primitives. May be configured to use semaphores instead via
129 * ACPI_MUTEX_TYPE (see platform/acenv.h)
131 #if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
133 acpi_status
acpi_os_create_mutex(acpi_mutex
* out_handle
);
135 void acpi_os_delete_mutex(acpi_mutex handle
);
137 acpi_status
acpi_os_acquire_mutex(acpi_mutex handle
, u16 timeout
);
139 void acpi_os_release_mutex(acpi_mutex handle
);
143 * Memory allocation and mapping
145 void *acpi_os_allocate(acpi_size size
);
147 void __iomem
*acpi_os_map_memory(acpi_physical_address where
,
150 void acpi_os_unmap_memory(void __iomem
* logical_address
, acpi_size size
);
151 void early_acpi_os_unmap_memory(void __iomem
* virt
, acpi_size size
);
153 #ifdef ACPI_FUTURE_USAGE
155 acpi_os_get_physical_address(void *logical_address
,
156 acpi_physical_address
* physical_address
);
160 * Memory/Object Cache
163 acpi_os_create_cache(char *cache_name
,
165 u16 max_depth
, acpi_cache_t
** return_cache
);
167 acpi_status
acpi_os_delete_cache(acpi_cache_t
* cache
);
169 acpi_status
acpi_os_purge_cache(acpi_cache_t
* cache
);
171 void *acpi_os_acquire_object(acpi_cache_t
* cache
);
173 acpi_status
acpi_os_release_object(acpi_cache_t
* cache
, void *object
);
179 acpi_os_install_interrupt_handler(u32 gsi
,
180 acpi_osd_handler service_routine
,
184 acpi_os_remove_interrupt_handler(u32 gsi
, acpi_osd_handler service_routine
);
186 void acpi_os_gpe_count(u32 gpe_number
);
187 void acpi_os_fixed_event_count(u32 fixed_event_number
);
190 * Threads and Scheduling
192 extern struct workqueue_struct
*kacpi_hotplug_wq
;
194 acpi_thread_id
acpi_os_get_thread_id(void);
197 acpi_os_execute(acpi_execute_type type
,
198 acpi_osd_exec_callback function
, void *context
);
201 acpi_os_hotplug_execute(acpi_osd_exec_callback function
, void *context
);
203 void acpi_os_wait_events_complete(void *context
);
205 void acpi_os_sleep(u64 milliseconds
);
207 void acpi_os_stall(u32 microseconds
);
210 * Platform and hardware-independent I/O interfaces
212 acpi_status
acpi_os_read_port(acpi_io_address address
, u32
* value
, u32 width
);
214 acpi_status
acpi_os_write_port(acpi_io_address address
, u32 value
, u32 width
);
217 * Platform and hardware-independent physical memory interfaces
220 acpi_os_read_memory(acpi_physical_address address
, u32
* value
, u32 width
);
223 acpi_os_write_memory(acpi_physical_address address
, u32 value
, u32 width
);
226 * Platform and hardware-independent PCI configuration space access
227 * Note: Can't use "Register" as a parameter, changed to "Reg" --
228 * certain compilers complain.
231 acpi_os_read_pci_configuration(struct acpi_pci_id
*pci_id
,
232 u32 reg
, u64
*value
, u32 width
);
235 acpi_os_write_pci_configuration(struct acpi_pci_id
*pci_id
,
236 u32 reg
, u64 value
, u32 width
);
241 u64
acpi_os_get_timer(void);
243 acpi_status
acpi_os_signal(u32 function
, void *info
);
246 * Debug print routines
248 void ACPI_INTERNAL_VAR_XFACE
acpi_os_printf(const char *format
, ...);
250 void acpi_os_vprintf(const char *format
, va_list args
);
252 void acpi_os_redirect_output(void *destination
);
254 #ifdef ACPI_FUTURE_USAGE
258 u32
acpi_os_get_line(char *buffer
);
262 * Directory manipulation
264 void *acpi_os_open_directory(char *pathname
,
265 char *wildcard_spec
, char requested_file_type
);
267 /* requeste_file_type values */
269 #define REQUEST_FILE_ONLY 0
270 #define REQUEST_DIR_ONLY 1
272 char *acpi_os_get_next_filename(void *dir_handle
);
274 void acpi_os_close_directory(void *dir_handle
);
276 #endif /* __ACPIOSXF_H__ */