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