1/******************************************************************************
2 *
3 * Name: acenv.h - Host and compiler configuration
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************/
115
116#ifndef __ACENV_H__
117#define __ACENV_H__
118
119/*
120 * Environment configuration. The purpose of this file is to interface ACPICA
121 * to the local environment. This includes compiler-specific, OS-specific,
122 * and machine-specific configuration.
123 */
124
125/* Types for ACPI_MUTEX_TYPE */
126
127#define ACPI_BINARY_SEMAPHORE       0
128#define ACPI_OSL_MUTEX              1
129
130/* Types for DEBUGGER_THREADING */
131
132#define DEBUGGER_SINGLE_THREADED    0
133#define DEBUGGER_MULTI_THREADED     1
134
135
136/******************************************************************************
137 *
138 * Configuration for ACPI tools and utilities
139 *
140 *****************************************************************************/
141
142/* Common application configuration. All single threaded except for AcpiExec. */
143
144#if (defined ACPI_ASL_COMPILER) || \
145    (defined ACPI_BIN_APP)      || \
146    (defined ACPI_DUMP_APP)     || \
147    (defined ACPI_HELP_APP)     || \
148    (defined ACPI_NAMES_APP)    || \
149    (defined ACPI_SRC_APP)      || \
150    (defined ACPI_XTRACT_APP)   || \
151    (defined ACPI_EXAMPLE_APP)
152#define ACPI_APPLICATION
153#define ACPI_SINGLE_THREADED
154#endif
155
156/* iASL configuration */
157
158#ifdef ACPI_ASL_COMPILER
159#define ACPI_DEBUG_OUTPUT
160#define ACPI_CONSTANT_EVAL_ONLY
161#define ACPI_LARGE_NAMESPACE_NODE
162#define ACPI_DATA_TABLE_DISASSEMBLY
163#define ACPI_32BIT_PHYSICAL_ADDRESS
164#define ACPI_DISASSEMBLER 1
165#endif
166
167/* AcpiExec configuration. Multithreaded with full AML debugger */
168
169#ifdef ACPI_EXEC_APP
170#define ACPI_APPLICATION
171#define ACPI_FULL_DEBUG
172#define ACPI_MUTEX_DEBUG
173#define ACPI_DBG_TRACK_ALLOCATIONS
174#endif
175
176/* AcpiHelp configuration. Error messages disabled. */
177
178#ifdef ACPI_HELP_APP
179#define ACPI_NO_ERROR_MESSAGES
180#endif
181
182/* AcpiNames configuration. Debug output enabled. */
183
184#ifdef ACPI_NAMES_APP
185#define ACPI_DEBUG_OUTPUT
186#endif
187
188/* AcpiExec/AcpiNames/Example configuration. Native RSDP used. */
189
190#if (defined ACPI_EXEC_APP)     || \
191    (defined ACPI_EXAMPLE_APP)  || \
192    (defined ACPI_NAMES_APP)
193#define ACPI_USE_NATIVE_RSDP_POINTER
194#endif
195
196/* AcpiDump configuration. Native mapping used if provided by the host */
197
198#ifdef ACPI_DUMP_APP
199#define ACPI_USE_NATIVE_MEMORY_MAPPING
200#define USE_NATIVE_ALLOCATE_ZEROED
201#endif
202
203/* AcpiNames/Example configuration. Hardware disabled */
204
205#if (defined ACPI_EXAMPLE_APP)  || \
206    (defined ACPI_NAMES_APP)
207#define ACPI_REDUCED_HARDWARE 1
208#endif
209
210/* Linkable ACPICA library. Two versions, one with full debug. */
211
212#ifdef ACPI_LIBRARY
213#define ACPI_USE_LOCAL_CACHE
214#define ACPI_DEBUGGER 1
215#define ACPI_DISASSEMBLER 1
216
217#ifdef _DEBUG
218#define ACPI_DEBUG_OUTPUT
219#endif
220#endif
221
222/* Common for all ACPICA applications */
223
224#ifdef ACPI_APPLICATION
225#define ACPI_USE_SYSTEM_CLIBRARY
226#define ACPI_USE_LOCAL_CACHE
227#endif
228
229/* Common debug/disassembler support */
230
231#ifdef ACPI_FULL_DEBUG
232#define ACPI_DEBUG_OUTPUT
233#define ACPI_DEBUGGER 1
234#define ACPI_DISASSEMBLER 1
235#endif
236
237/*! [Begin] no source code translation */
238
239/******************************************************************************
240 *
241 * Host configuration files. The compiler configuration files are included
242 * by the host files.
243 *
244 *****************************************************************************/
245
246#if defined(_LINUX) || defined(__linux__)
247#include "aclinux.h"
248
249#elif defined(_APPLE) || defined(__APPLE__)
250#include "acmacosx.h"
251
252#elif defined(__DragonFly__)
253#include "acdragonfly.h"
254
255#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
256#include "acfreebsd.h"
257
258#elif defined(__NetBSD__)
259#include "acnetbsd.h"
260
261#elif defined(__sun)
262#include "acsolaris.h"
263
264#elif defined(MODESTO)
265#include "acmodesto.h"
266
267#elif defined(NETWARE)
268#include "acnetware.h"
269
270#elif defined(_CYGWIN)
271#include "accygwin.h"
272
273#elif defined(WIN32)
274#include "acwin.h"
275
276#elif defined(WIN64)
277#include "acwin64.h"
278
279#elif defined(_WRS_LIB_BUILD)
280#include "acvxworks.h"
281
282#elif defined(__OS2__)
283#include "acos2.h"
284
285#elif defined(_AED_EFI)
286#include "acefi.h"
287
288#elif defined(_GNU_EFI)
289#include "acefi.h"
290
291#elif defined(__HAIKU__)
292#include "achaiku.h"
293
294#elif defined(__QNX__)
295#include "acqnx.h"
296
297#elif defined(BARRELFISH)
298#include "acbarrelfish.h"
299
300#else
301
302/* Unknown environment */
303
304#error Unknown target environment
305#endif
306
307/*! [End] no source code translation !*/
308
309
310/******************************************************************************
311 *
312 * Setup defaults for the required symbols that were not defined in one of
313 * the host/compiler files above.
314 *
315 *****************************************************************************/
316
317/* 64-bit data types */
318
319#ifndef COMPILER_DEPENDENT_INT64
320#define COMPILER_DEPENDENT_INT64   long long
321#endif
322
323#ifndef COMPILER_DEPENDENT_UINT64
324#define COMPILER_DEPENDENT_UINT64  unsigned long long
325#endif
326
327/* Type of mutex supported by host. Default is binary semaphores. */
328
329#ifndef ACPI_MUTEX_TYPE
330#define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
331#endif
332
333/* Global Lock acquire/release */
334
335#ifndef ACPI_ACQUIRE_GLOBAL_LOCK
336#define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
337#endif
338
339#ifndef ACPI_RELEASE_GLOBAL_LOCK
340#define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
341#endif
342
343/* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
344
345#ifndef ACPI_FLUSH_CPU_CACHE
346#define ACPI_FLUSH_CPU_CACHE()
347#endif
348
349/* "inline" keywords - configurable since inline is not standardized */
350
351#ifndef ACPI_INLINE
352#define ACPI_INLINE
353#endif
354
355/*
356 * Configurable calling conventions:
357 *
358 * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
359 * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
360 * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
361 * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
362 */
363#ifndef ACPI_SYSTEM_XFACE
364#define ACPI_SYSTEM_XFACE
365#endif
366
367#ifndef ACPI_EXTERNAL_XFACE
368#define ACPI_EXTERNAL_XFACE
369#endif
370
371#ifndef ACPI_INTERNAL_XFACE
372#define ACPI_INTERNAL_XFACE
373#endif
374
375#ifndef ACPI_INTERNAL_VAR_XFACE
376#define ACPI_INTERNAL_VAR_XFACE
377#endif
378
379
380/*
381 * Debugger threading model
382 * Use single threaded if the entire subsystem is contained in an application
383 * Use multiple threaded when the subsystem is running in the kernel.
384 *
385 * By default the model is single threaded if ACPI_APPLICATION is set,
386 * multi-threaded if ACPI_APPLICATION is not set.
387 */
388#ifndef DEBUGGER_THREADING
389#if !defined (ACPI_APPLICATION) || defined (ACPI_EXEC_APP)
390#define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
391
392#else
393#define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
394#endif
395#endif /* !DEBUGGER_THREADING */
396
397
398/******************************************************************************
399 *
400 * C library configuration
401 *
402 *****************************************************************************/
403
404/*
405 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
406 *      Otherwise, local versions of string/memory functions will be used.
407 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
408 *      the standard header files may be used.
409 *
410 * The ACPICA subsystem only uses low level C library functions that do not
411 * call operating system services and may therefore be inlined in the code.
412 *
413 * It may be necessary to tailor these include files to the target
414 * generation environment.
415 */
416#ifdef ACPI_USE_SYSTEM_CLIBRARY
417
418/* Use the standard C library headers. We want to keep these to a minimum. */
419
420#ifdef ACPI_USE_STANDARD_HEADERS
421
422/* Use the standard headers from the standard locations */
423
424#include <stdarg.h>
425#include <stdlib.h>
426#include <string.h>
427#include <ctype.h>
428
429#endif /* ACPI_USE_STANDARD_HEADERS */
430
431/* We will be linking to the standard Clib functions */
432
433#else
434
435/******************************************************************************
436 *
437 * Not using native C library, use local implementations
438 *
439 *****************************************************************************/
440
441/*
442 * Use local definitions of C library macros and functions. These function
443 * implementations may not be as efficient as an inline or assembly code
444 * implementation provided by a native C library, but they are functionally
445 * equivalent.
446 */
447#ifndef va_arg
448
449#ifndef _VALIST
450#define _VALIST
451typedef char *va_list;
452#endif /* _VALIST */
453
454/* Storage alignment properties */
455
456#define  _AUPBND                (sizeof (ACPI_NATIVE_INT) - 1)
457#define  _ADNBND                (sizeof (ACPI_NATIVE_INT) - 1)
458
459/* Variable argument list macro definitions */
460
461#define _Bnd(X, bnd)            (((sizeof (X)) + (bnd)) & (~(bnd)))
462#define va_arg(ap, T)           (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
463#define va_end(ap)              (ap = (va_list) NULL)
464#define va_start(ap, A)         (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
465
466#endif /* va_arg */
467
468/* Use the local (ACPICA) definitions of the clib functions */
469
470#endif /* ACPI_USE_SYSTEM_CLIBRARY */
471
472#ifndef ACPI_FILE
473#ifdef ACPI_APPLICATION
474#include <stdio.h>
475#define ACPI_FILE              FILE *
476#define ACPI_FILE_OUT          stdout
477#define ACPI_FILE_ERR          stderr
478#else
479#define ACPI_FILE              void *
480#define ACPI_FILE_OUT          NULL
481#define ACPI_FILE_ERR          NULL
482#endif /* ACPI_APPLICATION */
483#endif /* ACPI_FILE */
484
485#ifndef ACPI_INIT_FUNCTION
486#define ACPI_INIT_FUNCTION
487#endif
488
489#endif /* __ACENV_H__ */
490