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