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