Linux 5.6.13
[linux/fpc-iii.git] / include / acpi / actbl3.h
blob2bf3baf819bbed9afc9ac7fdebb91a63afa1bc7e
1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: actbl3.h - ACPI Table Definitions
6 * Copyright (C) 2000 - 2020, Intel Corp.
8 *****************************************************************************/
10 #ifndef __ACTBL3_H__
11 #define __ACTBL3_H__
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.
50 #pragma pack(1)
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
82 * Version 1
84 ******************************************************************************/
86 struct acpi_table_slit {
87 struct acpi_table_header header; /* Common ACPI table header */
88 u64 locality_count;
89 u8 entry[1]; /* Real size = localities^2 */
92 /*******************************************************************************
94 * SPCR - Serial Port Console Redirection table
95 * Version 2
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 */
105 u8 reserved[3];
106 struct acpi_generic_address serial_port;
107 u8 interrupt_type;
108 u8 pc_interrupt;
109 u32 interrupt;
110 u8 baud_rate;
111 u8 parity;
112 u8 stop_bits;
113 u8 flow_control;
114 u8 terminal_type;
115 u8 reserved1;
116 u16 pci_device_id;
117 u16 pci_vendor_id;
118 u8 pci_bus;
119 u8 pci_device;
120 u8 pci_function;
121 u32 pci_flags;
122 u8 pci_segment;
123 u32 reserved2;
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
135 * Version 5
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 */
145 u8 interface_type;
146 u8 reserved; /* Must be 1 */
147 u16 spec_revision; /* Version of IPMI */
148 u8 interrupt_type;
149 u8 gpe_number; /* GPE assigned */
150 u8 reserved1;
151 u8 pci_device_flag;
152 u32 interrupt;
153 struct acpi_generic_address ipmi_register;
154 u8 pci_segment;
155 u8 pci_bus;
156 u8 pci_device;
157 u8 pci_function;
158 u8 reserved2;
161 /* Values for interface_type above */
163 enum acpi_spmi_interface_types {
164 ACPI_SPMI_NOT_USED = 0,
165 ACPI_SPMI_KEYBOARD = 1,
166 ACPI_SPMI_SMI = 2,
167 ACPI_SPMI_BLOCK_TRANSFER = 3,
168 ACPI_SPMI_SMBUS = 4,
169 ACPI_SPMI_RESERVED = 5 /* 5 and above are reserved */
172 /*******************************************************************************
174 * SRAT - System Resource Affinity Table
175 * Version 3
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;
206 u8 apic_id;
207 u32 flags;
208 u8 local_sapic_eid;
209 u8 proximity_domain_hi[3];
210 u32 clock_domain;
213 /* Flags */
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 */
223 u64 base_address;
224 u64 length;
225 u32 reserved1;
226 u32 flags;
227 u64 reserved2; /* Reserved, must be zero */
230 /* Flags */
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;
242 u32 apic_id;
243 u32 flags;
244 u32 clock_domain;
245 u32 reserved2;
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;
258 u32 flags;
259 u32 clock_domain;
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;
271 u16 reserved;
272 u32 its_id;
275 /* 5: Generic Initiator Affinity Structure (ACPI 6.3) */
277 struct acpi_srat_generic_affinity {
278 struct acpi_subtable_header header;
279 u8 reserved;
280 u8 device_handle_type;
281 u32 proximity_domain;
282 u8 device_handle[16];
283 u32 flags;
284 u32 reserved1;
287 /* Flags for struct acpi_srat_generic_affinity */
289 #define ACPI_SRAT_GENERIC_AFFINITY_ENABLED (1) /* 00: Use affinity structure */
291 /*******************************************************************************
293 * STAO - Status Override Table (_STA override) - ACPI 6.0
294 * Version 1
296 * Conforms to "ACPI Specification for Status Override Table"
297 * 6 January 2015
299 ******************************************************************************/
301 struct acpi_table_stao {
302 struct acpi_table_header header; /* Common ACPI table header */
303 u8 ignore_uart;
306 /*******************************************************************************
308 * TCPA - Trusted Computing Platform Alliance table
309 * Version 2
311 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
313 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
314 * Version 1.2, Revision 8
315 * February 27, 2017
317 * NOTE: There are two versions of the table with the same signature --
318 * the client version and the server version. The common platform_class
319 * field is used to differentiate the two types of tables.
321 ******************************************************************************/
323 struct acpi_table_tcpa_hdr {
324 struct acpi_table_header header; /* Common ACPI table header */
325 u16 platform_class;
329 * Values for platform_class above.
330 * This is how the client and server subtables are differentiated
332 #define ACPI_TCPA_CLIENT_TABLE 0
333 #define ACPI_TCPA_SERVER_TABLE 1
335 struct acpi_table_tcpa_client {
336 u32 minimum_log_length; /* Minimum length for the event log area */
337 u64 log_address; /* Address of the event log area */
340 struct acpi_table_tcpa_server {
341 u16 reserved;
342 u64 minimum_log_length; /* Minimum length for the event log area */
343 u64 log_address; /* Address of the event log area */
344 u16 spec_revision;
345 u8 device_flags;
346 u8 interrupt_flags;
347 u8 gpe_number;
348 u8 reserved2[3];
349 u32 global_interrupt;
350 struct acpi_generic_address address;
351 u32 reserved3;
352 struct acpi_generic_address config_address;
353 u8 group;
354 u8 bus; /* PCI Bus/Segment/Function numbers */
355 u8 device;
356 u8 function;
359 /* Values for device_flags above */
361 #define ACPI_TCPA_PCI_DEVICE (1)
362 #define ACPI_TCPA_BUS_PNP (1<<1)
363 #define ACPI_TCPA_ADDRESS_VALID (1<<2)
365 /* Values for interrupt_flags above */
367 #define ACPI_TCPA_INTERRUPT_MODE (1)
368 #define ACPI_TCPA_INTERRUPT_POLARITY (1<<1)
369 #define ACPI_TCPA_SCI_VIA_GPE (1<<2)
370 #define ACPI_TCPA_GLOBAL_INTERRUPT (1<<3)
372 /*******************************************************************************
374 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
375 * Version 4
377 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
379 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
380 * Version 1.2, Revision 8
381 * February 27, 2017
383 ******************************************************************************/
385 /* Revision 3 */
387 struct acpi_table_tpm23 {
388 struct acpi_table_header header; /* Common ACPI table header */
389 u32 reserved;
390 u64 control_address;
391 u32 start_method;
394 /* Value for start_method above */
396 #define ACPI_TPM23_ACPI_START_METHOD 2
399 * Optional trailer for revision 3. If start method is 2, there is a 4 byte
400 * reserved area of all zeros.
402 struct acpi_tmp23_trailer {
403 u32 reserved;
406 /* Revision 4 */
408 struct acpi_table_tpm2 {
409 struct acpi_table_header header; /* Common ACPI table header */
410 u16 platform_class;
411 u16 reserved;
412 u64 control_address;
413 u32 start_method;
415 /* Platform-specific data follows */
418 /* Values for start_method above */
420 #define ACPI_TPM2_NOT_ALLOWED 0
421 #define ACPI_TPM2_RESERVED1 1
422 #define ACPI_TPM2_START_METHOD 2
423 #define ACPI_TPM2_RESERVED3 3
424 #define ACPI_TPM2_RESERVED4 4
425 #define ACPI_TPM2_RESERVED5 5
426 #define ACPI_TPM2_MEMORY_MAPPED 6
427 #define ACPI_TPM2_COMMAND_BUFFER 7
428 #define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
429 #define ACPI_TPM2_RESERVED9 9
430 #define ACPI_TPM2_RESERVED10 10
431 #define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
432 #define ACPI_TPM2_RESERVED 12
434 /* Optional trailer appears after any start_method subtables */
436 struct acpi_tpm2_trailer {
437 u8 method_parameters[12];
438 u32 minimum_log_length; /* Minimum length for the event log area */
439 u64 log_address; /* Address of the event log area */
443 * Subtables (start_method-specific)
446 /* 11: Start Method for ARM SMC (V1.2 Rev 8) */
448 struct acpi_tpm2_arm_smc {
449 u32 global_interrupt;
450 u8 interrupt_flags;
451 u8 operation_flags;
452 u16 reserved;
453 u32 function_id;
456 /* Values for interrupt_flags above */
458 #define ACPI_TPM2_INTERRUPT_SUPPORT (1)
460 /* Values for operation_flags above */
462 #define ACPI_TPM2_IDLE_SUPPORT (1)
464 /*******************************************************************************
466 * UEFI - UEFI Boot optimization Table
467 * Version 1
469 * Conforms to "Unified Extensible Firmware Interface Specification",
470 * Version 2.3, May 8, 2009
472 ******************************************************************************/
474 struct acpi_table_uefi {
475 struct acpi_table_header header; /* Common ACPI table header */
476 u8 identifier[16]; /* UUID identifier */
477 u16 data_offset; /* Offset of remaining data in table */
480 /*******************************************************************************
482 * VRTC - Virtual Real Time Clock Table
483 * Version 1
485 * Conforms to "Simple Firmware Interface Specification",
486 * Draft 0.8.2, Oct 19, 2010
487 * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
489 ******************************************************************************/
491 struct acpi_table_vrtc {
492 struct acpi_table_header header; /* Common ACPI table header */
495 /* VRTC entry */
497 struct acpi_vrtc_entry {
498 struct acpi_generic_address physical_address;
499 u32 irq;
502 /*******************************************************************************
504 * WAET - Windows ACPI Emulated devices Table
505 * Version 1
507 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
509 ******************************************************************************/
511 struct acpi_table_waet {
512 struct acpi_table_header header; /* Common ACPI table header */
513 u32 flags;
516 /* Masks for Flags field above */
518 #define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
519 #define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
521 /*******************************************************************************
523 * WDAT - Watchdog Action Table
524 * Version 1
526 * Conforms to "Hardware Watchdog Timers Design Specification",
527 * Copyright 2006 Microsoft Corporation.
529 ******************************************************************************/
531 struct acpi_table_wdat {
532 struct acpi_table_header header; /* Common ACPI table header */
533 u32 header_length; /* Watchdog Header Length */
534 u16 pci_segment; /* PCI Segment number */
535 u8 pci_bus; /* PCI Bus number */
536 u8 pci_device; /* PCI Device number */
537 u8 pci_function; /* PCI Function number */
538 u8 reserved[3];
539 u32 timer_period; /* Period of one timer count (msec) */
540 u32 max_count; /* Maximum counter value supported */
541 u32 min_count; /* Minimum counter value */
542 u8 flags;
543 u8 reserved2[3];
544 u32 entries; /* Number of watchdog entries that follow */
547 /* Masks for Flags field above */
549 #define ACPI_WDAT_ENABLED (1)
550 #define ACPI_WDAT_STOPPED 0x80
552 /* WDAT Instruction Entries (actions) */
554 struct acpi_wdat_entry {
555 u8 action;
556 u8 instruction;
557 u16 reserved;
558 struct acpi_generic_address register_region;
559 u32 value; /* Value used with Read/Write register */
560 u32 mask; /* Bitmask required for this register instruction */
563 /* Values for Action field above */
565 enum acpi_wdat_actions {
566 ACPI_WDAT_RESET = 1,
567 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
568 ACPI_WDAT_GET_COUNTDOWN = 5,
569 ACPI_WDAT_SET_COUNTDOWN = 6,
570 ACPI_WDAT_GET_RUNNING_STATE = 8,
571 ACPI_WDAT_SET_RUNNING_STATE = 9,
572 ACPI_WDAT_GET_STOPPED_STATE = 10,
573 ACPI_WDAT_SET_STOPPED_STATE = 11,
574 ACPI_WDAT_GET_REBOOT = 16,
575 ACPI_WDAT_SET_REBOOT = 17,
576 ACPI_WDAT_GET_SHUTDOWN = 18,
577 ACPI_WDAT_SET_SHUTDOWN = 19,
578 ACPI_WDAT_GET_STATUS = 32,
579 ACPI_WDAT_SET_STATUS = 33,
580 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
583 /* Values for Instruction field above */
585 enum acpi_wdat_instructions {
586 ACPI_WDAT_READ_VALUE = 0,
587 ACPI_WDAT_READ_COUNTDOWN = 1,
588 ACPI_WDAT_WRITE_VALUE = 2,
589 ACPI_WDAT_WRITE_COUNTDOWN = 3,
590 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
591 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
594 /*******************************************************************************
596 * WDDT - Watchdog Descriptor Table
597 * Version 1
599 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
600 * Version 001, September 2002
602 ******************************************************************************/
604 struct acpi_table_wddt {
605 struct acpi_table_header header; /* Common ACPI table header */
606 u16 spec_version;
607 u16 table_version;
608 u16 pci_vendor_id;
609 struct acpi_generic_address address;
610 u16 max_count; /* Maximum counter value supported */
611 u16 min_count; /* Minimum counter value supported */
612 u16 period;
613 u16 status;
614 u16 capability;
617 /* Flags for Status field above */
619 #define ACPI_WDDT_AVAILABLE (1)
620 #define ACPI_WDDT_ACTIVE (1<<1)
621 #define ACPI_WDDT_TCO_OS_OWNED (1<<2)
622 #define ACPI_WDDT_USER_RESET (1<<11)
623 #define ACPI_WDDT_WDT_RESET (1<<12)
624 #define ACPI_WDDT_POWER_FAIL (1<<13)
625 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
627 /* Flags for Capability field above */
629 #define ACPI_WDDT_AUTO_RESET (1)
630 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
632 /*******************************************************************************
634 * WDRT - Watchdog Resource Table
635 * Version 1
637 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
638 * Version 1.01, August 28, 2006
640 ******************************************************************************/
642 struct acpi_table_wdrt {
643 struct acpi_table_header header; /* Common ACPI table header */
644 struct acpi_generic_address control_register;
645 struct acpi_generic_address count_register;
646 u16 pci_device_id;
647 u16 pci_vendor_id;
648 u8 pci_bus; /* PCI Bus number */
649 u8 pci_device; /* PCI Device number */
650 u8 pci_function; /* PCI Function number */
651 u8 pci_segment; /* PCI Segment number */
652 u16 max_count; /* Maximum counter value supported */
653 u8 units;
656 /*******************************************************************************
658 * WPBT - Windows Platform Environment Table (ACPI 6.0)
659 * Version 1
661 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
663 ******************************************************************************/
665 struct acpi_table_wpbt {
666 struct acpi_table_header header; /* Common ACPI table header */
667 u32 handoff_size;
668 u64 handoff_address;
669 u8 layout;
670 u8 type;
671 u16 arguments_length;
674 /*******************************************************************************
676 * WSMT - Windows SMM Security Migrations Table
677 * Version 1
679 * Conforms to "Windows SMM Security Migrations Table",
680 * Version 1.0, April 18, 2016
682 ******************************************************************************/
684 struct acpi_table_wsmt {
685 struct acpi_table_header header; /* Common ACPI table header */
686 u32 protection_flags;
689 /* Flags for protection_flags field above */
691 #define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
692 #define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
693 #define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
695 /*******************************************************************************
697 * XENV - Xen Environment Table (ACPI 6.0)
698 * Version 1
700 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
702 ******************************************************************************/
704 struct acpi_table_xenv {
705 struct acpi_table_header header; /* Common ACPI table header */
706 u64 grant_table_address;
707 u64 grant_table_size;
708 u32 event_interrupt;
709 u8 event_flags;
712 /* Reset to default packing */
714 #pragma pack()
716 #endif /* __ACTBL3_H__ */