include/acpi/platform/acenv.h

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