sys/contrib/dev/acpica/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 - 2013, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #ifndef __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 functions that are available to the rest of the kernel are
 307  * tagged with this macro which can be defined as appropriate for the host.
 308  */
 309 #ifndef ACPI_EXPORT_SYMBOL
 310 #define ACPI_EXPORT_SYMBOL(Symbol)
 311 #endif
 312
 313 /*
 314  * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
 315  * utilities only.
 316  */
 317 #ifndef ACPI_DEBUG_INITIALIZE
 318 #define ACPI_DEBUG_INITIALIZE()
 319 #endif
 320
 321
 322 /******************************************************************************
 323  *
 324  * ACPI Specification constants (Do not change unless the specification changes)
 325  *
 326  *****************************************************************************/
 327
 328 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
 329
 330 #define ACPI_MAX_GPE_BLOCKS             2
 331
 332 /* Default ACPI register widths */
 333
 334 #define ACPI_GPE_REGISTER_WIDTH         8
 335 #define ACPI_PM1_REGISTER_WIDTH         16
 336 #define ACPI_PM2_REGISTER_WIDTH         8
 337 #define ACPI_PM_TIMER_WIDTH             32
 338
 339 /* Names within the namespace are 4 bytes long */
 340
 341 #define ACPI_NAME_SIZE                  4
 342 #define ACPI_PATH_SEGMENT_LENGTH        5           /* 4 chars for name + 1 char for separator */
 343 #define ACPI_PATH_SEPARATOR             '.'
 344
 345 /* Sizes for ACPI table headers */
 346
 347 #define ACPI_OEM_ID_SIZE                6
 348 #define ACPI_OEM_TABLE_ID_SIZE          8
 349
 350 /* ACPI/PNP hardware IDs */
 351
 352 #define PCI_ROOT_HID_STRING             "PNP0A03"
 353 #define PCI_EXPRESS_ROOT_HID_STRING     "PNP0A08"
 354
 355 /* PM Timer ticks per second (HZ) */
 356
 357 #define ACPI_PM_TIMER_FREQUENCY         3579545
 358
 359
 360 /*******************************************************************************
 361  *
 362  * Independent types
 363  *
 364  ******************************************************************************/
 365
 366 /* Logical defines and NULL */
 367
 368 #ifdef FALSE
 369 #undef FALSE
 370 #endif
 371 #define FALSE                           (1 == 0)
 372
 373 #ifdef TRUE
 374 #undef TRUE
 375 #endif
 376 #define TRUE                            (1 == 1)
 377
 378 #ifndef NULL
 379 #define NULL                            (void *) 0
 380 #endif
 381
 382
 383 /*
 384  * Miscellaneous types
 385  */
 386 typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
 387 typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
 388 typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
 389 typedef void *                          ACPI_HANDLE;    /* Actually a ptr to a NS Node */
 390
 391
 392 /* Time constants for timer calculations */
 393
 394 #define ACPI_MSEC_PER_SEC               1000L
 395
 396 #define ACPI_USEC_PER_MSEC              1000L
 397 #define ACPI_USEC_PER_SEC               1000000L
 398
 399 #define ACPI_100NSEC_PER_USEC           10L
 400 #define ACPI_100NSEC_PER_MSEC           10000L
 401 #define ACPI_100NSEC_PER_SEC            10000000L
 402
 403 #define ACPI_NSEC_PER_USEC              1000L
 404 #define ACPI_NSEC_PER_MSEC              1000000L
 405 #define ACPI_NSEC_PER_SEC               1000000000L
 406
 407
 408 /* Owner IDs are used to track namespace nodes for selective deletion */
 409
 410 typedef UINT8                           ACPI_OWNER_ID;
 411 #define ACPI_OWNER_ID_MAX               0xFF
 412
 413
 414 #define ACPI_INTEGER_BIT_SIZE           64
 415 #define ACPI_MAX_DECIMAL_DIGITS         20  /* 2^64 = 18,446,744,073,709,551,616 */
 416 #define ACPI_MAX64_DECIMAL_DIGITS       20
 417 #define ACPI_MAX32_DECIMAL_DIGITS       10
 418 #define ACPI_MAX16_DECIMAL_DIGITS        5
 419 #define ACPI_MAX8_DECIMAL_DIGITS         3
 420
 421 /*
 422  * Constants with special meanings
 423  */
 424 #define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (ACPI_HANDLE, NULL, ACPI_MAX_PTR)
 425 #define ACPI_WAIT_FOREVER               0xFFFF  /* UINT16, as per ACPI spec */
 426 #define ACPI_DO_NOT_WAIT                0
 427
 428 /*
 429  * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
 430  * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
 431  * pertains to the ACPI integer type only, not to other integers used in the
 432  * implementation of the ACPICA subsystem.
 433  *
 434  * 01/2010: This type is obsolete and has been removed from the entire ACPICA
 435  * code base. It remains here for compatibility with device drivers that use
 436  * the type. However, it will be removed in the future.
 437  */
 438 typedef UINT64                          ACPI_INTEGER;
 439 #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
 440
 441
 442 /*******************************************************************************
 443  *
 444  * Commonly used macros
 445  *
 446  ******************************************************************************/
 447
 448 /* Data manipulation */
 449
 450 #define ACPI_LOBYTE(Integer)            ((UINT8)   (UINT16)(Integer))
 451 #define ACPI_HIBYTE(Integer)            ((UINT8) (((UINT16)(Integer)) >> 8))
 452 #define ACPI_LOWORD(Integer)            ((UINT16)  (UINT32)(Integer))
 453 #define ACPI_HIWORD(Integer)            ((UINT16)(((UINT32)(Integer)) >> 16))
 454 #define ACPI_LODWORD(Integer64)         ((UINT32)  (UINT64)(Integer64))
 455 #define ACPI_HIDWORD(Integer64)         ((UINT32)(((UINT64)(Integer64)) >> 32))
 456
 457 #define ACPI_SET_BIT(target,bit)        ((target) |= (bit))
 458 #define ACPI_CLEAR_BIT(target,bit)      ((target) &= ~(bit))
 459 #define ACPI_MIN(a,b)                   (((a)<(b))?(a):(b))
 460 #define ACPI_MAX(a,b)                   (((a)>(b))?(a):(b))
 461
 462 /* Size calculation */
 463
 464 #define ACPI_ARRAY_LENGTH(x)            (sizeof(x) / sizeof((x)[0]))
 465
 466 /* Pointer manipulation */
 467
 468 #define ACPI_CAST_PTR(t, p)             ((t *) (ACPI_UINTPTR_T) (p))
 469 #define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **) (ACPI_UINTPTR_T) (p))
 470 #define ACPI_ADD_PTR(t, a, b)           ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
 471 #define ACPI_PTR_DIFF(a, b)             (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b)))
 472
 473 /* Pointer/Integer type conversions */
 474
 475 #define ACPI_TO_POINTER(i)              ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i)
 476 #define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p, (void *) NULL)
 477 #define ACPI_OFFSET(d, f)               (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
 478 #define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
 479 #define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
 480
 481 /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
 482
 483 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
 484 #define ACPI_COMPARE_NAME(a,b)          (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
 485 #define ACPI_MOVE_NAME(dest,src)        (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
 486 #else
 487 #define ACPI_COMPARE_NAME(a,b)          (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
 488 #define ACPI_MOVE_NAME(dest,src)        (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
 489 #endif
 490
 491 /* Support for the special RSDP signature (8 characters) */
 492
 493 #define ACPI_VALIDATE_RSDP_SIG(a)       (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
 494 #define ACPI_MAKE_RSDP_SIG(dest)        (ACPI_MEMCPY (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
 495
 496
 497 /*******************************************************************************
 498  *
 499  * Miscellaneous constants
 500  *
 501  ******************************************************************************/
 502
 503 /*
 504  * Initialization sequence
 505  */
 506 #define ACPI_FULL_INITIALIZATION        0x00
 507 #define ACPI_NO_ADDRESS_SPACE_INIT      0x01
 508 #define ACPI_NO_HARDWARE_INIT           0x02
 509 #define ACPI_NO_EVENT_INIT              0x04
 510 #define ACPI_NO_HANDLER_INIT            0x08
 511 #define ACPI_NO_ACPI_ENABLE             0x10
 512 #define ACPI_NO_DEVICE_INIT             0x20
 513 #define ACPI_NO_OBJECT_INIT             0x40
 514
 515 /*
 516  * Initialization state
 517  */
 518 #define ACPI_SUBSYSTEM_INITIALIZE       0x01
 519 #define ACPI_INITIALIZED_OK             0x02
 520
 521 /*
 522  * Power state values
 523  */
 524 #define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
 525
 526 #define ACPI_STATE_S0                   (UINT8) 0
 527 #define ACPI_STATE_S1                   (UINT8) 1
 528 #define ACPI_STATE_S2                   (UINT8) 2
 529 #define ACPI_STATE_S3                   (UINT8) 3
 530 #define ACPI_STATE_S4                   (UINT8) 4
 531 #define ACPI_STATE_S5                   (UINT8) 5
 532 #define ACPI_S_STATES_MAX               ACPI_STATE_S5
 533 #define ACPI_S_STATE_COUNT              6
 534
 535 #define ACPI_STATE_D0                   (UINT8) 0
 536 #define ACPI_STATE_D1                   (UINT8) 1
 537 #define ACPI_STATE_D2                   (UINT8) 2
 538 #define ACPI_STATE_D3                   (UINT8) 3
 539 #define ACPI_D_STATES_MAX               ACPI_STATE_D3
 540 #define ACPI_D_STATE_COUNT              4
 541
 542 #define ACPI_STATE_C0                   (UINT8) 0
 543 #define ACPI_STATE_C1                   (UINT8) 1
 544 #define ACPI_STATE_C2                   (UINT8) 2
 545 #define ACPI_STATE_C3                   (UINT8) 3
 546 #define ACPI_C_STATES_MAX               ACPI_STATE_C3
 547 #define ACPI_C_STATE_COUNT              4
 548
 549 /*
 550  * Sleep type invalid value
 551  */
 552 #define ACPI_SLEEP_TYPE_MAX             0x7
 553 #define ACPI_SLEEP_TYPE_INVALID         0xFF
 554
 555 /*
 556  * Standard notify values
 557  */
 558 #define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0x00
 559 #define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 0x01
 560 #define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 0x02
 561 #define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 0x03
 562 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 0x04
 563 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 0x05
 564 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 0x06
 565 #define ACPI_NOTIFY_POWER_FAULT         (UINT8) 0x07
 566 #define ACPI_NOTIFY_CAPABILITIES_CHECK  (UINT8) 0x08
 567 #define ACPI_NOTIFY_DEVICE_PLD_CHECK    (UINT8) 0x09
 568 #define ACPI_NOTIFY_RESERVED            (UINT8) 0x0A
 569 #define ACPI_NOTIFY_LOCALITY_UPDATE     (UINT8) 0x0B
 570 #define ACPI_NOTIFY_SHUTDOWN_REQUEST    (UINT8) 0x0C
 571
 572 #define ACPI_NOTIFY_MAX                 0x0C
 573
 574 /*
 575  * Types associated with ACPI names and objects. The first group of
 576  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 577  * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
 578  * only add to the first group if the spec changes.
 579  *
 580  * NOTE: Types must be kept in sync with the global AcpiNsProperties
 581  * and AcpiNsTypeNames arrays.
 582  */
 583 typedef UINT32                          ACPI_OBJECT_TYPE;
 584
 585 #define ACPI_TYPE_ANY                   0x00
 586 #define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
 587 #define ACPI_TYPE_STRING                0x02
 588 #define ACPI_TYPE_BUFFER                0x03
 589 #define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
 590 #define ACPI_TYPE_FIELD_UNIT            0x05
 591 #define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
 592 #define ACPI_TYPE_EVENT                 0x07
 593 #define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
 594 #define ACPI_TYPE_MUTEX                 0x09
 595 #define ACPI_TYPE_REGION                0x0A
 596 #define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
 597 #define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
 598 #define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
 599 #define ACPI_TYPE_BUFFER_FIELD          0x0E
 600 #define ACPI_TYPE_DDB_HANDLE            0x0F
 601 #define ACPI_TYPE_DEBUG_OBJECT          0x10
 602
 603 #define ACPI_TYPE_EXTERNAL_MAX          0x10
 604
 605 /*
 606  * These are object types that do not map directly to the ACPI
 607  * ObjectType() operator. They are used for various internal purposes only.
 608  * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 609  * internal types must move upwards. (There is code that depends on these
 610  * values being contiguous with the external types above.)
 611  */
 612 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
 613 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
 614 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
 615 #define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
 616 #define ACPI_TYPE_LOCAL_ALIAS           0x15
 617 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
 618 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
 619 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
 620 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
 621 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
 622 #define ACPI_TYPE_LOCAL_SCOPE           0x1B  /* 1 Name, multiple ObjectList Nodes */
 623
 624 #define ACPI_TYPE_NS_NODE_MAX           0x1B  /* Last typecode used within a NS Node */
 625
 626 /*
 627  * These are special object types that never appear in
 628  * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
 629  */
 630 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
 631 #define ACPI_TYPE_LOCAL_DATA            0x1D
 632
 633 #define ACPI_TYPE_LOCAL_MAX             0x1D
 634
 635 /* All types above here are invalid */
 636
 637 #define ACPI_TYPE_INVALID               0x1E
 638 #define ACPI_TYPE_NOT_FOUND             0xFF
 639
 640 #define ACPI_NUM_NS_TYPES               (ACPI_TYPE_INVALID + 1)
 641
 642
 643 /*
 644  * All I/O
 645  */
 646 #define ACPI_READ                       0
 647 #define ACPI_WRITE                      1
 648 #define ACPI_IO_MASK                    1
 649
 650 /*
 651  * Event Types: Fixed & General Purpose
 652  */
 653 typedef UINT32                          ACPI_EVENT_TYPE;
 654
 655 /*
 656  * Fixed events
 657  */
 658 #define ACPI_EVENT_PMTIMER              0
 659 #define ACPI_EVENT_GLOBAL               1
 660 #define ACPI_EVENT_POWER_BUTTON         2
 661 #define ACPI_EVENT_SLEEP_BUTTON         3
 662 #define ACPI_EVENT_RTC                  4
 663 #define ACPI_EVENT_MAX                  4
 664 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
 665
 666 /*
 667  * Event Status - Per event
 668  * -------------
 669  * The encoding of ACPI_EVENT_STATUS is illustrated below.
 670  * Note that a set bit (1) indicates the property is TRUE
 671  * (e.g. if bit 0 is set then the event is enabled).
 672  * +-------------+-+-+-+
 673  * |   Bits 31:3 |2|1|0|
 674  * +-------------+-+-+-+
 675  *          |     | | |
 676  *          |     | | +- Enabled?
 677  *          |     | +--- Enabled for wake?
 678  *          |     +----- Set?
 679  *          +----------- <Reserved>
 680  */
 681 typedef UINT32                          ACPI_EVENT_STATUS;
 682
 683 #define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
 684 #define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
 685 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
 686 #define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
 687
 688 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
 689
 690 #define ACPI_GPE_ENABLE                 0
 691 #define ACPI_GPE_DISABLE                1
 692 #define ACPI_GPE_CONDITIONAL_ENABLE     2
 693
 694 /*
 695  * GPE info flags - Per GPE
 696  * +-------+-+-+---+
 697  * |  7:4  |3|2|1:0|
 698  * +-------+-+-+---+
 699  *     |    | |  |
 700  *     |    | |  +-- Type of dispatch:to method, handler, notify, or none
 701  *     |    | +----- Interrupt type: edge or level triggered
 702  *     |    +------- Is a Wake GPE
 703  *     +------------ <Reserved>
 704  */
 705 #define ACPI_GPE_DISPATCH_NONE          (UINT8) 0x00
 706 #define ACPI_GPE_DISPATCH_METHOD        (UINT8) 0x01
 707 #define ACPI_GPE_DISPATCH_HANDLER       (UINT8) 0x02
 708 #define ACPI_GPE_DISPATCH_NOTIFY        (UINT8) 0x03
 709 #define ACPI_GPE_DISPATCH_MASK          (UINT8) 0x03
 710
 711 #define ACPI_GPE_LEVEL_TRIGGERED        (UINT8) 0x04
 712 #define ACPI_GPE_EDGE_TRIGGERED         (UINT8) 0x00
 713 #define ACPI_GPE_XRUPT_TYPE_MASK        (UINT8) 0x04
 714
 715 #define ACPI_GPE_CAN_WAKE               (UINT8) 0x08
 716
 717 /*
 718  * Flags for GPE and Lock interfaces
 719  */
 720 #define ACPI_NOT_ISR                    0x1
 721 #define ACPI_ISR                        0x0
 722
 723
 724 /* Notify types */
 725
 726 #define ACPI_SYSTEM_NOTIFY              0x1
 727 #define ACPI_DEVICE_NOTIFY              0x2
 728 #define ACPI_ALL_NOTIFY                 (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
 729 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
 730 #define ACPI_NUM_NOTIFY_TYPES           2
 731
 732 #define ACPI_MAX_SYS_NOTIFY             0x7F
 733 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
 734
 735 #define ACPI_SYSTEM_HANDLER_LIST        0 /* Used as index, must be SYSTEM_NOTIFY -1 */
 736 #define ACPI_DEVICE_HANDLER_LIST        1 /* Used as index, must be DEVICE_NOTIFY -1 */
 737
 738
 739 /* Address Space (Operation Region) Types */
 740
 741 typedef UINT8                           ACPI_ADR_SPACE_TYPE;
 742
 743 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
 744 #define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
 745 #define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
 746 #define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
 747 #define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
 748 #define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
 749 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
 750 #define ACPI_ADR_SPACE_IPMI             (ACPI_ADR_SPACE_TYPE) 7
 751 #define ACPI_ADR_SPACE_GPIO             (ACPI_ADR_SPACE_TYPE) 8
 752 #define ACPI_ADR_SPACE_GSBUS            (ACPI_ADR_SPACE_TYPE) 9
 753 #define ACPI_ADR_SPACE_PLATFORM_COMM    (ACPI_ADR_SPACE_TYPE) 10
 754
 755 #define ACPI_NUM_PREDEFINED_REGIONS     11
 756
 757 /*
 758  * Special Address Spaces
 759  *
 760  * Note: A Data Table region is a special type of operation region
 761  * that has its own AML opcode. However, internally, the AML
 762  * interpreter simply creates an operation region with an an address
 763  * space type of ACPI_ADR_SPACE_DATA_TABLE.
 764  */
 765 #define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
 766 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 0x7F
 767
 768 /* Values for _REG connection code */
 769
 770 #define ACPI_REG_DISCONNECT             0
 771 #define ACPI_REG_CONNECT                1
 772
 773 /*
 774  * BitRegister IDs
 775  *
 776  * These values are intended to be used by the hardware interfaces
 777  * and are mapped to individual bitfields defined within the ACPI
 778  * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
 779  * for this mapping.
 780  */
 781
 782 /* PM1 Status register */
 783
 784 #define ACPI_BITREG_TIMER_STATUS                0x00
 785 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
 786 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
 787 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
 788 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
 789 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
 790 #define ACPI_BITREG_WAKE_STATUS                 0x06
 791 #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
 792
 793 /* PM1 Enable register */
 794
 795 #define ACPI_BITREG_TIMER_ENABLE                0x08
 796 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
 797 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
 798 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
 799 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
 800 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0D
 801
 802 /* PM1 Control register */
 803
 804 #define ACPI_BITREG_SCI_ENABLE                  0x0E
 805 #define ACPI_BITREG_BUS_MASTER_RLD              0x0F
 806 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x10
 807 #define ACPI_BITREG_SLEEP_TYPE                  0x11
 808 #define ACPI_BITREG_SLEEP_ENABLE                0x12
 809
 810 /* PM2 Control register */
 811
 812 #define ACPI_BITREG_ARB_DISABLE                 0x13
 813
 814 #define ACPI_BITREG_MAX                         0x13
 815 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
 816
 817
 818 /* Status register values. A 1 clears a status bit. 0 = no effect */
 819
 820 #define ACPI_CLEAR_STATUS                       1
 821
 822 /* Enable and Control register values */
 823
 824 #define ACPI_ENABLE_EVENT                       1
 825 #define ACPI_DISABLE_EVENT                      0
 826
 827
 828 /* Sleep function dispatch */
 829
 830 typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) (
 831     UINT8                   SleepState);
 832
 833 typedef struct acpi_sleep_functions
 834 {
 835     ACPI_SLEEP_FUNCTION     LegacyFunction;
 836     ACPI_SLEEP_FUNCTION     ExtendedFunction;
 837
 838 } ACPI_SLEEP_FUNCTIONS;
 839
 840
 841 /*
 842  * External ACPI object definition
 843  */
 844
 845 /*
 846  * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
 847  * or an unresolved named reference.
 848  */
 849 typedef union acpi_object
 850 {
 851     ACPI_OBJECT_TYPE                Type;   /* See definition of AcpiNsType for values */
 852     struct
 853     {
 854         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_INTEGER */
 855         UINT64                          Value;      /* The actual number */
 856     } Integer;
 857
 858     struct
 859     {
 860         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_STRING */
 861         UINT32                          Length;     /* # of bytes in string, excluding trailing null */
 862         char                            *Pointer;   /* points to the string value */
 863     } String;
 864
 865     struct
 866     {
 867         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_BUFFER */
 868         UINT32                          Length;     /* # of bytes in buffer */
 869         UINT8                           *Pointer;   /* points to the buffer */
 870     } Buffer;
 871
 872     struct
 873     {
 874         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PACKAGE */
 875         UINT32                          Count;      /* # of elements in package */
 876         union acpi_object               *Elements;  /* Pointer to an array of ACPI_OBJECTs */
 877     } Package;
 878
 879     struct
 880     {
 881         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_LOCAL_REFERENCE */
 882         ACPI_OBJECT_TYPE                ActualType; /* Type associated with the Handle */
 883         ACPI_HANDLE                     Handle;     /* object reference */
 884     } Reference;
 885
 886     struct
 887     {
 888         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_PROCESSOR */
 889         UINT32                          ProcId;
 890         ACPI_IO_ADDRESS                 PblkAddress;
 891         UINT32                          PblkLength;
 892     } Processor;
 893
 894     struct
 895     {
 896         ACPI_OBJECT_TYPE                Type;       /* ACPI_TYPE_POWER */
 897         UINT32                          SystemLevel;
 898         UINT32                          ResourceOrder;
 899     } PowerResource;
 900
 901 } ACPI_OBJECT;
 902
 903
 904 /*
 905  * List of objects, used as a parameter list for control method evaluation
 906  */
 907 typedef struct acpi_object_list
 908 {
 909     UINT32                          Count;
 910     ACPI_OBJECT                     *Pointer;
 911
 912 } ACPI_OBJECT_LIST;
 913
 914
 915 /*
 916  * Miscellaneous common Data Structures used by the interfaces
 917  */
 918 #define ACPI_NO_BUFFER              0
 919 #define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
 920 #define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)
 921
 922 typedef struct acpi_buffer
 923 {
 924     ACPI_SIZE                       Length;         /* Length in bytes of the buffer */
 925     void                            *Pointer;       /* pointer to buffer */
 926
 927 } ACPI_BUFFER;
 928
 929 /* Free a buffer created in an ACPI_BUFFER via ACPI_ALLOCATE_LOCAL_BUFFER */
 930
 931 #define ACPI_FREE_BUFFER(b)         ACPI_FREE(b.Pointer)
 932
 933
 934 /*
 935  * NameType for AcpiGetName
 936  */
 937 #define ACPI_FULL_PATHNAME              0
 938 #define ACPI_SINGLE_NAME                1
 939 #define ACPI_NAME_TYPE_MAX              1
 940
 941
 942 /*
 943  * Predefined Namespace items
 944  */
 945 typedef struct acpi_predefined_names
 946 {
 947     char                            *Name;
 948     UINT8                           Type;
 949     char                            *Val;
 950
 951 } ACPI_PREDEFINED_NAMES;
 952
 953
 954 /*
 955  * Structure and flags for AcpiGetSystemInfo
 956  */
 957 #define ACPI_SYS_MODE_UNKNOWN           0x0000
 958 #define ACPI_SYS_MODE_ACPI              0x0001
 959 #define ACPI_SYS_MODE_LEGACY            0x0002
 960 #define ACPI_SYS_MODES_MASK             0x0003
 961
 962
 963 /*
 964  * System info returned by AcpiGetSystemInfo()
 965  */
 966 typedef struct acpi_system_info
 967 {
 968     UINT32                          AcpiCaVersion;
 969     UINT32                          Flags;
 970     UINT32                          TimerResolution;
 971     UINT32                          Reserved1;
 972     UINT32                          Reserved2;
 973     UINT32                          DebugLevel;
 974     UINT32                          DebugLayer;
 975
 976 } ACPI_SYSTEM_INFO;
 977
 978
 979 /*
 980  * System statistics returned by AcpiGetStatistics()
 981  */
 982 typedef struct acpi_statistics
 983 {
 984     UINT32                          SciCount;
 985     UINT32                          GpeCount;
 986     UINT32                          FixedEventCount[ACPI_NUM_FIXED_EVENTS];
 987     UINT32                          MethodCount;
 988
 989 } ACPI_STATISTICS;
 990
 991
 992 /* Table Event Types */
 993
 994 #define ACPI_TABLE_EVENT_LOAD           0x0
 995 #define ACPI_TABLE_EVENT_UNLOAD         0x1
 996 #define ACPI_NUM_TABLE_EVENTS           2
 997
 998
 999 /*
1000  * Types specific to the OS service interfaces
1001  */
1002 typedef UINT32
1003 (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
1004     void                            *Context);
1005
1006 typedef void
1007 (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
1008     void                            *Context);
1009
1010 /*
1011  * Various handlers and callback procedures
1012  */
1013 typedef
1014 UINT32 (*ACPI_SCI_HANDLER) (
1015     void                            *Context);
1016
1017 typedef
1018 void (*ACPI_GBL_EVENT_HANDLER) (
1019     UINT32                          EventType,
1020     ACPI_HANDLE                     Device,
1021     UINT32                          EventNumber,
1022     void                            *Context);
1023
1024 #define ACPI_EVENT_TYPE_GPE         0
1025 #define ACPI_EVENT_TYPE_FIXED       1
1026
1027 typedef
1028 UINT32 (*ACPI_EVENT_HANDLER) (
1029     void                            *Context);
1030
1031 typedef
1032 UINT32 (*ACPI_GPE_HANDLER) (
1033     ACPI_HANDLE                     GpeDevice,
1034     UINT32                          GpeNumber,
1035     void                            *Context);
1036
1037 typedef
1038 void (*ACPI_NOTIFY_HANDLER) (
1039     ACPI_HANDLE                     Device,
1040     UINT32                          Value,
1041     void                            *Context);
1042
1043 typedef
1044 void (*ACPI_OBJECT_HANDLER) (
1045     ACPI_HANDLE                     Object,
1046     void                            *Data);
1047
1048 typedef
1049 ACPI_STATUS (*ACPI_INIT_HANDLER) (
1050     ACPI_HANDLE                     Object,
1051     UINT32                          Function);
1052
1053 #define ACPI_INIT_DEVICE_INI        1
1054
1055 typedef
1056 ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
1057     ACPI_STATUS                     AmlStatus,
1058     ACPI_NAME                       Name,
1059     UINT16                          Opcode,
1060     UINT32                          AmlOffset,
1061     void                            *Context);
1062
1063 /* Table Event handler (Load, LoadTable, etc.) and types */
1064
1065 typedef
1066 ACPI_STATUS (*ACPI_TABLE_HANDLER) (
1067     UINT32                          Event,
1068     void                            *Table,
1069     void                            *Context);
1070
1071 #define ACPI_TABLE_LOAD             0x0
1072 #define ACPI_TABLE_UNLOAD           0x1
1073 #define ACPI_NUM_TABLE_EVENTS       2
1074
1075
1076 /* Address Spaces (For Operation Regions) */
1077
1078 typedef
1079 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
1080     UINT32                          Function,
1081     ACPI_PHYSICAL_ADDRESS           Address,
1082     UINT32                          BitWidth,
1083     UINT64                          *Value,
1084     void                            *HandlerContext,
1085     void                            *RegionContext);
1086
1087 #define ACPI_DEFAULT_HANDLER            NULL
1088
1089 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1090
1091 typedef struct acpi_connection_info
1092 {
1093     UINT8                           *Connection;
1094     UINT16                          Length;
1095     UINT8                           AccessLength;
1096
1097 } ACPI_CONNECTION_INFO;
1098
1099
1100 typedef
1101 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
1102     ACPI_HANDLE                     RegionHandle,
1103     UINT32                          Function,
1104     void                            *HandlerContext,
1105     void                            **RegionContext);
1106
1107 #define ACPI_REGION_ACTIVATE    0
1108 #define ACPI_REGION_DEACTIVATE  1
1109
1110 typedef
1111 ACPI_STATUS (*ACPI_WALK_CALLBACK) (
1112     ACPI_HANDLE                     Object,
1113     UINT32                          NestingLevel,
1114     void                            *Context,
1115     void                            **ReturnValue);
1116
1117 typedef
1118 UINT32 (*ACPI_INTERFACE_HANDLER) (
1119     ACPI_STRING                     InterfaceName,
1120     UINT32                          Supported);
1121
1122
1123 /* Interrupt handler return values */
1124
1125 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
1126 #define ACPI_INTERRUPT_HANDLED          0x01
1127
1128 /* GPE handler return values */
1129
1130 #define ACPI_REENABLE_GPE               0x80
1131
1132
1133 /* Length of 32-bit EISAID values when converted back to a string */
1134
1135 #define ACPI_EISAID_STRING_SIZE         8   /* Includes null terminator */
1136
1137 /* Length of UUID (string) values */
1138
1139 #define ACPI_UUID_LENGTH                16
1140
1141
1142 /* Structures used for device/processor HID, UID, CID, and SUB */
1143
1144 typedef struct acpi_pnp_device_id
1145 {
1146     UINT32                          Length;             /* Length of string + null */
1147     char                            *String;
1148
1149 } ACPI_PNP_DEVICE_ID;
1150
1151 typedef struct acpi_pnp_device_id_list
1152 {
1153     UINT32                          Count;              /* Number of IDs in Ids array */
1154     UINT32                          ListSize;           /* Size of list, including ID strings */
1155     ACPI_PNP_DEVICE_ID              Ids[1];             /* ID array */
1156
1157 } ACPI_PNP_DEVICE_ID_LIST;
1158
1159 /*
1160  * Structure returned from AcpiGetObjectInfo.
1161  * Optimized for both 32- and 64-bit builds
1162  */
1163 typedef struct acpi_device_info
1164 {
1165     UINT32                          InfoSize;           /* Size of info, including ID strings */
1166     UINT32                          Name;               /* ACPI object Name */
1167     ACPI_OBJECT_TYPE                Type;               /* ACPI object Type */
1168     UINT8                           ParamCount;         /* If a method, required parameter count */
1169     UINT8                           Valid;              /* Indicates which optional fields are valid */
1170     UINT8                           Flags;              /* Miscellaneous info */
1171     UINT8                           HighestDstates[4];  /* _SxD values: 0xFF indicates not valid */
1172     UINT8                           LowestDstates[5];   /* _SxW values: 0xFF indicates not valid */
1173     UINT32                          CurrentStatus;      /* _STA value */
1174     UINT64                          Address;            /* _ADR value */
1175     ACPI_PNP_DEVICE_ID              HardwareId;         /* _HID value */
1176     ACPI_PNP_DEVICE_ID              UniqueId;           /* _UID value */
1177     ACPI_PNP_DEVICE_ID              SubsystemId;        /* _SUB value */
1178     ACPI_PNP_DEVICE_ID_LIST         CompatibleIdList;   /* _CID list <must be last> */
1179
1180 } ACPI_DEVICE_INFO;
1181
1182 /* Values for Flags field above (AcpiGetObjectInfo) */
1183
1184 #define ACPI_PCI_ROOT_BRIDGE            0x01
1185
1186 /* Flags for Valid field above (AcpiGetObjectInfo) */
1187
1188 #define ACPI_VALID_STA                  0x01
1189 #define ACPI_VALID_ADR                  0x02
1190 #define ACPI_VALID_HID                  0x04
1191 #define ACPI_VALID_UID                  0x08
1192 #define ACPI_VALID_SUB                  0x10
1193 #define ACPI_VALID_CID                  0x20
1194 #define ACPI_VALID_SXDS                 0x40
1195 #define ACPI_VALID_SXWS                 0x80
1196
1197 /* Flags for _STA return value (CurrentStatus above) */
1198
1199 #define ACPI_STA_DEVICE_PRESENT         0x01
1200 #define ACPI_STA_DEVICE_ENABLED         0x02
1201 #define ACPI_STA_DEVICE_UI              0x04
1202 #define ACPI_STA_DEVICE_FUNCTIONING     0x08
1203 #define ACPI_STA_DEVICE_OK              0x08 /* Synonym */
1204 #define ACPI_STA_BATTERY_PRESENT        0x10
1205
1206
1207 /* Context structs for address space handlers */
1208
1209 typedef struct acpi_pci_id
1210 {
1211     UINT16                          Segment;
1212     UINT16                          Bus;
1213     UINT16                          Device;
1214     UINT16                          Function;
1215
1216 } ACPI_PCI_ID;
1217
1218 typedef struct acpi_mem_space_context
1219 {
1220     UINT32                          Length;
1221     ACPI_PHYSICAL_ADDRESS           Address;
1222     ACPI_PHYSICAL_ADDRESS           MappedPhysicalAddress;
1223     UINT8                           *MappedLogicalAddress;
1224     ACPI_SIZE                       MappedLength;
1225
1226 } ACPI_MEM_SPACE_CONTEXT;
1227
1228
1229 /*
1230  * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1231  */
1232 typedef struct acpi_memory_list
1233 {
1234     char                            *ListName;
1235     void                            *ListHead;
1236     UINT16                          ObjectSize;
1237     UINT16                          MaxDepth;
1238     UINT16                          CurrentDepth;
1239
1240 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1241
1242     /* Statistics for debug memory tracking only */
1243
1244     UINT32                          TotalAllocated;
1245     UINT32                          TotalFreed;
1246     UINT32                          MaxOccupied;
1247     UINT32                          TotalSize;
1248     UINT32                          CurrentTotalSize;
1249     UINT32                          Requests;
1250     UINT32                          Hits;
1251 #endif
1252
1253 } ACPI_MEMORY_LIST;
1254
1255
1256 /* Definitions of _OSI support */
1257
1258 #define ACPI_VENDOR_STRINGS                 0x01
1259 #define ACPI_FEATURE_STRINGS                0x02
1260 #define ACPI_ENABLE_INTERFACES              0x00
1261 #define ACPI_DISABLE_INTERFACES             0x04
1262
1263 #define ACPI_DISABLE_ALL_VENDOR_STRINGS     (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1264 #define ACPI_DISABLE_ALL_FEATURE_STRINGS    (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1265 #define ACPI_DISABLE_ALL_STRINGS            (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1266 #define ACPI_ENABLE_ALL_VENDOR_STRINGS      (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1267 #define ACPI_ENABLE_ALL_FEATURE_STRINGS     (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1268 #define ACPI_ENABLE_ALL_STRINGS             (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1269
1270 #define ACPI_OSI_WIN_2000               0x01
1271 #define ACPI_OSI_WIN_XP                 0x02
1272 #define ACPI_OSI_WIN_XP_SP1             0x03
1273 #define ACPI_OSI_WINSRV_2003            0x04
1274 #define ACPI_OSI_WIN_XP_SP2             0x05
1275 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1276 #define ACPI_OSI_WIN_VISTA              0x07
1277 #define ACPI_OSI_WINSRV_2008            0x08
1278 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1279 #define ACPI_OSI_WIN_VISTA_SP2          0x0A
1280 #define ACPI_OSI_WIN_7                  0x0B
1281 #define ACPI_OSI_WIN_8                  0x0C
1282
1283
1284 #endif /* __ACTYPES_H__ */