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