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