blob: 970e9a6372c390d56b1dc67ed01df14a0508998e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070010/*
Bob Moore4a90c7e2006-01-13 16:22:00 -050011 * Copyright (C) 2000 - 2006, R. Byron Moore
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070053/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/* Functions for acpi_os_signal */
64
65#define ACPI_SIGNAL_FATAL 0
66#define ACPI_SIGNAL_BREAKPOINT 1
67
Len Brown4be44fc2005-08-05 00:44:28 -040068struct acpi_signal_fatal_info {
69 u32 type;
70 u32 code;
71 u32 argument;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074/*
75 * OSL Initialization and shutdown primitives
76 */
Len Brown4be44fc2005-08-05 00:44:28 -040077acpi_status acpi_os_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Len Brown4be44fc2005-08-05 00:44:28 -040079acpi_status acpi_os_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/*
82 * ACPI Table interfaces
83 */
Len Brown4be44fc2005-08-05 00:44:28 -040084acpi_status acpi_os_get_root_pointer(u32 flags, struct acpi_pointer *address);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040087acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
88 acpi_string * new_val);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040091acpi_os_table_override(struct acpi_table_header *existing_table,
92 struct acpi_table_header **new_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94/*
95 * Synchronization primitives
96 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040098acpi_os_create_semaphore(u32 max_units,
99 u32 initial_units, acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Len Brown4be44fc2005-08-05 00:44:28 -0400101acpi_status acpi_os_delete_semaphore(acpi_handle handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Len Brown4be44fc2005-08-05 00:44:28 -0400103acpi_status acpi_os_wait_semaphore(acpi_handle handle, u32 units, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Len Brown4be44fc2005-08-05 00:44:28 -0400105acpi_status acpi_os_signal_semaphore(acpi_handle handle, u32 units);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Len Brown4be44fc2005-08-05 00:44:28 -0400107acpi_status acpi_os_create_lock(acpi_handle * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Len Brown4be44fc2005-08-05 00:44:28 -0400109void acpi_os_delete_lock(acpi_handle handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Bob Mooreb8e4d892006-01-27 16:43:00 -0500111acpi_cpu_flags acpi_os_acquire_lock(acpi_handle handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Bob Mooreb8e4d892006-01-27 16:43:00 -0500113void acpi_os_release_lock(acpi_handle handle, acpi_cpu_flags flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115/*
116 * Memory allocation and mapping
117 */
Len Brown4be44fc2005-08-05 00:44:28 -0400118void *acpi_os_allocate(acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Len Brown4be44fc2005-08-05 00:44:28 -0400120void acpi_os_free(void *memory);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400123acpi_os_map_memory(acpi_physical_address physical_address,
124 acpi_size size, void __iomem ** logical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Len Brown4be44fc2005-08-05 00:44:28 -0400126void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128#ifdef ACPI_FUTURE_USAGE
129acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400130acpi_os_get_physical_address(void *logical_address,
131 acpi_physical_address * physical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132#endif
133
Robert Moore73459f72005-06-24 00:00:00 -0400134/*
135 * Memory/Object Cache
136 */
137acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400138acpi_os_create_cache(char *cache_name,
139 u16 object_size,
140 u16 max_depth, acpi_cache_t ** return_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400141
Len Brown4be44fc2005-08-05 00:44:28 -0400142acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400143
Len Brown4be44fc2005-08-05 00:44:28 -0400144acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400145
Len Brown4be44fc2005-08-05 00:44:28 -0400146void *acpi_os_acquire_object(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400147
Len Brown4be44fc2005-08-05 00:44:28 -0400148acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
Robert Moore73459f72005-06-24 00:00:00 -0400149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150/*
151 * Interrupt handlers
152 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400154acpi_os_install_interrupt_handler(u32 gsi,
155 acpi_osd_handler service_routine,
156 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400159acpi_os_remove_interrupt_handler(u32 gsi, acpi_osd_handler service_routine);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161/*
162 * Threads and Scheduling
163 */
Len Brown4be44fc2005-08-05 00:44:28 -0400164u32 acpi_os_get_thread_id(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400167acpi_os_queue_for_execution(u32 priority,
168 acpi_osd_exec_callback function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Len Brown4be44fc2005-08-05 00:44:28 -0400170void acpi_os_wait_events_complete(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Len Brown4be44fc2005-08-05 00:44:28 -0400172void acpi_os_wait_events_complete(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Len Brown4be44fc2005-08-05 00:44:28 -0400174void acpi_os_sleep(acpi_integer milliseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Len Brown4be44fc2005-08-05 00:44:28 -0400176void acpi_os_stall(u32 microseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178/*
179 * Platform and hardware-independent I/O interfaces
180 */
Len Brown4be44fc2005-08-05 00:44:28 -0400181acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Len Brown4be44fc2005-08-05 00:44:28 -0400183acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185/*
186 * Platform and hardware-independent physical memory interfaces
187 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400189acpi_os_read_memory(acpi_physical_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
191acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400192acpi_os_write_memory(acpi_physical_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400200acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
201 u32 reg, void *value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400204acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
205 u32 reg, acpi_integer value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207/*
208 * Interim function needed for PCI IRQ routing
209 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210void
Len Brown4be44fc2005-08-05 00:44:28 -0400211acpi_os_derive_pci_id(acpi_handle rhandle,
212 acpi_handle chandle, struct acpi_pci_id **pci_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214/*
215 * Miscellaneous
216 */
Len Brown4be44fc2005-08-05 00:44:28 -0400217u8 acpi_os_readable(void *pointer, acpi_size length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400220u8 acpi_os_writable(void *pointer, acpi_size length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221#endif
222
Len Brown4be44fc2005-08-05 00:44:28 -0400223u64 acpi_os_get_timer(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Len Brown4be44fc2005-08-05 00:44:28 -0400225acpi_status acpi_os_signal(u32 function, void *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227/*
228 * Debug print routines
229 */
Len Brown4be44fc2005-08-05 00:44:28 -0400230void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Len Brown4be44fc2005-08-05 00:44:28 -0400232void acpi_os_vprintf(const char *format, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Len Brown4be44fc2005-08-05 00:44:28 -0400234void acpi_os_redirect_output(void *destination);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Robert Moore44f6c012005-04-18 22:49:35 -0400236#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
238 * Debug input
239 */
Len Brown4be44fc2005-08-05 00:44:28 -0400240u32 acpi_os_get_line(char *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241#endif
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/*
244 * Directory manipulation
245 */
Len Brown4be44fc2005-08-05 00:44:28 -0400246void *acpi_os_open_directory(char *pathname,
247 char *wildcard_spec, char requested_file_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249/* requeste_file_type values */
250
251#define REQUEST_FILE_ONLY 0
252#define REQUEST_DIR_ONLY 1
253
Len Brown4be44fc2005-08-05 00:44:28 -0400254char *acpi_os_get_next_filename(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Len Brown4be44fc2005-08-05 00:44:28 -0400256void acpi_os_close_directory(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258/*
259 * Debug
260 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261void
Len Brown4be44fc2005-08-05 00:44:28 -0400262acpi_os_dbg_assert(void *failed_assertion,
263 void *file_name, u32 line_number, char *message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Len Brown4be44fc2005-08-05 00:44:28 -0400265#endif /* __ACPIOSXF_H__ */