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