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