xref: /freebsd/sys/contrib/dev/acpica/include/platform/acenv.h (revision 6b129086dcee14496517fae085b448e3edc69bc7)
1 /******************************************************************************
2  *
3  * Name: acenv.h - Host and compiler configuration
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, 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 /* iASL configuration */
71 
72 #ifdef ACPI_ASL_COMPILER
73 #define ACPI_APPLICATION
74 #define ACPI_DISASSEMBLER
75 #define ACPI_DEBUG_OUTPUT
76 #define ACPI_CONSTANT_EVAL_ONLY
77 #define ACPI_LARGE_NAMESPACE_NODE
78 #define ACPI_DATA_TABLE_DISASSEMBLY
79 #define ACPI_SINGLE_THREADED
80 #endif
81 
82 /* AcpiExec configuration. Multithreaded with full AML debugger */
83 
84 #ifdef ACPI_EXEC_APP
85 #define ACPI_APPLICATION
86 #define ACPI_FULL_DEBUG
87 #define ACPI_MUTEX_DEBUG
88 #define ACPI_DBG_TRACK_ALLOCATIONS
89 #endif
90 
91 /*
92  * AcpiBin/AcpiDump/AcpiHelp/AcpiNames/AcpiSrc/AcpiXtract/Example configuration.
93  * All single threaded.
94  */
95 #if (defined ACPI_BIN_APP)      || \
96     (defined ACPI_DUMP_APP)     || \
97     (defined ACPI_HELP_APP)     || \
98     (defined ACPI_NAMES_APP)    || \
99     (defined ACPI_SRC_APP)      || \
100     (defined ACPI_XTRACT_APP)   || \
101     (defined ACPI_EXAMPLE_APP)
102 #define ACPI_APPLICATION
103 #define ACPI_SINGLE_THREADED
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 provied by OSPMs */
127 
128 #ifdef ACPI_DUMP_APP
129 #define ACPI_USE_NATIVE_MEMORY_MAPPING
130 #define USE_NATIVE_ALLOCATE_ZEROED
131 #endif
132 
133 /* AcpiNames/Example configuration. Hardware disabled */
134 
135 #if (defined ACPI_EXAMPLE_APP)  || \
136     (defined ACPI_NAMES_APP)
137 #define ACPI_REDUCED_HARDWARE 1
138 #endif
139 
140 /* Linkable ACPICA library */
141 
142 #ifdef ACPI_LIBRARY
143 #define ACPI_USE_LOCAL_CACHE
144 #endif
145 
146 /* Common for all ACPICA applications */
147 
148 #ifdef ACPI_APPLICATION
149 #define ACPI_USE_SYSTEM_CLIBRARY
150 #define ACPI_USE_LOCAL_CACHE
151 #endif
152 
153 /* Common debug support */
154 
155 #ifdef ACPI_FULL_DEBUG
156 #define ACPI_DEBUGGER
157 #define ACPI_DEBUG_OUTPUT
158 #define ACPI_DISASSEMBLER
159 #endif
160 
161 
162 /*! [Begin] no source code translation */
163 
164 /******************************************************************************
165  *
166  * Host configuration files. The compiler configuration files are included
167  * by the host files.
168  *
169  *****************************************************************************/
170 
171 #if defined(_LINUX) || defined(__linux__)
172 #include "aclinux.h"
173 
174 #elif defined(_APPLE) || defined(__APPLE__)
175 #include "acmacosx.h"
176 
177 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
178 #include <contrib/dev/acpica/include/platform/acfreebsd.h>
179 
180 #elif defined(__NetBSD__)
181 #include "acnetbsd.h"
182 
183 #elif defined(__sun)
184 #include "acsolaris.h"
185 
186 #elif defined(MODESTO)
187 #include "acmodesto.h"
188 
189 #elif defined(NETWARE)
190 #include "acnetware.h"
191 
192 #elif defined(_CYGWIN)
193 #include "accygwin.h"
194 
195 #elif defined(WIN32)
196 #include "acwin.h"
197 
198 #elif defined(WIN64)
199 #include "acwin64.h"
200 
201 #elif defined(_WRS_LIB_BUILD)
202 #include "acvxworks.h"
203 
204 #elif defined(__OS2__)
205 #include "acos2.h"
206 
207 #elif defined(_AED_EFI)
208 #include "acefi.h"
209 
210 #elif defined(_GNU_EFI)
211 #include "acefi.h"
212 
213 #elif defined(__HAIKU__)
214 #include "achaiku.h"
215 
216 #else
217 
218 /* Unknown environment */
219 
220 #error Unknown target environment
221 #endif
222 
223 /*! [End] no source code translation !*/
224 
225 
226 /******************************************************************************
227  *
228  * Setup defaults for the required symbols that were not defined in one of
229  * the host/compiler files above.
230  *
231  *****************************************************************************/
232 
233 /* 64-bit data types */
234 
235 #ifndef COMPILER_DEPENDENT_INT64
236 #define COMPILER_DEPENDENT_INT64   long long
237 #endif
238 
239 #ifndef COMPILER_DEPENDENT_UINT64
240 #define COMPILER_DEPENDENT_UINT64  unsigned long long
241 #endif
242 
243 /* Type of mutex supported by host. Default is binary semaphores. */
244 
245 #ifndef ACPI_MUTEX_TYPE
246 #define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
247 #endif
248 
249 /* Global Lock acquire/release */
250 
251 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK
252 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
253 #endif
254 
255 #ifndef ACPI_RELEASE_GLOBAL_LOCK
256 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
257 #endif
258 
259 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
260 
261 #ifndef ACPI_FLUSH_CPU_CACHE
262 #define ACPI_FLUSH_CPU_CACHE()
263 #endif
264 
265 /* "inline" keywords - configurable since inline is not standardized */
266 
267 #ifndef ACPI_INLINE
268 #define ACPI_INLINE
269 #endif
270 
271 /*
272  * Configurable calling conventions:
273  *
274  * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
275  * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
276  * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
277  * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
278  */
279 #ifndef ACPI_SYSTEM_XFACE
280 #define ACPI_SYSTEM_XFACE
281 #endif
282 
283 #ifndef ACPI_EXTERNAL_XFACE
284 #define ACPI_EXTERNAL_XFACE
285 #endif
286 
287 #ifndef ACPI_INTERNAL_XFACE
288 #define ACPI_INTERNAL_XFACE
289 #endif
290 
291 #ifndef ACPI_INTERNAL_VAR_XFACE
292 #define ACPI_INTERNAL_VAR_XFACE
293 #endif
294 
295 /*
296  * Debugger threading model
297  * Use single threaded if the entire subsystem is contained in an application
298  * Use multiple threaded when the subsystem is running in the kernel.
299  *
300  * By default the model is single threaded if ACPI_APPLICATION is set,
301  * multi-threaded if ACPI_APPLICATION is not set.
302  */
303 #ifndef DEBUGGER_THREADING
304 #ifdef ACPI_APPLICATION
305 #define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
306 
307 #else
308 #define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
309 #endif
310 #endif /* !DEBUGGER_THREADING */
311 
312 
313 /******************************************************************************
314  *
315  * C library configuration
316  *
317  *****************************************************************************/
318 
319 /*
320  * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
321  *      Otherwise, local versions of string/memory functions will be used.
322  * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
323  *      the standard header files may be used.
324  *
325  * The ACPICA subsystem only uses low level C library functions that do not call
326  * operating system services and may therefore be inlined in the code.
327  *
328  * It may be necessary to tailor these include files to the target
329  * generation environment.
330  */
331 #ifdef ACPI_USE_SYSTEM_CLIBRARY
332 
333 /* Use the standard C library headers. We want to keep these to a minimum. */
334 
335 #ifdef ACPI_USE_STANDARD_HEADERS
336 
337 /* Use the standard headers from the standard locations */
338 
339 #include <stdarg.h>
340 #include <stdlib.h>
341 #include <string.h>
342 #include <ctype.h>
343 
344 #endif /* ACPI_USE_STANDARD_HEADERS */
345 
346 /* We will be linking to the standard Clib functions */
347 
348 #define ACPI_STRSTR(s1,s2)      strstr((s1), (s2))
349 #define ACPI_STRCHR(s1,c)       strchr((s1), (c))
350 #define ACPI_STRLEN(s)          (ACPI_SIZE) strlen((s))
351 #define ACPI_STRCPY(d,s)        (void) strcpy((d), (s))
352 #define ACPI_STRNCPY(d,s,n)     (void) strncpy((d), (s), (ACPI_SIZE)(n))
353 #define ACPI_STRNCMP(d,s,n)     strncmp((d), (s), (ACPI_SIZE)(n))
354 #define ACPI_STRCMP(d,s)        strcmp((d), (s))
355 #define ACPI_STRCAT(d,s)        (void) strcat((d), (s))
356 #define ACPI_STRNCAT(d,s,n)     strncat((d), (s), (ACPI_SIZE)(n))
357 #define ACPI_STRTOUL(d,s,n)     strtoul((d), (s), (ACPI_SIZE)(n))
358 #define ACPI_MEMCMP(s1,s2,n)    memcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
359 #define ACPI_MEMCPY(d,s,n)      (void) memcpy((d), (s), (ACPI_SIZE)(n))
360 #define ACPI_MEMSET(d,s,n)      (void) memset((d), (s), (ACPI_SIZE)(n))
361 #define ACPI_TOUPPER(i)         toupper((int) (i))
362 #define ACPI_TOLOWER(i)         tolower((int) (i))
363 #define ACPI_IS_XDIGIT(i)       isxdigit((int) (i))
364 #define ACPI_IS_DIGIT(i)        isdigit((int) (i))
365 #define ACPI_IS_SPACE(i)        isspace((int) (i))
366 #define ACPI_IS_UPPER(i)        isupper((int) (i))
367 #define ACPI_IS_PRINT(i)        isprint((int) (i))
368 #define ACPI_IS_ALPHA(i)        isalpha((int) (i))
369 
370 #else
371 
372 /******************************************************************************
373  *
374  * Not using native C library, use local implementations
375  *
376  *****************************************************************************/
377 
378 /*
379  * Use local definitions of C library macros and functions. These function
380  * implementations may not be as efficient as an inline or assembly code
381  * implementation provided by a native C library, but they are functionally
382  * equivalent.
383  */
384 #ifndef va_arg
385 
386 #ifndef _VALIST
387 #define _VALIST
388 typedef char *va_list;
389 #endif /* _VALIST */
390 
391 /* Storage alignment properties */
392 
393 #define  _AUPBND                (sizeof (ACPI_NATIVE_INT) - 1)
394 #define  _ADNBND                (sizeof (ACPI_NATIVE_INT) - 1)
395 
396 /* Variable argument list macro definitions */
397 
398 #define _Bnd(X, bnd)            (((sizeof (X)) + (bnd)) & (~(bnd)))
399 #define va_arg(ap, T)           (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
400 #define va_end(ap)              (ap = (va_list) NULL)
401 #define va_start(ap, A)         (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
402 
403 #endif /* va_arg */
404 
405 /* Use the local (ACPICA) definitions of the clib functions */
406 
407 #define ACPI_STRSTR(s1,s2)      AcpiUtStrstr ((s1), (s2))
408 #define ACPI_STRCHR(s1,c)       AcpiUtStrchr ((s1), (c))
409 #define ACPI_STRLEN(s)          (ACPI_SIZE) AcpiUtStrlen ((s))
410 #define ACPI_STRCPY(d,s)        (void) AcpiUtStrcpy ((d), (s))
411 #define ACPI_STRNCPY(d,s,n)     (void) AcpiUtStrncpy ((d), (s), (ACPI_SIZE)(n))
412 #define ACPI_STRNCMP(d,s,n)     AcpiUtStrncmp ((d), (s), (ACPI_SIZE)(n))
413 #define ACPI_STRCMP(d,s)        AcpiUtStrcmp ((d), (s))
414 #define ACPI_STRCAT(d,s)        (void) AcpiUtStrcat ((d), (s))
415 #define ACPI_STRNCAT(d,s,n)     AcpiUtStrncat ((d), (s), (ACPI_SIZE)(n))
416 #define ACPI_STRTOUL(d,s,n)     AcpiUtStrtoul ((d), (s), (ACPI_SIZE)(n))
417 #define ACPI_MEMCMP(s1,s2,n)    AcpiUtMemcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
418 #define ACPI_MEMCPY(d,s,n)      (void) AcpiUtMemcpy ((d), (s), (ACPI_SIZE)(n))
419 #define ACPI_MEMSET(d,v,n)      (void) AcpiUtMemset ((d), (v), (ACPI_SIZE)(n))
420 #define ACPI_TOUPPER(c)         AcpiUtToUpper ((int) (c))
421 #define ACPI_TOLOWER(c)         AcpiUtToLower ((int) (c))
422 
423 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
424 
425 #ifndef ACPI_FILE
426 #ifdef ACPI_APPLICATION
427 #include <stdio.h>
428 #define ACPI_FILE              FILE *
429 #define ACPI_FILE_OUT          stdout
430 #define ACPI_FILE_ERR          stderr
431 #else
432 #define ACPI_FILE              void *
433 #define ACPI_FILE_OUT          NULL
434 #define ACPI_FILE_ERR          NULL
435 #endif /* ACPI_APPLICATION */
436 #endif /* ACPI_FILE */
437 
438 #endif /* __ACENV_H__ */
439