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_RESERVED = 6 /* 5 and greater are reserved */
198 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
201 /* 0: Processor Local APIC/SAPIC Affinity */
203 struct acpi_srat_cpu_affinity {
204 struct acpi_subtable_header header;
205 u8 proximity_domain_lo;
209 u8 proximity_domain_hi[3];
215 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
217 /* 1: Memory Affinity */
219 struct acpi_srat_mem_affinity {
220 struct acpi_subtable_header header;
221 u32 proximity_domain;
222 u16 reserved; /* Reserved, must be zero */
227 u64 reserved2; /* Reserved, must be zero */
232 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
233 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
234 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
236 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
238 struct acpi_srat_x2apic_cpu_affinity {
239 struct acpi_subtable_header header;
240 u16 reserved; /* Reserved, must be zero */
241 u32 proximity_domain;
248 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
250 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
252 /* 3: GICC Affinity (ACPI 5.1) */
254 struct acpi_srat_gicc_affinity {
255 struct acpi_subtable_header header;
256 u32 proximity_domain;
257 u32 acpi_processor_uid;
262 /* Flags for struct acpi_srat_gicc_affinity */
264 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
266 /* 4: GCC ITS Affinity (ACPI 6.2) */
268 struct acpi_srat_gic_its_affinity {
269 struct acpi_subtable_header header;
270 u32 proximity_domain;
275 /* 5: Generic Initiator Affinity Structure (ACPI 6.3) */
277 struct acpi_srat_generic_affinity {
278 struct acpi_subtable_header header;
280 u8 device_handle_type;
281 u32 proximity_domain;
282 u8 device_handle[16];
287 /* Flags for struct acpi_srat_generic_affinity */
289 #define ACPI_SRAT_GENERIC_AFFINITY_ENABLED (1) /* 00: Use affinity structure */
290 #define ACPI_SRAT_ARCHITECTURAL_TRANSACTIONS (1<<1) /* ACPI 6.4 */
292 /*******************************************************************************
294 * STAO - Status Override Table (_STA override) - ACPI 6.0
297 * Conforms to "ACPI Specification for Status Override Table"
300 ******************************************************************************/
302 struct acpi_table_stao {
303 struct acpi_table_header header; /* Common ACPI table header */
307 /*******************************************************************************
309 * TCPA - Trusted Computing Platform Alliance table
312 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
314 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
315 * Version 1.2, Revision 8
318 * NOTE: There are two versions of the table with the same signature --
319 * the client version and the server version. The common platform_class
320 * field is used to differentiate the two types of tables.
322 ******************************************************************************/
324 struct acpi_table_tcpa_hdr {
325 struct acpi_table_header header; /* Common ACPI table header */
330 * Values for platform_class above.
331 * This is how the client and server subtables are differentiated
333 #define ACPI_TCPA_CLIENT_TABLE 0
334 #define ACPI_TCPA_SERVER_TABLE 1
336 struct acpi_table_tcpa_client {
337 u32 minimum_log_length; /* Minimum length for the event log area */
338 u64 log_address; /* Address of the event log area */
341 struct acpi_table_tcpa_server {
343 u64 minimum_log_length; /* Minimum length for the event log area */
344 u64 log_address; /* Address of the event log area */
350 u32 global_interrupt;
351 struct acpi_generic_address address;
353 struct acpi_generic_address config_address;
355 u8 bus; /* PCI Bus/Segment/Function numbers */
360 /* Values for device_flags above */
362 #define ACPI_TCPA_PCI_DEVICE (1)
363 #define ACPI_TCPA_BUS_PNP (1<<1)
364 #define ACPI_TCPA_ADDRESS_VALID (1<<2)
366 /* Values for interrupt_flags above */
368 #define ACPI_TCPA_INTERRUPT_MODE (1)
369 #define ACPI_TCPA_INTERRUPT_POLARITY (1<<1)
370 #define ACPI_TCPA_SCI_VIA_GPE (1<<2)
371 #define ACPI_TCPA_GLOBAL_INTERRUPT (1<<3)
373 /*******************************************************************************
375 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
378 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
380 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
381 * Version 1.2, Revision 8
384 ******************************************************************************/
388 struct acpi_table_tpm23 {
389 struct acpi_table_header header; /* Common ACPI table header */
395 /* Value for start_method above */
397 #define ACPI_TPM23_ACPI_START_METHOD 2
400 * Optional trailer for revision 3. If start method is 2, there is a 4 byte
401 * reserved area of all zeros.
403 struct acpi_tmp23_trailer {
409 struct acpi_table_tpm2 {
410 struct acpi_table_header header; /* Common ACPI table header */
416 /* Platform-specific data follows */
419 /* Optional trailer for revision 4 holding platform-specific data */
420 struct acpi_tpm2_phy {
421 u8 start_method_specific[12];
422 u32 log_area_minimum_length;
423 u64 log_area_start_address;
426 /* Values for start_method above */
428 #define ACPI_TPM2_NOT_ALLOWED 0
429 #define ACPI_TPM2_RESERVED1 1
430 #define ACPI_TPM2_START_METHOD 2
431 #define ACPI_TPM2_RESERVED3 3
432 #define ACPI_TPM2_RESERVED4 4
433 #define ACPI_TPM2_RESERVED5 5
434 #define ACPI_TPM2_MEMORY_MAPPED 6
435 #define ACPI_TPM2_COMMAND_BUFFER 7
436 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
437 #define ACPI_TPM2_RESERVED9 9
438 #define ACPI_TPM2_RESERVED10 10
439 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
440 #define ACPI_TPM2_RESERVED 12
442 /* Optional trailer appears after any start_method subtables */
444 struct acpi_tpm2_trailer {
445 u8 method_parameters[12];
446 u32 minimum_log_length; /* Minimum length for the event log area */
447 u64 log_address; /* Address of the event log area */
451 * Subtables (start_method-specific)
454 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
456 struct acpi_tpm2_arm_smc {
457 u32 global_interrupt;
464 /* Values for interrupt_flags above */
466 #define ACPI_TPM2_INTERRUPT_SUPPORT (1)
468 /* Values for operation_flags above */
470 #define ACPI_TPM2_IDLE_SUPPORT (1)
472 /*******************************************************************************
474 * UEFI - UEFI Boot optimization Table
477 * Conforms to "Unified Extensible Firmware Interface Specification",
478 * Version 2.3, May 8, 2009
480 ******************************************************************************/
482 struct acpi_table_uefi {
483 struct acpi_table_header header; /* Common ACPI table header */
484 u8 identifier[16]; /* UUID identifier */
485 u16 data_offset; /* Offset of remaining data in table */
488 /*******************************************************************************
490 * VIOT - Virtual I/O Translation Table
493 ******************************************************************************/
495 struct acpi_table_viot {
496 struct acpi_table_header header; /* Common ACPI table header */
502 /* VIOT subtable header */
504 struct acpi_viot_header {
510 /* Values for Type field above */
512 enum acpi_viot_node_type {
513 ACPI_VIOT_NODE_PCI_RANGE = 0x01,
514 ACPI_VIOT_NODE_MMIO = 0x02,
515 ACPI_VIOT_NODE_VIRTIO_IOMMU_PCI = 0x03,
516 ACPI_VIOT_NODE_VIRTIO_IOMMU_MMIO = 0x04,
517 ACPI_VIOT_RESERVED = 0x05
522 struct acpi_viot_pci_range {
523 struct acpi_viot_header header;
533 struct acpi_viot_mmio {
534 struct acpi_viot_header header;
541 struct acpi_viot_virtio_iommu_pci {
542 struct acpi_viot_header header;
548 struct acpi_viot_virtio_iommu_mmio {
549 struct acpi_viot_header header;
554 /*******************************************************************************
556 * WAET - Windows ACPI Emulated devices Table
559 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
561 ******************************************************************************/
563 struct acpi_table_waet {
564 struct acpi_table_header header; /* Common ACPI table header */
568 /* Masks for Flags field above */
570 #define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
571 #define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
573 /*******************************************************************************
575 * WDAT - Watchdog Action Table
578 * Conforms to "Hardware Watchdog Timers Design Specification",
579 * Copyright 2006 Microsoft Corporation.
581 ******************************************************************************/
583 struct acpi_table_wdat {
584 struct acpi_table_header header; /* Common ACPI table header */
585 u32 header_length; /* Watchdog Header Length */
586 u16 pci_segment; /* PCI Segment number */
587 u8 pci_bus; /* PCI Bus number */
588 u8 pci_device; /* PCI Device number */
589 u8 pci_function; /* PCI Function number */
591 u32 timer_period; /* Period of one timer count (msec) */
592 u32 max_count; /* Maximum counter value supported */
593 u32 min_count; /* Minimum counter value */
596 u32 entries; /* Number of watchdog entries that follow */
599 /* Masks for Flags field above */
601 #define ACPI_WDAT_ENABLED (1)
602 #define ACPI_WDAT_STOPPED 0x80
604 /* WDAT Instruction Entries (actions) */
606 struct acpi_wdat_entry {
610 struct acpi_generic_address register_region;
611 u32 value; /* Value used with Read/Write register */
612 u32 mask; /* Bitmask required for this register instruction */
615 /* Values for Action field above */
617 enum acpi_wdat_actions {
619 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
620 ACPI_WDAT_GET_COUNTDOWN = 5,
621 ACPI_WDAT_SET_COUNTDOWN = 6,
622 ACPI_WDAT_GET_RUNNING_STATE = 8,
623 ACPI_WDAT_SET_RUNNING_STATE = 9,
624 ACPI_WDAT_GET_STOPPED_STATE = 10,
625 ACPI_WDAT_SET_STOPPED_STATE = 11,
626 ACPI_WDAT_GET_REBOOT = 16,
627 ACPI_WDAT_SET_REBOOT = 17,
628 ACPI_WDAT_GET_SHUTDOWN = 18,
629 ACPI_WDAT_SET_SHUTDOWN = 19,
630 ACPI_WDAT_GET_STATUS = 32,
631 ACPI_WDAT_SET_STATUS = 33,
632 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
635 /* Values for Instruction field above */
637 enum acpi_wdat_instructions {
638 ACPI_WDAT_READ_VALUE = 0,
639 ACPI_WDAT_READ_COUNTDOWN = 1,
640 ACPI_WDAT_WRITE_VALUE = 2,
641 ACPI_WDAT_WRITE_COUNTDOWN = 3,
642 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
643 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
646 /*******************************************************************************
648 * WDDT - Watchdog Descriptor Table
651 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
652 * Version 001, September 2002
654 ******************************************************************************/
656 struct acpi_table_wddt {
657 struct acpi_table_header header; /* Common ACPI table header */
661 struct acpi_generic_address address;
662 u16 max_count; /* Maximum counter value supported */
663 u16 min_count; /* Minimum counter value supported */
669 /* Flags for Status field above */
671 #define ACPI_WDDT_AVAILABLE (1)
672 #define ACPI_WDDT_ACTIVE (1<<1)
673 #define ACPI_WDDT_TCO_OS_OWNED (1<<2)
674 #define ACPI_WDDT_USER_RESET (1<<11)
675 #define ACPI_WDDT_WDT_RESET (1<<12)
676 #define ACPI_WDDT_POWER_FAIL (1<<13)
677 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
679 /* Flags for Capability field above */
681 #define ACPI_WDDT_AUTO_RESET (1)
682 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
684 /*******************************************************************************
686 * WDRT - Watchdog Resource Table
689 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
690 * Version 1.01, August 28, 2006
692 ******************************************************************************/
694 struct acpi_table_wdrt {
695 struct acpi_table_header header; /* Common ACPI table header */
696 struct acpi_generic_address control_register;
697 struct acpi_generic_address count_register;
700 u8 pci_bus; /* PCI Bus number */
701 u8 pci_device; /* PCI Device number */
702 u8 pci_function; /* PCI Function number */
703 u8 pci_segment; /* PCI Segment number */
704 u16 max_count; /* Maximum counter value supported */
708 /*******************************************************************************
710 * WPBT - Windows Platform Environment Table (ACPI 6.0)
713 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
715 ******************************************************************************/
717 struct acpi_table_wpbt {
718 struct acpi_table_header header; /* Common ACPI table header */
723 u16 arguments_length;
726 struct acpi_wpbt_unicode {
730 /*******************************************************************************
732 * WSMT - Windows SMM Security Mitigations Table
735 * Conforms to "Windows SMM Security Mitigations Table",
736 * Version 1.0, April 18, 2016
738 ******************************************************************************/
740 struct acpi_table_wsmt {
741 struct acpi_table_header header; /* Common ACPI table header */
742 u32 protection_flags;
745 /* Flags for protection_flags field above */
747 #define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
748 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
749 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
751 /*******************************************************************************
753 * XENV - Xen Environment Table (ACPI 6.0)
756 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
758 ******************************************************************************/
760 struct acpi_table_xenv {
761 struct acpi_table_header header; /* Common ACPI table header */
762 u64 grant_table_address;
763 u64 grant_table_size;
768 /* Reset to default packing */
772 #endif /* __ACTBL3_H__ */