1 /******************************************************************************
2  *
3  * Name: aclinux.h - OS specific defines, etc. for Linux
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ACLINUX_H__
153 #define __ACLINUX_H__
154 
155 #ifdef __KERNEL__
156 
157 /* ACPICA external files should not include ACPICA headers directly. */
158 
159 #if !defined(BUILDING_ACPICA) && !defined(_LINUX_ACPI_H)
160 #error "Please don't include <acpi/acpi.h> directly, include <linux/acpi.h> instead."
161 #endif
162 
163 #endif
164 
165 /* Common (in-kernel/user-space) ACPICA configuration */
166 
167 #define ACPI_USE_SYSTEM_CLIBRARY
168 #define ACPI_USE_DO_WHILE_0
169 #define ACPI_IGNORE_PACKAGE_RESOLUTION_ERRORS
170 
171 
172 #ifdef __KERNEL__
173 
174 #define ACPI_USE_SYSTEM_INTTYPES
175 #define ACPI_USE_GPE_POLLING
176 
177 /* Kernel specific ACPICA configuration */
178 
179 #ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
180 #define ACPI_REDUCED_HARDWARE 1
181 #endif
182 
183 #ifdef CONFIG_ACPI_DEBUGGER
184 #define ACPI_DEBUGGER
185 #endif
186 
187 #ifdef CONFIG_ACPI_DEBUG
188 #define ACPI_MUTEX_DEBUG
189 #endif
190 
191 #include <linux/string.h>
192 #include <linux/kernel.h>
193 #include <linux/ctype.h>
194 #include <linux/sched.h>
195 #include <linux/atomic.h>
196 #include <linux/math64.h>
197 #include <linux/slab.h>
198 #include <linux/spinlock_types.h>
199 #ifdef EXPORT_ACPI_INTERFACES
200 #include <linux/export.h>
201 #endif
202 #ifdef CONFIG_ACPI
203 #include <asm/acenv.h>
204 #endif
205 
206 #define ACPI_INIT_FUNCTION __init
207 
208 #ifndef CONFIG_ACPI
209 
210 /* External globals for __KERNEL__, stubs is needed */
211 
212 #define ACPI_GLOBAL(t,a)
213 #define ACPI_INIT_GLOBAL(t,a,b)
214 
215 /* Generating stubs for configurable ACPICA macros */
216 
217 #define ACPI_NO_MEM_ALLOCATIONS
218 
219 /* Generating stubs for configurable ACPICA functions */
220 
221 #define ACPI_NO_ERROR_MESSAGES
222 #undef ACPI_DEBUG_OUTPUT
223 
224 /* External interface for __KERNEL__, stub is needed */
225 
226 #define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \
227     static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
228 #define ACPI_EXTERNAL_RETURN_OK(Prototype) \
229     static ACPI_INLINE Prototype {return(AE_OK);}
230 #define ACPI_EXTERNAL_RETURN_VOID(Prototype) \
231     static ACPI_INLINE Prototype {return;}
232 #define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \
233     static ACPI_INLINE Prototype {return(0);}
234 #define ACPI_EXTERNAL_RETURN_PTR(Prototype) \
235     static ACPI_INLINE Prototype {return(NULL);}
236 
237 #endif /* CONFIG_ACPI */
238 
239 /* Host-dependent types and defines for in-kernel ACPICA */
240 
241 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
242 #define ACPI_USE_NATIVE_MATH64
243 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
244 #define strtoul                     simple_strtoul
245 
246 #define ACPI_CACHE_T                struct kmem_cache
247 #define ACPI_SPINLOCK               spinlock_t *
248 #define ACPI_CPU_FLAGS              unsigned long
249 
250 /* Use native linux version of AcpiOsAllocateZeroed */
251 
252 #define USE_NATIVE_ALLOCATE_ZEROED
253 
254 /*
255  * Overrides for in-kernel ACPICA
256  */
257 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
258 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
259 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
260 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
261 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
262 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
263 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
264 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
265 
266 /*
267  * OSL interfaces used by debugger/disassembler
268  */
269 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
270 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
271 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitializeDebugger
272 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminateDebugger
273 
274 /*
275  * OSL interfaces used by utilities
276  */
277 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
278 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
279 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
280 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
281 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
282 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
283 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
284 
285 #define ACPI_MSG_ERROR          KERN_ERR "ACPI Error: "
286 #define ACPI_MSG_EXCEPTION      KERN_ERR "ACPI Exception: "
287 #define ACPI_MSG_WARNING        KERN_WARNING "ACPI Warning: "
288 #define ACPI_MSG_INFO           KERN_INFO "ACPI: "
289 
290 #define ACPI_MSG_BIOS_ERROR     KERN_ERR "ACPI BIOS Error (bug): "
291 #define ACPI_MSG_BIOS_WARNING   KERN_WARNING "ACPI BIOS Warning (bug): "
292 
293 /*
294  * Linux wants to use designated initializers for function pointer structs.
295  */
296 #define ACPI_STRUCT_INIT(field, value)  .field = value
297 
298 #else /* !__KERNEL__ */
299 
300 #define ACPI_USE_STANDARD_HEADERS
301 
302 #ifdef ACPI_USE_STANDARD_HEADERS
303 #include <unistd.h>
304 #endif
305 
306 /* Define/disable kernel-specific declarators */
307 
308 #ifndef __init
309 #define __init
310 #endif
311 #ifndef __iomem
312 #define __iomem
313 #endif
314 
315 /* Host-dependent types and defines for user-space ACPICA */
316 
317 #define ACPI_FLUSH_CPU_CACHE()
318 #define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread))
319 
320 #if defined(__ia64__)    || (defined(__x86_64__) && !defined(__ILP32__)) ||\
321     defined(__aarch64__) || defined(__PPC64__) ||\
322     defined(__s390x__)
323 #define ACPI_MACHINE_WIDTH          64
324 #define COMPILER_DEPENDENT_INT64    long
325 #define COMPILER_DEPENDENT_UINT64   unsigned long
326 #else
327 #define ACPI_MACHINE_WIDTH          32
328 #define COMPILER_DEPENDENT_INT64    long long
329 #define COMPILER_DEPENDENT_UINT64   unsigned long long
330 #define ACPI_USE_NATIVE_DIVIDE
331 #define ACPI_USE_NATIVE_MATH64
332 #endif
333 
334 #ifndef __cdecl
335 #define __cdecl
336 #endif
337 
338 #endif /* __KERNEL__ */
339 
340 #endif /* __ACLINUX_H__ */
341