[ACPICA]
[reactos.git] / reactos / drivers / bus / acpi / acpica / include / platform / acenv.h
1 /******************************************************************************
2 *
3 * Name: acenv.h - Host and compiler configuration
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 __ACENV_H__
45 #define __ACENV_H__
46
47 /*
48 * Environment configuration. The purpose of this file is to interface ACPICA
49 * to the local environment. This includes compiler-specific, OS-specific,
50 * and machine-specific configuration.
51 */
52
53 /* Types for ACPI_MUTEX_TYPE */
54
55 #define ACPI_BINARY_SEMAPHORE 0
56 #define ACPI_OSL_MUTEX 1
57
58 /* Types for DEBUGGER_THREADING */
59
60 #define DEBUGGER_SINGLE_THREADED 0
61 #define DEBUGGER_MULTI_THREADED 1
62
63
64 /******************************************************************************
65 *
66 * Configuration for ACPI tools and utilities
67 *
68 *****************************************************************************/
69
70 /* Common application configuration. All single threaded except for AcpiExec. */
71
72 #if (defined ACPI_ASL_COMPILER) || \
73 (defined ACPI_BIN_APP) || \
74 (defined ACPI_DUMP_APP) || \
75 (defined ACPI_HELP_APP) || \
76 (defined ACPI_NAMES_APP) || \
77 (defined ACPI_SRC_APP) || \
78 (defined ACPI_XTRACT_APP) || \
79 (defined ACPI_EXAMPLE_APP) || \
80 (defined ACPI_EFI_HELLO)
81 #define ACPI_APPLICATION
82 #define ACPI_SINGLE_THREADED
83 #define USE_NATIVE_ALLOCATE_ZEROED
84 #endif
85
86 /* iASL configuration */
87
88 #ifdef ACPI_ASL_COMPILER
89 #define ACPI_DEBUG_OUTPUT
90 #define ACPI_CONSTANT_EVAL_ONLY
91 #define ACPI_LARGE_NAMESPACE_NODE
92 #define ACPI_DATA_TABLE_DISASSEMBLY
93 #define ACPI_32BIT_PHYSICAL_ADDRESS
94 #define ACPI_DISASSEMBLER 1
95 #endif
96
97 /* AcpiExec configuration. Multithreaded with full AML debugger */
98
99 #ifdef ACPI_EXEC_APP
100 #define ACPI_APPLICATION
101 #define ACPI_FULL_DEBUG
102 #define ACPI_MUTEX_DEBUG
103 #define ACPI_DBG_TRACK_ALLOCATIONS
104 #endif
105
106 /* AcpiHelp configuration. Error messages disabled. */
107
108 #ifdef ACPI_HELP_APP
109 #define ACPI_NO_ERROR_MESSAGES
110 #endif
111
112 /* AcpiNames configuration. Debug output enabled. */
113
114 #ifdef ACPI_NAMES_APP
115 #define ACPI_DEBUG_OUTPUT
116 #endif
117
118 /* AcpiExec/AcpiNames/Example configuration. Native RSDP used. */
119
120 #if (defined ACPI_EXEC_APP) || \
121 (defined ACPI_EXAMPLE_APP) || \
122 (defined ACPI_NAMES_APP)
123 #define ACPI_USE_NATIVE_RSDP_POINTER
124 #endif
125
126 /* AcpiDump configuration. Native mapping used if provided by the host */
127
128 #ifdef ACPI_DUMP_APP
129 #define ACPI_USE_NATIVE_MEMORY_MAPPING
130 #endif
131
132 /* AcpiNames/Example configuration. Hardware disabled */
133
134 #if (defined ACPI_EXAMPLE_APP) || \
135 (defined ACPI_NAMES_APP)
136 #define ACPI_REDUCED_HARDWARE 1
137 #endif
138
139 /* Linkable ACPICA library. Two versions, one with full debug. */
140
141 #ifdef ACPI_LIBRARY
142 #define ACPI_USE_LOCAL_CACHE
143 #define ACPI_DEBUGGER 1
144 #define ACPI_DISASSEMBLER 1
145
146 #ifdef _DEBUG
147 #define ACPI_DEBUG_OUTPUT
148 #endif
149 #endif
150
151 /* Common for all ACPICA applications */
152
153 #ifdef ACPI_APPLICATION
154 #define ACPI_USE_LOCAL_CACHE
155 #endif
156
157 /* Common debug/disassembler support */
158
159 #ifdef ACPI_FULL_DEBUG
160 #define ACPI_DEBUG_OUTPUT
161 #define ACPI_DEBUGGER 1
162 #define ACPI_DISASSEMBLER 1
163 #endif
164
165 /*! [Begin] no source code translation */
166
167 /******************************************************************************
168 *
169 * Host configuration files. The compiler configuration files are included
170 * first.
171 *
172 *****************************************************************************/
173
174 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
175 #include "acgcc.h"
176
177 #elif defined(_MSC_VER)
178 #include "acmsvc.h"
179
180 #elif defined(__INTEL_COMPILER)
181 #include "acintel.h"
182
183 #endif
184
185 #if defined(_LINUX) || defined(__linux__)
186 #include "aclinux.h"
187
188 #elif defined(_APPLE) || defined(__APPLE__)
189 #include "acmacosx.h"
190
191 #elif defined(__DragonFly__)
192 #include "acdragonfly.h"
193
194 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
195 #include "acfreebsd.h"
196
197 #elif defined(__NetBSD__)
198 #include "acnetbsd.h"
199
200 #elif defined(__sun)
201 #include "acsolaris.h"
202
203 #elif defined(MODESTO)
204 #include "acmodesto.h"
205
206 #elif defined(NETWARE)
207 #include "acnetware.h"
208
209 #elif defined(_CYGWIN)
210 #include "accygwin.h"
211
212 #elif defined(WIN32)
213 #include "acwin.h"
214
215 #elif defined(WIN64)
216 #include "acwin64.h"
217
218 #elif defined(_WRS_LIB_BUILD)
219 #include "acvxworks.h"
220
221 #elif defined(__OS2__)
222 #include "acos2.h"
223
224 #elif defined(__HAIKU__)
225 #include "achaiku.h"
226
227 #elif defined(__QNX__)
228 #include "acqnx.h"
229
230 /*
231 * EFI applications can be built with -nostdlib, in this case, it must be
232 * included after including all other host environmental definitions, in
233 * order to override the definitions.
234 */
235 #elif defined(_AED_EFI) || defined(_GNU_EFI) || defined(_EDK2_EFI)
236 #include "acefi.h"
237
238 #else
239
240 /* Unknown environment */
241
242 #error Unknown target environment
243 #endif
244
245 /*! [End] no source code translation !*/
246
247
248 /******************************************************************************
249 *
250 * Setup defaults for the required symbols that were not defined in one of
251 * the host/compiler files above.
252 *
253 *****************************************************************************/
254
255 /* 64-bit data types */
256
257 #ifndef COMPILER_DEPENDENT_INT64
258 #define COMPILER_DEPENDENT_INT64 long long
259 #endif
260
261 #ifndef COMPILER_DEPENDENT_UINT64
262 #define COMPILER_DEPENDENT_UINT64 unsigned long long
263 #endif
264
265 /* Type of mutex supported by host. Default is binary semaphores. */
266
267 #ifndef ACPI_MUTEX_TYPE
268 #ifdef __REACTOS__
269 #define ACPI_MUTEX_TYPE ACPI_OSL_MUTEX
270 #else
271 #define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
272 #endif /* __REACTOS__ */
273 #endif
274
275 /* Global Lock acquire/release */
276
277 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK
278 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
279 #endif
280
281 #ifndef ACPI_RELEASE_GLOBAL_LOCK
282 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
283 #endif
284
285 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
286
287 #ifndef ACPI_FLUSH_CPU_CACHE
288 #define ACPI_FLUSH_CPU_CACHE()
289 #endif
290
291 /* "inline" keywords - configurable since inline is not standardized */
292
293 #ifndef ACPI_INLINE
294 #define ACPI_INLINE
295 #endif
296
297 /* Use ordered initialization if compiler doesn't support designated. */
298 #ifndef ACPI_STRUCT_INIT
299 #define ACPI_STRUCT_INIT(field, value) value
300 #endif
301
302 /*
303 * Configurable calling conventions:
304 *
305 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
306 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
307 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
308 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
309 */
310 #ifndef ACPI_SYSTEM_XFACE
311 #define ACPI_SYSTEM_XFACE
312 #endif
313
314 #ifndef ACPI_EXTERNAL_XFACE
315 #define ACPI_EXTERNAL_XFACE
316 #endif
317
318 #ifndef ACPI_INTERNAL_XFACE
319 #define ACPI_INTERNAL_XFACE
320 #endif
321
322 #ifndef ACPI_INTERNAL_VAR_XFACE
323 #define ACPI_INTERNAL_VAR_XFACE
324 #endif
325
326
327 /*
328 * Debugger threading model
329 * Use single threaded if the entire subsystem is contained in an application
330 * Use multiple threaded when the subsystem is running in the kernel.
331 *
332 * By default the model is single threaded if ACPI_APPLICATION is set,
333 * multi-threaded if ACPI_APPLICATION is not set.
334 */
335 #ifndef DEBUGGER_THREADING
336 #if !defined (ACPI_APPLICATION) || defined (ACPI_EXEC_APP)
337 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
338
339 #else
340 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
341 #endif
342 #endif /* !DEBUGGER_THREADING */
343
344
345 /******************************************************************************
346 *
347 * C library configuration
348 *
349 *****************************************************************************/
350
351 /*
352 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
353 * Otherwise, local versions of string/memory functions will be used.
354 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
355 * the standard header files may be used. Defining this implies that
356 * ACPI_USE_SYSTEM_CLIBRARY has been defined.
357 *
358 * The ACPICA subsystem only uses low level C library functions that do not
359 * call operating system services and may therefore be inlined in the code.
360 *
361 * It may be necessary to tailor these include files to the target
362 * generation environment.
363 */
364
365 /* Use the standard C library headers. We want to keep these to a minimum. */
366
367 #ifdef ACPI_USE_STANDARD_HEADERS
368
369 /* Use the standard headers from the standard locations */
370
371 #include <stdlib.h>
372 #include <string.h>
373 #include <ctype.h>
374 #if defined (ACPI_APPLICATION) || defined(ACPI_LIBRARY)
375 #include <stdio.h>
376 #include <fcntl.h>
377 #include <errno.h>
378 #include <time.h>
379 #include <signal.h>
380 #endif
381
382 #endif /* ACPI_USE_STANDARD_HEADERS */
383
384 #ifdef ACPI_APPLICATION
385 #define ACPI_FILE FILE *
386 #define ACPI_FILE_OUT stdout
387 #define ACPI_FILE_ERR stderr
388 #else
389 #define ACPI_FILE void *
390 #define ACPI_FILE_OUT NULL
391 #define ACPI_FILE_ERR NULL
392 #endif /* ACPI_APPLICATION */
393
394 #ifndef ACPI_INIT_FUNCTION
395 #define ACPI_INIT_FUNCTION
396 #endif
397
398 #endif /* __ACENV_H__ */