1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: actbl3.h - ACPI Table Definitions
6 * Copyright (C) 2000 - 2018, 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_VRTC "VRTC" /* Virtual Real Time Clock 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 Migrations 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_RESERVED = 5 /* 5 and greater are reserved */
197 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
200 /* 0: Processor Local APIC/SAPIC Affinity */
202 struct acpi_srat_cpu_affinity {
203 struct acpi_subtable_header header;
204 u8 proximity_domain_lo;
208 u8 proximity_domain_hi[3];
214 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
216 /* 1: Memory Affinity */
218 struct acpi_srat_mem_affinity {
219 struct acpi_subtable_header header;
220 u32 proximity_domain;
221 u16 reserved; /* Reserved, must be zero */
226 u64 reserved2; /* Reserved, must be zero */
231 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
232 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
233 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
235 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
237 struct acpi_srat_x2apic_cpu_affinity {
238 struct acpi_subtable_header header;
239 u16 reserved; /* Reserved, must be zero */
240 u32 proximity_domain;
247 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
249 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
251 /* 3: GICC Affinity (ACPI 5.1) */
253 struct acpi_srat_gicc_affinity {
254 struct acpi_subtable_header header;
255 u32 proximity_domain;
256 u32 acpi_processor_uid;
261 /* Flags for struct acpi_srat_gicc_affinity */
263 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
265 /* 4: GCC ITS Affinity (ACPI 6.2) */
267 struct acpi_srat_gic_its_affinity {
268 struct acpi_subtable_header header;
269 u32 proximity_domain;
274 /*******************************************************************************
276 * STAO - Status Override Table (_STA override) - ACPI 6.0
279 * Conforms to "ACPI Specification for Status Override Table"
282 ******************************************************************************/
284 struct acpi_table_stao {
285 struct acpi_table_header header; /* Common ACPI table header */
289 /*******************************************************************************
291 * TCPA - Trusted Computing Platform Alliance table
294 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
296 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
297 * Version 1.2, Revision 8
300 * NOTE: There are two versions of the table with the same signature --
301 * the client version and the server version. The common platform_class
302 * field is used to differentiate the two types of tables.
304 ******************************************************************************/
306 struct acpi_table_tcpa_hdr {
307 struct acpi_table_header header; /* Common ACPI table header */
312 * Values for platform_class above.
313 * This is how the client and server subtables are differentiated
315 #define ACPI_TCPA_CLIENT_TABLE 0
316 #define ACPI_TCPA_SERVER_TABLE 1
318 struct acpi_table_tcpa_client {
319 u32 minimum_log_length; /* Minimum length for the event log area */
320 u64 log_address; /* Address of the event log area */
323 struct acpi_table_tcpa_server {
325 u64 minimum_log_length; /* Minimum length for the event log area */
326 u64 log_address; /* Address of the event log area */
332 u32 global_interrupt;
333 struct acpi_generic_address address;
335 struct acpi_generic_address config_address;
337 u8 bus; /* PCI Bus/Segment/Function numbers */
342 /* Values for device_flags above */
344 #define ACPI_TCPA_PCI_DEVICE (1)
345 #define ACPI_TCPA_BUS_PNP (1<<1)
346 #define ACPI_TCPA_ADDRESS_VALID (1<<2)
348 /* Values for interrupt_flags above */
350 #define ACPI_TCPA_INTERRUPT_MODE (1)
351 #define ACPI_TCPA_INTERRUPT_POLARITY (1<<1)
352 #define ACPI_TCPA_SCI_VIA_GPE (1<<2)
353 #define ACPI_TCPA_GLOBAL_INTERRUPT (1<<3)
355 /*******************************************************************************
357 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
360 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
362 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
363 * Version 1.2, Revision 8
366 ******************************************************************************/
370 struct acpi_table_tpm23 {
371 struct acpi_table_header header; /* Common ACPI table header */
377 /* Value for start_method above */
379 #define ACPI_TPM23_ACPI_START_METHOD 2
382 * Optional trailer for revision 3. If start method is 2, there is a 4 byte
383 * reserved area of all zeros.
385 struct acpi_tmp23_trailer {
391 struct acpi_table_tpm2 {
392 struct acpi_table_header header; /* Common ACPI table header */
398 /* Platform-specific data follows */
401 /* Values for start_method above */
403 #define ACPI_TPM2_NOT_ALLOWED 0
404 #define ACPI_TPM2_RESERVED1 1
405 #define ACPI_TPM2_START_METHOD 2
406 #define ACPI_TPM2_RESERVED3 3
407 #define ACPI_TPM2_RESERVED4 4
408 #define ACPI_TPM2_RESERVED5 5
409 #define ACPI_TPM2_MEMORY_MAPPED 6
410 #define ACPI_TPM2_COMMAND_BUFFER 7
411 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
412 #define ACPI_TPM2_RESERVED9 9
413 #define ACPI_TPM2_RESERVED10 10
414 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
415 #define ACPI_TPM2_RESERVED 12
417 /* Optional trailer appears after any start_method subtables */
419 struct acpi_tpm2_trailer {
420 u8 method_parameters[12];
421 u32 minimum_log_length; /* Minimum length for the event log area */
422 u64 log_address; /* Address of the event log area */
426 * Subtables (start_method-specific)
429 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
431 struct acpi_tpm2_arm_smc {
432 u32 global_interrupt;
439 /* Values for interrupt_flags above */
441 #define ACPI_TPM2_INTERRUPT_SUPPORT (1)
443 /* Values for operation_flags above */
445 #define ACPI_TPM2_IDLE_SUPPORT (1)
447 /*******************************************************************************
449 * UEFI - UEFI Boot optimization Table
452 * Conforms to "Unified Extensible Firmware Interface Specification",
453 * Version 2.3, May 8, 2009
455 ******************************************************************************/
457 struct acpi_table_uefi {
458 struct acpi_table_header header; /* Common ACPI table header */
459 u8 identifier[16]; /* UUID identifier */
460 u16 data_offset; /* Offset of remaining data in table */
463 /*******************************************************************************
465 * VRTC - Virtual Real Time Clock Table
468 * Conforms to "Simple Firmware Interface Specification",
469 * Draft 0.8.2, Oct 19, 2010
470 * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
472 ******************************************************************************/
474 struct acpi_table_vrtc {
475 struct acpi_table_header header; /* Common ACPI table header */
480 struct acpi_vrtc_entry {
481 struct acpi_generic_address physical_address;
485 /*******************************************************************************
487 * WAET - Windows ACPI Emulated devices Table
490 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
492 ******************************************************************************/
494 struct acpi_table_waet {
495 struct acpi_table_header header; /* Common ACPI table header */
499 /* Masks for Flags field above */
501 #define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
502 #define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
504 /*******************************************************************************
506 * WDAT - Watchdog Action Table
509 * Conforms to "Hardware Watchdog Timers Design Specification",
510 * Copyright 2006 Microsoft Corporation.
512 ******************************************************************************/
514 struct acpi_table_wdat {
515 struct acpi_table_header header; /* Common ACPI table header */
516 u32 header_length; /* Watchdog Header Length */
517 u16 pci_segment; /* PCI Segment number */
518 u8 pci_bus; /* PCI Bus number */
519 u8 pci_device; /* PCI Device number */
520 u8 pci_function; /* PCI Function number */
522 u32 timer_period; /* Period of one timer count (msec) */
523 u32 max_count; /* Maximum counter value supported */
524 u32 min_count; /* Minimum counter value */
527 u32 entries; /* Number of watchdog entries that follow */
530 /* Masks for Flags field above */
532 #define ACPI_WDAT_ENABLED (1)
533 #define ACPI_WDAT_STOPPED 0x80
535 /* WDAT Instruction Entries (actions) */
537 struct acpi_wdat_entry {
541 struct acpi_generic_address register_region;
542 u32 value; /* Value used with Read/Write register */
543 u32 mask; /* Bitmask required for this register instruction */
546 /* Values for Action field above */
548 enum acpi_wdat_actions {
550 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
551 ACPI_WDAT_GET_COUNTDOWN = 5,
552 ACPI_WDAT_SET_COUNTDOWN = 6,
553 ACPI_WDAT_GET_RUNNING_STATE = 8,
554 ACPI_WDAT_SET_RUNNING_STATE = 9,
555 ACPI_WDAT_GET_STOPPED_STATE = 10,
556 ACPI_WDAT_SET_STOPPED_STATE = 11,
557 ACPI_WDAT_GET_REBOOT = 16,
558 ACPI_WDAT_SET_REBOOT = 17,
559 ACPI_WDAT_GET_SHUTDOWN = 18,
560 ACPI_WDAT_SET_SHUTDOWN = 19,
561 ACPI_WDAT_GET_STATUS = 32,
562 ACPI_WDAT_SET_STATUS = 33,
563 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
566 /* Values for Instruction field above */
568 enum acpi_wdat_instructions {
569 ACPI_WDAT_READ_VALUE = 0,
570 ACPI_WDAT_READ_COUNTDOWN = 1,
571 ACPI_WDAT_WRITE_VALUE = 2,
572 ACPI_WDAT_WRITE_COUNTDOWN = 3,
573 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
574 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
577 /*******************************************************************************
579 * WDDT - Watchdog Descriptor Table
582 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
583 * Version 001, September 2002
585 ******************************************************************************/
587 struct acpi_table_wddt {
588 struct acpi_table_header header; /* Common ACPI table header */
592 struct acpi_generic_address address;
593 u16 max_count; /* Maximum counter value supported */
594 u16 min_count; /* Minimum counter value supported */
600 /* Flags for Status field above */
602 #define ACPI_WDDT_AVAILABLE (1)
603 #define ACPI_WDDT_ACTIVE (1<<1)
604 #define ACPI_WDDT_TCO_OS_OWNED (1<<2)
605 #define ACPI_WDDT_USER_RESET (1<<11)
606 #define ACPI_WDDT_WDT_RESET (1<<12)
607 #define ACPI_WDDT_POWER_FAIL (1<<13)
608 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
610 /* Flags for Capability field above */
612 #define ACPI_WDDT_AUTO_RESET (1)
613 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
615 /*******************************************************************************
617 * WDRT - Watchdog Resource Table
620 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
621 * Version 1.01, August 28, 2006
623 ******************************************************************************/
625 struct acpi_table_wdrt {
626 struct acpi_table_header header; /* Common ACPI table header */
627 struct acpi_generic_address control_register;
628 struct acpi_generic_address count_register;
631 u8 pci_bus; /* PCI Bus number */
632 u8 pci_device; /* PCI Device number */
633 u8 pci_function; /* PCI Function number */
634 u8 pci_segment; /* PCI Segment number */
635 u16 max_count; /* Maximum counter value supported */
639 /*******************************************************************************
641 * WPBT - Windows Platform Environment Table (ACPI 6.0)
644 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
646 ******************************************************************************/
648 struct acpi_table_wpbt {
649 struct acpi_table_header header; /* Common ACPI table header */
654 u16 arguments_length;
657 /*******************************************************************************
659 * WSMT - Windows SMM Security Migrations Table
662 * Conforms to "Windows SMM Security Migrations Table",
663 * Version 1.0, April 18, 2016
665 ******************************************************************************/
667 struct acpi_table_wsmt {
668 struct acpi_table_header header; /* Common ACPI table header */
669 u32 protection_flags;
672 /* Flags for protection_flags field above */
674 #define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
675 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
676 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
678 /*******************************************************************************
680 * XENV - Xen Environment Table (ACPI 6.0)
683 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
685 ******************************************************************************/
687 struct acpi_table_xenv {
688 struct acpi_table_header header; /* Common ACPI table header */
689 u64 grant_table_address;
690 u64 grant_table_size;
695 /* Reset to default packing */
699 #endif /* __ACTBL3_H__ */