xref: /netbsd-src/sys/external/bsd/acpica/dist/include/platform/aclinux.h (revision 796c32c94f6e154afc9de0f63da35c91bb739b45)
1 /******************************************************************************
2  *
3  * Name: aclinux.h - OS specific defines, etc. for Linux
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2017, 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 #ifdef CONFIG_ACPI_DEBUG
78 #define ACPI_MUTEX_DEBUG
79 #endif
80 
81 #include <linux/string.h>
82 #include <linux/kernel.h>
83 #include <linux/ctype.h>
84 #include <linux/sched.h>
85 #include <linux/atomic.h>
86 #include <linux/math64.h>
87 #include <linux/slab.h>
88 #include <linux/spinlock_types.h>
89 #ifdef EXPORT_ACPI_INTERFACES
90 #include <linux/export.h>
91 #endif
92 #ifdef CONFIG_ACPI
93 #include <asm/acenv.h>
94 #endif
95 
96 #define ACPI_INIT_FUNCTION __init
97 
98 #ifndef CONFIG_ACPI
99 
100 /* External globals for __KERNEL__, stubs is needed */
101 
102 #define ACPI_GLOBAL(t,a)
103 #define ACPI_INIT_GLOBAL(t,a,b)
104 
105 /* Generating stubs for configurable ACPICA macros */
106 
107 #define ACPI_NO_MEM_ALLOCATIONS
108 
109 /* Generating stubs for configurable ACPICA functions */
110 
111 #define ACPI_NO_ERROR_MESSAGES
112 #undef ACPI_DEBUG_OUTPUT
113 
114 /* External interface for __KERNEL__, stub is needed */
115 
116 #define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \
117     static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
118 #define ACPI_EXTERNAL_RETURN_OK(Prototype) \
119     static ACPI_INLINE Prototype {return(AE_OK);}
120 #define ACPI_EXTERNAL_RETURN_VOID(Prototype) \
121     static ACPI_INLINE Prototype {return;}
122 #define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \
123     static ACPI_INLINE Prototype {return(0);}
124 #define ACPI_EXTERNAL_RETURN_PTR(Prototype) \
125     static ACPI_INLINE Prototype {return(NULL);}
126 
127 #endif /* CONFIG_ACPI */
128 
129 /* Host-dependent types and defines for in-kernel ACPICA */
130 
131 #define ACPI_MACHINE_WIDTH          BITS_PER_LONG
132 #define ACPI_USE_NATIVE_MATH64
133 #define ACPI_EXPORT_SYMBOL(symbol)  EXPORT_SYMBOL(symbol);
134 #define strtoul                     simple_strtoul
135 
136 #define ACPI_CACHE_T                struct kmem_cache
137 #define ACPI_SPINLOCK               spinlock_t *
138 #define ACPI_CPU_FLAGS              unsigned long
139 
140 /* Use native linux version of AcpiOsAllocateZeroed */
141 
142 #define USE_NATIVE_ALLOCATE_ZEROED
143 
144 /*
145  * Overrides for in-kernel ACPICA
146  */
147 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitialize
148 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminate
149 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocate
150 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAllocateZeroed
151 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsFree
152 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsAcquireObject
153 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetThreadId
154 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCreateLock
155 
156 /*
157  * OSL interfaces used by debugger/disassembler
158  */
159 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsReadable
160 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsWritable
161 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsInitializeDebugger
162 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsTerminateDebugger
163 
164 /*
165  * OSL interfaces used by utilities
166  */
167 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsRedirectOutput
168 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByName
169 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByIndex
170 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetTableByAddress
171 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsOpenDirectory
172 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsGetNextFilename
173 #define ACPI_USE_ALTERNATE_PROTOTYPE_AcpiOsCloseDirectory
174 
175 #define ACPI_MSG_ERROR          KERN_ERR "ACPI Error: "
176 #define ACPI_MSG_EXCEPTION      KERN_ERR "ACPI Exception: "
177 #define ACPI_MSG_WARNING        KERN_WARNING "ACPI Warning: "
178 #define ACPI_MSG_INFO           KERN_INFO "ACPI: "
179 
180 #define ACPI_MSG_BIOS_ERROR     KERN_ERR "ACPI BIOS Error (bug): "
181 #define ACPI_MSG_BIOS_WARNING   KERN_WARNING "ACPI BIOS Warning (bug): "
182 
183 /*
184  * Linux wants to use designated initializers for function pointer structs.
185  */
186 #define ACPI_STRUCT_INIT(field, value)  .field = value
187 
188 #else /* !__KERNEL__ */
189 
190 #define ACPI_USE_STANDARD_HEADERS
191 
192 #ifdef ACPI_USE_STANDARD_HEADERS
193 #include <unistd.h>
194 #endif
195 
196 /* Define/disable kernel-specific declarators */
197 
198 #ifndef __init
199 #define __init
200 #endif
201 #ifndef __iomem
202 #define __iomem
203 #endif
204 
205 /* Host-dependent types and defines for user-space ACPICA */
206 
207 #define ACPI_FLUSH_CPU_CACHE()
208 #define ACPI_CAST_PTHREAD_T(Pthread) ((ACPI_THREAD_ID) (Pthread))
209 
210 #if defined(__ia64__)    || defined(__x86_64__) ||\
211     defined(__aarch64__) || defined(__PPC64__) ||\
212     defined(__s390x__)
213 #define ACPI_MACHINE_WIDTH          64
214 #define COMPILER_DEPENDENT_INT64    long
215 #define COMPILER_DEPENDENT_UINT64   unsigned long
216 #else
217 #define ACPI_MACHINE_WIDTH          32
218 #define COMPILER_DEPENDENT_INT64    long long
219 #define COMPILER_DEPENDENT_UINT64   unsigned long long
220 #define ACPI_USE_NATIVE_DIVIDE
221 #define ACPI_USE_NATIVE_MATH64
222 #endif
223 
224 #ifndef __cdecl
225 #define __cdecl
226 #endif
227 
228 #endif /* __KERNEL__ */
229 
230 #endif /* __ACLINUX_H__ */
231