1 /****************************************************************************** 2 * 3 * Name: acenv.h - Host and compiler configuration 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2013, Intel Corp. 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 * Environment configuration. The purpose of this file is to interface ACPICA 49 * to the local environment. This includes compiler-specific, OS-specific, 50 * and machine-specific configuration. 51 */ 52 53 /* Types for ACPI_MUTEX_TYPE */ 54 55 #define ACPI_BINARY_SEMAPHORE 0 56 #define ACPI_OSL_MUTEX 1 57 58 /* Types for DEBUGGER_THREADING */ 59 60 #define DEBUGGER_SINGLE_THREADED 0 61 #define DEBUGGER_MULTI_THREADED 1 62 63 /****************************************************************************** 64 * 65 * Configuration for ACPI tools and utilities 66 * 67 *****************************************************************************/ 68 69 /* iASL configuration */ 70 71 #ifdef ACPI_ASL_COMPILER 72 #define ACPI_APPLICATION 73 #define ACPI_DISASSEMBLER 74 #define ACPI_DEBUG_OUTPUT 75 #define ACPI_CONSTANT_EVAL_ONLY 76 #define ACPI_LARGE_NAMESPACE_NODE 77 #define ACPI_DATA_TABLE_DISASSEMBLY 78 #define ACPI_SINGLE_THREADED 79 #endif 80 81 /* acpi_exec configuration. Multithreaded with full AML debugger */ 82 83 #ifdef ACPI_EXEC_APP 84 #define ACPI_APPLICATION 85 #define ACPI_FULL_DEBUG 86 #define ACPI_MUTEX_DEBUG 87 #define ACPI_DBG_TRACK_ALLOCATIONS 88 #endif 89 90 /* acpi_names configuration. Single threaded with debugger output enabled. */ 91 92 #ifdef ACPI_NAMES_APP 93 #define ACPI_DEBUGGER 94 #define ACPI_APPLICATION 95 #define ACPI_SINGLE_THREADED 96 #endif 97 98 /* 99 * acpi_bin/acpi_dump/acpi_src/acpi_xtract configuration. All single 100 * threaded, with no debug output. 101 */ 102 #if (defined ACPI_BIN_APP) || \ 103 (defined ACPI_DUMP_APP) || \ 104 (defined ACPI_SRC_APP) || \ 105 (defined ACPI_XTRACT_APP) 106 #define ACPI_APPLICATION 107 #define ACPI_SINGLE_THREADED 108 #endif 109 110 #ifdef ACPI_HELP_APP 111 #define ACPI_APPLICATION 112 #define ACPI_SINGLE_THREADED 113 #define ACPI_NO_ERROR_MESSAGES 114 #endif 115 116 /* Linkable ACPICA library */ 117 118 #ifdef ACPI_LIBRARY 119 #define ACPI_USE_LOCAL_CACHE 120 #define ACPI_FUTURE_USAGE 121 #endif 122 123 /* Common for all ACPICA applications */ 124 125 #ifdef ACPI_APPLICATION 126 #define ACPI_USE_SYSTEM_CLIBRARY 127 #define ACPI_USE_LOCAL_CACHE 128 #endif 129 130 /* Common debug support */ 131 132 #ifdef ACPI_FULL_DEBUG 133 #define ACPI_DEBUGGER 134 #define ACPI_DEBUG_OUTPUT 135 #define ACPI_DISASSEMBLER 136 #endif 137 138 139 /*! [Begin] no source code translation */ 140 141 /****************************************************************************** 142 * 143 * Host configuration files. The compiler configuration files are included 144 * by the host files. 145 * 146 *****************************************************************************/ 147 148 #if defined(_LINUX) || defined(__linux__) 149 #include <acpi/platform/aclinux.h> 150 151 #elif defined(_APPLE) || defined(__APPLE__) 152 #include "acmacosx.h" 153 154 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) 155 #include "acfreebsd.h" 156 157 #elif defined(__NetBSD__) 158 #include "acnetbsd.h" 159 160 #elif defined(__sun) 161 #include "acsolaris.h" 162 163 #elif defined(MODESTO) 164 #include "acmodesto.h" 165 166 #elif defined(NETWARE) 167 #include "acnetware.h" 168 169 #elif defined(_CYGWIN) 170 #include "accygwin.h" 171 172 #elif defined(WIN32) 173 #include "acwin.h" 174 175 #elif defined(WIN64) 176 #include "acwin64.h" 177 178 #elif defined(_WRS_LIB_BUILD) 179 #include "acvxworks.h" 180 181 #elif defined(__OS2__) 182 #include "acos2.h" 183 184 #elif defined(_AED_EFI) 185 #include "acefi.h" 186 187 #elif defined(__HAIKU__) 188 #include "achaiku.h" 189 190 #else 191 192 /* Unknown environment */ 193 194 #error Unknown target environment 195 #endif 196 197 /*! [End] no source code translation !*/ 198 199 /****************************************************************************** 200 * 201 * Setup defaults for the required symbols that were not defined in one of 202 * the host/compiler files above. 203 * 204 *****************************************************************************/ 205 206 /* 64-bit data types */ 207 208 #ifndef COMPILER_DEPENDENT_INT64 209 #define COMPILER_DEPENDENT_INT64 long long 210 #endif 211 212 #ifndef COMPILER_DEPENDENT_UINT64 213 #define COMPILER_DEPENDENT_UINT64 unsigned long long 214 #endif 215 216 /* Type of mutex supported by host. Default is binary semaphores. */ 217 #ifndef ACPI_MUTEX_TYPE 218 #define ACPI_MUTEX_TYPE ACPI_BINARY_SEMAPHORE 219 #endif 220 221 /* Global Lock acquire/release */ 222 223 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK 224 #define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acquired) acquired = 1 225 #endif 226 227 #ifndef ACPI_RELEASE_GLOBAL_LOCK 228 #define ACPI_RELEASE_GLOBAL_LOCK(Glptr, pending) pending = 0 229 #endif 230 231 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */ 232 233 #ifndef ACPI_FLUSH_CPU_CACHE 234 #define ACPI_FLUSH_CPU_CACHE() 235 #endif 236 237 /* "inline" keywords - configurable since inline is not standardized */ 238 239 #ifndef ACPI_INLINE 240 #define ACPI_INLINE 241 #endif 242 243 /* 244 * Configurable calling conventions: 245 * 246 * ACPI_SYSTEM_XFACE - Interfaces to host OS (handlers, threads) 247 * ACPI_EXTERNAL_XFACE - External ACPI interfaces 248 * ACPI_INTERNAL_XFACE - Internal ACPI interfaces 249 * ACPI_INTERNAL_VAR_XFACE - Internal variable-parameter list interfaces 250 */ 251 #ifndef ACPI_SYSTEM_XFACE 252 #define ACPI_SYSTEM_XFACE 253 #endif 254 255 #ifndef ACPI_EXTERNAL_XFACE 256 #define ACPI_EXTERNAL_XFACE 257 #endif 258 259 #ifndef ACPI_INTERNAL_XFACE 260 #define ACPI_INTERNAL_XFACE 261 #endif 262 263 #ifndef ACPI_INTERNAL_VAR_XFACE 264 #define ACPI_INTERNAL_VAR_XFACE 265 #endif 266 267 /* 268 * Debugger threading model 269 * Use single threaded if the entire subsystem is contained in an application 270 * Use multiple threaded when the subsystem is running in the kernel. 271 * 272 * By default the model is single threaded if ACPI_APPLICATION is set, 273 * multi-threaded if ACPI_APPLICATION is not set. 274 */ 275 #ifndef DEBUGGER_THREADING 276 #ifdef ACPI_APPLICATION 277 #define DEBUGGER_THREADING DEBUGGER_SINGLE_THREADED 278 279 #else 280 #define DEBUGGER_THREADING DEBUGGER_MULTI_THREADED 281 #endif 282 #endif /* !DEBUGGER_THREADING */ 283 284 /****************************************************************************** 285 * 286 * C library configuration 287 * 288 *****************************************************************************/ 289 290 /* 291 * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library. 292 * Otherwise, local versions of string/memory functions will be used. 293 * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and 294 * the standard header files may be used. 295 * 296 * The ACPICA subsystem only uses low level C library functions that do not call 297 * operating system services and may therefore be inlined in the code. 298 * 299 * It may be necessary to tailor these include files to the target 300 * generation environment. 301 */ 302 #ifdef ACPI_USE_SYSTEM_CLIBRARY 303 304 /* Use the standard C library headers. We want to keep these to a minimum. */ 305 306 #ifdef ACPI_USE_STANDARD_HEADERS 307 308 /* Use the standard headers from the standard locations */ 309 310 #include <stdarg.h> 311 #include <stdlib.h> 312 #include <string.h> 313 #include <ctype.h> 314 315 #endif /* ACPI_USE_STANDARD_HEADERS */ 316 317 /* We will be linking to the standard Clib functions */ 318 319 #define ACPI_STRSTR(s1,s2) strstr((s1), (s2)) 320 #define ACPI_STRCHR(s1,c) strchr((s1), (c)) 321 #define ACPI_STRLEN(s) (acpi_size) strlen((s)) 322 #define ACPI_STRCPY(d,s) (void) strcpy((d), (s)) 323 #define ACPI_STRNCPY(d,s,n) (void) strncpy((d), (s), (acpi_size)(n)) 324 #define ACPI_STRNCMP(d,s,n) strncmp((d), (s), (acpi_size)(n)) 325 #define ACPI_STRCMP(d,s) strcmp((d), (s)) 326 #define ACPI_STRCAT(d,s) (void) strcat((d), (s)) 327 #define ACPI_STRNCAT(d,s,n) strncat((d), (s), (acpi_size)(n)) 328 #define ACPI_STRTOUL(d,s,n) strtoul((d), (s), (acpi_size)(n)) 329 #define ACPI_MEMCMP(s1,s2,n) memcmp((const char *)(s1), (const char *)(s2), (acpi_size)(n)) 330 #define ACPI_MEMCPY(d,s,n) (void) memcpy((d), (s), (acpi_size)(n)) 331 #define ACPI_MEMSET(d,s,n) (void) memset((d), (s), (acpi_size)(n)) 332 333 #define ACPI_TOUPPER(i) toupper((int) (i)) 334 #define ACPI_TOLOWER(i) tolower((int) (i)) 335 #define ACPI_IS_XDIGIT(i) isxdigit((int) (i)) 336 #define ACPI_IS_DIGIT(i) isdigit((int) (i)) 337 #define ACPI_IS_SPACE(i) isspace((int) (i)) 338 #define ACPI_IS_UPPER(i) isupper((int) (i)) 339 #define ACPI_IS_PRINT(i) isprint((int) (i)) 340 #define ACPI_IS_ALPHA(i) isalpha((int) (i)) 341 342 #else 343 344 /****************************************************************************** 345 * 346 * Not using native C library, use local implementations 347 * 348 *****************************************************************************/ 349 350 /* 351 * Use local definitions of C library macros and functions. These function 352 * implementations may not be as efficient as an inline or assembly code 353 * implementation provided by a native C library, but they are functionally 354 * equivalent. 355 */ 356 #ifndef va_arg 357 358 #ifndef _VALIST 359 #define _VALIST 360 typedef char *va_list; 361 #endif /* _VALIST */ 362 363 /* Storage alignment properties */ 364 365 #define _AUPBND (sizeof (acpi_native_int) - 1) 366 #define _ADNBND (sizeof (acpi_native_int) - 1) 367 368 /* Variable argument list macro definitions */ 369 370 #define _bnd(X, bnd) (((sizeof (X)) + (bnd)) & (~(bnd))) 371 #define va_arg(ap, T) (*(T *)(((ap) += (_bnd (T, _AUPBND))) - (_bnd (T,_ADNBND)))) 372 #define va_end(ap) (ap = (va_list) NULL) 373 #define va_start(ap, A) (void) ((ap) = (((char *) &(A)) + (_bnd (A,_AUPBND)))) 374 375 #endif /* va_arg */ 376 377 /* Use the local (ACPICA) definitions of the clib functions */ 378 379 #define ACPI_STRSTR(s1,s2) acpi_ut_strstr ((s1), (s2)) 380 #define ACPI_STRCHR(s1,c) acpi_ut_strchr ((s1), (c)) 381 #define ACPI_STRLEN(s) (acpi_size) acpi_ut_strlen ((s)) 382 #define ACPI_STRCPY(d,s) (void) acpi_ut_strcpy ((d), (s)) 383 #define ACPI_STRNCPY(d,s,n) (void) acpi_ut_strncpy ((d), (s), (acpi_size)(n)) 384 #define ACPI_STRNCMP(d,s,n) acpi_ut_strncmp ((d), (s), (acpi_size)(n)) 385 #define ACPI_STRCMP(d,s) acpi_ut_strcmp ((d), (s)) 386 #define ACPI_STRCAT(d,s) (void) acpi_ut_strcat ((d), (s)) 387 #define ACPI_STRNCAT(d,s,n) acpi_ut_strncat ((d), (s), (acpi_size)(n)) 388 #define ACPI_STRTOUL(d,s,n) acpi_ut_strtoul ((d), (s), (acpi_size)(n)) 389 #define ACPI_MEMCMP(s1,s2,n) acpi_ut_memcmp((const char *)(s1), (const char *)(s2), (acpi_size)(n)) 390 #define ACPI_MEMCPY(d,s,n) (void) acpi_ut_memcpy ((d), (s), (acpi_size)(n)) 391 #define ACPI_MEMSET(d,v,n) (void) acpi_ut_memset ((d), (v), (acpi_size)(n)) 392 #define ACPI_TOUPPER(c) acpi_ut_to_upper ((int) (c)) 393 #define ACPI_TOLOWER(c) acpi_ut_to_lower ((int) (c)) 394 395 #endif /* ACPI_USE_SYSTEM_CLIBRARY */ 396 397 #endif /* __ACENV_H__ */ 398