acenv.h revision 1.1.1.5.2.2 1 /******************************************************************************
2 *
3 * Name: acenv.h - Host and compiler configuration
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2015, 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 /* iASL configuration */
71
72 #ifdef ACPI_ASL_COMPILER
73 #define ACPI_APPLICATION
74 #define ACPI_DISASSEMBLER
75 #define ACPI_DEBUG_OUTPUT
76 #define ACPI_CONSTANT_EVAL_ONLY
77 #define ACPI_LARGE_NAMESPACE_NODE
78 #define ACPI_DATA_TABLE_DISASSEMBLY
79 #define ACPI_SINGLE_THREADED
80 #define ACPI_32BIT_PHYSICAL_ADDRESS
81 #endif
82
83 /* AcpiExec configuration. Multithreaded with full AML debugger */
84
85 #ifdef ACPI_EXEC_APP
86 #define ACPI_APPLICATION
87 #define ACPI_FULL_DEBUG
88 #define ACPI_MUTEX_DEBUG
89 #define ACPI_DBG_TRACK_ALLOCATIONS
90 #endif
91
92 /*
93 * AcpiBin/AcpiDump/AcpiHelp/AcpiNames/AcpiSrc/AcpiXtract/Example configuration.
94 * All single threaded.
95 */
96 #if (defined ACPI_BIN_APP) || \
97 (defined ACPI_DUMP_APP) || \
98 (defined ACPI_HELP_APP) || \
99 (defined ACPI_NAMES_APP) || \
100 (defined ACPI_SRC_APP) || \
101 (defined ACPI_XTRACT_APP) || \
102 (defined ACPI_EXAMPLE_APP)
103 #define ACPI_APPLICATION
104 #define ACPI_SINGLE_THREADED
105 #endif
106
107 /* AcpiHelp configuration. Error messages disabled. */
108
109 #ifdef ACPI_HELP_APP
110 #define ACPI_NO_ERROR_MESSAGES
111 #endif
112
113 /* AcpiNames configuration. Debug output enabled. */
114
115 #ifdef ACPI_NAMES_APP
116 #define ACPI_DEBUG_OUTPUT
117 #endif
118
119 /* AcpiExec/AcpiNames/Example configuration. Native RSDP used. */
120
121 #if (defined ACPI_EXEC_APP) || \
122 (defined ACPI_EXAMPLE_APP) || \
123 (defined ACPI_NAMES_APP)
124 #define ACPI_USE_NATIVE_RSDP_POINTER
125 #endif
126
127 /* AcpiDump configuration. Native mapping used if provied by OSPMs */
128
129 #ifdef ACPI_DUMP_APP
130 #define ACPI_USE_NATIVE_MEMORY_MAPPING
131 #define USE_NATIVE_ALLOCATE_ZEROED
132 #endif
133
134 /* AcpiNames/Example configuration. Hardware disabled */
135
136 #if (defined ACPI_EXAMPLE_APP) || \
137 (defined ACPI_NAMES_APP)
138 #define ACPI_REDUCED_HARDWARE 1
139 #endif
140
141 /* Linkable ACPICA library */
142
143 #ifdef ACPI_LIBRARY
144 #define ACPI_USE_LOCAL_CACHE
145 #endif
146
147 /* Common for all ACPICA applications */
148
149 #ifdef ACPI_APPLICATION
150 #define ACPI_USE_SYSTEM_CLIBRARY
151 #define ACPI_USE_LOCAL_CACHE
152 #endif
153
154 /* Common debug support */
155
156 #ifdef ACPI_FULL_DEBUG
157 #define ACPI_DEBUGGER
158 #define ACPI_DEBUG_OUTPUT
159 #define ACPI_DISASSEMBLER
160 #endif
161
162
163 /*! [Begin] no source code translation */
164
165 /******************************************************************************
166 *
167 * Host configuration files. The compiler configuration files are included
168 * by the host files.
169 *
170 *****************************************************************************/
171
172 #if defined(_LINUX) || defined(__linux__)
173 #include "aclinux.h"
174
175 #elif defined(_APPLE) || defined(__APPLE__)
176 #include "acmacosx.h"
177
178 #elif defined(__DragonFly__)
179 #include "acdragonfly.h"
180
181 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
182 #include "acfreebsd.h"
183
184 #elif defined(__NetBSD__)
185 #include "acnetbsd.h"
186
187 #elif defined(__sun)
188 #include "acsolaris.h"
189
190 #elif defined(MODESTO)
191 #include "acmodesto.h"
192
193 #elif defined(NETWARE)
194 #include "acnetware.h"
195
196 #elif defined(_CYGWIN)
197 #include "accygwin.h"
198
199 #elif defined(WIN32)
200 #include "acwin.h"
201
202 #elif defined(WIN64)
203 #include "acwin64.h"
204
205 #elif defined(_WRS_LIB_BUILD)
206 #include "acvxworks.h"
207
208 #elif defined(__OS2__)
209 #include "acos2.h"
210
211 #elif defined(_AED_EFI)
212 #include "acefi.h"
213
214 #elif defined(_GNU_EFI)
215 #include "acefi.h"
216
217 #elif defined(__HAIKU__)
218 #include "achaiku.h"
219
220 #else
221
222 /* Unknown environment */
223
224 #error Unknown target environment
225 #endif
226
227 /*! [End] no source code translation !*/
228
229
230 /******************************************************************************
231 *
232 * Setup defaults for the required symbols that were not defined in one of
233 * the host/compiler files above.
234 *
235 *****************************************************************************/
236
237 /* 64-bit data types */
238
239 #ifndef COMPILER_DEPENDENT_INT64
240 #define COMPILER_DEPENDENT_INT64 long long
241 #endif
242
243 #ifndef COMPILER_DEPENDENT_UINT64
244 #define COMPILER_DEPENDENT_UINT64 unsigned long long
245 #endif
246
247 /* Type of mutex supported by host. Default is binary semaphores. */
248
249 #ifndef ACPI_MUTEX_TYPE
250 #define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
251 #endif
252
253 /* Global Lock acquire/release */
254
255 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK
256 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
257 #endif
258
259 #ifndef ACPI_RELEASE_GLOBAL_LOCK
260 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
261 #endif
262
263 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
264
265 #ifndef ACPI_FLUSH_CPU_CACHE
266 #define ACPI_FLUSH_CPU_CACHE()
267 #endif
268
269 /* "inline" keywords - configurable since inline is not standardized */
270
271 #ifndef ACPI_INLINE
272 #define ACPI_INLINE
273 #endif
274
275 /*
276 * Configurable calling conventions:
277 *
278 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
279 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
280 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
281 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
282 */
283 #ifndef ACPI_SYSTEM_XFACE
284 #define ACPI_SYSTEM_XFACE
285 #endif
286
287 #ifndef ACPI_EXTERNAL_XFACE
288 #define ACPI_EXTERNAL_XFACE
289 #endif
290
291 #ifndef ACPI_INTERNAL_XFACE
292 #define ACPI_INTERNAL_XFACE
293 #endif
294
295 #ifndef ACPI_INTERNAL_VAR_XFACE
296 #define ACPI_INTERNAL_VAR_XFACE
297 #endif
298
299 /*
300 * Debugger threading model
301 * Use single threaded if the entire subsystem is contained in an application
302 * Use multiple threaded when the subsystem is running in the kernel.
303 *
304 * By default the model is single threaded if ACPI_APPLICATION is set,
305 * multi-threaded if ACPI_APPLICATION is not set.
306 */
307 #ifndef DEBUGGER_THREADING
308 #ifdef ACPI_APPLICATION
309 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
310
311 #else
312 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
313 #endif
314 #endif /* !DEBUGGER_THREADING */
315
316
317 /******************************************************************************
318 *
319 * C library configuration
320 *
321 *****************************************************************************/
322
323 /*
324 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
325 * Otherwise, local versions of string/memory functions will be used.
326 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
327 * the standard header files may be used.
328 *
329 * The ACPICA subsystem only uses low level C library functions that do not call
330 * operating system services and may therefore be inlined in the code.
331 *
332 * It may be necessary to tailor these include files to the target
333 * generation environment.
334 */
335 #ifdef ACPI_USE_SYSTEM_CLIBRARY
336
337 /* Use the standard C library headers. We want to keep these to a minimum. */
338
339 #ifdef ACPI_USE_STANDARD_HEADERS
340
341 /* Use the standard headers from the standard locations */
342
343 #include <stdarg.h>
344 #include <stdlib.h>
345 #include <string.h>
346 #include <ctype.h>
347
348 #endif /* ACPI_USE_STANDARD_HEADERS */
349
350 /* We will be linking to the standard Clib functions */
351
352 #else
353
354 /******************************************************************************
355 *
356 * Not using native C library, use local implementations
357 *
358 *****************************************************************************/
359
360 /*
361 * Use local definitions of C library macros and functions. These function
362 * implementations may not be as efficient as an inline or assembly code
363 * implementation provided by a native C library, but they are functionally
364 * equivalent.
365 */
366 #ifndef va_arg
367
368 #ifndef _VALIST
369 #define _VALIST
370 typedef char *va_list;
371 #endif /* _VALIST */
372
373 /* Storage alignment properties */
374
375 #define _AUPBND (sizeof (ACPI_NATIVE_INT) - 1)
376 #define _ADNBND (sizeof (ACPI_NATIVE_INT) - 1)
377
378 /* Variable argument list macro definitions */
379
380 #define _Bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
381 #define va_arg(ap, T) (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
382 #define va_end(ap) (ap = (va_list) NULL)
383 #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
384
385 #endif /* va_arg */
386
387 /* Use the local (ACPICA) definitions of the clib functions */
388
389 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
390
391 #ifndef ACPI_FILE
392 #ifdef ACPI_APPLICATION
393 #include <stdio.h>
394 #define ACPI_FILE FILE *
395 #define ACPI_FILE_OUT stdout
396 #define ACPI_FILE_ERR stderr
397 #else
398 #define ACPI_FILE void *
399 #define ACPI_FILE_OUT NULL
400 #define ACPI_FILE_ERR NULL
401 #endif /* ACPI_APPLICATION */
402 #endif /* ACPI_FILE */
403
404 #endif /* __ACENV_H__ */
405