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