include/acpi/platform/acenv.h

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