include/acpi/actypes.h

   1 /******************************************************************************
   2  *
   3  * Name: actypes.h - Common data types for the entire ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #ifndef __ACTYPES_H__
  45 #define __ACTYPES_H__
  46
  47 /*
  48  * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
  49  * and must be either 16, 32, or 64
  50  */
  51 #ifndef ACPI_MACHINE_WIDTH
  52 #error ACPI_MACHINE_WIDTH not defined
  53 #endif
  54
  55 /*! [Begin] no source code translation */
  56
  57 /*
  58  * Data type ranges
  59  * Note: These macros are designed to be compiler independent as well as
  60  * working around problems that some 32-bit compilers have with 64-bit
  61  * constants.
  62  */
  63 #define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
  64 #define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
  65 #define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
  66 #define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
  67 #define ACPI_ASCII_MAX                  0x7F
  68
  69 /*
  70  * Architecture-specific ACPICA Subsystem Data Types
  71  *
  72  * The goal of these types is to provide source code portability across
  73  * 16-bit, 32-bit, and 64-bit targets.
  74  *
  75  * 1) The following types are of fixed size for all targets (16/32/64):
  76  *
  77  * BOOLEAN      Logical boolean
  78  *
  79  * UINT8        8-bit  (1 byte) unsigned value
  80  * UINT16       16-bit (2 byte) unsigned value
  81  * UINT32       32-bit (4 byte) unsigned value
  82  * UINT64       64-bit (8 byte) unsigned value
  83  *
  84  * INT16        16-bit (2 byte) signed value
  85  * INT32        32-bit (4 byte) signed value
  86  * INT64        64-bit (8 byte) signed value
  87  *
  88  * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
  89  * compiler-dependent header(s) and were introduced because there is no common
  90  * 64-bit integer type across the various compilation models, as shown in
  91  * the table below.
  92  *
  93  * Datatype  LP64 ILP64 LLP64 ILP32 LP32 16bit
  94  * char      8    8     8     8     8    8
  95  * short     16   16    16    16    16   16
  96  * _int32         32
  97  * int       32   64    32    32    16   16
  98  * long      64   64    32    32    32   32
  99  * long long            64    64
 100  * pointer   64   64    64    32    32   32
 101  *
 102  * Note: ILP64 and LP32 are currently not supported.
 103  *
 104  *
 105  * 2) These types represent the native word size of the target mode of the
 106  * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
 107  * usually used for memory allocation, efficient loop counters, and array
 108  * indexes. The types are similar to the size_t type in the C library and are
 109  * required because there is no C type that consistently represents the native
 110  * data width.
 111  *
 112  * ACPI_SIZE        16/32/64-bit unsigned value
 113  * ACPI_NATIVE_UINT 16/32/64-bit unsigned value
 114  * ACPI_NATIVE_INT  16/32/64-bit signed value
 115  *
 116  */
 117
 118 /*******************************************************************************
 119  *
 120  * Common types for all compilers, all targets
 121  *
 122  ******************************************************************************/
 123
 124 typedef unsigned char BOOLEAN;
 125 typedef unsigned char UINT8;
 126 typedef unsigned short UINT16;
 127 typedef COMPILER_DEPENDENT_UINT64 UINT64;
 128 typedef COMPILER_DEPENDENT_INT64 INT64;
 129
 130 /*! [End] no source code translation !*/
 131
 132 /*******************************************************************************
 133  *
 134  * Types specific to 64-bit targets
 135  *
 136  ******************************************************************************/
 137
 138 #if ACPI_MACHINE_WIDTH == 64
 139
 140 /*! [Begin] no source code translation (keep the typedefs as-is) */
 141
 142 typedef unsigned int UINT32;
 143 typedef int INT32;
 144
 145 /*! [End] no source code translation !*/
 146
 147 typedef u64 acpi_native_uint;
 148 typedef s64 acpi_native_int;
 149
 150 typedef u64 acpi_table_ptr;
 151 typedef u64 acpi_io_address;
 152 typedef u64 acpi_physical_address;
 153
 154 #define ACPI_MAX_PTR                    ACPI_UINT64_MAX
 155 #define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
 156
 157 #define ALIGNED_ADDRESS_BOUNDARY        0x00000008
 158 #define ACPI_USE_NATIVE_DIVIDE  /* Has native 64-bit integer support */
 159
 160 /*
 161  * In the case of the Itanium Processor Family (IPF), the hardware does not
 162  * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
 163  * to indicate that special precautions must be taken to avoid alignment faults.
 164  * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
 165  *
 166  * Note: Em64_t and other X86-64 processors support misaligned transfers,
 167  * so there is no need to define this flag.
 168  */
 169 #if defined (__IA64__) || defined (__ia64__)
 170 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
 171 #endif
 172
 173 /*******************************************************************************
 174  *
 175  * Types specific to 32-bit targets
 176  *
 177  ******************************************************************************/
 178
 179 #elif ACPI_MACHINE_WIDTH == 32
 180
 181 /*! [Begin] no source code translation (keep the typedefs as-is) */
 182
 183 typedef unsigned int UINT32;
 184 typedef int INT32;
 185
 186 /*! [End] no source code translation !*/
 187
 188 typedef u32 acpi_native_uint;
 189 typedef s32 acpi_native_int;
 190
 191 typedef u64 acpi_table_ptr;
 192 typedef u32 acpi_io_address;
 193 typedef u64 acpi_physical_address;
 194
 195 #define ACPI_MAX_PTR                    ACPI_UINT32_MAX
 196 #define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
 197
 198 #define ALIGNED_ADDRESS_BOUNDARY        0x00000004
 199
 200 /*******************************************************************************
 201  *
 202  * Types specific to 16-bit targets
 203  *
 204  ******************************************************************************/
 205
 206 #elif ACPI_MACHINE_WIDTH == 16
 207
 208 /*! [Begin] no source code translation (keep the typedefs as-is) */
 209
 210 typedef unsigned long UINT32;
 211 typedef short INT16;
 212 typedef long INT32;
 213
 214 /*! [End] no source code translation !*/
 215
 216 typedef u16 acpi_native_uint;
 217 typedef s16 acpi_native_int;
 218
 219 typedef u32 acpi_table_ptr;
 220 typedef u32 acpi_io_address;
 221 typedef char *acpi_physical_address;
 222
 223 #define ACPI_MAX_PTR                    ACPI_UINT16_MAX
 224 #define ACPI_SIZE_MAX                   ACPI_UINT16_MAX
 225
 226 #define ALIGNED_ADDRESS_BOUNDARY        0x00000002
 227 #define ACPI_USE_NATIVE_DIVIDE  /* No 64-bit integers, ok to use native divide */
 228
 229 /* 64-bit integers cannot be supported */
 230
 231 #define ACPI_NO_INTEGER64_SUPPORT
 232
 233 #else
 234
 235 /* ACPI_MACHINE_WIDTH must be either 64, 32, or 16 */
 236
 237 #error unknown ACPI_MACHINE_WIDTH
 238 #endif
 239
 240 /*******************************************************************************
 241  *
 242  * OS- or compiler-dependent types
 243  *
 244  ******************************************************************************/
 245
 246 /*
 247  * If acpi_uintptr_t was not defined in the OS- or compiler-dependent header,
 248  * define it now (use C99 uintptr_t for pointer casting if available,
 249  * "void *" otherwise)
 250  */
 251 #ifndef acpi_uintptr_t
 252 #define acpi_uintptr_t                          void *
 253 #endif
 254
 255 /*
 256  * If acpi_cache_t was not defined in the OS-dependent header,
 257  * define it now. This is typically the case where the local cache
 258  * manager implementation is to be used (ACPI_USE_LOCAL_CACHE)
 259  */
 260 #ifndef acpi_cache_t
 261 #define acpi_cache_t                            struct acpi_memory_list
 262 #endif
 263
 264 /* Variable-width type, used instead of clib size_t */
 265
 266 typedef acpi_native_uint acpi_size;
 267
 268 /*******************************************************************************
 269  *
 270  * Independent types
 271  *
 272  ******************************************************************************/
 273
 274 /*
 275  * Pointer overlays to avoid lots of typecasting for
 276  * code that accepts both physical and logical pointers.
 277  */
 278 union acpi_pointers {
 279         acpi_physical_address physical;
 280         void *logical;
 281         acpi_table_ptr value;
 282 };
 283
 284 struct acpi_pointer {
 285         u32 pointer_type;
 286         union acpi_pointers pointer;
 287 };
 288
 289 /* pointer_types for above */
 290
 291 #define ACPI_PHYSICAL_POINTER           0x01
 292 #define ACPI_LOGICAL_POINTER            0x02
 293
 294 /* Processor mode */
 295
 296 #define ACPI_PHYSICAL_ADDRESSING        0x04
 297 #define ACPI_LOGICAL_ADDRESSING         0x08
 298 #define ACPI_MEMORY_MODE                0x0C
 299
 300 #define ACPI_PHYSMODE_PHYSPTR           ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
 301 #define ACPI_LOGMODE_PHYSPTR            ACPI_LOGICAL_ADDRESSING  | ACPI_PHYSICAL_POINTER
 302 #define ACPI_LOGMODE_LOGPTR             ACPI_LOGICAL_ADDRESSING  | ACPI_LOGICAL_POINTER
 303
 304 /* Logical defines and NULL */
 305
 306 #ifdef FALSE
 307 #undef FALSE
 308 #endif
 309 #define FALSE                           (1 == 0)
 310
 311 #ifdef TRUE
 312 #undef TRUE
 313 #endif
 314 #define TRUE                            (1 == 1)
 315
 316 #ifndef NULL
 317 #define NULL                            (void *) 0
 318 #endif
 319
 320 /*
 321  * Mescellaneous types
 322  */
 323 typedef u32 acpi_status;        /* All ACPI Exceptions */
 324 typedef u32 acpi_name;          /* 4-byte ACPI name */
 325 typedef char *acpi_string;      /* Null terminated ASCII string */
 326 typedef void *acpi_handle;      /* Actually a ptr to a NS Node */
 327
 328 struct uint64_struct {
 329         u32 lo;
 330         u32 hi;
 331 };
 332
 333 union uint64_overlay {
 334         u64 full;
 335         struct uint64_struct part;
 336 };
 337
 338 struct uint32_struct {
 339         u32 lo;
 340         u32 hi;
 341 };
 342
 343 /*
 344  * Acpi integer width. In ACPI version 1, integers are
 345  * 32 bits.  In ACPI version 2, integers are 64 bits.
 346  * Note that this pertains to the ACPI integer type only, not
 347  * other integers used in the implementation of the ACPI CA
 348  * subsystem.
 349  */
 350 #ifdef ACPI_NO_INTEGER64_SUPPORT
 351
 352 /* 32-bit integers only, no 64-bit support */
 353
 354 typedef u32 acpi_integer;
 355 #define ACPI_INTEGER_MAX                ACPI_UINT32_MAX
 356 #define ACPI_INTEGER_BIT_SIZE           32
 357 #define ACPI_MAX_DECIMAL_DIGITS         10      /* 2^32 = 4,294,967,296 */
 358
 359 #define ACPI_USE_NATIVE_DIVIDE  /* Use compiler native 32-bit divide */
 360
 361 #else
 362
 363 /* 64-bit integers */
 364
 365 typedef u64 acpi_integer;
 366 #define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
 367 #define ACPI_INTEGER_BIT_SIZE           64
 368 #define ACPI_MAX_DECIMAL_DIGITS         20      /* 2^64 = 18,446,744,073,709,551,616 */
 369
 370 #if ACPI_MACHINE_WIDTH == 64
 371 #define ACPI_USE_NATIVE_DIVIDE  /* Use compiler native 64-bit divide */
 372 #endif
 373 #endif
 374
 375 #define ACPI_MAX64_DECIMAL_DIGITS       20
 376 #define ACPI_MAX32_DECIMAL_DIGITS       10
 377 #define ACPI_MAX16_DECIMAL_DIGITS        5
 378 #define ACPI_MAX8_DECIMAL_DIGITS         3
 379
 380 /*
 381  * Constants with special meanings
 382  */
 383 #define ACPI_ROOT_OBJECT                ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
 384
 385 /*
 386  * Initialization sequence
 387  */
 388 #define ACPI_FULL_INITIALIZATION        0x00
 389 #define ACPI_NO_ADDRESS_SPACE_INIT      0x01
 390 #define ACPI_NO_HARDWARE_INIT           0x02
 391 #define ACPI_NO_EVENT_INIT              0x04
 392 #define ACPI_NO_HANDLER_INIT            0x08
 393 #define ACPI_NO_ACPI_ENABLE             0x10
 394 #define ACPI_NO_DEVICE_INIT             0x20
 395 #define ACPI_NO_OBJECT_INIT             0x40
 396
 397 /*
 398  * Initialization state
 399  */
 400 #define ACPI_INITIALIZED_OK             0x01
 401
 402 /*
 403  * Power state values
 404  */
 405 #define ACPI_STATE_UNKNOWN              (u8) 0xFF
 406
 407 #define ACPI_STATE_S0                   (u8) 0
 408 #define ACPI_STATE_S1                   (u8) 1
 409 #define ACPI_STATE_S2                   (u8) 2
 410 #define ACPI_STATE_S3                   (u8) 3
 411 #define ACPI_STATE_S4                   (u8) 4
 412 #define ACPI_STATE_S5                   (u8) 5
 413 #define ACPI_S_STATES_MAX               ACPI_STATE_S5
 414 #define ACPI_S_STATE_COUNT              6
 415
 416 #define ACPI_STATE_D0                   (u8) 0
 417 #define ACPI_STATE_D1                   (u8) 1
 418 #define ACPI_STATE_D2                   (u8) 2
 419 #define ACPI_STATE_D3                   (u8) 3
 420 #define ACPI_D_STATES_MAX               ACPI_STATE_D3
 421 #define ACPI_D_STATE_COUNT              4
 422
 423 #define ACPI_STATE_C0                   (u8) 0
 424 #define ACPI_STATE_C1                   (u8) 1
 425 #define ACPI_STATE_C2                   (u8) 2
 426 #define ACPI_STATE_C3                   (u8) 3
 427 #define ACPI_C_STATES_MAX               ACPI_STATE_C3
 428 #define ACPI_C_STATE_COUNT              4
 429
 430 /*
 431  * Sleep type invalid value
 432  */
 433 #define ACPI_SLEEP_TYPE_MAX             0x7
 434 #define ACPI_SLEEP_TYPE_INVALID         0xFF
 435
 436 /*
 437  * Standard notify values
 438  */
 439 #define ACPI_NOTIFY_BUS_CHECK           (u8) 0
 440 #define ACPI_NOTIFY_DEVICE_CHECK        (u8) 1
 441 #define ACPI_NOTIFY_DEVICE_WAKE         (u8) 2
 442 #define ACPI_NOTIFY_EJECT_REQUEST       (u8) 3
 443 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (u8) 4
 444 #define ACPI_NOTIFY_FREQUENCY_MISMATCH  (u8) 5
 445 #define ACPI_NOTIFY_BUS_MODE_MISMATCH   (u8) 6
 446 #define ACPI_NOTIFY_POWER_FAULT         (u8) 7
 447
 448 /*
 449  *  Table types.  These values are passed to the table related APIs
 450  */
 451 typedef u32 acpi_table_type;
 452
 453 #define ACPI_TABLE_RSDP                 (acpi_table_type) 0
 454 #define ACPI_TABLE_DSDT                 (acpi_table_type) 1
 455 #define ACPI_TABLE_FADT                 (acpi_table_type) 2
 456 #define ACPI_TABLE_FACS                 (acpi_table_type) 3
 457 #define ACPI_TABLE_PSDT                 (acpi_table_type) 4
 458 #define ACPI_TABLE_SSDT                 (acpi_table_type) 5
 459 #define ACPI_TABLE_XSDT                 (acpi_table_type) 6
 460 #define ACPI_TABLE_MAX                  6
 461 #define NUM_ACPI_TABLE_TYPES            (ACPI_TABLE_MAX+1)
 462
 463 /*
 464  * Types associated with ACPI names and objects.  The first group of
 465  * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
 466  * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
 467  * only add to the first group if the spec changes.
 468  *
 469  * NOTE: Types must be kept in sync with the global acpi_ns_properties
 470  * and acpi_ns_type_names arrays.
 471  */
 472 typedef u32 acpi_object_type;
 473
 474 #define ACPI_TYPE_ANY                   0x00
 475 #define ACPI_TYPE_INTEGER               0x01    /* Byte/Word/Dword/Zero/One/Ones */
 476 #define ACPI_TYPE_STRING                0x02
 477 #define ACPI_TYPE_BUFFER                0x03
 478 #define ACPI_TYPE_PACKAGE               0x04    /* byte_const, multiple data_term/Constant/super_name */
 479 #define ACPI_TYPE_FIELD_UNIT            0x05
 480 #define ACPI_TYPE_DEVICE                0x06    /* Name, multiple Node */
 481 #define ACPI_TYPE_EVENT                 0x07
 482 #define ACPI_TYPE_METHOD                0x08    /* Name, byte_const, multiple Code */
 483 #define ACPI_TYPE_MUTEX                 0x09
 484 #define ACPI_TYPE_REGION                0x0A
 485 #define ACPI_TYPE_POWER                 0x0B    /* Name,byte_const,word_const,multi Node */
 486 #define ACPI_TYPE_PROCESSOR             0x0C    /* Name,byte_const,Dword_const,byte_const,multi nm_o */
 487 #define ACPI_TYPE_THERMAL               0x0D    /* Name, multiple Node */
 488 #define ACPI_TYPE_BUFFER_FIELD          0x0E
 489 #define ACPI_TYPE_DDB_HANDLE            0x0F
 490 #define ACPI_TYPE_DEBUG_OBJECT          0x10
 491
 492 #define ACPI_TYPE_EXTERNAL_MAX          0x10
 493
 494 /*
 495  * These are object types that do not map directly to the ACPI
 496  * object_type() operator. They are used for various internal purposes only.
 497  * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
 498  * internal types must move upwards. (There is code that depends on these
 499  * values being contiguous with the external types above.)
 500  */
 501 #define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
 502 #define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
 503 #define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
 504 #define ACPI_TYPE_LOCAL_REFERENCE       0x14    /* Arg#, Local#, Name, Debug, ref_of, Index */
 505 #define ACPI_TYPE_LOCAL_ALIAS           0x15
 506 #define ACPI_TYPE_LOCAL_METHOD_ALIAS    0x16
 507 #define ACPI_TYPE_LOCAL_NOTIFY          0x17
 508 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
 509 #define ACPI_TYPE_LOCAL_RESOURCE        0x19
 510 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x1A
 511 #define ACPI_TYPE_LOCAL_SCOPE           0x1B    /* 1 Name, multiple object_list Nodes */
 512
 513 #define ACPI_TYPE_NS_NODE_MAX           0x1B    /* Last typecode used within a NS Node */
 514
 515 /*
 516  * These are special object types that never appear in
 517  * a Namespace node, only in an union acpi_operand_object
 518  */
 519 #define ACPI_TYPE_LOCAL_EXTRA           0x1C
 520 #define ACPI_TYPE_LOCAL_DATA            0x1D
 521
 522 #define ACPI_TYPE_LOCAL_MAX             0x1D
 523
 524 /* All types above here are invalid */
 525
 526 #define ACPI_TYPE_INVALID               0x1E
 527 #define ACPI_TYPE_NOT_FOUND             0xFF
 528
 529 /*
 530  * All I/O
 531  */
 532 #define ACPI_READ                       0
 533 #define ACPI_WRITE                      1
 534 #define ACPI_IO_MASK                    1
 535
 536 /*
 537  * Event Types: Fixed & General Purpose
 538  */
 539 typedef u32 acpi_event_type;
 540
 541 /*
 542  * Fixed events
 543  */
 544 #define ACPI_EVENT_PMTIMER              0
 545 #define ACPI_EVENT_GLOBAL               1
 546 #define ACPI_EVENT_POWER_BUTTON         2
 547 #define ACPI_EVENT_SLEEP_BUTTON         3
 548 #define ACPI_EVENT_RTC                  4
 549 #define ACPI_EVENT_MAX                  4
 550 #define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
 551
 552 /*
 553  * Event Status - Per event
 554  * -------------
 555  * The encoding of acpi_event_status is illustrated below.
 556  * Note that a set bit (1) indicates the property is TRUE
 557  * (e.g. if bit 0 is set then the event is enabled).
 558  * +-------------+-+-+-+
 559  * |   Bits 31:3 |2|1|0|
 560  * +-------------+-+-+-+
 561  *          |     | | |
 562  *          |     | | +- Enabled?
 563  *          |     | +--- Enabled for wake?
 564  *          |     +----- Set?
 565  *          +----------- <Reserved>
 566  */
 567 typedef u32 acpi_event_status;
 568
 569 #define ACPI_EVENT_FLAG_DISABLED        (acpi_event_status) 0x00
 570 #define ACPI_EVENT_FLAG_ENABLED         (acpi_event_status) 0x01
 571 #define ACPI_EVENT_FLAG_WAKE_ENABLED    (acpi_event_status) 0x02
 572 #define ACPI_EVENT_FLAG_SET             (acpi_event_status) 0x04
 573
 574 /*
 575  * General Purpose Events (GPE)
 576  */
 577 #define ACPI_GPE_INVALID                0xFF
 578 #define ACPI_GPE_MAX                    0xFF
 579 #define ACPI_NUM_GPE                    256
 580
 581 #define ACPI_GPE_ENABLE                 0
 582 #define ACPI_GPE_DISABLE                1
 583
 584 /*
 585  * GPE info flags - Per GPE
 586  * +-+-+-+---+---+-+
 587  * |7|6|5|4:3|2:1|0|
 588  * +-+-+-+---+---+-+
 589  *  | | |  |   |  |
 590  *  | | |  |   |  +--- Interrupt type: Edge or Level Triggered
 591  *  | | |  |   +--- Type: Wake-only, Runtime-only, or wake/runtime
 592  *  | | |  +--- Type of dispatch -- to method, handler, or none
 593  *  | | +--- Enabled for runtime?
 594  *  | +--- Enabled for wake?
 595  *  +--- System state when GPE ocurred (running/waking)
 596  */
 597 #define ACPI_GPE_XRUPT_TYPE_MASK        (u8) 0x01
 598 #define ACPI_GPE_LEVEL_TRIGGERED        (u8) 0x01
 599 #define ACPI_GPE_EDGE_TRIGGERED         (u8) 0x00
 600
 601 #define ACPI_GPE_TYPE_MASK              (u8) 0x06
 602 #define ACPI_GPE_TYPE_WAKE_RUN          (u8) 0x06
 603 #define ACPI_GPE_TYPE_WAKE              (u8) 0x02
 604 #define ACPI_GPE_TYPE_RUNTIME           (u8) 0x04       /* Default */
 605
 606 #define ACPI_GPE_DISPATCH_MASK          (u8) 0x18
 607 #define ACPI_GPE_DISPATCH_HANDLER       (u8) 0x08
 608 #define ACPI_GPE_DISPATCH_METHOD        (u8) 0x10
 609 #define ACPI_GPE_DISPATCH_NOT_USED      (u8) 0x00       /* Default */
 610
 611 #define ACPI_GPE_RUN_ENABLE_MASK        (u8) 0x20
 612 #define ACPI_GPE_RUN_ENABLED            (u8) 0x20
 613 #define ACPI_GPE_RUN_DISABLED           (u8) 0x00       /* Default */
 614
 615 #define ACPI_GPE_WAKE_ENABLE_MASK       (u8) 0x40
 616 #define ACPI_GPE_WAKE_ENABLED           (u8) 0x40
 617 #define ACPI_GPE_WAKE_DISABLED          (u8) 0x00       /* Default */
 618
 619 #define ACPI_GPE_ENABLE_MASK            (u8) 0x60       /* Both run/wake */
 620
 621 #define ACPI_GPE_SYSTEM_MASK            (u8) 0x80
 622 #define ACPI_GPE_SYSTEM_RUNNING         (u8) 0x80
 623 #define ACPI_GPE_SYSTEM_WAKING          (u8) 0x00
 624
 625 /*
 626  * Flags for GPE and Lock interfaces
 627  */
 628 #define ACPI_EVENT_WAKE_ENABLE          0x2     /* acpi_gpe_enable */
 629 #define ACPI_EVENT_WAKE_DISABLE         0x2     /* acpi_gpe_disable */
 630
 631 #define ACPI_NOT_ISR                    0x1
 632 #define ACPI_ISR                        0x0
 633
 634 /* Notify types */
 635
 636 #define ACPI_SYSTEM_NOTIFY              0x1
 637 #define ACPI_DEVICE_NOTIFY              0x2
 638 #define ACPI_ALL_NOTIFY                 0x3
 639 #define ACPI_MAX_NOTIFY_HANDLER_TYPE    0x3
 640
 641 #define ACPI_MAX_SYS_NOTIFY             0x7f
 642
 643 /* Address Space (Operation Region) Types */
 644
 645 typedef u8 acpi_adr_space_type;
 646
 647 #define ACPI_ADR_SPACE_SYSTEM_MEMORY    (acpi_adr_space_type) 0
 648 #define ACPI_ADR_SPACE_SYSTEM_IO        (acpi_adr_space_type) 1
 649 #define ACPI_ADR_SPACE_PCI_CONFIG       (acpi_adr_space_type) 2
 650 #define ACPI_ADR_SPACE_EC               (acpi_adr_space_type) 3
 651 #define ACPI_ADR_SPACE_SMBUS            (acpi_adr_space_type) 4
 652 #define ACPI_ADR_SPACE_CMOS             (acpi_adr_space_type) 5
 653 #define ACPI_ADR_SPACE_PCI_BAR_TARGET   (acpi_adr_space_type) 6
 654 #define ACPI_ADR_SPACE_DATA_TABLE       (acpi_adr_space_type) 7
 655 #define ACPI_ADR_SPACE_FIXED_HARDWARE   (acpi_adr_space_type) 127
 656
 657 /*
 658  * bit_register IDs
 659  * These are bitfields defined within the full ACPI registers
 660  */
 661 #define ACPI_BITREG_TIMER_STATUS                0x00
 662 #define ACPI_BITREG_BUS_MASTER_STATUS           0x01
 663 #define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
 664 #define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
 665 #define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
 666 #define ACPI_BITREG_RT_CLOCK_STATUS             0x05
 667 #define ACPI_BITREG_WAKE_STATUS                 0x06
 668 #define ACPI_BITREG_PCIEXP_WAKE_STATUS          0x07
 669
 670 #define ACPI_BITREG_TIMER_ENABLE                0x08
 671 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x09
 672 #define ACPI_BITREG_POWER_BUTTON_ENABLE         0x0A
 673 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0B
 674 #define ACPI_BITREG_RT_CLOCK_ENABLE             0x0C
 675 #define ACPI_BITREG_WAKE_ENABLE                 0x0D
 676 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE         0x0E
 677
 678 #define ACPI_BITREG_SCI_ENABLE                  0x0F
 679 #define ACPI_BITREG_BUS_MASTER_RLD              0x10
 680 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x11
 681 #define ACPI_BITREG_SLEEP_TYPE_A                0x12
 682 #define ACPI_BITREG_SLEEP_TYPE_B                0x13
 683 #define ACPI_BITREG_SLEEP_ENABLE                0x14
 684
 685 #define ACPI_BITREG_ARB_DISABLE                 0x15
 686
 687 #define ACPI_BITREG_MAX                         0x15
 688 #define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
 689
 690 /*
 691  * External ACPI object definition
 692  */
 693 union acpi_object {
 694         acpi_object_type type;  /* See definition of acpi_ns_type for values */
 695         struct {
 696                 acpi_object_type type;
 697                 acpi_integer value;     /* The actual number */
 698         } integer;
 699
 700         struct {
 701                 acpi_object_type type;
 702                 u32 length;     /* # of bytes in string, excluding trailing null */
 703                 char *pointer;  /* points to the string value */
 704         } string;
 705
 706         struct {
 707                 acpi_object_type type;
 708                 u32 length;     /* # of bytes in buffer */
 709                 u8 *pointer;    /* points to the buffer */
 710         } buffer;
 711
 712         struct {
 713                 acpi_object_type type;
 714                 u32 fill1;
 715                 acpi_handle handle;     /* object reference */
 716         } reference;
 717
 718         struct {
 719                 acpi_object_type type;
 720                 u32 count;      /* # of elements in package */
 721                 union acpi_object *elements;    /* Pointer to an array of ACPI_OBJECTs */
 722         } package;
 723
 724         struct {
 725                 acpi_object_type type;
 726                 u32 proc_id;
 727                 acpi_io_address pblk_address;
 728                 u32 pblk_length;
 729         } processor;
 730
 731         struct {
 732                 acpi_object_type type;
 733                 u32 system_level;
 734                 u32 resource_order;
 735         } power_resource;
 736 };
 737
 738 /*
 739  * List of objects, used as a parameter list for control method evaluation
 740  */
 741 struct acpi_object_list {
 742         u32 count;
 743         union acpi_object *pointer;
 744 };
 745
 746 /*
 747  * Miscellaneous common Data Structures used by the interfaces
 748  */
 749 #define ACPI_NO_BUFFER              0
 750 #define ACPI_ALLOCATE_BUFFER        (acpi_size) (-1)
 751 #define ACPI_ALLOCATE_LOCAL_BUFFER  (acpi_size) (-2)
 752
 753 struct acpi_buffer {
 754         acpi_size length;       /* Length in bytes of the buffer */
 755         void *pointer;          /* pointer to buffer */
 756 };
 757
 758 /*
 759  * name_type for acpi_get_name
 760  */
 761 #define ACPI_FULL_PATHNAME              0
 762 #define ACPI_SINGLE_NAME                1
 763 #define ACPI_NAME_TYPE_MAX              1
 764
 765 /*
 766  * Structure and flags for acpi_get_system_info
 767  */
 768 #define ACPI_SYS_MODE_UNKNOWN           0x0000
 769 #define ACPI_SYS_MODE_ACPI              0x0001
 770 #define ACPI_SYS_MODE_LEGACY            0x0002
 771 #define ACPI_SYS_MODES_MASK             0x0003
 772
 773 /*
 774  * ACPI Table Info.  One per ACPI table _type_
 775  */
 776 struct acpi_table_info {
 777         u32 count;
 778 };
 779
 780 /*
 781  * System info returned by acpi_get_system_info()
 782  */
 783 struct acpi_system_info {
 784         u32 acpi_ca_version;
 785         u32 flags;
 786         u32 timer_resolution;
 787         u32 reserved1;
 788         u32 reserved2;
 789         u32 debug_level;
 790         u32 debug_layer;
 791         u32 num_table_types;
 792         struct acpi_table_info table_info[NUM_ACPI_TABLE_TYPES];
 793 };
 794
 795 /*
 796  * Types specific to the OS service interfaces
 797  */
 798 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
 799
 800 typedef void
 801  (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
 802
 803 /*
 804  * Various handlers and callback procedures
 805  */
 806 typedef u32(*acpi_event_handler) (void *context);
 807
 808 typedef
 809 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
 810
 811 typedef
 812 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
 813
 814 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
 815
 816 #define ACPI_INIT_DEVICE_INI        1
 817
 818 typedef
 819 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
 820                                       acpi_name name,
 821                                       u16 opcode,
 822                                       u32 aml_offset, void *context);
 823
 824 /* Address Spaces (For Operation Regions) */
 825
 826 typedef
 827 acpi_status(*acpi_adr_space_handler) (u32 function,
 828                                       acpi_physical_address address,
 829                                       u32 bit_width,
 830                                       acpi_integer * value,
 831                                       void *handler_context,
 832                                       void *region_context);
 833
 834 #define ACPI_DEFAULT_HANDLER        NULL
 835
 836 typedef
 837 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
 838                                     u32 function,
 839                                     void *handler_context,
 840                                     void **region_context);
 841
 842 #define ACPI_REGION_ACTIVATE    0
 843 #define ACPI_REGION_DEACTIVATE  1
 844
 845 typedef
 846 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
 847                                   u32 nesting_level,
 848                                   void *context, void **return_value);
 849
 850 /* Interrupt handler return values */
 851
 852 #define ACPI_INTERRUPT_NOT_HANDLED      0x00
 853 #define ACPI_INTERRUPT_HANDLED          0x01
 854
 855 /* Common string version of device HIDs and UIDs */
 856
 857 struct acpi_device_id {
 858         char value[ACPI_DEVICE_ID_LENGTH];
 859 };
 860
 861 /* Common string version of device CIDs */
 862
 863 struct acpi_compatible_id {
 864         char value[ACPI_MAX_CID_LENGTH];
 865 };
 866
 867 struct acpi_compatible_id_list {
 868         u32 count;
 869         u32 size;
 870         struct acpi_compatible_id id[1];
 871 };
 872
 873 /* Structure and flags for acpi_get_object_info */
 874
 875 #define ACPI_VALID_STA                  0x0001
 876 #define ACPI_VALID_ADR                  0x0002
 877 #define ACPI_VALID_HID                  0x0004
 878 #define ACPI_VALID_UID                  0x0008
 879 #define ACPI_VALID_CID                  0x0010
 880 #define ACPI_VALID_SXDS                 0x0020
 881
 882 /* Flags for _STA method */
 883
 884 #define ACPI_STA_DEVICE_PRESENT         0x01
 885 #define ACPI_STA_DEVICE_ENABLED         0x02
 886 #define ACPI_STA_DEVICE_UI              0x04
 887 #define ACPI_STA_DEVICE_OK              0x08
 888 #define ACPI_STA_BATTERY_PRESENT        0x10
 889
 890 #define ACPI_COMMON_OBJ_INFO \
 891         acpi_object_type                    type;           /* ACPI object type */ \
 892         acpi_name                           name        /* ACPI object Name */
 893
 894 struct acpi_obj_info_header {
 895         ACPI_COMMON_OBJ_INFO;
 896 };
 897
 898 /* Structure returned from Get Object Info */
 899
 900 struct acpi_device_info {
 901         ACPI_COMMON_OBJ_INFO;
 902
 903         u32 valid;              /* Indicates which fields below are valid */
 904         u32 current_status;     /* _STA value */
 905         acpi_integer address;   /* _ADR value if any */
 906         struct acpi_device_id hardware_id;      /* _HID value if any */
 907         struct acpi_device_id unique_id;        /* _UID value if any */
 908         u8 highest_dstates[4];  /* _sx_d values: 0xFF indicates not valid */
 909         struct acpi_compatible_id_list compatibility_id;        /* List of _CIDs if any */
 910 };
 911
 912 /* Context structs for address space handlers */
 913
 914 struct acpi_pci_id {
 915         u16 segment;
 916         u16 bus;
 917         u16 device;
 918         u16 function;
 919 };
 920
 921 struct acpi_mem_space_context {
 922         u32 length;
 923         acpi_physical_address address;
 924         acpi_physical_address mapped_physical_address;
 925         u8 *mapped_logical_address;
 926         acpi_size mapped_length;
 927 };
 928
 929 /*
 930  * Definitions for Resource Attributes
 931  */
 932 typedef u16 acpi_rs_length;     /* Resource Length field is fixed at 16 bits */
 933 typedef u32 acpi_rsdesc_size;   /* Max Resource Descriptor size is (length+3) = (64_k-1)+3 */
 934
 935 /*
 936  *  Memory Attributes
 937  */
 938 #define ACPI_READ_ONLY_MEMORY           (u8) 0x00
 939 #define ACPI_READ_WRITE_MEMORY          (u8) 0x01
 940
 941 #define ACPI_NON_CACHEABLE_MEMORY       (u8) 0x00
 942 #define ACPI_CACHABLE_MEMORY            (u8) 0x01
 943 #define ACPI_WRITE_COMBINING_MEMORY     (u8) 0x02
 944 #define ACPI_PREFETCHABLE_MEMORY        (u8) 0x03
 945
 946 /*
 947  *  IO Attributes
 948  *  The ISA Io ranges are:     n000-n0_ffh, n400-n4_ffh, n800-n8_ffh, n_c00-n_cFFh.
 949  *  The non-ISA Io ranges are: n100-n3_ffh, n500-n7_ffh, n900-n_bFfh, n_cd0-n_fFFh.
 950  */
 951 #define ACPI_NON_ISA_ONLY_RANGES        (u8) 0x01
 952 #define ACPI_ISA_ONLY_RANGES            (u8) 0x02
 953 #define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
 954
 955 /* Type of translation - 1=Sparse, 0=Dense */
 956
 957 #define ACPI_SPARSE_TRANSLATION         (u8) 0x01
 958
 959 /*
 960  *  IO Port Descriptor Decode
 961  */
 962 #define ACPI_DECODE_10                  (u8) 0x00       /* 10-bit IO address decode */
 963 #define ACPI_DECODE_16                  (u8) 0x01       /* 16-bit IO address decode */
 964
 965 /*
 966  *  IRQ Attributes
 967  */
 968 #define ACPI_LEVEL_SENSITIVE            (u8) 0x00
 969 #define ACPI_EDGE_SENSITIVE             (u8) 0x01
 970
 971 #define ACPI_ACTIVE_HIGH                (u8) 0x00
 972 #define ACPI_ACTIVE_LOW                 (u8) 0x01
 973
 974 #define ACPI_EXCLUSIVE                  (u8) 0x00
 975 #define ACPI_SHARED                     (u8) 0x01
 976
 977 /*
 978  *  DMA Attributes
 979  */
 980 #define ACPI_COMPATIBILITY              (u8) 0x00
 981 #define ACPI_TYPE_A                     (u8) 0x01
 982 #define ACPI_TYPE_B                     (u8) 0x02
 983 #define ACPI_TYPE_F                     (u8) 0x03
 984
 985 #define ACPI_NOT_BUS_MASTER             (u8) 0x00
 986 #define ACPI_BUS_MASTER                 (u8) 0x01
 987
 988 #define ACPI_TRANSFER_8                 (u8) 0x00
 989 #define ACPI_TRANSFER_8_16              (u8) 0x01
 990 #define ACPI_TRANSFER_16                (u8) 0x02
 991
 992 /*
 993  * Start Dependent Functions Priority definitions
 994  */
 995 #define ACPI_GOOD_CONFIGURATION         (u8) 0x00
 996 #define ACPI_ACCEPTABLE_CONFIGURATION   (u8) 0x01
 997 #define ACPI_SUB_OPTIMAL_CONFIGURATION  (u8) 0x02
 998
 999 /*
1000  *  16, 32 and 64-bit Address Descriptor resource types
1001  */
1002 #define ACPI_MEMORY_RANGE               (u8) 0x00
1003 #define ACPI_IO_RANGE                   (u8) 0x01
1004 #define ACPI_BUS_NUMBER_RANGE           (u8) 0x02
1005
1006 #define ACPI_ADDRESS_NOT_FIXED          (u8) 0x00
1007 #define ACPI_ADDRESS_FIXED              (u8) 0x01
1008
1009 #define ACPI_POS_DECODE                 (u8) 0x00
1010 #define ACPI_SUB_DECODE                 (u8) 0x01
1011
1012 #define ACPI_PRODUCER                   (u8) 0x00
1013 #define ACPI_CONSUMER                   (u8) 0x01
1014
1015 /*
1016  * If possible, pack the following structures to byte alignment
1017  */
1018 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1019 #pragma pack(1)
1020 #endif
1021
1022 /* UUID data structures for use in vendor-defined resource descriptors */
1023
1024 struct acpi_uuid {
1025         u8 data[ACPI_UUID_LENGTH];
1026 };
1027
1028 struct acpi_vendor_uuid {
1029         u8 subtype;
1030         u8 data[ACPI_UUID_LENGTH];
1031 };
1032
1033 /*
1034  *  Structures used to describe device resources
1035  */
1036 struct acpi_resource_irq {
1037         u8 triggering;
1038         u8 polarity;
1039         u8 sharable;
1040         u8 interrupt_count;
1041         u8 interrupts[1];
1042 };
1043
1044 struct acpi_resource_dma {
1045         u8 type;
1046         u8 bus_master;
1047         u8 transfer;
1048         u8 channel_count;
1049         u8 channels[1];
1050 };
1051
1052 struct acpi_resource_start_dependent {
1053         u8 compatibility_priority;
1054         u8 performance_robustness;
1055 };
1056
1057 /*
1058  * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1059  * needed because it has no fields
1060  */
1061
1062 struct acpi_resource_io {
1063         u8 io_decode;
1064         u8 alignment;
1065         u8 address_length;
1066         u16 minimum;
1067         u16 maximum;
1068 };
1069
1070 struct acpi_resource_fixed_io {
1071         u16 address;
1072         u8 address_length;
1073 };
1074
1075 struct acpi_resource_vendor {
1076         u16 byte_length;
1077         u8 byte_data[1];
1078 };
1079
1080 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
1081
1082 struct acpi_resource_vendor_typed {
1083         u16 byte_length;
1084         u8 uuid_subtype;
1085         u8 uuid[ACPI_UUID_LENGTH];
1086         u8 byte_data[1];
1087 };
1088
1089 struct acpi_resource_end_tag {
1090         u8 checksum;
1091 };
1092
1093 struct acpi_resource_memory24 {
1094         u8 write_protect;
1095         u16 minimum;
1096         u16 maximum;
1097         u16 alignment;
1098         u16 address_length;
1099 };
1100
1101 struct acpi_resource_memory32 {
1102         u8 write_protect;
1103         u32 minimum;
1104         u32 maximum;
1105         u32 alignment;
1106         u32 address_length;
1107 };
1108
1109 struct acpi_resource_fixed_memory32 {
1110         u8 write_protect;
1111         u32 address;
1112         u32 address_length;
1113 };
1114
1115 struct acpi_memory_attribute {
1116         u8 write_protect;
1117         u8 caching;
1118         u8 range_type;
1119         u8 translation;
1120 };
1121
1122 struct acpi_io_attribute {
1123         u8 range_type;
1124         u8 translation;
1125         u8 translation_type;
1126         u8 reserved1;
1127 };
1128
1129 union acpi_resource_attribute {
1130         struct acpi_memory_attribute mem;
1131         struct acpi_io_attribute io;
1132
1133         /* Used for the *word_space macros */
1134
1135         u8 type_specific;
1136 };
1137
1138 struct acpi_resource_source {
1139         u8 index;
1140         u16 string_length;
1141         char *string_ptr;
1142 };
1143
1144 /* Fields common to all address descriptors, 16/32/64 bit */
1145
1146 #define ACPI_RESOURCE_ADDRESS_COMMON \
1147         u8                                  resource_type; \
1148         u8                                  producer_consumer; \
1149         u8                                  decode; \
1150         u8                                  min_address_fixed; \
1151         u8                                  max_address_fixed; \
1152         union acpi_resource_attribute       info;
1153
1154 struct acpi_resource_address {
1155 ACPI_RESOURCE_ADDRESS_COMMON};
1156
1157 struct acpi_resource_address16 {
1158         ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
1159         u16 minimum;
1160         u16 maximum;
1161         u16 translation_offset;
1162         u16 address_length;
1163         struct acpi_resource_source resource_source;
1164 };
1165
1166 struct acpi_resource_address32 {
1167         ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1168         u32 minimum;
1169         u32 maximum;
1170         u32 translation_offset;
1171         u32 address_length;
1172         struct acpi_resource_source resource_source;
1173 };
1174
1175 struct acpi_resource_address64 {
1176         ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1177         u64 minimum;
1178         u64 maximum;
1179         u64 translation_offset;
1180         u64 address_length;
1181         struct acpi_resource_source resource_source;
1182 };
1183
1184 struct acpi_resource_extended_address64 {
1185         ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
1186         u64 granularity;
1187         u64 minimum;
1188         u64 maximum;
1189         u64 translation_offset;
1190         u64 address_length;
1191         u64 type_specific;
1192 };
1193
1194 struct acpi_resource_extended_irq {
1195         u8 producer_consumer;
1196         u8 triggering;
1197         u8 polarity;
1198         u8 sharable;
1199         u8 interrupt_count;
1200         struct acpi_resource_source resource_source;
1201         u32 interrupts[1];
1202 };
1203
1204 struct acpi_resource_generic_register {
1205         u8 space_id;
1206         u8 bit_width;
1207         u8 bit_offset;
1208         u8 access_size;
1209         u64 address;
1210 };
1211
1212 /* ACPI_RESOURCE_TYPEs */
1213
1214 #define ACPI_RESOURCE_TYPE_IRQ                  0
1215 #define ACPI_RESOURCE_TYPE_DMA                  1
1216 #define ACPI_RESOURCE_TYPE_START_DEPENDENT      2
1217 #define ACPI_RESOURCE_TYPE_END_DEPENDENT        3
1218 #define ACPI_RESOURCE_TYPE_IO                   4
1219 #define ACPI_RESOURCE_TYPE_FIXED_IO             5
1220 #define ACPI_RESOURCE_TYPE_VENDOR               6
1221 #define ACPI_RESOURCE_TYPE_END_TAG              7
1222 #define ACPI_RESOURCE_TYPE_MEMORY24             8
1223 #define ACPI_RESOURCE_TYPE_MEMORY32             9
1224 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32       10
1225 #define ACPI_RESOURCE_TYPE_ADDRESS16            11
1226 #define ACPI_RESOURCE_TYPE_ADDRESS32            12
1227 #define ACPI_RESOURCE_TYPE_ADDRESS64            13
1228 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64   14      /* ACPI 3.0 */
1229 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ         15
1230 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER     16
1231 #define ACPI_RESOURCE_TYPE_MAX                  16
1232
1233 union acpi_resource_data {
1234         struct acpi_resource_irq irq;
1235         struct acpi_resource_dma dma;
1236         struct acpi_resource_start_dependent start_dpf;
1237         struct acpi_resource_io io;
1238         struct acpi_resource_fixed_io fixed_io;
1239         struct acpi_resource_vendor vendor;
1240         struct acpi_resource_vendor_typed vendor_typed;
1241         struct acpi_resource_end_tag end_tag;
1242         struct acpi_resource_memory24 memory24;
1243         struct acpi_resource_memory32 memory32;
1244         struct acpi_resource_fixed_memory32 fixed_memory32;
1245         struct acpi_resource_address16 address16;
1246         struct acpi_resource_address32 address32;
1247         struct acpi_resource_address64 address64;
1248         struct acpi_resource_extended_address64 ext_address64;
1249         struct acpi_resource_extended_irq extended_irq;
1250         struct acpi_resource_generic_register generic_reg;
1251
1252         /* Common fields */
1253
1254         struct acpi_resource_address address;   /* Common 16/32/64 address fields */
1255 };
1256
1257 struct acpi_resource {
1258         u32 type;
1259         u32 length;
1260         union acpi_resource_data data;
1261 };
1262
1263 /* restore default alignment */
1264
1265 #pragma pack()
1266
1267 #define ACPI_RS_SIZE_MIN                    12
1268 #define ACPI_RS_SIZE_NO_DATA                8   /* Id + Length fields */
1269 #define ACPI_RS_SIZE(type)                  (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
1270
1271 #define ACPI_NEXT_RESOURCE(res)             (struct acpi_resource *)((u8 *) res + res->length)
1272
1273 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1274 #define ACPI_ALIGN_RESOURCE_SIZE(length)    (length)
1275 #else
1276 #define ACPI_ALIGN_RESOURCE_SIZE(length)    ACPI_ROUND_UP_TO_NATIVE_WORD(length)
1277 #endif
1278
1279 /*
1280  * END: of definitions for Resource Attributes
1281  */
1282
1283 struct acpi_pci_routing_table {
1284         u32 length;
1285         u32 pin;
1286         acpi_integer address;   /* here for 64-bit alignment */
1287         u32 source_index;
1288         char source[4];         /* pad to 64 bits so sizeof() works in all cases */
1289 };
1290
1291 /*
1292  * END: of definitions for PCI Routing tables
1293  */
1294
1295 #endif                          /* __ACTYPES_H__ */