1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: actbl3.h - ACPI Table Definitions
6 * Copyright (C) 2000 - 2021, Intel Corp.
8 *****************************************************************************/
13 /*******************************************************************************
15 * Additional ACPI Tables
17 * These tables are not consumed directly by the ACPICA subsystem, but are
18 * included here to support device drivers and the AML disassembler.
20 ******************************************************************************/
23 * Values for description table header signatures for tables defined in this
24 * file. Useful because they make it more difficult to inadvertently type in
25 * the wrong signature.
27 #define ACPI_SIG_SLIC "SLIC" /* Software Licensing Description Table */
28 #define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
29 #define ACPI_SIG_SPCR "SPCR" /* Serial Port Console Redirection table */
30 #define ACPI_SIG_SPMI "SPMI" /* Server Platform Management Interface table */
31 #define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
32 #define ACPI_SIG_STAO "STAO" /* Status Override table */
33 #define ACPI_SIG_TCPA "TCPA" /* Trusted Computing Platform Alliance table */
34 #define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
35 #define ACPI_SIG_UEFI "UEFI" /* Uefi Boot Optimization Table */
36 #define ACPI_SIG_VIOT "VIOT" /* Virtual I/O Translation Table */
37 #define ACPI_SIG_WAET "WAET" /* Windows ACPI Emulated devices Table */
38 #define ACPI_SIG_WDAT "WDAT" /* Watchdog Action Table */
39 #define ACPI_SIG_WDDT "WDDT" /* Watchdog Timer Description Table */
40 #define ACPI_SIG_WDRT "WDRT" /* Watchdog Resource Table */
41 #define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
42 #define ACPI_SIG_WSMT "WSMT" /* Windows SMM Security Mitigations Table */
43 #define ACPI_SIG_XENV "XENV" /* Xen Environment table */
44 #define ACPI_SIG_XXXX "XXXX" /* Intermediate AML header for ASL/ASL+ converter */
47 * All tables must be byte-packed to match the ACPI specification, since
48 * the tables are provided by the system BIOS.
53 * Note: C bitfields are not used for this reason:
55 * "Bitfields are great and easy to read, but unfortunately the C language
56 * does not specify the layout of bitfields in memory, which means they are
57 * essentially useless for dealing with packed data in on-disk formats or
58 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
59 * this decision was a design error in C. Ritchie could have picked an order
60 * and stuck with it." Norman Ramsey.
61 * See http://stackoverflow.com/a/1053662/41661
64 /*******************************************************************************
66 * SLIC - Software Licensing Description Table
68 * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
69 * November 29, 2011. Copyright 2011 Microsoft
71 ******************************************************************************/
73 /* Basic SLIC table is only the common ACPI header */
75 struct acpi_table_slic {
76 struct acpi_table_header header; /* Common ACPI table header */
79 /*******************************************************************************
81 * SLIT - System Locality Distance Information Table
84 ******************************************************************************/
86 struct acpi_table_slit {
87 struct acpi_table_header header; /* Common ACPI table header */
89 u8 entry[1]; /* Real size = localities^2 */
92 /*******************************************************************************
94 * SPCR - Serial Port Console Redirection table
97 * Conforms to "Serial Port Console Redirection Table",
98 * Version 1.03, August 10, 2015
100 ******************************************************************************/
102 struct acpi_table_spcr {
103 struct acpi_table_header header; /* Common ACPI table header */
104 u8 interface_type; /* 0=full 16550, 1=subset of 16550 */
106 struct acpi_generic_address serial_port;
126 /* Masks for pci_flags field above */
128 #define ACPI_SPCR_DO_NOT_DISABLE (1)
130 /* Values for Interface Type: See the definition of the DBG2 table */
132 /*******************************************************************************
134 * SPMI - Server Platform Management Interface table
137 * Conforms to "Intelligent Platform Management Interface Specification
138 * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
139 * June 12, 2009 markup.
141 ******************************************************************************/
143 struct acpi_table_spmi {
144 struct acpi_table_header header; /* Common ACPI table header */
146 u8 reserved; /* Must be 1 */
147 u16 spec_revision; /* Version of IPMI */
149 u8 gpe_number; /* GPE assigned */
153 struct acpi_generic_address ipmi_register;
161 /* Values for interface_type above */
163 enum acpi_spmi_interface_types {
164 ACPI_SPMI_NOT_USED = 0,
165 ACPI_SPMI_KEYBOARD = 1,
167 ACPI_SPMI_BLOCK_TRANSFER = 3,
169 ACPI_SPMI_RESERVED = 5 /* 5 and above are reserved */
172 /*******************************************************************************
174 * SRAT - System Resource Affinity Table
177 ******************************************************************************/
179 struct acpi_table_srat {
180 struct acpi_table_header header; /* Common ACPI table header */
181 u32 table_revision; /* Must be value '1' */
182 u64 reserved; /* Reserved, must be zero */
185 /* Values for subtable type in struct acpi_subtable_header */
187 enum acpi_srat_type {
188 ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
189 ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
190 ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY = 2,
191 ACPI_SRAT_TYPE_GICC_AFFINITY = 3,
192 ACPI_SRAT_TYPE_GIC_ITS_AFFINITY = 4, /* ACPI 6.2 */
193 ACPI_SRAT_TYPE_GENERIC_AFFINITY = 5, /* ACPI 6.3 */
194 ACPI_SRAT_TYPE_GENERIC_PORT_AFFINITY = 6, /* ACPI 6.4 */
195 ACPI_SRAT_TYPE_RESERVED = 7 /* 7 and greater are reserved */
199 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
202 /* 0: Processor Local APIC/SAPIC Affinity */
204 struct acpi_srat_cpu_affinity {
205 struct acpi_subtable_header header;
206 u8 proximity_domain_lo;
210 u8 proximity_domain_hi[3];
216 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
218 /* 1: Memory Affinity */
220 struct acpi_srat_mem_affinity {
221 struct acpi_subtable_header header;
222 u32 proximity_domain;
223 u16 reserved; /* Reserved, must be zero */
228 u64 reserved2; /* Reserved, must be zero */
233 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
234 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
235 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
237 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
239 struct acpi_srat_x2apic_cpu_affinity {
240 struct acpi_subtable_header header;
241 u16 reserved; /* Reserved, must be zero */
242 u32 proximity_domain;
249 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
251 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
253 /* 3: GICC Affinity (ACPI 5.1) */
255 struct acpi_srat_gicc_affinity {
256 struct acpi_subtable_header header;
257 u32 proximity_domain;
258 u32 acpi_processor_uid;
263 /* Flags for struct acpi_srat_gicc_affinity */
265 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
267 /* 4: GCC ITS Affinity (ACPI 6.2) */
269 struct acpi_srat_gic_its_affinity {
270 struct acpi_subtable_header header;
271 u32 proximity_domain;
277 * Common structure for SRAT subtable types:
278 * 5: ACPI_SRAT_TYPE_GENERIC_AFFINITY
279 * 6: ACPI_SRAT_TYPE_GENERIC_PORT_AFFINITY
282 struct acpi_srat_generic_affinity {
283 struct acpi_subtable_header header;
285 u8 device_handle_type;
286 u32 proximity_domain;
287 u8 device_handle[16];
292 /* Flags for struct acpi_srat_generic_affinity */
294 #define ACPI_SRAT_GENERIC_AFFINITY_ENABLED (1) /* 00: Use affinity structure */
295 #define ACPI_SRAT_ARCHITECTURAL_TRANSACTIONS (1<<1) /* ACPI 6.4 */
297 /*******************************************************************************
299 * STAO - Status Override Table (_STA override) - ACPI 6.0
302 * Conforms to "ACPI Specification for Status Override Table"
305 ******************************************************************************/
307 struct acpi_table_stao {
308 struct acpi_table_header header; /* Common ACPI table header */
312 /*******************************************************************************
314 * TCPA - Trusted Computing Platform Alliance table
317 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
319 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
320 * Version 1.2, Revision 8
323 * NOTE: There are two versions of the table with the same signature --
324 * the client version and the server version. The common platform_class
325 * field is used to differentiate the two types of tables.
327 ******************************************************************************/
329 struct acpi_table_tcpa_hdr {
330 struct acpi_table_header header; /* Common ACPI table header */
335 * Values for platform_class above.
336 * This is how the client and server subtables are differentiated
338 #define ACPI_TCPA_CLIENT_TABLE 0
339 #define ACPI_TCPA_SERVER_TABLE 1
341 struct acpi_table_tcpa_client {
342 u32 minimum_log_length; /* Minimum length for the event log area */
343 u64 log_address; /* Address of the event log area */
346 struct acpi_table_tcpa_server {
348 u64 minimum_log_length; /* Minimum length for the event log area */
349 u64 log_address; /* Address of the event log area */
355 u32 global_interrupt;
356 struct acpi_generic_address address;
358 struct acpi_generic_address config_address;
360 u8 bus; /* PCI Bus/Segment/Function numbers */
365 /* Values for device_flags above */
367 #define ACPI_TCPA_PCI_DEVICE (1)
368 #define ACPI_TCPA_BUS_PNP (1<<1)
369 #define ACPI_TCPA_ADDRESS_VALID (1<<2)
371 /* Values for interrupt_flags above */
373 #define ACPI_TCPA_INTERRUPT_MODE (1)
374 #define ACPI_TCPA_INTERRUPT_POLARITY (1<<1)
375 #define ACPI_TCPA_SCI_VIA_GPE (1<<2)
376 #define ACPI_TCPA_GLOBAL_INTERRUPT (1<<3)
378 /*******************************************************************************
380 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
383 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
385 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
386 * Version 1.2, Revision 8
389 ******************************************************************************/
393 struct acpi_table_tpm23 {
394 struct acpi_table_header header; /* Common ACPI table header */
400 /* Value for start_method above */
402 #define ACPI_TPM23_ACPI_START_METHOD 2
405 * Optional trailer for revision 3. If start method is 2, there is a 4 byte
406 * reserved area of all zeros.
408 struct acpi_tmp23_trailer {
414 struct acpi_table_tpm2 {
415 struct acpi_table_header header; /* Common ACPI table header */
421 /* Platform-specific data follows */
424 /* Optional trailer for revision 4 holding platform-specific data */
425 struct acpi_tpm2_phy {
426 u8 start_method_specific[12];
427 u32 log_area_minimum_length;
428 u64 log_area_start_address;
431 /* Values for start_method above */
433 #define ACPI_TPM2_NOT_ALLOWED 0
434 #define ACPI_TPM2_RESERVED1 1
435 #define ACPI_TPM2_START_METHOD 2
436 #define ACPI_TPM2_RESERVED3 3
437 #define ACPI_TPM2_RESERVED4 4
438 #define ACPI_TPM2_RESERVED5 5
439 #define ACPI_TPM2_MEMORY_MAPPED 6
440 #define ACPI_TPM2_COMMAND_BUFFER 7
441 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
442 #define ACPI_TPM2_RESERVED9 9
443 #define ACPI_TPM2_RESERVED10 10
444 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
445 #define ACPI_TPM2_RESERVED 12
447 /* Optional trailer appears after any start_method subtables */
449 struct acpi_tpm2_trailer {
450 u8 method_parameters[12];
451 u32 minimum_log_length; /* Minimum length for the event log area */
452 u64 log_address; /* Address of the event log area */
456 * Subtables (start_method-specific)
459 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
461 struct acpi_tpm2_arm_smc {
462 u32 global_interrupt;
469 /* Values for interrupt_flags above */
471 #define ACPI_TPM2_INTERRUPT_SUPPORT (1)
473 /* Values for operation_flags above */
475 #define ACPI_TPM2_IDLE_SUPPORT (1)
477 /*******************************************************************************
479 * UEFI - UEFI Boot optimization Table
482 * Conforms to "Unified Extensible Firmware Interface Specification",
483 * Version 2.3, May 8, 2009
485 ******************************************************************************/
487 struct acpi_table_uefi {
488 struct acpi_table_header header; /* Common ACPI table header */
489 u8 identifier[16]; /* UUID identifier */
490 u16 data_offset; /* Offset of remaining data in table */
493 /*******************************************************************************
495 * VIOT - Virtual I/O Translation Table
498 ******************************************************************************/
500 struct acpi_table_viot {
501 struct acpi_table_header header; /* Common ACPI table header */
507 /* VIOT subtable header */
509 struct acpi_viot_header {
515 /* Values for Type field above */
517 enum acpi_viot_node_type {
518 ACPI_VIOT_NODE_PCI_RANGE = 0x01,
519 ACPI_VIOT_NODE_MMIO = 0x02,
520 ACPI_VIOT_NODE_VIRTIO_IOMMU_PCI = 0x03,
521 ACPI_VIOT_NODE_VIRTIO_IOMMU_MMIO = 0x04,
522 ACPI_VIOT_RESERVED = 0x05
527 struct acpi_viot_pci_range {
528 struct acpi_viot_header header;
538 struct acpi_viot_mmio {
539 struct acpi_viot_header header;
546 struct acpi_viot_virtio_iommu_pci {
547 struct acpi_viot_header header;
553 struct acpi_viot_virtio_iommu_mmio {
554 struct acpi_viot_header header;
559 /*******************************************************************************
561 * WAET - Windows ACPI Emulated devices Table
564 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
566 ******************************************************************************/
568 struct acpi_table_waet {
569 struct acpi_table_header header; /* Common ACPI table header */
573 /* Masks for Flags field above */
575 #define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
576 #define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
578 /*******************************************************************************
580 * WDAT - Watchdog Action Table
583 * Conforms to "Hardware Watchdog Timers Design Specification",
584 * Copyright 2006 Microsoft Corporation.
586 ******************************************************************************/
588 struct acpi_table_wdat {
589 struct acpi_table_header header; /* Common ACPI table header */
590 u32 header_length; /* Watchdog Header Length */
591 u16 pci_segment; /* PCI Segment number */
592 u8 pci_bus; /* PCI Bus number */
593 u8 pci_device; /* PCI Device number */
594 u8 pci_function; /* PCI Function number */
596 u32 timer_period; /* Period of one timer count (msec) */
597 u32 max_count; /* Maximum counter value supported */
598 u32 min_count; /* Minimum counter value */
601 u32 entries; /* Number of watchdog entries that follow */
604 /* Masks for Flags field above */
606 #define ACPI_WDAT_ENABLED (1)
607 #define ACPI_WDAT_STOPPED 0x80
609 /* WDAT Instruction Entries (actions) */
611 struct acpi_wdat_entry {
615 struct acpi_generic_address register_region;
616 u32 value; /* Value used with Read/Write register */
617 u32 mask; /* Bitmask required for this register instruction */
620 /* Values for Action field above */
622 enum acpi_wdat_actions {
624 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
625 ACPI_WDAT_GET_COUNTDOWN = 5,
626 ACPI_WDAT_SET_COUNTDOWN = 6,
627 ACPI_WDAT_GET_RUNNING_STATE = 8,
628 ACPI_WDAT_SET_RUNNING_STATE = 9,
629 ACPI_WDAT_GET_STOPPED_STATE = 10,
630 ACPI_WDAT_SET_STOPPED_STATE = 11,
631 ACPI_WDAT_GET_REBOOT = 16,
632 ACPI_WDAT_SET_REBOOT = 17,
633 ACPI_WDAT_GET_SHUTDOWN = 18,
634 ACPI_WDAT_SET_SHUTDOWN = 19,
635 ACPI_WDAT_GET_STATUS = 32,
636 ACPI_WDAT_SET_STATUS = 33,
637 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
640 /* Values for Instruction field above */
642 enum acpi_wdat_instructions {
643 ACPI_WDAT_READ_VALUE = 0,
644 ACPI_WDAT_READ_COUNTDOWN = 1,
645 ACPI_WDAT_WRITE_VALUE = 2,
646 ACPI_WDAT_WRITE_COUNTDOWN = 3,
647 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
648 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
651 /*******************************************************************************
653 * WDDT - Watchdog Descriptor Table
656 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
657 * Version 001, September 2002
659 ******************************************************************************/
661 struct acpi_table_wddt {
662 struct acpi_table_header header; /* Common ACPI table header */
666 struct acpi_generic_address address;
667 u16 max_count; /* Maximum counter value supported */
668 u16 min_count; /* Minimum counter value supported */
674 /* Flags for Status field above */
676 #define ACPI_WDDT_AVAILABLE (1)
677 #define ACPI_WDDT_ACTIVE (1<<1)
678 #define ACPI_WDDT_TCO_OS_OWNED (1<<2)
679 #define ACPI_WDDT_USER_RESET (1<<11)
680 #define ACPI_WDDT_WDT_RESET (1<<12)
681 #define ACPI_WDDT_POWER_FAIL (1<<13)
682 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
684 /* Flags for Capability field above */
686 #define ACPI_WDDT_AUTO_RESET (1)
687 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
689 /*******************************************************************************
691 * WDRT - Watchdog Resource Table
694 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
695 * Version 1.01, August 28, 2006
697 ******************************************************************************/
699 struct acpi_table_wdrt {
700 struct acpi_table_header header; /* Common ACPI table header */
701 struct acpi_generic_address control_register;
702 struct acpi_generic_address count_register;
705 u8 pci_bus; /* PCI Bus number */
706 u8 pci_device; /* PCI Device number */
707 u8 pci_function; /* PCI Function number */
708 u8 pci_segment; /* PCI Segment number */
709 u16 max_count; /* Maximum counter value supported */
713 /*******************************************************************************
715 * WPBT - Windows Platform Environment Table (ACPI 6.0)
718 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
720 ******************************************************************************/
722 struct acpi_table_wpbt {
723 struct acpi_table_header header; /* Common ACPI table header */
728 u16 arguments_length;
731 struct acpi_wpbt_unicode {
735 /*******************************************************************************
737 * WSMT - Windows SMM Security Mitigations Table
740 * Conforms to "Windows SMM Security Mitigations Table",
741 * Version 1.0, April 18, 2016
743 ******************************************************************************/
745 struct acpi_table_wsmt {
746 struct acpi_table_header header; /* Common ACPI table header */
747 u32 protection_flags;
750 /* Flags for protection_flags field above */
752 #define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
753 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
754 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
756 /*******************************************************************************
758 * XENV - Xen Environment Table (ACPI 6.0)
761 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
763 ******************************************************************************/
765 struct acpi_table_xenv {
766 struct acpi_table_header header; /* Common ACPI table header */
767 u64 grant_table_address;
768 u64 grant_table_size;
773 /* Reset to default packing */
777 #endif /* __ACTBL3_H__ */