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