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