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