xref: /openbmc/linux/include/acpi/platform/aclinux.h (revision 636fcfef)
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 #define ACPI_USE_SYSTEM_INTTYPES
56 
57 /* Compile for reduced hardware mode only with this kernel config */
58 
59 #ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
60 #define ACPI_REDUCED_HARDWARE 1
61 #endif
62 
63 #include <linux/string.h>
64 #include <linux/kernel.h>
65 #include <linux/ctype.h>
66 #include <linux/sched.h>
67 #include <linux/atomic.h>
68 #include <linux/math64.h>
69 #include <linux/slab.h>
70 #include <linux/spinlock_types.h>
71 #ifdef EXPORT_ACPI_INTERFACES
72 #include <linux/export.h>
73 #endif
74 #include <asm/acpi.h>
75 
76 #ifndef CONFIG_ACPI
77 
78 /* External globals for __KERNEL__, stubs is needed */
79 
80 #define ACPI_GLOBAL(t,a)
81 #define ACPI_INIT_GLOBAL(t,a,b)
82 
83 /* Generating stubs for configurable ACPICA macros */
84 
85 #define ACPI_NO_MEM_ALLOCATIONS
86 
87 /* Generating stubs for configurable ACPICA functions */
88 
89 #define ACPI_NO_ERROR_MESSAGES
90 #undef ACPI_DEBUG_OUTPUT
91 
92 /* External interface for __KERNEL__, stub is needed */
93 
94 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
95 	static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
96 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
97 	static ACPI_INLINE prototype {return(AE_OK);}
98 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
99 	static ACPI_INLINE prototype {return;}
100 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
101 	static ACPI_INLINE prototype {return(0);}
102 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
103 	static ACPI_INLINE prototype {return(NULL);}
104 
105 #endif				/* CONFIG_ACPI */
106 
107 /* Host-dependent types and defines for in-kernel ACPICA */
108 
109 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
110 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
111 #define strtoul                     simple_strtoul
112 
113 #define acpi_cache_t                        struct kmem_cache
114 #define acpi_spinlock                       spinlock_t *
115 #define acpi_cpu_flags                      unsigned long
116 
117 #else				/* !__KERNEL__ */
118 
119 #include <stdarg.h>
120 #include <string.h>
121 #include <stdlib.h>
122 #include <ctype.h>
123 #include <unistd.h>
124 
125 /* Define/disable kernel-specific declarators */
126 
127 #ifndef __init
128 #define __init
129 #endif
130 
131 #ifndef __iomem
132 #define __iomem
133 #endif
134 
135 /* Host-dependent types and defines for user-space ACPICA */
136 
137 #define ACPI_FLUSH_CPU_CACHE()
138 #define ACPI_CAST_PTHREAD_T(pthread) ((acpi_thread_id) (pthread))
139 
140 #if defined(__ia64__)    || defined(__x86_64__) ||\
141 	defined(__aarch64__) || defined(__PPC64__)
142 #define ACPI_MACHINE_WIDTH          64
143 #define COMPILER_DEPENDENT_INT64    long
144 #define COMPILER_DEPENDENT_UINT64   unsigned long
145 #else
146 #define ACPI_MACHINE_WIDTH          32
147 #define COMPILER_DEPENDENT_INT64    long long
148 #define COMPILER_DEPENDENT_UINT64   unsigned long long
149 #define ACPI_USE_NATIVE_DIVIDE
150 #endif
151 
152 #ifndef __cdecl
153 #define __cdecl
154 #endif
155 
156 #endif				/* __KERNEL__ */
157 
158 /* Linux uses GCC */
159 
160 #include <acpi/platform/acgcc.h>
161 
162 #ifdef __KERNEL__
163 
164 /*
165  * FIXME: Inclusion of actypes.h
166  * Linux kernel need this before defining inline OSL interfaces as
167  * actypes.h need to be included to find ACPICA type definitions.
168  * Since from ACPICA's perspective, the actypes.h should be included after
169  * acenv.h (aclinux.h), this leads to a inclusion mis-ordering issue.
170  */
171 #include <acpi/actypes.h>
172 
173 /*
174  * Overrides for in-kernel ACPICA
175  */
176 acpi_status __init acpi_os_initialize(void);
177 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_initialize
178 
179 acpi_status acpi_os_terminate(void);
180 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_terminate
181 
182 /*
183  * Memory allocation/deallocation
184  */
185 
186 /*
187  * The irqs_disabled() check is for resume from RAM.
188  * Interrupts are off during resume, just like they are for boot.
189  * However, boot has  (system_state != SYSTEM_RUNNING)
190  * to quiet __might_sleep() in kmalloc() and resume does not.
191  */
192 static inline void *acpi_os_allocate(acpi_size size)
193 {
194 	return kmalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
195 }
196 
197 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate
198 
199 /* Use native linux version of acpi_os_allocate_zeroed */
200 
201 static inline void *acpi_os_allocate_zeroed(acpi_size size)
202 {
203 	return kzalloc(size, irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
204 }
205 
206 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_allocate_zeroed
207 #define USE_NATIVE_ALLOCATE_ZEROED
208 
209 static inline void acpi_os_free(void *memory)
210 {
211 	kfree(memory);
212 }
213 
214 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_free
215 
216 static inline void *acpi_os_acquire_object(acpi_cache_t * cache)
217 {
218 	return kmem_cache_zalloc(cache,
219 				 irqs_disabled()? GFP_ATOMIC : GFP_KERNEL);
220 }
221 
222 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_acquire_object
223 
224 static inline acpi_thread_id acpi_os_get_thread_id(void)
225 {
226 	return (acpi_thread_id) (unsigned long)current;
227 }
228 
229 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_thread_id
230 
231 /*
232  * When lockdep is enabled, the spin_lock_init() macro stringifies it's
233  * argument and uses that as a name for the lock in debugging.
234  * By executing spin_lock_init() in a macro the key changes from "lock" for
235  * all locks to the name of the argument of acpi_os_create_lock(), which
236  * prevents lockdep from reporting false positives for ACPICA locks.
237  */
238 #define acpi_os_create_lock(__handle) \
239 	({ \
240 		spinlock_t *lock = ACPI_ALLOCATE(sizeof(*lock)); \
241 		if (lock) { \
242 			*(__handle) = lock; \
243 			spin_lock_init(*(__handle)); \
244 		} \
245 		lock ? AE_OK : AE_NO_MEMORY; \
246 	})
247 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_create_lock
248 
249 void __iomem *acpi_os_map_memory(acpi_physical_address where, acpi_size length);
250 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_map_memory
251 
252 void acpi_os_unmap_memory(void __iomem * logical_address, acpi_size size);
253 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_unmap_memory
254 
255 /*
256  * OSL interfaces used by debugger/disassembler
257  */
258 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_readable
259 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_writable
260 
261 /*
262  * OSL interfaces used by utilities
263  */
264 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_redirect_output
265 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_line
266 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_name
267 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_index
268 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_table_by_address
269 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_open_directory
270 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_get_next_filename
271 #define ACPI_USE_ALTERNATE_PROTOTYPE_acpi_os_close_directory
272 
273 /*
274  * OSL interfaces added by Linux
275  */
276 void early_acpi_os_unmap_memory(void __iomem * virt, acpi_size size);
277 
278 #endif				/* __KERNEL__ */
279 
280 #endif				/* __ACLINUX_H__ */
281