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