xref: /reactos/drivers/bus/acpi/acpica/include/actbl3.h (revision 0f92924a)
1 /******************************************************************************
2  *
3  * Name: actbl3.h - ACPI Table Definitions
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2019, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ACTBL3_H__
45 #define __ACTBL3_H__
46 
47 
48 /*******************************************************************************
49  *
50  * Additional ACPI Tables
51  *
52  * These tables are not consumed directly by the ACPICA subsystem, but are
53  * included here to support device drivers and the AML disassembler.
54  *
55  ******************************************************************************/
56 
57 
58 /*
59  * Values for description table header signatures for tables defined in this
60  * file. Useful because they make it more difficult to inadvertently type in
61  * the wrong signature.
62  */
63 #define ACPI_SIG_SLIC           "SLIC"      /* Software Licensing Description Table */
64 #define ACPI_SIG_SLIT           "SLIT"      /* System Locality Distance Information Table */
65 #define ACPI_SIG_SPCR           "SPCR"      /* Serial Port Console Redirection table */
66 #define ACPI_SIG_SPMI           "SPMI"      /* Server Platform Management Interface table */
67 #define ACPI_SIG_SRAT           "SRAT"      /* System Resource Affinity Table */
68 #define ACPI_SIG_STAO           "STAO"      /* Status Override table */
69 #define ACPI_SIG_TCPA           "TCPA"      /* Trusted Computing Platform Alliance table */
70 #define ACPI_SIG_TPM2           "TPM2"      /* Trusted Platform Module 2.0 H/W interface table */
71 #define ACPI_SIG_UEFI           "UEFI"      /* Uefi Boot Optimization Table */
72 #define ACPI_SIG_VRTC           "VRTC"      /* Virtual Real Time Clock Table */
73 #define ACPI_SIG_WAET           "WAET"      /* Windows ACPI Emulated devices Table */
74 #define ACPI_SIG_WDAT           "WDAT"      /* Watchdog Action Table */
75 #define ACPI_SIG_WDDT           "WDDT"      /* Watchdog Timer Description Table */
76 #define ACPI_SIG_WDRT           "WDRT"      /* Watchdog Resource Table */
77 #define ACPI_SIG_WPBT           "WPBT"      /* Windows Platform Binary Table */
78 #define ACPI_SIG_WSMT           "WSMT"      /* Windows SMM Security Migrations Table */
79 #define ACPI_SIG_XENV           "XENV"      /* Xen Environment table */
80 #define ACPI_SIG_XXXX           "XXXX"      /* Intermediate AML header for ASL/ASL+ converter */
81 
82 /*
83  * All tables must be byte-packed to match the ACPI specification, since
84  * the tables are provided by the system BIOS.
85  */
86 #pragma pack(1)
87 
88 /*
89  * Note: C bitfields are not used for this reason:
90  *
91  * "Bitfields are great and easy to read, but unfortunately the C language
92  * does not specify the layout of bitfields in memory, which means they are
93  * essentially useless for dealing with packed data in on-disk formats or
94  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
95  * this decision was a design error in C. Ritchie could have picked an order
96  * and stuck with it." Norman Ramsey.
97  * See http://stackoverflow.com/a/1053662/41661
98  */
99 
100 
101 /*******************************************************************************
102  *
103  * SLIC - Software Licensing Description Table
104  *
105  * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
106  * November 29, 2011. Copyright 2011 Microsoft
107  *
108  ******************************************************************************/
109 
110 /* Basic SLIC table is only the common ACPI header */
111 
112 typedef struct acpi_table_slic
113 {
114     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
115 
116 } ACPI_TABLE_SLIC;
117 
118 
119 /*******************************************************************************
120  *
121  * SLIT - System Locality Distance Information Table
122  *        Version 1
123  *
124  ******************************************************************************/
125 
126 typedef struct acpi_table_slit
127 {
128     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
129     UINT64                  LocalityCount;
130     UINT8                   Entry[1];           /* Real size = localities^2 */
131 
132 } ACPI_TABLE_SLIT;
133 
134 
135 /*******************************************************************************
136  *
137  * SPCR - Serial Port Console Redirection table
138  *        Version 2
139  *
140  * Conforms to "Serial Port Console Redirection Table",
141  * Version 1.03, August 10, 2015
142  *
143  ******************************************************************************/
144 
145 typedef struct acpi_table_spcr
146 {
147     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
148     UINT8                   InterfaceType;      /* 0=full 16550, 1=subset of 16550 */
149     UINT8                   Reserved[3];
150     ACPI_GENERIC_ADDRESS    SerialPort;
151     UINT8                   InterruptType;
152     UINT8                   PcInterrupt;
153     UINT32                  Interrupt;
154     UINT8                   BaudRate;
155     UINT8                   Parity;
156     UINT8                   StopBits;
157     UINT8                   FlowControl;
158     UINT8                   TerminalType;
159     UINT8                   Reserved1;
160     UINT16                  PciDeviceId;
161     UINT16                  PciVendorId;
162     UINT8                   PciBus;
163     UINT8                   PciDevice;
164     UINT8                   PciFunction;
165     UINT32                  PciFlags;
166     UINT8                   PciSegment;
167     UINT32                  Reserved2;
168 
169 } ACPI_TABLE_SPCR;
170 
171 /* Masks for PciFlags field above */
172 
173 #define ACPI_SPCR_DO_NOT_DISABLE    (1)
174 
175 /* Values for Interface Type: See the definition of the DBG2 table */
176 
177 
178 /*******************************************************************************
179  *
180  * SPMI - Server Platform Management Interface table
181  *        Version 5
182  *
183  * Conforms to "Intelligent Platform Management Interface Specification
184  * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
185  * June 12, 2009 markup.
186  *
187  ******************************************************************************/
188 
189 typedef struct acpi_table_spmi
190 {
191     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
192     UINT8                   InterfaceType;
193     UINT8                   Reserved;           /* Must be 1 */
194     UINT16                  SpecRevision;       /* Version of IPMI */
195     UINT8                   InterruptType;
196     UINT8                   GpeNumber;          /* GPE assigned */
197     UINT8                   Reserved1;
198     UINT8                   PciDeviceFlag;
199     UINT32                  Interrupt;
200     ACPI_GENERIC_ADDRESS    IpmiRegister;
201     UINT8                   PciSegment;
202     UINT8                   PciBus;
203     UINT8                   PciDevice;
204     UINT8                   PciFunction;
205     UINT8                   Reserved2;
206 
207 } ACPI_TABLE_SPMI;
208 
209 /* Values for InterfaceType above */
210 
211 enum AcpiSpmiInterfaceTypes
212 {
213     ACPI_SPMI_NOT_USED              = 0,
214     ACPI_SPMI_KEYBOARD              = 1,
215     ACPI_SPMI_SMI                   = 2,
216     ACPI_SPMI_BLOCK_TRANSFER        = 3,
217     ACPI_SPMI_SMBUS                 = 4,
218     ACPI_SPMI_RESERVED              = 5         /* 5 and above are reserved */
219 };
220 
221 
222 /*******************************************************************************
223  *
224  * SRAT - System Resource Affinity Table
225  *        Version 3
226  *
227  ******************************************************************************/
228 
229 typedef struct acpi_table_srat
230 {
231     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
232     UINT32                  TableRevision;      /* Must be value '1' */
233     UINT64                  Reserved;           /* Reserved, must be zero */
234 
235 } ACPI_TABLE_SRAT;
236 
237 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
238 
239 enum AcpiSratType
240 {
241     ACPI_SRAT_TYPE_CPU_AFFINITY         = 0,
242     ACPI_SRAT_TYPE_MEMORY_AFFINITY      = 1,
243     ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY  = 2,
244     ACPI_SRAT_TYPE_GICC_AFFINITY        = 3,
245     ACPI_SRAT_TYPE_GIC_ITS_AFFINITY     = 4, /* ACPI 6.2 */
246     ACPI_SRAT_TYPE_GENERIC_AFFINITY     = 5, /* ACPI 6.3 */
247     ACPI_SRAT_TYPE_RESERVED             = 6  /* 5 and greater are reserved */
248 };
249 
250 /*
251  * SRAT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
252  */
253 
254 /* 0: Processor Local APIC/SAPIC Affinity */
255 
256 typedef struct acpi_srat_cpu_affinity
257 {
258     ACPI_SUBTABLE_HEADER    Header;
259     UINT8                   ProximityDomainLo;
260     UINT8                   ApicId;
261     UINT32                  Flags;
262     UINT8                   LocalSapicEid;
263     UINT8                   ProximityDomainHi[3];
264     UINT32                  ClockDomain;
265 
266 } ACPI_SRAT_CPU_AFFINITY;
267 
268 /* Flags */
269 
270 #define ACPI_SRAT_CPU_USE_AFFINITY  (1)         /* 00: Use affinity structure */
271 
272 
273 /* 1: Memory Affinity */
274 
275 typedef struct acpi_srat_mem_affinity
276 {
277     ACPI_SUBTABLE_HEADER    Header;
278     UINT32                  ProximityDomain;
279     UINT16                  Reserved;           /* Reserved, must be zero */
280     UINT64                  BaseAddress;
281     UINT64                  Length;
282     UINT32                  Reserved1;
283     UINT32                  Flags;
284     UINT64                  Reserved2;          /* Reserved, must be zero */
285 
286 } ACPI_SRAT_MEM_AFFINITY;
287 
288 /* Flags */
289 
290 #define ACPI_SRAT_MEM_ENABLED       (1)         /* 00: Use affinity structure */
291 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1)      /* 01: Memory region is hot pluggable */
292 #define ACPI_SRAT_MEM_NON_VOLATILE  (1<<2)      /* 02: Memory region is non-volatile */
293 
294 
295 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
296 
297 typedef struct acpi_srat_x2apic_cpu_affinity
298 {
299     ACPI_SUBTABLE_HEADER    Header;
300     UINT16                  Reserved;           /* Reserved, must be zero */
301     UINT32                  ProximityDomain;
302     UINT32                  ApicId;
303     UINT32                  Flags;
304     UINT32                  ClockDomain;
305     UINT32                  Reserved2;
306 
307 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
308 
309 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
310 
311 #define ACPI_SRAT_CPU_ENABLED       (1)         /* 00: Use affinity structure */
312 
313 
314 /* 3: GICC Affinity (ACPI 5.1) */
315 
316 typedef struct acpi_srat_gicc_affinity
317 {
318     ACPI_SUBTABLE_HEADER    Header;
319     UINT32                  ProximityDomain;
320     UINT32                  AcpiProcessorUid;
321     UINT32                  Flags;
322     UINT32                  ClockDomain;
323 
324 } ACPI_SRAT_GICC_AFFINITY;
325 
326 /* Flags for ACPI_SRAT_GICC_AFFINITY */
327 
328 #define ACPI_SRAT_GICC_ENABLED     (1)         /* 00: Use affinity structure */
329 
330 
331 /* 4: GCC ITS Affinity (ACPI 6.2) */
332 
333 typedef struct acpi_srat_gic_its_affinity
334 {
335     ACPI_SUBTABLE_HEADER    Header;
336     UINT32                  ProximityDomain;
337     UINT16                  Reserved;
338     UINT32                  ItsId;
339 
340 } ACPI_SRAT_GIC_ITS_AFFINITY;
341 
342 
343 /* 5: Generic Initiator Affinity Structure (ACPI 6.3) */
344 
345 typedef struct acpi_srat_generic_affinity
346 {
347     ACPI_SUBTABLE_HEADER    Header;
348     UINT8                   Reserved;
349     UINT8                   DeviceHandleType;
350     UINT32                  ProximityDomain;
351     UINT8                   DeviceHandle[16];
352     UINT32                  Flags;
353     UINT32                  Reserved1;
354 
355 } ACPI_SRAT_GENERIC_AFFINITY;
356 
357 /* Flags for ACPI_SRAT_GENERIC_AFFINITY */
358 
359 #define ACPI_SRAT_GENERIC_AFFINITY_ENABLED (1) /* 00: Use affinity structure */
360 
361 /*******************************************************************************
362  *
363  * STAO - Status Override Table (_STA override) - ACPI 6.0
364  *        Version 1
365  *
366  * Conforms to "ACPI Specification for Status Override Table"
367  * 6 January 2015
368  *
369  ******************************************************************************/
370 
371 typedef struct acpi_table_stao
372 {
373     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
374     UINT8                   IgnoreUart;
375 
376 } ACPI_TABLE_STAO;
377 
378 
379 /*******************************************************************************
380  *
381  * TCPA - Trusted Computing Platform Alliance table
382  *        Version 2
383  *
384  * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
385  *
386  * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
387  * Version 1.2, Revision 8
388  * February 27, 2017
389  *
390  * NOTE: There are two versions of the table with the same signature --
391  * the client version and the server version. The common PlatformClass
392  * field is used to differentiate the two types of tables.
393  *
394  ******************************************************************************/
395 
396 typedef struct acpi_table_tcpa_hdr
397 {
398     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
399     UINT16                  PlatformClass;
400 
401 } ACPI_TABLE_TCPA_HDR;
402 
403 /*
404  * Values for PlatformClass above.
405  * This is how the client and server subtables are differentiated
406  */
407 #define ACPI_TCPA_CLIENT_TABLE          0
408 #define ACPI_TCPA_SERVER_TABLE          1
409 
410 
411 typedef struct acpi_table_tcpa_client
412 {
413     UINT32                  MinimumLogLength;   /* Minimum length for the event log area */
414     UINT64                  LogAddress;         /* Address of the event log area */
415 
416 } ACPI_TABLE_TCPA_CLIENT;
417 
418 typedef struct acpi_table_tcpa_server
419 {
420     UINT16                  Reserved;
421     UINT64                  MinimumLogLength;   /* Minimum length for the event log area */
422     UINT64                  LogAddress;         /* Address of the event log area */
423     UINT16                  SpecRevision;
424     UINT8                   DeviceFlags;
425     UINT8                   InterruptFlags;
426     UINT8                   GpeNumber;
427     UINT8                   Reserved2[3];
428     UINT32                  GlobalInterrupt;
429     ACPI_GENERIC_ADDRESS    Address;
430     UINT32                  Reserved3;
431     ACPI_GENERIC_ADDRESS    ConfigAddress;
432     UINT8                   Group;
433     UINT8                   Bus;                /* PCI Bus/Segment/Function numbers */
434     UINT8                   Device;
435     UINT8                   Function;
436 
437 } ACPI_TABLE_TCPA_SERVER;
438 
439 /* Values for DeviceFlags above */
440 
441 #define ACPI_TCPA_PCI_DEVICE            (1)
442 #define ACPI_TCPA_BUS_PNP               (1<<1)
443 #define ACPI_TCPA_ADDRESS_VALID         (1<<2)
444 
445 /* Values for InterruptFlags above */
446 
447 #define ACPI_TCPA_INTERRUPT_MODE        (1)
448 #define ACPI_TCPA_INTERRUPT_POLARITY    (1<<1)
449 #define ACPI_TCPA_SCI_VIA_GPE           (1<<2)
450 #define ACPI_TCPA_GLOBAL_INTERRUPT      (1<<3)
451 
452 
453 /*******************************************************************************
454  *
455  * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
456  *        Version 4
457  *
458  * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
459  *
460  * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
461  * Version 1.2, Revision 8
462  * February 27, 2017
463  *
464  ******************************************************************************/
465 
466 /* Revision 3 */
467 
468 typedef struct acpi_table_tpm23
469 {
470     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
471     UINT32                  Reserved;
472     UINT64                  ControlAddress;
473     UINT32                  StartMethod;
474 
475 } ACPI_TABLE_TPM23;
476 
477 /* Value for StartMethod above */
478 
479 #define ACPI_TPM23_ACPI_START_METHOD                 2
480 
481 /*
482  * Optional trailer for revision 3. If start method is 2, there is a 4 byte
483  * reserved area of all zeros.
484  */
485 typedef struct acpi_tmp23_trailer
486 {
487     UINT32                  Reserved;
488 
489 } ACPI_TPM23_TRAILER;
490 
491 
492 /* Revision 4 */
493 
494 typedef struct acpi_table_tpm2
495 {
496     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
497     UINT16                  PlatformClass;
498     UINT16                  Reserved;
499     UINT64                  ControlAddress;
500     UINT32                  StartMethod;
501 
502     /* Platform-specific data follows */
503 
504 } ACPI_TABLE_TPM2;
505 
506 /* Values for StartMethod above */
507 
508 #define ACPI_TPM2_NOT_ALLOWED                       0
509 #define ACPI_TPM2_RESERVED1                         1
510 #define ACPI_TPM2_START_METHOD                      2
511 #define ACPI_TPM2_RESERVED3                         3
512 #define ACPI_TPM2_RESERVED4                         4
513 #define ACPI_TPM2_RESERVED5                         5
514 #define ACPI_TPM2_MEMORY_MAPPED                     6
515 #define ACPI_TPM2_COMMAND_BUFFER                    7
516 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD  8
517 #define ACPI_TPM2_RESERVED9                         9
518 #define ACPI_TPM2_RESERVED10                        10
519 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC       11  /* V1.2 Rev 8 */
520 #define ACPI_TPM2_RESERVED                          12
521 
522 
523 /* Optional trailer appears after any StartMethod subtables */
524 
525 typedef struct acpi_tpm2_trailer
526 {
527     UINT8                   MethodParameters[12];
528     UINT32                  MinimumLogLength;   /* Minimum length for the event log area */
529     UINT64                  LogAddress;         /* Address of the event log area */
530 
531 } ACPI_TPM2_TRAILER;
532 
533 
534 /*
535  * Subtables (StartMethod-specific)
536  */
537 
538 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
539 
540 typedef struct acpi_tpm2_arm_smc
541 {
542     UINT32                  GlobalInterrupt;
543     UINT8                   InterruptFlags;
544     UINT8                   OperationFlags;
545     UINT16                  Reserved;
546     UINT32                  FunctionId;
547 
548 } ACPI_TPM2_ARM_SMC;
549 
550 /* Values for InterruptFlags above */
551 
552 #define ACPI_TPM2_INTERRUPT_SUPPORT     (1)
553 
554 /* Values for OperationFlags above */
555 
556 #define ACPI_TPM2_IDLE_SUPPORT          (1)
557 
558 
559 /*******************************************************************************
560  *
561  * UEFI - UEFI Boot optimization Table
562  *        Version 1
563  *
564  * Conforms to "Unified Extensible Firmware Interface Specification",
565  * Version 2.3, May 8, 2009
566  *
567  ******************************************************************************/
568 
569 typedef struct acpi_table_uefi
570 {
571     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
572     UINT8                   Identifier[16];     /* UUID identifier */
573     UINT16                  DataOffset;         /* Offset of remaining data in table */
574 
575 } ACPI_TABLE_UEFI;
576 
577 
578 /*******************************************************************************
579  *
580  * VRTC - Virtual Real Time Clock Table
581  *        Version 1
582  *
583  * Conforms to "Simple Firmware Interface Specification",
584  * Draft 0.8.2, Oct 19, 2010
585  * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
586  *
587  ******************************************************************************/
588 
589 typedef struct acpi_table_vrtc
590 {
591     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
592 
593 } ACPI_TABLE_VRTC;
594 
595 /* VRTC entry */
596 
597 typedef struct acpi_vrtc_entry
598 {
599     ACPI_GENERIC_ADDRESS    PhysicalAddress;
600     UINT32                  Irq;
601 
602 } ACPI_VRTC_ENTRY;
603 
604 
605 /*******************************************************************************
606  *
607  * WAET - Windows ACPI Emulated devices Table
608  *        Version 1
609  *
610  * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
611  *
612  ******************************************************************************/
613 
614 typedef struct acpi_table_waet
615 {
616     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
617     UINT32                  Flags;
618 
619 } ACPI_TABLE_WAET;
620 
621 /* Masks for Flags field above */
622 
623 #define ACPI_WAET_RTC_NO_ACK        (1)         /* RTC requires no int acknowledge */
624 #define ACPI_WAET_TIMER_ONE_READ    (1<<1)      /* PM timer requires only one read */
625 
626 
627 /*******************************************************************************
628  *
629  * WDAT - Watchdog Action Table
630  *        Version 1
631  *
632  * Conforms to "Hardware Watchdog Timers Design Specification",
633  * Copyright 2006 Microsoft Corporation.
634  *
635  ******************************************************************************/
636 
637 typedef struct acpi_table_wdat
638 {
639     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
640     UINT32                  HeaderLength;       /* Watchdog Header Length */
641     UINT16                  PciSegment;         /* PCI Segment number */
642     UINT8                   PciBus;             /* PCI Bus number */
643     UINT8                   PciDevice;          /* PCI Device number */
644     UINT8                   PciFunction;        /* PCI Function number */
645     UINT8                   Reserved[3];
646     UINT32                  TimerPeriod;        /* Period of one timer count (msec) */
647     UINT32                  MaxCount;           /* Maximum counter value supported */
648     UINT32                  MinCount;           /* Minimum counter value */
649     UINT8                   Flags;
650     UINT8                   Reserved2[3];
651     UINT32                  Entries;            /* Number of watchdog entries that follow */
652 
653 } ACPI_TABLE_WDAT;
654 
655 /* Masks for Flags field above */
656 
657 #define ACPI_WDAT_ENABLED           (1)
658 #define ACPI_WDAT_STOPPED           0x80
659 
660 
661 /* WDAT Instruction Entries (actions) */
662 
663 typedef struct acpi_wdat_entry
664 {
665     UINT8                   Action;
666     UINT8                   Instruction;
667     UINT16                  Reserved;
668     ACPI_GENERIC_ADDRESS    RegisterRegion;
669     UINT32                  Value;              /* Value used with Read/Write register */
670     UINT32                  Mask;               /* Bitmask required for this register instruction */
671 
672 } ACPI_WDAT_ENTRY;
673 
674 /* Values for Action field above */
675 
676 enum AcpiWdatActions
677 {
678     ACPI_WDAT_RESET                 = 1,
679     ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
680     ACPI_WDAT_GET_COUNTDOWN         = 5,
681     ACPI_WDAT_SET_COUNTDOWN         = 6,
682     ACPI_WDAT_GET_RUNNING_STATE     = 8,
683     ACPI_WDAT_SET_RUNNING_STATE     = 9,
684     ACPI_WDAT_GET_STOPPED_STATE     = 10,
685     ACPI_WDAT_SET_STOPPED_STATE     = 11,
686     ACPI_WDAT_GET_REBOOT            = 16,
687     ACPI_WDAT_SET_REBOOT            = 17,
688     ACPI_WDAT_GET_SHUTDOWN          = 18,
689     ACPI_WDAT_SET_SHUTDOWN          = 19,
690     ACPI_WDAT_GET_STATUS            = 32,
691     ACPI_WDAT_SET_STATUS            = 33,
692     ACPI_WDAT_ACTION_RESERVED       = 34    /* 34 and greater are reserved */
693 };
694 
695 /* Values for Instruction field above */
696 
697 enum AcpiWdatInstructions
698 {
699     ACPI_WDAT_READ_VALUE            = 0,
700     ACPI_WDAT_READ_COUNTDOWN        = 1,
701     ACPI_WDAT_WRITE_VALUE           = 2,
702     ACPI_WDAT_WRITE_COUNTDOWN       = 3,
703     ACPI_WDAT_INSTRUCTION_RESERVED  = 4,    /* 4 and greater are reserved */
704     ACPI_WDAT_PRESERVE_REGISTER     = 0x80  /* Except for this value */
705 };
706 
707 
708 /*******************************************************************************
709  *
710  * WDDT - Watchdog Descriptor Table
711  *        Version 1
712  *
713  * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
714  * Version 001, September 2002
715  *
716  ******************************************************************************/
717 
718 typedef struct acpi_table_wddt
719 {
720     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
721     UINT16                  SpecVersion;
722     UINT16                  TableVersion;
723     UINT16                  PciVendorId;
724     ACPI_GENERIC_ADDRESS    Address;
725     UINT16                  MaxCount;           /* Maximum counter value supported */
726     UINT16                  MinCount;           /* Minimum counter value supported */
727     UINT16                  Period;
728     UINT16                  Status;
729     UINT16                  Capability;
730 
731 } ACPI_TABLE_WDDT;
732 
733 /* Flags for Status field above */
734 
735 #define ACPI_WDDT_AVAILABLE     (1)
736 #define ACPI_WDDT_ACTIVE        (1<<1)
737 #define ACPI_WDDT_TCO_OS_OWNED  (1<<2)
738 #define ACPI_WDDT_USER_RESET    (1<<11)
739 #define ACPI_WDDT_WDT_RESET     (1<<12)
740 #define ACPI_WDDT_POWER_FAIL    (1<<13)
741 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
742 
743 /* Flags for Capability field above */
744 
745 #define ACPI_WDDT_AUTO_RESET    (1)
746 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
747 
748 
749 /*******************************************************************************
750  *
751  * WDRT - Watchdog Resource Table
752  *        Version 1
753  *
754  * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
755  * Version 1.01, August 28, 2006
756  *
757  ******************************************************************************/
758 
759 typedef struct acpi_table_wdrt
760 {
761     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
762     ACPI_GENERIC_ADDRESS    ControlRegister;
763     ACPI_GENERIC_ADDRESS    CountRegister;
764     UINT16                  PciDeviceId;
765     UINT16                  PciVendorId;
766     UINT8                   PciBus;             /* PCI Bus number */
767     UINT8                   PciDevice;          /* PCI Device number */
768     UINT8                   PciFunction;        /* PCI Function number */
769     UINT8                   PciSegment;         /* PCI Segment number */
770     UINT16                  MaxCount;           /* Maximum counter value supported */
771     UINT8                   Units;
772 
773 } ACPI_TABLE_WDRT;
774 
775 
776 /*******************************************************************************
777  *
778  * WPBT - Windows Platform Environment Table (ACPI 6.0)
779  *        Version 1
780  *
781  * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
782  *
783  ******************************************************************************/
784 
785 typedef struct acpi_table_wpbt
786 {
787     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
788     UINT32                  HandoffSize;
789     UINT64                  HandoffAddress;
790     UINT8                   Layout;
791     UINT8                   Type;
792     UINT16                  ArgumentsLength;
793 
794 } ACPI_TABLE_WPBT;
795 
796 
797 /*******************************************************************************
798  *
799  * WSMT - Windows SMM Security Migrations Table
800  *        Version 1
801  *
802  * Conforms to "Windows SMM Security Migrations Table",
803  * Version 1.0, April 18, 2016
804  *
805  ******************************************************************************/
806 
807 typedef struct acpi_table_wsmt
808 {
809     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
810     UINT32                  ProtectionFlags;
811 
812 } ACPI_TABLE_WSMT;
813 
814 /* Flags for ProtectionFlags field above */
815 
816 #define ACPI_WSMT_FIXED_COMM_BUFFERS                (1)
817 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
818 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION        (4)
819 
820 
821 /*******************************************************************************
822  *
823  * XENV - Xen Environment Table (ACPI 6.0)
824  *        Version 1
825  *
826  * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
827  *
828  ******************************************************************************/
829 
830 typedef struct acpi_table_xenv
831 {
832     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
833     UINT64                  GrantTableAddress;
834     UINT64                  GrantTableSize;
835     UINT32                  EventInterrupt;
836     UINT8                   EventFlags;
837 
838 } ACPI_TABLE_XENV;
839 
840 
841 /* Reset to default packing */
842 
843 #pragma pack()
844 
845 #endif /* __ACTBL3_H__ */
846