drivers/bus/acpi/acpica/include/actbl3.h

   1 /******************************************************************************
   2  *
   3  * Name: actbl3.h - ACPI Table Definitions
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2021, 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 MERCHANTABILITY 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 __ACTBL3_H__
  45 #define __ACTBL3_H__
  46
  47
  48 /*******************************************************************************
  49  *
  50  * Additional ACPI Tables
  51  *
  52  * These tables are not consumed directly by the ACPICA subsystem, but are
  53  * included here to support device drivers and the AML disassembler.
  54  *
  55  ******************************************************************************/
  56
  57
  58 /*
  59  * Values for description table header signatures for tables defined in this
  60  * file. Useful because they make it more difficult to inadvertently type in
  61  * the wrong signature.
  62  */
  63 #define ACPI_SIG_SLIC           "SLIC"      /* Software Licensing Description Table */
  64 #define ACPI_SIG_SLIT           "SLIT"      /* System Locality Distance Information Table */
  65 #define ACPI_SIG_SPCR           "SPCR"      /* Serial Port Console Redirection table */
  66 #define ACPI_SIG_SPMI           "SPMI"      /* Server Platform Management Interface table */
  67 #define ACPI_SIG_SRAT           "SRAT"      /* System Resource Affinity Table */
  68 #define ACPI_SIG_STAO           "STAO"      /* Status Override table */
  69 #define ACPI_SIG_TCPA           "TCPA"      /* Trusted Computing Platform Alliance table */
  70 #define ACPI_SIG_TPM2           "TPM2"      /* Trusted Platform Module 2.0 H/W interface table */
  71 #define ACPI_SIG_UEFI           "UEFI"      /* Uefi Boot Optimization Table */
  72 #define ACPI_SIG_VIOT           "VIOT"      /* Virtual I/O Translation Table */
  73 #define ACPI_SIG_WAET           "WAET"      /* Windows ACPI Emulated devices Table */
  74 #define ACPI_SIG_WDAT           "WDAT"      /* Watchdog Action Table */
  75 #define ACPI_SIG_WDDT           "WDDT"      /* Watchdog Timer Description Table */
  76 #define ACPI_SIG_WDRT           "WDRT"      /* Watchdog Resource Table */
  77 #define ACPI_SIG_WPBT           "WPBT"      /* Windows Platform Binary Table */
  78 #define ACPI_SIG_WSMT           "WSMT"      /* Windows SMM Security Mitigations Table */
  79 #define ACPI_SIG_XENV           "XENV"      /* Xen Environment table */
  80 #define ACPI_SIG_XXXX           "XXXX"      /* Intermediate AML header for ASL/ASL+ converter */
  81
  82 /*
  83  * All tables must be byte-packed to match the ACPI specification, since
  84  * the tables are provided by the system BIOS.
  85  */
  86 #pragma pack(1)
  87
  88 /*
  89  * Note: C bitfields are not used for this reason:
  90  *
  91  * "Bitfields are great and easy to read, but unfortunately the C language
  92  * does not specify the layout of bitfields in memory, which means they are
  93  * essentially useless for dealing with packed data in on-disk formats or
  94  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
  95  * this decision was a design error in C. Ritchie could have picked an order
  96  * and stuck with it." Norman Ramsey.
  97  * See http://stackoverflow.com/a/1053662/41661
  98  */
  99
 100
 101 /*******************************************************************************
 102  *
 103  * SLIC - Software Licensing Description Table
 104  *
 105  * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
 106  * November 29, 2011. Copyright 2011 Microsoft
 107  *
 108  ******************************************************************************/
 109
 110 /* Basic SLIC table is only the common ACPI header */
 111
 112 typedef struct acpi_table_slic
 113 {
 114     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 115
 116 } ACPI_TABLE_SLIC;
 117
 118
 119 /*******************************************************************************
 120  *
 121  * SLIT - System Locality Distance Information Table
 122  *        Version 1
 123  *
 124  ******************************************************************************/
 125
 126 typedef struct acpi_table_slit
 127 {
 128     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 129     UINT64                  LocalityCount;
 130     UINT8                   Entry[1];           /* Real size = localities^2 */
 131
 132 } ACPI_TABLE_SLIT;
 133
 134
 135 /*******************************************************************************
 136  *
 137  * SPCR - Serial Port Console Redirection table
 138  *        Version 2
 139  *
 140  * Conforms to "Serial Port Console Redirection Table",
 141  * Version 1.03, August 10, 2015
 142  *
 143  ******************************************************************************/
 144
 145 typedef struct acpi_table_spcr
 146 {
 147     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 148     UINT8                   InterfaceType;      /* 0=full 16550, 1=subset of 16550 */
 149     UINT8                   Reserved[3];
 150     ACPI_GENERIC_ADDRESS    SerialPort;
 151     UINT8                   InterruptType;
 152     UINT8                   PcInterrupt;
 153     UINT32                  Interrupt;
 154     UINT8                   BaudRate;
 155     UINT8                   Parity;
 156     UINT8                   StopBits;
 157     UINT8                   FlowControl;
 158     UINT8                   TerminalType;
 159     UINT8                   Reserved1;
 160     UINT16                  PciDeviceId;
 161     UINT16                  PciVendorId;
 162     UINT8                   PciBus;
 163     UINT8                   PciDevice;
 164     UINT8                   PciFunction;
 165     UINT32                  PciFlags;
 166     UINT8                   PciSegment;
 167     UINT32                  Reserved2;
 168
 169 } ACPI_TABLE_SPCR;
 170
 171 /* Masks for PciFlags field above */
 172
 173 #define ACPI_SPCR_DO_NOT_DISABLE    (1)
 174
 175 /* Values for Interface Type: See the definition of the DBG2 table */
 176
 177
 178 /*******************************************************************************
 179  *
 180  * SPMI - Server Platform Management Interface table
 181  *        Version 5
 182  *
 183  * Conforms to "Intelligent Platform Management Interface Specification
 184  * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
 185  * June 12, 2009 markup.
 186  *
 187  ******************************************************************************/
 188
 189 typedef struct acpi_table_spmi
 190 {
 191     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 192     UINT8                   InterfaceType;
 193     UINT8                   Reserved;           /* Must be 1 */
 194     UINT16                  SpecRevision;       /* Version of IPMI */
 195     UINT8                   InterruptType;
 196     UINT8                   GpeNumber;          /* GPE assigned */
 197     UINT8                   Reserved1;
 198     UINT8                   PciDeviceFlag;
 199     UINT32                  Interrupt;
 200     ACPI_GENERIC_ADDRESS    IpmiRegister;
 201     UINT8                   PciSegment;
 202     UINT8                   PciBus;
 203     UINT8                   PciDevice;
 204     UINT8                   PciFunction;
 205     UINT8                   Reserved2;
 206
 207 } ACPI_TABLE_SPMI;
 208
 209 /* Values for InterfaceType above */
 210
 211 enum AcpiSpmiInterfaceTypes
 212 {
 213     ACPI_SPMI_NOT_USED              = 0,
 214     ACPI_SPMI_KEYBOARD              = 1,
 215     ACPI_SPMI_SMI                   = 2,
 216     ACPI_SPMI_BLOCK_TRANSFER        = 3,
 217     ACPI_SPMI_SMBUS                 = 4,
 218     ACPI_SPMI_RESERVED              = 5         /* 5 and above are reserved */
 219 };
 220
 221
 222 /*******************************************************************************
 223  *
 224  * SRAT - System Resource Affinity Table
 225  *        Version 3
 226  *
 227  ******************************************************************************/
 228
 229 typedef struct acpi_table_srat
 230 {
 231     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 232     UINT32                  TableRevision;      /* Must be value '1' */
 233     UINT64                  Reserved;           /* Reserved, must be zero */
 234
 235 } ACPI_TABLE_SRAT;
 236
 237 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
 238
 239 enum AcpiSratType
 240 {
 241     ACPI_SRAT_TYPE_CPU_AFFINITY         = 0,
 242     ACPI_SRAT_TYPE_MEMORY_AFFINITY      = 1,
 243     ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY  = 2,
 244     ACPI_SRAT_TYPE_GICC_AFFINITY        = 3,
 245     ACPI_SRAT_TYPE_GIC_ITS_AFFINITY     = 4, /* ACPI 6.2 */
 246     ACPI_SRAT_TYPE_GENERIC_AFFINITY     = 5, /* ACPI 6.3 */
 247     ACPI_SRAT_TYPE_RESERVED             = 6  /* 5 and greater are reserved */
 248 };
 249
 250 /*
 251  * SRAT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
 252  */
 253
 254 /* 0: Processor Local APIC/SAPIC Affinity */
 255
 256 typedef struct acpi_srat_cpu_affinity
 257 {
 258     ACPI_SUBTABLE_HEADER    Header;
 259     UINT8                   ProximityDomainLo;
 260     UINT8                   ApicId;
 261     UINT32                  Flags;
 262     UINT8                   LocalSapicEid;
 263     UINT8                   ProximityDomainHi[3];
 264     UINT32                  ClockDomain;
 265
 266 } ACPI_SRAT_CPU_AFFINITY;
 267
 268 /* Flags */
 269
 270 #define ACPI_SRAT_CPU_USE_AFFINITY  (1)         /* 00: Use affinity structure */
 271
 272
 273 /* 1: Memory Affinity */
 274
 275 typedef struct acpi_srat_mem_affinity
 276 {
 277     ACPI_SUBTABLE_HEADER    Header;
 278     UINT32                  ProximityDomain;
 279     UINT16                  Reserved;           /* Reserved, must be zero */
 280     UINT64                  BaseAddress;
 281     UINT64                  Length;
 282     UINT32                  Reserved1;
 283     UINT32                  Flags;
 284     UINT64                  Reserved2;          /* Reserved, must be zero */
 285
 286 } ACPI_SRAT_MEM_AFFINITY;
 287
 288 /* Flags */
 289
 290 #define ACPI_SRAT_MEM_ENABLED       (1)         /* 00: Use affinity structure */
 291 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1)      /* 01: Memory region is hot pluggable */
 292 #define ACPI_SRAT_MEM_NON_VOLATILE  (1<<2)      /* 02: Memory region is non-volatile */
 293
 294
 295 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
 296
 297 typedef struct acpi_srat_x2apic_cpu_affinity
 298 {
 299     ACPI_SUBTABLE_HEADER    Header;
 300     UINT16                  Reserved;           /* Reserved, must be zero */
 301     UINT32                  ProximityDomain;
 302     UINT32                  ApicId;
 303     UINT32                  Flags;
 304     UINT32                  ClockDomain;
 305     UINT32                  Reserved2;
 306
 307 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
 308
 309 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
 310
 311 #define ACPI_SRAT_CPU_ENABLED       (1)         /* 00: Use affinity structure */
 312
 313
 314 /* 3: GICC Affinity (ACPI 5.1) */
 315
 316 typedef struct acpi_srat_gicc_affinity
 317 {
 318     ACPI_SUBTABLE_HEADER    Header;
 319     UINT32                  ProximityDomain;
 320     UINT32                  AcpiProcessorUid;
 321     UINT32                  Flags;
 322     UINT32                  ClockDomain;
 323
 324 } ACPI_SRAT_GICC_AFFINITY;
 325
 326 /* Flags for ACPI_SRAT_GICC_AFFINITY */
 327
 328 #define ACPI_SRAT_GICC_ENABLED     (1)         /* 00: Use affinity structure */
 329
 330
 331 /* 4: GCC ITS Affinity (ACPI 6.2) */
 332
 333 typedef struct acpi_srat_gic_its_affinity
 334 {
 335     ACPI_SUBTABLE_HEADER    Header;
 336     UINT32                  ProximityDomain;
 337     UINT16                  Reserved;
 338     UINT32                  ItsId;
 339
 340 } ACPI_SRAT_GIC_ITS_AFFINITY;
 341
 342
 343 /* 5: Generic Initiator Affinity Structure (ACPI 6.3) */
 344
 345 typedef struct acpi_srat_generic_affinity
 346 {
 347     ACPI_SUBTABLE_HEADER    Header;
 348     UINT8                   Reserved;
 349     UINT8                   DeviceHandleType;
 350     UINT32                  ProximityDomain;
 351     UINT8                   DeviceHandle[16];
 352     UINT32                  Flags;
 353     UINT32                  Reserved1;
 354
 355 } ACPI_SRAT_GENERIC_AFFINITY;
 356
 357 /* Flags for ACPI_SRAT_GENERIC_AFFINITY */
 358
 359 #define ACPI_SRAT_GENERIC_AFFINITY_ENABLED     (1)      /* 00: Use affinity structure */
 360 #define ACPI_SRAT_ARCHITECTURAL_TRANSACTIONS   (1<<1)   /* ACPI 6.4 */
 361
 362 /*******************************************************************************
 363  *
 364  * STAO - Status Override Table (_STA override) - ACPI 6.0
 365  *        Version 1
 366  *
 367  * Conforms to "ACPI Specification for Status Override Table"
 368  * 6 January 2015
 369  *
 370  ******************************************************************************/
 371
 372 typedef struct acpi_table_stao
 373 {
 374     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 375     UINT8                   IgnoreUart;
 376
 377 } ACPI_TABLE_STAO;
 378
 379
 380 /*******************************************************************************
 381  *
 382  * TCPA - Trusted Computing Platform Alliance table
 383  *        Version 2
 384  *
 385  * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
 386  *
 387  * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
 388  * Version 1.2, Revision 8
 389  * February 27, 2017
 390  *
 391  * NOTE: There are two versions of the table with the same signature --
 392  * the client version and the server version. The common PlatformClass
 393  * field is used to differentiate the two types of tables.
 394  *
 395  ******************************************************************************/
 396
 397 typedef struct acpi_table_tcpa_hdr
 398 {
 399     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 400     UINT16                  PlatformClass;
 401
 402 } ACPI_TABLE_TCPA_HDR;
 403
 404 /*
 405  * Values for PlatformClass above.
 406  * This is how the client and server subtables are differentiated
 407  */
 408 #define ACPI_TCPA_CLIENT_TABLE          0
 409 #define ACPI_TCPA_SERVER_TABLE          1
 410
 411
 412 typedef struct acpi_table_tcpa_client
 413 {
 414     UINT32                  MinimumLogLength;   /* Minimum length for the event log area */
 415     UINT64                  LogAddress;         /* Address of the event log area */
 416
 417 } ACPI_TABLE_TCPA_CLIENT;
 418
 419 typedef struct acpi_table_tcpa_server
 420 {
 421     UINT16                  Reserved;
 422     UINT64                  MinimumLogLength;   /* Minimum length for the event log area */
 423     UINT64                  LogAddress;         /* Address of the event log area */
 424     UINT16                  SpecRevision;
 425     UINT8                   DeviceFlags;
 426     UINT8                   InterruptFlags;
 427     UINT8                   GpeNumber;
 428     UINT8                   Reserved2[3];
 429     UINT32                  GlobalInterrupt;
 430     ACPI_GENERIC_ADDRESS    Address;
 431     UINT32                  Reserved3;
 432     ACPI_GENERIC_ADDRESS    ConfigAddress;
 433     UINT8                   Group;
 434     UINT8                   Bus;                /* PCI Bus/Segment/Function numbers */
 435     UINT8                   Device;
 436     UINT8                   Function;
 437
 438 } ACPI_TABLE_TCPA_SERVER;
 439
 440 /* Values for DeviceFlags above */
 441
 442 #define ACPI_TCPA_PCI_DEVICE            (1)
 443 #define ACPI_TCPA_BUS_PNP               (1<<1)
 444 #define ACPI_TCPA_ADDRESS_VALID         (1<<2)
 445
 446 /* Values for InterruptFlags above */
 447
 448 #define ACPI_TCPA_INTERRUPT_MODE        (1)
 449 #define ACPI_TCPA_INTERRUPT_POLARITY    (1<<1)
 450 #define ACPI_TCPA_SCI_VIA_GPE           (1<<2)
 451 #define ACPI_TCPA_GLOBAL_INTERRUPT      (1<<3)
 452
 453
 454 /*******************************************************************************
 455  *
 456  * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
 457  *        Version 4
 458  *
 459  * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
 460  *
 461  * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
 462  * Version 1.2, Revision 8
 463  * February 27, 2017
 464  *
 465  ******************************************************************************/
 466
 467 /* Revision 3 */
 468
 469 typedef struct acpi_table_tpm23
 470 {
 471     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 472     UINT32                  Reserved;
 473     UINT64                  ControlAddress;
 474     UINT32                  StartMethod;
 475
 476 } ACPI_TABLE_TPM23;
 477
 478 /* Value for StartMethod above */
 479
 480 #define ACPI_TPM23_ACPI_START_METHOD                 2
 481
 482 /*
 483  * Optional trailer for revision 3. If start method is 2, there is a 4 byte
 484  * reserved area of all zeros.
 485  */
 486 typedef struct acpi_tmp23_trailer
 487 {
 488     UINT32                  Reserved;
 489
 490 } ACPI_TPM23_TRAILER;
 491
 492
 493 /* Revision 4 */
 494
 495 typedef struct acpi_table_tpm2
 496 {
 497     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 498     UINT16                  PlatformClass;
 499     UINT16                  Reserved;
 500     UINT64                  ControlAddress;
 501     UINT32                  StartMethod;
 502
 503     /* Platform-specific data follows */
 504
 505 } ACPI_TABLE_TPM2;
 506
 507 /* Values for StartMethod above */
 508
 509 #define ACPI_TPM2_NOT_ALLOWED                       0
 510 #define ACPI_TPM2_RESERVED1                         1
 511 #define ACPI_TPM2_START_METHOD                      2
 512 #define ACPI_TPM2_RESERVED3                         3
 513 #define ACPI_TPM2_RESERVED4                         4
 514 #define ACPI_TPM2_RESERVED5                         5
 515 #define ACPI_TPM2_MEMORY_MAPPED                     6
 516 #define ACPI_TPM2_COMMAND_BUFFER                    7
 517 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD  8
 518 #define ACPI_TPM2_RESERVED9                         9
 519 #define ACPI_TPM2_RESERVED10                        10
 520 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC       11  /* V1.2 Rev 8 */
 521 #define ACPI_TPM2_RESERVED                          12
 522
 523
 524 /* Optional trailer appears after any StartMethod subtables */
 525
 526 typedef struct acpi_tpm2_trailer
 527 {
 528     UINT8                   MethodParameters[12];
 529     UINT32                  MinimumLogLength;   /* Minimum length for the event log area */
 530     UINT64                  LogAddress;         /* Address of the event log area */
 531
 532 } ACPI_TPM2_TRAILER;
 533
 534
 535 /*
 536  * Subtables (StartMethod-specific)
 537  */
 538
 539 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
 540
 541 typedef struct acpi_tpm2_arm_smc
 542 {
 543     UINT32                  GlobalInterrupt;
 544     UINT8                   InterruptFlags;
 545     UINT8                   OperationFlags;
 546     UINT16                  Reserved;
 547     UINT32                  FunctionId;
 548
 549 } ACPI_TPM2_ARM_SMC;
 550
 551 /* Values for InterruptFlags above */
 552
 553 #define ACPI_TPM2_INTERRUPT_SUPPORT     (1)
 554
 555 /* Values for OperationFlags above */
 556
 557 #define ACPI_TPM2_IDLE_SUPPORT          (1)
 558
 559
 560 /*******************************************************************************
 561  *
 562  * UEFI - UEFI Boot optimization Table
 563  *        Version 1
 564  *
 565  * Conforms to "Unified Extensible Firmware Interface Specification",
 566  * Version 2.3, May 8, 2009
 567  *
 568  ******************************************************************************/
 569
 570 typedef struct acpi_table_uefi
 571 {
 572     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 573     UINT8                   Identifier[16];     /* UUID identifier */
 574     UINT16                  DataOffset;         /* Offset of remaining data in table */
 575
 576 } ACPI_TABLE_UEFI;
 577
 578
 579 /*******************************************************************************
 580  *
 581  * VIOT - Virtual I/O Translation Table
 582  *        Version 1
 583  *
 584  ******************************************************************************/
 585
 586 typedef struct acpi_table_viot
 587 {
 588     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 589     UINT16                  NodeCount;
 590     UINT16                  NodeOffset;
 591     UINT8                   Reserved[8];
 592
 593 } ACPI_TABLE_VIOT;
 594
 595 /* VIOT subtable header */
 596
 597 typedef struct acpi_viot_header
 598 {
 599     UINT8                   Type;
 600     UINT8                   Reserved;
 601     UINT16                  Length;
 602
 603 } ACPI_VIOT_HEADER;
 604
 605 /* Values for Type field above */
 606
 607 enum AcpiViotNodeType
 608 {
 609     ACPI_VIOT_NODE_PCI_RANGE            = 0x01,
 610     ACPI_VIOT_NODE_MMIO                 = 0x02,
 611     ACPI_VIOT_NODE_VIRTIO_IOMMU_PCI     = 0x03,
 612     ACPI_VIOT_NODE_VIRTIO_IOMMU_MMIO    = 0x04,
 613     ACPI_VIOT_RESERVED                  = 0x05
 614 };
 615
 616 /* VIOT subtables */
 617
 618 typedef struct acpi_viot_pci_range
 619 {
 620     ACPI_VIOT_HEADER        Header;
 621     UINT32                  EndpointStart;
 622     UINT16                  SegmentStart;
 623     UINT16                  SegmentEnd;
 624     UINT16                  BdfStart;
 625     UINT16                  BdfEnd;
 626     UINT16                  OutputNode;
 627     UINT8                   Reserved[6];
 628
 629 } ACPI_VIOT_PCI_RANGE;
 630
 631 typedef struct acpi_viot_mmio
 632 {
 633     ACPI_VIOT_HEADER        Header;
 634     UINT32                  Endpoint;
 635     UINT64                  BaseAddress;
 636     UINT16                  OutputNode;
 637     UINT8                   Reserved[6];
 638
 639 } ACPI_VIOT_MMIO;
 640
 641 typedef struct acpi_viot_virtio_iommu_pci
 642 {
 643     ACPI_VIOT_HEADER        Header;
 644     UINT16                  Segment;
 645     UINT16                  Bdf;
 646     UINT8                   Reserved[8];
 647
 648 } ACPI_VIOT_VIRTIO_IOMMU_PCI;
 649
 650 typedef struct acpi_viot_virtio_iommu_mmio
 651 {
 652     ACPI_VIOT_HEADER        Header;
 653     UINT8                   Reserved[4];
 654     UINT64                  BaseAddress;
 655
 656 } ACPI_VIOT_VIRTIO_IOMMU_MMIO;
 657
 658
 659 /*******************************************************************************
 660  *
 661  * WAET - Windows ACPI Emulated devices Table
 662  *        Version 1
 663  *
 664  * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
 665  *
 666  ******************************************************************************/
 667
 668 typedef struct acpi_table_waet
 669 {
 670     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 671     UINT32                  Flags;
 672
 673 } ACPI_TABLE_WAET;
 674
 675 /* Masks for Flags field above */
 676
 677 #define ACPI_WAET_RTC_NO_ACK        (1)         /* RTC requires no int acknowledge */
 678 #define ACPI_WAET_TIMER_ONE_READ    (1<<1)      /* PM timer requires only one read */
 679
 680
 681 /*******************************************************************************
 682  *
 683  * WDAT - Watchdog Action Table
 684  *        Version 1
 685  *
 686  * Conforms to "Hardware Watchdog Timers Design Specification",
 687  * Copyright 2006 Microsoft Corporation.
 688  *
 689  ******************************************************************************/
 690
 691 typedef struct acpi_table_wdat
 692 {
 693     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 694     UINT32                  HeaderLength;       /* Watchdog Header Length */
 695     UINT16                  PciSegment;         /* PCI Segment number */
 696     UINT8                   PciBus;             /* PCI Bus number */
 697     UINT8                   PciDevice;          /* PCI Device number */
 698     UINT8                   PciFunction;        /* PCI Function number */
 699     UINT8                   Reserved[3];
 700     UINT32                  TimerPeriod;        /* Period of one timer count (msec) */
 701     UINT32                  MaxCount;           /* Maximum counter value supported */
 702     UINT32                  MinCount;           /* Minimum counter value */
 703     UINT8                   Flags;
 704     UINT8                   Reserved2[3];
 705     UINT32                  Entries;            /* Number of watchdog entries that follow */
 706
 707 } ACPI_TABLE_WDAT;
 708
 709 /* Masks for Flags field above */
 710
 711 #define ACPI_WDAT_ENABLED           (1)
 712 #define ACPI_WDAT_STOPPED           0x80
 713
 714
 715 /* WDAT Instruction Entries (actions) */
 716
 717 typedef struct acpi_wdat_entry
 718 {
 719     UINT8                   Action;
 720     UINT8                   Instruction;
 721     UINT16                  Reserved;
 722     ACPI_GENERIC_ADDRESS    RegisterRegion;
 723     UINT32                  Value;              /* Value used with Read/Write register */
 724     UINT32                  Mask;               /* Bitmask required for this register instruction */
 725
 726 } ACPI_WDAT_ENTRY;
 727
 728 /* Values for Action field above */
 729
 730 enum AcpiWdatActions
 731 {
 732     ACPI_WDAT_RESET                 = 1,
 733     ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
 734     ACPI_WDAT_GET_COUNTDOWN         = 5,
 735     ACPI_WDAT_SET_COUNTDOWN         = 6,
 736     ACPI_WDAT_GET_RUNNING_STATE     = 8,
 737     ACPI_WDAT_SET_RUNNING_STATE     = 9,
 738     ACPI_WDAT_GET_STOPPED_STATE     = 10,
 739     ACPI_WDAT_SET_STOPPED_STATE     = 11,
 740     ACPI_WDAT_GET_REBOOT            = 16,
 741     ACPI_WDAT_SET_REBOOT            = 17,
 742     ACPI_WDAT_GET_SHUTDOWN          = 18,
 743     ACPI_WDAT_SET_SHUTDOWN          = 19,
 744     ACPI_WDAT_GET_STATUS            = 32,
 745     ACPI_WDAT_SET_STATUS            = 33,
 746     ACPI_WDAT_ACTION_RESERVED       = 34    /* 34 and greater are reserved */
 747 };
 748
 749 /* Values for Instruction field above */
 750
 751 enum AcpiWdatInstructions
 752 {
 753     ACPI_WDAT_READ_VALUE            = 0,
 754     ACPI_WDAT_READ_COUNTDOWN        = 1,
 755     ACPI_WDAT_WRITE_VALUE           = 2,
 756     ACPI_WDAT_WRITE_COUNTDOWN       = 3,
 757     ACPI_WDAT_INSTRUCTION_RESERVED  = 4,    /* 4 and greater are reserved */
 758     ACPI_WDAT_PRESERVE_REGISTER     = 0x80  /* Except for this value */
 759 };
 760
 761
 762 /*******************************************************************************
 763  *
 764  * WDDT - Watchdog Descriptor Table
 765  *        Version 1
 766  *
 767  * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
 768  * Version 001, September 2002
 769  *
 770  ******************************************************************************/
 771
 772 typedef struct acpi_table_wddt
 773 {
 774     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 775     UINT16                  SpecVersion;
 776     UINT16                  TableVersion;
 777     UINT16                  PciVendorId;
 778     ACPI_GENERIC_ADDRESS    Address;
 779     UINT16                  MaxCount;           /* Maximum counter value supported */
 780     UINT16                  MinCount;           /* Minimum counter value supported */
 781     UINT16                  Period;
 782     UINT16                  Status;
 783     UINT16                  Capability;
 784
 785 } ACPI_TABLE_WDDT;
 786
 787 /* Flags for Status field above */
 788
 789 #define ACPI_WDDT_AVAILABLE     (1)
 790 #define ACPI_WDDT_ACTIVE        (1<<1)
 791 #define ACPI_WDDT_TCO_OS_OWNED  (1<<2)
 792 #define ACPI_WDDT_USER_RESET    (1<<11)
 793 #define ACPI_WDDT_WDT_RESET     (1<<12)
 794 #define ACPI_WDDT_POWER_FAIL    (1<<13)
 795 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
 796
 797 /* Flags for Capability field above */
 798
 799 #define ACPI_WDDT_AUTO_RESET    (1)
 800 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
 801
 802
 803 /*******************************************************************************
 804  *
 805  * WDRT - Watchdog Resource Table
 806  *        Version 1
 807  *
 808  * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
 809  * Version 1.01, August 28, 2006
 810  *
 811  ******************************************************************************/
 812
 813 typedef struct acpi_table_wdrt
 814 {
 815     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 816     ACPI_GENERIC_ADDRESS    ControlRegister;
 817     ACPI_GENERIC_ADDRESS    CountRegister;
 818     UINT16                  PciDeviceId;
 819     UINT16                  PciVendorId;
 820     UINT8                   PciBus;             /* PCI Bus number */
 821     UINT8                   PciDevice;          /* PCI Device number */
 822     UINT8                   PciFunction;        /* PCI Function number */
 823     UINT8                   PciSegment;         /* PCI Segment number */
 824     UINT16                  MaxCount;           /* Maximum counter value supported */
 825     UINT8                   Units;
 826
 827 } ACPI_TABLE_WDRT;
 828
 829
 830 /*******************************************************************************
 831  *
 832  * WPBT - Windows Platform Environment Table (ACPI 6.0)
 833  *        Version 1
 834  *
 835  * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
 836  *
 837  ******************************************************************************/
 838
 839 typedef struct acpi_table_wpbt
 840 {
 841     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 842     UINT32                  HandoffSize;
 843     UINT64                  HandoffAddress;
 844     UINT8                   Layout;
 845     UINT8                   Type;
 846     UINT16                  ArgumentsLength;
 847
 848 } ACPI_TABLE_WPBT;
 849
 850 typedef struct acpi_wpbt_unicode
 851 {
 852     UINT16                  *UnicodeString;
 853
 854 } ACPI_WPBT_UNICODE;
 855
 856
 857 /*******************************************************************************
 858  *
 859  * WSMT - Windows SMM Security Mitigations Table
 860  *        Version 1
 861  *
 862  * Conforms to "Windows SMM Security Mitigations Table",
 863  * Version 1.0, April 18, 2016
 864  *
 865  ******************************************************************************/
 866
 867 typedef struct acpi_table_wsmt
 868 {
 869     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 870     UINT32                  ProtectionFlags;
 871
 872 } ACPI_TABLE_WSMT;
 873
 874 /* Flags for ProtectionFlags field above */
 875
 876 #define ACPI_WSMT_FIXED_COMM_BUFFERS                (1)
 877 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
 878 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION        (4)
 879
 880
 881 /*******************************************************************************
 882  *
 883  * XENV - Xen Environment Table (ACPI 6.0)
 884  *        Version 1
 885  *
 886  * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
 887  *
 888  ******************************************************************************/
 889
 890 typedef struct acpi_table_xenv
 891 {
 892     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
 893     UINT64                  GrantTableAddress;
 894     UINT64                  GrantTableSize;
 895     UINT32                  EventInterrupt;
 896     UINT8                   EventFlags;
 897
 898 } ACPI_TABLE_XENV;
 899
 900
 901 /* Reset to default packing */
 902
 903 #pragma pack()
 904
 905 #endif /* __ACTBL3_H__ */