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