include/acpi/platform/acenv.h

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