Loading...
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: actbl3.h - ACPI Table Definitions
5 *
6 * Copyright (C) 2000 - 2020, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef __ACTBL3_H__
11#define __ACTBL3_H__
12
13/*******************************************************************************
14 *
15 * Additional ACPI Tables
16 *
17 * These tables are not consumed directly by the ACPICA subsystem, but are
18 * included here to support device drivers and the AML disassembler.
19 *
20 ******************************************************************************/
21
22/*
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.
26 */
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 Mitigations Table */
43#define ACPI_SIG_XENV "XENV" /* Xen Environment table */
44#define ACPI_SIG_XXXX "XXXX" /* Intermediate AML header for ASL/ASL+ converter */
45
46/*
47 * All tables must be byte-packed to match the ACPI specification, since
48 * the tables are provided by the system BIOS.
49 */
50#pragma pack(1)
51
52/*
53 * Note: C bitfields are not used for this reason:
54 *
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
62 */
63
64/*******************************************************************************
65 *
66 * SLIC - Software Licensing Description Table
67 *
68 * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
69 * November 29, 2011. Copyright 2011 Microsoft
70 *
71 ******************************************************************************/
72
73/* Basic SLIC table is only the common ACPI header */
74
75struct acpi_table_slic {
76 struct acpi_table_header header; /* Common ACPI table header */
77};
78
79/*******************************************************************************
80 *
81 * SLIT - System Locality Distance Information Table
82 * Version 1
83 *
84 ******************************************************************************/
85
86struct 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 */
90};
91
92/*******************************************************************************
93 *
94 * SPCR - Serial Port Console Redirection table
95 * Version 2
96 *
97 * Conforms to "Serial Port Console Redirection Table",
98 * Version 1.03, August 10, 2015
99 *
100 ******************************************************************************/
101
102struct 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;
124};
125
126/* Masks for pci_flags field above */
127
128#define ACPI_SPCR_DO_NOT_DISABLE (1)
129
130/* Values for Interface Type: See the definition of the DBG2 table */
131
132/*******************************************************************************
133 *
134 * SPMI - Server Platform Management Interface table
135 * Version 5
136 *
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.
140 *
141 ******************************************************************************/
142
143struct 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;
159};
160
161/* Values for interface_type above */
162
163enum 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 */
170};
171
172/*******************************************************************************
173 *
174 * SRAT - System Resource Affinity Table
175 * Version 3
176 *
177 ******************************************************************************/
178
179struct 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 */
183};
184
185/* Values for subtable type in struct acpi_subtable_header */
186
187enum 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 */
195};
196
197/*
198 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
199 */
200
201/* 0: Processor Local APIC/SAPIC Affinity */
202
203struct 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;
211};
212
213/* Flags */
214
215#define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
216
217/* 1: Memory Affinity */
218
219struct 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 */
228};
229
230/* Flags */
231
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 */
235
236/* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
237
238struct 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;
246};
247
248/* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
249
250#define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
251
252/* 3: GICC Affinity (ACPI 5.1) */
253
254struct 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;
260};
261
262/* Flags for struct acpi_srat_gicc_affinity */
263
264#define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
265
266/* 4: GCC ITS Affinity (ACPI 6.2) */
267
268struct acpi_srat_gic_its_affinity {
269 struct acpi_subtable_header header;
270 u32 proximity_domain;
271 u16 reserved;
272 u32 its_id;
273};
274
275/* 5: Generic Initiator Affinity Structure (ACPI 6.3) */
276
277struct 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;
285};
286
287/* Flags for struct acpi_srat_generic_affinity */
288
289#define ACPI_SRAT_GENERIC_AFFINITY_ENABLED (1) /* 00: Use affinity structure */
290
291/*******************************************************************************
292 *
293 * STAO - Status Override Table (_STA override) - ACPI 6.0
294 * Version 1
295 *
296 * Conforms to "ACPI Specification for Status Override Table"
297 * 6 January 2015
298 *
299 ******************************************************************************/
300
301struct acpi_table_stao {
302 struct acpi_table_header header; /* Common ACPI table header */
303 u8 ignore_uart;
304};
305
306/*******************************************************************************
307 *
308 * TCPA - Trusted Computing Platform Alliance table
309 * Version 2
310 *
311 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
312 *
313 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
314 * Version 1.2, Revision 8
315 * February 27, 2017
316 *
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.
320 *
321 ******************************************************************************/
322
323struct acpi_table_tcpa_hdr {
324 struct acpi_table_header header; /* Common ACPI table header */
325 u16 platform_class;
326};
327
328/*
329 * Values for platform_class above.
330 * This is how the client and server subtables are differentiated
331 */
332#define ACPI_TCPA_CLIENT_TABLE 0
333#define ACPI_TCPA_SERVER_TABLE 1
334
335struct 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 */
338};
339
340struct 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;
357};
358
359/* Values for device_flags above */
360
361#define ACPI_TCPA_PCI_DEVICE (1)
362#define ACPI_TCPA_BUS_PNP (1<<1)
363#define ACPI_TCPA_ADDRESS_VALID (1<<2)
364
365/* Values for interrupt_flags above */
366
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)
371
372/*******************************************************************************
373 *
374 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
375 * Version 4
376 *
377 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
378 *
379 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
380 * Version 1.2, Revision 8
381 * February 27, 2017
382 *
383 ******************************************************************************/
384
385/* Revision 3 */
386
387struct acpi_table_tpm23 {
388 struct acpi_table_header header; /* Common ACPI table header */
389 u32 reserved;
390 u64 control_address;
391 u32 start_method;
392};
393
394/* Value for start_method above */
395
396#define ACPI_TPM23_ACPI_START_METHOD 2
397
398/*
399 * Optional trailer for revision 3. If start method is 2, there is a 4 byte
400 * reserved area of all zeros.
401 */
402struct acpi_tmp23_trailer {
403 u32 reserved;
404};
405
406/* Revision 4 */
407
408struct 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;
414
415 /* Platform-specific data follows */
416};
417
418/* Optional trailer for revision 4 holding platform-specific data */
419struct acpi_tpm2_phy {
420 u8 start_method_specific[12];
421 u32 log_area_minimum_length;
422 u64 log_area_start_address;
423};
424
425/* Values for start_method above */
426
427#define ACPI_TPM2_NOT_ALLOWED 0
428#define ACPI_TPM2_RESERVED1 1
429#define ACPI_TPM2_START_METHOD 2
430#define ACPI_TPM2_RESERVED3 3
431#define ACPI_TPM2_RESERVED4 4
432#define ACPI_TPM2_RESERVED5 5
433#define ACPI_TPM2_MEMORY_MAPPED 6
434#define ACPI_TPM2_COMMAND_BUFFER 7
435#define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
436#define ACPI_TPM2_RESERVED9 9
437#define ACPI_TPM2_RESERVED10 10
438#define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
439#define ACPI_TPM2_RESERVED 12
440
441/* Optional trailer appears after any start_method subtables */
442
443struct acpi_tpm2_trailer {
444 u8 method_parameters[12];
445 u32 minimum_log_length; /* Minimum length for the event log area */
446 u64 log_address; /* Address of the event log area */
447};
448
449/*
450 * Subtables (start_method-specific)
451 */
452
453/* 11: Start Method for ARM SMC (V1.2 Rev 8) */
454
455struct acpi_tpm2_arm_smc {
456 u32 global_interrupt;
457 u8 interrupt_flags;
458 u8 operation_flags;
459 u16 reserved;
460 u32 function_id;
461};
462
463/* Values for interrupt_flags above */
464
465#define ACPI_TPM2_INTERRUPT_SUPPORT (1)
466
467/* Values for operation_flags above */
468
469#define ACPI_TPM2_IDLE_SUPPORT (1)
470
471/*******************************************************************************
472 *
473 * UEFI - UEFI Boot optimization Table
474 * Version 1
475 *
476 * Conforms to "Unified Extensible Firmware Interface Specification",
477 * Version 2.3, May 8, 2009
478 *
479 ******************************************************************************/
480
481struct acpi_table_uefi {
482 struct acpi_table_header header; /* Common ACPI table header */
483 u8 identifier[16]; /* UUID identifier */
484 u16 data_offset; /* Offset of remaining data in table */
485};
486
487/*******************************************************************************
488 *
489 * VRTC - Virtual Real Time Clock Table
490 * Version 1
491 *
492 * Conforms to "Simple Firmware Interface Specification",
493 * Draft 0.8.2, Oct 19, 2010
494 * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
495 *
496 ******************************************************************************/
497
498struct acpi_table_vrtc {
499 struct acpi_table_header header; /* Common ACPI table header */
500};
501
502/* VRTC entry */
503
504struct acpi_vrtc_entry {
505 struct acpi_generic_address physical_address;
506 u32 irq;
507};
508
509/*******************************************************************************
510 *
511 * WAET - Windows ACPI Emulated devices Table
512 * Version 1
513 *
514 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
515 *
516 ******************************************************************************/
517
518struct acpi_table_waet {
519 struct acpi_table_header header; /* Common ACPI table header */
520 u32 flags;
521};
522
523/* Masks for Flags field above */
524
525#define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
526#define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
527
528/*******************************************************************************
529 *
530 * WDAT - Watchdog Action Table
531 * Version 1
532 *
533 * Conforms to "Hardware Watchdog Timers Design Specification",
534 * Copyright 2006 Microsoft Corporation.
535 *
536 ******************************************************************************/
537
538struct acpi_table_wdat {
539 struct acpi_table_header header; /* Common ACPI table header */
540 u32 header_length; /* Watchdog Header Length */
541 u16 pci_segment; /* PCI Segment number */
542 u8 pci_bus; /* PCI Bus number */
543 u8 pci_device; /* PCI Device number */
544 u8 pci_function; /* PCI Function number */
545 u8 reserved[3];
546 u32 timer_period; /* Period of one timer count (msec) */
547 u32 max_count; /* Maximum counter value supported */
548 u32 min_count; /* Minimum counter value */
549 u8 flags;
550 u8 reserved2[3];
551 u32 entries; /* Number of watchdog entries that follow */
552};
553
554/* Masks for Flags field above */
555
556#define ACPI_WDAT_ENABLED (1)
557#define ACPI_WDAT_STOPPED 0x80
558
559/* WDAT Instruction Entries (actions) */
560
561struct acpi_wdat_entry {
562 u8 action;
563 u8 instruction;
564 u16 reserved;
565 struct acpi_generic_address register_region;
566 u32 value; /* Value used with Read/Write register */
567 u32 mask; /* Bitmask required for this register instruction */
568};
569
570/* Values for Action field above */
571
572enum acpi_wdat_actions {
573 ACPI_WDAT_RESET = 1,
574 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
575 ACPI_WDAT_GET_COUNTDOWN = 5,
576 ACPI_WDAT_SET_COUNTDOWN = 6,
577 ACPI_WDAT_GET_RUNNING_STATE = 8,
578 ACPI_WDAT_SET_RUNNING_STATE = 9,
579 ACPI_WDAT_GET_STOPPED_STATE = 10,
580 ACPI_WDAT_SET_STOPPED_STATE = 11,
581 ACPI_WDAT_GET_REBOOT = 16,
582 ACPI_WDAT_SET_REBOOT = 17,
583 ACPI_WDAT_GET_SHUTDOWN = 18,
584 ACPI_WDAT_SET_SHUTDOWN = 19,
585 ACPI_WDAT_GET_STATUS = 32,
586 ACPI_WDAT_SET_STATUS = 33,
587 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
588};
589
590/* Values for Instruction field above */
591
592enum acpi_wdat_instructions {
593 ACPI_WDAT_READ_VALUE = 0,
594 ACPI_WDAT_READ_COUNTDOWN = 1,
595 ACPI_WDAT_WRITE_VALUE = 2,
596 ACPI_WDAT_WRITE_COUNTDOWN = 3,
597 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
598 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
599};
600
601/*******************************************************************************
602 *
603 * WDDT - Watchdog Descriptor Table
604 * Version 1
605 *
606 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
607 * Version 001, September 2002
608 *
609 ******************************************************************************/
610
611struct acpi_table_wddt {
612 struct acpi_table_header header; /* Common ACPI table header */
613 u16 spec_version;
614 u16 table_version;
615 u16 pci_vendor_id;
616 struct acpi_generic_address address;
617 u16 max_count; /* Maximum counter value supported */
618 u16 min_count; /* Minimum counter value supported */
619 u16 period;
620 u16 status;
621 u16 capability;
622};
623
624/* Flags for Status field above */
625
626#define ACPI_WDDT_AVAILABLE (1)
627#define ACPI_WDDT_ACTIVE (1<<1)
628#define ACPI_WDDT_TCO_OS_OWNED (1<<2)
629#define ACPI_WDDT_USER_RESET (1<<11)
630#define ACPI_WDDT_WDT_RESET (1<<12)
631#define ACPI_WDDT_POWER_FAIL (1<<13)
632#define ACPI_WDDT_UNKNOWN_RESET (1<<14)
633
634/* Flags for Capability field above */
635
636#define ACPI_WDDT_AUTO_RESET (1)
637#define ACPI_WDDT_ALERT_SUPPORT (1<<1)
638
639/*******************************************************************************
640 *
641 * WDRT - Watchdog Resource Table
642 * Version 1
643 *
644 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
645 * Version 1.01, August 28, 2006
646 *
647 ******************************************************************************/
648
649struct acpi_table_wdrt {
650 struct acpi_table_header header; /* Common ACPI table header */
651 struct acpi_generic_address control_register;
652 struct acpi_generic_address count_register;
653 u16 pci_device_id;
654 u16 pci_vendor_id;
655 u8 pci_bus; /* PCI Bus number */
656 u8 pci_device; /* PCI Device number */
657 u8 pci_function; /* PCI Function number */
658 u8 pci_segment; /* PCI Segment number */
659 u16 max_count; /* Maximum counter value supported */
660 u8 units;
661};
662
663/*******************************************************************************
664 *
665 * WPBT - Windows Platform Environment Table (ACPI 6.0)
666 * Version 1
667 *
668 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
669 *
670 ******************************************************************************/
671
672struct acpi_table_wpbt {
673 struct acpi_table_header header; /* Common ACPI table header */
674 u32 handoff_size;
675 u64 handoff_address;
676 u8 layout;
677 u8 type;
678 u16 arguments_length;
679};
680
681/*******************************************************************************
682 *
683 * WSMT - Windows SMM Security Mitigations Table
684 * Version 1
685 *
686 * Conforms to "Windows SMM Security Mitigations Table",
687 * Version 1.0, April 18, 2016
688 *
689 ******************************************************************************/
690
691struct acpi_table_wsmt {
692 struct acpi_table_header header; /* Common ACPI table header */
693 u32 protection_flags;
694};
695
696/* Flags for protection_flags field above */
697
698#define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
699#define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
700#define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
701
702/*******************************************************************************
703 *
704 * XENV - Xen Environment Table (ACPI 6.0)
705 * Version 1
706 *
707 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
708 *
709 ******************************************************************************/
710
711struct acpi_table_xenv {
712 struct acpi_table_header header; /* Common ACPI table header */
713 u64 grant_table_address;
714 u64 grant_table_size;
715 u32 event_interrupt;
716 u8 event_flags;
717};
718
719/* Reset to default packing */
720
721#pragma pack()
722
723#endif /* __ACTBL3_H__ */
1/******************************************************************************
2 *
3 * Name: actbl3.h - ACPI Table Definitions
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2014, 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 * Additional ACPI Tables (3)
50 *
51 * These tables are not consumed directly by the ACPICA subsystem, but are
52 * included here to support device drivers and the AML disassembler.
53 *
54 * The tables in this file are fully defined within the ACPI specification.
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_BGRT "BGRT" /* Boot Graphics Resource Table */
64#define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
65#define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
66#define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
67#define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
68#define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
69#define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
70#define ACPI_SIG_RASF "RASF" /* RAS Feature table */
71#define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
72
73#define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
74#define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
75
76/* Reserved table signatures */
77
78#define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
79#define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
80#define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
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 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
103 * Version 1
104 *
105 ******************************************************************************/
106
107struct acpi_table_bgrt {
108 struct acpi_table_header header; /* Common ACPI table header */
109 u16 version;
110 u8 status;
111 u8 image_type;
112 u64 image_address;
113 u32 image_offset_x;
114 u32 image_offset_y;
115};
116
117/*******************************************************************************
118 *
119 * DRTM - Dynamic Root of Trust for Measurement table
120 *
121 ******************************************************************************/
122
123struct acpi_table_drtm {
124 struct acpi_table_header header; /* Common ACPI table header */
125 u64 entry_base_address;
126 u64 entry_length;
127 u32 entry_address32;
128 u64 entry_address64;
129 u64 exit_address;
130 u64 log_area_address;
131 u32 log_area_length;
132 u64 arch_dependent_address;
133 u32 flags;
134};
135
136/* 1) Validated Tables List */
137
138struct acpi_drtm_vtl_list {
139 u32 validated_table_list_count;
140};
141
142/* 2) Resources List */
143
144struct acpi_drtm_resource_list {
145 u32 resource_list_count;
146};
147
148/* 3) Platform-specific Identifiers List */
149
150struct acpi_drtm_id_list {
151 u32 id_list_count;
152};
153
154/*******************************************************************************
155 *
156 * FPDT - Firmware Performance Data Table (ACPI 5.0)
157 * Version 1
158 *
159 ******************************************************************************/
160
161struct acpi_table_fpdt {
162 struct acpi_table_header header; /* Common ACPI table header */
163};
164
165/* FPDT subtable header */
166
167struct acpi_fpdt_header {
168 u16 type;
169 u8 length;
170 u8 revision;
171};
172
173/* Values for Type field above */
174
175enum acpi_fpdt_type {
176 ACPI_FPDT_TYPE_BOOT = 0,
177 ACPI_FPDT_TYPE_S3PERF = 1
178};
179
180/*
181 * FPDT subtables
182 */
183
184/* 0: Firmware Basic Boot Performance Record */
185
186struct acpi_fpdt_boot {
187 struct acpi_fpdt_header header;
188 u8 reserved[4];
189 u64 reset_end;
190 u64 load_start;
191 u64 startup_start;
192 u64 exit_services_entry;
193 u64 exit_services_exit;
194};
195
196/* 1: S3 Performance Table Pointer Record */
197
198struct acpi_fpdt_s3pt_ptr {
199 struct acpi_fpdt_header header;
200 u8 reserved[4];
201 u64 address;
202};
203
204/*
205 * S3PT - S3 Performance Table. This table is pointed to by the
206 * FPDT S3 Pointer Record above.
207 */
208struct acpi_table_s3pt {
209 u8 signature[4]; /* "S3PT" */
210 u32 length;
211};
212
213/*
214 * S3PT Subtables
215 */
216struct acpi_s3pt_header {
217 u16 type;
218 u8 length;
219 u8 revision;
220};
221
222/* Values for Type field above */
223
224enum acpi_s3pt_type {
225 ACPI_S3PT_TYPE_RESUME = 0,
226 ACPI_S3PT_TYPE_SUSPEND = 1
227};
228
229struct acpi_s3pt_resume {
230 struct acpi_s3pt_header header;
231 u32 resume_count;
232 u64 full_resume;
233 u64 average_resume;
234};
235
236struct acpi_s3pt_suspend {
237 struct acpi_s3pt_header header;
238 u64 suspend_start;
239 u64 suspend_end;
240};
241
242/*******************************************************************************
243 *
244 * GTDT - Generic Timer Description Table (ACPI 5.0)
245 * Version 1
246 *
247 ******************************************************************************/
248
249struct acpi_table_gtdt {
250 struct acpi_table_header header; /* Common ACPI table header */
251 u64 address;
252 u32 flags;
253 u32 secure_pl1_interrupt;
254 u32 secure_pl1_flags;
255 u32 non_secure_pl1_interrupt;
256 u32 non_secure_pl1_flags;
257 u32 virtual_timer_interrupt;
258 u32 virtual_timer_flags;
259 u32 non_secure_pl2_interrupt;
260 u32 non_secure_pl2_flags;
261};
262
263/* Values for Flags field above */
264
265#define ACPI_GTDT_MAPPED_BLOCK_PRESENT 1
266
267/* Values for all "TimerFlags" fields above */
268
269#define ACPI_GTDT_INTERRUPT_MODE 1
270#define ACPI_GTDT_INTERRUPT_POLARITY 2
271
272/*******************************************************************************
273 *
274 * MPST - Memory Power State Table (ACPI 5.0)
275 * Version 1
276 *
277 ******************************************************************************/
278
279#define ACPI_MPST_CHANNEL_INFO \
280 u8 channel_id; \
281 u8 reserved1[3]; \
282 u16 power_node_count; \
283 u16 reserved2;
284
285/* Main table */
286
287struct acpi_table_mpst {
288 struct acpi_table_header header; /* Common ACPI table header */
289 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
290};
291
292/* Memory Platform Communication Channel Info */
293
294struct acpi_mpst_channel {
295 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
296};
297
298/* Memory Power Node Structure */
299
300struct acpi_mpst_power_node {
301 u8 flags;
302 u8 reserved1;
303 u16 node_id;
304 u32 length;
305 u64 range_address;
306 u64 range_length;
307 u32 num_power_states;
308 u32 num_physical_components;
309};
310
311/* Values for Flags field above */
312
313#define ACPI_MPST_ENABLED 1
314#define ACPI_MPST_POWER_MANAGED 2
315#define ACPI_MPST_HOT_PLUG_CAPABLE 4
316
317/* Memory Power State Structure (follows POWER_NODE above) */
318
319struct acpi_mpst_power_state {
320 u8 power_state;
321 u8 info_index;
322};
323
324/* Physical Component ID Structure (follows POWER_STATE above) */
325
326struct acpi_mpst_component {
327 u16 component_id;
328};
329
330/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
331
332struct acpi_mpst_data_hdr {
333 u16 characteristics_count;
334 u16 reserved;
335};
336
337struct acpi_mpst_power_data {
338 u8 structure_id;
339 u8 flags;
340 u16 reserved1;
341 u32 average_power;
342 u32 power_saving;
343 u64 exit_latency;
344 u64 reserved2;
345};
346
347/* Values for Flags field above */
348
349#define ACPI_MPST_PRESERVE 1
350#define ACPI_MPST_AUTOENTRY 2
351#define ACPI_MPST_AUTOEXIT 4
352
353/* Shared Memory Region (not part of an ACPI table) */
354
355struct acpi_mpst_shared {
356 u32 signature;
357 u16 pcc_command;
358 u16 pcc_status;
359 u32 command_register;
360 u32 status_register;
361 u32 power_state_id;
362 u32 power_node_id;
363 u64 energy_consumed;
364 u64 average_power;
365};
366
367/*******************************************************************************
368 *
369 * PCCT - Platform Communications Channel Table (ACPI 5.0)
370 * Version 1
371 *
372 ******************************************************************************/
373
374struct acpi_table_pcct {
375 struct acpi_table_header header; /* Common ACPI table header */
376 u32 flags;
377 u64 reserved;
378};
379
380/* Values for Flags field above */
381
382#define ACPI_PCCT_DOORBELL 1
383
384/* Values for subtable type in struct acpi_subtable_header */
385
386enum acpi_pcct_type {
387 ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
388 ACPI_PCCT_TYPE_RESERVED = 1 /* 1 and greater are reserved */
389};
390
391/*
392 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
393 */
394
395/* 0: Generic Communications Subspace */
396
397struct acpi_pcct_subspace {
398 struct acpi_subtable_header header;
399 u8 reserved[6];
400 u64 base_address;
401 u64 length;
402 struct acpi_generic_address doorbell_register;
403 u64 preserve_mask;
404 u64 write_mask;
405 u32 latency;
406 u32 max_access_rate;
407 u16 min_turnaround_time;
408};
409
410/*
411 * PCC memory structures (not part of the ACPI table)
412 */
413
414/* Shared Memory Region */
415
416struct acpi_pcct_shared_memory {
417 u32 signature;
418 u16 command;
419 u16 status;
420};
421
422/*******************************************************************************
423 *
424 * PMTT - Platform Memory Topology Table (ACPI 5.0)
425 * Version 1
426 *
427 ******************************************************************************/
428
429struct acpi_table_pmtt {
430 struct acpi_table_header header; /* Common ACPI table header */
431 u32 reserved;
432};
433
434/* Common header for PMTT subtables that follow main table */
435
436struct acpi_pmtt_header {
437 u8 type;
438 u8 reserved1;
439 u16 length;
440 u16 flags;
441 u16 reserved2;
442};
443
444/* Values for Type field above */
445
446#define ACPI_PMTT_TYPE_SOCKET 0
447#define ACPI_PMTT_TYPE_CONTROLLER 1
448#define ACPI_PMTT_TYPE_DIMM 2
449#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
450
451/* Values for Flags field above */
452
453#define ACPI_PMTT_TOP_LEVEL 0x0001
454#define ACPI_PMTT_PHYSICAL 0x0002
455#define ACPI_PMTT_MEMORY_TYPE 0x000C
456
457/*
458 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
459 */
460
461/* 0: Socket Structure */
462
463struct acpi_pmtt_socket {
464 struct acpi_pmtt_header header;
465 u16 socket_id;
466 u16 reserved;
467};
468
469/* 1: Memory Controller subtable */
470
471struct acpi_pmtt_controller {
472 struct acpi_pmtt_header header;
473 u32 read_latency;
474 u32 write_latency;
475 u32 read_bandwidth;
476 u32 write_bandwidth;
477 u16 access_width;
478 u16 alignment;
479 u16 reserved;
480 u16 domain_count;
481};
482
483/* 1a: Proximity Domain substructure */
484
485struct acpi_pmtt_domain {
486 u32 proximity_domain;
487};
488
489/* 2: Physical Component Identifier (DIMM) */
490
491struct acpi_pmtt_physical_component {
492 struct acpi_pmtt_header header;
493 u16 component_id;
494 u16 reserved;
495 u32 memory_size;
496 u32 bios_handle;
497};
498
499/*******************************************************************************
500 *
501 * RASF - RAS Feature Table (ACPI 5.0)
502 * Version 1
503 *
504 ******************************************************************************/
505
506struct acpi_table_rasf {
507 struct acpi_table_header header; /* Common ACPI table header */
508 u8 channel_id[12];
509};
510
511/* RASF Platform Communication Channel Shared Memory Region */
512
513struct acpi_rasf_shared_memory {
514 u32 signature;
515 u16 command;
516 u16 status;
517 u16 version;
518 u8 capabilities[16];
519 u8 set_capabilities[16];
520 u16 num_parameter_blocks;
521 u32 set_capabilities_status;
522};
523
524/* RASF Parameter Block Structure Header */
525
526struct acpi_rasf_parameter_block {
527 u16 type;
528 u16 version;
529 u16 length;
530};
531
532/* RASF Parameter Block Structure for PATROL_SCRUB */
533
534struct acpi_rasf_patrol_scrub_parameter {
535 struct acpi_rasf_parameter_block header;
536 u16 patrol_scrub_command;
537 u64 requested_address_range[2];
538 u64 actual_address_range[2];
539 u16 flags;
540 u8 requested_speed;
541};
542
543/* Masks for Flags and Speed fields above */
544
545#define ACPI_RASF_SCRUBBER_RUNNING 1
546#define ACPI_RASF_SPEED (7<<1)
547#define ACPI_RASF_SPEED_SLOW (0<<1)
548#define ACPI_RASF_SPEED_MEDIUM (4<<1)
549#define ACPI_RASF_SPEED_FAST (7<<1)
550
551/* Channel Commands */
552
553enum acpi_rasf_commands {
554 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
555};
556
557/* Platform RAS Capabilities */
558
559enum acpi_rasf_capabiliities {
560 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
561 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
562};
563
564/* Patrol Scrub Commands */
565
566enum acpi_rasf_patrol_scrub_commands {
567 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
568 ACPI_RASF_START_PATROL_SCRUBBER = 2,
569 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
570};
571
572/* Channel Command flags */
573
574#define ACPI_RASF_GENERATE_SCI (1<<15)
575
576/* Status values */
577
578enum acpi_rasf_status {
579 ACPI_RASF_SUCCESS = 0,
580 ACPI_RASF_NOT_VALID = 1,
581 ACPI_RASF_NOT_SUPPORTED = 2,
582 ACPI_RASF_BUSY = 3,
583 ACPI_RASF_FAILED = 4,
584 ACPI_RASF_ABORTED = 5,
585 ACPI_RASF_INVALID_DATA = 6
586};
587
588/* Status flags */
589
590#define ACPI_RASF_COMMAND_COMPLETE (1)
591#define ACPI_RASF_SCI_DOORBELL (1<<1)
592#define ACPI_RASF_ERROR (1<<2)
593#define ACPI_RASF_STATUS (0x1F<<3)
594
595/*******************************************************************************
596 *
597 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
598 * Version 3
599 *
600 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
601 *
602 ******************************************************************************/
603
604struct acpi_table_tpm2 {
605 struct acpi_table_header header; /* Common ACPI table header */
606 u32 flags;
607 u64 control_address;
608 u32 start_method;
609};
610
611/* Control area structure (not part of table, pointed to by control_address) */
612
613struct acpi_tpm2_control {
614 u32 reserved;
615 u32 error;
616 u32 cancel;
617 u32 start;
618 u64 interrupt_control;
619 u32 command_size;
620 u64 command_address;
621 u32 response_size;
622 u64 response_address;
623};
624
625/* Reset to default packing */
626
627#pragma pack()
628
629#endif /* __ACTBL3_H__ */