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