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