sys/contrib/dev/acpica/source/include/actypes.h

   1 /******************************************************************************
   2  *
   3  * Name: actypes.h - Common data types for the entire ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2014, 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 __ACTYPES_H__
  45 #define __ACTYPES_H__
  46
  47 /* acpisrc:StructDefs -- for acpisrc conversion */
  48
  49 /*
  50  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
  51  * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
  52  * 12/2006.
  53  */
  54 #ifndef ACPI_MACHINE_WIDTH
  55 #error ACPI_MACHINE_WIDTH not defined
  56 #endif
  57
  58 /*! [Begin] no source code translation */
  59
  60 /*
  61  * Data type ranges
  62  * Note: These macros are designed to be compiler independent as well as
  63  * working around problems that some 32-bit compilers have with 64-bit
  64  * constants.
  65  */
  66 #define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
  67 #define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
  68 #define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
  69 #define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
  70 #define ACPI_ASCII_MAX                  0x7F
  71
  72
  73 /*
  74  * Architecture-specific ACPICA Subsystem Data Types
  75  *
  76  * The goal of these types is to provide source code portability across
  77  * 16-bit, 32-bit, and 64-bit targets.
  78  *
  79  * 1) The following types are of fixed size for all targets (16/32/64):
  80  *
  81  * BOOLEAN      Logical boolean
  82  *
  83  * UINT8        8-bit  (1 byte) unsigned value
  84  * UINT16       16-bit (2 byte) unsigned value
  85  * UINT32       32-bit (4 byte) unsigned value
  86  * UINT64       64-bit (8 byte) unsigned value
  87  *
  88  * INT16        16-bit (2 byte) signed value
  89  * INT32        32-bit (4 byte) signed value
  90  * INT64        64-bit (8 byte) signed value
  91  *
  92  * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
  93  * compiler-dependent header(s) and were introduced because there is no common
  94  * 64-bit integer type across the various compilation models, as shown in
  95  * the table below.
  96  *
  97  * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
  98  * char      8    8     8     8     8    8
  99  * short     16   16    16    16    16   16
 100  * _int32         32
 101  * int       32   64    32    32    16   16
 102  * long      64   64    32    32    32   32
 103  * long long            64    64
 104  * pointer   64   64    64    32    32   32
 105  *
 106  * Note: ILP64 and LP32 are currently not supported.
 107  *
 108  *
 109  * 2) These types represent the native word size of the target mode of the
 110  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
 111  * usually used for memory allocation, efficient loop counters, and array
 112  * indexes. The types are similar to the size_t type in the C library and are
 113  * required because there is no C type that consistently represents the native
 114  * data width. ACPI_SIZE is needed because there is no guarantee that a
 115  * kernel-level C library is present.
 116  *
 117  * ACPI_SIZE        16/32/64-bit unsigned value
 118  * ACPI_NATIVE_INT  16/32/64-bit signed value
 119  */
 120
 121 /*******************************************************************************
 122  *
 123  * Common types for all compilers, all targets
 124  *
 125  ******************************************************************************/
 126
 127 typedef unsigned char                   BOOLEAN;
 128 typedef unsigned char                   UINT8;
 129 typedef unsigned short                  UINT16;
 130 typedef COMPILER_DEPENDENT_UINT64       UINT64;
 131 typedef COMPILER_DEPENDENT_INT64        INT64;
 132
 133 /*! [End] no source code translation !*/
 134
 135 /*
 136  * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
 137  * across operating systems or even the various UNIX systems. Since ACPICA
 138  * only needs the thread ID as a unique thread identifier, we use a UINT64
 139  * as the only common data type - it will accommodate any type of pointer or
 140  * any type of integer. It is up to the host-dependent OSL to cast the
 141  * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
 142  */
 143 #define ACPI_THREAD_ID                  UINT64
 144
 145
 146 /*******************************************************************************
 147  *
 148  * Types specific to 64-bit targets
 149  *
 150  ******************************************************************************/
 151
 152 #if ACPI_MACHINE_WIDTH == 64
 153
 154 /*! [Begin] no source code translation (keep the typedefs as-is) */
 155
 156 typedef unsigned int                    UINT32;
 157 typedef int                             INT32;
 158
 159 /*! [End] no source code translation !*/
 160
 161
 162 typedef INT64                           ACPI_NATIVE_INT;
 163 typedef UINT64                          ACPI_SIZE;
 164 typedef UINT64                          ACPI_IO_ADDRESS;
 165 typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
 166
 167 #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
 168 #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
 169 #define ACPI_USE_NATIVE_DIVIDE          /* Has native 64-bit integer support */
 170
 171 /*
 172  * In the case of the Itanium Processor Family (IPF), the hardware does not
 173  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
 174  * to indicate that special precautions must be taken to avoid alignment faults.
 175  * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
 176  *
 177  * Note: EM64T and other X86-64 processors support misaligned transfers,
 178  * so there is no need to define this flag.
 179  */
 180 #if defined (__IA64__) || defined (__ia64__)
 181 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
 182 #endif
 183
 184
 185 /*******************************************************************************
 186  *
 187  * Types specific to 32-bit targets
 188  *
 189  ******************************************************************************/
 190
 191 #elif ACPI_MACHINE_WIDTH == 32
 192
 193 /*! [Begin] no source code translation (keep the typedefs as-is) */
 194
 195 typedef unsigned int                    UINT32;
 196 typedef int                             INT32;
 197
 198 /*! [End] no source code translation !*/
 199
 200
 201 typedef INT32                           ACPI_NATIVE_INT;
 202 typedef UINT32                          ACPI_SIZE;
 203 typedef UINT32                          ACPI_IO_ADDRESS;
 204 typedef UINT32                          ACPI_PHYSICAL_ADDRESS;
 205
 206 #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
 207 #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
 208
 209 #else
 210
 211 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
 212
 213 #error unknown ACPI_MACHINE_WIDTH
 214 #endif
 215
 216
 217 /*******************************************************************************
 218  *
 219  * OS-dependent types
 220  *
 221  * If the defaults below are not appropriate for the host system, they can
 222  * be defined in the OS-specific header, and this will take precedence.
 223  *
 224  ******************************************************************************/
 225
 226 /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
 227
 228 #ifndef ACPI_CPU_FLAGS
 229 #define ACPI_CPU_FLAGS                  ACPI_SIZE
 230 #endif
 231
 232 /* Object returned from AcpiOsCreateCache */
 233
 234 #ifndef ACPI_CACHE_T
 235 #ifdef ACPI_USE_LOCAL_CACHE
 236 #define ACPI_CACHE_T                    ACPI_MEMORY_LIST
 237 #else
 238 #define ACPI_CACHE_T                    void *
 239 #endif
 240 #endif
 241
 242 /*
 243  * Synchronization objects - Mutexes, Semaphores, and SpinLocks
 244  */
 245 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
 246 /*
 247  * These macros are used if the host OS does not support a mutex object.
 248  * Map the OSL Mutex interfaces to binary semaphores.
 249  */
 250 #define ACPI_MUTEX                      ACPI_SEMAPHORE
 251 #define AcpiOsCreateMutex(OutHandle)    AcpiOsCreateSemaphore (1, 1, OutHandle)
 252 #define AcpiOsDeleteMutex(Handle)       (void) AcpiOsDeleteSemaphore (Handle)
 253 #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
 254 #define AcpiOsReleaseMutex(Handle)      (void) AcpiOsSignalSemaphore (Handle, 1)
 255 #endif
 256
 257 /* Configurable types for synchronization objects */
 258
 259 #ifndef ACPI_SPINLOCK
 260 #define ACPI_SPINLOCK                   void *
 261 #endif
 262
 263 #ifndef ACPI_SEMAPHORE
 264 #define ACPI_SEMAPHORE                  void *
 265 #endif
 266
 267 #ifndef ACPI_MUTEX
 268 #define ACPI_MUTEX                      void *
 269 #endif
 270
 271
 272 /*******************************************************************************
 273  *
 274  * Compiler-dependent types
 275  *
 276  * If the defaults below are not appropriate for the host compiler, they can
 277  * be defined in the compiler-specific header, and this will take precedence.
 278  *
 279  ******************************************************************************/
 280
 281 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
 282
 283 #ifndef ACPI_UINTPTR_T
 284 #define ACPI_UINTPTR_T                  void *
 285 #endif
 286
 287 /*
 288  * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
 289  * some compilers can catch printf format string problems
 290  */
 291 #ifndef ACPI_PRINTF_LIKE
 292 #define ACPI_PRINTF_LIKE(c)
 293 #endif
 294
 295 /*
 296  * Some compilers complain about unused variables. Sometimes we don't want to
 297  * use all the variables (for example, _AcpiModuleName). This allows us
 298  * to tell the compiler in a per-variable manner that a variable
 299  * is unused
 300  */
 301 #ifndef ACPI_UNUSED_VAR
 302 #define ACPI_UNUSED_VAR
 303 #endif
 304
 305 /*
 306  * All ACPICA external functions that are available to the rest of the kernel
 307  * are tagged with thes macros which can be defined as appropriate for the host.
 308  *
 309  * Notes:
 310  * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
 311  * interfaces that may need special processing.
 312  * ACPI_EXPORT_SYMBOL is used for all other public external functions.
 313  */
 314 #ifndef ACPI_EXPORT_SYMBOL_INIT
 315 #define ACPI_EXPORT_SYMBOL_INIT(Symbol)
 316 #endif
 317
 318 #ifndef ACPI_EXPORT_SYMBOL
 319 #define ACPI_EXPORT_SYMBOL(Symbol)
 320 #endif
 321
 322 /*
 323  * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
 324  * utilities only.
 325  */
 326 #ifndef ACPI_DEBUG_INITIALIZE
 327 #define ACPI_DEBUG_INITIALIZE()
 328 #endif
 329
 330
 331 /*******************************************************************************
 332  *
 333  * Configuration
 334  *
 335  ******************************************************************************/
 336
 337 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 338 /*
 339  * Memory allocation tracking (used by AcpiExec to detect memory leaks)
 340  */
 341 #define ACPI_MEM_PARAMETERS             _COMPONENT, _AcpiModuleName, __LINE__
 342 #define ACPI_ALLOCATE(a)                AcpiUtAllocateAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
 343 #define ACPI_ALLOCATE_ZEROED(a)         AcpiUtAllocateZeroedAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
 344 #define ACPI_FREE(a)                    AcpiUtFreeAndTrack (a, ACPI_MEM_PARAMETERS)
 345 #define ACPI_MEM_TRACKING(a)            a
 346
 347 #else
 348 /*
 349  * Normal memory allocation directly via the OS services layer
 350  */
 351 #define ACPI_ALLOCATE(a)                AcpiOsAllocate ((ACPI_SIZE) (a))
 352 #define ACPI_ALLOCATE_ZEROED(a)         AcpiOsAllocateZeroed ((ACPI_SIZE) (a))
 353 #define ACPI_FREE(a)                    AcpiOsFree (a)
 354 #define ACPI_MEM_TRACKING(a)
 355
 356 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
 357
 358
 359 /******************************************************************************
 360  *
 361  * ACPI Specification constants (Do not change unless the specification changes)
 362  *
 363  *****************************************************************************/
 364
 365 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
 366
 367 #define ACPI_MAX_GPE_BLOCKS             2
 368
 369 /* Default ACPI register widths */
 370
 371 #define ACPI_GPE_REGISTER_WIDTH         8
 372 #define ACPI_PM1_REGISTER_WIDTH         16
 373 #define ACPI_PM2_REGISTER_WIDTH         8
 374 #define ACPI_PM_TIMER_WIDTH             32
 375 #define ACPI_RESET_REGISTER_WIDTH       8
 376
 377 /* Names within the namespace are 4 bytes long */
 378
 379 #define ACPI_NAME_SIZE                  4
 380 #define ACPI_PATH_SEGMENT_LENGTH        5           /* 4 chars for name + 1 char for separator */
 381 #define ACPI_PATH_SEPARATOR             '.'
 382
 383 /* Sizes for ACPI table headers */
 384
 385 #define ACPI_OEM_ID_SIZE                6
 386 #define ACPI_OEM_TABLE_ID_SIZE          8
 387
 388 /* ACPI/PNP hardware IDs */
 389
 390 #define PCI_ROOT_HID_STRING             "PNP0A03"
 391 #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
 392
 393 /* PM Timer ticks per second (HZ) */
 394
 395 #define ACPI_PM_TIMER_FREQUENCY         3579545
 396
 397
 398 /*******************************************************************************
 399  *
 400  * Independent types
 401  *
 402  ******************************************************************************/
 403
 404 /* Logical defines and NULL */
 405
 406 #ifdef FALSE
 407 #undef FALSE
 408 #endif
 409 #define FALSE                           (1 == 0)
 410
 411 #ifdef TRUE
 412 #undef TRUE
 413 #endif
 414 #define TRUE                            (1 == 1)
 415
 416 #ifndef NULL
 417 #define NULL                            (void *) 0
 418 #endif
 419
 420
 421 /*
 422  * Miscellaneous types
 423  */
 424 typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
 425 typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
 426 typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
 427 typedef void *                          ACPI_HANDLE;    /* Actually a ptr to a NS Node */
 428
 429
 430 /* Time constants for timer calculations */
 431
 432 #define ACPI_MSEC_PER_SEC               1000L
 433
 434 #define ACPI_USEC_PER_MSEC              1000L
 435 #define ACPI_USEC_PER_SEC               1000000L
 436
 437 #define ACPI_100NSEC_PER_USEC           10L
 438 #define ACPI_100NSEC_PER_MSEC           10000L
 439 #define ACPI_100NSEC_PER_SEC            10000000L
 440
 441 #define ACPI_NSEC_PER_USEC              1000L
 442 #define ACPI_NSEC_PER_MSEC              1000000L
 443 #define ACPI_NSEC_PER_SEC               1000000000L
 444
 445
 446 /* Owner IDs are used to track namespace nodes for selective deletion */
 447
 448 typedef UINT8                           ACPI_OWNER_ID;
 449 #define ACPI_OWNER_ID_MAX               0xFF
 450
 451
 452 #define ACPI_INTEGER_BIT_SIZE           64
 453 #define ACPI_MAX_DECIMAL_DIGITS         20  /* 2^64 = 18,446,744,073,709,551,616 */
 454 #define ACPI_MAX64_DECIMAL_DIGITS       20
 455 #define ACPI_MAX32_DECIMAL_DIGITS       10
 456 #define ACPI_MAX16_DECIMAL_DIGITS        5
 457 #define ACPI_MAX8_DECIMAL_DIGITS         3
 458
 459 /*
 460  * Constants with special meanings
 461  */
 462 #define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (ACPI_HANDLE, NULL, ACPI_MAX_PTR)
 463 #define ACPI_WAIT_FOREVER               0xFFFF  /* UINT16, as per ACPI spec */
 464 #define ACPI_DO_NOT_WAIT                0
 465
 466 /*
 467  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
 468  * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
 469  * pertains to the ACPI integer type only, not to other integers used in the
 470  * implementation of the ACPICA subsystem.
 471  *
 472  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
 473  * code base. It remains here for compatibility with device drivers that use
 474  * the type. However, it will be removed in the future.
 475  */
 476 typedef UINT64                          ACPI_INTEGER;
 477 #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
 478
 479
 480 /*******************************************************************************
 481  *
 482  * Commonly used macros
 483  *
 484  ******************************************************************************/
 485
 486 /* Data manipulation */
 487
 488 #define ACPI_LOBYTE(Integer)            ((UINT8)   (UINT16)(Integer))
 489 #define ACPI_HIBYTE(Integer)            ((UINT8) (((UINT16)(Integer)) >> 8))
 490 #define ACPI_LOWORD(Integer)            ((UINT16)  (UINT32)(Integer))
 491 #define ACPI_HIWORD(Integer)            ((UINT16)(((UINT32)(Integer)) >> 16))
 492 #define ACPI_LODWORD(Integer64)         ((UINT32)  (UINT64)(Integer64))
 493 #define ACPI_HIDWORD(Integer64)         ((UINT32)(((UINT64)(Integer64)) >> 32))
 494
 495 #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
 496 #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
 497 #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
 498 #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
 499
 500 /* Size calculation */
 501
 502 #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
 503
 504 /* Pointer manipulation */
 505
 506 #define ACPI_CAST_PTR(t, p)             ((t *) (ACPI_UINTPTR_T) (p))
 507 #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (ACPI_UINTPTR_T) (p))
 508 #define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
 509 #define ACPI_PTR_DIFF(a, b)             (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b)))
 510
 511 /* Pointer/Integer type conversions */
 512
 513 #define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i)
 514 #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) NULL)
 515 #define ACPI_OFFSET(d, f)               (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
 516 #define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
 517 #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
 518
 519 /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
 520
 521 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
 522 #define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
 523 #define ACPI_MOVE_NAME(dest,src)        (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
 524 #else
 525 #define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
 526 #define ACPI_MOVE_NAME(dest,src)        (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
 527 #endif
 528
 529 /* Support for the special RSDP signature (8 characters) */
 530
 531 #define ACPI_VALIDATE_RSDP_SIG(a)       (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
 532 #define ACPI_MAKE_RSDP_SIG(dest)        (ACPI_MEMCPY (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
 533
 534
 535 /*******************************************************************************
 536  *
 537  * Miscellaneous constants
 538  *
 539  ******************************************************************************/
 540
 541 /*
 542  * Initialization sequence
 543  */
 544 #define ACPI_FULL_INITIALIZATION        0x00
 545 #define ACPI_NO_ADDRESS_SPACE_INIT      0x01
 546 #define ACPI_NO_HARDWARE_INIT           0x02
 547 #define ACPI_NO_EVENT_INIT              0x04
 548 #define ACPI_NO_HANDLER_INIT            0x08
 549 #define ACPI_NO_ACPI_ENABLE             0x10
 550 #define ACPI_NO_DEVICE_INIT             0x20
 551 #define ACPI_NO_OBJECT_INIT             0x40
 552
 553 /*
 554  * Initialization state
 555  */
 556 #define ACPI_SUBSYSTEM_INITIALIZE       0x01
 557 #define ACPI_INITIALIZED_OK             0x02
 558
 559 /*
 560  * Power state values
 561  */
 562 #define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
 563
 564 #define ACPI_STATE_S0                   (UINT8) 0
 565 #define ACPI_STATE_S1                   (UINT8) 1
 566 #define ACPI_STATE_S2                   (UINT8) 2
 567 #define ACPI_STATE_S3                   (UINT8) 3
 568 #define ACPI_STATE_S4                   (UINT8) 4
 569 #define ACPI_STATE_S5                   (UINT8) 5
 570 #define ACPI_S_STATES_MAX               ACPI_STATE_S5
 571 #define ACPI_S_STATE_COUNT              6
 572
 573 #define ACPI_STATE_D0                   (UINT8) 0
 574 #define ACPI_STATE_D1                   (UINT8) 1
 575 #define ACPI_STATE_D2                   (UINT8) 2
 576 #define ACPI_STATE_D3                   (UINT8) 3
 577 #define ACPI_D_STATES_MAX               ACPI_STATE_D3
 578 #define ACPI_D_STATE_COUNT              4
 579
 580 #define ACPI_STATE_C0                   (UINT8) 0
 581 #define ACPI_STATE_C1                   (UINT8) 1
 582 #define ACPI_STATE_C2                   (UINT8) 2
 583 #define ACPI_STATE_C3                   (UINT8) 3
 584 #define ACPI_C_STATES_MAX               ACPI_STATE_C3
 585 #define ACPI_C_STATE_COUNT              4
 586
 587 /*
 588  * Sleep type invalid value
 589  */
 590 #define ACPI_SLEEP_TYPE_MAX             0x7
 591 #define ACPI_SLEEP_TYPE_INVALID         0xFF
 592
 593 /*
 594  * Standard notify values
 595  */
 596 #define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0x00
 597 #define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 0x01
 598 #define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 0x02
 599 #define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 0x03
 600 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 0x04
 601 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 0x05
 602 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 0x06
 603 #define ACPI_NOTIFY_POWER_FAULT         (UINT8) 0x07
 604 #define ACPI_NOTIFY_CAPABILITIES_CHECK  (UINT8) 0x08
 605 #define ACPI_NOTIFY_DEVICE_PLD_CHECK    (UINT8) 0x09
 606 #define ACPI_NOTIFY_RESERVED            (UINT8) 0x0A
 607 #define ACPI_NOTIFY_LOCALITY_UPDATE     (UINT8) 0x0B
 608 #define ACPI_NOTIFY_SHUTDOWN_REQUEST    (UINT8) 0x0C
 609
 610 #define ACPI_NOTIFY_MAX                 0x0C
 611
 612 /*
 613  * Types associated with ACPI names and objects. The first group of
 614  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 615  * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
 616  * only add to the first group if the spec changes.
 617  *
 618  * NOTE: Types must be kept in sync with the global AcpiNsProperties
 619  * and AcpiNsTypeNames arrays.
 620  */
 621 typedef UINT32                          ACPI_OBJECT_TYPE;
 622
 623 #define ACPI_TYPE_ANY                   0x00
 624 #define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
 625 #define ACPI_TYPE_STRING                0x02
 626 #define ACPI_TYPE_BUFFER                0x03
 627 #define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
 628 #define ACPI_TYPE_FIELD_UNIT            0x05
 629 #define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
 630 #define ACPI_TYPE_EVENT                 0x07
 631 #define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
 632 #define ACPI_TYPE_MUTEX                 0x09
 633 #define ACPI_TYPE_REGION                0x0A
 634 #define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
 635 #define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
 636 #define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
 637 #define ACPI_TYPE_BUFFER_FIELD          0x0E
 638 #define ACPI_TYPE_DDB_HANDLE            0x0F
 639 #define ACPI_TYPE_DEBUG_OBJECT          0x10
 640
 641 #define ACPI_TYPE_EXTERNAL_MAX          0x10
 642
 643 /*
 644  * These are object types that do not map directly to the ACPI
 645  * ObjectType() operator. They are used for various internal purposes only.
 646  * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 647  * internal types must move upwards. (There is code that depends on these
 648  * values being contiguous with the external types above.)
 649  */
 650 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
 651 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
 652 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
 653 #define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
 654 #define ACPI_TYPE_LOCAL_ALIAS           0x15
 655 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
 656 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
 657 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
 658 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
 659 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
 660 #define ACPI_TYPE_LOCAL_SCOPE           0x1B  /* 1 Name, multiple ObjectList Nodes */
 661
 662 #define ACPI_TYPE_NS_NODE_MAX           0x1B  /* Last typecode used within a NS Node */
 663
 664 /*
 665  * These are special object types that never appear in
 666  * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
 667  */
 668 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
 669 #define ACPI_TYPE_LOCAL_DATA            0x1D
 670
 671 #define ACPI_TYPE_LOCAL_MAX             0x1D
 672
 673 /* All types above here are invalid */
 674
 675 #define ACPI_TYPE_INVALID               0x1E
 676 #define ACPI_TYPE_NOT_FOUND             0xFF
 677
 678 #define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
 679
 680
 681 /*
 682  * All I/O
 683  */
 684 #define ACPI_READ                       0
 685 #define ACPI_WRITE                      1
 686 #define ACPI_IO_MASK                    1
 687
 688 /*
 689  * Event Types: Fixed & General Purpose
 690  */
 691 typedef UINT32                          ACPI_EVENT_TYPE;
 692
 693 /*
 694  * Fixed events
 695  */
 696 #define ACPI_EVENT_PMTIMER              0
 697 #define ACPI_EVENT_GLOBAL               1
 698 #define ACPI_EVENT_POWER_BUTTON         2
 699 #define ACPI_EVENT_SLEEP_BUTTON         3
 700 #define ACPI_EVENT_RTC                  4
 701 #define ACPI_EVENT_MAX                  4
 702 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
 703
 704 /*
 705  * Event Status - Per event
 706  * -------------
 707  * The encoding of ACPI_EVENT_STATUS is illustrated below.
 708  * Note that a set bit (1) indicates the property is TRUE
 709  * (e.g. if bit 0 is set then the event is enabled).
 710  * +-------------+-+-+-+
 711  * |   Bits 31:3 |2|1|0|
 712  * +-------------+-+-+-+
 713  *          |     | | |
 714  *          |     | | +- Enabled?
 715  *          |     | +--- Enabled for wake?
 716  *          |     +----- Set?
 717  *          +----------- <Reserved>
 718  */
 719 typedef UINT32                          ACPI_EVENT_STATUS;
 720
 721 #define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
 722 #define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
 723 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
 724 #define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
 725
 726 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
 727
 728 #define ACPI_GPE_ENABLE                 0
 729 #define ACPI_GPE_DISABLE                1
 730 #define ACPI_GPE_CONDITIONAL_ENABLE     2
 731
 732 /*
 733  * GPE info flags - Per GPE
 734  * +-------+-+-+---+
 735  * |  7:4  |3|2|1:0|
 736  * +-------+-+-+---+
 737  *     |    | |  |
 738  *     |    | |  +-- Type of dispatch:to method, handler, notify, or none
 739  *     |    | +----- Interrupt type: edge or level triggered
 740  *     |    +------- Is a Wake GPE
 741  *     +------------ <Reserved>
 742  */
 743 #define ACPI_GPE_DISPATCH_NONE          (UINT8) 0x00
 744 #define ACPI_GPE_DISPATCH_METHOD        (UINT8) 0x01
 745 #define ACPI_GPE_DISPATCH_HANDLER       (UINT8) 0x02
 746 #define ACPI_GPE_DISPATCH_NOTIFY        (UINT8) 0x03
 747 #define ACPI_GPE_DISPATCH_MASK          (UINT8) 0x03
 748
 749 #define ACPI_GPE_LEVEL_TRIGGERED        (UINT8) 0x04
 750 #define ACPI_GPE_EDGE_TRIGGERED         (UINT8) 0x00
 751 #define ACPI_GPE_XRUPT_TYPE_MASK        (UINT8) 0x04
 752
 753 #define ACPI_GPE_CAN_WAKE               (UINT8) 0x08
 754
 755 /*
 756  * Flags for GPE and Lock interfaces
 757  */
 758 #define ACPI_NOT_ISR                    0x1
 759 #define ACPI_ISR                        0x0
 760
 761
 762 /* Notify types */
 763
 764 #define ACPI_SYSTEM_NOTIFY              0x1
 765 #define ACPI_DEVICE_NOTIFY              0x2
 766 #define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
 767 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
 768 #define ACPI_NUM_NOTIFY_TYPES           2
 769
 770 #define ACPI_MAX_SYS_NOTIFY             0x7F
 771 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
 772
 773 #define ACPI_SYSTEM_HANDLER_LIST        0 /* Used as index, must be SYSTEM_NOTIFY -1 */
 774 #define ACPI_DEVICE_HANDLER_LIST        1 /* Used as index, must be DEVICE_NOTIFY -1 */
 775
 776
 777 /* Address Space (Operation Region) Types */
 778
 779 typedef UINT8                           ACPI_ADR_SPACE_TYPE;
 780
 781 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
 782 #define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
 783 #define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
 784 #define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
 785 #define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
 786 #define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
 787 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
 788 #define ACPI_ADR_SPACE_IPMI             (ACPI_ADR_SPACE_TYPE) 7
 789 #define ACPI_ADR_SPACE_GPIO             (ACPI_ADR_SPACE_TYPE) 8
 790 #define ACPI_ADR_SPACE_GSBUS            (ACPI_ADR_SPACE_TYPE) 9
 791 #define ACPI_ADR_SPACE_PLATFORM_COMM    (ACPI_ADR_SPACE_TYPE) 10
 792
 793 #define ACPI_NUM_PREDEFINED_REGIONS     11
 794
 795 /*
 796  * Special Address Spaces
 797  *
 798  * Note: A Data Table region is a special type of operation region
 799  * that has its own AML opcode. However, internally, the AML
 800  * interpreter simply creates an operation region with an an address
 801  * space type of ACPI_ADR_SPACE_DATA_TABLE.
 802  */
 803 #define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
 804 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 0x7F
 805
 806 /* Values for _REG connection code */
 807
 808 #define ACPI_REG_DISCONNECT             0
 809 #define ACPI_REG_CONNECT                1
 810
 811 /*
 812  * BitRegister IDs
 813  *
 814  * These values are intended to be used by the hardware interfaces
 815  * and are mapped to individual bitfields defined within the ACPI
 816  * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
 817  * for this mapping.
 818  */
 819
 820 /* PM1 Status register */
 821
 822 #define ACPI_BITREG_TIMER_STATUS                0x00
 823 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
 824 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
 825 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
 826 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
 827 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
 828 #define ACPI_BITREG_WAKE_STATUS                 0x06
 829 #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
 830
 831 /* PM1 Enable register */
 832
 833 #define ACPI_BITREG_TIMER_ENABLE                0x08
 834 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
 835 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
 836 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
 837 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
 838 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
 839
 840 /* PM1 Control register */
 841
 842 #define ACPI_BITREG_SCI_ENABLE                  0x0E
 843 #define ACPI_BITREG_BUS_MASTER_RLD              0x0F
 844 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
 845 #define ACPI_BITREG_SLEEP_TYPE                  0x11
 846 #define ACPI_BITREG_SLEEP_ENABLE                0x12
 847
 848 /* PM2 Control register */
 849
 850 #define ACPI_BITREG_ARB_DISABLE                 0x13
 851
 852 #define ACPI_BITREG_MAX                         0x13
 853 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
 854
 855
 856 /* Status register values. A 1 clears a status bit. 0 = no effect */
 857
 858 #define ACPI_CLEAR_STATUS                       1
 859
 860 /* Enable and Control register values */
 861
 862 #define ACPI_ENABLE_EVENT                       1
 863 #define ACPI_DISABLE_EVENT                      0
 864
 865
 866 /* Sleep function dispatch */
 867
 868 typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) (
 869     UINT8                   SleepState);
 870
 871 typedef struct acpi_sleep_functions
 872 {
 873     ACPI_SLEEP_FUNCTION     LegacyFunction;
 874     ACPI_SLEEP_FUNCTION     ExtendedFunction;
 875
 876 } ACPI_SLEEP_FUNCTIONS;
 877
 878
 879 /*
 880  * External ACPI object definition
 881  */
 882
 883 /*
 884  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
 885  * or an unresolved named reference.
 886  */
 887 typedef union acpi_object
 888 {
 889     ACPI_OBJECT_TYPE                Type;   /* See definition of AcpiNsType for values */
 890     struct
 891     {
 892         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_INTEGER */
 893         UINT64                          Value;      /* The actual number */
 894     } Integer;
 895
 896     struct
 897     {
 898         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_STRING */
 899         UINT32                          Length;     /* # of bytes in string, excluding trailing null */
 900         char                            *Pointer;   /* points to the string value */
 901     } String;
 902
 903     struct
 904     {
 905         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_BUFFER */
 906         UINT32                          Length;     /* # of bytes in buffer */
 907         UINT8                           *Pointer;   /* points to the buffer */
 908     } Buffer;
 909
 910     struct
 911     {
 912         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PACKAGE */
 913         UINT32                          Count;      /* # of elements in package */
 914         union acpi_object               *Elements;  /* Pointer to an array of ACPI_OBJECTs */
 915     } Package;
 916
 917     struct
 918     {
 919         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_LOCAL_REFERENCE */
 920         ACPI_OBJECT_TYPE                ActualType; /* Type associated with the Handle */
 921         ACPI_HANDLE                     Handle;     /* object reference */
 922     } Reference;
 923
 924     struct
 925     {
 926         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PROCESSOR */
 927         UINT32                          ProcId;
 928         ACPI_IO_ADDRESS                 PblkAddress;
 929         UINT32                          PblkLength;
 930     } Processor;
 931
 932     struct
 933     {
 934         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_POWER */
 935         UINT32                          SystemLevel;
 936         UINT32                          ResourceOrder;
 937     } PowerResource;
 938
 939 } ACPI_OBJECT;
 940
 941
 942 /*
 943  * List of objects, used as a parameter list for control method evaluation
 944  */
 945 typedef struct acpi_object_list
 946 {
 947     UINT32                          Count;
 948     ACPI_OBJECT                     *Pointer;
 949
 950 } ACPI_OBJECT_LIST;
 951
 952
 953 /*
 954  * Miscellaneous common Data Structures used by the interfaces
 955  */
 956 #define ACPI_NO_BUFFER              0
 957 #define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)    /* Let ACPICA allocate buffer */
 958 #define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)    /* For internal use only (enables tracking) */
 959
 960 typedef struct acpi_buffer
 961 {
 962     ACPI_SIZE                       Length;         /* Length in bytes of the buffer */
 963     void                            *Pointer;       /* pointer to buffer */
 964
 965 } ACPI_BUFFER;
 966
 967
 968 /*
 969  * NameType for AcpiGetName
 970  */
 971 #define ACPI_FULL_PATHNAME              0
 972 #define ACPI_SINGLE_NAME                1
 973 #define ACPI_NAME_TYPE_MAX              1
 974
 975
 976 /*
 977  * Predefined Namespace items
 978  */
 979 typedef struct acpi_predefined_names
 980 {
 981     char                            *Name;
 982     UINT8                           Type;
 983     char                            *Val;
 984
 985 } ACPI_PREDEFINED_NAMES;
 986
 987
 988 /*
 989  * Structure and flags for AcpiGetSystemInfo
 990  */
 991 #define ACPI_SYS_MODE_UNKNOWN           0x0000
 992 #define ACPI_SYS_MODE_ACPI              0x0001
 993 #define ACPI_SYS_MODE_LEGACY            0x0002
 994 #define ACPI_SYS_MODES_MASK             0x0003
 995
 996
 997 /*
 998  * System info returned by AcpiGetSystemInfo()
 999  */
1000 typedef struct acpi_system_info
1001 {
1002     UINT32                          AcpiCaVersion;
1003     UINT32                          Flags;
1004     UINT32                          TimerResolution;
1005     UINT32                          Reserved1;
1006     UINT32                          Reserved2;
1007     UINT32                          DebugLevel;
1008     UINT32                          DebugLayer;
1009
1010 } ACPI_SYSTEM_INFO;
1011
1012
1013 /*
1014  * System statistics returned by AcpiGetStatistics()
1015  */
1016 typedef struct acpi_statistics
1017 {
1018     UINT32                          SciCount;
1019     UINT32                          GpeCount;
1020     UINT32                          FixedEventCount[ACPI_NUM_FIXED_EVENTS];
1021     UINT32                          MethodCount;
1022
1023 } ACPI_STATISTICS;
1024
1025
1026 /* Table Event Types */
1027
1028 #define ACPI_TABLE_EVENT_LOAD           0x0
1029 #define ACPI_TABLE_EVENT_UNLOAD         0x1
1030 #define ACPI_NUM_TABLE_EVENTS           2
1031
1032
1033 /*
1034  * Types specific to the OS service interfaces
1035  */
1036 typedef UINT32
1037 (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
1038     void                            *Context);
1039
1040 typedef void
1041 (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
1042     void                            *Context);
1043
1044 /*
1045  * Various handlers and callback procedures
1046  */
1047 typedef
1048 UINT32 (*ACPI_SCI_HANDLER) (
1049     void                            *Context);
1050
1051 typedef
1052 void (*ACPI_GBL_EVENT_HANDLER) (
1053     UINT32                          EventType,
1054     ACPI_HANDLE                     Device,
1055     UINT32                          EventNumber,
1056     void                            *Context);
1057
1058 #define ACPI_EVENT_TYPE_GPE         0
1059 #define ACPI_EVENT_TYPE_FIXED       1
1060
1061 typedef
1062 UINT32 (*ACPI_EVENT_HANDLER) (
1063     void                            *Context);
1064
1065 typedef
1066 UINT32 (*ACPI_GPE_HANDLER) (
1067     ACPI_HANDLE                     GpeDevice,
1068     UINT32                          GpeNumber,
1069     void                            *Context);
1070
1071 typedef
1072 void (*ACPI_NOTIFY_HANDLER) (
1073     ACPI_HANDLE                     Device,
1074     UINT32                          Value,
1075     void                            *Context);
1076
1077 typedef
1078 void (*ACPI_OBJECT_HANDLER) (
1079     ACPI_HANDLE                     Object,
1080     void                            *Data);
1081
1082 typedef
1083 ACPI_STATUS (*ACPI_INIT_HANDLER) (
1084     ACPI_HANDLE                     Object,
1085     UINT32                          Function);
1086
1087 #define ACPI_INIT_DEVICE_INI        1
1088
1089 typedef
1090 ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
1091     ACPI_STATUS                     AmlStatus,
1092     ACPI_NAME                       Name,
1093     UINT16                          Opcode,
1094     UINT32                          AmlOffset,
1095     void                            *Context);
1096
1097 /* Table Event handler (Load, LoadTable, etc.) and types */
1098
1099 typedef
1100 ACPI_STATUS (*ACPI_TABLE_HANDLER) (
1101     UINT32                          Event,
1102     void                            *Table,
1103     void                            *Context);
1104
1105 #define ACPI_TABLE_LOAD             0x0
1106 #define ACPI_TABLE_UNLOAD           0x1
1107 #define ACPI_NUM_TABLE_EVENTS       2
1108
1109
1110 /* Address Spaces (For Operation Regions) */
1111
1112 typedef
1113 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
1114     UINT32                          Function,
1115     ACPI_PHYSICAL_ADDRESS           Address,
1116     UINT32                          BitWidth,
1117     UINT64                          *Value,
1118     void                            *HandlerContext,
1119     void                            *RegionContext);
1120
1121 #define ACPI_DEFAULT_HANDLER            NULL
1122
1123 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1124
1125 typedef struct acpi_connection_info
1126 {
1127     UINT8                           *Connection;
1128     UINT16                          Length;
1129     UINT8                           AccessLength;
1130
1131 } ACPI_CONNECTION_INFO;
1132
1133
1134 typedef
1135 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
1136     ACPI_HANDLE                     RegionHandle,
1137     UINT32                          Function,
1138     void                            *HandlerContext,
1139     void                            **RegionContext);
1140
1141 #define ACPI_REGION_ACTIVATE    0
1142 #define ACPI_REGION_DEACTIVATE  1
1143
1144 typedef
1145 ACPI_STATUS (*ACPI_WALK_CALLBACK) (
1146     ACPI_HANDLE                     Object,
1147     UINT32                          NestingLevel,
1148     void                            *Context,
1149     void                            **ReturnValue);
1150
1151 typedef
1152 UINT32 (*ACPI_INTERFACE_HANDLER) (
1153     ACPI_STRING                     InterfaceName,
1154     UINT32                          Supported);
1155
1156
1157 /* Interrupt handler return values */
1158
1159 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
1160 #define ACPI_INTERRUPT_HANDLED          0x01
1161
1162 /* GPE handler return values */
1163
1164 #define ACPI_REENABLE_GPE               0x80
1165
1166
1167 /* Length of 32-bit EISAID values when converted back to a string */
1168
1169 #define ACPI_EISAID_STRING_SIZE         8   /* Includes null terminator */
1170
1171 /* Length of UUID (string) values */
1172
1173 #define ACPI_UUID_LENGTH                16
1174
1175
1176 /* Structures used for device/processor HID, UID, CID, and SUB */
1177
1178 typedef struct acpi_pnp_device_id
1179 {
1180     UINT32                          Length;             /* Length of string + null */
1181     char                            *String;
1182
1183 } ACPI_PNP_DEVICE_ID;
1184
1185 typedef struct acpi_pnp_device_id_list
1186 {
1187     UINT32                          Count;              /* Number of IDs in Ids array */
1188     UINT32                          ListSize;           /* Size of list, including ID strings */
1189     ACPI_PNP_DEVICE_ID              Ids[1];             /* ID array */
1190
1191 } ACPI_PNP_DEVICE_ID_LIST;
1192
1193 /*
1194  * Structure returned from AcpiGetObjectInfo.
1195  * Optimized for both 32- and 64-bit builds
1196  */
1197 typedef struct acpi_device_info
1198 {
1199     UINT32                          InfoSize;           /* Size of info, including ID strings */
1200     UINT32                          Name;               /* ACPI object Name */
1201     ACPI_OBJECT_TYPE                Type;               /* ACPI object Type */
1202     UINT8                           ParamCount;         /* If a method, required parameter count */
1203     UINT8                           Valid;              /* Indicates which optional fields are valid */
1204     UINT8                           Flags;              /* Miscellaneous info */
1205     UINT8                           HighestDstates[4];  /* _SxD values: 0xFF indicates not valid */
1206     UINT8                           LowestDstates[5];   /* _SxW values: 0xFF indicates not valid */
1207     UINT32                          CurrentStatus;      /* _STA value */
1208     UINT64                          Address;            /* _ADR value */
1209     ACPI_PNP_DEVICE_ID              HardwareId;         /* _HID value */
1210     ACPI_PNP_DEVICE_ID              UniqueId;           /* _UID value */
1211     ACPI_PNP_DEVICE_ID              SubsystemId;        /* _SUB value */
1212     ACPI_PNP_DEVICE_ID_LIST         CompatibleIdList;   /* _CID list <must be last> */
1213
1214 } ACPI_DEVICE_INFO;
1215
1216 /* Values for Flags field above (AcpiGetObjectInfo) */
1217
1218 #define ACPI_PCI_ROOT_BRIDGE            0x01
1219
1220 /* Flags for Valid field above (AcpiGetObjectInfo) */
1221
1222 #define ACPI_VALID_STA                  0x01
1223 #define ACPI_VALID_ADR                  0x02
1224 #define ACPI_VALID_HID                  0x04
1225 #define ACPI_VALID_UID                  0x08
1226 #define ACPI_VALID_SUB                  0x10
1227 #define ACPI_VALID_CID                  0x20
1228 #define ACPI_VALID_SXDS                 0x40
1229 #define ACPI_VALID_SXWS                 0x80
1230
1231 /* Flags for _STA return value (CurrentStatus above) */
1232
1233 #define ACPI_STA_DEVICE_PRESENT         0x01
1234 #define ACPI_STA_DEVICE_ENABLED         0x02
1235 #define ACPI_STA_DEVICE_UI              0x04
1236 #define ACPI_STA_DEVICE_FUNCTIONING     0x08
1237 #define ACPI_STA_DEVICE_OK              0x08 /* Synonym */
1238 #define ACPI_STA_BATTERY_PRESENT        0x10
1239
1240
1241 /* Context structs for address space handlers */
1242
1243 typedef struct acpi_pci_id
1244 {
1245     UINT16                          Segment;
1246     UINT16                          Bus;
1247     UINT16                          Device;
1248     UINT16                          Function;
1249
1250 } ACPI_PCI_ID;
1251
1252 typedef struct acpi_mem_space_context
1253 {
1254     UINT32                          Length;
1255     ACPI_PHYSICAL_ADDRESS           Address;
1256     ACPI_PHYSICAL_ADDRESS           MappedPhysicalAddress;
1257     UINT8                           *MappedLogicalAddress;
1258     ACPI_SIZE                       MappedLength;
1259
1260 } ACPI_MEM_SPACE_CONTEXT;
1261
1262
1263 /*
1264  * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1265  */
1266 typedef struct acpi_memory_list
1267 {
1268     char                            *ListName;
1269     void                            *ListHead;
1270     UINT16                          ObjectSize;
1271     UINT16                          MaxDepth;
1272     UINT16                          CurrentDepth;
1273
1274 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1275
1276     /* Statistics for debug memory tracking only */
1277
1278     UINT32                          TotalAllocated;
1279     UINT32                          TotalFreed;
1280     UINT32                          MaxOccupied;
1281     UINT32                          TotalSize;
1282     UINT32                          CurrentTotalSize;
1283     UINT32                          Requests;
1284     UINT32                          Hits;
1285 #endif
1286
1287 } ACPI_MEMORY_LIST;
1288
1289
1290 /* Definitions of _OSI support */
1291
1292 #define ACPI_VENDOR_STRINGS                 0x01
1293 #define ACPI_FEATURE_STRINGS                0x02
1294 #define ACPI_ENABLE_INTERFACES              0x00
1295 #define ACPI_DISABLE_INTERFACES             0x04
1296
1297 #define ACPI_DISABLE_ALL_VENDOR_STRINGS     (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1298 #define ACPI_DISABLE_ALL_FEATURE_STRINGS    (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1299 #define ACPI_DISABLE_ALL_STRINGS            (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1300 #define ACPI_ENABLE_ALL_VENDOR_STRINGS      (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1301 #define ACPI_ENABLE_ALL_FEATURE_STRINGS     (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1302 #define ACPI_ENABLE_ALL_STRINGS             (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1303
1304 #define ACPI_OSI_WIN_2000               0x01
1305 #define ACPI_OSI_WIN_XP                 0x02
1306 #define ACPI_OSI_WIN_XP_SP1             0x03
1307 #define ACPI_OSI_WINSRV_2003            0x04
1308 #define ACPI_OSI_WIN_XP_SP2             0x05
1309 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1310 #define ACPI_OSI_WIN_VISTA              0x07
1311 #define ACPI_OSI_WINSRV_2008            0x08
1312 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1313 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1314 #define ACPI_OSI_WIN_7                  0x0B
1315 #define ACPI_OSI_WIN_8                  0x0C
1316
1317
1318 #endif /* __ACTYPES_H__ */