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