1 /******************************************************************************
2 *
3 * Name: aclinuxex.h - Extra 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 __ACLINUXEX_H__
153 #define __ACLINUXEX_H__
154
155 #ifdef __KERNEL__
156
157 #ifndef ACPI_USE_NATIVE_DIVIDE
158
159 #ifndef ACPI_DIV_64_BY_32
160 #define ACPI_DIV_64_BY_32(n_hi, n_lo, d32, q32, r32) \
161 do { \
162 UINT64 (__n) = ((UINT64) n_hi) << 32 | (n_lo); \
163 (r32) = do_div ((__n), (d32)); \
164 (q32) = (UINT32) (__n); \
165 } while (0)
166 #endif
167
168 #ifndef ACPI_SHIFT_RIGHT_64
169 #define ACPI_SHIFT_RIGHT_64(n_hi, n_lo) \
170 do { \
171 (n_lo) >>= 1; \
172 (n_lo) |= (((n_hi) & 1) << 31); \
173 (n_hi) >>= 1; \
174 } while (0)
175 #endif
176
177 #endif
178
179 /*
180 * Overrides for in-kernel ACPICA
181 */
182 ACPI_STATUS ACPI_INIT_FUNCTION AcpiOsInitialize (
183 void);
184
185 ACPI_STATUS AcpiOsTerminate (
186 void);
187
188 /*
189 * The irqs_disabled() check is for resume from RAM.
190 * Interrupts are off during resume, just like they are for boot.
191 * However, boot has (system_state != SYSTEM_RUNNING)
192 * to quiet __might_sleep() in kmalloc() and resume does not.
193 */
194 static inline void *
AcpiOsAllocate(ACPI_SIZE Size)195 AcpiOsAllocate (
196 ACPI_SIZE Size)
197 {
198 return kmalloc (Size, irqs_disabled () ? GFP_ATOMIC : GFP_KERNEL);
199 }
200
201 static inline void *
AcpiOsAllocateZeroed(ACPI_SIZE Size)202 AcpiOsAllocateZeroed (
203 ACPI_SIZE Size)
204 {
205 return kzalloc (Size, irqs_disabled () ? GFP_ATOMIC : GFP_KERNEL);
206 }
207
208 static inline void
AcpiOsFree(void * Memory)209 AcpiOsFree (
210 void *Memory)
211 {
212 kfree (Memory);
213 }
214
215 static inline void *
AcpiOsAcquireObject(ACPI_CACHE_T * Cache)216 AcpiOsAcquireObject (
217 ACPI_CACHE_T *Cache)
218 {
219 return kmem_cache_zalloc (Cache,
220 irqs_disabled () ? GFP_ATOMIC : GFP_KERNEL);
221 }
222
223 static inline ACPI_THREAD_ID
AcpiOsGetThreadId(void)224 AcpiOsGetThreadId (
225 void)
226 {
227 return (ACPI_THREAD_ID) (unsigned long) current;
228 }
229
230 /*
231 * When lockdep is enabled, the spin_lock_init() macro stringifies it's
232 * argument and uses that as a name for the lock in debugging.
233 * By executing spin_lock_init() in a macro the key changes from "lock" for
234 * all locks to the name of the argument of acpi_os_create_lock(), which
235 * prevents lockdep from reporting false positives for ACPICA locks.
236 */
237 #define AcpiOsCreateLock(__Handle) \
238 ({ \
239 spinlock_t *Lock = ACPI_ALLOCATE(sizeof(*Lock)); \
240 if (Lock) { \
241 *(__Handle) = Lock; \
242 spin_lock_init(*(__Handle)); \
243 } \
244 Lock ? AE_OK : AE_NO_MEMORY; \
245 })
246
247 static inline BOOLEAN
AcpiOsReadable(void * Pointer,ACPI_SIZE Length)248 AcpiOsReadable (
249 void *Pointer,
250 ACPI_SIZE Length)
251 {
252 return TRUE;
253 }
254
255 static inline ACPI_STATUS
AcpiOsInitializeDebugger(void)256 AcpiOsInitializeDebugger (
257 void)
258 {
259 return AE_OK;
260 }
261
262 static inline void
AcpiOsTerminateDebugger(void)263 AcpiOsTerminateDebugger (
264 void)
265 {
266 return;
267 }
268
269
270 /*
271 * OSL interfaces added by Linux
272 */
273
274 #endif /* __KERNEL__ */
275
276 #endif /* __ACLINUXEX_H__ */
277