sys/contrib/dev/acpica-unix-20040527/include/actypes.h

   1 /******************************************************************************
   2  *
   3  * Name: actypes.h - Common data types for the entire ACPI subsystem
   4  *       $Revision: 270 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #ifndef __ACTYPES_H__
 118 #define __ACTYPES_H__
 119
 120 /*! [Begin] no source code translation (keep the typedefs) */
 121
 122
 123
 124 /*
 125  * Data type ranges
 126  * Note: These macros are designed to be compiler independent as well as
 127  * working around problems that some 32-bit compilers have with 64-bit
 128  * constants.
 129  */
 130 #define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
 131 #define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
 132 #define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
 133 #define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
 134 #define ACPI_ASCII_MAX                  0x7F
 135
 136
 137 #ifdef DEFINE_ALTERNATE_TYPES
 138 /*
 139  * Types used only in translated source, defined here to enable
 140  * cross-platform compilation only.
 141  */
 142 typedef int                             s32;
 143 typedef unsigned char                   u8;
 144 typedef unsigned short                  u16;
 145 typedef unsigned int                    u32;
 146 typedef COMPILER_DEPENDENT_UINT64       u64;
 147
 148 #endif
 149
 150
 151 /*
 152  * Data types - Fixed across all compilation models (16/32/64)
 153  *
 154  * BOOLEAN          Logical Boolean.
 155  * INT8             8-bit  (1 byte) signed value
 156  * UINT8            8-bit  (1 byte) unsigned value
 157  * INT16            16-bit (2 byte) signed value
 158  * UINT16           16-bit (2 byte) unsigned value
 159  * INT32            32-bit (4 byte) signed value
 160  * UINT32           32-bit (4 byte) unsigned value
 161  * INT64            64-bit (8 byte) signed value
 162  * UINT64           64-bit (8 byte) unsigned value
 163  * ACPI_NATIVE_INT  32-bit on IA-32, 64-bit on IA-64 signed value
 164  * ACPI_NATIVE_UINT 32-bit on IA-32, 64-bit on IA-64 unsigned value
 165  */
 166
 167 #ifndef ACPI_MACHINE_WIDTH
 168 #error ACPI_MACHINE_WIDTH not defined
 169 #endif
 170
 171 #if ACPI_MACHINE_WIDTH == 64
 172
 173 /*! [Begin] no source code translation (keep the typedefs) */
 174
 175 /*
 176  * 64-bit type definitions
 177  */
 178 typedef unsigned char                   UINT8;
 179 typedef unsigned char                   BOOLEAN;
 180 typedef unsigned short                  UINT16;
 181 typedef int                             INT32;
 182 typedef unsigned int                    UINT32;
 183 typedef COMPILER_DEPENDENT_INT64        INT64;
 184 typedef COMPILER_DEPENDENT_UINT64       UINT64;
 185
 186 /*! [End] no source code translation !*/
 187
 188 typedef INT64                           ACPI_NATIVE_INT;
 189 typedef UINT64                          ACPI_NATIVE_UINT;
 190
 191 typedef UINT64                          ACPI_TABLE_PTR;
 192 typedef UINT64                          ACPI_IO_ADDRESS;
 193 typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
 194 typedef UINT64                          ACPI_SIZE;
 195
 196 #define ALIGNED_ADDRESS_BOUNDARY        0x00000008      /* No hardware alignment support in IA64 */
 197 #define ACPI_USE_NATIVE_DIVIDE                          /* Native 64-bit integer support */
 198 #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
 199 #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
 200
 201
 202 #elif ACPI_MACHINE_WIDTH == 16
 203
 204 /*! [Begin] no source code translation (keep the typedefs) */
 205
 206 /*
 207  * 16-bit type definitions
 208  */
 209 typedef unsigned char                   UINT8;
 210 typedef unsigned char                   BOOLEAN;
 211 typedef unsigned int                    UINT16;
 212 typedef long                            INT32;
 213 typedef int                             INT16;
 214 typedef unsigned long                   UINT32;
 215
 216 typedef struct
 217 {
 218     UINT32                                  Lo;
 219     UINT32                                  Hi;
 220
 221 } UINT64;
 222
 223 /*! [End] no source code translation !*/
 224
 225 typedef UINT16                          ACPI_NATIVE_UINT;
 226 typedef INT16                           ACPI_NATIVE_INT;
 227
 228 typedef UINT32                          ACPI_TABLE_PTR;
 229 typedef UINT32                          ACPI_IO_ADDRESS;
 230 typedef char                            *ACPI_PHYSICAL_ADDRESS;
 231 typedef UINT16                          ACPI_SIZE;
 232
 233 #define ALIGNED_ADDRESS_BOUNDARY        0x00000002
 234 #define ACPI_MISALIGNED_TRANSFERS
 235 #define ACPI_USE_NATIVE_DIVIDE                          /* No 64-bit integers, ok to use native divide */
 236 #define ACPI_MAX_PTR                    ACPI_UINT16_MAX
 237 #define ACPI_SIZE_MAX                   ACPI_UINT16_MAX
 238
 239 /*
 240  * (16-bit only) internal integers must be 32-bits, so
 241  * 64-bit integers cannot be supported
 242  */
 243 #define ACPI_NO_INTEGER64_SUPPORT
 244
 245
 246 #elif ACPI_MACHINE_WIDTH == 32
 247
 248 /*! [Begin] no source code translation (keep the typedefs) */
 249
 250 /*
 251  * 32-bit type definitions (default)
 252  */
 253 typedef unsigned char                   UINT8;
 254 typedef unsigned char                   BOOLEAN;
 255 typedef unsigned short                  UINT16;
 256 typedef int                             INT32;
 257 typedef unsigned int                    UINT32;
 258 typedef COMPILER_DEPENDENT_INT64        INT64;
 259 typedef COMPILER_DEPENDENT_UINT64       UINT64;
 260
 261 /*! [End] no source code translation !*/
 262
 263 typedef INT32                           ACPI_NATIVE_INT;
 264 typedef UINT32                          ACPI_NATIVE_UINT;
 265
 266 typedef UINT64                          ACPI_TABLE_PTR;
 267 typedef UINT32                          ACPI_IO_ADDRESS;
 268 typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
 269 typedef UINT32                          ACPI_SIZE;
 270
 271 #define ALIGNED_ADDRESS_BOUNDARY        0x00000004
 272 #define ACPI_MISALIGNED_TRANSFERS
 273 #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
 274 #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
 275
 276 #else
 277 #error unknown ACPI_MACHINE_WIDTH
 278 #endif
 279
 280
 281 /*
 282  * Miscellaneous common types
 283  */
 284 typedef UINT16                          UINT16_BIT;
 285 typedef UINT32                          UINT32_BIT;
 286 typedef ACPI_NATIVE_UINT                ACPI_PTRDIFF;
 287
 288 /*
 289  * Pointer overlays to avoid lots of typecasting for
 290  * code that accepts both physical and logical pointers.
 291  */
 292 typedef union acpi_pointers
 293 {
 294     ACPI_PHYSICAL_ADDRESS       Physical;
 295     void                        *Logical;
 296     ACPI_TABLE_PTR              Value;
 297
 298 } ACPI_POINTERS;
 299
 300 typedef struct acpi_pointer
 301 {
 302     UINT32                      PointerType;
 303     union acpi_pointers         Pointer;
 304
 305 } ACPI_POINTER;
 306
 307 /* PointerTypes for above */
 308
 309 #define ACPI_PHYSICAL_POINTER           0x01
 310 #define ACPI_LOGICAL_POINTER            0x02
 311
 312 /* Processor mode */
 313
 314 #define ACPI_PHYSICAL_ADDRESSING        0x04
 315 #define ACPI_LOGICAL_ADDRESSING         0x08
 316 #define ACPI_MEMORY_MODE                0x0C
 317
 318 #define ACPI_PHYSMODE_PHYSPTR           ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
 319 #define ACPI_LOGMODE_PHYSPTR            ACPI_LOGICAL_ADDRESSING  | ACPI_PHYSICAL_POINTER
 320 #define ACPI_LOGMODE_LOGPTR             ACPI_LOGICAL_ADDRESSING  | ACPI_LOGICAL_POINTER
 321
 322
 323 /*
 324  * Useful defines
 325  */
 326 #ifdef FALSE
 327 #undef FALSE
 328 #endif
 329 #define FALSE                           (1 == 0)
 330
 331 #ifdef TRUE
 332 #undef TRUE
 333 #endif
 334 #define TRUE                            (1 == 1)
 335
 336 #ifndef NULL
 337 #define NULL                            (void *) 0
 338 #endif
 339
 340
 341 /*
 342  * Local datatypes
 343  */
 344 typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
 345 typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
 346 typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
 347 typedef void *                          ACPI_HANDLE;    /* Actually a ptr to an Node */
 348
 349 typedef struct uint64_struct
 350 {
 351     UINT32                      Lo;
 352     UINT32                      Hi;
 353
 354 } UINT64_STRUCT;
 355
 356 typedef union uint64_overlay
 357 {
 358     UINT64                      Full;
 359     UINT64_STRUCT               Part;
 360
 361 } UINT64_OVERLAY;
 362
 363 typedef struct uint32_struct
 364 {
 365     UINT32                      Lo;
 366     UINT32                      Hi;
 367
 368 } UINT32_STRUCT;
 369
 370
 371 /*
 372  * Acpi integer width. In ACPI version 1, integers are
 373  * 32 bits.  In ACPI version 2, integers are 64 bits.
 374  * Note that this pertains to the ACPI integer type only, not
 375  * other integers used in the implementation of the ACPI CA
 376  * subsystem.
 377  */
 378 #ifdef ACPI_NO_INTEGER64_SUPPORT
 379
 380 /* 32-bit integers only, no 64-bit support */
 381
 382 typedef UINT32                          ACPI_INTEGER;
 383 #define ACPI_INTEGER_MAX                ACPI_UINT32_MAX
 384 #define ACPI_INTEGER_BIT_SIZE           32
 385 #define ACPI_MAX_DECIMAL_DIGITS         10
 386
 387 #define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 32-bit divide */
 388
 389
 390 #else
 391
 392 /* 64-bit integers */
 393
 394 typedef UINT64                          ACPI_INTEGER;
 395 #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
 396 #define ACPI_INTEGER_BIT_SIZE           64
 397 #define ACPI_MAX_DECIMAL_DIGITS         19
 398
 399 #if ACPI_MACHINE_WIDTH == 64
 400 #define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 64-bit divide */
 401 #endif
 402 #endif
 403
 404
 405 /*
 406  * Constants with special meanings
 407  */
 408 #define ACPI_ROOT_OBJECT                (ACPI_HANDLE) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR)
 409
 410
 411 /*
 412  * Initialization sequence
 413  */
 414 #define ACPI_FULL_INITIALIZATION        0x00
 415 #define ACPI_NO_ADDRESS_SPACE_INIT      0x01
 416 #define ACPI_NO_HARDWARE_INIT           0x02
 417 #define ACPI_NO_EVENT_INIT              0x04
 418 #define ACPI_NO_HANDLER_INIT            0x08
 419 #define ACPI_NO_ACPI_ENABLE             0x10
 420 #define ACPI_NO_DEVICE_INIT             0x20
 421 #define ACPI_NO_OBJECT_INIT             0x40
 422
 423 /*
 424  * Initialization state
 425  */
 426 #define ACPI_INITIALIZED_OK             0x01
 427
 428 /*
 429  * Power state values
 430  */
 431 #define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
 432
 433 #define ACPI_STATE_S0                   (UINT8) 0
 434 #define ACPI_STATE_S1                   (UINT8) 1
 435 #define ACPI_STATE_S2                   (UINT8) 2
 436 #define ACPI_STATE_S3                   (UINT8) 3
 437 #define ACPI_STATE_S4                   (UINT8) 4
 438 #define ACPI_STATE_S5                   (UINT8) 5
 439 #define ACPI_S_STATES_MAX               ACPI_STATE_S5
 440 #define ACPI_S_STATE_COUNT              6
 441
 442 #define ACPI_STATE_D0                   (UINT8) 0
 443 #define ACPI_STATE_D1                   (UINT8) 1
 444 #define ACPI_STATE_D2                   (UINT8) 2
 445 #define ACPI_STATE_D3                   (UINT8) 3
 446 #define ACPI_D_STATES_MAX               ACPI_STATE_D3
 447 #define ACPI_D_STATE_COUNT              4
 448
 449 #define ACPI_STATE_C0                   (UINT8) 0
 450 #define ACPI_STATE_C1                   (UINT8) 1
 451 #define ACPI_STATE_C2                   (UINT8) 2
 452 #define ACPI_STATE_C3                   (UINT8) 3
 453 #define ACPI_C_STATES_MAX               ACPI_STATE_C3
 454 #define ACPI_C_STATE_COUNT              4
 455
 456 /*
 457  * Sleep type invalid value
 458  */
 459 #define ACPI_SLEEP_TYPE_MAX             0x7
 460 #define ACPI_SLEEP_TYPE_INVALID         0xFF
 461
 462 /*
 463  * Standard notify values
 464  */
 465 #define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0
 466 #define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 1
 467 #define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 2
 468 #define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 3
 469 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 4
 470 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 5
 471 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 6
 472 #define ACPI_NOTIFY_POWER_FAULT         (UINT8) 7
 473
 474 /*
 475  *  Table types.  These values are passed to the table related APIs
 476  */
 477 typedef UINT32                          ACPI_TABLE_TYPE;
 478
 479 #define ACPI_TABLE_RSDP                 (ACPI_TABLE_TYPE) 0
 480 #define ACPI_TABLE_DSDT                 (ACPI_TABLE_TYPE) 1
 481 #define ACPI_TABLE_FADT                 (ACPI_TABLE_TYPE) 2
 482 #define ACPI_TABLE_FACS                 (ACPI_TABLE_TYPE) 3
 483 #define ACPI_TABLE_PSDT                 (ACPI_TABLE_TYPE) 4
 484 #define ACPI_TABLE_SSDT                 (ACPI_TABLE_TYPE) 5
 485 #define ACPI_TABLE_XSDT                 (ACPI_TABLE_TYPE) 6
 486 #define ACPI_TABLE_MAX                  6
 487 #define NUM_ACPI_TABLE_TYPES            (ACPI_TABLE_MAX+1)
 488
 489 /*
 490  * Types associated with ACPI names and objects.  The first group of
 491  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 492  * of the ACPI ObjectType() operator (See the ACPI Spec).  Therefore,
 493  * only add to the first group if the spec changes.
 494  *
 495  * NOTE: Types must be kept in sync with the global AcpiNsProperties
 496  * and AcpiNsTypeNames arrays.
 497  */
 498 typedef UINT32                          ACPI_OBJECT_TYPE;
 499
 500 #define ACPI_TYPE_ANY                   0x00
 501 #define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
 502 #define ACPI_TYPE_STRING                0x02
 503 #define ACPI_TYPE_BUFFER                0x03
 504 #define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
 505 #define ACPI_TYPE_FIELD_UNIT            0x05
 506 #define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
 507 #define ACPI_TYPE_EVENT                 0x07
 508 #define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
 509 #define ACPI_TYPE_MUTEX                 0x09
 510 #define ACPI_TYPE_REGION                0x0A
 511 #define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
 512 #define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
 513 #define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
 514 #define ACPI_TYPE_BUFFER_FIELD          0x0E
 515 #define ACPI_TYPE_DDB_HANDLE            0x0F
 516 #define ACPI_TYPE_DEBUG_OBJECT          0x10
 517
 518 #define ACPI_TYPE_EXTERNAL_MAX          0x10
 519
 520 /*
 521  * These are object types that do not map directly to the ACPI
 522  * ObjectType() operator. They are used for various internal purposes only.
 523  * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 524  * internal types must move upwards. (There is code that depends on these
 525  * values being contiguous with the external types above.)
 526  */
 527 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
 528 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
 529 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
 530 #define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
 531 #define ACPI_TYPE_LOCAL_ALIAS           0x15
 532 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
 533 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
 534 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
 535 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
 536 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
 537 #define ACPI_TYPE_LOCAL_SCOPE           0x1B  /* 1 Name, multiple ObjectList Nodes */
 538
 539 #define ACPI_TYPE_NS_NODE_MAX           0x1B  /* Last typecode used within a NS Node */
 540
 541 /*
 542  * These are special object types that never appear in
 543  * a Namespace node, only in an ACPI_OPERAND_OBJECT
 544  */
 545 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
 546 #define ACPI_TYPE_LOCAL_DATA            0x1D
 547
 548 #define ACPI_TYPE_LOCAL_MAX             0x1D
 549
 550 /* All types above here are invalid */
 551
 552 #define ACPI_TYPE_INVALID               0x1E
 553 #define ACPI_TYPE_NOT_FOUND             0xFF
 554
 555
 556 /*
 557  * Bitmapped ACPI types.  Used internally only
 558  */
 559 #define ACPI_BTYPE_ANY                  0x00000000
 560 #define ACPI_BTYPE_INTEGER              0x00000001
 561 #define ACPI_BTYPE_STRING               0x00000002
 562 #define ACPI_BTYPE_BUFFER               0x00000004
 563 #define ACPI_BTYPE_PACKAGE              0x00000008
 564 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
 565 #define ACPI_BTYPE_DEVICE               0x00000020
 566 #define ACPI_BTYPE_EVENT                0x00000040
 567 #define ACPI_BTYPE_METHOD               0x00000080
 568 #define ACPI_BTYPE_MUTEX                0x00000100
 569 #define ACPI_BTYPE_REGION               0x00000200
 570 #define ACPI_BTYPE_POWER                0x00000400
 571 #define ACPI_BTYPE_PROCESSOR            0x00000800
 572 #define ACPI_BTYPE_THERMAL              0x00001000
 573 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
 574 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
 575 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
 576 #define ACPI_BTYPE_REFERENCE            0x00010000
 577 #define ACPI_BTYPE_RESOURCE             0x00020000
 578
 579 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
 580
 581 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
 582 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
 583 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
 584 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
 585 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
 586
 587 /*
 588  * All I/O
 589  */
 590 #define ACPI_READ                       0
 591 #define ACPI_WRITE                      1
 592 #define ACPI_IO_MASK                    1
 593
 594 /*
 595  * Event Types: Fixed & General Purpose
 596  */
 597 typedef UINT32                          ACPI_EVENT_TYPE;
 598
 599 /*
 600  * Fixed events
 601  */
 602 #define ACPI_EVENT_PMTIMER              0
 603 #define ACPI_EVENT_GLOBAL               1
 604 #define ACPI_EVENT_POWER_BUTTON         2
 605 #define ACPI_EVENT_SLEEP_BUTTON         3
 606 #define ACPI_EVENT_RTC                  4
 607 #define ACPI_EVENT_MAX                  4
 608 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
 609
 610 /*
 611  * Event Status - Per event
 612  * -------------
 613  * The encoding of ACPI_EVENT_STATUS is illustrated below.
 614  * Note that a set bit (1) indicates the property is TRUE
 615  * (e.g. if bit 0 is set then the event is enabled).
 616  * +-------------+-+-+-+
 617  * |   Bits 31:3 |2|1|0|
 618  * +-------------+-+-+-+
 619  *          |     | | |
 620  *          |     | | +- Enabled?
 621  *          |     | +--- Enabled for wake?
 622  *          |     +----- Set?
 623  *          +----------- <Reserved>
 624  */
 625 typedef UINT32                          ACPI_EVENT_STATUS;
 626
 627 #define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
 628 #define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
 629 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
 630 #define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
 631
 632 /*
 633  * General Purpose Events (GPE)
 634  */
 635 #define ACPI_GPE_INVALID                0xFF
 636 #define ACPI_GPE_MAX                    0xFF
 637 #define ACPI_NUM_GPE                    256
 638
 639 #define ACPI_GPE_ENABLE                 0
 640 #define ACPI_GPE_DISABLE                1
 641
 642
 643 /*
 644  * GPE info flags - Per GPE
 645  * +-+-+-+---+---+-+
 646  * |7|6|5|4:3|2:1|0|
 647  * +-+-+-+---+---+-+
 648  *  | | |  |   |  |
 649  *  | | |  |   |  +--- Interrupt type: Edge or Level Triggered
 650  *  | | |  |   +--- Type: Wake-only, Runtime-only, or wake/runtime
 651  *  | | |  +--- Type of dispatch -- to method, handler, or none
 652  *  | | +--- Enabled for runtime?
 653  *  | +--- Enabled for wake?
 654  *  +--- System state when GPE ocurred (running/waking)
 655  */
 656 #define ACPI_GPE_XRUPT_TYPE_MASK        (UINT8) 0x01
 657 #define ACPI_GPE_LEVEL_TRIGGERED        (UINT8) 0x01
 658 #define ACPI_GPE_EDGE_TRIGGERED         (UINT8) 0x00
 659
 660 #define ACPI_GPE_TYPE_MASK              (UINT8) 0x06
 661 #define ACPI_GPE_TYPE_WAKE_RUN          (UINT8) 0x06
 662 #define ACPI_GPE_TYPE_WAKE              (UINT8) 0x02
 663 #define ACPI_GPE_TYPE_RUNTIME           (UINT8) 0x04    /* Default */
 664
 665 #define ACPI_GPE_DISPATCH_MASK          (UINT8) 0x18
 666 #define ACPI_GPE_DISPATCH_HANDLER       (UINT8) 0x08
 667 #define ACPI_GPE_DISPATCH_METHOD        (UINT8) 0x10
 668 #define ACPI_GPE_DISPATCH_NOT_USED      (UINT8) 0x00    /* Default */
 669
 670 #define ACPI_GPE_RUN_ENABLE_MASK        (UINT8) 0x20
 671 #define ACPI_GPE_RUN_ENABLED            (UINT8) 0x20
 672 #define ACPI_GPE_RUN_DISABLED           (UINT8) 0x00    /* Default */
 673
 674 #define ACPI_GPE_WAKE_ENABLE_MASK       (UINT8) 0x40
 675 #define ACPI_GPE_WAKE_ENABLED           (UINT8) 0x40
 676 #define ACPI_GPE_WAKE_DISABLED          (UINT8) 0x00    /* Default */
 677
 678 #define ACPI_GPE_ENABLE_MASK            (UINT8) 0x60    /* Both run/wake */
 679
 680 #define ACPI_GPE_SYSTEM_MASK            (UINT8) 0x80
 681 #define ACPI_GPE_SYSTEM_RUNNING         (UINT8) 0x80
 682 #define ACPI_GPE_SYSTEM_WAKING          (UINT8) 0x00
 683
 684 /*
 685  * Flags for GPE and Lock interfaces
 686  */
 687 #define ACPI_EVENT_WAKE_ENABLE          0x2             /* AcpiGpeEnable */
 688 #define ACPI_EVENT_WAKE_DISABLE         0x2             /* AcpiGpeDisable */
 689
 690 #define ACPI_NOT_ISR                    0x1
 691 #define ACPI_ISR                        0x0
 692
 693
 694 /* Notify types */
 695
 696 #define ACPI_SYSTEM_NOTIFY              0x1
 697 #define ACPI_DEVICE_NOTIFY              0x2
 698 #define ACPI_ALL_NOTIFY                 0x3
 699 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
 700
 701 #define ACPI_MAX_SYS_NOTIFY             0x7f
 702
 703
 704 /* Address Space (Operation Region) Types */
 705
 706 typedef UINT8                           ACPI_ADR_SPACE_TYPE;
 707
 708 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
 709 #define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
 710 #define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
 711 #define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
 712 #define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
 713 #define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
 714 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
 715 #define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 7
 716 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 127
 717
 718
 719 /*
 720  * BitRegister IDs
 721  * These are bitfields defined within the full ACPI registers
 722  */
 723 #define ACPI_BITREG_TIMER_STATUS                0x00
 724 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
 725 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
 726 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
 727 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
 728 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
 729 #define ACPI_BITREG_WAKE_STATUS                 0x06
 730
 731 #define ACPI_BITREG_TIMER_ENABLE                0x07
 732 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x08
 733 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x09
 734 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0A
 735 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0B
 736 #define ACPI_BITREG_WAKE_ENABLE                 0x0C
 737
 738 #define ACPI_BITREG_SCI_ENABLE                  0x0D
 739 #define ACPI_BITREG_BUS_MASTER_RLD              0x0E
 740 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x0F
 741 #define ACPI_BITREG_SLEEP_TYPE_A                0x10
 742 #define ACPI_BITREG_SLEEP_TYPE_B                0x11
 743 #define ACPI_BITREG_SLEEP_ENABLE                0x12
 744
 745 #define ACPI_BITREG_ARB_DISABLE                 0x13
 746
 747 #define ACPI_BITREG_MAX                         0x13
 748 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
 749
 750
 751 /*
 752  * External ACPI object definition
 753  */
 754 typedef union acpi_object
 755 {
 756     ACPI_OBJECT_TYPE            Type;   /* See definition of AcpiNsType for values */
 757     struct
 758     {
 759         ACPI_OBJECT_TYPE            Type;
 760         ACPI_INTEGER                Value;      /* The actual number */
 761     } Integer;
 762
 763     struct
 764     {
 765         ACPI_OBJECT_TYPE            Type;
 766         UINT32                      Length;     /* # of bytes in string, excluding trailing null */
 767         char                        *Pointer;   /* points to the string value */
 768     } String;
 769
 770     struct
 771     {
 772         ACPI_OBJECT_TYPE            Type;
 773         UINT32                      Length;     /* # of bytes in buffer */
 774         UINT8                       *Pointer;   /* points to the buffer */
 775     } Buffer;
 776
 777     struct
 778     {
 779         ACPI_OBJECT_TYPE            Type;
 780         UINT32                      Fill1;
 781         ACPI_HANDLE                 Handle;     /* object reference */
 782     } Reference;
 783
 784     struct
 785     {
 786         ACPI_OBJECT_TYPE            Type;
 787         UINT32                      Count;      /* # of elements in package */
 788         union acpi_object           *Elements;  /* Pointer to an array of ACPI_OBJECTs */
 789     } Package;
 790
 791     struct
 792     {
 793         ACPI_OBJECT_TYPE            Type;
 794         UINT32                      ProcId;
 795         ACPI_IO_ADDRESS             PblkAddress;
 796         UINT32                      PblkLength;
 797     } Processor;
 798
 799     struct
 800     {
 801         ACPI_OBJECT_TYPE            Type;
 802         UINT32                      SystemLevel;
 803         UINT32                      ResourceOrder;
 804     } PowerResource;
 805
 806 } ACPI_OBJECT;
 807
 808
 809 /*
 810  * List of objects, used as a parameter list for control method evaluation
 811  */
 812 typedef struct acpi_object_list
 813 {
 814     UINT32                      Count;
 815     ACPI_OBJECT                 *Pointer;
 816
 817 } ACPI_OBJECT_LIST;
 818
 819
 820 /*
 821  * Miscellaneous common Data Structures used by the interfaces
 822  */
 823 #define ACPI_NO_BUFFER              0
 824 #define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
 825 #define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)
 826
 827 typedef struct acpi_buffer
 828 {
 829     ACPI_SIZE                   Length;         /* Length in bytes of the buffer */
 830     void                        *Pointer;       /* pointer to buffer */
 831
 832 } ACPI_BUFFER;
 833
 834
 835 /*
 836  * NameType for AcpiGetName
 837  */
 838 #define ACPI_FULL_PATHNAME              0
 839 #define ACPI_SINGLE_NAME                1
 840 #define ACPI_NAME_TYPE_MAX              1
 841
 842
 843 /*
 844  * Structure and flags for AcpiGetSystemInfo
 845  */
 846 #define ACPI_SYS_MODE_UNKNOWN           0x0000
 847 #define ACPI_SYS_MODE_ACPI              0x0001
 848 #define ACPI_SYS_MODE_LEGACY            0x0002
 849 #define ACPI_SYS_MODES_MASK             0x0003
 850
 851
 852 /*
 853  * ACPI Table Info.  One per ACPI table _type_
 854  */
 855 typedef struct acpi_table_info
 856 {
 857     UINT32                      Count;
 858
 859 } ACPI_TABLE_INFO;
 860
 861
 862 /*
 863  * System info returned by AcpiGetSystemInfo()
 864  */
 865 typedef struct acpi_system_info
 866 {
 867     UINT32                      AcpiCaVersion;
 868     UINT32                      Flags;
 869     UINT32                      TimerResolution;
 870     UINT32                      Reserved1;
 871     UINT32                      Reserved2;
 872     UINT32                      DebugLevel;
 873     UINT32                      DebugLayer;
 874     UINT32                      NumTableTypes;
 875     ACPI_TABLE_INFO             TableInfo [NUM_ACPI_TABLE_TYPES];
 876
 877 } ACPI_SYSTEM_INFO;
 878
 879
 880 /*
 881  * Types specific to the OS service interfaces
 882  */
 883
 884 typedef UINT32
 885 (ACPI_SYSTEM_XFACE *OSD_HANDLER) (
 886     void                    *Context);
 887
 888 typedef void
 889 (ACPI_SYSTEM_XFACE *OSD_EXECUTION_CALLBACK) (
 890     void                    *Context);
 891
 892 /*
 893  * Various handlers and callback procedures
 894  */
 895 typedef
 896 UINT32 (*ACPI_EVENT_HANDLER) (
 897     void                        *Context);
 898
 899 typedef
 900 void (*ACPI_NOTIFY_HANDLER) (
 901     ACPI_HANDLE                 Device,
 902     UINT32                      Value,
 903     void                        *Context);
 904
 905 typedef
 906 void (*ACPI_OBJECT_HANDLER) (
 907     ACPI_HANDLE                 Object,
 908     UINT32                      Function,
 909     void                        *Data);
 910
 911 typedef
 912 ACPI_STATUS (*ACPI_INIT_HANDLER) (
 913     ACPI_HANDLE                 Object,
 914     UINT32                      Function);
 915
 916 #define ACPI_INIT_DEVICE_INI        1
 917
 918
 919 /* Address Spaces (For Operation Regions) */
 920
 921 typedef
 922 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
 923     UINT32                      Function,
 924     ACPI_PHYSICAL_ADDRESS       Address,
 925     UINT32                      BitWidth,
 926     ACPI_INTEGER                *Value,
 927     void                        *HandlerContext,
 928     void                        *RegionContext);
 929
 930 #define ACPI_DEFAULT_HANDLER        NULL
 931
 932
 933 typedef
 934 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
 935     ACPI_HANDLE                 RegionHandle,
 936     UINT32                      Function,
 937     void                        *HandlerContext,
 938     void                        **RegionContext);
 939
 940 #define ACPI_REGION_ACTIVATE    0
 941 #define ACPI_REGION_DEACTIVATE  1
 942
 943 typedef
 944 ACPI_STATUS (*ACPI_WALK_CALLBACK) (
 945     ACPI_HANDLE                 ObjHandle,
 946     UINT32                      NestingLevel,
 947     void                        *Context,
 948     void                        **ReturnValue);
 949
 950
 951 /* Interrupt handler return values */
 952
 953 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
 954 #define ACPI_INTERRUPT_HANDLED          0x01
 955
 956
 957 /* Common string version of device HIDs and UIDs */
 958
 959 typedef struct acpi_device_id
 960 {
 961     char                    Value[ACPI_DEVICE_ID_LENGTH];
 962
 963 } ACPI_DEVICE_ID;
 964
 965 /* Common string version of device CIDs */
 966
 967 typedef struct acpi_compatible_id
 968 {
 969     char                    Value[ACPI_MAX_CID_LENGTH];
 970
 971 } ACPI_COMPATIBLE_ID;
 972
 973 typedef struct acpi_compatible_id_list
 974 {
 975     UINT32                  Count;
 976     UINT32                  Size;
 977     ACPI_COMPATIBLE_ID      Id[1];
 978
 979 } ACPI_COMPATIBLE_ID_LIST;
 980
 981
 982 /* Structure and flags for AcpiGetObjectInfo */
 983
 984 #define ACPI_VALID_STA                  0x0001
 985 #define ACPI_VALID_ADR                  0x0002
 986 #define ACPI_VALID_HID                  0x0004
 987 #define ACPI_VALID_UID                  0x0008
 988 #define ACPI_VALID_CID                  0x0010
 989 #define ACPI_VALID_SXDS                 0x0020
 990
 991
 992 #define ACPI_COMMON_OBJ_INFO \
 993     ACPI_OBJECT_TYPE            Type;           /* ACPI object type */ \
 994     ACPI_NAME                   Name            /* ACPI object Name */
 995
 996
 997 typedef struct acpi_obj_info_header
 998 {
 999     ACPI_COMMON_OBJ_INFO;
1000
1001 } ACPI_OBJ_INFO_HEADER;
1002
1003
1004 /* Structure returned from Get Object Info */
1005
1006 typedef struct acpi_device_info
1007 {
1008     ACPI_COMMON_OBJ_INFO;
1009
1010     UINT32                      Valid;              /* Indicates which fields below are valid */
1011     UINT32                      CurrentStatus;      /* _STA value */
1012     ACPI_INTEGER                Address;            /* _ADR value if any */
1013     ACPI_DEVICE_ID              HardwareId;         /* _HID value if any */
1014     ACPI_DEVICE_ID              UniqueId;           /* _UID value if any */
1015     UINT8                       HighestDstates[4];  /* _SxD values: 0xFF indicates not valid */
1016     ACPI_COMPATIBLE_ID_LIST     CompatibilityId;    /* List of _CIDs if any */
1017
1018 } ACPI_DEVICE_INFO;
1019
1020
1021 /* Context structs for address space handlers */
1022
1023 typedef struct acpi_pci_id
1024 {
1025     UINT16                      Segment;
1026     UINT16                      Bus;
1027     UINT16                      Device;
1028     UINT16                      Function;
1029
1030 } ACPI_PCI_ID;
1031
1032
1033 typedef struct acpi_mem_space_context
1034 {
1035     UINT32                      Length;
1036     ACPI_PHYSICAL_ADDRESS       Address;
1037     ACPI_PHYSICAL_ADDRESS       MappedPhysicalAddress;
1038     UINT8                       *MappedLogicalAddress;
1039     ACPI_SIZE                   MappedLength;
1040
1041 } ACPI_MEM_SPACE_CONTEXT;
1042
1043
1044 /*
1045  * Definitions for Resource Attributes
1046  */
1047
1048 /*
1049  *  Memory Attributes
1050  */
1051 #define ACPI_READ_ONLY_MEMORY           (UINT8) 0x00
1052 #define ACPI_READ_WRITE_MEMORY          (UINT8) 0x01
1053
1054 #define ACPI_NON_CACHEABLE_MEMORY       (UINT8) 0x00
1055 #define ACPI_CACHABLE_MEMORY            (UINT8) 0x01
1056 #define ACPI_WRITE_COMBINING_MEMORY     (UINT8) 0x02
1057 #define ACPI_PREFETCHABLE_MEMORY        (UINT8) 0x03
1058
1059 /*
1060  *  IO Attributes
1061  *  The ISA IO ranges are:     n000-n0FFh,  n400-n4FFh, n800-n8FFh, nC00-nCFFh.
1062  *  The non-ISA IO ranges are: n100-n3FFh,  n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
1063  */
1064 #define ACPI_NON_ISA_ONLY_RANGES        (UINT8) 0x01
1065 #define ACPI_ISA_ONLY_RANGES            (UINT8) 0x02
1066 #define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
1067
1068 #define ACPI_SPARSE_TRANSLATION         (UINT8) 0x03
1069
1070 /*
1071  *  IO Port Descriptor Decode
1072  */
1073 #define ACPI_DECODE_10                  (UINT8) 0x00    /* 10-bit IO address decode */
1074 #define ACPI_DECODE_16                  (UINT8) 0x01    /* 16-bit IO address decode */
1075
1076 /*
1077  *  IRQ Attributes
1078  */
1079 #define ACPI_EDGE_SENSITIVE             (UINT8) 0x00
1080 #define ACPI_LEVEL_SENSITIVE            (UINT8) 0x01
1081
1082 #define ACPI_ACTIVE_HIGH                (UINT8) 0x00
1083 #define ACPI_ACTIVE_LOW                 (UINT8) 0x01
1084
1085 #define ACPI_EXCLUSIVE                  (UINT8) 0x00
1086 #define ACPI_SHARED                     (UINT8) 0x01
1087
1088 /*
1089  *  DMA Attributes
1090  */
1091 #define ACPI_COMPATIBILITY              (UINT8) 0x00
1092 #define ACPI_TYPE_A                     (UINT8) 0x01
1093 #define ACPI_TYPE_B                     (UINT8) 0x02
1094 #define ACPI_TYPE_F                     (UINT8) 0x03
1095
1096 #define ACPI_NOT_BUS_MASTER             (UINT8) 0x00
1097 #define ACPI_BUS_MASTER                 (UINT8) 0x01
1098
1099 #define ACPI_TRANSFER_8                 (UINT8) 0x00
1100 #define ACPI_TRANSFER_8_16              (UINT8) 0x01
1101 #define ACPI_TRANSFER_16                (UINT8) 0x02
1102
1103 /*
1104  * Start Dependent Functions Priority definitions
1105  */
1106 #define ACPI_GOOD_CONFIGURATION         (UINT8) 0x00
1107 #define ACPI_ACCEPTABLE_CONFIGURATION   (UINT8) 0x01
1108 #define ACPI_SUB_OPTIMAL_CONFIGURATION  (UINT8) 0x02
1109
1110 /*
1111  *  16, 32 and 64-bit Address Descriptor resource types
1112  */
1113 #define ACPI_MEMORY_RANGE               (UINT8) 0x00
1114 #define ACPI_IO_RANGE                   (UINT8) 0x01
1115 #define ACPI_BUS_NUMBER_RANGE           (UINT8) 0x02
1116
1117 #define ACPI_ADDRESS_NOT_FIXED          (UINT8) 0x00
1118 #define ACPI_ADDRESS_FIXED              (UINT8) 0x01
1119
1120 #define ACPI_POS_DECODE                 (UINT8) 0x00
1121 #define ACPI_SUB_DECODE                 (UINT8) 0x01
1122
1123 #define ACPI_PRODUCER                   (UINT8) 0x00
1124 #define ACPI_CONSUMER                   (UINT8) 0x01
1125
1126
1127 /*
1128  *  Structures used to describe device resources
1129  */
1130 typedef struct acpi_resource_irq
1131 {
1132     UINT32                      EdgeLevel;
1133     UINT32                      ActiveHighLow;
1134     UINT32                      SharedExclusive;
1135     UINT32                      NumberOfInterrupts;
1136     UINT32                      Interrupts[1];
1137
1138 } ACPI_RESOURCE_IRQ;
1139
1140 typedef struct ACPI_RESOURCE_DMA
1141 {
1142     UINT32                      Type;
1143     UINT32                      BusMaster;
1144     UINT32                      Transfer;
1145     UINT32                      NumberOfChannels;
1146     UINT32                      Channels[1];
1147
1148 } ACPI_RESOURCE_DMA;
1149
1150 typedef struct acpi_resource_start_dpf
1151 {
1152     UINT32                      CompatibilityPriority;
1153     UINT32                      PerformanceRobustness;
1154
1155 } ACPI_RESOURCE_START_DPF;
1156
1157 /*
1158  * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1159  * needed because it has no fields
1160  */
1161
1162 typedef struct acpi_resource_io
1163 {
1164     UINT32                      IoDecode;
1165     UINT32                      MinBaseAddress;
1166     UINT32                      MaxBaseAddress;
1167     UINT32                      Alignment;
1168     UINT32                      RangeLength;
1169
1170 } ACPI_RESOURCE_IO;
1171
1172 typedef struct acpi_resource_fixed_io
1173 {
1174     UINT32                      BaseAddress;
1175     UINT32                      RangeLength;
1176
1177 } ACPI_RESOURCE_FIXED_IO;
1178
1179 typedef struct acpi_resource_vendor
1180 {
1181     UINT32                      Length;
1182     UINT8                       Reserved[1];
1183
1184 } ACPI_RESOURCE_VENDOR;
1185
1186 typedef struct acpi_resource_end_tag
1187 {
1188     UINT8                       Checksum;
1189
1190 } ACPI_RESOURCE_END_TAG;
1191
1192 typedef struct acpi_resource_mem24
1193 {
1194     UINT32                      ReadWriteAttribute;
1195     UINT32                      MinBaseAddress;
1196     UINT32                      MaxBaseAddress;
1197     UINT32                      Alignment;
1198     UINT32                      RangeLength;
1199
1200 } ACPI_RESOURCE_MEM24;
1201
1202 typedef struct acpi_resource_mem32
1203 {
1204     UINT32                      ReadWriteAttribute;
1205     UINT32                      MinBaseAddress;
1206     UINT32                      MaxBaseAddress;
1207     UINT32                      Alignment;
1208     UINT32                      RangeLength;
1209
1210 } ACPI_RESOURCE_MEM32;
1211
1212 typedef struct acpi_resource_fixed_mem32
1213 {
1214     UINT32                      ReadWriteAttribute;
1215     UINT32                      RangeBaseAddress;
1216     UINT32                      RangeLength;
1217
1218 } ACPI_RESOURCE_FIXED_MEM32;
1219
1220 typedef struct acpi_memory_attribute
1221 {
1222     UINT16                      CacheAttribute;
1223     UINT16                      ReadWriteAttribute;
1224
1225 } ACPI_MEMORY_ATTRIBUTE;
1226
1227 typedef struct acpi_io_attribute
1228 {
1229     UINT16                      RangeAttribute;
1230     UINT16                      TranslationAttribute;
1231
1232 } ACPI_IO_ATTRIBUTE;
1233
1234 typedef struct acpi_bus_attribute
1235 {
1236     UINT16                      Reserved1;
1237     UINT16                      Reserved2;
1238
1239 } ACPI_BUS_ATTRIBUTE;
1240
1241 typedef union acpi_resource_attribute
1242 {
1243     ACPI_MEMORY_ATTRIBUTE       Memory;
1244     ACPI_IO_ATTRIBUTE           Io;
1245     ACPI_BUS_ATTRIBUTE          Bus;
1246
1247 } ACPI_RESOURCE_ATTRIBUTE;
1248
1249 typedef struct acpi_resource_source
1250 {
1251     UINT32                      Index;
1252     UINT32                      StringLength;
1253     char                        *StringPtr;
1254
1255 } ACPI_RESOURCE_SOURCE;
1256
1257 typedef struct acpi_resource_address16
1258 {
1259     UINT32                      ResourceType;
1260     UINT32                      ProducerConsumer;
1261     UINT32                      Decode;
1262     UINT32                      MinAddressFixed;
1263     UINT32                      MaxAddressFixed;
1264     ACPI_RESOURCE_ATTRIBUTE     Attribute;
1265     UINT32                      Granularity;
1266     UINT32                      MinAddressRange;
1267     UINT32                      MaxAddressRange;
1268     UINT32                      AddressTranslationOffset;
1269     UINT32                      AddressLength;
1270     ACPI_RESOURCE_SOURCE        ResourceSource;
1271
1272 } ACPI_RESOURCE_ADDRESS16;
1273
1274 typedef struct acpi_resource_address32
1275 {
1276     UINT32                      ResourceType;
1277     UINT32                      ProducerConsumer;
1278     UINT32                      Decode;
1279     UINT32                      MinAddressFixed;
1280     UINT32                      MaxAddressFixed;
1281     ACPI_RESOURCE_ATTRIBUTE     Attribute;
1282     UINT32                      Granularity;
1283     UINT32                      MinAddressRange;
1284     UINT32                      MaxAddressRange;
1285     UINT32                      AddressTranslationOffset;
1286     UINT32                      AddressLength;
1287     ACPI_RESOURCE_SOURCE        ResourceSource;
1288
1289 } ACPI_RESOURCE_ADDRESS32;
1290
1291 typedef struct acpi_resource_address64
1292 {
1293     UINT32                      ResourceType;
1294     UINT32                      ProducerConsumer;
1295     UINT32                      Decode;
1296     UINT32                      MinAddressFixed;
1297     UINT32                      MaxAddressFixed;
1298     ACPI_RESOURCE_ATTRIBUTE     Attribute;
1299     UINT64                      Granularity;
1300     UINT64                      MinAddressRange;
1301     UINT64                      MaxAddressRange;
1302     UINT64                      AddressTranslationOffset;
1303     UINT64                      AddressLength;
1304     ACPI_RESOURCE_SOURCE        ResourceSource;
1305
1306 } ACPI_RESOURCE_ADDRESS64;
1307
1308 typedef struct acpi_resource_ext_irq
1309 {
1310     UINT32                      ProducerConsumer;
1311     UINT32                      EdgeLevel;
1312     UINT32                      ActiveHighLow;
1313     UINT32                      SharedExclusive;
1314     UINT32                      NumberOfInterrupts;
1315     ACPI_RESOURCE_SOURCE        ResourceSource;
1316     UINT32                      Interrupts[1];
1317
1318 } ACPI_RESOURCE_EXT_IRQ;
1319
1320
1321 /* ACPI_RESOURCE_TYPEs */
1322
1323 #define ACPI_RSTYPE_IRQ                 0
1324 #define ACPI_RSTYPE_DMA                 1
1325 #define ACPI_RSTYPE_START_DPF           2
1326 #define ACPI_RSTYPE_END_DPF             3
1327 #define ACPI_RSTYPE_IO                  4
1328 #define ACPI_RSTYPE_FIXED_IO            5
1329 #define ACPI_RSTYPE_VENDOR              6
1330 #define ACPI_RSTYPE_END_TAG             7
1331 #define ACPI_RSTYPE_MEM24               8
1332 #define ACPI_RSTYPE_MEM32               9
1333 #define ACPI_RSTYPE_FIXED_MEM32         10
1334 #define ACPI_RSTYPE_ADDRESS16           11
1335 #define ACPI_RSTYPE_ADDRESS32           12
1336 #define ACPI_RSTYPE_ADDRESS64           13
1337 #define ACPI_RSTYPE_EXT_IRQ             14
1338
1339 typedef UINT32                          ACPI_RESOURCE_TYPE;
1340
1341 typedef union acpi_resource_data
1342 {
1343     ACPI_RESOURCE_IRQ           Irq;
1344     ACPI_RESOURCE_DMA           Dma;
1345     ACPI_RESOURCE_START_DPF     StartDpf;
1346     ACPI_RESOURCE_IO            Io;
1347     ACPI_RESOURCE_FIXED_IO      FixedIo;
1348     ACPI_RESOURCE_VENDOR        VendorSpecific;
1349     ACPI_RESOURCE_END_TAG       EndTag;
1350     ACPI_RESOURCE_MEM24         Memory24;
1351     ACPI_RESOURCE_MEM32         Memory32;
1352     ACPI_RESOURCE_FIXED_MEM32   FixedMemory32;
1353     ACPI_RESOURCE_ADDRESS16     Address16;
1354     ACPI_RESOURCE_ADDRESS32     Address32;
1355     ACPI_RESOURCE_ADDRESS64     Address64;
1356     ACPI_RESOURCE_EXT_IRQ       ExtendedIrq;
1357
1358 } ACPI_RESOURCE_DATA;
1359
1360 typedef struct acpi_resource
1361 {
1362     ACPI_RESOURCE_TYPE          Id;
1363     UINT32                      Length;
1364     ACPI_RESOURCE_DATA          Data;
1365
1366 } ACPI_RESOURCE;
1367
1368 #define ACPI_RESOURCE_LENGTH                12
1369 #define ACPI_RESOURCE_LENGTH_NO_DATA        8       /* Id + Length fields */
1370
1371 #define ACPI_SIZEOF_RESOURCE(Type)          (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (Type))
1372
1373 #define ACPI_NEXT_RESOURCE(Res)             (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length)
1374
1375 #ifdef ACPI_MISALIGNED_TRANSFERS
1376 #define ACPI_ALIGN_RESOURCE_SIZE(Length)    (Length)
1377 #else
1378 #define ACPI_ALIGN_RESOURCE_SIZE(Length)    ACPI_ROUND_UP_TO_NATIVE_WORD(Length)
1379 #endif
1380
1381 /*
1382  * END: of definitions for Resource Attributes
1383  */
1384
1385
1386 typedef struct acpi_pci_routing_table
1387 {
1388     UINT32                      Length;
1389     UINT32                      Pin;
1390     ACPI_INTEGER                Address;        /* here for 64-bit alignment */
1391     UINT32                      SourceIndex;
1392     char                        Source[4];      /* pad to 64 bits so sizeof() works in all cases */
1393
1394 } ACPI_PCI_ROUTING_TABLE;
1395
1396 /*
1397  * END: of definitions for PCI Routing tables
1398  */
1399
1400
1401 #endif /* __ACTYPES_H__ */