xref: /openbmc/linux/include/acpi/platform/aclinux.h (revision 7e66b46b)
1 /******************************************************************************
2  *
3  * Name: aclinux.h - OS specific defines, etc. for Linux
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ACLINUX_H__
45 #define __ACLINUX_H__
46 
47 /* Common (in-kernel/user-space) ACPICA configuration */
48 
49 #define ACPI_USE_SYSTEM_CLIBRARY
50 #define ACPI_USE_DO_WHILE_0
51 #define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
52 
53 #ifdef __KERNEL__
54 
55 #include <linux/string.h>
56 #include <linux/kernel.h>
57 #include <linux/ctype.h>
58 #include <linux/sched.h>
59 #include <linux/atomic.h>
60 #include <linux/math64.h>
61 #include <linux/slab.h>
62 #include <linux/spinlock_types.h>
63 #ifdef EXPORT_ACPI_INTERFACES
64 #include <linux/export.h>
65 #endif
66 #include <asm/acpi.h>
67 
68 /* Host-dependent types and defines for in-kernel ACPICA */
69 
70 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
71 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
72 #define strtoul                     simple_strtoul
73 
74 #define acpi_cache_t                        struct kmem_cache
75 #define acpi_spinlock                       spinlock_t *
76 #define acpi_cpu_flags                      unsigned long
77 
78 #else				/* !__KERNEL__ */
79 
80 #include <stdarg.h>
81 #include <string.h>
82 #include <stdlib.h>
83 #include <ctype.h>
84 #include <unistd.h>
85 
86 /* Disable kernel specific declarators */
87 
88 #ifndef __init
89 #define __init
90 #endif
91 
92 #ifndef __iomem
93 #define __iomem
94 #endif
95 
96 /* Host-dependent types and defines for user-space ACPICA */
97 
98 #define ACPI_FLUSH_CPU_CACHE()
99 #define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
100 
101 #if defined(__ia64__) || defined(__x86_64__) || defined(__aarch64__)
102 #define ACPI_MACHINE_WIDTH          64
103 #define COMPILER_DEPENDENT_INT64    long
104 #define COMPILER_DEPENDENT_UINT64   unsigned long
105 #else
106 #define ACPI_MACHINE_WIDTH          32
107 #define COMPILER_DEPENDENT_INT64    long long
108 #define COMPILER_DEPENDENT_UINT64   unsigned long long
109 #define ACPI_USE_NATIVE_DIVIDE
110 #endif
111 
112 #ifndef __cdecl
113 #define __cdecl
114 #endif
115 
116 #endif				/* __KERNEL__ */
117 
118 /* Linux uses GCC */
119 
120 #include <acpi/platform/acgcc.h>
121 
122 #ifdef __KERNEL__
123 
124 /*
125  * FIXME: Inclusion of actypes.h
126  * Linux kernel need this before defining inline OSL interfaces as
127  * actypes.h need to be included to find ACPICA type definitions.
128  * Since from ACPICA's perspective, the actypes.h should be included after
129  * acenv.h (aclinux.h), this leads to a inclusion mis-ordering issue.
130  */
131 #include <acpi/actypes.h>
132 
133 /*
134  * Overrides for in-kernel ACPICA
135  */
136 acpi_status __init acpi_os_initialize(void);
137 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
138 
139 acpi_status acpi_os_terminate(void);
140 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
141 
142 /*
143  * Memory allocation/deallocation
144  */
145 
146 /*
147  * The irqs_disabled() check is for resume from RAM.
148  * Interrupts are off during resume, just like they are for boot.
149  * However, boot has  (system_state != SYSTEM_RUNNING)
150  * to quiet __might_sleep() in kmalloc() and resume does not.
151  */
152 static inline void *acpi_os_allocate(acpi_size size)
153 {
154 	return kmalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
155 }
156 
157 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
158 
159 /* Use native linux version of acpi_os_allocate_zeroed */
160 
161 static inline void *acpi_os_allocate_zeroed(acpi_size size)
162 {
163 	return kzalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
164 }
165 
166 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
167 #define USE_NATIVE_ALLOCATE_ZEROED
168 
169 static inline void acpi_os_free(void *memory)
170 {
171 	kfree(memory);
172 }
173 
174 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
175 
176 static inline void *acpi_os_acquire_object(acpi_cache_t * cache)
177 {
178 	return kmem_cache_zalloc(cache,
179 				 irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
180 }
181 
182 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
183 
184 static inline acpi_thread_id acpi_os_get_thread_id(void)
185 {
186 	return (acpi_thread_id) (unsigned long)current;
187 }
188 
189 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
190 
191 #ifndef CONFIG_PREEMPT
192 
193 /*
194  * Used within ACPICA to show where it is safe to preempt execution
195  * when CONFIG_PREEMPT=n
196  */
197 #define ACPI_PREEMPTION_POINT() \
198 	do { \
199 		if (!irqs_disabled()) \
200 			cond_resched(); \
201 	} while (0)
202 
203 #endif
204 
205 /*
206  * When lockdep is enabled, the spin_lock_init() macro stringifies it's
207  * argument and uses that as a name for the lock in debugging.
208  * By executing spin_lock_init() in a macro the key changes from "lock" for
209  * all locks to the name of the argument of acpi_os_create_lock(), which
210  * prevents lockdep from reporting false positives for ACPICA locks.
211  */
212 #define acpi_os_create_lock(__handle) \
213 	({ \
214 		spinlock_t *lock = ACPI_ALLOCATE(sizeof(*lock)); \
215 		if (lock) { \
216 			*(__handle) = lock; \
217 			spin_lock_init(*(__handle)); \
218 		} \
219 		lock ? AE_OK : AE_NO_MEMORY; \
220 	})
221 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
222 
223 void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_size length);
224 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
225 
226 void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
227 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
228 
229 /*
230  * OSL interfaces used by debugger/disassembler
231  */
232 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
233 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
234 
235 /*
236  * OSL interfaces used by utilities
237  */
238 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
239 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
240 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
241 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
242 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
243 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
244 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
245 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
246 
247 /*
248  * OSL interfaces added by Linux
249  */
250 void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
251 
252 #endif				/* __KERNEL__ */
253 
254 #endif				/* __ACLINUX_H__ */
255