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