1 /******************************************************************************
2  *
3  * Name: aclinux.h - OS specific defines, etc. for Linux
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2013, 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 
54 #ifdef __KERNEL__
55 
56 #include <linux/string.h>
57 #include <linux/kernel.h>
58 #include <linux/ctype.h>
59 #include <linux/sched.h>
60 #include <linux/atomic.h>
61 #include <linux/math64.h>
62 #include <linux/slab.h>
63 #include <linux/spinlock_types.h>
64 #ifdef EXPORT_ACPI_INTERFACES
65 #include <linux/export.h>
66 #endif
67 #include <asm/acpi.h>
68 
69 /* Host-dependent types and defines for in-kernel ACPICA */
70 
71 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
72 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
73 #define strtoul                     simple_strtoul
74 
75 #define ACPI_CACHE_T                struct kmem_cache
76 #define ACPI_SPINLOCK               spinlock_t *
77 #define ACPI_CPU_FLAGS              unsigned long
78 
79 #else /* !__KERNEL__ */
80 
81 #include <stdarg.h>
82 #include <string.h>
83 #include <stdlib.h>
84 #include <ctype.h>
85 #include <unistd.h>
86 
87 /* Host-dependent types and defines for user-space ACPICA */
88 
89 #define ACPI_FLUSH_CPU_CACHE()
90 #define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread))
91 
92 #if defined(__ia64__) || defined(__x86_64__) || defined(__aarch64__)
93 #define ACPI_MACHINE_WIDTH          64
94 #define COMPILER_DEPENDENT_INT64    long
95 #define COMPILER_DEPENDENT_UINT64   unsigned long
96 #else
97 #define ACPI_MACHINE_WIDTH          32
98 #define COMPILER_DEPENDENT_INT64    long long
99 #define COMPILER_DEPENDENT_UINT64   unsigned long long
100 #define ACPI_USE_NATIVE_DIVIDE
101 #endif
102 
103 #ifndef __cdecl
104 #define __cdecl
105 #endif
106 
107 #endif /* __KERNEL__ */
108 
109 /* Linux uses GCC */
110 
111 #include "acgcc.h"
112 
113 
114 #ifdef __KERNEL__
115 
116 /*
117  * FIXME: Inclusion of actypes.h
118  * Linux kernel need this before defining inline OSL interfaces as
119  * actypes.h need to be included to find ACPICA type definitions.
120  * Since from ACPICA's perspective, the actypes.h should be included after
121  * acenv.h (aclinux.h), this leads to a inclusion mis-ordering issue.
122  */
123 #include <acpi/actypes.h>
124 
125 /*
126  * Overrides for in-kernel ACPICA
127  */
128 ACPI_STATUS __init AcpiOsInitialize (
129     void);
130 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
131 
132 ACPI_STATUS AcpiOsTerminate (
133     void);
134 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
135 
136 /*
137  * Memory allocation/deallocation
138  */
139 
140 /*
141  * The irqs_disabled() check is for resume from RAM.
142  * Interrupts are off during resume, just like they are for boot.
143  * However, boot has  (system_state != SYSTEM_RUNNING)
144  * to quiet __might_sleep() in kmalloc() and resume does not.
145  */
146 static inline void *
147 AcpiOsAllocate (
148     ACPI_SIZE               Size)
149 {
150     return kmalloc (Size, irqs_disabled () ? GFP_ATOMIC : GFP_KERNEL);
151 }
152 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
153 
154 /* Use native linux version of AcpiOsAllocateZeroed */
155 
156 static inline void *
157 AcpiOsAllocateZeroed (
158     ACPI_SIZE               Size)
159 {
160     return kzalloc (Size, irqs_disabled () ? GFP_ATOMIC : GFP_KERNEL);
161 }
162 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
163 #define USE_NATIVE_ALLOCATE_ZEROED
164 
165 static inline void
166 AcpiOsFree (
167     void                   *Memory)
168 {
169     kfree (Memory);
170 }
171 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
172 
173 static inline void *
174 AcpiOsAcquireObject (
175     ACPI_CACHE_T           *Cache)
176 {
177     return kmem_cache_zalloc (Cache,
178         irqs_disabled () ? GFP_ATOMIC : GFP_KERNEL);
179 }
180 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
181 
182 static inline ACPI_THREAD_ID
183 AcpiOsGetThreadId (
184     void)
185 {
186     return (ACPI_THREAD_ID) (unsigned long) current;
187 }
188 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
189 
190 #ifndef CONFIG_PREEMPT
191 
192 /*
193  * Used within ACPICA to show where it is safe to preempt execution
194  * when CONFIG_PREEMPT=n
195  */
196 #define ACPI_PREEMPTION_POINT() \
197     do { \
198         if (!irqs_disabled()) \
199             cond_resched(); \
200     } while (0)
201 
202 #endif
203 
204 /*
205  * When lockdep is enabled, the spin_lock_init() macro stringifies it's
206  * argument and uses that as a name for the lock in debugging.
207  * By executing spin_lock_init() in a macro the key changes from "lock" for
208  * all locks to the name of the argument of acpi_os_create_lock(), which
209  * prevents lockdep from reporting false positives for ACPICA locks.
210  */
211 #define AcpiOsCreateLock(__Handle) \
212     ({ \
213         spinlock_t *Lock = ACPI_ALLOCATE(sizeof(*Lock)); \
214         if (Lock) { \
215             *(__Handle) = Lock; \
216             spin_lock_init(*(__Handle)); \
217         } \
218         Lock ? AE_OK : AE_NO_MEMORY; \
219     })
220 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
221 
222 void __iomem *
223 AcpiOsMapMemory (
224     ACPI_PHYSICAL_ADDRESS   Where,
225     ACPI_SIZE               Length);
226 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsMapMemory
227 
228 void
229 AcpiOsUnmapMemory (
230     void __iomem            *LogicalAddress,
231     ACPI_SIZE               Size);
232 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsUnmapMemory
233 
234 /*
235  * OSL interfaces used by debugger/disassembler
236  */
237 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
238 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
239 
240 /*
241  * OSL interfaces used by utilities
242  */
243 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
244 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetLine
245 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
246 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
247 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
248 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
249 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
250 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
251 
252 /*
253  * OSL interfaces added by Linux
254  */
255 void
256 EarlyAcpiOsUnmapMemory (
257     void __iomem            *Virt,
258     ACPI_SIZE               Size);
259 
260 ACPI_STATUS
261 AcpiOsHotplugExecute (
262     ACPI_OSD_EXEC_CALLBACK  Function,
263     void                    *Context);
264 
265 #endif /* __KERNEL__ */
266 
267 #endif /* __ACLINUX_H__ */
268