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 - 2020, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#ifndef __ACENV_H__
153#define __ACENV_H__
154
155/*
156 * Environment configuration. The purpose of this file is to interface ACPICA
157 * to the local environment. This includes compiler-specific, OS-specific,
158 * and machine-specific configuration.
159 */
160
161/* Types for ACPI_MUTEX_TYPE */
162
163#define ACPI_BINARY_SEMAPHORE       0
164#define ACPI_OSL_MUTEX              1
165
166/* Types for DEBUGGER_THREADING */
167
168#define DEBUGGER_SINGLE_THREADED    0
169#define DEBUGGER_MULTI_THREADED     1
170
171
172/******************************************************************************
173 *
174 * Configuration for ACPI tools and utilities
175 *
176 *****************************************************************************/
177
178/* Common application configuration. All single threaded except for AcpiExec. */
179
180#if (defined ACPI_ASL_COMPILER) || \
181    (defined ACPI_BIN_APP)      || \
182    (defined ACPI_DUMP_APP)     || \
183    (defined ACPI_HELP_APP)     || \
184    (defined ACPI_NAMES_APP)    || \
185    (defined ACPI_SRC_APP)      || \
186    (defined ACPI_XTRACT_APP)   || \
187    (defined ACPI_EXAMPLE_APP)  || \
188    (defined ACPI_EFI_HELLO)
189#define ACPI_APPLICATION
190#define ACPI_SINGLE_THREADED
191#define USE_NATIVE_ALLOCATE_ZEROED
192#endif
193
194/* iASL configuration */
195
196#ifdef ACPI_ASL_COMPILER
197#define ACPI_DEBUG_OUTPUT
198#define ACPI_CONSTANT_EVAL_ONLY
199#define ACPI_LARGE_NAMESPACE_NODE
200#define ACPI_DATA_TABLE_DISASSEMBLY
201#define ACPI_32BIT_PHYSICAL_ADDRESS
202#define ACPI_DISASSEMBLER 1
203#endif
204
205/* AcpiExec configuration. Multithreaded with full AML debugger */
206
207#ifdef ACPI_EXEC_APP
208#define ACPI_APPLICATION
209#define ACPI_FULL_DEBUG
210#define ACPI_MUTEX_DEBUG
211#define ACPI_DBG_TRACK_ALLOCATIONS
212#endif
213
214/* AcpiHelp configuration. Error messages disabled. */
215
216#ifdef ACPI_HELP_APP
217#define ACPI_NO_ERROR_MESSAGES
218#endif
219
220/* AcpiNames configuration. Debug output enabled. */
221
222#ifdef ACPI_NAMES_APP
223#define ACPI_DEBUG_OUTPUT
224#endif
225
226/* AcpiExec/AcpiNames/Example configuration. Native RSDP used. */
227
228#if (defined ACPI_EXEC_APP)     || \
229    (defined ACPI_EXAMPLE_APP)  || \
230    (defined ACPI_NAMES_APP)
231#define ACPI_USE_NATIVE_RSDP_POINTER
232#endif
233
234/* AcpiDump configuration. Native mapping used if provided by the host */
235
236#ifdef ACPI_DUMP_APP
237#define ACPI_USE_NATIVE_MEMORY_MAPPING
238#endif
239
240/* AcpiNames/Example configuration. Hardware disabled */
241
242#if (defined ACPI_EXAMPLE_APP)  || \
243    (defined ACPI_NAMES_APP)
244#define ACPI_REDUCED_HARDWARE 1
245#endif
246
247/* Linkable ACPICA library. Two versions, one with full debug. */
248
249#ifdef ACPI_LIBRARY
250#define ACPI_USE_LOCAL_CACHE
251#define ACPI_DEBUGGER 1
252#define ACPI_DISASSEMBLER 1
253
254#ifdef _DEBUG
255#define ACPI_DEBUG_OUTPUT
256#endif
257#endif
258
259/* Common for all ACPICA applications */
260
261#ifdef ACPI_APPLICATION
262#define ACPI_USE_LOCAL_CACHE
263#endif
264
265/* Common debug/disassembler support */
266
267#ifdef ACPI_FULL_DEBUG
268#define ACPI_DEBUG_OUTPUT
269#define ACPI_DEBUGGER 1
270#define ACPI_DISASSEMBLER 1
271#endif
272
273/*
274 * acpisrc CR\LF support
275 * Unix file line endings do not include the carriage return.
276 * If the acpisrc utility is being built using a microsoft compiler, it means
277 * that it will be running on a windows machine which means that the output is
278 * expected to have CR/LF newlines. If the acpisrc utility is built with
279 * anything else, it will likely run on a system with LF newlines. This flag
280 * tells the acpisrc utility that newlines will be in the LF format.
281 */
282#if defined(ACPI_SRC_APP) && !defined(_MSC_VER)
283#define ACPI_SRC_OS_LF_ONLY 1
284#else
285#define ACPI_SRC_OS_LF_ONLY 0
286#endif
287
288/*! [Begin] no source code translation */
289
290/******************************************************************************
291 *
292 * Host configuration files. The compiler configuration files are included
293 * first.
294 *
295 *****************************************************************************/
296
297#if defined(__GNUC__) && !defined(__INTEL_COMPILER)
298#include <contrib/dev/acpica/include/platform/acgcc.h>
299
300#elif defined(_MSC_VER)
301#include "acmsvc.h"
302
303#elif defined(__INTEL_COMPILER)
304#include "acintel.h"
305
306#endif
307
308#if defined(_LINUX) || defined(__linux__)
309#include "aclinux.h"
310
311#elif defined(_APPLE) || defined(__APPLE__)
312#include "acmacosx.h"
313
314#elif defined(__DragonFly__)
315#include "acdragonfly.h"
316
317#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
318#include <contrib/dev/acpica/include/platform/acfreebsd.h>
319
320#elif defined(__NetBSD__)
321#include "acnetbsd.h"
322
323#elif defined(__sun)
324#include "acsolaris.h"
325
326#elif defined(MODESTO)
327#include "acmodesto.h"
328
329#elif defined(NETWARE)
330#include "acnetware.h"
331
332#elif defined(_CYGWIN)
333#include "accygwin.h"
334
335#elif defined(WIN32)
336#include "acwin.h"
337
338#elif defined(WIN64)
339#include "acwin64.h"
340
341#elif defined(_WRS_LIB_BUILD)
342#include "acvxworks.h"
343
344#elif defined(__OS2__)
345#include "acos2.h"
346
347#elif defined(__HAIKU__)
348#include "achaiku.h"
349
350#elif defined(__QNX__)
351#include "acqnx.h"
352
353/*
354 * EFI applications can be built with -nostdlib, in this case, it must be
355 * included after including all other host environmental definitions, in
356 * order to override the definitions.
357 */
358#elif defined(_AED_EFI) || defined(_GNU_EFI) || defined(_EDK2_EFI)
359#include "acefi.h"
360
361#else
362
363/* Unknown environment */
364
365#error Unknown target environment
366#endif
367
368/*! [End] no source code translation !*/
369
370
371/******************************************************************************
372 *
373 * Setup defaults for the required symbols that were not defined in one of
374 * the host/compiler files above.
375 *
376 *****************************************************************************/
377
378/* 64-bit data types */
379
380#ifndef COMPILER_DEPENDENT_INT64
381#define COMPILER_DEPENDENT_INT64   long long
382#endif
383
384#ifndef COMPILER_DEPENDENT_UINT64
385#define COMPILER_DEPENDENT_UINT64  unsigned long long
386#endif
387
388/* Type of mutex supported by host. Default is binary semaphores. */
389
390#ifndef ACPI_MUTEX_TYPE
391#define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
392#endif
393
394/* Global Lock acquire/release */
395
396#ifndef ACPI_ACQUIRE_GLOBAL_LOCK
397#define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
398#endif
399
400#ifndef ACPI_RELEASE_GLOBAL_LOCK
401#define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
402#endif
403
404/* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
405
406#ifndef ACPI_FLUSH_CPU_CACHE
407#define ACPI_FLUSH_CPU_CACHE()
408#endif
409
410/* "inline" keywords - configurable since inline is not standardized */
411
412#ifndef ACPI_INLINE
413#define ACPI_INLINE
414#endif
415
416/* Use ordered initialization if compiler doesn't support designated. */
417#ifndef ACPI_STRUCT_INIT
418#define ACPI_STRUCT_INIT(field, value)  value
419#endif
420
421/*
422 * Configurable calling conventions:
423 *
424 * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
425 * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
426 * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
427 * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
428 */
429#ifndef ACPI_SYSTEM_XFACE
430#define ACPI_SYSTEM_XFACE
431#endif
432
433#ifndef ACPI_EXTERNAL_XFACE
434#define ACPI_EXTERNAL_XFACE
435#endif
436
437#ifndef ACPI_INTERNAL_XFACE
438#define ACPI_INTERNAL_XFACE
439#endif
440
441#ifndef ACPI_INTERNAL_VAR_XFACE
442#define ACPI_INTERNAL_VAR_XFACE
443#endif
444
445
446/*
447 * Debugger threading model
448 * Use single threaded if the entire subsystem is contained in an application
449 * Use multiple threaded when the subsystem is running in the kernel.
450 *
451 * By default the model is single threaded if ACPI_APPLICATION is set,
452 * multi-threaded if ACPI_APPLICATION is not set.
453 */
454#ifndef DEBUGGER_THREADING
455#if !defined (ACPI_APPLICATION) || defined (ACPI_EXEC_APP)
456#define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
457
458#else
459#define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
460#endif
461#endif /* !DEBUGGER_THREADING */
462
463
464/******************************************************************************
465 *
466 * C library configuration
467 *
468 *****************************************************************************/
469
470/*
471 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
472 *      Otherwise, local versions of string/memory functions will be used.
473 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
474 *      the standard header files may be used. Defining this implies that
475 *      ACPI_USE_SYSTEM_CLIBRARY has been defined.
476 *
477 * The ACPICA subsystem only uses low level C library functions that do not
478 * call operating system services and may therefore be inlined in the code.
479 *
480 * It may be necessary to tailor these include files to the target
481 * generation environment.
482 */
483
484/* Use the standard C library headers. We want to keep these to a minimum. */
485
486#ifdef ACPI_USE_STANDARD_HEADERS
487
488/* Use the standard headers from the standard locations */
489
490#include <stdlib.h>
491#include <string.h>
492#include <ctype.h>
493#if defined (ACPI_APPLICATION) || defined(ACPI_LIBRARY)
494#include <stdio.h>
495#include <fcntl.h>
496#include <errno.h>
497#include <time.h>
498#include <signal.h>
499#endif
500
501#endif /* ACPI_USE_STANDARD_HEADERS */
502
503#ifdef ACPI_APPLICATION
504#define ACPI_FILE              FILE *
505#define ACPI_FILE_OUT          stdout
506#define ACPI_FILE_ERR          stderr
507#else
508#define ACPI_FILE              void *
509#define ACPI_FILE_OUT          NULL
510#define ACPI_FILE_ERR          NULL
511#endif /* ACPI_APPLICATION */
512
513#ifndef ACPI_INIT_FUNCTION
514#define ACPI_INIT_FUNCTION
515#endif
516
517#endif /* __ACENV_H__ */
518