xref: /illumos-gate/usr/src/uts/intel/sys/acpi/platform/aclinux.h (revision 22a84b8d79248a611e4ba663a268d3c4bed054ac)
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 - 2009, 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 #ifndef __ACLINUX_H__
117 #define __ACLINUX_H__
118 
119 /* Common (in-kernel/user-space) ACPICA configuration */
120 
121 #define ACPI_USE_SYSTEM_CLIBRARY
122 #define ACPI_USE_DO_WHILE_0
123 #define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
124 
125 
126 #ifdef __KERNEL__
127 
128 #include <linux/string.h>
129 #include <linux/kernel.h>
130 #include <linux/module.h>
131 #include <linux/ctype.h>
132 #include <linux/sched.h>
133 #include <asm/system.h>
134 #include <asm/atomic.h>
135 #include <asm/div64.h>
136 #include <asm/acpi.h>
137 #include <linux/slab.h>
138 #include <linux/spinlock_types.h>
139 #include <asm/current.h>
140 
141 /* Host-dependent types and defines for in-kernel ACPICA */
142 
143 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
144 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
145 #define strtoul                     simple_strtoul
146 
147 #define ACPI_CACHE_T                struct kmem_cache
148 #define ACPI_SPINLOCK               spinlock_t *
149 #define ACPI_CPU_FLAGS              unsigned long
150 #define ACPI_THREAD_ID              struct task_struct *
151 
152 #else /* !__KERNEL__ */
153 
154 #include <stdarg.h>
155 #include <string.h>
156 #include <stdlib.h>
157 #include <ctype.h>
158 #include <unistd.h>
159 
160 /* Host-dependent types and defines for user-space ACPICA */
161 
162 #define ACPI_FLUSH_CPU_CACHE()
163 #define ACPI_THREAD_ID              pthread_t
164 
165 #if defined(__ia64__) || defined(__x86_64__)
166 #define ACPI_MACHINE_WIDTH          64
167 #define COMPILER_DEPENDENT_INT64    long
168 #define COMPILER_DEPENDENT_UINT64   unsigned long
169 #else
170 #define ACPI_MACHINE_WIDTH          32
171 #define COMPILER_DEPENDENT_INT64    long long
172 #define COMPILER_DEPENDENT_UINT64   unsigned long long
173 #define ACPI_USE_NATIVE_DIVIDE
174 #endif
175 
176 #ifndef __cdecl
177 #define __cdecl
178 #endif
179 
180 #endif /* __KERNEL__ */
181 
182 /* Linux uses GCC */
183 
184 #include "acgcc.h"
185 
186 
187 #ifdef __KERNEL__
188 /*
189  * Overrides for in-kernel ACPICA
190  */
191 static inline acpi_thread_id acpi_os_get_thread_id(void)
192 {
193     return current;
194 }
195 
196 /*
197  * The irqs_disabled() check is for resume from RAM.
198  * Interrupts are off during resume, just like they are for boot.
199  * However, boot has  (system_state != SYSTEM_RUNNING)
200  * to quiet __might_sleep() in kmalloc() and resume does not.
201  */
202 #include <acpi/actypes.h>
203 static inline void *acpi_os_allocate(acpi_size size)
204 {
205     return kmalloc(size, irqs_disabled() ? GFP_ATOMIC : GFP_KERNEL);
206 }
207 
208 static inline void *acpi_os_allocate_zeroed(acpi_size size)
209 {
210     return kzalloc(size, irqs_disabled() ? GFP_ATOMIC : GFP_KERNEL);
211 }
212 
213 static inline void *acpi_os_acquire_object(acpi_cache_t * cache)
214 {
215     return kmem_cache_zalloc(cache,
216         irqs_disabled() ? GFP_ATOMIC : GFP_KERNEL);
217 }
218 
219 #define ACPI_ALLOCATE(a)        acpi_os_allocate(a)
220 #define ACPI_ALLOCATE_ZEROED(a) acpi_os_allocate_zeroed(a)
221 #define ACPI_FREE(a)            kfree(a)
222 
223 /* Used within ACPICA to show where it is safe to preempt execution */
224 
225 #define ACPI_PREEMPTION_POINT() \
226     do { \
227         if (!irqs_disabled()) \
228             cond_resched(); \
229     } while (0)
230 
231 #endif /* __KERNEL__ */
232 
233 #endif /* __ACLINUX_H__ */
234