acenv.h revision 99679 
1/******************************************************************************
2 *
3 * Name: acenv.h - Generation environment specific items
4 *       $Revision: 95 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 *****************************************************************************/
116
117#ifndef __ACENV_H__
118#define __ACENV_H__
119
120
121/*
122 * Configuration for ACPI tools and utilities
123 */
124
125#ifdef _ACPI_DUMP_APP
126#define ACPI_DEBUG
127#define ACPI_APPLICATION
128#define ENABLE_DEBUGGER
129#define ACPI_USE_SYSTEM_CLIBRARY
130#define PARSER_ONLY
131#endif
132
133#ifdef _ACPI_EXEC_APP
134#undef DEBUGGER_THREADING
135#define DEBUGGER_THREADING      DEBUGGER_SINGLE_THREADED
136#define ACPI_DEBUG
137#define ACPI_APPLICATION
138#define ENABLE_DEBUGGER
139#define ACPI_USE_SYSTEM_CLIBRARY
140#endif
141
142#ifdef _ACPI_ASL_COMPILER
143#define ACPI_DEBUG
144#define ACPI_APPLICATION
145/* #define ENABLE_DEBUGGER */
146#define ACPI_USE_SYSTEM_CLIBRARY
147#endif
148
149/*
150 * Environment configuration.  The purpose of this file is to interface to the
151 * local generation environment.
152 *
153 * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
154 *      Otherwise, local versions of string/memory functions will be used.
155 * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
156 *      the standard header files may be used.
157 *
158 * The ACPI subsystem only uses low level C library functions that do not call
159 * operating system services and may therefore be inlined in the code.
160 *
161 * It may be necessary to tailor these include files to the target
162 * generation environment.
163 *
164 *
165 * Functions and constants used from each header:
166 *
167 * string.h:    memcpy
168 *              memset
169 *              strcat
170 *              strcmp
171 *              strcpy
172 *              strlen
173 *              strncmp
174 *              strncat
175 *              strncpy
176 *
177 * stdlib.h:    strtoul
178 *
179 * stdarg.h:    va_list
180 *              va_arg
181 *              va_start
182 *              va_end
183 *
184 */
185
186/*! [Begin] no source code translation */
187
188#if defined(_LINUX)
189#include "aclinux.h"
190
191#elif defined(_AED_EFI)
192#include "acefi.h"
193
194#elif defined(WIN32)
195#include "acwin.h"
196
197#elif defined(WIN64)
198#include "acwin64.h"
199
200#elif defined(MSDOS)        /* Must appear after WIN32 and WIN64 check */
201#include "acdos16.h"
202
203#elif defined(__FreeBSD__)
204#include "acfreebsd.h"
205
206#elif defined(MODESTO)
207#include "acmodesto.h"
208
209#elif defined(NETWARE)
210#include "acnetware.h"
211
212#else
213
214/* All other environments */
215
216#define ACPI_USE_STANDARD_HEADERS
217
218#define COMPILER_DEPENDENT_INT64   long long
219#define COMPILER_DEPENDENT_UINT64  unsigned long long
220
221
222/* Name of host operating system (returned by the _OS_ namespace object) */
223
224#define ACPI_OS_NAME         "Intel ACPI/CA Core Subsystem"
225
226/* This macro is used to tag functions as "printf-like" because
227 * some compilers can catch printf format string problems. MSVC
228 * doesn't, so this is proprocessed away.
229 */
230#define ACPI_PRINTF_LIKE_FUNC
231
232#endif
233
234/*
235 * Memory allocation tracking.  Used only if
236 * 1) This is the debug version
237 * 2) This is NOT a 16-bit version of the code (not enough real-mode memory)
238 */
239#ifdef ACPI_DEBUG
240#if ACPI_MACHINE_WIDTH != 16
241#define ACPI_DBG_TRACK_ALLOCATIONS
242#endif
243#endif
244
245/*! [End] no source code translation !*/
246
247
248/*
249 * Debugger threading model
250 * Use single threaded if the entire subsystem is contained in an application
251 * Use multiple threaded when the subsystem is running in the kernel.
252 *
253 * By default the model is single threaded if ACPI_APPLICATION is set,
254 * multi-threaded if ACPI_APPLICATION is not set.
255 */
256#define DEBUGGER_SINGLE_THREADED    0
257#define DEBUGGER_MULTI_THREADED     1
258
259#ifdef ACPI_APPLICATION
260#define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
261
262#else
263#define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
264#endif
265
266
267/******************************************************************************
268 *
269 * C library configuration
270 *
271 *****************************************************************************/
272
273#ifdef ACPI_USE_SYSTEM_CLIBRARY
274/*
275 * Use the standard C library headers.
276 * We want to keep these to a minimum.
277 *
278 */
279
280#ifdef ACPI_USE_STANDARD_HEADERS
281/*
282 * Use the standard headers from the standard locations
283 */
284#include <stdarg.h>
285#include <stdlib.h>
286#include <string.h>
287#include <ctype.h>
288
289#endif /* ACPI_USE_STANDARD_HEADERS */
290
291/*
292 * We will be linking to the standard Clib functions
293 */
294
295#define ACPI_STRSTR(s1,s2)      strstr((s1), (s2))
296#define ACPI_STRUPR(s)          (void) AcpiUtStrupr ((s))
297#define ACPI_STRLEN(s)          (ACPI_SIZE) strlen((s))
298#define ACPI_STRCPY(d,s)        (void) strcpy((d), (s))
299#define ACPI_STRNCPY(d,s,n)     (void) strncpy((d), (s), (ACPI_SIZE)(n))
300#define ACPI_STRNCMP(d,s,n)     strncmp((d), (s), (ACPI_SIZE)(n))
301#define ACPI_STRCMP(d,s)        strcmp((d), (s))
302#define ACPI_STRCAT(d,s)        (void) strcat((d), (s))
303#define ACPI_STRNCAT(d,s,n)     strncat((d), (s), (ACPI_SIZE)(n))
304#define ACPI_STRTOUL(d,s,n)     strtoul((d), (s), (ACPI_SIZE)(n))
305#define ACPI_MEMCPY(d,s,n)      (void) memcpy((d), (s), (ACPI_SIZE)(n))
306#define ACPI_MEMSET(d,s,n)      (void) memset((d), (s), (ACPI_SIZE)(n))
307#define ACPI_TOUPPER            toupper
308#define ACPI_TOLOWER            tolower
309#define ACPI_IS_XDIGIT          isxdigit
310#define ACPI_IS_DIGIT           isdigit
311#define ACPI_IS_SPACE           isspace
312#define ACPI_IS_UPPER           isupper
313
314/******************************************************************************
315 *
316 * Not using native C library, use local implementations
317 *
318 *****************************************************************************/
319#else
320
321/*
322 * Use local definitions of C library macros and functions
323 * NOTE: The function implementations may not be as efficient
324 * as an inline or assembly code implementation provided by a
325 * native C library.
326 */
327
328#ifndef va_arg
329
330#ifndef _VALIST
331#define _VALIST
332typedef char *va_list;
333#endif /* _VALIST */
334
335/*
336 * Storage alignment properties
337 */
338
339#define  _AUPBND                (sizeof (NATIVE_INT) - 1)
340#define  _ADNBND                (sizeof (NATIVE_INT) - 1)
341
342/*
343 * Variable argument list macro definitions
344 */
345
346#define _Bnd(X, bnd)            (((sizeof (X)) + (bnd)) & (~(bnd)))
347#define va_arg(ap, T)           (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
348#define va_end(ap)              (void) 0
349#define va_start(ap, A)         (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
350
351#endif /* va_arg */
352
353
354#define ACPI_STRSTR(s1,s2)      AcpiUtStrstr  ((s1), (s2))
355#define ACPI_STRUPR(s)          (void) AcpiUtStrupr ((s))
356#define ACPI_STRLEN(s)          (ACPI_SIZE) AcpiUtStrlen  ((s))
357#define ACPI_STRCPY(d,s)        (void) AcpiUtStrcpy  ((d), (s))
358#define ACPI_STRNCPY(d,s,n)     (void) AcpiUtStrncpy ((d), (s), (ACPI_SIZE)(n))
359#define ACPI_STRNCMP(d,s,n)     AcpiUtStrncmp ((d), (s), (ACPI_SIZE)(n))
360#define ACPI_STRCMP(d,s)        AcpiUtStrcmp  ((d), (s))
361#define ACPI_STRCAT(d,s)        (void) AcpiUtStrcat  ((d), (s))
362#define ACPI_STRNCAT(d,s,n)     AcpiUtStrncat ((d), (s), (ACPI_SIZE)(n))
363#define ACPI_STRTOUL(d,s,n)     AcpiUtStrtoul ((d), (s), (ACPI_SIZE)(n))
364#define ACPI_MEMCPY(d,s,n)      (void) AcpiUtMemcpy  ((d), (s), (ACPI_SIZE)(n))
365#define ACPI_MEMSET(d,v,n)      (void) AcpiUtMemset  ((d), (v), (ACPI_SIZE)(n))
366#define ACPI_TOUPPER            AcpiUtToUpper
367#define ACPI_TOLOWER            AcpiUtToLower
368
369#endif /* ACPI_USE_SYSTEM_CLIBRARY */
370
371
372/******************************************************************************
373 *
374 * Assembly code macros
375 *
376 *****************************************************************************/
377
378/*
379 * Handle platform- and compiler-specific assembly language differences.
380 * These should already have been defined by the platform includes above.
381 *
382 * Notes:
383 * 1) Interrupt 3 is used to break into a debugger
384 * 2) Interrupts are turned off during ACPI register setup
385 */
386
387/* Unrecognized compiler, use defaults */
388
389#ifndef ACPI_ASM_MACROS
390
391/*
392 * Calling conventions:
393 *
394 * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
395 * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
396 * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
397 * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
398 */
399#define ACPI_SYSTEM_XFACE
400#define ACPI_EXTERNAL_XFACE
401#define ACPI_INTERNAL_XFACE
402#define ACPI_INTERNAL_VAR_XFACE
403
404#define ACPI_ASM_MACROS
405#define BREAKPOINT3
406#define ACPI_DISABLE_IRQS()
407#define ACPI_ENABLE_IRQS()
408#define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acq)
409#define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Acq)
410
411#endif /* ACPI_ASM_MACROS */
412
413
414#ifdef ACPI_APPLICATION
415
416/* Don't want software interrupts within a ring3 application */
417
418#undef BREAKPOINT3
419#define BREAKPOINT3
420#endif
421
422
423/******************************************************************************
424 *
425 * Compiler-specific information is contained in the compiler-specific
426 * headers.
427 *
428 *****************************************************************************/
429#endif /* __ACENV_H__ */
430