include/acpi/platform/acenv.h

   1 /******************************************************************************
   2  *
   3  * Name: acenv.h - Host and compiler configuration
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, 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 /* Common application configuration. All single threaded except for acpi_exec. */
  70
  71 #if (defined ACPI_ASL_COMPILER) || \
  72         (defined ACPI_BIN_APP)      || \
  73         (defined ACPI_DUMP_APP)     || \
  74         (defined ACPI_HELP_APP)     || \
  75         (defined ACPI_NAMES_APP)    || \
  76         (defined ACPI_SRC_APP)      || \
  77         (defined ACPI_XTRACT_APP)   || \
  78         (defined ACPI_EXAMPLE_APP)
  79 #define ACPI_APPLICATION
  80 #define ACPI_SINGLE_THREADED
  81 #define USE_NATIVE_ALLOCATE_ZEROED
  82 #endif
  83
  84 /* iASL configuration */
  85
  86 #ifdef ACPI_ASL_COMPILER
  87 #define ACPI_DEBUG_OUTPUT
  88 #define ACPI_CONSTANT_EVAL_ONLY
  89 #define ACPI_LARGE_NAMESPACE_NODE
  90 #define ACPI_DATA_TABLE_DISASSEMBLY
  91 #define ACPI_32BIT_PHYSICAL_ADDRESS
  92 #define ACPI_DISASSEMBLER 1
  93 #endif
  94
  95 /* acpi_exec configuration. Multithreaded with full AML debugger */
  96
  97 #ifdef ACPI_EXEC_APP
  98 #define ACPI_APPLICATION
  99 #define ACPI_FULL_DEBUG
 100 #define ACPI_MUTEX_DEBUG
 101 #define ACPI_DBG_TRACK_ALLOCATIONS
 102 #endif
 103
 104 /* acpi_help configuration. Error messages disabled. */
 105
 106 #ifdef ACPI_HELP_APP
 107 #define ACPI_NO_ERROR_MESSAGES
 108 #endif
 109
 110 /* acpi_names configuration. Debug output enabled. */
 111
 112 #ifdef ACPI_NAMES_APP
 113 #define ACPI_DEBUG_OUTPUT
 114 #endif
 115
 116 /* acpi_exec/acpi_names/Example configuration. Native RSDP used. */
 117
 118 #if (defined ACPI_EXEC_APP)     || \
 119         (defined ACPI_EXAMPLE_APP)  || \
 120         (defined ACPI_NAMES_APP)
 121 #define ACPI_USE_NATIVE_RSDP_POINTER
 122 #endif
 123
 124 /* acpi_dump configuration. Native mapping used if provided by the host */
 125
 126 #ifdef ACPI_DUMP_APP
 127 #define ACPI_USE_NATIVE_MEMORY_MAPPING
 128 #endif
 129
 130 /* acpi_names/Example configuration. Hardware disabled */
 131
 132 #if (defined ACPI_EXAMPLE_APP)  || \
 133         (defined ACPI_NAMES_APP)
 134 #define ACPI_REDUCED_HARDWARE 1
 135 #endif
 136
 137 /* Linkable ACPICA library. Two versions, one with full debug. */
 138
 139 #ifdef ACPI_LIBRARY
 140 #define ACPI_USE_LOCAL_CACHE
 141 #define ACPI_DEBUGGER 1
 142 #define ACPI_DISASSEMBLER 1
 143
 144 #ifdef _DEBUG
 145 #define ACPI_DEBUG_OUTPUT
 146 #endif
 147 #endif
 148
 149 /* Common for all ACPICA applications */
 150
 151 #ifdef ACPI_APPLICATION
 152 #define ACPI_USE_LOCAL_CACHE
 153 #endif
 154
 155 /* Common debug/disassembler support */
 156
 157 #ifdef ACPI_FULL_DEBUG
 158 #define ACPI_DEBUG_OUTPUT
 159 #define ACPI_DEBUGGER 1
 160 #define ACPI_DISASSEMBLER 1
 161 #endif
 162
 163
 164 /*! [Begin] no source code translation */
 165
 166 /******************************************************************************
 167  *
 168  * Host configuration files. The compiler configuration files are included
 169  * first.
 170  *
 171  *****************************************************************************/
 172
 173 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
 174 #include <acpi/platform/acgcc.h>
 175
 176 #elif defined(_MSC_VER)
 177 #include "acmsvc.h"
 178
 179 #elif defined(__INTEL_COMPILER)
 180 #include "acintel.h"
 181
 182 #endif
 183
 184 #if defined(_LINUX) || defined(__linux__)
 185 #include <acpi/platform/aclinux.h>
 186
 187 #elif defined(_APPLE) || defined(__APPLE__)
 188 #include "acmacosx.h"
 189
 190 #elif defined(__DragonFly__)
 191 #include "acdragonfly.h"
 192
 193 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 194 #include "acfreebsd.h"
 195
 196 #elif defined(__NetBSD__)
 197 #include "acnetbsd.h"
 198
 199 #elif defined(__sun)
 200 #include "acsolaris.h"
 201
 202 #elif defined(MODESTO)
 203 #include "acmodesto.h"
 204
 205 #elif defined(NETWARE)
 206 #include "acnetware.h"
 207
 208 #elif defined(_CYGWIN)
 209 #include "accygwin.h"
 210
 211 #elif defined(WIN32)
 212 #include "acwin.h"
 213
 214 #elif defined(WIN64)
 215 #include "acwin64.h"
 216
 217 #elif defined(_WRS_LIB_BUILD)
 218 #include "acvxworks.h"
 219
 220 #elif defined(__OS2__)
 221 #include "acos2.h"
 222
 223 #elif defined(__HAIKU__)
 224 #include "achaiku.h"
 225
 226 #elif defined(__QNX__)
 227 #include "acqnx.h"
 228
 229 /*
 230  * EFI applications can be built with -nostdlib, in this case, it must be
 231  * included after including all other host environmental definitions, in
 232  * order to override the definitions.
 233  */
 234 #elif defined(_AED_EFI) || defined(_GNU_EFI) || defined(_EDK2_EFI)
 235 #include "acefi.h"
 236
 237 #else
 238
 239 /* Unknown environment */
 240
 241 #error Unknown target environment
 242 #endif
 243
 244 /*! [End] no source code translation !*/
 245
 246 /******************************************************************************
 247  *
 248  * Setup defaults for the required symbols that were not defined in one of
 249  * the host/compiler files above.
 250  *
 251  *****************************************************************************/
 252
 253 /* 64-bit data types */
 254
 255 #ifndef COMPILER_DEPENDENT_INT64
 256 #define COMPILER_DEPENDENT_INT64   long long
 257 #endif
 258
 259 #ifndef COMPILER_DEPENDENT_UINT64
 260 #define COMPILER_DEPENDENT_UINT64  unsigned long long
 261 #endif
 262
 263 /* Type of mutex supported by host. Default is binary semaphores. */
 264 #ifndef ACPI_MUTEX_TYPE
 265 #define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
 266 #endif
 267
 268 /* Global Lock acquire/release */
 269
 270 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK
 271 #define ACPI_ACQUIRE_GLOBAL_LOCK(Glptr, acquired) acquired = 1
 272 #endif
 273
 274 #ifndef ACPI_RELEASE_GLOBAL_LOCK
 275 #define ACPI_RELEASE_GLOBAL_LOCK(Glptr, pending) pending = 0
 276 #endif
 277
 278 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
 279
 280 #ifndef ACPI_FLUSH_CPU_CACHE
 281 #define ACPI_FLUSH_CPU_CACHE()
 282 #endif
 283
 284 /* "inline" keywords - configurable since inline is not standardized */
 285
 286 #ifndef ACPI_INLINE
 287 #define ACPI_INLINE
 288 #endif
 289
 290 /*
 291  * Configurable calling conventions:
 292  *
 293  * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
 294  * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
 295  * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
 296  * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
 297  */
 298 #ifndef ACPI_SYSTEM_XFACE
 299 #define ACPI_SYSTEM_XFACE
 300 #endif
 301
 302 #ifndef ACPI_EXTERNAL_XFACE
 303 #define ACPI_EXTERNAL_XFACE
 304 #endif
 305
 306 #ifndef ACPI_INTERNAL_XFACE
 307 #define ACPI_INTERNAL_XFACE
 308 #endif
 309
 310 #ifndef ACPI_INTERNAL_VAR_XFACE
 311 #define ACPI_INTERNAL_VAR_XFACE
 312 #endif
 313
 314 /*
 315  * Debugger threading model
 316  * Use single threaded if the entire subsystem is contained in an application
 317  * Use multiple threaded when the subsystem is running in the kernel.
 318  *
 319  * By default the model is single threaded if ACPI_APPLICATION is set,
 320  * multi-threaded if ACPI_APPLICATION is not set.
 321  */
 322 #ifndef DEBUGGER_THREADING
 323 #if !defined (ACPI_APPLICATION) || defined (ACPI_EXEC_APP)
 324 #define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
 325
 326 #else
 327 #define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
 328 #endif
 329 #endif                          /* !DEBUGGER_THREADING */
 330
 331 /******************************************************************************
 332  *
 333  * C library configuration
 334  *
 335  *****************************************************************************/
 336
 337 /*
 338  * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
 339  *      Otherwise, local versions of string/memory functions will be used.
 340  * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
 341  *      the standard header files may be used. Defining this implies that
 342  *      ACPI_USE_SYSTEM_CLIBRARY has been defined.
 343  *
 344  * The ACPICA subsystem only uses low level C library functions that do not
 345  * call operating system services and may therefore be inlined in the code.
 346  *
 347  * It may be necessary to tailor these include files to the target
 348  * generation environment.
 349  */
 350
 351 /* Use the standard C library headers. We want to keep these to a minimum. */
 352
 353 #ifdef ACPI_USE_STANDARD_HEADERS
 354
 355 /* Use the standard headers from the standard locations */
 356
 357 #include <stdlib.h>
 358 #include <string.h>
 359 #include <ctype.h>
 360 #ifdef ACPI_APPLICATION
 361 #include <stdio.h>
 362 #include <fcntl.h>
 363 #include <errno.h>
 364 #include <time.h>
 365 #include <signal.h>
 366 #endif
 367
 368 #endif                          /* ACPI_USE_STANDARD_HEADERS */
 369
 370 #ifdef ACPI_APPLICATION
 371 #define ACPI_FILE              FILE *
 372 #define ACPI_FILE_OUT          stdout
 373 #define ACPI_FILE_ERR          stderr
 374 #else
 375 #define ACPI_FILE              void *
 376 #define ACPI_FILE_OUT          NULL
 377 #define ACPI_FILE_ERR          NULL
 378 #endif                          /* ACPI_APPLICATION */
 379
 380 #ifndef ACPI_INIT_FUNCTION
 381 #define ACPI_INIT_FUNCTION
 382 #endif
 383
 384 #endif                          /* __ACENV_H__ */