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