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