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