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