Loading...
Note: File does not exist in v3.1.
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 - 2018, 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 Migrations 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_RESERVED = 5 /* 5 and greater are reserved */
194};
195
196/*
197 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
198 */
199
200/* 0: Processor Local APIC/SAPIC Affinity */
201
202struct acpi_srat_cpu_affinity {
203 struct acpi_subtable_header header;
204 u8 proximity_domain_lo;
205 u8 apic_id;
206 u32 flags;
207 u8 local_sapic_eid;
208 u8 proximity_domain_hi[3];
209 u32 clock_domain;
210};
211
212/* Flags */
213
214#define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
215
216/* 1: Memory Affinity */
217
218struct acpi_srat_mem_affinity {
219 struct acpi_subtable_header header;
220 u32 proximity_domain;
221 u16 reserved; /* Reserved, must be zero */
222 u64 base_address;
223 u64 length;
224 u32 reserved1;
225 u32 flags;
226 u64 reserved2; /* Reserved, must be zero */
227};
228
229/* Flags */
230
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 */
234
235/* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
236
237struct acpi_srat_x2apic_cpu_affinity {
238 struct acpi_subtable_header header;
239 u16 reserved; /* Reserved, must be zero */
240 u32 proximity_domain;
241 u32 apic_id;
242 u32 flags;
243 u32 clock_domain;
244 u32 reserved2;
245};
246
247/* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
248
249#define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
250
251/* 3: GICC Affinity (ACPI 5.1) */
252
253struct acpi_srat_gicc_affinity {
254 struct acpi_subtable_header header;
255 u32 proximity_domain;
256 u32 acpi_processor_uid;
257 u32 flags;
258 u32 clock_domain;
259};
260
261/* Flags for struct acpi_srat_gicc_affinity */
262
263#define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
264
265/* 4: GCC ITS Affinity (ACPI 6.2) */
266
267struct acpi_srat_gic_its_affinity {
268 struct acpi_subtable_header header;
269 u32 proximity_domain;
270 u16 reserved;
271 u32 its_id;
272};
273
274/*******************************************************************************
275 *
276 * STAO - Status Override Table (_STA override) - ACPI 6.0
277 * Version 1
278 *
279 * Conforms to "ACPI Specification for Status Override Table"
280 * 6 January 2015
281 *
282 ******************************************************************************/
283
284struct acpi_table_stao {
285 struct acpi_table_header header; /* Common ACPI table header */
286 u8 ignore_uart;
287};
288
289/*******************************************************************************
290 *
291 * TCPA - Trusted Computing Platform Alliance table
292 * Version 2
293 *
294 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
295 *
296 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
297 * Version 1.2, Revision 8
298 * February 27, 2017
299 *
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.
303 *
304 ******************************************************************************/
305
306struct acpi_table_tcpa_hdr {
307 struct acpi_table_header header; /* Common ACPI table header */
308 u16 platform_class;
309};
310
311/*
312 * Values for platform_class above.
313 * This is how the client and server subtables are differentiated
314 */
315#define ACPI_TCPA_CLIENT_TABLE 0
316#define ACPI_TCPA_SERVER_TABLE 1
317
318struct 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 */
321};
322
323struct acpi_table_tcpa_server {
324 u16 reserved;
325 u64 minimum_log_length; /* Minimum length for the event log area */
326 u64 log_address; /* Address of the event log area */
327 u16 spec_revision;
328 u8 device_flags;
329 u8 interrupt_flags;
330 u8 gpe_number;
331 u8 reserved2[3];
332 u32 global_interrupt;
333 struct acpi_generic_address address;
334 u32 reserved3;
335 struct acpi_generic_address config_address;
336 u8 group;
337 u8 bus; /* PCI Bus/Segment/Function numbers */
338 u8 device;
339 u8 function;
340};
341
342/* Values for device_flags above */
343
344#define ACPI_TCPA_PCI_DEVICE (1)
345#define ACPI_TCPA_BUS_PNP (1<<1)
346#define ACPI_TCPA_ADDRESS_VALID (1<<2)
347
348/* Values for interrupt_flags above */
349
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)
354
355/*******************************************************************************
356 *
357 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
358 * Version 4
359 *
360 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
361 *
362 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
363 * Version 1.2, Revision 8
364 * February 27, 2017
365 *
366 ******************************************************************************/
367
368struct acpi_table_tpm2 {
369 struct acpi_table_header header; /* Common ACPI table header */
370 u16 platform_class;
371 u16 reserved;
372 u64 control_address;
373 u32 start_method;
374
375 /* Platform-specific data follows */
376};
377
378/* Values for start_method above */
379
380#define ACPI_TPM2_NOT_ALLOWED 0
381#define ACPI_TPM2_RESERVED1 1
382#define ACPI_TPM2_START_METHOD 2
383#define ACPI_TPM2_RESERVED3 3
384#define ACPI_TPM2_RESERVED4 4
385#define ACPI_TPM2_RESERVED5 5
386#define ACPI_TPM2_MEMORY_MAPPED 6
387#define ACPI_TPM2_COMMAND_BUFFER 7
388#define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
389#define ACPI_TPM2_RESERVED9 9
390#define ACPI_TPM2_RESERVED10 10
391#define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
392#define ACPI_TPM2_RESERVED 12
393
394/* Optional trailer appears after any start_method subtables */
395
396struct acpi_tpm2_trailer {
397 u8 method_parameters[12];
398 u32 minimum_log_length; /* Minimum length for the event log area */
399 u64 log_address; /* Address of the event log area */
400};
401
402/*
403 * Subtables (start_method-specific)
404 */
405
406/* 11: Start Method for ARM SMC (V1.2 Rev 8) */
407
408struct acpi_tpm2_arm_smc {
409 u32 global_interrupt;
410 u8 interrupt_flags;
411 u8 operation_flags;
412 u16 reserved;
413 u32 function_id;
414};
415
416/* Values for interrupt_flags above */
417
418#define ACPI_TPM2_INTERRUPT_SUPPORT (1)
419
420/* Values for operation_flags above */
421
422#define ACPI_TPM2_IDLE_SUPPORT (1)
423
424/*******************************************************************************
425 *
426 * UEFI - UEFI Boot optimization Table
427 * Version 1
428 *
429 * Conforms to "Unified Extensible Firmware Interface Specification",
430 * Version 2.3, May 8, 2009
431 *
432 ******************************************************************************/
433
434struct acpi_table_uefi {
435 struct acpi_table_header header; /* Common ACPI table header */
436 u8 identifier[16]; /* UUID identifier */
437 u16 data_offset; /* Offset of remaining data in table */
438};
439
440/*******************************************************************************
441 *
442 * VRTC - Virtual Real Time Clock Table
443 * Version 1
444 *
445 * Conforms to "Simple Firmware Interface Specification",
446 * Draft 0.8.2, Oct 19, 2010
447 * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
448 *
449 ******************************************************************************/
450
451struct acpi_table_vrtc {
452 struct acpi_table_header header; /* Common ACPI table header */
453};
454
455/* VRTC entry */
456
457struct acpi_vrtc_entry {
458 struct acpi_generic_address physical_address;
459 u32 irq;
460};
461
462/*******************************************************************************
463 *
464 * WAET - Windows ACPI Emulated devices Table
465 * Version 1
466 *
467 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
468 *
469 ******************************************************************************/
470
471struct acpi_table_waet {
472 struct acpi_table_header header; /* Common ACPI table header */
473 u32 flags;
474};
475
476/* Masks for Flags field above */
477
478#define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
479#define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
480
481/*******************************************************************************
482 *
483 * WDAT - Watchdog Action Table
484 * Version 1
485 *
486 * Conforms to "Hardware Watchdog Timers Design Specification",
487 * Copyright 2006 Microsoft Corporation.
488 *
489 ******************************************************************************/
490
491struct acpi_table_wdat {
492 struct acpi_table_header header; /* Common ACPI table header */
493 u32 header_length; /* Watchdog Header Length */
494 u16 pci_segment; /* PCI Segment number */
495 u8 pci_bus; /* PCI Bus number */
496 u8 pci_device; /* PCI Device number */
497 u8 pci_function; /* PCI Function number */
498 u8 reserved[3];
499 u32 timer_period; /* Period of one timer count (msec) */
500 u32 max_count; /* Maximum counter value supported */
501 u32 min_count; /* Minimum counter value */
502 u8 flags;
503 u8 reserved2[3];
504 u32 entries; /* Number of watchdog entries that follow */
505};
506
507/* Masks for Flags field above */
508
509#define ACPI_WDAT_ENABLED (1)
510#define ACPI_WDAT_STOPPED 0x80
511
512/* WDAT Instruction Entries (actions) */
513
514struct acpi_wdat_entry {
515 u8 action;
516 u8 instruction;
517 u16 reserved;
518 struct acpi_generic_address register_region;
519 u32 value; /* Value used with Read/Write register */
520 u32 mask; /* Bitmask required for this register instruction */
521};
522
523/* Values for Action field above */
524
525enum acpi_wdat_actions {
526 ACPI_WDAT_RESET = 1,
527 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
528 ACPI_WDAT_GET_COUNTDOWN = 5,
529 ACPI_WDAT_SET_COUNTDOWN = 6,
530 ACPI_WDAT_GET_RUNNING_STATE = 8,
531 ACPI_WDAT_SET_RUNNING_STATE = 9,
532 ACPI_WDAT_GET_STOPPED_STATE = 10,
533 ACPI_WDAT_SET_STOPPED_STATE = 11,
534 ACPI_WDAT_GET_REBOOT = 16,
535 ACPI_WDAT_SET_REBOOT = 17,
536 ACPI_WDAT_GET_SHUTDOWN = 18,
537 ACPI_WDAT_SET_SHUTDOWN = 19,
538 ACPI_WDAT_GET_STATUS = 32,
539 ACPI_WDAT_SET_STATUS = 33,
540 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
541};
542
543/* Values for Instruction field above */
544
545enum acpi_wdat_instructions {
546 ACPI_WDAT_READ_VALUE = 0,
547 ACPI_WDAT_READ_COUNTDOWN = 1,
548 ACPI_WDAT_WRITE_VALUE = 2,
549 ACPI_WDAT_WRITE_COUNTDOWN = 3,
550 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
551 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
552};
553
554/*******************************************************************************
555 *
556 * WDDT - Watchdog Descriptor Table
557 * Version 1
558 *
559 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
560 * Version 001, September 2002
561 *
562 ******************************************************************************/
563
564struct acpi_table_wddt {
565 struct acpi_table_header header; /* Common ACPI table header */
566 u16 spec_version;
567 u16 table_version;
568 u16 pci_vendor_id;
569 struct acpi_generic_address address;
570 u16 max_count; /* Maximum counter value supported */
571 u16 min_count; /* Minimum counter value supported */
572 u16 period;
573 u16 status;
574 u16 capability;
575};
576
577/* Flags for Status field above */
578
579#define ACPI_WDDT_AVAILABLE (1)
580#define ACPI_WDDT_ACTIVE (1<<1)
581#define ACPI_WDDT_TCO_OS_OWNED (1<<2)
582#define ACPI_WDDT_USER_RESET (1<<11)
583#define ACPI_WDDT_WDT_RESET (1<<12)
584#define ACPI_WDDT_POWER_FAIL (1<<13)
585#define ACPI_WDDT_UNKNOWN_RESET (1<<14)
586
587/* Flags for Capability field above */
588
589#define ACPI_WDDT_AUTO_RESET (1)
590#define ACPI_WDDT_ALERT_SUPPORT (1<<1)
591
592/*******************************************************************************
593 *
594 * WDRT - Watchdog Resource Table
595 * Version 1
596 *
597 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
598 * Version 1.01, August 28, 2006
599 *
600 ******************************************************************************/
601
602struct acpi_table_wdrt {
603 struct acpi_table_header header; /* Common ACPI table header */
604 struct acpi_generic_address control_register;
605 struct acpi_generic_address count_register;
606 u16 pci_device_id;
607 u16 pci_vendor_id;
608 u8 pci_bus; /* PCI Bus number */
609 u8 pci_device; /* PCI Device number */
610 u8 pci_function; /* PCI Function number */
611 u8 pci_segment; /* PCI Segment number */
612 u16 max_count; /* Maximum counter value supported */
613 u8 units;
614};
615
616/*******************************************************************************
617 *
618 * WPBT - Windows Platform Environment Table (ACPI 6.0)
619 * Version 1
620 *
621 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
622 *
623 ******************************************************************************/
624
625struct acpi_table_wpbt {
626 struct acpi_table_header header; /* Common ACPI table header */
627 u32 handoff_size;
628 u64 handoff_address;
629 u8 layout;
630 u8 type;
631 u16 arguments_length;
632};
633
634/*******************************************************************************
635 *
636 * WSMT - Windows SMM Security Migrations Table
637 * Version 1
638 *
639 * Conforms to "Windows SMM Security Migrations Table",
640 * Version 1.0, April 18, 2016
641 *
642 ******************************************************************************/
643
644struct acpi_table_wsmt {
645 struct acpi_table_header header; /* Common ACPI table header */
646 u32 protection_flags;
647};
648
649/* Flags for protection_flags field above */
650
651#define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
652#define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
653#define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
654
655/*******************************************************************************
656 *
657 * XENV - Xen Environment Table (ACPI 6.0)
658 * Version 1
659 *
660 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
661 *
662 ******************************************************************************/
663
664struct acpi_table_xenv {
665 struct acpi_table_header header; /* Common ACPI table header */
666 u64 grant_table_address;
667 u64 grant_table_size;
668 u32 event_interrupt;
669 u8 event_flags;
670};
671
672/* Reset to default packing */
673
674#pragma pack()
675
676#endif /* __ACTBL3_H__ */