| blob | 0f5cc558400dbf358b4d448300b0685c463e96ab |
1 /******************************************************************************
2 *
3 * Name: acenv.h - Generation environment specific items
4 * $Revision: 1.130 $
5 *
6 *****************************************************************************/
8 /******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
117 #ifndef __ACENV_H__
118 #define __ACENV_H__
121 /*
122 * Configuration for ACPI tools and utilities
123 */
125 #ifdef ACPI_LIBRARY
126 /*
127 * Note: The non-debug version of the AcpiLibrary does not contain any
128 * debug support, for minimimal size. The debug version uses ACPI_FULL_DEBUG
129 */
130 #define ACPI_USE_LOCAL_CACHE
131 #endif
133 #ifdef ACPI_ASL_COMPILER
134 #define ACPI_DEBUG_OUTPUT
135 #define ACPI_APPLICATION
136 #define ACPI_DISASSEMBLER
137 #define ACPI_CONSTANT_EVAL_ONLY
138 #define ACPI_LARGE_NAMESPACE_NODE
139 #define ACPI_DATA_TABLE_DISASSEMBLY
140 #endif
142 #ifdef ACPI_EXEC_APP
143 #undef DEBUGGER_THREADING
144 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
145 #define ACPI_FULL_DEBUG
146 #define ACPI_APPLICATION
147 #define ACPI_DEBUGGER
148 #define ACPI_MUTEX_DEBUG
149 #define ACPI_DBG_TRACK_ALLOCATIONS
150 #endif
152 #ifdef ACPI_DASM_APP
153 #ifndef MSDOS
154 #define ACPI_DEBUG_OUTPUT
155 #endif
156 #define ACPI_APPLICATION
157 #define ACPI_DISASSEMBLER
158 #define ACPI_NO_METHOD_EXECUTION
159 #define ACPI_LARGE_NAMESPACE_NODE
160 #define ACPI_DATA_TABLE_DISASSEMBLY
161 #endif
163 #ifdef ACPI_APPLICATION
164 #define ACPI_USE_SYSTEM_CLIBRARY
165 #define ACPI_USE_LOCAL_CACHE
166 #endif
168 #ifdef ACPI_FULL_DEBUG
169 #define ACPI_DEBUGGER
170 #define ACPI_DEBUG_OUTPUT
171 #define ACPI_DISASSEMBLER
172 #endif
175 /*
176 * Environment configuration. The purpose of this file is to interface to the
177 * local generation environment.
178 *
179 * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
180 * Otherwise, local versions of string/memory functions will be used.
181 * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
182 * the standard header files may be used.
183 *
184 * The ACPI subsystem only uses low level C library functions that do not call
185 * operating system services and may therefore be inlined in the code.
186 *
187 * It may be necessary to tailor these include files to the target
188 * generation environment.
189 *
190 *
191 * Functions and constants used from each header:
192 *
193 * string.h: memcpy
194 * memset
195 * strcat
196 * strcmp
197 * strcpy
198 * strlen
199 * strncmp
200 * strncat
201 * strncpy
202 *
203 * stdlib.h: strtoul
204 *
205 * stdarg.h: va_list
206 * va_arg
207 * va_start
208 * va_end
209 *
210 */
212 /*! [Begin] no source code translation */
214 #if defined(__linux__)
217 #elif defined(_AED_EFI)
220 #elif defined(WIN32)
223 #elif defined(WIN64)
229 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
232 #elif defined(__NetBSD__)
235 #elif defined(MODESTO)
238 #elif defined(NETWARE)
241 #elif defined(__sun)
244 #else
246 /* All other environments */
248 #define ACPI_USE_STANDARD_HEADERS
250 #define COMPILER_DEPENDENT_INT64 long long
251 #define COMPILER_DEPENDENT_UINT64 unsigned long long
253 #endif
255 /*! [End] no source code translation !*/
258 /*
259 * Debugger threading model
260 * Use single threaded if the entire subsystem is contained in an application
261 * Use multiple threaded when the subsystem is running in the kernel.
262 *
263 * By default the model is single threaded if ACPI_APPLICATION is set,
264 * multi-threaded if ACPI_APPLICATION is not set.
265 */
266 #define DEBUGGER_SINGLE_THREADED 0
267 #define DEBUGGER_MULTI_THREADED 1
269 #ifndef DEBUGGER_THREADING
270 #ifdef ACPI_APPLICATION
271 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED
273 #else
274 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED
275 #endif
279 /******************************************************************************
280 *
281 * C library configuration
282 *
283 *****************************************************************************/
285 #define ACPI_IS_ASCII(c) ((c) < 0x80)
287 #ifdef ACPI_USE_SYSTEM_CLIBRARY
288 /*
289 * Use the standard C library headers.
290 * We want to keep these to a minimum.
291 */
292 #ifdef ACPI_USE_STANDARD_HEADERS
293 /*
294 * Use the standard headers from the standard locations
295 */
296 #include <stdarg.h>
297 #include <stdlib.h>
298 #include <string.h>
299 #include <ctype.h>
303 /*
304 * We will be linking to the standard Clib functions
305 */
306 #define ACPI_STRSTR(s1,s2) strstr((s1), (s2))
307 #define ACPI_STRCHR(s1,c) strchr((s1), (c))
308 #define ACPI_STRLEN(s) (ACPI_SIZE) strlen((s))
309 #define ACPI_STRCPY(d,s) (void) strcpy((d), (s))
310 #define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (ACPI_SIZE)(n))
311 #define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (ACPI_SIZE)(n))
312 #define ACPI_STRCMP(d,s) strcmp((d), (s))
313 #define ACPI_STRCAT(d,s) (void) strcat((d), (s))
314 #define ACPI_STRNCAT(d,s,n) strncat((d), (s), (ACPI_SIZE)(n))
315 #define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (ACPI_SIZE)(n))
316 #define ACPI_MEMCMP(s1,s2,n) memcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
317 #define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (ACPI_SIZE)(n))
318 #define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (ACPI_SIZE)(n))
320 #define ACPI_TOUPPER(i) toupper((int) (i))
321 #define ACPI_TOLOWER(i) tolower((int) (i))
322 #define ACPI_IS_XDIGIT(i) isxdigit((int) (i))
323 #define ACPI_IS_DIGIT(i) isdigit((int) (i))
324 #define ACPI_IS_SPACE(i) isspace((int) (i))
325 #define ACPI_IS_UPPER(i) isupper((int) (i))
326 #define ACPI_IS_PRINT(i) isprint((int) (i))
327 #define ACPI_IS_ALPHA(i) isalpha((int) (i))
329 #else
331 /******************************************************************************
332 *
333 * Not using native C library, use local implementations
334 *
335 *****************************************************************************/
337 /*
338 * Use local definitions of C library macros and functions
339 * NOTE: The function implementations may not be as efficient
340 * as an inline or assembly code implementation provided by a
341 * native C library.
342 */
344 #ifndef va_arg
346 #ifndef _VALIST
347 #define _VALIST
351 /*
352 * Storage alignment properties
353 */
354 #define _AUPBND (sizeof (ACPI_NATIVE_INT) - 1)
355 #define _ADNBND (sizeof (ACPI_NATIVE_INT) - 1)
357 /*
358 * Variable argument list macro definitions
359 */
360 #define _Bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd)))
361 #define va_arg(ap, T) (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
362 #define va_end(ap) (void) 0
363 #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
368 #define ACPI_STRSTR(s1,s2) AcpiUtStrstr ((s1), (s2))
369 #define ACPI_STRCHR(s1,c) AcpiUtStrchr ((s1), (c))
370 #define ACPI_STRLEN(s) (ACPI_SIZE) AcpiUtStrlen ((s))
371 #define ACPI_STRCPY(d,s) (void) AcpiUtStrcpy ((d), (s))
372 #define ACPI_STRNCPY(d,s,n) (void) AcpiUtStrncpy ((d), (s), (ACPI_SIZE)(n))
373 #define ACPI_STRNCMP(d,s,n) AcpiUtStrncmp ((d), (s), (ACPI_SIZE)(n))
374 #define ACPI_STRCMP(d,s) AcpiUtStrcmp ((d), (s))
375 #define ACPI_STRCAT(d,s) (void) AcpiUtStrcat ((d), (s))
376 #define ACPI_STRNCAT(d,s,n) AcpiUtStrncat ((d), (s), (ACPI_SIZE)(n))
377 #define ACPI_STRTOUL(d,s,n) AcpiUtStrtoul ((d), (s), (ACPI_SIZE)(n))
378 #define ACPI_MEMCMP(s1,s2,n) AcpiUtMemcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
379 #define ACPI_MEMCPY(d,s,n) (void) AcpiUtMemcpy ((d), (s), (ACPI_SIZE)(n))
380 #define ACPI_MEMSET(d,v,n) (void) AcpiUtMemset ((d), (v), (ACPI_SIZE)(n))
381 #define ACPI_TOUPPER AcpiUtToUpper
382 #define ACPI_TOLOWER AcpiUtToLower
387 /******************************************************************************
388 *
389 * Assembly code macros
390 *
391 *****************************************************************************/
393 /*
394 * Handle platform- and compiler-specific assembly language differences.
395 * These should already have been defined by the platform includes above.
396 *
397 * Notes:
398 * 1) Interrupt 3 is used to break into a debugger
399 * 2) Interrupts are turned off during ACPI register setup
400 */
402 /* Unrecognized compiler, use defaults */
404 #ifndef ACPI_ASM_MACROS
406 /*
407 * Calling conventions:
408 *
409 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads)
410 * ACPI_EXTERNAL_XFACE - External ACPI interfaces
411 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces
412 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces
413 */
414 #define ACPI_SYSTEM_XFACE
415 #define ACPI_EXTERNAL_XFACE
416 #define ACPI_INTERNAL_XFACE
417 #define ACPI_INTERNAL_VAR_XFACE
419 #define ACPI_ASM_MACROS
420 #define BREAKPOINT3
421 #define ACPI_DISABLE_IRQS()
422 #define ACPI_ENABLE_IRQS()
423 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acq)
424 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Acq)
429 #ifdef ACPI_APPLICATION
431 /* Don't want software interrupts within a ring3 application */
433 #undef BREAKPOINT3
434 #define BREAKPOINT3
435 #endif
438 /******************************************************************************
439 *
440 * Compiler-specific information is contained in the compiler-specific
441 * headers.
442 *
443 *****************************************************************************/