1 /****************************************************************************** 2 * 3 * Name: acenv.h - Generation environment specific items 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2006, R. Byron Moore 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef __ACENV_H__ 45 #define __ACENV_H__ 46 47 /* 48 * Configuration for ACPI tools and utilities 49 */ 50 51 #ifdef ACPI_LIBRARY 52 #define ACPI_USE_LOCAL_CACHE 53 #endif 54 55 #ifdef ACPI_DUMP_APP 56 #ifndef MSDOS 57 #define ACPI_DEBUG_OUTPUT 58 #endif 59 #define ACPI_APPLICATION 60 #define ACPI_DISASSEMBLER 61 #define ACPI_NO_METHOD_EXECUTION 62 #endif 63 64 #ifdef ACPI_EXEC_APP 65 #undef DEBUGGER_THREADING 66 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED 67 #define ACPI_DEBUG_OUTPUT 68 #define ACPI_APPLICATION 69 #define ACPI_DEBUGGER 70 #define ACPI_DISASSEMBLER 71 #define ACPI_MUTEX_DEBUG 72 #endif 73 74 #ifdef ACPI_ASL_COMPILER 75 #define ACPI_DEBUG_OUTPUT 76 #define ACPI_APPLICATION 77 #define ACPI_DISASSEMBLER 78 #define ACPI_CONSTANT_EVAL_ONLY 79 #endif 80 81 #ifdef ACPI_APPLICATION 82 #define ACPI_USE_SYSTEM_CLIBRARY 83 #define ACPI_USE_LOCAL_CACHE 84 #endif 85 86 /* 87 * Environment configuration. The purpose of this file is to interface to the 88 * local generation environment. 89 * 90 * 1) ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library. 91 * Otherwise, local versions of string/memory functions will be used. 92 * 2) ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and 93 * the standard header files may be used. 94 * 95 * The ACPI subsystem only uses low level C library functions that do not call 96 * operating system services and may therefore be inlined in the code. 97 * 98 * It may be necessary to tailor these include files to the target 99 * generation environment. 100 * 101 * 102 * Functions and constants used from each header: 103 * 104 * string.h: memcpy 105 * memset 106 * strcat 107 * strcmp 108 * strcpy 109 * strlen 110 * strncmp 111 * strncat 112 * strncpy 113 * 114 * stdlib.h: strtoul 115 * 116 * stdarg.h: va_list 117 * va_arg 118 * va_start 119 * va_end 120 * 121 */ 122 123 /*! [Begin] no source code translation */ 124 125 #if defined(__linux__) 126 #include "aclinux.h" 127 128 #elif defined(_AED_EFI) 129 #include "acefi.h" 130 131 #elif defined(WIN32) 132 #include "acwin.h" 133 134 #elif defined(WIN64) 135 #include "acwin64.h" 136 137 #elif defined(MSDOS) /* Must appear after WIN32 and WIN64 check */ 138 #include "acdos16.h" 139 140 #elif defined(__FreeBSD__) 141 #include "acfreebsd.h" 142 143 #elif defined(__NetBSD__) 144 #include "acnetbsd.h" 145 146 #elif defined(MODESTO) 147 #include "acmodesto.h" 148 149 #elif defined(NETWARE) 150 #include "acnetware.h" 151 152 #elif defined(__sun) 153 #include "acsolaris.h" 154 155 #else 156 157 /* All other environments */ 158 159 #define ACPI_USE_STANDARD_HEADERS 160 161 #define COMPILER_DEPENDENT_INT64 long long 162 #define COMPILER_DEPENDENT_UINT64 unsigned long long 163 164 #endif 165 166 /* 167 * Memory allocation tracking. Used only if 168 * 1) This is the debug version 169 * 2) This is NOT a 16-bit version of the code (not enough real-mode memory) 170 */ 171 #ifdef ACPI_DEBUG_OUTPUT 172 #if ACPI_MACHINE_WIDTH != 16 173 #define ACPI_DBG_TRACK_ALLOCATIONS 174 #endif 175 #endif 176 177 /*! [End] no source code translation !*/ 178 179 /* 180 * Debugger threading model 181 * Use single threaded if the entire subsystem is contained in an application 182 * Use multiple threaded when the subsystem is running in the kernel. 183 * 184 * By default the model is single threaded if ACPI_APPLICATION is set, 185 * multi-threaded if ACPI_APPLICATION is not set. 186 */ 187 #define DEBUGGER_SINGLE_THREADED 0 188 #define DEBUGGER_MULTI_THREADED 1 189 190 #ifndef DEBUGGER_THREADING 191 #ifdef ACPI_APPLICATION 192 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED 193 194 #else 195 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED 196 #endif 197 #endif /* !DEBUGGER_THREADING */ 198 199 /****************************************************************************** 200 * 201 * C library configuration 202 * 203 *****************************************************************************/ 204 205 #define ACPI_IS_ASCII(c) ((c) < 0x80) 206 207 #ifdef ACPI_USE_SYSTEM_CLIBRARY 208 /* 209 * Use the standard C library headers. 210 * We want to keep these to a minimum. 211 */ 212 #ifdef ACPI_USE_STANDARD_HEADERS 213 /* 214 * Use the standard headers from the standard locations 215 */ 216 #include <stdarg.h> 217 #include <stdlib.h> 218 #include <string.h> 219 #include <ctype.h> 220 221 #endif /* ACPI_USE_STANDARD_HEADERS */ 222 223 /* 224 * We will be linking to the standard Clib functions 225 */ 226 #define ACPI_STRSTR(s1,s2) strstr((s1), (s2)) 227 #define ACPI_STRCHR(s1,c) strchr((s1), (c)) 228 #define ACPI_STRLEN(s) (acpi_size) strlen((s)) 229 #define ACPI_STRCPY(d,s) (void) strcpy((d), (s)) 230 #define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (acpi_size)(n)) 231 #define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (acpi_size)(n)) 232 #define ACPI_STRCMP(d,s) strcmp((d), (s)) 233 #define ACPI_STRCAT(d,s) (void) strcat((d), (s)) 234 #define ACPI_STRNCAT(d,s,n) strncat((d), (s), (acpi_size)(n)) 235 #define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (acpi_size)(n)) 236 #define ACPI_MEMCMP(s1,s2,n) memcmp((const char *)(s1), (const char *)(s2), (acpi_size)(n)) 237 #define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (acpi_size)(n)) 238 #define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (acpi_size)(n)) 239 240 #define ACPI_TOUPPER(i) toupper((int) (i)) 241 #define ACPI_TOLOWER(i) tolower((int) (i)) 242 #define ACPI_IS_XDIGIT(i) isxdigit((int) (i)) 243 #define ACPI_IS_DIGIT(i) isdigit((int) (i)) 244 #define ACPI_IS_SPACE(i) isspace((int) (i)) 245 #define ACPI_IS_UPPER(i) isupper((int) (i)) 246 #define ACPI_IS_PRINT(i) isprint((int) (i)) 247 #define ACPI_IS_ALPHA(i) isalpha((int) (i)) 248 249 #else 250 251 /****************************************************************************** 252 * 253 * Not using native C library, use local implementations 254 * 255 *****************************************************************************/ 256 257 /* 258 * Use local definitions of C library macros and functions 259 * NOTE: The function implementations may not be as efficient 260 * as an inline or assembly code implementation provided by a 261 * native C library. 262 */ 263 264 #ifndef va_arg 265 266 #ifndef _VALIST 267 #define _VALIST 268 typedef char *va_list; 269 #endif /* _VALIST */ 270 271 /* 272 * Storage alignment properties 273 */ 274 #define _AUPBND (sizeof (acpi_native_uint) - 1) 275 #define _ADNBND (sizeof (acpi_native_uint) - 1) 276 277 /* 278 * Variable argument list macro definitions 279 */ 280 #define _bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd))) 281 #define va_arg(ap, T) (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND)))) 282 #define va_end(ap) (void) 0 283 #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND)))) 284 285 #endif /* va_arg */ 286 287 #define ACPI_STRSTR(s1,s2) acpi_ut_strstr ((s1), (s2)) 288 #define ACPI_STRCHR(s1,c) acpi_ut_strchr ((s1), (c)) 289 #define ACPI_STRLEN(s) (acpi_size) acpi_ut_strlen ((s)) 290 #define ACPI_STRCPY(d,s) (void) acpi_ut_strcpy ((d), (s)) 291 #define ACPI_STRNCPY(d,s,n) (void) acpi_ut_strncpy ((d), (s), (acpi_size)(n)) 292 #define ACPI_STRNCMP(d,s,n) acpi_ut_strncmp ((d), (s), (acpi_size)(n)) 293 #define ACPI_STRCMP(d,s) acpi_ut_strcmp ((d), (s)) 294 #define ACPI_STRCAT(d,s) (void) acpi_ut_strcat ((d), (s)) 295 #define ACPI_STRNCAT(d,s,n) acpi_ut_strncat ((d), (s), (acpi_size)(n)) 296 #define ACPI_STRTOUL(d,s,n) acpi_ut_strtoul ((d), (s), (acpi_size)(n)) 297 #define ACPI_MEMCMP(s1,s2,n) acpi_ut_memcmp((const char *)(s1), (const char *)(s2), (acpi_size)(n)) 298 #define ACPI_MEMCPY(d,s,n) (void) acpi_ut_memcpy ((d), (s), (acpi_size)(n)) 299 #define ACPI_MEMSET(d,v,n) (void) acpi_ut_memset ((d), (v), (acpi_size)(n)) 300 #define ACPI_TOUPPER acpi_ut_to_upper 301 #define ACPI_TOLOWER acpi_ut_to_lower 302 303 #endif /* ACPI_USE_SYSTEM_CLIBRARY */ 304 305 /****************************************************************************** 306 * 307 * Assembly code macros 308 * 309 *****************************************************************************/ 310 311 /* 312 * Handle platform- and compiler-specific assembly language differences. 313 * These should already have been defined by the platform includes above. 314 * 315 * Notes: 316 * 1) Interrupt 3 is used to break into a debugger 317 * 2) Interrupts are turned off during ACPI register setup 318 */ 319 320 /* Unrecognized compiler, use defaults */ 321 322 #ifndef ACPI_ASM_MACROS 323 324 /* 325 * Calling conventions: 326 * 327 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads) 328 * ACPI_EXTERNAL_XFACE - External ACPI interfaces 329 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces 330 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces 331 */ 332 #define ACPI_SYSTEM_XFACE 333 #define ACPI_EXTERNAL_XFACE 334 #define ACPI_INTERNAL_XFACE 335 #define ACPI_INTERNAL_VAR_XFACE 336 337 #define ACPI_ASM_MACROS 338 #define BREAKPOINT3 339 #define ACPI_DISABLE_IRQS() 340 #define ACPI_ENABLE_IRQS() 341 #define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acq) 342 #define ACPI_RELEASE_GLOBAL_LOCK(Glptr, acq) 343 344 #endif /* ACPI_ASM_MACROS */ 345 346 #ifdef ACPI_APPLICATION 347 348 /* Don't want software interrupts within a ring3 application */ 349 350 #undef BREAKPOINT3 351 #define BREAKPOINT3 352 #endif 353 354 /****************************************************************************** 355 * 356 * Compiler-specific information is contained in the compiler-specific 357 * headers. 358 * 359 *****************************************************************************/ 360 #endif /* __ACENV_H__ */ 361