reactos/drivers/bus/acpi/acpica/include/platform/acenv.h

   1 /******************************************************************************
   2  *
   3  * Name: acenv.h - Host and compiler configuration
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #ifndef __ACENV_H__
 117 #define __ACENV_H__
 118
 119 /*
 120  * Environment configuration. The purpose of this file is to interface ACPICA
 121  * to the local environment. This includes compiler-specific, OS-specific,
 122  * and machine-specific configuration.
 123  */
 124
 125 /* Types for ACPI_MUTEX_TYPE */
 126
 127 #define ACPI_BINARY_SEMAPHORE       0
 128 #define ACPI_OSL_MUTEX              1
 129
 130 /* Types for DEBUGGER_THREADING */
 131
 132 #define DEBUGGER_SINGLE_THREADED    0
 133 #define DEBUGGER_MULTI_THREADED     1
 134
 135
 136 /******************************************************************************
 137  *
 138  * Configuration for ACPI tools and utilities
 139  *
 140  *****************************************************************************/
 141
 142 /* iASL configuration */
 143
 144 #ifdef ACPI_ASL_COMPILER
 145 #define ACPI_APPLICATION
 146 #define ACPI_DISASSEMBLER
 147 #define ACPI_DEBUG_OUTPUT
 148 #define ACPI_CONSTANT_EVAL_ONLY
 149 #define ACPI_LARGE_NAMESPACE_NODE
 150 #define ACPI_DATA_TABLE_DISASSEMBLY
 151 #define ACPI_SINGLE_THREADED
 152 #define ACPI_32BIT_PHYSICAL_ADDRESS
 153 #endif
 154
 155 /* AcpiExec configuration. Multithreaded with full AML debugger */
 156
 157 #ifdef ACPI_EXEC_APP
 158 #define ACPI_APPLICATION
 159 #define ACPI_FULL_DEBUG
 160 #define ACPI_MUTEX_DEBUG
 161 #define ACPI_DBG_TRACK_ALLOCATIONS
 162 #endif
 163
 164 /*
 165  * AcpiBin/AcpiDump/AcpiHelp/AcpiNames/AcpiSrc/AcpiXtract/Example configuration.
 166  * All single threaded.
 167  */
 168 #if (defined ACPI_BIN_APP)      || \
 169     (defined ACPI_DUMP_APP)     || \
 170     (defined ACPI_HELP_APP)     || \
 171     (defined ACPI_NAMES_APP)    || \
 172     (defined ACPI_SRC_APP)      || \
 173     (defined ACPI_XTRACT_APP)   || \
 174     (defined ACPI_EXAMPLE_APP)
 175 #define ACPI_APPLICATION
 176 #define ACPI_SINGLE_THREADED
 177 #endif
 178
 179 /* AcpiHelp configuration. Error messages disabled. */
 180
 181 #ifdef ACPI_HELP_APP
 182 #define ACPI_NO_ERROR_MESSAGES
 183 #endif
 184
 185 /* AcpiNames configuration. Debug output enabled. */
 186
 187 #ifdef ACPI_NAMES_APP
 188 #define ACPI_DEBUG_OUTPUT
 189 #endif
 190
 191 /* AcpiExec/AcpiNames/Example configuration. Native RSDP used. */
 192
 193 #if (defined ACPI_EXEC_APP)     || \
 194     (defined ACPI_EXAMPLE_APP)  || \
 195     (defined ACPI_NAMES_APP)
 196 #define ACPI_USE_NATIVE_RSDP_POINTER
 197 #endif
 198
 199 /* AcpiDump configuration. Native mapping used if provied by OSPMs */
 200
 201 #ifdef ACPI_DUMP_APP
 202 #define ACPI_USE_NATIVE_MEMORY_MAPPING
 203 #define USE_NATIVE_ALLOCATE_ZEROED
 204 #endif
 205
 206 /* AcpiNames/Example configuration. Hardware disabled */
 207
 208 #if (defined ACPI_EXAMPLE_APP)  || \
 209     (defined ACPI_NAMES_APP)
 210 #define ACPI_REDUCED_HARDWARE 1
 211 #endif
 212
 213 /* Linkable ACPICA library */
 214
 215 #ifdef ACPI_LIBRARY
 216 #define ACPI_USE_LOCAL_CACHE
 217 #endif
 218
 219 /* Common for all ACPICA applications */
 220
 221 #ifdef ACPI_APPLICATION
 222 #define ACPI_USE_SYSTEM_CLIBRARY
 223 #define ACPI_USE_LOCAL_CACHE
 224 #endif
 225
 226 /* Common debug support */
 227
 228 #ifdef ACPI_FULL_DEBUG
 229 #define ACPI_DEBUGGER
 230 #define ACPI_DEBUG_OUTPUT
 231 #define ACPI_DISASSEMBLER
 232 #endif
 233
 234
 235 /*! [Begin] no source code translation */
 236
 237 /******************************************************************************
 238  *
 239  * Host configuration files. The compiler configuration files are included
 240  * by the host files.
 241  *
 242  *****************************************************************************/
 243
 244 #if defined(_LINUX) || defined(__linux__)
 245 #include "aclinux.h"
 246
 247 #elif defined(_APPLE) || defined(__APPLE__)
 248 #include "acmacosx.h"
 249
 250 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 251 #include "acfreebsd.h"
 252
 253 #elif defined(__NetBSD__)
 254 #include "acnetbsd.h"
 255
 256 #elif defined(__sun)
 257 #include "acsolaris.h"
 258
 259 #elif defined(MODESTO)
 260 #include "acmodesto.h"
 261
 262 #elif defined(NETWARE)
 263 #include "acnetware.h"
 264
 265 #elif defined(_CYGWIN)
 266 #include "accygwin.h"
 267
 268 #elif defined(WIN32)
 269 #include "acwin.h"
 270
 271 #elif defined(WIN64)
 272 #include "acwin64.h"
 273
 274 #elif defined(_WRS_LIB_BUILD)
 275 #include "acvxworks.h"
 276
 277 #elif defined(__OS2__)
 278 #include "acos2.h"
 279
 280 #elif defined(_AED_EFI)
 281 #include "acefi.h"
 282
 283 #elif defined(_GNU_EFI)
 284 #include "acefi.h"
 285
 286 #elif defined(__HAIKU__)
 287 #include "achaiku.h"
 288
 289 #else
 290
 291 /* Unknown environment */
 292
 293 #error Unknown target environment
 294 #endif
 295
 296 /*! [End] no source code translation !*/
 297
 298
 299 /******************************************************************************
 300  *
 301  * Setup defaults for the required symbols that were not defined in one of
 302  * the host/compiler files above.
 303  *
 304  *****************************************************************************/
 305
 306 /* 64-bit data types */
 307
 308 #ifndef COMPILER_DEPENDENT_INT64
 309 #define COMPILER_DEPENDENT_INT64   long long
 310 #endif
 311
 312 #ifndef COMPILER_DEPENDENT_UINT64
 313 #define COMPILER_DEPENDENT_UINT64  unsigned long long
 314 #endif
 315
 316 /* Type of mutex supported by host. Default is binary semaphores. */
 317
 318 #ifndef ACPI_MUTEX_TYPE
 319 #ifdef __REACTOS__
 320 #define ACPI_MUTEX_TYPE             ACPI_OSL_MUTEX
 321 #else
 322 #define ACPI_MUTEX_TYPE             ACPI_BINARY_SEMAPHORE
 323 #endif /* __REACTOS__ */
 324 #endif
 325
 326 /* Global Lock acquire/release */
 327
 328 #ifndef ACPI_ACQUIRE_GLOBAL_LOCK
 329 #define ACPI_ACQUIRE_GLOBAL_LOCK(GLptr, Acquired) Acquired = 1
 330 #endif
 331
 332 #ifndef ACPI_RELEASE_GLOBAL_LOCK
 333 #define ACPI_RELEASE_GLOBAL_LOCK(GLptr, Pending) Pending = 0
 334 #endif
 335
 336 /* Flush CPU cache - used when going to sleep. Wbinvd or similar. */
 337
 338 #ifndef ACPI_FLUSH_CPU_CACHE
 339 #define ACPI_FLUSH_CPU_CACHE()
 340 #endif
 341
 342 /* "inline" keywords - configurable since inline is not standardized */
 343
 344 #ifndef ACPI_INLINE
 345 #define ACPI_INLINE
 346 #endif
 347
 348 /*
 349  * Configurable calling conventions:
 350  *
 351  * ACPI_SYSTEM_XFACE        - Interfaces to host OS (handlers, threads)
 352  * ACPI_EXTERNAL_XFACE      - External ACPI interfaces
 353  * ACPI_INTERNAL_XFACE      - Internal ACPI interfaces
 354  * ACPI_INTERNAL_VAR_XFACE  - Internal variable-parameter list interfaces
 355  */
 356 #ifndef ACPI_SYSTEM_XFACE
 357 #define ACPI_SYSTEM_XFACE
 358 #endif
 359
 360 #ifndef ACPI_EXTERNAL_XFACE
 361 #define ACPI_EXTERNAL_XFACE
 362 #endif
 363
 364 #ifndef ACPI_INTERNAL_XFACE
 365 #define ACPI_INTERNAL_XFACE
 366 #endif
 367
 368 #ifndef ACPI_INTERNAL_VAR_XFACE
 369 #define ACPI_INTERNAL_VAR_XFACE
 370 #endif
 371
 372 /*
 373  * Debugger threading model
 374  * Use single threaded if the entire subsystem is contained in an application
 375  * Use multiple threaded when the subsystem is running in the kernel.
 376  *
 377  * By default the model is single threaded if ACPI_APPLICATION is set,
 378  * multi-threaded if ACPI_APPLICATION is not set.
 379  */
 380 #ifndef DEBUGGER_THREADING
 381 #ifdef ACPI_APPLICATION
 382 #define DEBUGGER_THREADING          DEBUGGER_SINGLE_THREADED
 383
 384 #else
 385 #define DEBUGGER_THREADING          DEBUGGER_MULTI_THREADED
 386 #endif
 387 #endif /* !DEBUGGER_THREADING */
 388
 389
 390 /******************************************************************************
 391  *
 392  * C library configuration
 393  *
 394  *****************************************************************************/
 395
 396 /*
 397  * ACPI_USE_SYSTEM_CLIBRARY - Define this if linking to an actual C library.
 398  *      Otherwise, local versions of string/memory functions will be used.
 399  * ACPI_USE_STANDARD_HEADERS - Define this if linking to a C library and
 400  *      the standard header files may be used.
 401  *
 402  * The ACPICA subsystem only uses low level C library functions that do not call
 403  * operating system services and may therefore be inlined in the code.
 404  *
 405  * It may be necessary to tailor these include files to the target
 406  * generation environment.
 407  */
 408 #ifdef ACPI_USE_SYSTEM_CLIBRARY
 409
 410 /* Use the standard C library headers. We want to keep these to a minimum. */
 411
 412 #ifdef ACPI_USE_STANDARD_HEADERS
 413
 414 /* Use the standard headers from the standard locations */
 415
 416 #include <stdarg.h>
 417 #include <stdlib.h>
 418 #include <string.h>
 419 #include <ctype.h>
 420
 421 #endif /* ACPI_USE_STANDARD_HEADERS */
 422
 423 /* We will be linking to the standard Clib functions */
 424
 425 #define ACPI_STRSTR(s1,s2)      strstr((s1), (s2))
 426 #define ACPI_STRCHR(s1,c)       strchr((s1), (c))
 427 #define ACPI_STRLEN(s)          (ACPI_SIZE) strlen((s))
 428 #define ACPI_STRCPY(d,s)        (void) strcpy((d), (s))
 429 #define ACPI_STRNCPY(d,s,n)     (void) strncpy((d), (s), (ACPI_SIZE)(n))
 430 #define ACPI_STRNCMP(d,s,n)     strncmp((d), (s), (ACPI_SIZE)(n))
 431 #define ACPI_STRCMP(d,s)        strcmp((d), (s))
 432 #define ACPI_STRCAT(d,s)        (void) strcat((d), (s))
 433 #define ACPI_STRNCAT(d,s,n)     strncat((d), (s), (ACPI_SIZE)(n))
 434 #define ACPI_STRTOUL(d,s,n)     strtoul((d), (s), (ACPI_SIZE)(n))
 435 #define ACPI_MEMCMP(s1,s2,n)    memcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
 436 #define ACPI_MEMCPY(d,s,n)      (void) memcpy((d), (s), (ACPI_SIZE)(n))
 437 #define ACPI_MEMSET(d,s,n)      (void) memset((d), (s), (ACPI_SIZE)(n))
 438 #define ACPI_TOUPPER(i)         toupper((int) (i))
 439 #define ACPI_TOLOWER(i)         tolower((int) (i))
 440 #define ACPI_IS_XDIGIT(i)       isxdigit((int) (i))
 441 #define ACPI_IS_DIGIT(i)        isdigit((int) (i))
 442 #define ACPI_IS_SPACE(i)        isspace((int) (i))
 443 #define ACPI_IS_UPPER(i)        isupper((int) (i))
 444 #define ACPI_IS_PRINT(i)        isprint((int) (i))
 445 #define ACPI_IS_ALPHA(i)        isalpha((int) (i))
 446
 447 #else
 448
 449 /******************************************************************************
 450  *
 451  * Not using native C library, use local implementations
 452  *
 453  *****************************************************************************/
 454
 455 /*
 456  * Use local definitions of C library macros and functions. These function
 457  * implementations may not be as efficient as an inline or assembly code
 458  * implementation provided by a native C library, but they are functionally
 459  * equivalent.
 460  */
 461 #ifndef va_arg
 462
 463 #ifndef _VALIST
 464 #define _VALIST
 465 typedef char *va_list;
 466 #endif /* _VALIST */
 467
 468 /* Storage alignment properties */
 469
 470 #define  _AUPBND                (sizeof (ACPI_NATIVE_INT) - 1)
 471 #define  _ADNBND                (sizeof (ACPI_NATIVE_INT) - 1)
 472
 473 /* Variable argument list macro definitions */
 474
 475 #define _Bnd(X, bnd)            (((sizeof (X)) + (bnd)) & (~(bnd)))
 476 #define va_arg(ap, T)           (*(T *)(((ap) += (_Bnd (T, _AUPBND))) - (_Bnd (T,_ADNBND))))
 477 #define va_end(ap)              (ap = (va_list) NULL)
 478 #define va_start(ap, A)         (void) ((ap) = (((char *) &(A)) + (_Bnd (A,_AUPBND))))
 479
 480 #endif /* va_arg */
 481
 482 /* Use the local (ACPICA) definitions of the clib functions */
 483
 484 #define ACPI_STRSTR(s1,s2)      AcpiUtStrstr ((s1), (s2))
 485 #define ACPI_STRCHR(s1,c)       AcpiUtStrchr ((s1), (c))
 486 #define ACPI_STRLEN(s)          (ACPI_SIZE) AcpiUtStrlen ((s))
 487 #define ACPI_STRCPY(d,s)        (void) AcpiUtStrcpy ((d), (s))
 488 #define ACPI_STRNCPY(d,s,n)     (void) AcpiUtStrncpy ((d), (s), (ACPI_SIZE)(n))
 489 #define ACPI_STRNCMP(d,s,n)     AcpiUtStrncmp ((d), (s), (ACPI_SIZE)(n))
 490 #define ACPI_STRCMP(d,s)        AcpiUtStrcmp ((d), (s))
 491 #define ACPI_STRCAT(d,s)        (void) AcpiUtStrcat ((d), (s))
 492 #define ACPI_STRNCAT(d,s,n)     AcpiUtStrncat ((d), (s), (ACPI_SIZE)(n))
 493 #define ACPI_STRTOUL(d,s,n)     AcpiUtStrtoul ((d), (s), (ACPI_SIZE)(n))
 494 #define ACPI_MEMCMP(s1,s2,n)    AcpiUtMemcmp((const char *)(s1), (const char *)(s2), (ACPI_SIZE)(n))
 495 #define ACPI_MEMCPY(d,s,n)      (void) AcpiUtMemcpy ((d), (s), (ACPI_SIZE)(n))
 496 #define ACPI_MEMSET(d,v,n)      (void) AcpiUtMemset ((d), (v), (ACPI_SIZE)(n))
 497 #define ACPI_TOUPPER(c)         AcpiUtToUpper ((int) (c))
 498 #define ACPI_TOLOWER(c)         AcpiUtToLower ((int) (c))
 499
 500 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
 501
 502 #ifndef ACPI_FILE
 503 #ifdef ACPI_APPLICATION
 504 #include <stdio.h>
 505 #define ACPI_FILE              FILE *
 506 #define ACPI_FILE_OUT          stdout
 507 #define ACPI_FILE_ERR          stderr
 508 #else
 509 #define ACPI_FILE              void *
 510 #define ACPI_FILE_OUT          NULL
 511 #define ACPI_FILE_ERR          NULL
 512 #endif /* ACPI_APPLICATION */
 513 #endif /* ACPI_FILE */
 514
 515 #endif /* __ACENV_H__ */