acpi: Include acdragonfly.h from acenv.h.
[dragonfly.git] / sys / contrib / dev / acpica-unix / include / platform / acenv.h
CommitLineData
02dd1afe
SZ
1/******************************************************************************
2 *
3 * Name: acenv.h - Host and compiler configuration
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
29bac728 11 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
02dd1afe
SZ
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
29bac728 151#define ACPI_SINGLE_THREADED
02dd1afe
SZ
152#endif
153
29bac728 154/* AcpiExec and AcpiBin configuration */
02dd1afe
SZ
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
29bac728
MA
163#ifdef ACPI_BIN_APP
164#define ACPI_APPLICATION
165#define ACPI_SINGLE_THREADED
166#endif
167
02dd1afe
SZ
168/* Linkable ACPICA library */
169
170#ifdef ACPI_LIBRARY
171#define ACPI_USE_LOCAL_CACHE
172#endif
173
174/* Common for all ACPICA applications */
175
176#ifdef ACPI_APPLICATION
177#define ACPI_USE_SYSTEM_CLIBRARY
178#define ACPI_USE_LOCAL_CACHE
179#endif
180
181/* Common debug support */
182
183#ifdef ACPI_FULL_DEBUG
184#define ACPI_DEBUGGER
185#define ACPI_DEBUG_OUTPUT
186#define ACPI_DISASSEMBLER
187#endif
188
189
190/*! [Begin] no source code translation */
191
192/******************************************************************************
193 *
194 * Host configuration files. The compiler configuration files are included
195 * by the host files.
196 *
197 *****************************************************************************/
198
199#if defined(_LINUX) || defined(__linux__)
200#include "aclinux.h"
201
202#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
203#include "acfreebsd.h"
204
72e57dee
SW
205#elif defined(__DragonFly__)
206#include "acdragonfly.h"
207
02dd1afe
SZ
208#elif defined(__NetBSD__)
209#include "acnetbsd.h"
210
211#elif defined(__sun)
212#include "acsolaris.h"
213
214#elif defined(MODESTO)
215#include "acmodesto.h"
216
217#elif defined(NETWARE)
218#include "acnetware.h"
219
220#elif defined(_CYGWIN)
221#include "accygwin.h"
222
223#elif defined(WIN32)
224#include "acwin.h"
225
226#elif defined(WIN64)
227#include "acwin64.h"
228
229#elif defined(_WRS_LIB_BUILD)
230#include "acvxworks.h"
231
232#elif defined(__OS2__)
233#include "acos2.h"
234
235#elif defined(_AED_EFI)
236#include "acefi.h"
237
238#else
239
240/* Unknown environment */
241
242#error Unknown target environment
243#endif
244
245/*! [End] no source code translation !*/
246
247
248/******************************************************************************
249 *
250 * Setup defaults for the required symbols that were not defined in one of
251 * the host/compiler files above.
252 *
253 *****************************************************************************/
254
255/* 64-bit data types */
256
257#ifndef COMPILER_DEPENDENT_INT64
258#define COMPILER_DEPENDENT_INT64 long long
259#endif
260
261#ifndef COMPILER_DEPENDENT_UINT64
262#define COMPILER_DEPENDENT_UINT64 unsigned long long
263#endif
264
265/* Type of mutex supported by host. Default is binary semaphores. */
266
267#ifndef ACPI_MUTEX_TYPE
268#define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE
269#endif
270
271/* Global Lock acquire/release */
272
273#ifndef ACPI_ACQUIRE_GLOBAL_LOCK
29bac728 274#define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
02dd1afe
SZ
275#endif
276
277#ifndef ACPI_RELEASE_GLOBAL_LOCK
29bac728 278#define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
02dd1afe
SZ
279#endif
280
281/* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
282
283#ifndef ACPI_FLUSH_CPU_CACHE
284#define ACPI_FLUSH_CPU_CACHE()
285#endif
286
29bac728
MA
287/* "inline" keywords - configurable since inline is not standardized */
288
289#ifndef ACPI_INLINE
290#define ACPI_INLINE
291#endif
292
02dd1afe
SZ
293/*
294 * Configurable calling conventions:
295 *
296 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
297 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
298 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
299 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
300 */
301#ifndef ACPI_SYSTEM_XFACE
302#define ACPI_SYSTEM_XFACE
303#endif
304
305#ifndef ACPI_EXTERNAL_XFACE
306#define ACPI_EXTERNAL_XFACE
307#endif
308
309#ifndef ACPI_INTERNAL_XFACE
310#define ACPI_INTERNAL_XFACE
311#endif
312
313#ifndef ACPI_INTERNAL_VAR_XFACE
314#define ACPI_INTERNAL_VAR_XFACE
315#endif
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#ifdef ACPI_APPLICATION
327#define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
328
329#else
330#define DEBUGGER_THREADING DEBUGGER_MULTI_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.
346 *
347 * The ACPICA subsystem only uses low level C library functions that do not call
348 * operating system services and may therefore be inlined in the code.
349 *
350 * It may be necessary to tailor these include files to the target
351 * generation environment.
352 */
353#ifdef ACPI_USE_SYSTEM_CLIBRARY
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 <stdarg.h>
362#include <stdlib.h>
363#include <string.h>
364#include <ctype.h>
365
366#endif /* ACPI_USE_STANDARD_HEADERS */
367
368/* We will be linking to the standard Clib functions */
369
370#define ACPI_STRSTR(s1,s2) strstr((s1), (s2))
371#define ACPI_STRCHR(s1,c) strchr((s1), (c))
372#define ACPI_STRLEN(s) (ACPI_SIZE) strlen((s))
373#define ACPI_STRCPY(d,s) (void) strcpy((d), (s))
374#define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (ACPI_SIZE)(n))
375#define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (ACPI_SIZE)(n))
376#define ACPI_STRCMP(d,s) strcmp((d), (s))
377#define ACPI_STRCAT(d,s) (void) strcat((d), (s))
378#define ACPI_STRNCAT(d,s,n) strncat((d), (s), (ACPI_SIZE)(n))
379#define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (ACPI_SIZE)(n))
380#define ACPI_MEMCMP(s1,s2,n) memcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
381#define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (ACPI_SIZE)(n))
382#define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (ACPI_SIZE)(n))
383#define ACPI_TOUPPER(i) toupper((int) (i))
384#define ACPI_TOLOWER(i) tolower((int) (i))
385#define ACPI_IS_XDIGIT(i) isxdigit((int) (i))
386#define ACPI_IS_DIGIT(i) isdigit((int) (i))
387#define ACPI_IS_SPACE(i) isspace((int) (i))
388#define ACPI_IS_UPPER(i) isupper((int) (i))
389#define ACPI_IS_PRINT(i) isprint((int) (i))
390#define ACPI_IS_ALPHA(i) isalpha((int) (i))
391
392#else
393
394/******************************************************************************
395 *
396 * Not using native C library, use local implementations
397 *
398 *****************************************************************************/
399
400/*
401 * Use local definitions of C library macros and functions. These function
402 * implementations may not be as efficient as an inline or assembly code
403 * implementation provided by a native C library, but they are functionally
404 * equivalent.
405 */
406#ifndef va_arg
407
408#ifndef _VALIST
409#define _VALIST
410typedef char *va_list;
411#endif /* _VALIST */
412
413/* Storage alignment properties */
414
415#define _AUPBND (sizeof (ACPI_NATIVE_INT) - 1)
416#define _ADNBND (sizeof (ACPI_NATIVE_INT) - 1)
417
418/* Variable argument list macro definitions */
419
420#define _Bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
421#define va_arg(ap, T) (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
422#define va_end(ap) (void) 0
423#define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
424
425#endif /* va_arg */
426
427/* Use the local (ACPICA) definitions of the clib functions */
428
429#define ACPI_STRSTR(s1,s2) AcpiUtStrstr ((s1), (s2))
430#define ACPI_STRCHR(s1,c) AcpiUtStrchr ((s1), (c))
431#define ACPI_STRLEN(s) (ACPI_SIZE) AcpiUtStrlen ((s))
432#define ACPI_STRCPY(d,s) (void) AcpiUtStrcpy ((d), (s))
433#define ACPI_STRNCPY(d,s,n) (void) AcpiUtStrncpy ((d), (s), (ACPI_SIZE)(n))
434#define ACPI_STRNCMP(d,s,n) AcpiUtStrncmp ((d), (s), (ACPI_SIZE)(n))
435#define ACPI_STRCMP(d,s) AcpiUtStrcmp ((d), (s))
436#define ACPI_STRCAT(d,s) (void) AcpiUtStrcat ((d), (s))
437#define ACPI_STRNCAT(d,s,n) AcpiUtStrncat ((d), (s), (ACPI_SIZE)(n))
438#define ACPI_STRTOUL(d,s,n) AcpiUtStrtoul ((d), (s), (ACPI_SIZE)(n))
439#define ACPI_MEMCMP(s1,s2,n) AcpiUtMemcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
440#define ACPI_MEMCPY(d,s,n) (void) AcpiUtMemcpy ((d), (s), (ACPI_SIZE)(n))
441#define ACPI_MEMSET(d,v,n) (void) AcpiUtMemset ((d), (v), (ACPI_SIZE)(n))
29bac728
MA
442#define ACPI_TOUPPER(c) AcpiUtToUpper ((int) (c))
443#define ACPI_TOLOWER(c) AcpiUtToLower ((int) (c))
02dd1afe
SZ
444
445#endif /* ACPI_USE_SYSTEM_CLIBRARY */
446
447#endif /* __ACENV_H__ */