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