1 /******************************************************************************
3 * Name: acenv.h - Host and compiler configuration
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
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.
53 /* Types for ACPI_MUTEX_TYPE */
55 #define ACPI_BINARY_SEMAPHORE 0
56 #define ACPI_OSL_MUTEX 1
58 /* Types for DEBUGGER_THREADING */
60 #define DEBUGGER_SINGLE_THREADED 0
61 #define DEBUGGER_MULTI_THREADED 1
64 /******************************************************************************
66 * Configuration for ACPI tools and utilities
68 *****************************************************************************/
70 /* iASL configuration */
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
82 /* AcpiExec configuration. Multithreaded with full AML debugger */
85 #define ACPI_APPLICATION
86 #define ACPI_FULL_DEBUG
87 #define ACPI_MUTEX_DEBUG
88 #define ACPI_DBG_TRACK_ALLOCATIONS
92 * AcpiBin/AcpiDump/AcpiHelp/AcpiNames/AcpiSrc/AcpiXtract/Example configuration.
93 * All single threaded.
95 #if (defined ACPI_BIN_APP) || \
96 (defined ACPI_DUMP_APP) || \
97 (defined ACPI_HELP_APP) || \
98 (defined ACPI_NAMES_APP) || \
99 (defined ACPI_SRC_APP) || \
100 (defined ACPI_XTRACT_APP) || \
101 (defined ACPI_EXAMPLE_APP)
102 #define ACPI_APPLICATION
103 #define ACPI_SINGLE_THREADED
106 /* AcpiHelp configuration. Error messages disabled. */
109 #define ACPI_NO_ERROR_MESSAGES
112 /* AcpiNames configuration. Debug output enabled. */
114 #ifdef ACPI_NAMES_APP
115 #define ACPI_DEBUG_OUTPUT
118 /* AcpiExec/AcpiNames/Example configuration. Native RSDP used. */
120 #if (defined ACPI_EXEC_APP) || \
121 (defined ACPI_EXAMPLE_APP) || \
122 (defined ACPI_NAMES_APP)
123 #define ACPI_USE_NATIVE_RSDP_POINTER
126 /* AcpiDump configuration. Native mapping used if provied by OSPMs */
129 #define ACPI_USE_NATIVE_MEMORY_MAPPING
130 #define USE_NATIVE_ALLOCATE_ZEROED
133 /* AcpiNames/Example configuration. Hardware disabled */
135 #if (defined ACPI_EXAMPLE_APP) || \
136 (defined ACPI_NAMES_APP)
137 #define ACPI_REDUCED_HARDWARE 1
140 /* Linkable ACPICA library */
143 #define ACPI_USE_LOCAL_CACHE
146 /* Common for all ACPICA applications */
148 #ifdef ACPI_APPLICATION
149 #define ACPI_USE_SYSTEM_CLIBRARY
150 #define ACPI_USE_LOCAL_CACHE
153 /* Common debug support */
155 #ifdef ACPI_FULL_DEBUG
156 #define ACPI_DEBUGGER
157 #define ACPI_DEBUG_OUTPUT
158 #define ACPI_DISASSEMBLER
162 /*! [Begin] no source code translation */
164 /******************************************************************************
166 * Host configuration files. The compiler configuration files are included
169 *****************************************************************************/
171 #if defined(_LINUX) || defined(__linux__)
174 #elif defined(_APPLE) || defined(__APPLE__)
175 #include "acmacosx.h"
177 #elif defined(__DragonFly__)
178 #include "acdragonfly.h"
180 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
181 #include "acfreebsd.h"
183 #elif defined(__NetBSD__)
184 #include "acnetbsd.h"
187 #include "acsolaris.h"
189 #elif defined(MODESTO)
190 #include "acmodesto.h"
192 #elif defined(NETWARE)
193 #include "acnetware.h"
195 #elif defined(_CYGWIN)
196 #include "accygwin.h"
204 #elif defined(_WRS_LIB_BUILD)
205 #include "acvxworks.h"
207 #elif defined(__OS2__)
210 #elif defined(_AED_EFI)
213 #elif defined(_GNU_EFI)
216 #elif defined(__HAIKU__)
221 /* Unknown environment */
223 #error Unknown target environment
226 /*! [End] no source code translation !*/
229 /******************************************************************************
231 * Setup defaults for the required symbols that were not defined in one of
232 * the host/compiler files above.
234 *****************************************************************************/
236 /* 64-bit data types */
238 #ifndef COMPILER_DEPENDENT_INT64
239 #define COMPILER_DEPENDENT_INT64 long long
242 #ifndef COMPILER_DEPENDENT_UINT64
243 #define COMPILER_DEPENDENT_UINT64 unsigned long long
246 /* Type of mutex supported by host. Default is binary semaphores. */
248 #ifndef ACPI_MUTEX_TYPE
249 #define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
252 /* Global Lock acquire/release */
254 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK
255 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
258 #ifndef ACPI_RELEASE_GLOBAL_LOCK
259 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
262 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
264 #ifndef ACPI_FLUSH_CPU_CACHE
265 #define ACPI_FLUSH_CPU_CACHE()
268 /* "inline" keywords - configurable since inline is not standardized */
275 * Configurable calling conventions:
277 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
278 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
279 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
280 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
282 #ifndef ACPI_SYSTEM_XFACE
283 #define ACPI_SYSTEM_XFACE
286 #ifndef ACPI_EXTERNAL_XFACE
287 #define ACPI_EXTERNAL_XFACE
290 #ifndef ACPI_INTERNAL_XFACE
291 #define ACPI_INTERNAL_XFACE
294 #ifndef ACPI_INTERNAL_VAR_XFACE
295 #define ACPI_INTERNAL_VAR_XFACE
299 * Debugger threading model
300 * Use single threaded if the entire subsystem is contained in an application
301 * Use multiple threaded when the subsystem is running in the kernel.
303 * By default the model is single threaded if ACPI_APPLICATION is set,
304 * multi-threaded if ACPI_APPLICATION is not set.
306 #ifndef DEBUGGER_THREADING
307 #ifdef ACPI_APPLICATION
308 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
311 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
313 #endif /* !DEBUGGER_THREADING */
316 /******************************************************************************
318 * C library configuration
320 *****************************************************************************/
323 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
324 * Otherwise, local versions of string/memory functions will be used.
325 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
326 * the standard header files may be used.
328 * The ACPICA subsystem only uses low level C library functions that do not call
329 * operating system services and may therefore be inlined in the code.
331 * It may be necessary to tailor these include files to the target
332 * generation environment.
334 #ifdef ACPI_USE_SYSTEM_CLIBRARY
336 /* Use the standard C library headers. We want to keep these to a minimum. */
338 #ifdef ACPI_USE_STANDARD_HEADERS
340 /* Use the standard headers from the standard locations */
347 #endif /* ACPI_USE_STANDARD_HEADERS */
349 /* We will be linking to the standard Clib functions */
351 #define ACPI_STRSTR(s1,s2) strstr((s1), (s2))
352 #define ACPI_STRCHR(s1,c) strchr((s1), (c))
353 #define ACPI_STRLEN(s) (ACPI_SIZE) strlen((s))
354 #define ACPI_STRCPY(d,s) (void) strcpy((d), (s))
355 #define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (ACPI_SIZE)(n))
356 #define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (ACPI_SIZE)(n))
357 #define ACPI_STRCMP(d,s) strcmp((d), (s))
358 #define ACPI_STRCAT(d,s) (void) strcat((d), (s))
359 #define ACPI_STRNCAT(d,s,n) strncat((d), (s), (ACPI_SIZE)(n))
360 #define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (ACPI_SIZE)(n))
361 #define ACPI_MEMCMP(s1,s2,n) memcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
362 #define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (ACPI_SIZE)(n))
363 #define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (ACPI_SIZE)(n))
364 #define ACPI_TOUPPER(i) toupper((int) (i))
365 #define ACPI_TOLOWER(i) tolower((int) (i))
366 #define ACPI_IS_XDIGIT(i) isxdigit((int) (i))
367 #define ACPI_IS_DIGIT(i) isdigit((int) (i))
368 #define ACPI_IS_SPACE(i) isspace((int) (i))
369 #define ACPI_IS_UPPER(i) isupper((int) (i))
370 #define ACPI_IS_PRINT(i) isprint((int) (i))
371 #define ACPI_IS_ALPHA(i) isalpha((int) (i))
375 /******************************************************************************
377 * Not using native C library, use local implementations
379 *****************************************************************************/
382 * Use local definitions of C library macros and functions. These function
383 * implementations may not be as efficient as an inline or assembly code
384 * implementation provided by a native C library, but they are functionally
391 typedef char *va_list;
394 /* Storage alignment properties */
396 #define _AUPBND (sizeof (ACPI_NATIVE_INT) - 1)
397 #define _ADNBND (sizeof (ACPI_NATIVE_INT) - 1)
399 /* Variable argument list macro definitions */
401 #define _Bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
402 #define va_arg(ap, T) (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
403 #define va_end(ap) (ap = (va_list) NULL)
404 #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
408 /* Use the local (ACPICA) definitions of the clib functions */
410 #define ACPI_STRSTR(s1,s2) AcpiUtStrstr ((s1), (s2))
411 #define ACPI_STRCHR(s1,c) AcpiUtStrchr ((s1), (c))
412 #define ACPI_STRLEN(s) (ACPI_SIZE) AcpiUtStrlen ((s))
413 #define ACPI_STRCPY(d,s) (void) AcpiUtStrcpy ((d), (s))
414 #define ACPI_STRNCPY(d,s,n) (void) AcpiUtStrncpy ((d), (s), (ACPI_SIZE)(n))
415 #define ACPI_STRNCMP(d,s,n) AcpiUtStrncmp ((d), (s), (ACPI_SIZE)(n))
416 #define ACPI_STRCMP(d,s) AcpiUtStrcmp ((d), (s))
417 #define ACPI_STRCAT(d,s) (void) AcpiUtStrcat ((d), (s))
418 #define ACPI_STRNCAT(d,s,n) AcpiUtStrncat ((d), (s), (ACPI_SIZE)(n))
419 #define ACPI_STRTOUL(d,s,n) AcpiUtStrtoul ((d), (s), (ACPI_SIZE)(n))
420 #define ACPI_MEMCMP(s1,s2,n) AcpiUtMemcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
421 #define ACPI_MEMCPY(d,s,n) (void) AcpiUtMemcpy ((d), (s), (ACPI_SIZE)(n))
422 #define ACPI_MEMSET(d,v,n) (void) AcpiUtMemset ((d), (v), (ACPI_SIZE)(n))
423 #define ACPI_TOUPPER(c) AcpiUtToUpper ((int) (c))
424 #define ACPI_TOLOWER(c) AcpiUtToLower ((int) (c))
426 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
429 #ifdef ACPI_APPLICATION
431 #define ACPI_FILE FILE *
432 #define ACPI_FILE_OUT stdout
433 #define ACPI_FILE_ERR stderr
435 #define ACPI_FILE void *
436 #define ACPI_FILE_OUT NULL
437 #define ACPI_FILE_ERR NULL
438 #endif /* ACPI_APPLICATION */
439 #endif /* ACPI_FILE */
441 #endif /* __ACENV_H__ */