xref: /illumos-gate/usr/src/uts/intel/sys/acpi/platform/aclinux.h (revision 4c28a617e3922d92a58e813a5b955eb526b9c386)
1 /******************************************************************************
2  *
3  * Name: aclinux.h - OS specific defines, etc. for Linux
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2016, 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 #ifdef __KERNEL__
48 
49 /* ACPICA external files should not include ACPICA headers directly. */
50 
51 #if !defined(BUILDING_ACPICA) && !defined(_LINUX_ACPI_H)
52 #error "Please don't include <acpi/acpi.h> directly, include <linux/acpi.h> instead."
53 #endif
54 
55 #endif
56 
57 /* Common (in-kernel/user-space) ACPICA configuration */
58 
59 #define ACPI_USE_SYSTEM_CLIBRARY
60 #define ACPI_USE_DO_WHILE_0
61 
62 
63 #ifdef __KERNEL__
64 
65 #define ACPI_USE_SYSTEM_INTTYPES
66 
67 /* Kernel specific ACPICA configuration */
68 
69 #ifdef CONFIG_ACPI_REDUCED_HARDWARE_ONLY
70 #define ACPI_REDUCED_HARDWARE 1
71 #endif
72 
73 #ifdef CONFIG_ACPI_DEBUGGER
74 #define ACPI_DEBUGGER
75 #endif
76 
77 #include <linux/string.h>
78 #include <linux/kernel.h>
79 #include <linux/ctype.h>
80 #include <linux/sched.h>
81 #include <linux/atomic.h>
82 #include <linux/math64.h>
83 #include <linux/slab.h>
84 #include <linux/spinlock_types.h>
85 #ifdef EXPORT_ACPI_INTERFACES
86 #include <linux/export.h>
87 #endif
88 #ifdef CONFIG_ACPI
89 #include <asm/acenv.h>
90 #endif
91 
92 #ifndef CONFIG_ACPI
93 
94 /* External globals for __KERNEL__, stubs is needed */
95 
96 #define ACPI_GLOBAL(t,a)
97 #define ACPI_INIT_GLOBAL(t,a,b)
98 
99 /* Generating stubs for configurable ACPICA macros */
100 
101 #define ACPI_NO_MEM_ALLOCATIONS
102 
103 /* Generating stubs for configurable ACPICA functions */
104 
105 #define ACPI_NO_ERROR_MESSAGES
106 #undef ACPI_DEBUG_OUTPUT
107 
108 /* External interface for __KERNEL__, stub is needed */
109 
110 #define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \
111     static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
112 #define ACPI_EXTERNAL_RETURN_OK(Prototype) \
113     static ACPI_INLINE Prototype {return(AE_OK);}
114 #define ACPI_EXTERNAL_RETURN_VOID(Prototype) \
115     static ACPI_INLINE Prototype {return;}
116 #define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \
117     static ACPI_INLINE Prototype {return(0);}
118 #define ACPI_EXTERNAL_RETURN_PTR(Prototype) \
119     static ACPI_INLINE Prototype {return(NULL);}
120 
121 #endif /* CONFIG_ACPI */
122 
123 /* Host-dependent types and defines for in-kernel ACPICA */
124 
125 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
126 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
127 #define strtoul                     simple_strtoul
128 
129 #define ACPI_CACHE_T                struct kmem_cache
130 #define ACPI_SPINLOCK               spinlock_t *
131 #define ACPI_CPU_FLAGS              unsigned long
132 
133 /* Use native linux version of AcpiOsAllocateZeroed */
134 
135 #define USE_NATIVE_ALLOCATE_ZEROED
136 
137 /*
138  * Overrides for in-kernel ACPICA
139  */
140 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
141 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
142 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
143 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
144 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
145 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
146 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
147 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
148 
149 /*
150  * OSL interfaces used by debugger/disassembler
151  */
152 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
153 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
154 
155 /*
156  * OSL interfaces used by utilities
157  */
158 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
159 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
160 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
161 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
162 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
163 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
164 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
165 
166 #define ACPI_MSG_ERROR          KERN_ERR "ACPI Error: "
167 #define ACPI_MSG_EXCEPTION      KERN_ERR "ACPI Exception: "
168 #define ACPI_MSG_WARNING        KERN_WARNING "ACPI Warning: "
169 #define ACPI_MSG_INFO           KERN_INFO "ACPI: "
170 
171 #define ACPI_MSG_BIOS_ERROR     KERN_ERR "ACPI BIOS Error (bug): "
172 #define ACPI_MSG_BIOS_WARNING   KERN_WARNING "ACPI BIOS Warning (bug): "
173 
174 #else /* !__KERNEL__ */
175 
176 #include <stdarg.h>
177 #include <string.h>
178 #include <stdlib.h>
179 #include <ctype.h>
180 #include <unistd.h>
181 
182 /* Define/disable kernel-specific declarators */
183 
184 #ifndef __init
185 #define __init
186 #endif
187 
188 /* Host-dependent types and defines for user-space ACPICA */
189 
190 #define ACPI_FLUSH_CPU_CACHE()
191 #define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread))
192 
193 #if defined(__ia64__)    || defined(__x86_64__) ||\
194     defined(__aarch64__) || defined(__PPC64__)
195 #define ACPI_MACHINE_WIDTH          64
196 #define COMPILER_DEPENDENT_INT64    long
197 #define COMPILER_DEPENDENT_UINT64   unsigned long
198 #else
199 #define ACPI_MACHINE_WIDTH          32
200 #define COMPILER_DEPENDENT_INT64    long long
201 #define COMPILER_DEPENDENT_UINT64   unsigned long long
202 #define ACPI_USE_NATIVE_DIVIDE
203 #endif
204 
205 #ifndef __cdecl
206 #define __cdecl
207 #endif
208 
209 #endif /* __KERNEL__ */
210 
211 /* Linux uses GCC */
212 
213 #include "acgcc.h"
214 
215 #endif /* __ACLINUX_H__ */
216