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