acenv.h revision 67754
1/****************************************************************************** 2 * 3 * Name: acenv.h - Generation environment specific items 4 * $Revision: 61 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 13 * 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 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 143/* 144 * Environment configuration. The purpose of this file is to interface to the 145 * local generation environment. 146 * 147 * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library. 148 * Otherwise, local versions of string/memory functions will be used. 149 * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and 150 * the standard header files may be used. 151 * 152 * The ACPI subsystem only uses low level C library functions that do not call 153 * operating system services and may therefore be inlined in the code. 154 * 155 * It may be necessary to tailor these include files to the target 156 * generation environment. 157 * 158 * 159 * Functions and constants used from each header: 160 * 161 * string.h: memcpy 162 * memset 163 * strcat 164 * strcmp 165 * strcpy 166 * strlen 167 * strncmp 168 * strncat 169 * strncpy 170 * 171 * stdlib.h: strtoul 172 * 173 * stdarg.h: va_list 174 * va_arg 175 * va_start 176 * va_end 177 * 178 */ 179 180/*! [Begin] no source code translation */ 181 182#ifdef _LINUX 183#include "aclinux.h" 184 185#elif _AED_EFI 186#include "acefi.h" 187 188#elif WIN32 189#include "acwin.h" 190 191#elif __FreeBSD__ 192#include "acfreebsd.h" 193 194#else 195 196/* All other environments */ 197 198#define ACPI_USE_STANDARD_HEADERS 199 200/* Name of host operating system (returned by the _OS_ namespace object) */ 201 202#define ACPI_OS_NAME "Intel ACPI/CA Core Subsystem" 203 204#endif 205 206 207/*! [End] no source code translation !*/ 208 209/****************************************************************************** 210 * 211 * C library configuration 212 * 213 *****************************************************************************/ 214 215#ifdef ACPI_USE_SYSTEM_CLIBRARY 216/* 217 * Use the standard C library headers. 218 * We want to keep these to a minimum. 219 * 220 */ 221 222#ifdef ACPI_USE_STANDARD_HEADERS 223/* 224 * Use the standard headers from the standard locations 225 */ 226#include <stdarg.h> 227#include <stdlib.h> 228#include <string.h> 229#include <ctype.h> 230 231#endif /* ACPI_USE_STANDARD_HEADERS */ 232 233/* 234 * We will be linking to the standard Clib functions 235 */ 236 237#define STRSTR(s1,s2) strstr((s1), (s2)) 238#define STRUPR(s) strupr((s)) 239#define STRLEN(s) strlen((s)) 240#define STRCPY(d,s) strcpy((d), (s)) 241#define STRNCPY(d,s,n) strncpy((d), (s), (n)) 242#define STRNCMP(d,s,n) strncmp((d), (s), (n)) 243#define STRCMP(d,s) strcmp((d), (s)) 244#define STRCAT(d,s) strcat((d), (s)) 245#define STRNCAT(d,s,n) strncat((d), (s), (n)) 246#define STRTOUL(d,s,n) strtoul((d), (s), (n)) 247#define MEMCPY(d,s,n) memcpy((d), (s), (n)) 248#define MEMSET(d,s,n) memset((d), (s), (n)) 249#define TOUPPER toupper 250#define TOLOWER tolower 251 252 253/****************************************************************************** 254 * 255 * Not using native C library, use local implementations 256 * 257 *****************************************************************************/ 258#else 259 260/* 261 * Use local definitions of C library macros and functions 262 * NOTE: The function implementations may not be as efficient 263 * as an inline or assembly code implementation provided by a 264 * native C library. 265 */ 266 267#ifndef va_arg 268 269#ifndef _VALIST 270#define _VALIST 271typedef char *va_list; 272#endif /* _VALIST */ 273 274/* 275 * Storage alignment properties 276 */ 277 278#define _AUPBND (sizeof(int) - 1) 279#define _ADNBND (sizeof(int) - 1) 280 281/* 282 * Variable argument list macro definitions 283 */ 284 285#define _Bnd(X, bnd) (((sizeof(X)) + (bnd)) & (~(bnd))) 286#define va_arg(ap, T) (*(T *)(((ap)+=((_Bnd(T, _AUPBND)))-(_Bnd(T,_ADNBND))))) 287#define va_end(ap) (void)0 288#define va_start(ap, A) (void)((ap)=(((char*)&(A))+(_Bnd(A,_AUPBND)))) 289 290#endif /* va_arg */ 291 292 293#define STRSTR(s1,s2) AcpiCmStrstr ((s1), (s2)) 294#define STRUPR(s) AcpiCmStrupr ((s)) 295#define STRLEN(s) AcpiCmStrlen ((s)) 296#define STRCPY(d,s) AcpiCmStrcpy ((d), (s)) 297#define STRNCPY(d,s,n) AcpiCmStrncpy ((d), (s), (n)) 298#define STRNCMP(d,s,n) AcpiCmStrncmp ((d), (s), (n)) 299#define STRCMP(d,s) AcpiCmStrcmp ((d), (s)) 300#define STRCAT(d,s) AcpiCmStrcat ((d), (s)) 301#define STRNCAT(d,s,n) AcpiCmStrncat ((d), (s), (n)) 302#define STRTOUL(d,s,n) AcpiCmStrtoul ((d), (s),(n)) 303#define MEMCPY(d,s,n) AcpiCmMemcpy ((d), (s), (n)) 304#define MEMSET(d,v,n) AcpiCmMemset ((d), (v), (n)) 305#define TOUPPER AcpiCmToUpper 306#define TOLOWER AcpiCmToLower 307 308#endif /* ACPI_USE_SYSTEM_CLIBRARY */ 309 310 311/****************************************************************************** 312 * 313 * Assembly code macros 314 * 315 *****************************************************************************/ 316 317/* 318 * Handle platform- and compiler-specific assembly language differences. 319 * These should already have been defined by the platform includes above. 320 * 321 * Notes: 322 * 1) Interrupt 3 is used to break into a debugger 323 * 2) Interrupts are turned off during ACPI register setup 324 */ 325 326/* Unrecognized compiler, use defaults */ 327#ifndef ACPI_ASM_MACROS 328 329#define ACPI_ASM_MACROS 330#define causeinterrupt(level) 331#define BREAKPOINT3 332#define disable() 333#define enable() 334#define halt() 335#define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acq) 336#define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Acq) 337 338#endif /* ACPI_ASM_MACROS */ 339 340 341#ifdef ACPI_APPLICATION 342 343/* Don't want software interrupts within a ring3 application */ 344 345#undef causeinterrupt 346#undef BREAKPOINT3 347#define causeinterrupt(level) 348#define BREAKPOINT3 349#endif 350 351 352/****************************************************************************** 353 * 354 * Compiler-specific 355 * 356 *****************************************************************************/ 357 358/* this has been moved to compiler-specific headers, which are included from the 359 platform header. */ 360 361 362 363/* TBD: move this elsewhere! */ 364 365#ifdef __ia64__ 366/* Look at interim FADT to determine IO or memory mapped */ 367#define IoAddressSpace(flag) (AcpiGbl_FACP->AddressSpace & flag) 368#else 369/* always IO space */ 370#define IoAddressSpace(flag) (1) 371#endif 372 373 374#endif /* __ACENV_H__ */ 375