blob: 64b8c7639520d1e41e1439bc558d7a35424e25ef [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
Bob Mooreabf95c32012-10-31 02:27:04 +00003 * Name: acpiosxf.h - All interfaces to the OS Services Layer (OSL). These
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * interfaces must be implemented by OSL to interface the
5 * ACPI components to the host operating system.
6 *
7 *****************************************************************************/
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009/*
Bob Moore25f044e2013-01-25 05:38:56 +000010 * Copyright (C) 2000 - 2013, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
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.
27 *
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.
31 *
32 * NO WARRANTY
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.
44 */
45
46#ifndef __ACPIOSXF_H__
47#define __ACPIOSXF_H__
48
David Howellsa1ce3922012-10-02 18:01:25 +010049#include <acpi/platform/acenv.h>
50#include <acpi/actypes.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Bob Moore958dd242006-05-12 17:12:00 -040052/* Types for acpi_os_execute */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Bob Moore958dd242006-05-12 17:12:00 -040054typedef enum {
55 OSL_GLOBAL_LOCK_HANDLER,
56 OSL_NOTIFY_HANDLER,
57 OSL_GPE_HANDLER,
58 OSL_DEBUGGER_THREAD,
59 OSL_EC_POLL_HANDLER,
Bob Moore41195322006-05-26 16:36:00 -040060 OSL_EC_BURST_HANDLER
Bob Moore958dd242006-05-12 17:12:00 -040061} acpi_execute_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63#define ACPI_NO_UNIT_LIMIT ((u32) -1)
64#define ACPI_MUTEX_SEM 1
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/* Functions for acpi_os_signal */
67
68#define ACPI_SIGNAL_FATAL 0
69#define ACPI_SIGNAL_BREAKPOINT 1
70
Len Brown4be44fc2005-08-05 00:44:28 -040071struct acpi_signal_fatal_info {
72 u32 type;
73 u32 code;
74 u32 argument;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075};
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/*
78 * OSL Initialization and shutdown primitives
79 */
Jan-Simon Möller36200af2013-04-30 09:39:04 +000080acpi_status __init acpi_os_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Len Brown4be44fc2005-08-05 00:44:28 -040082acpi_status acpi_os_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84/*
85 * ACPI Table interfaces
86 */
Bob Mooref3d2e782007-02-02 19:48:18 +030087acpi_physical_address acpi_os_get_root_pointer(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040090acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
91 acpi_string * new_val);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040094acpi_os_table_override(struct acpi_table_header *existing_table,
95 struct acpi_table_header **new_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Bob Mooref7b004a2012-02-14 18:31:56 +080097acpi_status
98acpi_os_physical_table_override(struct acpi_table_header *existing_table,
99 acpi_physical_address * new_address,
100 u32 *new_table_length);
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102/*
Bob Moore967440e32006-06-23 17:04:00 -0400103 * Spinlock primitives
104 */
Rafael J. Wysocki07e49a72011-07-06 20:44:25 +0200105#ifndef acpi_os_create_lock
Lv Zheng3e8214e2012-12-19 05:37:15 +0000106acpi_status acpi_os_create_lock(acpi_spinlock * out_handle);
Rafael J. Wysocki07e49a72011-07-06 20:44:25 +0200107#endif
Lin Ming9f63b882011-03-23 17:26:34 +0800108
Bob Moore967440e32006-06-23 17:04:00 -0400109void acpi_os_delete_lock(acpi_spinlock handle);
110
111acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock handle);
112
113void acpi_os_release_lock(acpi_spinlock handle, acpi_cpu_flags flags);
114
115/*
116 * Semaphore primitives
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400119acpi_os_create_semaphore(u32 max_units,
Bob Moore967440e32006-06-23 17:04:00 -0400120 u32 initial_units, acpi_semaphore * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Bob Moore967440e32006-06-23 17:04:00 -0400122acpi_status acpi_os_delete_semaphore(acpi_semaphore handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Bob Moore967440e32006-06-23 17:04:00 -0400124acpi_status
125acpi_os_wait_semaphore(acpi_semaphore handle, u32 units, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Bob Moore967440e32006-06-23 17:04:00 -0400127acpi_status acpi_os_signal_semaphore(acpi_semaphore handle, u32 units);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Bob Moore967440e32006-06-23 17:04:00 -0400129/*
Bob Moore1685bd42008-12-31 03:03:29 +0800130 * Mutex primitives. May be configured to use semaphores instead via
131 * ACPI_MUTEX_TYPE (see platform/acenv.h)
Bob Moore967440e32006-06-23 17:04:00 -0400132 */
Bob Moore1685bd42008-12-31 03:03:29 +0800133#if (ACPI_MUTEX_TYPE != ACPI_BINARY_SEMAPHORE)
134
Bob Moore967440e32006-06-23 17:04:00 -0400135acpi_status acpi_os_create_mutex(acpi_mutex * out_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Bob Moore967440e32006-06-23 17:04:00 -0400137void acpi_os_delete_mutex(acpi_mutex handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Bob Moore967440e32006-06-23 17:04:00 -0400139acpi_status acpi_os_acquire_mutex(acpi_mutex handle, u16 timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Bob Moore967440e32006-06-23 17:04:00 -0400141void acpi_os_release_mutex(acpi_mutex handle);
Bob Moore1685bd42008-12-31 03:03:29 +0800142#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144/*
145 * Memory allocation and mapping
146 */
Len Brown4be44fc2005-08-05 00:44:28 -0400147void *acpi_os_allocate(acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Lv Zheng739dcbb2012-12-20 01:07:26 +0000149void acpi_os_free(void *memory);
150
Len Brownfd350942007-05-09 23:34:35 -0400151void __iomem *acpi_os_map_memory(acpi_physical_address where,
Bob Moore67a119f2008-06-10 13:42:13 +0800152 acpi_size length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Len Brown4be44fc2005-08-05 00:44:28 -0400154void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
Yinghai Lu7d972772009-02-07 15:39:41 -0800155void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157#ifdef ACPI_FUTURE_USAGE
158acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400159acpi_os_get_physical_address(void *logical_address,
160 acpi_physical_address * physical_address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#endif
162
Robert Moore73459f72005-06-24 00:00:00 -0400163/*
164 * Memory/Object Cache
165 */
166acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400167acpi_os_create_cache(char *cache_name,
168 u16 object_size,
169 u16 max_depth, acpi_cache_t ** return_cache);
Robert Moore73459f72005-06-24 00:00:00 -0400170
Len Brown4be44fc2005-08-05 00:44:28 -0400171acpi_status acpi_os_delete_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400172
Len Brown4be44fc2005-08-05 00:44:28 -0400173acpi_status acpi_os_purge_cache(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400174
Len Brown4be44fc2005-08-05 00:44:28 -0400175void *acpi_os_acquire_object(acpi_cache_t * cache);
Robert Moore73459f72005-06-24 00:00:00 -0400176
Len Brown4be44fc2005-08-05 00:44:28 -0400177acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object);
Robert Moore73459f72005-06-24 00:00:00 -0400178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179/*
180 * Interrupt handlers
181 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182acpi_status
Lv Zheng739dcbb2012-12-20 01:07:26 +0000183acpi_os_install_interrupt_handler(u32 interrupt_number,
Len Brown4be44fc2005-08-05 00:44:28 -0400184 acpi_osd_handler service_routine,
185 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187acpi_status
Lv Zheng739dcbb2012-12-20 01:07:26 +0000188acpi_os_remove_interrupt_handler(u32 interrupt_number,
189 acpi_osd_handler service_routine);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Len Brown5229e872008-02-06 01:26:55 -0500191void acpi_os_gpe_count(u32 gpe_number);
192void acpi_os_fixed_event_count(u32 fixed_event_number);
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194/*
195 * Threads and Scheduling
196 */
Bob Moore83135242006-10-03 00:00:00 -0400197acpi_thread_id acpi_os_get_thread_id(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199acpi_status
Bob Moore958dd242006-05-12 17:12:00 -0400200acpi_os_execute(acpi_execute_type type,
201 acpi_osd_exec_callback function, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Zhang Rui19cd8472008-08-28 10:05:06 +0800203acpi_status
204acpi_os_hotplug_execute(acpi_osd_exec_callback function, void *context);
205
Lin Mingbd6f10a2012-05-22 16:43:49 +0800206void acpi_os_wait_events_complete(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Bob Moore5df7e6c2010-01-21 10:06:32 +0800208void acpi_os_sleep(u64 milliseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Len Brown4be44fc2005-08-05 00:44:28 -0400210void acpi_os_stall(u32 microseconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212/*
213 * Platform and hardware-independent I/O interfaces
214 */
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_status acpi_os_read_port(acpi_io_address address, u32 * value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Len Brown4be44fc2005-08-05 00:44:28 -0400217acpi_status acpi_os_write_port(acpi_io_address address, u32 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219/*
220 * Platform and hardware-independent physical memory interfaces
221 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222acpi_status
Bob Moore653f4b52012-02-14 18:29:55 +0800223acpi_os_read_memory(acpi_physical_address address, u64 *value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225acpi_status
Bob Moore653f4b52012-02-14 18:29:55 +0800226acpi_os_write_memory(acpi_physical_address address, u64 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
228/*
229 * Platform and hardware-independent PCI configuration space access
230 * Note: Can't use "Register" as a parameter, changed to "Reg" --
231 * certain compilers complain.
232 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400234acpi_os_read_pci_configuration(struct acpi_pci_id *pci_id,
Bob Moorec5f02312010-08-06 08:57:53 +0800235 u32 reg, u64 *value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400238acpi_os_write_pci_configuration(struct acpi_pci_id *pci_id,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800239 u32 reg, u64 value, u32 width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 * Miscellaneous
243 */
Len Brown4be44fc2005-08-05 00:44:28 -0400244u64 acpi_os_get_timer(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Len Brown4be44fc2005-08-05 00:44:28 -0400246acpi_status acpi_os_signal(u32 function, void *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248/*
249 * Debug print routines
250 */
Len Brown4be44fc2005-08-05 00:44:28 -0400251void ACPI_INTERNAL_VAR_XFACE acpi_os_printf(const char *format, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Len Brown4be44fc2005-08-05 00:44:28 -0400253void acpi_os_vprintf(const char *format, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Len Brown4be44fc2005-08-05 00:44:28 -0400255void acpi_os_redirect_output(void *destination);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Robert Moore44f6c012005-04-18 22:49:35 -0400257#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258/*
259 * Debug input
260 */
Len Brown4be44fc2005-08-05 00:44:28 -0400261u32 acpi_os_get_line(char *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262#endif
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264/*
265 * Directory manipulation
266 */
Len Brown4be44fc2005-08-05 00:44:28 -0400267void *acpi_os_open_directory(char *pathname,
268 char *wildcard_spec, char requested_file_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270/* requeste_file_type values */
271
272#define REQUEST_FILE_ONLY 0
273#define REQUEST_DIR_ONLY 1
274
Len Brown4be44fc2005-08-05 00:44:28 -0400275char *acpi_os_get_next_filename(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Len Brown4be44fc2005-08-05 00:44:28 -0400277void acpi_os_close_directory(void *dir_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Len Brown4be44fc2005-08-05 00:44:28 -0400279#endif /* __ACPIOSXF_H__ */