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