xref: /freebsd/sys/contrib/dev/acpica/include/actbl3.h (revision 7937bfbc0ca53fe7cdd0d54414f9296e273a518e)
1 /******************************************************************************
2  *
3  * Name: actbl3.h - ACPI Table Definitions
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ACTBL3_H__
153 #define __ACTBL3_H__
154 
155 
156 /*******************************************************************************
157  *
158  * Additional ACPI Tables
159  *
160  * These tables are not consumed directly by the ACPICA subsystem, but are
161  * included here to support device drivers and the AML disassembler.
162  *
163  ******************************************************************************/
164 
165 
166 /*
167  * Values for description table header signatures for tables defined in this
168  * file. Useful because they make it more difficult to inadvertently type in
169  * the wrong signature.
170  */
171 #define ACPI_SIG_SLIC           "SLIC"      /* Software Licensing Description Table */
172 #define ACPI_SIG_SLIT           "SLIT"      /* System Locality Distance Information Table */
173 #define ACPI_SIG_SPCR           "SPCR"      /* Serial Port Console Redirection table */
174 #define ACPI_SIG_SPMI           "SPMI"      /* Server Platform Management Interface table */
175 #define ACPI_SIG_SRAT           "SRAT"      /* System Resource Affinity Table */
176 #define ACPI_SIG_STAO           "STAO"      /* Status Override table */
177 #define ACPI_SIG_TCPA           "TCPA"      /* Trusted Computing Platform Alliance table */
178 #define ACPI_SIG_TPM2           "TPM2"      /* Trusted Platform Module 2.0 H/W interface table */
179 #define ACPI_SIG_UEFI           "UEFI"      /* Uefi Boot Optimization Table */
180 #define ACPI_SIG_VIOT           "VIOT"      /* Virtual I/O Translation Table */
181 #define ACPI_SIG_WAET           "WAET"      /* Windows ACPI Emulated devices Table */
182 #define ACPI_SIG_WDAT           "WDAT"      /* Watchdog Action Table */
183 #define ACPI_SIG_WDDT           "WDDT"      /* Watchdog Timer Description Table */
184 #define ACPI_SIG_WDRT           "WDRT"      /* Watchdog Resource Table */
185 #define ACPI_SIG_WPBT           "WPBT"      /* Windows Platform Binary Table */
186 #define ACPI_SIG_WSMT           "WSMT"      /* Windows SMM Security Mitigations Table */
187 #define ACPI_SIG_XENV           "XENV"      /* Xen Environment table */
188 #define ACPI_SIG_XXXX           "XXXX"      /* Intermediate AML header for ASL/ASL+ converter */
189 
190 /*
191  * All tables must be byte-packed to match the ACPI specification, since
192  * the tables are provided by the system BIOS.
193  */
194 #pragma pack(1)
195 
196 /*
197  * Note: C bitfields are not used for this reason:
198  *
199  * "Bitfields are great and easy to read, but unfortunately the C language
200  * does not specify the layout of bitfields in memory, which means they are
201  * essentially useless for dealing with packed data in on-disk formats or
202  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
203  * this decision was a design error in C. Ritchie could have picked an order
204  * and stuck with it." Norman Ramsey.
205  * See http://stackoverflow.com/a/1053662/41661
206  */
207 
208 
209 /*******************************************************************************
210  *
211  * SLIC - Software Licensing Description Table
212  *
213  * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
214  * November 29, 2011. Copyright 2011 Microsoft
215  *
216  ******************************************************************************/
217 
218 /* Basic SLIC table is only the common ACPI header */
219 
220 typedef struct acpi_table_slic
221 {
222     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
223 
224 } ACPI_TABLE_SLIC;
225 
226 
227 /*******************************************************************************
228  *
229  * SLIT - System Locality Distance Information Table
230  *        Version 1
231  *
232  ******************************************************************************/
233 
234 typedef struct acpi_table_slit
235 {
236     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
237     UINT64                  LocalityCount;
238     UINT8                   Entry[1];           /* Real size = localities^2 */
239 
240 } ACPI_TABLE_SLIT;
241 
242 
243 /*******************************************************************************
244  *
245  * SPCR - Serial Port Console Redirection table
246  *        Version 4
247  *
248  * Conforms to "Serial Port Console Redirection Table",
249  * Version 1.10, Jan 5, 2023
250  *
251  ******************************************************************************/
252 
253 typedef struct acpi_table_spcr
254 {
255     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
256     UINT8                   InterfaceType;      /* 0=full 16550, 1=subset of 16550 */
257     UINT8                   Reserved[3];
258     ACPI_GENERIC_ADDRESS    SerialPort;
259     UINT8                   InterruptType;
260     UINT8                   PcInterrupt;
261     UINT32                  Interrupt;
262     UINT8                   BaudRate;
263     UINT8                   Parity;
264     UINT8                   StopBits;
265     UINT8                   FlowControl;
266     UINT8                   TerminalType;
267     UINT8                   Language;
268     UINT16                  PciDeviceId;
269     UINT16                  PciVendorId;
270     UINT8                   PciBus;
271     UINT8                   PciDevice;
272     UINT8                   PciFunction;
273     UINT32                  PciFlags;
274     UINT8                   PciSegment;
275     UINT32                  UartClkFreq;
276     UINT32                  PreciseBaudrate;
277     UINT16                  NameSpaceStringLength;
278     UINT16                  NameSpaceStringOffset;
279     char                    NameSpaceString[];
280 
281 } ACPI_TABLE_SPCR;
282 
283 /* Masks for PciFlags field above */
284 
285 #define ACPI_SPCR_DO_NOT_DISABLE    (1)
286 
287 /* Values for Interface Type: See the definition of the DBG2 table */
288 
289 
290 /*******************************************************************************
291  *
292  * SPMI - Server Platform Management Interface table
293  *        Version 5
294  *
295  * Conforms to "Intelligent Platform Management Interface Specification
296  * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
297  * June 12, 2009 markup.
298  *
299  ******************************************************************************/
300 
301 typedef struct acpi_table_spmi
302 {
303     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
304     UINT8                   InterfaceType;
305     UINT8                   Reserved;           /* Must be 1 */
306     UINT16                  SpecRevision;       /* Version of IPMI */
307     UINT8                   InterruptType;
308     UINT8                   GpeNumber;          /* GPE assigned */
309     UINT8                   Reserved1;
310     UINT8                   PciDeviceFlag;
311     UINT32                  Interrupt;
312     ACPI_GENERIC_ADDRESS    IpmiRegister;
313     UINT8                   PciSegment;
314     UINT8                   PciBus;
315     UINT8                   PciDevice;
316     UINT8                   PciFunction;
317     UINT8                   Reserved2;
318 
319 } ACPI_TABLE_SPMI;
320 
321 /* Values for InterfaceType above */
322 
323 enum AcpiSpmiInterfaceTypes
324 {
325     ACPI_SPMI_NOT_USED              = 0,
326     ACPI_SPMI_KEYBOARD              = 1,
327     ACPI_SPMI_SMI                   = 2,
328     ACPI_SPMI_BLOCK_TRANSFER        = 3,
329     ACPI_SPMI_SMBUS                 = 4,
330     ACPI_SPMI_RESERVED              = 5         /* 5 and above are reserved */
331 };
332 
333 
334 /*******************************************************************************
335  *
336  * SRAT - System Resource Affinity Table
337  *        Version 3
338  *
339  ******************************************************************************/
340 
341 typedef struct acpi_table_srat
342 {
343     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
344     UINT32                  TableRevision;      /* Must be value '1' */
345     UINT64                  Reserved;           /* Reserved, must be zero */
346 
347 } ACPI_TABLE_SRAT;
348 
349 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
350 
351 enum AcpiSratType
352 {
353     ACPI_SRAT_TYPE_CPU_AFFINITY         = 0,
354     ACPI_SRAT_TYPE_MEMORY_AFFINITY      = 1,
355     ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY  = 2,
356     ACPI_SRAT_TYPE_GICC_AFFINITY        = 3,
357     ACPI_SRAT_TYPE_GIC_ITS_AFFINITY     = 4, /* ACPI 6.2 */
358     ACPI_SRAT_TYPE_GENERIC_AFFINITY     = 5, /* ACPI 6.3 */
359     ACPI_SRAT_TYPE_GENERIC_PORT_AFFINITY = 6, /* ACPI 6.4 */
360     ACPI_SRAT_TYPE_RESERVED              = 7  /* 7 and greater are reserved */
361 };
362 
363 /*
364  * SRAT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
365  */
366 
367 /* 0: Processor Local APIC/SAPIC Affinity */
368 
369 typedef struct acpi_srat_cpu_affinity
370 {
371     ACPI_SUBTABLE_HEADER    Header;
372     UINT8                   ProximityDomainLo;
373     UINT8                   ApicId;
374     UINT32                  Flags;
375     UINT8                   LocalSapicEid;
376     UINT8                   ProximityDomainHi[3];
377     UINT32                  ClockDomain;
378 
379 } ACPI_SRAT_CPU_AFFINITY;
380 
381 /* Flags */
382 
383 #define ACPI_SRAT_CPU_USE_AFFINITY  (1)         /* 00: Use affinity structure */
384 
385 
386 /* 1: Memory Affinity */
387 
388 typedef struct acpi_srat_mem_affinity
389 {
390     ACPI_SUBTABLE_HEADER    Header;
391     UINT32                  ProximityDomain;
392     UINT16                  Reserved;           /* Reserved, must be zero */
393     UINT64                  BaseAddress;
394     UINT64                  Length;
395     UINT32                  Reserved1;
396     UINT32                  Flags;
397     UINT64                  Reserved2;          /* Reserved, must be zero */
398 
399 } ACPI_SRAT_MEM_AFFINITY;
400 
401 /* Flags */
402 
403 #define ACPI_SRAT_MEM_ENABLED       (1)         /* 00: Use affinity structure */
404 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1)      /* 01: Memory region is hot pluggable */
405 #define ACPI_SRAT_MEM_NON_VOLATILE  (1<<2)      /* 02: Memory region is non-volatile */
406 
407 
408 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
409 
410 typedef struct acpi_srat_x2apic_cpu_affinity
411 {
412     ACPI_SUBTABLE_HEADER    Header;
413     UINT16                  Reserved;           /* Reserved, must be zero */
414     UINT32                  ProximityDomain;
415     UINT32                  ApicId;
416     UINT32                  Flags;
417     UINT32                  ClockDomain;
418     UINT32                  Reserved2;
419 
420 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
421 
422 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
423 
424 #define ACPI_SRAT_CPU_ENABLED       (1)         /* 00: Use affinity structure */
425 
426 
427 /* 3: GICC Affinity (ACPI 5.1) */
428 
429 typedef struct acpi_srat_gicc_affinity
430 {
431     ACPI_SUBTABLE_HEADER    Header;
432     UINT32                  ProximityDomain;
433     UINT32                  AcpiProcessorUid;
434     UINT32                  Flags;
435     UINT32                  ClockDomain;
436 
437 } ACPI_SRAT_GICC_AFFINITY;
438 
439 /* Flags for ACPI_SRAT_GICC_AFFINITY */
440 
441 #define ACPI_SRAT_GICC_ENABLED     (1)         /* 00: Use affinity structure */
442 
443 
444 /* 4: GCC ITS Affinity (ACPI 6.2) */
445 
446 typedef struct acpi_srat_gic_its_affinity
447 {
448     ACPI_SUBTABLE_HEADER    Header;
449     UINT32                  ProximityDomain;
450     UINT16                  Reserved;
451     UINT32                  ItsId;
452 
453 } ACPI_SRAT_GIC_ITS_AFFINITY;
454 
455 /*
456  * Common structure for SRAT subtable types:
457  * 5: ACPI_SRAT_TYPE_GENERIC_AFFINITY
458  * 6: ACPI_SRAT_TYPE_GENERIC_PORT_AFFINITY
459  */
460 
461 #define ACPI_SRAT_DEVICE_HANDLE_SIZE	16
462 
463 typedef struct acpi_srat_generic_affinity
464 {
465     ACPI_SUBTABLE_HEADER    Header;
466     UINT8                   Reserved;
467     UINT8                   DeviceHandleType;
468     UINT32                  ProximityDomain;
469     UINT8                   DeviceHandle[ACPI_SRAT_DEVICE_HANDLE_SIZE];
470     UINT32                  Flags;
471     UINT32                  Reserved1;
472 
473 } ACPI_SRAT_GENERIC_AFFINITY;
474 
475 /* Flags for ACPI_SRAT_GENERIC_AFFINITY */
476 
477 #define ACPI_SRAT_GENERIC_AFFINITY_ENABLED     (1)      /* 00: Use affinity structure */
478 #define ACPI_SRAT_ARCHITECTURAL_TRANSACTIONS   (1<<1)   /* ACPI 6.4 */
479 
480 /*******************************************************************************
481  *
482  * STAO - Status Override Table (_STA override) - ACPI 6.0
483  *        Version 1
484  *
485  * Conforms to "ACPI Specification for Status Override Table"
486  * 6 January 2015
487  *
488  ******************************************************************************/
489 
490 typedef struct acpi_table_stao
491 {
492     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
493     UINT8                   IgnoreUart;
494 
495 } ACPI_TABLE_STAO;
496 
497 
498 /*******************************************************************************
499  *
500  * TCPA - Trusted Computing Platform Alliance table
501  *        Version 2
502  *
503  * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
504  *
505  * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
506  * Version 1.2, Revision 8
507  * February 27, 2017
508  *
509  * NOTE: There are two versions of the table with the same signature --
510  * the client version and the server version. The common PlatformClass
511  * field is used to differentiate the two types of tables.
512  *
513  ******************************************************************************/
514 
515 typedef struct acpi_table_tcpa_hdr
516 {
517     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
518     UINT16                  PlatformClass;
519 
520 } ACPI_TABLE_TCPA_HDR;
521 
522 /*
523  * Values for PlatformClass above.
524  * This is how the client and server subtables are differentiated
525  */
526 #define ACPI_TCPA_CLIENT_TABLE          0
527 #define ACPI_TCPA_SERVER_TABLE          1
528 
529 
530 typedef struct acpi_table_tcpa_client
531 {
532     UINT32                  MinimumLogLength;   /* Minimum length for the event log area */
533     UINT64                  LogAddress;         /* Address of the event log area */
534 
535 } ACPI_TABLE_TCPA_CLIENT;
536 
537 typedef struct acpi_table_tcpa_server
538 {
539     UINT16                  Reserved;
540     UINT64                  MinimumLogLength;   /* Minimum length for the event log area */
541     UINT64                  LogAddress;         /* Address of the event log area */
542     UINT16                  SpecRevision;
543     UINT8                   DeviceFlags;
544     UINT8                   InterruptFlags;
545     UINT8                   GpeNumber;
546     UINT8                   Reserved2[3];
547     UINT32                  GlobalInterrupt;
548     ACPI_GENERIC_ADDRESS    Address;
549     UINT32                  Reserved3;
550     ACPI_GENERIC_ADDRESS    ConfigAddress;
551     UINT8                   Group;
552     UINT8                   Bus;                /* PCI Bus/Segment/Function numbers */
553     UINT8                   Device;
554     UINT8                   Function;
555 
556 } ACPI_TABLE_TCPA_SERVER;
557 
558 /* Values for DeviceFlags above */
559 
560 #define ACPI_TCPA_PCI_DEVICE            (1)
561 #define ACPI_TCPA_BUS_PNP               (1<<1)
562 #define ACPI_TCPA_ADDRESS_VALID         (1<<2)
563 
564 /* Values for InterruptFlags above */
565 
566 #define ACPI_TCPA_INTERRUPT_MODE        (1)
567 #define ACPI_TCPA_INTERRUPT_POLARITY    (1<<1)
568 #define ACPI_TCPA_SCI_VIA_GPE           (1<<2)
569 #define ACPI_TCPA_GLOBAL_INTERRUPT      (1<<3)
570 
571 
572 /*******************************************************************************
573  *
574  * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
575  *        Version 4
576  *
577  * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
578  *
579  * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
580  * Version 1.2, Revision 8
581  * February 27, 2017
582  *
583  ******************************************************************************/
584 
585 /* Revision 3 */
586 
587 typedef struct acpi_table_tpm23
588 {
589     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
590     UINT32                  Reserved;
591     UINT64                  ControlAddress;
592     UINT32                  StartMethod;
593 
594 } ACPI_TABLE_TPM23;
595 
596 /* Value for StartMethod above */
597 
598 #define ACPI_TPM23_ACPI_START_METHOD                 2
599 
600 /*
601  * Optional trailer for revision 3. If start method is 2, there is a 4 byte
602  * reserved area of all zeros.
603  */
604 typedef struct acpi_tmp23_trailer
605 {
606     UINT32                  Reserved;
607 
608 } ACPI_TPM23_TRAILER;
609 
610 
611 /* Revision 4 */
612 
613 typedef struct acpi_table_tpm2
614 {
615     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
616     UINT16                  PlatformClass;
617     UINT16                  Reserved;
618     UINT64                  ControlAddress;
619     UINT32                  StartMethod;
620 
621     /* Platform-specific data follows */
622 
623 } ACPI_TABLE_TPM2;
624 
625 /* Values for StartMethod above */
626 
627 #define ACPI_TPM2_NOT_ALLOWED                       0
628 #define ACPI_TPM2_RESERVED1                         1
629 #define ACPI_TPM2_START_METHOD                      2
630 #define ACPI_TPM2_RESERVED3                         3
631 #define ACPI_TPM2_RESERVED4                         4
632 #define ACPI_TPM2_RESERVED5                         5
633 #define ACPI_TPM2_MEMORY_MAPPED                     6
634 #define ACPI_TPM2_COMMAND_BUFFER                    7
635 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD  8
636 #define ACPI_TPM2_RESERVED9                         9
637 #define ACPI_TPM2_RESERVED10                        10
638 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC       11  /* V1.2 Rev 8 */
639 #define ACPI_TPM2_RESERVED                          12
640 
641 
642 /* Optional trailer appears after any StartMethod subtables */
643 
644 typedef struct acpi_tpm2_trailer
645 {
646     UINT8                   MethodParameters[12];
647     UINT32                  MinimumLogLength;   /* Minimum length for the event log area */
648     UINT64                  LogAddress;         /* Address of the event log area */
649 
650 } ACPI_TPM2_TRAILER;
651 
652 
653 /*
654  * Subtables (StartMethod-specific)
655  */
656 
657 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
658 
659 typedef struct acpi_tpm2_arm_smc
660 {
661     UINT32                  GlobalInterrupt;
662     UINT8                   InterruptFlags;
663     UINT8                   OperationFlags;
664     UINT16                  Reserved;
665     UINT32                  FunctionId;
666 
667 } ACPI_TPM2_ARM_SMC;
668 
669 /* Values for InterruptFlags above */
670 
671 #define ACPI_TPM2_INTERRUPT_SUPPORT     (1)
672 
673 /* Values for OperationFlags above */
674 
675 #define ACPI_TPM2_IDLE_SUPPORT          (1)
676 
677 
678 /*******************************************************************************
679  *
680  * UEFI - UEFI Boot optimization Table
681  *        Version 1
682  *
683  * Conforms to "Unified Extensible Firmware Interface Specification",
684  * Version 2.3, May 8, 2009
685  *
686  ******************************************************************************/
687 
688 typedef struct acpi_table_uefi
689 {
690     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
691     UINT8                   Identifier[16];     /* UUID identifier */
692     UINT16                  DataOffset;         /* Offset of remaining data in table */
693 
694 } ACPI_TABLE_UEFI;
695 
696 
697 /*******************************************************************************
698  *
699  * VIOT - Virtual I/O Translation Table
700  *        Version 1
701  *
702  ******************************************************************************/
703 
704 typedef struct acpi_table_viot
705 {
706     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
707     UINT16                  NodeCount;
708     UINT16                  NodeOffset;
709     UINT8                   Reserved[8];
710 
711 } ACPI_TABLE_VIOT;
712 
713 /* VIOT subtable header */
714 
715 typedef struct acpi_viot_header
716 {
717     UINT8                   Type;
718     UINT8                   Reserved;
719     UINT16                  Length;
720 
721 } ACPI_VIOT_HEADER;
722 
723 /* Values for Type field above */
724 
725 enum AcpiViotNodeType
726 {
727     ACPI_VIOT_NODE_PCI_RANGE            = 0x01,
728     ACPI_VIOT_NODE_MMIO                 = 0x02,
729     ACPI_VIOT_NODE_VIRTIO_IOMMU_PCI     = 0x03,
730     ACPI_VIOT_NODE_VIRTIO_IOMMU_MMIO    = 0x04,
731     ACPI_VIOT_RESERVED                  = 0x05
732 };
733 
734 /* VIOT subtables */
735 
736 typedef struct acpi_viot_pci_range
737 {
738     ACPI_VIOT_HEADER        Header;
739     UINT32                  EndpointStart;
740     UINT16                  SegmentStart;
741     UINT16                  SegmentEnd;
742     UINT16                  BdfStart;
743     UINT16                  BdfEnd;
744     UINT16                  OutputNode;
745     UINT8                   Reserved[6];
746 
747 } ACPI_VIOT_PCI_RANGE;
748 
749 typedef struct acpi_viot_mmio
750 {
751     ACPI_VIOT_HEADER        Header;
752     UINT32                  Endpoint;
753     UINT64                  BaseAddress;
754     UINT16                  OutputNode;
755     UINT8                   Reserved[6];
756 
757 } ACPI_VIOT_MMIO;
758 
759 typedef struct acpi_viot_virtio_iommu_pci
760 {
761     ACPI_VIOT_HEADER        Header;
762     UINT16                  Segment;
763     UINT16                  Bdf;
764     UINT8                   Reserved[8];
765 
766 } ACPI_VIOT_VIRTIO_IOMMU_PCI;
767 
768 typedef struct acpi_viot_virtio_iommu_mmio
769 {
770     ACPI_VIOT_HEADER        Header;
771     UINT8                   Reserved[4];
772     UINT64                  BaseAddress;
773 
774 } ACPI_VIOT_VIRTIO_IOMMU_MMIO;
775 
776 
777 /*******************************************************************************
778  *
779  * WAET - Windows ACPI Emulated devices Table
780  *        Version 1
781  *
782  * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
783  *
784  ******************************************************************************/
785 
786 typedef struct acpi_table_waet
787 {
788     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
789     UINT32                  Flags;
790 
791 } ACPI_TABLE_WAET;
792 
793 /* Masks for Flags field above */
794 
795 #define ACPI_WAET_RTC_NO_ACK        (1)         /* RTC requires no int acknowledge */
796 #define ACPI_WAET_TIMER_ONE_READ    (1<<1)      /* PM timer requires only one read */
797 
798 
799 /*******************************************************************************
800  *
801  * WDAT - Watchdog Action Table
802  *        Version 1
803  *
804  * Conforms to "Hardware Watchdog Timers Design Specification",
805  * Copyright 2006 Microsoft Corporation.
806  *
807  ******************************************************************************/
808 
809 typedef struct acpi_table_wdat
810 {
811     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
812     UINT32                  HeaderLength;       /* Watchdog Header Length */
813     UINT16                  PciSegment;         /* PCI Segment number */
814     UINT8                   PciBus;             /* PCI Bus number */
815     UINT8                   PciDevice;          /* PCI Device number */
816     UINT8                   PciFunction;        /* PCI Function number */
817     UINT8                   Reserved[3];
818     UINT32                  TimerPeriod;        /* Period of one timer count (msec) */
819     UINT32                  MaxCount;           /* Maximum counter value supported */
820     UINT32                  MinCount;           /* Minimum counter value */
821     UINT8                   Flags;
822     UINT8                   Reserved2[3];
823     UINT32                  Entries;            /* Number of watchdog entries that follow */
824 
825 } ACPI_TABLE_WDAT;
826 
827 /* Masks for Flags field above */
828 
829 #define ACPI_WDAT_ENABLED           (1)
830 #define ACPI_WDAT_STOPPED           0x80
831 
832 
833 /* WDAT Instruction Entries (actions) */
834 
835 typedef struct acpi_wdat_entry
836 {
837     UINT8                   Action;
838     UINT8                   Instruction;
839     UINT16                  Reserved;
840     ACPI_GENERIC_ADDRESS    RegisterRegion;
841     UINT32                  Value;              /* Value used with Read/Write register */
842     UINT32                  Mask;               /* Bitmask required for this register instruction */
843 
844 } ACPI_WDAT_ENTRY;
845 
846 /* Values for Action field above */
847 
848 enum AcpiWdatActions
849 {
850     ACPI_WDAT_RESET                 = 1,
851     ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
852     ACPI_WDAT_GET_COUNTDOWN         = 5,
853     ACPI_WDAT_SET_COUNTDOWN         = 6,
854     ACPI_WDAT_GET_RUNNING_STATE     = 8,
855     ACPI_WDAT_SET_RUNNING_STATE     = 9,
856     ACPI_WDAT_GET_STOPPED_STATE     = 10,
857     ACPI_WDAT_SET_STOPPED_STATE     = 11,
858     ACPI_WDAT_GET_REBOOT            = 16,
859     ACPI_WDAT_SET_REBOOT            = 17,
860     ACPI_WDAT_GET_SHUTDOWN          = 18,
861     ACPI_WDAT_SET_SHUTDOWN          = 19,
862     ACPI_WDAT_GET_STATUS            = 32,
863     ACPI_WDAT_SET_STATUS            = 33,
864     ACPI_WDAT_ACTION_RESERVED       = 34    /* 34 and greater are reserved */
865 };
866 
867 /* Values for Instruction field above */
868 
869 enum AcpiWdatInstructions
870 {
871     ACPI_WDAT_READ_VALUE            = 0,
872     ACPI_WDAT_READ_COUNTDOWN        = 1,
873     ACPI_WDAT_WRITE_VALUE           = 2,
874     ACPI_WDAT_WRITE_COUNTDOWN       = 3,
875     ACPI_WDAT_INSTRUCTION_RESERVED  = 4,    /* 4 and greater are reserved */
876     ACPI_WDAT_PRESERVE_REGISTER     = 0x80  /* Except for this value */
877 };
878 
879 
880 /*******************************************************************************
881  *
882  * WDDT - Watchdog Descriptor Table
883  *        Version 1
884  *
885  * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
886  * Version 001, September 2002
887  *
888  ******************************************************************************/
889 
890 typedef struct acpi_table_wddt
891 {
892     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
893     UINT16                  SpecVersion;
894     UINT16                  TableVersion;
895     UINT16                  PciVendorId;
896     ACPI_GENERIC_ADDRESS    Address;
897     UINT16                  MaxCount;           /* Maximum counter value supported */
898     UINT16                  MinCount;           /* Minimum counter value supported */
899     UINT16                  Period;
900     UINT16                  Status;
901     UINT16                  Capability;
902 
903 } ACPI_TABLE_WDDT;
904 
905 /* Flags for Status field above */
906 
907 #define ACPI_WDDT_AVAILABLE     (1)
908 #define ACPI_WDDT_ACTIVE        (1<<1)
909 #define ACPI_WDDT_TCO_OS_OWNED  (1<<2)
910 #define ACPI_WDDT_USER_RESET    (1<<11)
911 #define ACPI_WDDT_WDT_RESET     (1<<12)
912 #define ACPI_WDDT_POWER_FAIL    (1<<13)
913 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
914 
915 /* Flags for Capability field above */
916 
917 #define ACPI_WDDT_AUTO_RESET    (1)
918 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
919 
920 
921 /*******************************************************************************
922  *
923  * WDRT - Watchdog Resource Table
924  *        Version 1
925  *
926  * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
927  * Version 1.01, August 28, 2006
928  *
929  ******************************************************************************/
930 
931 typedef struct acpi_table_wdrt
932 {
933     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
934     ACPI_GENERIC_ADDRESS    ControlRegister;
935     ACPI_GENERIC_ADDRESS    CountRegister;
936     UINT16                  PciDeviceId;
937     UINT16                  PciVendorId;
938     UINT8                   PciBus;             /* PCI Bus number */
939     UINT8                   PciDevice;          /* PCI Device number */
940     UINT8                   PciFunction;        /* PCI Function number */
941     UINT8                   PciSegment;         /* PCI Segment number */
942     UINT16                  MaxCount;           /* Maximum counter value supported */
943     UINT8                   Units;
944 
945 } ACPI_TABLE_WDRT;
946 
947 
948 /*******************************************************************************
949  *
950  * WPBT - Windows Platform Environment Table (ACPI 6.0)
951  *        Version 1
952  *
953  * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
954  *
955  ******************************************************************************/
956 
957 typedef struct acpi_table_wpbt
958 {
959     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
960     UINT32                  HandoffSize;
961     UINT64                  HandoffAddress;
962     UINT8                   Layout;
963     UINT8                   Type;
964     UINT16                  ArgumentsLength;
965 
966 } ACPI_TABLE_WPBT;
967 
968 typedef struct acpi_wpbt_unicode
969 {
970     UINT16                  *UnicodeString;
971 
972 } ACPI_WPBT_UNICODE;
973 
974 
975 /*******************************************************************************
976  *
977  * WSMT - Windows SMM Security Mitigations Table
978  *        Version 1
979  *
980  * Conforms to "Windows SMM Security Mitigations Table",
981  * Version 1.0, April 18, 2016
982  *
983  ******************************************************************************/
984 
985 typedef struct acpi_table_wsmt
986 {
987     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
988     UINT32                  ProtectionFlags;
989 
990 } ACPI_TABLE_WSMT;
991 
992 /* Flags for ProtectionFlags field above */
993 
994 #define ACPI_WSMT_FIXED_COMM_BUFFERS                (1)
995 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
996 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION        (4)
997 
998 
999 /*******************************************************************************
1000  *
1001  * XENV - Xen Environment Table (ACPI 6.0)
1002  *        Version 1
1003  *
1004  * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
1005  *
1006  ******************************************************************************/
1007 
1008 typedef struct acpi_table_xenv
1009 {
1010     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1011     UINT64                  GrantTableAddress;
1012     UINT64                  GrantTableSize;
1013     UINT32                  EventInterrupt;
1014     UINT8                   EventFlags;
1015 
1016 } ACPI_TABLE_XENV;
1017 
1018 
1019 /* Reset to default packing */
1020 
1021 #pragma pack()
1022 
1023 #endif /* __ACTBL3_H__ */
1024