kernel/include/acpi/actbl2.h

   1 /******************************************************************************
   2  *
   3  * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2015, Intel Corp.
   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 __ACTBL2_H__
  45 #define __ACTBL2_H__
  46
  47 /*******************************************************************************
  48  *
  49  * Additional ACPI Tables (2)
  50  *
  51  * These tables are not consumed directly by the ACPICA subsystem, but are
  52  * included here to support device drivers and the AML disassembler.
  53  *
  54  * The tables in this file are defined by third-party specifications, and are
  55  * not defined directly by the ACPI specification itself.
  56  *
  57  ******************************************************************************/
  58
  59 /*
  60  * Values for description table header signatures for tables defined in this
  61  * file. Useful because they make it more difficult to inadvertently type in
  62  * the wrong signature.
  63  */
  64 #define ACPI_SIG_ASF            "ASF!"  /* Alert Standard Format table */
  65 #define ACPI_SIG_BOOT           "BOOT"  /* Simple Boot Flag Table */
  66 #define ACPI_SIG_CSRT           "CSRT"  /* Core System Resource Table */
  67 #define ACPI_SIG_DBG2           "DBG2"  /* Debug Port table type 2 */
  68 #define ACPI_SIG_DBGP           "DBGP"  /* Debug Port table */
  69 #define ACPI_SIG_DMAR           "DMAR"  /* DMA Remapping table */
  70 #define ACPI_SIG_HPET           "HPET"  /* High Precision Event Timer table */
  71 #define ACPI_SIG_IBFT           "IBFT"  /* iSCSI Boot Firmware Table */
  72 #define ACPI_SIG_IVRS           "IVRS"  /* I/O Virtualization Reporting Structure */
  73 #define ACPI_SIG_LPIT           "LPIT"  /* Low Power Idle Table */
  74 #define ACPI_SIG_MCFG           "MCFG"  /* PCI Memory Mapped Configuration table */
  75 #define ACPI_SIG_MCHI           "MCHI"  /* Management Controller Host Interface table */
  76 #define ACPI_SIG_MSDM           "MSDM"  /* Microsoft Data Management Table */
  77 #define ACPI_SIG_MTMR           "MTMR"  /* MID Timer table */
  78 #define ACPI_SIG_SLIC           "SLIC"  /* Software Licensing Description Table */
  79 #define ACPI_SIG_SPCR           "SPCR"  /* Serial Port Console Redirection table */
  80 #define ACPI_SIG_SPMI           "SPMI"  /* Server Platform Management Interface table */
  81 #define ACPI_SIG_TCPA           "TCPA"  /* Trusted Computing Platform Alliance table */
  82 #define ACPI_SIG_UEFI           "UEFI"  /* Uefi Boot Optimization Table */
  83 #define ACPI_SIG_VRTC           "VRTC"  /* Virtual Real Time Clock Table */
  84 #define ACPI_SIG_WAET           "WAET"  /* Windows ACPI Emulated devices Table */
  85 #define ACPI_SIG_WDAT           "WDAT"  /* Watchdog Action Table */
  86 #define ACPI_SIG_WDDT           "WDDT"  /* Watchdog Timer Description Table */
  87 #define ACPI_SIG_WDRT           "WDRT"  /* Watchdog Resource Table */
  88
  89 #ifdef ACPI_UNDEFINED_TABLES
  90 /*
  91  * These tables have been seen in the field, but no definition has been found
  92  */
  93 #define ACPI_SIG_ATKG           "ATKG"
  94 #define ACPI_SIG_GSCI           "GSCI"  /* GMCH SCI table */
  95 #define ACPI_SIG_IEIT           "IEIT"
  96 #endif
  97
  98 /*
  99  * All tables must be byte-packed to match the ACPI specification, since
 100  * the tables are provided by the system BIOS.
 101  */
 102 #pragma pack(1)
 103
 104 /*
 105  * Note: C bitfields are not used for this reason:
 106  *
 107  * "Bitfields are great and easy to read, but unfortunately the C language
 108  * does not specify the layout of bitfields in memory, which means they are
 109  * essentially useless for dealing with packed data in on-disk formats or
 110  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
 111  * this decision was a design error in C. Ritchie could have picked an order
 112  * and stuck with it." Norman Ramsey.
 113  * See http://stackoverflow.com/a/1053662/41661
 114  */
 115
 116 /*******************************************************************************
 117  *
 118  * ASF - Alert Standard Format table (Signature "ASF!")
 119  *       Revision 0x10
 120  *
 121  * Conforms to the Alert Standard Format Specification V2.0, 23 April 2003
 122  *
 123  ******************************************************************************/
 124
 125 struct acpi_table_asf {
 126         struct acpi_table_header header;        /* Common ACPI table header */
 127 };
 128
 129 /* ASF subtable header */
 130
 131 struct acpi_asf_header {
 132         u8 type;
 133         u8 reserved;
 134         u16 length;
 135 };
 136
 137 /* Values for Type field above */
 138
 139 enum acpi_asf_type {
 140         ACPI_ASF_TYPE_INFO = 0,
 141         ACPI_ASF_TYPE_ALERT = 1,
 142         ACPI_ASF_TYPE_CONTROL = 2,
 143         ACPI_ASF_TYPE_BOOT = 3,
 144         ACPI_ASF_TYPE_ADDRESS = 4,
 145         ACPI_ASF_TYPE_RESERVED = 5
 146 };
 147
 148 /*
 149  * ASF subtables
 150  */
 151
 152 /* 0: ASF Information */
 153
 154 struct acpi_asf_info {
 155         struct acpi_asf_header header;
 156         u8 min_reset_value;
 157         u8 min_poll_interval;
 158         u16 system_id;
 159         u32 mfg_id;
 160         u8 flags;
 161         u8 reserved2[3];
 162 };
 163
 164 /* Masks for Flags field above */
 165
 166 #define ACPI_ASF_SMBUS_PROTOCOLS    (1)
 167
 168 /* 1: ASF Alerts */
 169
 170 struct acpi_asf_alert {
 171         struct acpi_asf_header header;
 172         u8 assert_mask;
 173         u8 deassert_mask;
 174         u8 alerts;
 175         u8 data_length;
 176 };
 177
 178 struct acpi_asf_alert_data {
 179         u8 address;
 180         u8 command;
 181         u8 mask;
 182         u8 value;
 183         u8 sensor_type;
 184         u8 type;
 185         u8 offset;
 186         u8 source_type;
 187         u8 severity;
 188         u8 sensor_number;
 189         u8 entity;
 190         u8 instance;
 191 };
 192
 193 /* 2: ASF Remote Control */
 194
 195 struct acpi_asf_remote {
 196         struct acpi_asf_header header;
 197         u8 controls;
 198         u8 data_length;
 199         u16 reserved2;
 200 };
 201
 202 struct acpi_asf_control_data {
 203         u8 function;
 204         u8 address;
 205         u8 command;
 206         u8 value;
 207 };
 208
 209 /* 3: ASF RMCP Boot Options */
 210
 211 struct acpi_asf_rmcp {
 212         struct acpi_asf_header header;
 213         u8 capabilities[7];
 214         u8 completion_code;
 215         u32 enterprise_id;
 216         u8 command;
 217         u16 parameter;
 218         u16 boot_options;
 219         u16 oem_parameters;
 220 };
 221
 222 /* 4: ASF Address */
 223
 224 struct acpi_asf_address {
 225         struct acpi_asf_header header;
 226         u8 eprom_address;
 227         u8 devices;
 228 };
 229
 230 /*******************************************************************************
 231  *
 232  * BOOT - Simple Boot Flag Table
 233  *        Version 1
 234  *
 235  * Conforms to the "Simple Boot Flag Specification", Version 2.1
 236  *
 237  ******************************************************************************/
 238
 239 struct acpi_table_boot {
 240         struct acpi_table_header header;        /* Common ACPI table header */
 241         u8 cmos_index;          /* Index in CMOS RAM for the boot register */
 242         u8 reserved[3];
 243 };
 244
 245 /*******************************************************************************
 246  *
 247  * CSRT - Core System Resource Table
 248  *        Version 0
 249  *
 250  * Conforms to the "Core System Resource Table (CSRT)", November 14, 2011
 251  *
 252  ******************************************************************************/
 253
 254 struct acpi_table_csrt {
 255         struct acpi_table_header header;        /* Common ACPI table header */
 256 };
 257
 258 /* Resource Group subtable */
 259
 260 struct acpi_csrt_group {
 261         u32 length;
 262         u32 vendor_id;
 263         u32 subvendor_id;
 264         u16 device_id;
 265         u16 subdevice_id;
 266         u16 revision;
 267         u16 reserved;
 268         u32 shared_info_length;
 269
 270         /* Shared data immediately follows (Length = shared_info_length) */
 271 };
 272
 273 /* Shared Info subtable */
 274
 275 struct acpi_csrt_shared_info {
 276         u16 major_version;
 277         u16 minor_version;
 278         u32 mmio_base_low;
 279         u32 mmio_base_high;
 280         u32 gsi_interrupt;
 281         u8 interrupt_polarity;
 282         u8 interrupt_mode;
 283         u8 num_channels;
 284         u8 dma_address_width;
 285         u16 base_request_line;
 286         u16 num_handshake_signals;
 287         u32 max_block_size;
 288
 289         /* Resource descriptors immediately follow (Length = Group length - shared_info_length) */
 290 };
 291
 292 /* Resource Descriptor subtable */
 293
 294 struct acpi_csrt_descriptor {
 295         u32 length;
 296         u16 type;
 297         u16 subtype;
 298         u32 uid;
 299
 300         /* Resource-specific information immediately follows */
 301 };
 302
 303 /* Resource Types */
 304
 305 #define ACPI_CSRT_TYPE_INTERRUPT    0x0001
 306 #define ACPI_CSRT_TYPE_TIMER        0x0002
 307 #define ACPI_CSRT_TYPE_DMA          0x0003
 308
 309 /* Resource Subtypes */
 310
 311 #define ACPI_CSRT_XRUPT_LINE        0x0000
 312 #define ACPI_CSRT_XRUPT_CONTROLLER  0x0001
 313 #define ACPI_CSRT_TIMER             0x0000
 314 #define ACPI_CSRT_DMA_CHANNEL       0x0000
 315 #define ACPI_CSRT_DMA_CONTROLLER    0x0001
 316
 317 /*******************************************************************************
 318  *
 319  * DBG2 - Debug Port Table 2
 320  *        Version 0 (Both main table and subtables)
 321  *
 322  * Conforms to "Microsoft Debug Port Table 2 (DBG2)", May 22 2012.
 323  *
 324  ******************************************************************************/
 325
 326 struct acpi_table_dbg2 {
 327         struct acpi_table_header header;        /* Common ACPI table header */
 328         u32 info_offset;
 329         u32 info_count;
 330 };
 331
 332 struct acpi_dbg2_header {
 333         u32 info_offset;
 334         u32 info_count;
 335 };
 336
 337 /* Debug Device Information Subtable */
 338
 339 struct acpi_dbg2_device {
 340         u8 revision;
 341         u16 length;
 342         u8 register_count;      /* Number of base_address registers */
 343         u16 namepath_length;
 344         u16 namepath_offset;
 345         u16 oem_data_length;
 346         u16 oem_data_offset;
 347         u16 port_type;
 348         u16 port_subtype;
 349         u16 reserved;
 350         u16 base_address_offset;
 351         u16 address_size_offset;
 352         /*
 353          * Data that follows:
 354          *    base_address (required) - Each in 12-byte Generic Address Structure format.
 355          *    address_size (required) - Array of u32 sizes corresponding to each base_address register.
 356          *    Namepath    (required) - Null terminated string. Single dot if not supported.
 357          *    oem_data    (optional) - Length is oem_data_length.
 358          */
 359 };
 360
 361 /* Types for port_type field above */
 362
 363 #define ACPI_DBG2_SERIAL_PORT       0x8000
 364 #define ACPI_DBG2_1394_PORT         0x8001
 365 #define ACPI_DBG2_USB_PORT          0x8002
 366 #define ACPI_DBG2_NET_PORT          0x8003
 367
 368 /* Subtypes for port_subtype field above */
 369
 370 #define ACPI_DBG2_16550_COMPATIBLE  0x0000
 371 #define ACPI_DBG2_16550_SUBSET      0x0001
 372
 373 #define ACPI_DBG2_1394_STANDARD     0x0000
 374
 375 #define ACPI_DBG2_USB_XHCI          0x0000
 376 #define ACPI_DBG2_USB_EHCI          0x0001
 377
 378 /*******************************************************************************
 379  *
 380  * DBGP - Debug Port table
 381  *        Version 1
 382  *
 383  * Conforms to the "Debug Port Specification", Version 1.00, 2/9/2000
 384  *
 385  ******************************************************************************/
 386
 387 struct acpi_table_dbgp {
 388         struct acpi_table_header header;        /* Common ACPI table header */
 389         u8 type;                /* 0=full 16550, 1=subset of 16550 */
 390         u8 reserved[3];
 391         struct acpi_generic_address debug_port;
 392 };
 393
 394 /*******************************************************************************
 395  *
 396  * DMAR - DMA Remapping table
 397  *        Version 1
 398  *
 399  * Conforms to "Intel Virtualization Technology for Directed I/O",
 400  * Version 2.2, Sept. 2013
 401  *
 402  ******************************************************************************/
 403
 404 struct acpi_table_dmar {
 405         struct acpi_table_header header;        /* Common ACPI table header */
 406         u8 width;               /* Host Address Width */
 407         u8 flags;
 408         u8 reserved[10];
 409 };
 410
 411 /* Masks for Flags field above */
 412
 413 #define ACPI_DMAR_INTR_REMAP        (1)
 414
 415 /* DMAR subtable header */
 416
 417 struct acpi_dmar_header {
 418         u16 type;
 419         u16 length;
 420 };
 421
 422 /* Values for subtable type in struct acpi_dmar_header */
 423
 424 enum acpi_dmar_type {
 425         ACPI_DMAR_TYPE_HARDWARE_UNIT = 0,
 426         ACPI_DMAR_TYPE_RESERVED_MEMORY = 1,
 427         ACPI_DMAR_TYPE_ROOT_ATS = 2,
 428         ACPI_DMAR_TYPE_HARDWARE_AFFINITY = 3,
 429         ACPI_DMAR_TYPE_NAMESPACE = 4,
 430         ACPI_DMAR_TYPE_RESERVED = 5     /* 5 and greater are reserved */
 431 };
 432
 433 /* DMAR Device Scope structure */
 434
 435 struct acpi_dmar_device_scope {
 436         u8 entry_type;
 437         u8 length;
 438         u16 reserved;
 439         u8 enumeration_id;
 440         u8 bus;
 441 };
 442
 443 /* Values for entry_type in struct acpi_dmar_device_scope - device types */
 444
 445 enum acpi_dmar_scope_type {
 446         ACPI_DMAR_SCOPE_TYPE_NOT_USED = 0,
 447         ACPI_DMAR_SCOPE_TYPE_ENDPOINT = 1,
 448         ACPI_DMAR_SCOPE_TYPE_BRIDGE = 2,
 449         ACPI_DMAR_SCOPE_TYPE_IOAPIC = 3,
 450         ACPI_DMAR_SCOPE_TYPE_HPET = 4,
 451         ACPI_DMAR_SCOPE_TYPE_NAMESPACE = 5,
 452         ACPI_DMAR_SCOPE_TYPE_RESERVED = 6       /* 6 and greater are reserved */
 453 };
 454
 455 struct acpi_dmar_pci_path {
 456         u8 device;
 457         u8 function;
 458 };
 459
 460 /*
 461  * DMAR Subtables, correspond to Type in struct acpi_dmar_header
 462  */
 463
 464 /* 0: Hardware Unit Definition */
 465
 466 struct acpi_dmar_hardware_unit {
 467         struct acpi_dmar_header header;
 468         u8 flags;
 469         u8 reserved;
 470         u16 segment;
 471         u64 address;            /* Register Base Address */
 472 };
 473
 474 /* Masks for Flags field above */
 475
 476 #define ACPI_DMAR_INCLUDE_ALL       (1)
 477
 478 /* 1: Reserved Memory Defininition */
 479
 480 struct acpi_dmar_reserved_memory {
 481         struct acpi_dmar_header header;
 482         u16 reserved;
 483         u16 segment;
 484         u64 base_address;       /* 4K aligned base address */
 485         u64 end_address;        /* 4K aligned limit address */
 486 };
 487
 488 /* Masks for Flags field above */
 489
 490 #define ACPI_DMAR_ALLOW_ALL         (1)
 491
 492 /* 2: Root Port ATS Capability Reporting Structure */
 493
 494 struct acpi_dmar_atsr {
 495         struct acpi_dmar_header header;
 496         u8 flags;
 497         u8 reserved;
 498         u16 segment;
 499 };
 500
 501 /* Masks for Flags field above */
 502
 503 #define ACPI_DMAR_ALL_PORTS         (1)
 504
 505 /* 3: Remapping Hardware Static Affinity Structure */
 506
 507 struct acpi_dmar_rhsa {
 508         struct acpi_dmar_header header;
 509         u32 reserved;
 510         u64 base_address;
 511         u32 proximity_domain;
 512 };
 513
 514 /* 4: ACPI Namespace Device Declaration Structure */
 515
 516 struct acpi_dmar_andd {
 517         struct acpi_dmar_header header;
 518         u8 reserved[3];
 519         u8 device_number;
 520         char device_name[1];
 521 };
 522
 523 /*******************************************************************************
 524  *
 525  * HPET - High Precision Event Timer table
 526  *        Version 1
 527  *
 528  * Conforms to "IA-PC HPET (High Precision Event Timers) Specification",
 529  * Version 1.0a, October 2004
 530  *
 531  ******************************************************************************/
 532
 533 struct acpi_table_hpet {
 534         struct acpi_table_header header;        /* Common ACPI table header */
 535         u32 id;                 /* Hardware ID of event timer block */
 536         struct acpi_generic_address address;    /* Address of event timer block */
 537         u8 sequence;            /* HPET sequence number */
 538         u16 minimum_tick;       /* Main counter min tick, periodic mode */
 539         u8 flags;
 540 };
 541
 542 /* Masks for Flags field above */
 543
 544 #define ACPI_HPET_PAGE_PROTECT_MASK (3)
 545
 546 /* Values for Page Protect flags */
 547
 548 enum acpi_hpet_page_protect {
 549         ACPI_HPET_NO_PAGE_PROTECT = 0,
 550         ACPI_HPET_PAGE_PROTECT4 = 1,
 551         ACPI_HPET_PAGE_PROTECT64 = 2
 552 };
 553
 554 /*******************************************************************************
 555  *
 556  * IBFT - Boot Firmware Table
 557  *        Version 1
 558  *
 559  * Conforms to "iSCSI Boot Firmware Table (iBFT) as Defined in ACPI 3.0b
 560  * Specification", Version 1.01, March 1, 2007
 561  *
 562  * Note: It appears that this table is not intended to appear in the RSDT/XSDT.
 563  * Therefore, it is not currently supported by the disassembler.
 564  *
 565  ******************************************************************************/
 566
 567 struct acpi_table_ibft {
 568         struct acpi_table_header header;        /* Common ACPI table header */
 569         u8 reserved[12];
 570 };
 571
 572 /* IBFT common subtable header */
 573
 574 struct acpi_ibft_header {
 575         u8 type;
 576         u8 version;
 577         u16 length;
 578         u8 index;
 579         u8 flags;
 580 };
 581
 582 /* Values for Type field above */
 583
 584 enum acpi_ibft_type {
 585         ACPI_IBFT_TYPE_NOT_USED = 0,
 586         ACPI_IBFT_TYPE_CONTROL = 1,
 587         ACPI_IBFT_TYPE_INITIATOR = 2,
 588         ACPI_IBFT_TYPE_NIC = 3,
 589         ACPI_IBFT_TYPE_TARGET = 4,
 590         ACPI_IBFT_TYPE_EXTENSIONS = 5,
 591         ACPI_IBFT_TYPE_RESERVED = 6     /* 6 and greater are reserved */
 592 };
 593
 594 /* IBFT subtables */
 595
 596 struct acpi_ibft_control {
 597         struct acpi_ibft_header header;
 598         u16 extensions;
 599         u16 initiator_offset;
 600         u16 nic0_offset;
 601         u16 target0_offset;
 602         u16 nic1_offset;
 603         u16 target1_offset;
 604 };
 605
 606 struct acpi_ibft_initiator {
 607         struct acpi_ibft_header header;
 608         u8 sns_server[16];
 609         u8 slp_server[16];
 610         u8 primary_server[16];
 611         u8 secondary_server[16];
 612         u16 name_length;
 613         u16 name_offset;
 614 };
 615
 616 struct acpi_ibft_nic {
 617         struct acpi_ibft_header header;
 618         u8 ip_address[16];
 619         u8 subnet_mask_prefix;
 620         u8 origin;
 621         u8 gateway[16];
 622         u8 primary_dns[16];
 623         u8 secondary_dns[16];
 624         u8 dhcp[16];
 625         u16 vlan;
 626         u8 mac_address[6];
 627         u16 pci_address;
 628         u16 name_length;
 629         u16 name_offset;
 630 };
 631
 632 struct acpi_ibft_target {
 633         struct acpi_ibft_header header;
 634         u8 target_ip_address[16];
 635         u16 target_ip_socket;
 636         u8 target_boot_lun[8];
 637         u8 chap_type;
 638         u8 nic_association;
 639         u16 target_name_length;
 640         u16 target_name_offset;
 641         u16 chap_name_length;
 642         u16 chap_name_offset;
 643         u16 chap_secret_length;
 644         u16 chap_secret_offset;
 645         u16 reverse_chap_name_length;
 646         u16 reverse_chap_name_offset;
 647         u16 reverse_chap_secret_length;
 648         u16 reverse_chap_secret_offset;
 649 };
 650
 651 /*******************************************************************************
 652  *
 653  * IVRS - I/O Virtualization Reporting Structure
 654  *        Version 1
 655  *
 656  * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
 657  * Revision 1.26, February 2009.
 658  *
 659  ******************************************************************************/
 660
 661 struct acpi_table_ivrs {
 662         struct acpi_table_header header;        /* Common ACPI table header */
 663         u32 info;               /* Common virtualization info */
 664         u64 reserved;
 665 };
 666
 667 /* Values for Info field above */
 668
 669 #define ACPI_IVRS_PHYSICAL_SIZE     0x00007F00  /* 7 bits, physical address size */
 670 #define ACPI_IVRS_VIRTUAL_SIZE      0x003F8000  /* 7 bits, virtual address size */
 671 #define ACPI_IVRS_ATS_RESERVED      0x00400000  /* ATS address translation range reserved */
 672
 673 /* IVRS subtable header */
 674
 675 struct acpi_ivrs_header {
 676         u8 type;                /* Subtable type */
 677         u8 flags;
 678         u16 length;             /* Subtable length */
 679         u16 device_id;          /* ID of IOMMU */
 680 };
 681
 682 /* Values for subtable Type above */
 683
 684 enum acpi_ivrs_type {
 685         ACPI_IVRS_TYPE_HARDWARE = 0x10,
 686         ACPI_IVRS_TYPE_MEMORY1 = 0x20,
 687         ACPI_IVRS_TYPE_MEMORY2 = 0x21,
 688         ACPI_IVRS_TYPE_MEMORY3 = 0x22
 689 };
 690
 691 /* Masks for Flags field above for IVHD subtable */
 692
 693 #define ACPI_IVHD_TT_ENABLE         (1)
 694 #define ACPI_IVHD_PASS_PW           (1<<1)
 695 #define ACPI_IVHD_RES_PASS_PW       (1<<2)
 696 #define ACPI_IVHD_ISOC              (1<<3)
 697 #define ACPI_IVHD_IOTLB             (1<<4)
 698
 699 /* Masks for Flags field above for IVMD subtable */
 700
 701 #define ACPI_IVMD_UNITY             (1)
 702 #define ACPI_IVMD_READ              (1<<1)
 703 #define ACPI_IVMD_WRITE             (1<<2)
 704 #define ACPI_IVMD_EXCLUSION_RANGE   (1<<3)
 705
 706 /*
 707  * IVRS subtables, correspond to Type in struct acpi_ivrs_header
 708  */
 709
 710 /* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
 711
 712 struct acpi_ivrs_hardware {
 713         struct acpi_ivrs_header header;
 714         u16 capability_offset;  /* Offset for IOMMU control fields */
 715         u64 base_address;       /* IOMMU control registers */
 716         u16 pci_segment_group;
 717         u16 info;               /* MSI number and unit ID */
 718         u32 reserved;
 719 };
 720
 721 /* Masks for Info field above */
 722
 723 #define ACPI_IVHD_MSI_NUMBER_MASK   0x001F      /* 5 bits, MSI message number */
 724 #define ACPI_IVHD_UNIT_ID_MASK      0x1F00      /* 5 bits, unit_ID */
 725
 726 /*
 727  * Device Entries for IVHD subtable, appear after struct acpi_ivrs_hardware structure.
 728  * Upper two bits of the Type field are the (encoded) length of the structure.
 729  * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
 730  * are reserved for future use but not defined.
 731  */
 732 struct acpi_ivrs_de_header {
 733         u8 type;
 734         u16 id;
 735         u8 data_setting;
 736 };
 737
 738 /* Length of device entry is in the top two bits of Type field above */
 739
 740 #define ACPI_IVHD_ENTRY_LENGTH      0xC0
 741
 742 /* Values for device entry Type field above */
 743
 744 enum acpi_ivrs_device_entry_type {
 745         /* 4-byte device entries, all use struct acpi_ivrs_device4 */
 746
 747         ACPI_IVRS_TYPE_PAD4 = 0,
 748         ACPI_IVRS_TYPE_ALL = 1,
 749         ACPI_IVRS_TYPE_SELECT = 2,
 750         ACPI_IVRS_TYPE_START = 3,
 751         ACPI_IVRS_TYPE_END = 4,
 752
 753         /* 8-byte device entries */
 754
 755         ACPI_IVRS_TYPE_PAD8 = 64,
 756         ACPI_IVRS_TYPE_NOT_USED = 65,
 757         ACPI_IVRS_TYPE_ALIAS_SELECT = 66,       /* Uses struct acpi_ivrs_device8a */
 758         ACPI_IVRS_TYPE_ALIAS_START = 67,        /* Uses struct acpi_ivrs_device8a */
 759         ACPI_IVRS_TYPE_EXT_SELECT = 70, /* Uses struct acpi_ivrs_device8b */
 760         ACPI_IVRS_TYPE_EXT_START = 71,  /* Uses struct acpi_ivrs_device8b */
 761         ACPI_IVRS_TYPE_SPECIAL = 72     /* Uses struct acpi_ivrs_device8c */
 762 };
 763
 764 /* Values for Data field above */
 765
 766 #define ACPI_IVHD_INIT_PASS         (1)
 767 #define ACPI_IVHD_EINT_PASS         (1<<1)
 768 #define ACPI_IVHD_NMI_PASS          (1<<2)
 769 #define ACPI_IVHD_SYSTEM_MGMT       (3<<4)
 770 #define ACPI_IVHD_LINT0_PASS        (1<<6)
 771 #define ACPI_IVHD_LINT1_PASS        (1<<7)
 772
 773 /* Types 0-4: 4-byte device entry */
 774
 775 struct acpi_ivrs_device4 {
 776         struct acpi_ivrs_de_header header;
 777 };
 778
 779 /* Types 66-67: 8-byte device entry */
 780
 781 struct acpi_ivrs_device8a {
 782         struct acpi_ivrs_de_header header;
 783         u8 reserved1;
 784         u16 used_id;
 785         u8 reserved2;
 786 };
 787
 788 /* Types 70-71: 8-byte device entry */
 789
 790 struct acpi_ivrs_device8b {
 791         struct acpi_ivrs_de_header header;
 792         u32 extended_data;
 793 };
 794
 795 /* Values for extended_data above */
 796
 797 #define ACPI_IVHD_ATS_DISABLED      (1<<31)
 798
 799 /* Type 72: 8-byte device entry */
 800
 801 struct acpi_ivrs_device8c {
 802         struct acpi_ivrs_de_header header;
 803         u8 handle;
 804         u16 used_id;
 805         u8 variety;
 806 };
 807
 808 /* Values for Variety field above */
 809
 810 #define ACPI_IVHD_IOAPIC            1
 811 #define ACPI_IVHD_HPET              2
 812
 813 /* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
 814
 815 struct acpi_ivrs_memory {
 816         struct acpi_ivrs_header header;
 817         u16 aux_data;
 818         u64 reserved;
 819         u64 start_address;
 820         u64 memory_length;
 821 };
 822
 823 /*******************************************************************************
 824  *
 825  * LPIT - Low Power Idle Table
 826  *
 827  * Conforms to "ACPI Low Power Idle Table (LPIT) and _LPD Proposal (DRAFT)"
 828  *
 829  ******************************************************************************/
 830
 831 struct acpi_table_lpit {
 832         struct acpi_table_header header;        /* Common ACPI table header */
 833 };
 834
 835 /* LPIT subtable header */
 836
 837 struct acpi_lpit_header {
 838         u32 type;               /* Subtable type */
 839         u32 length;             /* Subtable length */
 840         u16 unique_id;
 841         u16 reserved;
 842         u32 flags;
 843 };
 844
 845 /* Values for subtable Type above */
 846
 847 enum acpi_lpit_type {
 848         ACPI_LPIT_TYPE_NATIVE_CSTATE = 0x00,
 849         ACPI_LPIT_TYPE_SIMPLE_IO = 0x01,
 850         ACPI_LPIT_TYPE_RESERVED = 0x02  /* 2 and above are reserved */
 851 };
 852
 853 /* Masks for Flags field above  */
 854
 855 #define ACPI_LPIT_STATE_DISABLED    (1)
 856 #define ACPI_LPIT_NO_COUNTER        (1<<1)
 857
 858 /*
 859  * LPIT subtables, correspond to Type in struct acpi_lpit_header
 860  */
 861
 862 /* 0x00: Native C-state instruction based LPI structure */
 863
 864 struct acpi_lpit_native {
 865         struct acpi_lpit_header header;
 866         struct acpi_generic_address entry_trigger;
 867         u32 residency;
 868         u32 latency;
 869         struct acpi_generic_address residency_counter;
 870         u64 counter_frequency;
 871 };
 872
 873 /* 0x01: Simple I/O based LPI structure */
 874
 875 struct acpi_lpit_io {
 876         struct acpi_lpit_header header;
 877         struct acpi_generic_address entry_trigger;
 878         u32 trigger_action;
 879         u64 trigger_value;
 880         u64 trigger_mask;
 881         struct acpi_generic_address minimum_idle_state;
 882         u32 residency;
 883         u32 latency;
 884         struct acpi_generic_address residency_counter;
 885         u64 counter_frequency;
 886 };
 887
 888 /*******************************************************************************
 889  *
 890  * MCFG - PCI Memory Mapped Configuration table and subtable
 891  *        Version 1
 892  *
 893  * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
 894  *
 895  ******************************************************************************/
 896
 897 struct acpi_table_mcfg {
 898         struct acpi_table_header header;        /* Common ACPI table header */
 899         u8 reserved[8];
 900 };
 901
 902 /* Subtable */
 903
 904 struct acpi_mcfg_allocation {
 905         u64 address;            /* Base address, processor-relative */
 906         u16 pci_segment;        /* PCI segment group number */
 907         u8 start_bus_number;    /* Starting PCI Bus number */
 908         u8 end_bus_number;      /* Final PCI Bus number */
 909         u32 reserved;
 910 };
 911
 912 /*******************************************************************************
 913  *
 914  * MCHI - Management Controller Host Interface Table
 915  *        Version 1
 916  *
 917  * Conforms to "Management Component Transport Protocol (MCTP) Host
 918  * Interface Specification", Revision 1.0.0a, October 13, 2009
 919  *
 920  ******************************************************************************/
 921
 922 struct acpi_table_mchi {
 923         struct acpi_table_header header;        /* Common ACPI table header */
 924         u8 interface_type;
 925         u8 protocol;
 926         u64 protocol_data;
 927         u8 interrupt_type;
 928         u8 gpe;
 929         u8 pci_device_flag;
 930         u32 global_interrupt;
 931         struct acpi_generic_address control_register;
 932         u8 pci_segment;
 933         u8 pci_bus;
 934         u8 pci_device;
 935         u8 pci_function;
 936 };
 937
 938 /*******************************************************************************
 939  *
 940  * MSDM - Microsoft Data Management table
 941  *
 942  * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
 943  * November 29, 2011. Copyright 2011 Microsoft
 944  *
 945  ******************************************************************************/
 946
 947 /* Basic MSDM table is only the common ACPI header */
 948
 949 struct acpi_table_msdm {
 950         struct acpi_table_header header;        /* Common ACPI table header */
 951 };
 952
 953 /*******************************************************************************
 954  *
 955  * MTMR - MID Timer Table
 956  *        Version 1
 957  *
 958  * Conforms to "Simple Firmware Interface Specification",
 959  * Draft 0.8.2, Oct 19, 2010
 960  * NOTE: The ACPI MTMR is equivalent to the SFI MTMR table.
 961  *
 962  ******************************************************************************/
 963
 964 struct acpi_table_mtmr {
 965         struct acpi_table_header header;        /* Common ACPI table header */
 966 };
 967
 968 /* MTMR entry */
 969
 970 struct acpi_mtmr_entry {
 971         struct acpi_generic_address physical_address;
 972         u32 frequency;
 973         u32 irq;
 974 };
 975
 976 /*******************************************************************************
 977  *
 978  * SLIC - Software Licensing Description Table
 979  *
 980  * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
 981  * November 29, 2011. Copyright 2011 Microsoft
 982  *
 983  ******************************************************************************/
 984
 985 /* Basic SLIC table is only the common ACPI header */
 986
 987 struct acpi_table_slic {
 988         struct acpi_table_header header;        /* Common ACPI table header */
 989 };
 990
 991 /*******************************************************************************
 992  *
 993  * SPCR - Serial Port Console Redirection table
 994  *        Version 1
 995  *
 996  * Conforms to "Serial Port Console Redirection Table",
 997  * Version 1.00, January 11, 2002
 998  *
 999  ******************************************************************************/
1000
1001 struct acpi_table_spcr {
1002         struct acpi_table_header header;        /* Common ACPI table header */
1003         u8 interface_type;      /* 0=full 16550, 1=subset of 16550 */
1004         u8 reserved[3];
1005         struct acpi_generic_address serial_port;
1006         u8 interrupt_type;
1007         u8 pc_interrupt;
1008         u32 interrupt;
1009         u8 baud_rate;
1010         u8 parity;
1011         u8 stop_bits;
1012         u8 flow_control;
1013         u8 terminal_type;
1014         u8 reserved1;
1015         u16 pci_device_id;
1016         u16 pci_vendor_id;
1017         u8 pci_bus;
1018         u8 pci_device;
1019         u8 pci_function;
1020         u32 pci_flags;
1021         u8 pci_segment;
1022         u32 reserved2;
1023 };
1024
1025 /* Masks for pci_flags field above */
1026
1027 #define ACPI_SPCR_DO_NOT_DISABLE    (1)
1028
1029 /*******************************************************************************
1030  *
1031  * SPMI - Server Platform Management Interface table
1032  *        Version 5
1033  *
1034  * Conforms to "Intelligent Platform Management Interface Specification
1035  * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
1036  * June 12, 2009 markup.
1037  *
1038  ******************************************************************************/
1039
1040 struct acpi_table_spmi {
1041         struct acpi_table_header header;        /* Common ACPI table header */
1042         u8 interface_type;
1043         u8 reserved;            /* Must be 1 */
1044         u16 spec_revision;      /* Version of IPMI */
1045         u8 interrupt_type;
1046         u8 gpe_number;          /* GPE assigned */
1047         u8 reserved1;
1048         u8 pci_device_flag;
1049         u32 interrupt;
1050         struct acpi_generic_address ipmi_register;
1051         u8 pci_segment;
1052         u8 pci_bus;
1053         u8 pci_device;
1054         u8 pci_function;
1055         u8 reserved2;
1056 };
1057
1058 /* Values for interface_type above */
1059
1060 enum acpi_spmi_interface_types {
1061         ACPI_SPMI_NOT_USED = 0,
1062         ACPI_SPMI_KEYBOARD = 1,
1063         ACPI_SPMI_SMI = 2,
1064         ACPI_SPMI_BLOCK_TRANSFER = 3,
1065         ACPI_SPMI_SMBUS = 4,
1066         ACPI_SPMI_RESERVED = 5  /* 5 and above are reserved */
1067 };
1068
1069 /*******************************************************************************
1070  *
1071  * TCPA - Trusted Computing Platform Alliance table
1072  *        Version 1
1073  *
1074  * Conforms to "TCG PC Specific Implementation Specification",
1075  * Version 1.1, August 18, 2003
1076  *
1077  ******************************************************************************/
1078
1079 struct acpi_table_tcpa {
1080         struct acpi_table_header header;        /* Common ACPI table header */
1081         u16 reserved;
1082         u32 max_log_length;     /* Maximum length for the event log area */
1083         u64 log_address;        /* Address of the event log area */
1084 };
1085
1086 /*******************************************************************************
1087  *
1088  * UEFI - UEFI Boot optimization Table
1089  *        Version 1
1090  *
1091  * Conforms to "Unified Extensible Firmware Interface Specification",
1092  * Version 2.3, May 8, 2009
1093  *
1094  ******************************************************************************/
1095
1096 struct acpi_table_uefi {
1097         struct acpi_table_header header;        /* Common ACPI table header */
1098         u8 identifier[16];      /* UUID identifier */
1099         u16 data_offset;        /* Offset of remaining data in table */
1100 };
1101
1102 /*******************************************************************************
1103  *
1104  * VRTC - Virtual Real Time Clock Table
1105  *        Version 1
1106  *
1107  * Conforms to "Simple Firmware Interface Specification",
1108  * Draft 0.8.2, Oct 19, 2010
1109  * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
1110  *
1111  ******************************************************************************/
1112
1113 struct acpi_table_vrtc {
1114         struct acpi_table_header header;        /* Common ACPI table header */
1115 };
1116
1117 /* VRTC entry */
1118
1119 struct acpi_vrtc_entry {
1120         struct acpi_generic_address physical_address;
1121         u32 irq;
1122 };
1123
1124 /*******************************************************************************
1125  *
1126  * WAET - Windows ACPI Emulated devices Table
1127  *        Version 1
1128  *
1129  * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
1130  *
1131  ******************************************************************************/
1132
1133 struct acpi_table_waet {
1134         struct acpi_table_header header;        /* Common ACPI table header */
1135         u32 flags;
1136 };
1137
1138 /* Masks for Flags field above */
1139
1140 #define ACPI_WAET_RTC_NO_ACK        (1) /* RTC requires no int acknowledge */
1141 #define ACPI_WAET_TIMER_ONE_READ    (1<<1)      /* PM timer requires only one read */
1142
1143 /*******************************************************************************
1144  *
1145  * WDAT - Watchdog Action Table
1146  *        Version 1
1147  *
1148  * Conforms to "Hardware Watchdog Timers Design Specification",
1149  * Copyright 2006 Microsoft Corporation.
1150  *
1151  ******************************************************************************/
1152
1153 struct acpi_table_wdat {
1154         struct acpi_table_header header;        /* Common ACPI table header */
1155         u32 header_length;      /* Watchdog Header Length */
1156         u16 pci_segment;        /* PCI Segment number */
1157         u8 pci_bus;             /* PCI Bus number */
1158         u8 pci_device;          /* PCI Device number */
1159         u8 pci_function;        /* PCI Function number */
1160         u8 reserved[3];
1161         u32 timer_period;       /* Period of one timer count (msec) */
1162         u32 max_count;          /* Maximum counter value supported */
1163         u32 min_count;          /* Minimum counter value */
1164         u8 flags;
1165         u8 reserved2[3];
1166         u32 entries;            /* Number of watchdog entries that follow */
1167 };
1168
1169 /* Masks for Flags field above */
1170
1171 #define ACPI_WDAT_ENABLED           (1)
1172 #define ACPI_WDAT_STOPPED           0x80
1173
1174 /* WDAT Instruction Entries (actions) */
1175
1176 struct acpi_wdat_entry {
1177         u8 action;
1178         u8 instruction;
1179         u16 reserved;
1180         struct acpi_generic_address register_region;
1181         u32 value;              /* Value used with Read/Write register */
1182         u32 mask;               /* Bitmask required for this register instruction */
1183 };
1184
1185 /* Values for Action field above */
1186
1187 enum acpi_wdat_actions {
1188         ACPI_WDAT_RESET = 1,
1189         ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
1190         ACPI_WDAT_GET_COUNTDOWN = 5,
1191         ACPI_WDAT_SET_COUNTDOWN = 6,
1192         ACPI_WDAT_GET_RUNNING_STATE = 8,
1193         ACPI_WDAT_SET_RUNNING_STATE = 9,
1194         ACPI_WDAT_GET_STOPPED_STATE = 10,
1195         ACPI_WDAT_SET_STOPPED_STATE = 11,
1196         ACPI_WDAT_GET_REBOOT = 16,
1197         ACPI_WDAT_SET_REBOOT = 17,
1198         ACPI_WDAT_GET_SHUTDOWN = 18,
1199         ACPI_WDAT_SET_SHUTDOWN = 19,
1200         ACPI_WDAT_GET_STATUS = 32,
1201         ACPI_WDAT_SET_STATUS = 33,
1202         ACPI_WDAT_ACTION_RESERVED = 34  /* 34 and greater are reserved */
1203 };
1204
1205 /* Values for Instruction field above */
1206
1207 enum acpi_wdat_instructions {
1208         ACPI_WDAT_READ_VALUE = 0,
1209         ACPI_WDAT_READ_COUNTDOWN = 1,
1210         ACPI_WDAT_WRITE_VALUE = 2,
1211         ACPI_WDAT_WRITE_COUNTDOWN = 3,
1212         ACPI_WDAT_INSTRUCTION_RESERVED = 4,     /* 4 and greater are reserved */
1213         ACPI_WDAT_PRESERVE_REGISTER = 0x80      /* Except for this value */
1214 };
1215
1216 /*******************************************************************************
1217  *
1218  * WDDT - Watchdog Descriptor Table
1219  *        Version 1
1220  *
1221  * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
1222  * Version 001, September 2002
1223  *
1224  ******************************************************************************/
1225
1226 struct acpi_table_wddt {
1227         struct acpi_table_header header;        /* Common ACPI table header */
1228         u16 spec_version;
1229         u16 table_version;
1230         u16 pci_vendor_id;
1231         struct acpi_generic_address address;
1232         u16 max_count;          /* Maximum counter value supported */
1233         u16 min_count;          /* Minimum counter value supported */
1234         u16 period;
1235         u16 status;
1236         u16 capability;
1237 };
1238
1239 /* Flags for Status field above */
1240
1241 #define ACPI_WDDT_AVAILABLE     (1)
1242 #define ACPI_WDDT_ACTIVE        (1<<1)
1243 #define ACPI_WDDT_TCO_OS_OWNED  (1<<2)
1244 #define ACPI_WDDT_USER_RESET    (1<<11)
1245 #define ACPI_WDDT_WDT_RESET     (1<<12)
1246 #define ACPI_WDDT_POWER_FAIL    (1<<13)
1247 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
1248
1249 /* Flags for Capability field above */
1250
1251 #define ACPI_WDDT_AUTO_RESET    (1)
1252 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
1253
1254 /*******************************************************************************
1255  *
1256  * WDRT - Watchdog Resource Table
1257  *        Version 1
1258  *
1259  * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
1260  * Version 1.01, August 28, 2006
1261  *
1262  ******************************************************************************/
1263
1264 struct acpi_table_wdrt {
1265         struct acpi_table_header header;        /* Common ACPI table header */
1266         struct acpi_generic_address control_register;
1267         struct acpi_generic_address count_register;
1268         u16 pci_device_id;
1269         u16 pci_vendor_id;
1270         u8 pci_bus;             /* PCI Bus number */
1271         u8 pci_device;          /* PCI Device number */
1272         u8 pci_function;        /* PCI Function number */
1273         u8 pci_segment;         /* PCI Segment number */
1274         u16 max_count;          /* Maximum counter value supported */
1275         u8 units;
1276 };
1277
1278 /* Reset to default packing */
1279
1280 #pragma pack()
1281
1282 #endif                          /* __ACTBL2_H__ */