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