Loading...
1/******************************************************************************
2 *
3 * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, 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 __ACTBL2_H__
45#define __ACTBL2_H__
46
47/*******************************************************************************
48 *
49 * Additional ACPI Tables (2)
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 defined by third-party specifications, and are
55 * not defined directly by the ACPI specification itself.
56 *
57 ******************************************************************************/
58
59/*
60 * Values for description table header signatures for tables defined in this
61 * file. Useful because they make it more difficult to inadvertently type in
62 * the wrong signature.
63 */
64#define ACPI_SIG_ASF "ASF!" /* Alert Standard Format table */
65#define ACPI_SIG_BOOT "BOOT" /* Simple Boot Flag Table */
66#define ACPI_SIG_DBGP "DBGP" /* Debug Port table */
67#define ACPI_SIG_DMAR "DMAR" /* DMA Remapping table */
68#define ACPI_SIG_HPET "HPET" /* High Precision Event Timer table */
69#define ACPI_SIG_IBFT "IBFT" /* i_sCSI Boot Firmware Table */
70#define ACPI_SIG_IVRS "IVRS" /* I/O Virtualization Reporting Structure */
71#define ACPI_SIG_MCFG "MCFG" /* PCI Memory Mapped Configuration table */
72#define ACPI_SIG_MCHI "MCHI" /* Management Controller Host Interface table */
73#define ACPI_SIG_SLIC "SLIC" /* Software Licensing Description Table */
74#define ACPI_SIG_SPCR "SPCR" /* Serial Port Console Redirection table */
75#define ACPI_SIG_SPMI "SPMI" /* Server Platform Management Interface table */
76#define ACPI_SIG_TCPA "TCPA" /* Trusted Computing Platform Alliance table */
77#define ACPI_SIG_UEFI "UEFI" /* Uefi Boot Optimization Table */
78#define ACPI_SIG_WAET "WAET" /* Windows ACPI Emulated devices Table */
79#define ACPI_SIG_WDAT "WDAT" /* Watchdog Action Table */
80#define ACPI_SIG_WDDT "WDDT" /* Watchdog Timer Description Table */
81#define ACPI_SIG_WDRT "WDRT" /* Watchdog Resource Table */
82
83#ifdef ACPI_UNDEFINED_TABLES
84/*
85 * These tables have been seen in the field, but no definition has been found
86 */
87#define ACPI_SIG_ATKG "ATKG"
88#define ACPI_SIG_GSCI "GSCI" /* GMCH SCI table */
89#define ACPI_SIG_IEIT "IEIT"
90#endif
91
92/*
93 * All tables must be byte-packed to match the ACPI specification, since
94 * the tables are provided by the system BIOS.
95 */
96#pragma pack(1)
97
98/*
99 * Note about bitfields: The u8 type is used for bitfields in ACPI tables.
100 * This is the only type that is even remotely portable. Anything else is not
101 * portable, so do not use any other bitfield types.
102 */
103
104/*******************************************************************************
105 *
106 * ASF - Alert Standard Format table (Signature "ASF!")
107 * Revision 0x10
108 *
109 * Conforms to the Alert Standard Format Specification V2.0, 23 April 2003
110 *
111 ******************************************************************************/
112
113struct acpi_table_asf {
114 struct acpi_table_header header; /* Common ACPI table header */
115};
116
117/* ASF subtable header */
118
119struct acpi_asf_header {
120 u8 type;
121 u8 reserved;
122 u16 length;
123};
124
125/* Values for Type field above */
126
127enum acpi_asf_type {
128 ACPI_ASF_TYPE_INFO = 0,
129 ACPI_ASF_TYPE_ALERT = 1,
130 ACPI_ASF_TYPE_CONTROL = 2,
131 ACPI_ASF_TYPE_BOOT = 3,
132 ACPI_ASF_TYPE_ADDRESS = 4,
133 ACPI_ASF_TYPE_RESERVED = 5
134};
135
136/*
137 * ASF subtables
138 */
139
140/* 0: ASF Information */
141
142struct acpi_asf_info {
143 struct acpi_asf_header header;
144 u8 min_reset_value;
145 u8 min_poll_interval;
146 u16 system_id;
147 u32 mfg_id;
148 u8 flags;
149 u8 reserved2[3];
150};
151
152/* Masks for Flags field above */
153
154#define ACPI_ASF_SMBUS_PROTOCOLS (1)
155
156/* 1: ASF Alerts */
157
158struct acpi_asf_alert {
159 struct acpi_asf_header header;
160 u8 assert_mask;
161 u8 deassert_mask;
162 u8 alerts;
163 u8 data_length;
164};
165
166struct acpi_asf_alert_data {
167 u8 address;
168 u8 command;
169 u8 mask;
170 u8 value;
171 u8 sensor_type;
172 u8 type;
173 u8 offset;
174 u8 source_type;
175 u8 severity;
176 u8 sensor_number;
177 u8 entity;
178 u8 instance;
179};
180
181/* 2: ASF Remote Control */
182
183struct acpi_asf_remote {
184 struct acpi_asf_header header;
185 u8 controls;
186 u8 data_length;
187 u16 reserved2;
188};
189
190struct acpi_asf_control_data {
191 u8 function;
192 u8 address;
193 u8 command;
194 u8 value;
195};
196
197/* 3: ASF RMCP Boot Options */
198
199struct acpi_asf_rmcp {
200 struct acpi_asf_header header;
201 u8 capabilities[7];
202 u8 completion_code;
203 u32 enterprise_id;
204 u8 command;
205 u16 parameter;
206 u16 boot_options;
207 u16 oem_parameters;
208};
209
210/* 4: ASF Address */
211
212struct acpi_asf_address {
213 struct acpi_asf_header header;
214 u8 eprom_address;
215 u8 devices;
216};
217
218/*******************************************************************************
219 *
220 * BOOT - Simple Boot Flag Table
221 * Version 1
222 *
223 * Conforms to the "Simple Boot Flag Specification", Version 2.1
224 *
225 ******************************************************************************/
226
227struct acpi_table_boot {
228 struct acpi_table_header header; /* Common ACPI table header */
229 u8 cmos_index; /* Index in CMOS RAM for the boot register */
230 u8 reserved[3];
231};
232
233/*******************************************************************************
234 *
235 * DBGP - Debug Port table
236 * Version 1
237 *
238 * Conforms to the "Debug Port Specification", Version 1.00, 2/9/2000
239 *
240 ******************************************************************************/
241
242struct acpi_table_dbgp {
243 struct acpi_table_header header; /* Common ACPI table header */
244 u8 type; /* 0=full 16550, 1=subset of 16550 */
245 u8 reserved[3];
246 struct acpi_generic_address debug_port;
247};
248
249/*******************************************************************************
250 *
251 * DMAR - DMA Remapping table
252 * Version 1
253 *
254 * Conforms to "Intel Virtualization Technology for Directed I/O",
255 * Version 1.2, Sept. 2008
256 *
257 ******************************************************************************/
258
259struct acpi_table_dmar {
260 struct acpi_table_header header; /* Common ACPI table header */
261 u8 width; /* Host Address Width */
262 u8 flags;
263 u8 reserved[10];
264};
265
266/* Masks for Flags field above */
267
268#define ACPI_DMAR_INTR_REMAP (1)
269
270/* DMAR subtable header */
271
272struct acpi_dmar_header {
273 u16 type;
274 u16 length;
275};
276
277/* Values for subtable type in struct acpi_dmar_header */
278
279enum acpi_dmar_type {
280 ACPI_DMAR_TYPE_HARDWARE_UNIT = 0,
281 ACPI_DMAR_TYPE_RESERVED_MEMORY = 1,
282 ACPI_DMAR_TYPE_ATSR = 2,
283 ACPI_DMAR_HARDWARE_AFFINITY = 3,
284 ACPI_DMAR_TYPE_RESERVED = 4 /* 4 and greater are reserved */
285};
286
287/* DMAR Device Scope structure */
288
289struct acpi_dmar_device_scope {
290 u8 entry_type;
291 u8 length;
292 u16 reserved;
293 u8 enumeration_id;
294 u8 bus;
295};
296
297/* Values for entry_type in struct acpi_dmar_device_scope */
298
299enum acpi_dmar_scope_type {
300 ACPI_DMAR_SCOPE_TYPE_NOT_USED = 0,
301 ACPI_DMAR_SCOPE_TYPE_ENDPOINT = 1,
302 ACPI_DMAR_SCOPE_TYPE_BRIDGE = 2,
303 ACPI_DMAR_SCOPE_TYPE_IOAPIC = 3,
304 ACPI_DMAR_SCOPE_TYPE_HPET = 4,
305 ACPI_DMAR_SCOPE_TYPE_RESERVED = 5 /* 5 and greater are reserved */
306};
307
308struct acpi_dmar_pci_path {
309 u8 dev;
310 u8 fn;
311};
312
313/*
314 * DMAR Sub-tables, correspond to Type in struct acpi_dmar_header
315 */
316
317/* 0: Hardware Unit Definition */
318
319struct acpi_dmar_hardware_unit {
320 struct acpi_dmar_header header;
321 u8 flags;
322 u8 reserved;
323 u16 segment;
324 u64 address; /* Register Base Address */
325};
326
327/* Masks for Flags field above */
328
329#define ACPI_DMAR_INCLUDE_ALL (1)
330
331/* 1: Reserved Memory Defininition */
332
333struct acpi_dmar_reserved_memory {
334 struct acpi_dmar_header header;
335 u16 reserved;
336 u16 segment;
337 u64 base_address; /* 4_k aligned base address */
338 u64 end_address; /* 4_k aligned limit address */
339};
340
341/* Masks for Flags field above */
342
343#define ACPI_DMAR_ALLOW_ALL (1)
344
345/* 2: Root Port ATS Capability Reporting Structure */
346
347struct acpi_dmar_atsr {
348 struct acpi_dmar_header header;
349 u8 flags;
350 u8 reserved;
351 u16 segment;
352};
353
354/* Masks for Flags field above */
355
356#define ACPI_DMAR_ALL_PORTS (1)
357
358/* 3: Remapping Hardware Static Affinity Structure */
359
360struct acpi_dmar_rhsa {
361 struct acpi_dmar_header header;
362 u32 reserved;
363 u64 base_address;
364 u32 proximity_domain;
365};
366
367/*******************************************************************************
368 *
369 * HPET - High Precision Event Timer table
370 * Version 1
371 *
372 * Conforms to "IA-PC HPET (High Precision Event Timers) Specification",
373 * Version 1.0a, October 2004
374 *
375 ******************************************************************************/
376
377struct acpi_table_hpet {
378 struct acpi_table_header header; /* Common ACPI table header */
379 u32 id; /* Hardware ID of event timer block */
380 struct acpi_generic_address address; /* Address of event timer block */
381 u8 sequence; /* HPET sequence number */
382 u16 minimum_tick; /* Main counter min tick, periodic mode */
383 u8 flags;
384};
385
386/* Masks for Flags field above */
387
388#define ACPI_HPET_PAGE_PROTECT_MASK (3)
389
390/* Values for Page Protect flags */
391
392enum acpi_hpet_page_protect {
393 ACPI_HPET_NO_PAGE_PROTECT = 0,
394 ACPI_HPET_PAGE_PROTECT4 = 1,
395 ACPI_HPET_PAGE_PROTECT64 = 2
396};
397
398/*******************************************************************************
399 *
400 * IBFT - Boot Firmware Table
401 * Version 1
402 *
403 * Conforms to "iSCSI Boot Firmware Table (iBFT) as Defined in ACPI 3.0b
404 * Specification", Version 1.01, March 1, 2007
405 *
406 * Note: It appears that this table is not intended to appear in the RSDT/XSDT.
407 * Therefore, it is not currently supported by the disassembler.
408 *
409 ******************************************************************************/
410
411struct acpi_table_ibft {
412 struct acpi_table_header header; /* Common ACPI table header */
413 u8 reserved[12];
414};
415
416/* IBFT common subtable header */
417
418struct acpi_ibft_header {
419 u8 type;
420 u8 version;
421 u16 length;
422 u8 index;
423 u8 flags;
424};
425
426/* Values for Type field above */
427
428enum acpi_ibft_type {
429 ACPI_IBFT_TYPE_NOT_USED = 0,
430 ACPI_IBFT_TYPE_CONTROL = 1,
431 ACPI_IBFT_TYPE_INITIATOR = 2,
432 ACPI_IBFT_TYPE_NIC = 3,
433 ACPI_IBFT_TYPE_TARGET = 4,
434 ACPI_IBFT_TYPE_EXTENSIONS = 5,
435 ACPI_IBFT_TYPE_RESERVED = 6 /* 6 and greater are reserved */
436};
437
438/* IBFT subtables */
439
440struct acpi_ibft_control {
441 struct acpi_ibft_header header;
442 u16 extensions;
443 u16 initiator_offset;
444 u16 nic0_offset;
445 u16 target0_offset;
446 u16 nic1_offset;
447 u16 target1_offset;
448};
449
450struct acpi_ibft_initiator {
451 struct acpi_ibft_header header;
452 u8 sns_server[16];
453 u8 slp_server[16];
454 u8 primary_server[16];
455 u8 secondary_server[16];
456 u16 name_length;
457 u16 name_offset;
458};
459
460struct acpi_ibft_nic {
461 struct acpi_ibft_header header;
462 u8 ip_address[16];
463 u8 subnet_mask_prefix;
464 u8 origin;
465 u8 gateway[16];
466 u8 primary_dns[16];
467 u8 secondary_dns[16];
468 u8 dhcp[16];
469 u16 vlan;
470 u8 mac_address[6];
471 u16 pci_address;
472 u16 name_length;
473 u16 name_offset;
474};
475
476struct acpi_ibft_target {
477 struct acpi_ibft_header header;
478 u8 target_ip_address[16];
479 u16 target_ip_socket;
480 u8 target_boot_lun[8];
481 u8 chap_type;
482 u8 nic_association;
483 u16 target_name_length;
484 u16 target_name_offset;
485 u16 chap_name_length;
486 u16 chap_name_offset;
487 u16 chap_secret_length;
488 u16 chap_secret_offset;
489 u16 reverse_chap_name_length;
490 u16 reverse_chap_name_offset;
491 u16 reverse_chap_secret_length;
492 u16 reverse_chap_secret_offset;
493};
494
495/*******************************************************************************
496 *
497 * IVRS - I/O Virtualization Reporting Structure
498 * Version 1
499 *
500 * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
501 * Revision 1.26, February 2009.
502 *
503 ******************************************************************************/
504
505struct acpi_table_ivrs {
506 struct acpi_table_header header; /* Common ACPI table header */
507 u32 info; /* Common virtualization info */
508 u64 reserved;
509};
510
511/* Values for Info field above */
512
513#define ACPI_IVRS_PHYSICAL_SIZE 0x00007F00 /* 7 bits, physical address size */
514#define ACPI_IVRS_VIRTUAL_SIZE 0x003F8000 /* 7 bits, virtual address size */
515#define ACPI_IVRS_ATS_RESERVED 0x00400000 /* ATS address translation range reserved */
516
517/* IVRS subtable header */
518
519struct acpi_ivrs_header {
520 u8 type; /* Subtable type */
521 u8 flags;
522 u16 length; /* Subtable length */
523 u16 device_id; /* ID of IOMMU */
524};
525
526/* Values for subtable Type above */
527
528enum acpi_ivrs_type {
529 ACPI_IVRS_TYPE_HARDWARE = 0x10,
530 ACPI_IVRS_TYPE_MEMORY1 = 0x20,
531 ACPI_IVRS_TYPE_MEMORY2 = 0x21,
532 ACPI_IVRS_TYPE_MEMORY3 = 0x22
533};
534
535/* Masks for Flags field above for IVHD subtable */
536
537#define ACPI_IVHD_TT_ENABLE (1)
538#define ACPI_IVHD_PASS_PW (1<<1)
539#define ACPI_IVHD_RES_PASS_PW (1<<2)
540#define ACPI_IVHD_ISOC (1<<3)
541#define ACPI_IVHD_IOTLB (1<<4)
542
543/* Masks for Flags field above for IVMD subtable */
544
545#define ACPI_IVMD_UNITY (1)
546#define ACPI_IVMD_READ (1<<1)
547#define ACPI_IVMD_WRITE (1<<2)
548#define ACPI_IVMD_EXCLUSION_RANGE (1<<3)
549
550/*
551 * IVRS subtables, correspond to Type in struct acpi_ivrs_header
552 */
553
554/* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
555
556struct acpi_ivrs_hardware {
557 struct acpi_ivrs_header header;
558 u16 capability_offset; /* Offset for IOMMU control fields */
559 u64 base_address; /* IOMMU control registers */
560 u16 pci_segment_group;
561 u16 info; /* MSI number and unit ID */
562 u32 reserved;
563};
564
565/* Masks for Info field above */
566
567#define ACPI_IVHD_MSI_NUMBER_MASK 0x001F /* 5 bits, MSI message number */
568#define ACPI_IVHD_UNIT_ID_MASK 0x1F00 /* 5 bits, unit_iD */
569
570/*
571 * Device Entries for IVHD subtable, appear after struct acpi_ivrs_hardware structure.
572 * Upper two bits of the Type field are the (encoded) length of the structure.
573 * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
574 * are reserved for future use but not defined.
575 */
576struct acpi_ivrs_de_header {
577 u8 type;
578 u16 id;
579 u8 data_setting;
580};
581
582/* Length of device entry is in the top two bits of Type field above */
583
584#define ACPI_IVHD_ENTRY_LENGTH 0xC0
585
586/* Values for device entry Type field above */
587
588enum acpi_ivrs_device_entry_type {
589 /* 4-byte device entries, all use struct acpi_ivrs_device4 */
590
591 ACPI_IVRS_TYPE_PAD4 = 0,
592 ACPI_IVRS_TYPE_ALL = 1,
593 ACPI_IVRS_TYPE_SELECT = 2,
594 ACPI_IVRS_TYPE_START = 3,
595 ACPI_IVRS_TYPE_END = 4,
596
597 /* 8-byte device entries */
598
599 ACPI_IVRS_TYPE_PAD8 = 64,
600 ACPI_IVRS_TYPE_NOT_USED = 65,
601 ACPI_IVRS_TYPE_ALIAS_SELECT = 66, /* Uses struct acpi_ivrs_device8a */
602 ACPI_IVRS_TYPE_ALIAS_START = 67, /* Uses struct acpi_ivrs_device8a */
603 ACPI_IVRS_TYPE_EXT_SELECT = 70, /* Uses struct acpi_ivrs_device8b */
604 ACPI_IVRS_TYPE_EXT_START = 71, /* Uses struct acpi_ivrs_device8b */
605 ACPI_IVRS_TYPE_SPECIAL = 72 /* Uses struct acpi_ivrs_device8c */
606};
607
608/* Values for Data field above */
609
610#define ACPI_IVHD_INIT_PASS (1)
611#define ACPI_IVHD_EINT_PASS (1<<1)
612#define ACPI_IVHD_NMI_PASS (1<<2)
613#define ACPI_IVHD_SYSTEM_MGMT (3<<4)
614#define ACPI_IVHD_LINT0_PASS (1<<6)
615#define ACPI_IVHD_LINT1_PASS (1<<7)
616
617/* Types 0-4: 4-byte device entry */
618
619struct acpi_ivrs_device4 {
620 struct acpi_ivrs_de_header header;
621};
622
623/* Types 66-67: 8-byte device entry */
624
625struct acpi_ivrs_device8a {
626 struct acpi_ivrs_de_header header;
627 u8 reserved1;
628 u16 used_id;
629 u8 reserved2;
630};
631
632/* Types 70-71: 8-byte device entry */
633
634struct acpi_ivrs_device8b {
635 struct acpi_ivrs_de_header header;
636 u32 extended_data;
637};
638
639/* Values for extended_data above */
640
641#define ACPI_IVHD_ATS_DISABLED (1<<31)
642
643/* Type 72: 8-byte device entry */
644
645struct acpi_ivrs_device8c {
646 struct acpi_ivrs_de_header header;
647 u8 handle;
648 u16 used_id;
649 u8 variety;
650};
651
652/* Values for Variety field above */
653
654#define ACPI_IVHD_IOAPIC 1
655#define ACPI_IVHD_HPET 2
656
657/* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
658
659struct acpi_ivrs_memory {
660 struct acpi_ivrs_header header;
661 u16 aux_data;
662 u64 reserved;
663 u64 start_address;
664 u64 memory_length;
665};
666
667/*******************************************************************************
668 *
669 * MCFG - PCI Memory Mapped Configuration table and sub-table
670 * Version 1
671 *
672 * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
673 *
674 ******************************************************************************/
675
676struct acpi_table_mcfg {
677 struct acpi_table_header header; /* Common ACPI table header */
678 u8 reserved[8];
679};
680
681/* Subtable */
682
683struct acpi_mcfg_allocation {
684 u64 address; /* Base address, processor-relative */
685 u16 pci_segment; /* PCI segment group number */
686 u8 start_bus_number; /* Starting PCI Bus number */
687 u8 end_bus_number; /* Final PCI Bus number */
688 u32 reserved;
689};
690
691/*******************************************************************************
692 *
693 * MCHI - Management Controller Host Interface Table
694 * Version 1
695 *
696 * Conforms to "Management Component Transport Protocol (MCTP) Host
697 * Interface Specification", Revision 1.0.0a, October 13, 2009
698 *
699 ******************************************************************************/
700
701struct acpi_table_mchi {
702 struct acpi_table_header header; /* Common ACPI table header */
703 u8 interface_type;
704 u8 protocol;
705 u64 protocol_data;
706 u8 interrupt_type;
707 u8 gpe;
708 u8 pci_device_flag;
709 u32 global_interrupt;
710 struct acpi_generic_address control_register;
711 u8 pci_segment;
712 u8 pci_bus;
713 u8 pci_device;
714 u8 pci_function;
715};
716
717/*******************************************************************************
718 *
719 * SLIC - Software Licensing Description Table
720 * Version 1
721 *
722 * Conforms to "OEM Activation 2.0 for Windows Vista Operating Systems",
723 * Copyright 2006
724 *
725 ******************************************************************************/
726
727/* Basic SLIC table is only the common ACPI header */
728
729struct acpi_table_slic {
730 struct acpi_table_header header; /* Common ACPI table header */
731};
732
733/* Common SLIC subtable header */
734
735struct acpi_slic_header {
736 u32 type;
737 u32 length;
738};
739
740/* Values for Type field above */
741
742enum acpi_slic_type {
743 ACPI_SLIC_TYPE_PUBLIC_KEY = 0,
744 ACPI_SLIC_TYPE_WINDOWS_MARKER = 1,
745 ACPI_SLIC_TYPE_RESERVED = 2 /* 2 and greater are reserved */
746};
747
748/*
749 * SLIC Sub-tables, correspond to Type in struct acpi_slic_header
750 */
751
752/* 0: Public Key Structure */
753
754struct acpi_slic_key {
755 struct acpi_slic_header header;
756 u8 key_type;
757 u8 version;
758 u16 reserved;
759 u32 algorithm;
760 char magic[4];
761 u32 bit_length;
762 u32 exponent;
763 u8 modulus[128];
764};
765
766/* 1: Windows Marker Structure */
767
768struct acpi_slic_marker {
769 struct acpi_slic_header header;
770 u32 version;
771 char oem_id[ACPI_OEM_ID_SIZE]; /* ASCII OEM identification */
772 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */
773 char windows_flag[8];
774 u32 slic_version;
775 u8 reserved[16];
776 u8 signature[128];
777};
778
779/*******************************************************************************
780 *
781 * SPCR - Serial Port Console Redirection table
782 * Version 1
783 *
784 * Conforms to "Serial Port Console Redirection Table",
785 * Version 1.00, January 11, 2002
786 *
787 ******************************************************************************/
788
789struct acpi_table_spcr {
790 struct acpi_table_header header; /* Common ACPI table header */
791 u8 interface_type; /* 0=full 16550, 1=subset of 16550 */
792 u8 reserved[3];
793 struct acpi_generic_address serial_port;
794 u8 interrupt_type;
795 u8 pc_interrupt;
796 u32 interrupt;
797 u8 baud_rate;
798 u8 parity;
799 u8 stop_bits;
800 u8 flow_control;
801 u8 terminal_type;
802 u8 reserved1;
803 u16 pci_device_id;
804 u16 pci_vendor_id;
805 u8 pci_bus;
806 u8 pci_device;
807 u8 pci_function;
808 u32 pci_flags;
809 u8 pci_segment;
810 u32 reserved2;
811};
812
813/* Masks for pci_flags field above */
814
815#define ACPI_SPCR_DO_NOT_DISABLE (1)
816
817/*******************************************************************************
818 *
819 * SPMI - Server Platform Management Interface table
820 * Version 5
821 *
822 * Conforms to "Intelligent Platform Management Interface Specification
823 * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
824 * June 12, 2009 markup.
825 *
826 ******************************************************************************/
827
828struct acpi_table_spmi {
829 struct acpi_table_header header; /* Common ACPI table header */
830 u8 interface_type;
831 u8 reserved; /* Must be 1 */
832 u16 spec_revision; /* Version of IPMI */
833 u8 interrupt_type;
834 u8 gpe_number; /* GPE assigned */
835 u8 reserved1;
836 u8 pci_device_flag;
837 u32 interrupt;
838 struct acpi_generic_address ipmi_register;
839 u8 pci_segment;
840 u8 pci_bus;
841 u8 pci_device;
842 u8 pci_function;
843 u8 reserved2;
844};
845
846/* Values for interface_type above */
847
848enum acpi_spmi_interface_types {
849 ACPI_SPMI_NOT_USED = 0,
850 ACPI_SPMI_KEYBOARD = 1,
851 ACPI_SPMI_SMI = 2,
852 ACPI_SPMI_BLOCK_TRANSFER = 3,
853 ACPI_SPMI_SMBUS = 4,
854 ACPI_SPMI_RESERVED = 5 /* 5 and above are reserved */
855};
856
857/*******************************************************************************
858 *
859 * TCPA - Trusted Computing Platform Alliance table
860 * Version 1
861 *
862 * Conforms to "TCG PC Specific Implementation Specification",
863 * Version 1.1, August 18, 2003
864 *
865 ******************************************************************************/
866
867struct acpi_table_tcpa {
868 struct acpi_table_header header; /* Common ACPI table header */
869 u16 reserved;
870 u32 max_log_length; /* Maximum length for the event log area */
871 u64 log_address; /* Address of the event log area */
872};
873
874/*******************************************************************************
875 *
876 * UEFI - UEFI Boot optimization Table
877 * Version 1
878 *
879 * Conforms to "Unified Extensible Firmware Interface Specification",
880 * Version 2.3, May 8, 2009
881 *
882 ******************************************************************************/
883
884struct acpi_table_uefi {
885 struct acpi_table_header header; /* Common ACPI table header */
886 u8 identifier[16]; /* UUID identifier */
887 u16 data_offset; /* Offset of remaining data in table */
888};
889
890/*******************************************************************************
891 *
892 * WAET - Windows ACPI Emulated devices Table
893 * Version 1
894 *
895 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
896 *
897 ******************************************************************************/
898
899struct acpi_table_waet {
900 struct acpi_table_header header; /* Common ACPI table header */
901 u32 flags;
902};
903
904/* Masks for Flags field above */
905
906#define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
907#define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
908
909/*******************************************************************************
910 *
911 * WDAT - Watchdog Action Table
912 * Version 1
913 *
914 * Conforms to "Hardware Watchdog Timers Design Specification",
915 * Copyright 2006 Microsoft Corporation.
916 *
917 ******************************************************************************/
918
919struct acpi_table_wdat {
920 struct acpi_table_header header; /* Common ACPI table header */
921 u32 header_length; /* Watchdog Header Length */
922 u16 pci_segment; /* PCI Segment number */
923 u8 pci_bus; /* PCI Bus number */
924 u8 pci_device; /* PCI Device number */
925 u8 pci_function; /* PCI Function number */
926 u8 reserved[3];
927 u32 timer_period; /* Period of one timer count (msec) */
928 u32 max_count; /* Maximum counter value supported */
929 u32 min_count; /* Minimum counter value */
930 u8 flags;
931 u8 reserved2[3];
932 u32 entries; /* Number of watchdog entries that follow */
933};
934
935/* Masks for Flags field above */
936
937#define ACPI_WDAT_ENABLED (1)
938#define ACPI_WDAT_STOPPED 0x80
939
940/* WDAT Instruction Entries (actions) */
941
942struct acpi_wdat_entry {
943 u8 action;
944 u8 instruction;
945 u16 reserved;
946 struct acpi_generic_address register_region;
947 u32 value; /* Value used with Read/Write register */
948 u32 mask; /* Bitmask required for this register instruction */
949};
950
951/* Values for Action field above */
952
953enum acpi_wdat_actions {
954 ACPI_WDAT_RESET = 1,
955 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
956 ACPI_WDAT_GET_COUNTDOWN = 5,
957 ACPI_WDAT_SET_COUNTDOWN = 6,
958 ACPI_WDAT_GET_RUNNING_STATE = 8,
959 ACPI_WDAT_SET_RUNNING_STATE = 9,
960 ACPI_WDAT_GET_STOPPED_STATE = 10,
961 ACPI_WDAT_SET_STOPPED_STATE = 11,
962 ACPI_WDAT_GET_REBOOT = 16,
963 ACPI_WDAT_SET_REBOOT = 17,
964 ACPI_WDAT_GET_SHUTDOWN = 18,
965 ACPI_WDAT_SET_SHUTDOWN = 19,
966 ACPI_WDAT_GET_STATUS = 32,
967 ACPI_WDAT_SET_STATUS = 33,
968 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
969};
970
971/* Values for Instruction field above */
972
973enum acpi_wdat_instructions {
974 ACPI_WDAT_READ_VALUE = 0,
975 ACPI_WDAT_READ_COUNTDOWN = 1,
976 ACPI_WDAT_WRITE_VALUE = 2,
977 ACPI_WDAT_WRITE_COUNTDOWN = 3,
978 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
979 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
980};
981
982/*******************************************************************************
983 *
984 * WDDT - Watchdog Descriptor Table
985 * Version 1
986 *
987 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
988 * Version 001, September 2002
989 *
990 ******************************************************************************/
991
992struct acpi_table_wddt {
993 struct acpi_table_header header; /* Common ACPI table header */
994 u16 spec_version;
995 u16 table_version;
996 u16 pci_vendor_id;
997 struct acpi_generic_address address;
998 u16 max_count; /* Maximum counter value supported */
999 u16 min_count; /* Minimum counter value supported */
1000 u16 period;
1001 u16 status;
1002 u16 capability;
1003};
1004
1005/* Flags for Status field above */
1006
1007#define ACPI_WDDT_AVAILABLE (1)
1008#define ACPI_WDDT_ACTIVE (1<<1)
1009#define ACPI_WDDT_TCO_OS_OWNED (1<<2)
1010#define ACPI_WDDT_USER_RESET (1<<11)
1011#define ACPI_WDDT_WDT_RESET (1<<12)
1012#define ACPI_WDDT_POWER_FAIL (1<<13)
1013#define ACPI_WDDT_UNKNOWN_RESET (1<<14)
1014
1015/* Flags for Capability field above */
1016
1017#define ACPI_WDDT_AUTO_RESET (1)
1018#define ACPI_WDDT_ALERT_SUPPORT (1<<1)
1019
1020/*******************************************************************************
1021 *
1022 * WDRT - Watchdog Resource Table
1023 * Version 1
1024 *
1025 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
1026 * Version 1.01, August 28, 2006
1027 *
1028 ******************************************************************************/
1029
1030struct acpi_table_wdrt {
1031 struct acpi_table_header header; /* Common ACPI table header */
1032 struct acpi_generic_address control_register;
1033 struct acpi_generic_address count_register;
1034 u16 pci_device_id;
1035 u16 pci_vendor_id;
1036 u8 pci_bus; /* PCI Bus number */
1037 u8 pci_device; /* PCI Device number */
1038 u8 pci_function; /* PCI Function number */
1039 u8 pci_segment; /* PCI Segment number */
1040 u16 max_count; /* Maximum counter value supported */
1041 u8 units;
1042};
1043
1044/* Reset to default packing */
1045
1046#pragma pack()
1047
1048#endif /* __ACTBL2_H__ */
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
5 *
6 * Copyright (C) 2000 - 2022, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef __ACTBL2_H__
11#define __ACTBL2_H__
12
13/*******************************************************************************
14 *
15 * Additional ACPI Tables (2)
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_AGDI "AGDI" /* Arm Generic Diagnostic Dump and Reset Device Interface */
28#define ACPI_SIG_APMT "APMT" /* Arm Performance Monitoring Unit table */
29#define ACPI_SIG_BDAT "BDAT" /* BIOS Data ACPI Table */
30#define ACPI_SIG_CCEL "CCEL" /* CC Event Log Table */
31#define ACPI_SIG_CDAT "CDAT" /* Coherent Device Attribute Table */
32#define ACPI_SIG_IORT "IORT" /* IO Remapping Table */
33#define ACPI_SIG_IVRS "IVRS" /* I/O Virtualization Reporting Structure */
34#define ACPI_SIG_LPIT "LPIT" /* Low Power Idle Table */
35#define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
36#define ACPI_SIG_MCFG "MCFG" /* PCI Memory Mapped Configuration table */
37#define ACPI_SIG_MCHI "MCHI" /* Management Controller Host Interface table */
38#define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
39#define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
40#define ACPI_SIG_NFIT "NFIT" /* NVDIMM Firmware Interface Table */
41#define ACPI_SIG_NHLT "NHLT" /* Non HD Audio Link Table */
42#define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
43#define ACPI_SIG_PDTT "PDTT" /* Platform Debug Trigger Table */
44#define ACPI_SIG_PHAT "PHAT" /* Platform Health Assessment Table */
45#define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
46#define ACPI_SIG_PPTT "PPTT" /* Processor Properties Topology Table */
47#define ACPI_SIG_PRMT "PRMT" /* Platform Runtime Mechanism Table */
48#define ACPI_SIG_RASF "RASF" /* RAS Feature table */
49#define ACPI_SIG_RGRT "RGRT" /* Regulatory Graphics Resource Table */
50#define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
51#define ACPI_SIG_SDEI "SDEI" /* Software Delegated Exception Interface Table */
52#define ACPI_SIG_SDEV "SDEV" /* Secure Devices table */
53#define ACPI_SIG_SVKL "SVKL" /* Storage Volume Key Location Table */
54#define ACPI_SIG_TDEL "TDEL" /* TD Event Log Table */
55
56/*
57 * All tables must be byte-packed to match the ACPI specification, since
58 * the tables are provided by the system BIOS.
59 */
60#pragma pack(1)
61
62/*
63 * Note: C bitfields are not used for this reason:
64 *
65 * "Bitfields are great and easy to read, but unfortunately the C language
66 * does not specify the layout of bitfields in memory, which means they are
67 * essentially useless for dealing with packed data in on-disk formats or
68 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
69 * this decision was a design error in C. Ritchie could have picked an order
70 * and stuck with it." Norman Ramsey.
71 * See http://stackoverflow.com/a/1053662/41661
72 */
73
74/*******************************************************************************
75 *
76 * AEST - Arm Error Source Table
77 *
78 * Conforms to: ACPI for the Armv8 RAS Extensions 1.1 Platform Design Document
79 * September 2020.
80 *
81 ******************************************************************************/
82
83struct acpi_table_aest {
84 struct acpi_table_header header;
85 void *node_array[];
86};
87
88/* Common Subtable header - one per Node Structure (Subtable) */
89
90struct acpi_aest_hdr {
91 u8 type;
92 u16 length;
93 u8 reserved;
94 u32 node_specific_offset;
95 u32 node_interface_offset;
96 u32 node_interrupt_offset;
97 u32 node_interrupt_count;
98 u64 timestamp_rate;
99 u64 reserved1;
100 u64 error_injection_rate;
101};
102
103/* Values for Type above */
104
105#define ACPI_AEST_PROCESSOR_ERROR_NODE 0
106#define ACPI_AEST_MEMORY_ERROR_NODE 1
107#define ACPI_AEST_SMMU_ERROR_NODE 2
108#define ACPI_AEST_VENDOR_ERROR_NODE 3
109#define ACPI_AEST_GIC_ERROR_NODE 4
110#define ACPI_AEST_NODE_TYPE_RESERVED 5 /* 5 and above are reserved */
111
112/*
113 * AEST subtables (Error nodes)
114 */
115
116/* 0: Processor Error */
117
118typedef struct acpi_aest_processor {
119 u32 processor_id;
120 u8 resource_type;
121 u8 reserved;
122 u8 flags;
123 u8 revision;
124 u64 processor_affinity;
125
126} acpi_aest_processor;
127
128/* Values for resource_type above, related structs below */
129
130#define ACPI_AEST_CACHE_RESOURCE 0
131#define ACPI_AEST_TLB_RESOURCE 1
132#define ACPI_AEST_GENERIC_RESOURCE 2
133#define ACPI_AEST_RESOURCE_RESERVED 3 /* 3 and above are reserved */
134
135/* 0R: Processor Cache Resource Substructure */
136
137typedef struct acpi_aest_processor_cache {
138 u32 cache_reference;
139 u32 reserved;
140
141} acpi_aest_processor_cache;
142
143/* Values for cache_type above */
144
145#define ACPI_AEST_CACHE_DATA 0
146#define ACPI_AEST_CACHE_INSTRUCTION 1
147#define ACPI_AEST_CACHE_UNIFIED 2
148#define ACPI_AEST_CACHE_RESERVED 3 /* 3 and above are reserved */
149
150/* 1R: Processor TLB Resource Substructure */
151
152typedef struct acpi_aest_processor_tlb {
153 u32 tlb_level;
154 u32 reserved;
155
156} acpi_aest_processor_tlb;
157
158/* 2R: Processor Generic Resource Substructure */
159
160typedef struct acpi_aest_processor_generic {
161 u32 resource;
162
163} acpi_aest_processor_generic;
164
165/* 1: Memory Error */
166
167typedef struct acpi_aest_memory {
168 u32 srat_proximity_domain;
169
170} acpi_aest_memory;
171
172/* 2: Smmu Error */
173
174typedef struct acpi_aest_smmu {
175 u32 iort_node_reference;
176 u32 subcomponent_reference;
177
178} acpi_aest_smmu;
179
180/* 3: Vendor Defined */
181
182typedef struct acpi_aest_vendor {
183 u32 acpi_hid;
184 u32 acpi_uid;
185 u8 vendor_specific_data[16];
186
187} acpi_aest_vendor;
188
189/* 4: Gic Error */
190
191typedef struct acpi_aest_gic {
192 u32 interface_type;
193 u32 instance_id;
194
195} acpi_aest_gic;
196
197/* Values for interface_type above */
198
199#define ACPI_AEST_GIC_CPU 0
200#define ACPI_AEST_GIC_DISTRIBUTOR 1
201#define ACPI_AEST_GIC_REDISTRIBUTOR 2
202#define ACPI_AEST_GIC_ITS 3
203#define ACPI_AEST_GIC_RESERVED 4 /* 4 and above are reserved */
204
205/* Node Interface Structure */
206
207typedef struct acpi_aest_node_interface {
208 u8 type;
209 u8 reserved[3];
210 u32 flags;
211 u64 address;
212 u32 error_record_index;
213 u32 error_record_count;
214 u64 error_record_implemented;
215 u64 error_status_reporting;
216 u64 addressing_mode;
217
218} acpi_aest_node_interface;
219
220/* Values for Type field above */
221
222#define ACPI_AEST_NODE_SYSTEM_REGISTER 0
223#define ACPI_AEST_NODE_MEMORY_MAPPED 1
224#define ACPI_AEST_XFACE_RESERVED 2 /* 2 and above are reserved */
225
226/* Node Interrupt Structure */
227
228typedef struct acpi_aest_node_interrupt {
229 u8 type;
230 u8 reserved[2];
231 u8 flags;
232 u32 gsiv;
233 u8 iort_id;
234 u8 reserved1[3];
235
236} acpi_aest_node_interrupt;
237
238/* Values for Type field above */
239
240#define ACPI_AEST_NODE_FAULT_HANDLING 0
241#define ACPI_AEST_NODE_ERROR_RECOVERY 1
242#define ACPI_AEST_XRUPT_RESERVED 2 /* 2 and above are reserved */
243
244/*******************************************************************************
245 * AGDI - Arm Generic Diagnostic Dump and Reset Device Interface
246 *
247 * Conforms to "ACPI for Arm Components 1.1, Platform Design Document"
248 * ARM DEN0093 v1.1
249 *
250 ******************************************************************************/
251struct acpi_table_agdi {
252 struct acpi_table_header header; /* Common ACPI table header */
253 u8 flags;
254 u8 reserved[3];
255 u32 sdei_event;
256 u32 gsiv;
257};
258
259/* Mask for Flags field above */
260
261#define ACPI_AGDI_SIGNALING_MODE (1)
262
263/*******************************************************************************
264 *
265 * APMT - ARM Performance Monitoring Unit Table
266 *
267 * Conforms to:
268 * ARM Performance Monitoring Unit Architecture 1.0 Platform Design Document
269 * ARM DEN0117 v1.0 November 25, 2021
270 *
271 ******************************************************************************/
272
273struct acpi_table_apmt {
274 struct acpi_table_header header; /* Common ACPI table header */
275};
276
277#define ACPI_APMT_NODE_ID_LENGTH 4
278
279/*
280 * APMT subtables
281 */
282struct acpi_apmt_node {
283 u16 length;
284 u8 flags;
285 u8 type;
286 u32 id;
287 u64 inst_primary;
288 u32 inst_secondary;
289 u64 base_address0;
290 u64 base_address1;
291 u32 ovflw_irq;
292 u32 reserved;
293 u32 ovflw_irq_flags;
294 u32 proc_affinity;
295 u32 impl_id;
296};
297
298/* Masks for Flags field above */
299
300#define ACPI_APMT_FLAGS_DUAL_PAGE (1<<0)
301#define ACPI_APMT_FLAGS_AFFINITY (1<<1)
302#define ACPI_APMT_FLAGS_ATOMIC (1<<2)
303
304/* Values for Flags dual page field above */
305
306#define ACPI_APMT_FLAGS_DUAL_PAGE_NSUPP (0<<0)
307#define ACPI_APMT_FLAGS_DUAL_PAGE_SUPP (1<<0)
308
309/* Values for Flags processor affinity field above */
310#define ACPI_APMT_FLAGS_AFFINITY_PROC (0<<1)
311#define ACPI_APMT_FLAGS_AFFINITY_PROC_CONTAINER (1<<1)
312
313/* Values for Flags 64-bit atomic field above */
314#define ACPI_APMT_FLAGS_ATOMIC_NSUPP (0<<2)
315#define ACPI_APMT_FLAGS_ATOMIC_SUPP (1<<2)
316
317/* Values for Type field above */
318
319enum acpi_apmt_node_type {
320 ACPI_APMT_NODE_TYPE_MC = 0x00,
321 ACPI_APMT_NODE_TYPE_SMMU = 0x01,
322 ACPI_APMT_NODE_TYPE_PCIE_ROOT = 0x02,
323 ACPI_APMT_NODE_TYPE_ACPI = 0x03,
324 ACPI_APMT_NODE_TYPE_CACHE = 0x04,
325 ACPI_APMT_NODE_TYPE_COUNT
326};
327
328/* Masks for ovflw_irq_flags field above */
329
330#define ACPI_APMT_OVFLW_IRQ_FLAGS_MODE (1<<0)
331#define ACPI_APMT_OVFLW_IRQ_FLAGS_TYPE (1<<1)
332
333/* Values for ovflw_irq_flags mode field above */
334
335#define ACPI_APMT_OVFLW_IRQ_FLAGS_MODE_LEVEL (0<<0)
336#define ACPI_APMT_OVFLW_IRQ_FLAGS_MODE_EDGE (1<<0)
337
338/* Values for ovflw_irq_flags type field above */
339
340#define ACPI_APMT_OVFLW_IRQ_FLAGS_TYPE_WIRED (0<<1)
341
342/*******************************************************************************
343 *
344 * BDAT - BIOS Data ACPI Table
345 *
346 * Conforms to "BIOS Data ACPI Table", Interface Specification v4.0 Draft 5
347 * Nov 2020
348 *
349 ******************************************************************************/
350
351struct acpi_table_bdat {
352 struct acpi_table_header header;
353 struct acpi_generic_address gas;
354};
355
356/*******************************************************************************
357 *
358 * CCEL - CC-Event Log
359 * From: "Guest-Host-Communication Interface (GHCI) for Intel
360 * Trust Domain Extensions (Intel TDX)". Feb 2022
361 *
362 ******************************************************************************/
363
364struct acpi_table_ccel {
365 struct acpi_table_header header; /* Common ACPI table header */
366 u8 CCtype;
367 u8 Ccsub_type;
368 u16 reserved;
369 u64 log_area_minimum_length;
370 u64 log_area_start_address;
371};
372
373/*******************************************************************************
374 *
375 * IORT - IO Remapping Table
376 *
377 * Conforms to "IO Remapping Table System Software on ARM Platforms",
378 * Document number: ARM DEN 0049E.e, Sep 2022
379 *
380 ******************************************************************************/
381
382struct acpi_table_iort {
383 struct acpi_table_header header;
384 u32 node_count;
385 u32 node_offset;
386 u32 reserved;
387};
388
389/*
390 * IORT subtables
391 */
392struct acpi_iort_node {
393 u8 type;
394 u16 length;
395 u8 revision;
396 u32 identifier;
397 u32 mapping_count;
398 u32 mapping_offset;
399 char node_data[1];
400};
401
402/* Values for subtable Type above */
403
404enum acpi_iort_node_type {
405 ACPI_IORT_NODE_ITS_GROUP = 0x00,
406 ACPI_IORT_NODE_NAMED_COMPONENT = 0x01,
407 ACPI_IORT_NODE_PCI_ROOT_COMPLEX = 0x02,
408 ACPI_IORT_NODE_SMMU = 0x03,
409 ACPI_IORT_NODE_SMMU_V3 = 0x04,
410 ACPI_IORT_NODE_PMCG = 0x05,
411 ACPI_IORT_NODE_RMR = 0x06,
412};
413
414struct acpi_iort_id_mapping {
415 u32 input_base; /* Lowest value in input range */
416 u32 id_count; /* Number of IDs */
417 u32 output_base; /* Lowest value in output range */
418 u32 output_reference; /* A reference to the output node */
419 u32 flags;
420};
421
422/* Masks for Flags field above for IORT subtable */
423
424#define ACPI_IORT_ID_SINGLE_MAPPING (1)
425
426struct acpi_iort_memory_access {
427 u32 cache_coherency;
428 u8 hints;
429 u16 reserved;
430 u8 memory_flags;
431};
432
433/* Values for cache_coherency field above */
434
435#define ACPI_IORT_NODE_COHERENT 0x00000001 /* The device node is fully coherent */
436#define ACPI_IORT_NODE_NOT_COHERENT 0x00000000 /* The device node is not coherent */
437
438/* Masks for Hints field above */
439
440#define ACPI_IORT_HT_TRANSIENT (1)
441#define ACPI_IORT_HT_WRITE (1<<1)
442#define ACPI_IORT_HT_READ (1<<2)
443#define ACPI_IORT_HT_OVERRIDE (1<<3)
444
445/* Masks for memory_flags field above */
446
447#define ACPI_IORT_MF_COHERENCY (1)
448#define ACPI_IORT_MF_ATTRIBUTES (1<<1)
449
450/*
451 * IORT node specific subtables
452 */
453struct acpi_iort_its_group {
454 u32 its_count;
455 u32 identifiers[1]; /* GIC ITS identifier array */
456};
457
458struct acpi_iort_named_component {
459 u32 node_flags;
460 u64 memory_properties; /* Memory access properties */
461 u8 memory_address_limit; /* Memory address size limit */
462 char device_name[1]; /* Path of namespace object */
463};
464
465/* Masks for Flags field above */
466
467#define ACPI_IORT_NC_STALL_SUPPORTED (1)
468#define ACPI_IORT_NC_PASID_BITS (31<<1)
469
470struct acpi_iort_root_complex {
471 u64 memory_properties; /* Memory access properties */
472 u32 ats_attribute;
473 u32 pci_segment_number;
474 u8 memory_address_limit; /* Memory address size limit */
475 u16 pasid_capabilities; /* PASID Capabilities */
476 u8 reserved[1]; /* Reserved, must be zero */
477};
478
479/* Masks for ats_attribute field above */
480
481#define ACPI_IORT_ATS_SUPPORTED (1) /* The root complex ATS support */
482#define ACPI_IORT_PRI_SUPPORTED (1<<1) /* The root complex PRI support */
483#define ACPI_IORT_PASID_FWD_SUPPORTED (1<<2) /* The root complex PASID forward support */
484
485/* Masks for pasid_capabilities field above */
486#define ACPI_IORT_PASID_MAX_WIDTH (0x1F) /* Bits 0-4 */
487
488struct acpi_iort_smmu {
489 u64 base_address; /* SMMU base address */
490 u64 span; /* Length of memory range */
491 u32 model;
492 u32 flags;
493 u32 global_interrupt_offset;
494 u32 context_interrupt_count;
495 u32 context_interrupt_offset;
496 u32 pmu_interrupt_count;
497 u32 pmu_interrupt_offset;
498 u64 interrupts[1]; /* Interrupt array */
499};
500
501/* Values for Model field above */
502
503#define ACPI_IORT_SMMU_V1 0x00000000 /* Generic SMMUv1 */
504#define ACPI_IORT_SMMU_V2 0x00000001 /* Generic SMMUv2 */
505#define ACPI_IORT_SMMU_CORELINK_MMU400 0x00000002 /* ARM Corelink MMU-400 */
506#define ACPI_IORT_SMMU_CORELINK_MMU500 0x00000003 /* ARM Corelink MMU-500 */
507#define ACPI_IORT_SMMU_CORELINK_MMU401 0x00000004 /* ARM Corelink MMU-401 */
508#define ACPI_IORT_SMMU_CAVIUM_THUNDERX 0x00000005 /* Cavium thunder_x SMMUv2 */
509
510/* Masks for Flags field above */
511
512#define ACPI_IORT_SMMU_DVM_SUPPORTED (1)
513#define ACPI_IORT_SMMU_COHERENT_WALK (1<<1)
514
515/* Global interrupt format */
516
517struct acpi_iort_smmu_gsi {
518 u32 nsg_irpt;
519 u32 nsg_irpt_flags;
520 u32 nsg_cfg_irpt;
521 u32 nsg_cfg_irpt_flags;
522};
523
524struct acpi_iort_smmu_v3 {
525 u64 base_address; /* SMMUv3 base address */
526 u32 flags;
527 u32 reserved;
528 u64 vatos_address;
529 u32 model;
530 u32 event_gsiv;
531 u32 pri_gsiv;
532 u32 gerr_gsiv;
533 u32 sync_gsiv;
534 u32 pxm;
535 u32 id_mapping_index;
536};
537
538/* Values for Model field above */
539
540#define ACPI_IORT_SMMU_V3_GENERIC 0x00000000 /* Generic SMMUv3 */
541#define ACPI_IORT_SMMU_V3_HISILICON_HI161X 0x00000001 /* hi_silicon Hi161x SMMUv3 */
542#define ACPI_IORT_SMMU_V3_CAVIUM_CN99XX 0x00000002 /* Cavium CN99xx SMMUv3 */
543
544/* Masks for Flags field above */
545
546#define ACPI_IORT_SMMU_V3_COHACC_OVERRIDE (1)
547#define ACPI_IORT_SMMU_V3_HTTU_OVERRIDE (3<<1)
548#define ACPI_IORT_SMMU_V3_PXM_VALID (1<<3)
549#define ACPI_IORT_SMMU_V3_DEVICEID_VALID (1<<4)
550
551struct acpi_iort_pmcg {
552 u64 page0_base_address;
553 u32 overflow_gsiv;
554 u32 node_reference;
555 u64 page1_base_address;
556};
557
558struct acpi_iort_rmr {
559 u32 flags;
560 u32 rmr_count;
561 u32 rmr_offset;
562};
563
564/* Masks for Flags field above */
565#define ACPI_IORT_RMR_REMAP_PERMITTED (1)
566#define ACPI_IORT_RMR_ACCESS_PRIVILEGE (1<<1)
567
568/*
569 * Macro to access the Access Attributes in flags field above:
570 * Access Attributes is encoded in bits 9:2
571 */
572#define ACPI_IORT_RMR_ACCESS_ATTRIBUTES(flags) (((flags) >> 2) & 0xFF)
573
574/* Values for above Access Attributes */
575
576#define ACPI_IORT_RMR_ATTR_DEVICE_NGNRNE 0x00
577#define ACPI_IORT_RMR_ATTR_DEVICE_NGNRE 0x01
578#define ACPI_IORT_RMR_ATTR_DEVICE_NGRE 0x02
579#define ACPI_IORT_RMR_ATTR_DEVICE_GRE 0x03
580#define ACPI_IORT_RMR_ATTR_NORMAL_NC 0x04
581#define ACPI_IORT_RMR_ATTR_NORMAL_IWB_OWB 0x05
582
583struct acpi_iort_rmr_desc {
584 u64 base_address;
585 u64 length;
586 u32 reserved;
587};
588
589/*******************************************************************************
590 *
591 * IVRS - I/O Virtualization Reporting Structure
592 * Version 1
593 *
594 * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
595 * Revision 1.26, February 2009.
596 *
597 ******************************************************************************/
598
599struct acpi_table_ivrs {
600 struct acpi_table_header header; /* Common ACPI table header */
601 u32 info; /* Common virtualization info */
602 u64 reserved;
603};
604
605/* Values for Info field above */
606
607#define ACPI_IVRS_PHYSICAL_SIZE 0x00007F00 /* 7 bits, physical address size */
608#define ACPI_IVRS_VIRTUAL_SIZE 0x003F8000 /* 7 bits, virtual address size */
609#define ACPI_IVRS_ATS_RESERVED 0x00400000 /* ATS address translation range reserved */
610
611/* IVRS subtable header */
612
613struct acpi_ivrs_header {
614 u8 type; /* Subtable type */
615 u8 flags;
616 u16 length; /* Subtable length */
617 u16 device_id; /* ID of IOMMU */
618};
619
620/* Values for subtable Type above */
621
622enum acpi_ivrs_type {
623 ACPI_IVRS_TYPE_HARDWARE1 = 0x10,
624 ACPI_IVRS_TYPE_HARDWARE2 = 0x11,
625 ACPI_IVRS_TYPE_HARDWARE3 = 0x40,
626 ACPI_IVRS_TYPE_MEMORY1 = 0x20,
627 ACPI_IVRS_TYPE_MEMORY2 = 0x21,
628 ACPI_IVRS_TYPE_MEMORY3 = 0x22
629};
630
631/* Masks for Flags field above for IVHD subtable */
632
633#define ACPI_IVHD_TT_ENABLE (1)
634#define ACPI_IVHD_PASS_PW (1<<1)
635#define ACPI_IVHD_RES_PASS_PW (1<<2)
636#define ACPI_IVHD_ISOC (1<<3)
637#define ACPI_IVHD_IOTLB (1<<4)
638
639/* Masks for Flags field above for IVMD subtable */
640
641#define ACPI_IVMD_UNITY (1)
642#define ACPI_IVMD_READ (1<<1)
643#define ACPI_IVMD_WRITE (1<<2)
644#define ACPI_IVMD_EXCLUSION_RANGE (1<<3)
645
646/*
647 * IVRS subtables, correspond to Type in struct acpi_ivrs_header
648 */
649
650/* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
651
652struct acpi_ivrs_hardware_10 {
653 struct acpi_ivrs_header header;
654 u16 capability_offset; /* Offset for IOMMU control fields */
655 u64 base_address; /* IOMMU control registers */
656 u16 pci_segment_group;
657 u16 info; /* MSI number and unit ID */
658 u32 feature_reporting;
659};
660
661/* 0x11: I/O Virtualization Hardware Definition Block (IVHD) */
662
663struct acpi_ivrs_hardware_11 {
664 struct acpi_ivrs_header header;
665 u16 capability_offset; /* Offset for IOMMU control fields */
666 u64 base_address; /* IOMMU control registers */
667 u16 pci_segment_group;
668 u16 info; /* MSI number and unit ID */
669 u32 attributes;
670 u64 efr_register_image;
671 u64 reserved;
672};
673
674/* Masks for Info field above */
675
676#define ACPI_IVHD_MSI_NUMBER_MASK 0x001F /* 5 bits, MSI message number */
677#define ACPI_IVHD_UNIT_ID_MASK 0x1F00 /* 5 bits, unit_ID */
678
679/*
680 * Device Entries for IVHD subtable, appear after struct acpi_ivrs_hardware structure.
681 * Upper two bits of the Type field are the (encoded) length of the structure.
682 * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
683 * are reserved for future use but not defined.
684 */
685struct acpi_ivrs_de_header {
686 u8 type;
687 u16 id;
688 u8 data_setting;
689};
690
691/* Length of device entry is in the top two bits of Type field above */
692
693#define ACPI_IVHD_ENTRY_LENGTH 0xC0
694
695/* Values for device entry Type field above */
696
697enum acpi_ivrs_device_entry_type {
698 /* 4-byte device entries, all use struct acpi_ivrs_device4 */
699
700 ACPI_IVRS_TYPE_PAD4 = 0,
701 ACPI_IVRS_TYPE_ALL = 1,
702 ACPI_IVRS_TYPE_SELECT = 2,
703 ACPI_IVRS_TYPE_START = 3,
704 ACPI_IVRS_TYPE_END = 4,
705
706 /* 8-byte device entries */
707
708 ACPI_IVRS_TYPE_PAD8 = 64,
709 ACPI_IVRS_TYPE_NOT_USED = 65,
710 ACPI_IVRS_TYPE_ALIAS_SELECT = 66, /* Uses struct acpi_ivrs_device8a */
711 ACPI_IVRS_TYPE_ALIAS_START = 67, /* Uses struct acpi_ivrs_device8a */
712 ACPI_IVRS_TYPE_EXT_SELECT = 70, /* Uses struct acpi_ivrs_device8b */
713 ACPI_IVRS_TYPE_EXT_START = 71, /* Uses struct acpi_ivrs_device8b */
714 ACPI_IVRS_TYPE_SPECIAL = 72, /* Uses struct acpi_ivrs_device8c */
715
716 /* Variable-length device entries */
717
718 ACPI_IVRS_TYPE_HID = 240 /* Uses ACPI_IVRS_DEVICE_HID */
719};
720
721/* Values for Data field above */
722
723#define ACPI_IVHD_INIT_PASS (1)
724#define ACPI_IVHD_EINT_PASS (1<<1)
725#define ACPI_IVHD_NMI_PASS (1<<2)
726#define ACPI_IVHD_SYSTEM_MGMT (3<<4)
727#define ACPI_IVHD_LINT0_PASS (1<<6)
728#define ACPI_IVHD_LINT1_PASS (1<<7)
729
730/* Types 0-4: 4-byte device entry */
731
732struct acpi_ivrs_device4 {
733 struct acpi_ivrs_de_header header;
734};
735
736/* Types 66-67: 8-byte device entry */
737
738struct acpi_ivrs_device8a {
739 struct acpi_ivrs_de_header header;
740 u8 reserved1;
741 u16 used_id;
742 u8 reserved2;
743};
744
745/* Types 70-71: 8-byte device entry */
746
747struct acpi_ivrs_device8b {
748 struct acpi_ivrs_de_header header;
749 u32 extended_data;
750};
751
752/* Values for extended_data above */
753
754#define ACPI_IVHD_ATS_DISABLED (1<<31)
755
756/* Type 72: 8-byte device entry */
757
758struct acpi_ivrs_device8c {
759 struct acpi_ivrs_de_header header;
760 u8 handle;
761 u16 used_id;
762 u8 variety;
763};
764
765/* Values for Variety field above */
766
767#define ACPI_IVHD_IOAPIC 1
768#define ACPI_IVHD_HPET 2
769
770/* Type 240: variable-length device entry */
771
772struct acpi_ivrs_device_hid {
773 struct acpi_ivrs_de_header header;
774 u64 acpi_hid;
775 u64 acpi_cid;
776 u8 uid_type;
777 u8 uid_length;
778};
779
780/* Values for uid_type above */
781
782#define ACPI_IVRS_UID_NOT_PRESENT 0
783#define ACPI_IVRS_UID_IS_INTEGER 1
784#define ACPI_IVRS_UID_IS_STRING 2
785
786/* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
787
788struct acpi_ivrs_memory {
789 struct acpi_ivrs_header header;
790 u16 aux_data;
791 u64 reserved;
792 u64 start_address;
793 u64 memory_length;
794};
795
796/*******************************************************************************
797 *
798 * LPIT - Low Power Idle Table
799 *
800 * Conforms to "ACPI Low Power Idle Table (LPIT)" July 2014.
801 *
802 ******************************************************************************/
803
804struct acpi_table_lpit {
805 struct acpi_table_header header; /* Common ACPI table header */
806};
807
808/* LPIT subtable header */
809
810struct acpi_lpit_header {
811 u32 type; /* Subtable type */
812 u32 length; /* Subtable length */
813 u16 unique_id;
814 u16 reserved;
815 u32 flags;
816};
817
818/* Values for subtable Type above */
819
820enum acpi_lpit_type {
821 ACPI_LPIT_TYPE_NATIVE_CSTATE = 0x00,
822 ACPI_LPIT_TYPE_RESERVED = 0x01 /* 1 and above are reserved */
823};
824
825/* Masks for Flags field above */
826
827#define ACPI_LPIT_STATE_DISABLED (1)
828#define ACPI_LPIT_NO_COUNTER (1<<1)
829
830/*
831 * LPIT subtables, correspond to Type in struct acpi_lpit_header
832 */
833
834/* 0x00: Native C-state instruction based LPI structure */
835
836struct acpi_lpit_native {
837 struct acpi_lpit_header header;
838 struct acpi_generic_address entry_trigger;
839 u32 residency;
840 u32 latency;
841 struct acpi_generic_address residency_counter;
842 u64 counter_frequency;
843};
844
845/*******************************************************************************
846 *
847 * MADT - Multiple APIC Description Table
848 * Version 3
849 *
850 ******************************************************************************/
851
852struct acpi_table_madt {
853 struct acpi_table_header header; /* Common ACPI table header */
854 u32 address; /* Physical address of local APIC */
855 u32 flags;
856};
857
858/* Masks for Flags field above */
859
860#define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
861
862/* Values for PCATCompat flag */
863
864#define ACPI_MADT_DUAL_PIC 1
865#define ACPI_MADT_MULTIPLE_APIC 0
866
867/* Values for MADT subtable type in struct acpi_subtable_header */
868
869enum acpi_madt_type {
870 ACPI_MADT_TYPE_LOCAL_APIC = 0,
871 ACPI_MADT_TYPE_IO_APIC = 1,
872 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
873 ACPI_MADT_TYPE_NMI_SOURCE = 3,
874 ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
875 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
876 ACPI_MADT_TYPE_IO_SAPIC = 6,
877 ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
878 ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
879 ACPI_MADT_TYPE_LOCAL_X2APIC = 9,
880 ACPI_MADT_TYPE_LOCAL_X2APIC_NMI = 10,
881 ACPI_MADT_TYPE_GENERIC_INTERRUPT = 11,
882 ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR = 12,
883 ACPI_MADT_TYPE_GENERIC_MSI_FRAME = 13,
884 ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR = 14,
885 ACPI_MADT_TYPE_GENERIC_TRANSLATOR = 15,
886 ACPI_MADT_TYPE_MULTIPROC_WAKEUP = 16,
887 ACPI_MADT_TYPE_CORE_PIC = 17,
888 ACPI_MADT_TYPE_LIO_PIC = 18,
889 ACPI_MADT_TYPE_HT_PIC = 19,
890 ACPI_MADT_TYPE_EIO_PIC = 20,
891 ACPI_MADT_TYPE_MSI_PIC = 21,
892 ACPI_MADT_TYPE_BIO_PIC = 22,
893 ACPI_MADT_TYPE_LPC_PIC = 23,
894 ACPI_MADT_TYPE_RESERVED = 24, /* 24 to 0x7F are reserved */
895 ACPI_MADT_TYPE_OEM_RESERVED = 0x80 /* 0x80 to 0xFF are reserved for OEM use */
896};
897
898/*
899 * MADT Subtables, correspond to Type in struct acpi_subtable_header
900 */
901
902/* 0: Processor Local APIC */
903
904struct acpi_madt_local_apic {
905 struct acpi_subtable_header header;
906 u8 processor_id; /* ACPI processor id */
907 u8 id; /* Processor's local APIC id */
908 u32 lapic_flags;
909};
910
911/* 1: IO APIC */
912
913struct acpi_madt_io_apic {
914 struct acpi_subtable_header header;
915 u8 id; /* I/O APIC ID */
916 u8 reserved; /* reserved - must be zero */
917 u32 address; /* APIC physical address */
918 u32 global_irq_base; /* Global system interrupt where INTI lines start */
919};
920
921/* 2: Interrupt Override */
922
923struct acpi_madt_interrupt_override {
924 struct acpi_subtable_header header;
925 u8 bus; /* 0 - ISA */
926 u8 source_irq; /* Interrupt source (IRQ) */
927 u32 global_irq; /* Global system interrupt */
928 u16 inti_flags;
929};
930
931/* 3: NMI Source */
932
933struct acpi_madt_nmi_source {
934 struct acpi_subtable_header header;
935 u16 inti_flags;
936 u32 global_irq; /* Global system interrupt */
937};
938
939/* 4: Local APIC NMI */
940
941struct acpi_madt_local_apic_nmi {
942 struct acpi_subtable_header header;
943 u8 processor_id; /* ACPI processor id */
944 u16 inti_flags;
945 u8 lint; /* LINTn to which NMI is connected */
946};
947
948/* 5: Address Override */
949
950struct acpi_madt_local_apic_override {
951 struct acpi_subtable_header header;
952 u16 reserved; /* Reserved, must be zero */
953 u64 address; /* APIC physical address */
954};
955
956/* 6: I/O Sapic */
957
958struct acpi_madt_io_sapic {
959 struct acpi_subtable_header header;
960 u8 id; /* I/O SAPIC ID */
961 u8 reserved; /* Reserved, must be zero */
962 u32 global_irq_base; /* Global interrupt for SAPIC start */
963 u64 address; /* SAPIC physical address */
964};
965
966/* 7: Local Sapic */
967
968struct acpi_madt_local_sapic {
969 struct acpi_subtable_header header;
970 u8 processor_id; /* ACPI processor id */
971 u8 id; /* SAPIC ID */
972 u8 eid; /* SAPIC EID */
973 u8 reserved[3]; /* Reserved, must be zero */
974 u32 lapic_flags;
975 u32 uid; /* Numeric UID - ACPI 3.0 */
976 char uid_string[1]; /* String UID - ACPI 3.0 */
977};
978
979/* 8: Platform Interrupt Source */
980
981struct acpi_madt_interrupt_source {
982 struct acpi_subtable_header header;
983 u16 inti_flags;
984 u8 type; /* 1=PMI, 2=INIT, 3=corrected */
985 u8 id; /* Processor ID */
986 u8 eid; /* Processor EID */
987 u8 io_sapic_vector; /* Vector value for PMI interrupts */
988 u32 global_irq; /* Global system interrupt */
989 u32 flags; /* Interrupt Source Flags */
990};
991
992/* Masks for Flags field above */
993
994#define ACPI_MADT_CPEI_OVERRIDE (1)
995
996/* 9: Processor Local X2APIC (ACPI 4.0) */
997
998struct acpi_madt_local_x2apic {
999 struct acpi_subtable_header header;
1000 u16 reserved; /* reserved - must be zero */
1001 u32 local_apic_id; /* Processor x2APIC ID */
1002 u32 lapic_flags;
1003 u32 uid; /* ACPI processor UID */
1004};
1005
1006/* 10: Local X2APIC NMI (ACPI 4.0) */
1007
1008struct acpi_madt_local_x2apic_nmi {
1009 struct acpi_subtable_header header;
1010 u16 inti_flags;
1011 u32 uid; /* ACPI processor UID */
1012 u8 lint; /* LINTn to which NMI is connected */
1013 u8 reserved[3]; /* reserved - must be zero */
1014};
1015
1016/* 11: Generic interrupt - GICC (ACPI 5.0 + ACPI 6.0 + ACPI 6.3 changes) */
1017
1018struct acpi_madt_generic_interrupt {
1019 struct acpi_subtable_header header;
1020 u16 reserved; /* reserved - must be zero */
1021 u32 cpu_interface_number;
1022 u32 uid;
1023 u32 flags;
1024 u32 parking_version;
1025 u32 performance_interrupt;
1026 u64 parked_address;
1027 u64 base_address;
1028 u64 gicv_base_address;
1029 u64 gich_base_address;
1030 u32 vgic_interrupt;
1031 u64 gicr_base_address;
1032 u64 arm_mpidr;
1033 u8 efficiency_class;
1034 u8 reserved2[1];
1035 u16 spe_interrupt; /* ACPI 6.3 */
1036};
1037
1038/* Masks for Flags field above */
1039
1040/* ACPI_MADT_ENABLED (1) Processor is usable if set */
1041#define ACPI_MADT_PERFORMANCE_IRQ_MODE (1<<1) /* 01: Performance Interrupt Mode */
1042#define ACPI_MADT_VGIC_IRQ_MODE (1<<2) /* 02: VGIC Maintenance Interrupt mode */
1043
1044/* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
1045
1046struct acpi_madt_generic_distributor {
1047 struct acpi_subtable_header header;
1048 u16 reserved; /* reserved - must be zero */
1049 u32 gic_id;
1050 u64 base_address;
1051 u32 global_irq_base;
1052 u8 version;
1053 u8 reserved2[3]; /* reserved - must be zero */
1054};
1055
1056/* Values for Version field above */
1057
1058enum acpi_madt_gic_version {
1059 ACPI_MADT_GIC_VERSION_NONE = 0,
1060 ACPI_MADT_GIC_VERSION_V1 = 1,
1061 ACPI_MADT_GIC_VERSION_V2 = 2,
1062 ACPI_MADT_GIC_VERSION_V3 = 3,
1063 ACPI_MADT_GIC_VERSION_V4 = 4,
1064 ACPI_MADT_GIC_VERSION_RESERVED = 5 /* 5 and greater are reserved */
1065};
1066
1067/* 13: Generic MSI Frame (ACPI 5.1) */
1068
1069struct acpi_madt_generic_msi_frame {
1070 struct acpi_subtable_header header;
1071 u16 reserved; /* reserved - must be zero */
1072 u32 msi_frame_id;
1073 u64 base_address;
1074 u32 flags;
1075 u16 spi_count;
1076 u16 spi_base;
1077};
1078
1079/* Masks for Flags field above */
1080
1081#define ACPI_MADT_OVERRIDE_SPI_VALUES (1)
1082
1083/* 14: Generic Redistributor (ACPI 5.1) */
1084
1085struct acpi_madt_generic_redistributor {
1086 struct acpi_subtable_header header;
1087 u16 reserved; /* reserved - must be zero */
1088 u64 base_address;
1089 u32 length;
1090};
1091
1092/* 15: Generic Translator (ACPI 6.0) */
1093
1094struct acpi_madt_generic_translator {
1095 struct acpi_subtable_header header;
1096 u16 reserved; /* reserved - must be zero */
1097 u32 translation_id;
1098 u64 base_address;
1099 u32 reserved2;
1100};
1101
1102/* 16: Multiprocessor wakeup (ACPI 6.4) */
1103
1104struct acpi_madt_multiproc_wakeup {
1105 struct acpi_subtable_header header;
1106 u16 mailbox_version;
1107 u32 reserved; /* reserved - must be zero */
1108 u64 base_address;
1109};
1110
1111#define ACPI_MULTIPROC_WAKEUP_MB_OS_SIZE 2032
1112#define ACPI_MULTIPROC_WAKEUP_MB_FIRMWARE_SIZE 2048
1113
1114struct acpi_madt_multiproc_wakeup_mailbox {
1115 u16 command;
1116 u16 reserved; /* reserved - must be zero */
1117 u32 apic_id;
1118 u64 wakeup_vector;
1119 u8 reserved_os[ACPI_MULTIPROC_WAKEUP_MB_OS_SIZE]; /* reserved for OS use */
1120 u8 reserved_firmware[ACPI_MULTIPROC_WAKEUP_MB_FIRMWARE_SIZE]; /* reserved for firmware use */
1121};
1122
1123#define ACPI_MP_WAKE_COMMAND_WAKEUP 1
1124
1125/* 17: CPU Core Interrupt Controller (ACPI 6.5) */
1126
1127struct acpi_madt_core_pic {
1128 struct acpi_subtable_header header;
1129 u8 version;
1130 u32 processor_id;
1131 u32 core_id;
1132 u32 flags;
1133};
1134
1135/* Values for Version field above */
1136
1137enum acpi_madt_core_pic_version {
1138 ACPI_MADT_CORE_PIC_VERSION_NONE = 0,
1139 ACPI_MADT_CORE_PIC_VERSION_V1 = 1,
1140 ACPI_MADT_CORE_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1141};
1142
1143/* 18: Legacy I/O Interrupt Controller (ACPI 6.5) */
1144
1145struct acpi_madt_lio_pic {
1146 struct acpi_subtable_header header;
1147 u8 version;
1148 u64 address;
1149 u16 size;
1150 u8 cascade[2];
1151 u32 cascade_map[2];
1152};
1153
1154/* Values for Version field above */
1155
1156enum acpi_madt_lio_pic_version {
1157 ACPI_MADT_LIO_PIC_VERSION_NONE = 0,
1158 ACPI_MADT_LIO_PIC_VERSION_V1 = 1,
1159 ACPI_MADT_LIO_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1160};
1161
1162/* 19: HT Interrupt Controller (ACPI 6.5) */
1163
1164struct acpi_madt_ht_pic {
1165 struct acpi_subtable_header header;
1166 u8 version;
1167 u64 address;
1168 u16 size;
1169 u8 cascade[8];
1170};
1171
1172/* Values for Version field above */
1173
1174enum acpi_madt_ht_pic_version {
1175 ACPI_MADT_HT_PIC_VERSION_NONE = 0,
1176 ACPI_MADT_HT_PIC_VERSION_V1 = 1,
1177 ACPI_MADT_HT_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1178};
1179
1180/* 20: Extend I/O Interrupt Controller (ACPI 6.5) */
1181
1182struct acpi_madt_eio_pic {
1183 struct acpi_subtable_header header;
1184 u8 version;
1185 u8 cascade;
1186 u8 node;
1187 u64 node_map;
1188};
1189
1190/* Values for Version field above */
1191
1192enum acpi_madt_eio_pic_version {
1193 ACPI_MADT_EIO_PIC_VERSION_NONE = 0,
1194 ACPI_MADT_EIO_PIC_VERSION_V1 = 1,
1195 ACPI_MADT_EIO_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1196};
1197
1198/* 21: MSI Interrupt Controller (ACPI 6.5) */
1199
1200struct acpi_madt_msi_pic {
1201 struct acpi_subtable_header header;
1202 u8 version;
1203 u64 msg_address;
1204 u32 start;
1205 u32 count;
1206};
1207
1208/* Values for Version field above */
1209
1210enum acpi_madt_msi_pic_version {
1211 ACPI_MADT_MSI_PIC_VERSION_NONE = 0,
1212 ACPI_MADT_MSI_PIC_VERSION_V1 = 1,
1213 ACPI_MADT_MSI_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1214};
1215
1216/* 22: Bridge I/O Interrupt Controller (ACPI 6.5) */
1217
1218struct acpi_madt_bio_pic {
1219 struct acpi_subtable_header header;
1220 u8 version;
1221 u64 address;
1222 u16 size;
1223 u16 id;
1224 u16 gsi_base;
1225};
1226
1227/* Values for Version field above */
1228
1229enum acpi_madt_bio_pic_version {
1230 ACPI_MADT_BIO_PIC_VERSION_NONE = 0,
1231 ACPI_MADT_BIO_PIC_VERSION_V1 = 1,
1232 ACPI_MADT_BIO_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1233};
1234
1235/* 23: LPC Interrupt Controller (ACPI 6.5) */
1236
1237struct acpi_madt_lpc_pic {
1238 struct acpi_subtable_header header;
1239 u8 version;
1240 u64 address;
1241 u16 size;
1242 u8 cascade;
1243};
1244
1245/* Values for Version field above */
1246
1247enum acpi_madt_lpc_pic_version {
1248 ACPI_MADT_LPC_PIC_VERSION_NONE = 0,
1249 ACPI_MADT_LPC_PIC_VERSION_V1 = 1,
1250 ACPI_MADT_LPC_PIC_VERSION_RESERVED = 2 /* 2 and greater are reserved */
1251};
1252
1253/* 80: OEM data */
1254
1255struct acpi_madt_oem_data {
1256 u8 oem_data[0];
1257};
1258
1259/*
1260 * Common flags fields for MADT subtables
1261 */
1262
1263/* MADT Local APIC flags */
1264
1265#define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
1266#define ACPI_MADT_ONLINE_CAPABLE (2) /* 01: System HW supports enabling processor at runtime */
1267
1268/* MADT MPS INTI flags (inti_flags) */
1269
1270#define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
1271#define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
1272
1273/* Values for MPS INTI flags */
1274
1275#define ACPI_MADT_POLARITY_CONFORMS 0
1276#define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
1277#define ACPI_MADT_POLARITY_RESERVED 2
1278#define ACPI_MADT_POLARITY_ACTIVE_LOW 3
1279
1280#define ACPI_MADT_TRIGGER_CONFORMS (0)
1281#define ACPI_MADT_TRIGGER_EDGE (1<<2)
1282#define ACPI_MADT_TRIGGER_RESERVED (2<<2)
1283#define ACPI_MADT_TRIGGER_LEVEL (3<<2)
1284
1285/*******************************************************************************
1286 *
1287 * MCFG - PCI Memory Mapped Configuration table and subtable
1288 * Version 1
1289 *
1290 * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
1291 *
1292 ******************************************************************************/
1293
1294struct acpi_table_mcfg {
1295 struct acpi_table_header header; /* Common ACPI table header */
1296 u8 reserved[8];
1297};
1298
1299/* Subtable */
1300
1301struct acpi_mcfg_allocation {
1302 u64 address; /* Base address, processor-relative */
1303 u16 pci_segment; /* PCI segment group number */
1304 u8 start_bus_number; /* Starting PCI Bus number */
1305 u8 end_bus_number; /* Final PCI Bus number */
1306 u32 reserved;
1307};
1308
1309/*******************************************************************************
1310 *
1311 * MCHI - Management Controller Host Interface Table
1312 * Version 1
1313 *
1314 * Conforms to "Management Component Transport Protocol (MCTP) Host
1315 * Interface Specification", Revision 1.0.0a, October 13, 2009
1316 *
1317 ******************************************************************************/
1318
1319struct acpi_table_mchi {
1320 struct acpi_table_header header; /* Common ACPI table header */
1321 u8 interface_type;
1322 u8 protocol;
1323 u64 protocol_data;
1324 u8 interrupt_type;
1325 u8 gpe;
1326 u8 pci_device_flag;
1327 u32 global_interrupt;
1328 struct acpi_generic_address control_register;
1329 u8 pci_segment;
1330 u8 pci_bus;
1331 u8 pci_device;
1332 u8 pci_function;
1333};
1334
1335/*******************************************************************************
1336 *
1337 * MPST - Memory Power State Table (ACPI 5.0)
1338 * Version 1
1339 *
1340 ******************************************************************************/
1341
1342#define ACPI_MPST_CHANNEL_INFO \
1343 u8 channel_id; \
1344 u8 reserved1[3]; \
1345 u16 power_node_count; \
1346 u16 reserved2;
1347
1348/* Main table */
1349
1350struct acpi_table_mpst {
1351 struct acpi_table_header header; /* Common ACPI table header */
1352 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
1353};
1354
1355/* Memory Platform Communication Channel Info */
1356
1357struct acpi_mpst_channel {
1358 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
1359};
1360
1361/* Memory Power Node Structure */
1362
1363struct acpi_mpst_power_node {
1364 u8 flags;
1365 u8 reserved1;
1366 u16 node_id;
1367 u32 length;
1368 u64 range_address;
1369 u64 range_length;
1370 u32 num_power_states;
1371 u32 num_physical_components;
1372};
1373
1374/* Values for Flags field above */
1375
1376#define ACPI_MPST_ENABLED 1
1377#define ACPI_MPST_POWER_MANAGED 2
1378#define ACPI_MPST_HOT_PLUG_CAPABLE 4
1379
1380/* Memory Power State Structure (follows POWER_NODE above) */
1381
1382struct acpi_mpst_power_state {
1383 u8 power_state;
1384 u8 info_index;
1385};
1386
1387/* Physical Component ID Structure (follows POWER_STATE above) */
1388
1389struct acpi_mpst_component {
1390 u16 component_id;
1391};
1392
1393/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
1394
1395struct acpi_mpst_data_hdr {
1396 u16 characteristics_count;
1397 u16 reserved;
1398};
1399
1400struct acpi_mpst_power_data {
1401 u8 structure_id;
1402 u8 flags;
1403 u16 reserved1;
1404 u32 average_power;
1405 u32 power_saving;
1406 u64 exit_latency;
1407 u64 reserved2;
1408};
1409
1410/* Values for Flags field above */
1411
1412#define ACPI_MPST_PRESERVE 1
1413#define ACPI_MPST_AUTOENTRY 2
1414#define ACPI_MPST_AUTOEXIT 4
1415
1416/* Shared Memory Region (not part of an ACPI table) */
1417
1418struct acpi_mpst_shared {
1419 u32 signature;
1420 u16 pcc_command;
1421 u16 pcc_status;
1422 u32 command_register;
1423 u32 status_register;
1424 u32 power_state_id;
1425 u32 power_node_id;
1426 u64 energy_consumed;
1427 u64 average_power;
1428};
1429
1430/*******************************************************************************
1431 *
1432 * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1433 * Version 1
1434 *
1435 ******************************************************************************/
1436
1437struct acpi_table_msct {
1438 struct acpi_table_header header; /* Common ACPI table header */
1439 u32 proximity_offset; /* Location of proximity info struct(s) */
1440 u32 max_proximity_domains; /* Max number of proximity domains */
1441 u32 max_clock_domains; /* Max number of clock domains */
1442 u64 max_address; /* Max physical address in system */
1443};
1444
1445/* subtable - Maximum Proximity Domain Information. Version 1 */
1446
1447struct acpi_msct_proximity {
1448 u8 revision;
1449 u8 length;
1450 u32 range_start; /* Start of domain range */
1451 u32 range_end; /* End of domain range */
1452 u32 processor_capacity;
1453 u64 memory_capacity; /* In bytes */
1454};
1455
1456/*******************************************************************************
1457 *
1458 * MSDM - Microsoft Data Management table
1459 *
1460 * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
1461 * November 29, 2011. Copyright 2011 Microsoft
1462 *
1463 ******************************************************************************/
1464
1465/* Basic MSDM table is only the common ACPI header */
1466
1467struct acpi_table_msdm {
1468 struct acpi_table_header header; /* Common ACPI table header */
1469};
1470
1471/*******************************************************************************
1472 *
1473 * NFIT - NVDIMM Interface Table (ACPI 6.0+)
1474 * Version 1
1475 *
1476 ******************************************************************************/
1477
1478struct acpi_table_nfit {
1479 struct acpi_table_header header; /* Common ACPI table header */
1480 u32 reserved; /* Reserved, must be zero */
1481};
1482
1483/* Subtable header for NFIT */
1484
1485struct acpi_nfit_header {
1486 u16 type;
1487 u16 length;
1488};
1489
1490/* Values for subtable type in struct acpi_nfit_header */
1491
1492enum acpi_nfit_type {
1493 ACPI_NFIT_TYPE_SYSTEM_ADDRESS = 0,
1494 ACPI_NFIT_TYPE_MEMORY_MAP = 1,
1495 ACPI_NFIT_TYPE_INTERLEAVE = 2,
1496 ACPI_NFIT_TYPE_SMBIOS = 3,
1497 ACPI_NFIT_TYPE_CONTROL_REGION = 4,
1498 ACPI_NFIT_TYPE_DATA_REGION = 5,
1499 ACPI_NFIT_TYPE_FLUSH_ADDRESS = 6,
1500 ACPI_NFIT_TYPE_CAPABILITIES = 7,
1501 ACPI_NFIT_TYPE_RESERVED = 8 /* 8 and greater are reserved */
1502};
1503
1504/*
1505 * NFIT Subtables
1506 */
1507
1508/* 0: System Physical Address Range Structure */
1509
1510struct acpi_nfit_system_address {
1511 struct acpi_nfit_header header;
1512 u16 range_index;
1513 u16 flags;
1514 u32 reserved; /* Reserved, must be zero */
1515 u32 proximity_domain;
1516 u8 range_guid[16];
1517 u64 address;
1518 u64 length;
1519 u64 memory_mapping;
1520 u64 location_cookie; /* ACPI 6.4 */
1521};
1522
1523/* Flags */
1524
1525#define ACPI_NFIT_ADD_ONLINE_ONLY (1) /* 00: Add/Online Operation Only */
1526#define ACPI_NFIT_PROXIMITY_VALID (1<<1) /* 01: Proximity Domain Valid */
1527#define ACPI_NFIT_LOCATION_COOKIE_VALID (1<<2) /* 02: SPA location cookie valid (ACPI 6.4) */
1528
1529/* Range Type GUIDs appear in the include/acuuid.h file */
1530
1531/* 1: Memory Device to System Address Range Map Structure */
1532
1533struct acpi_nfit_memory_map {
1534 struct acpi_nfit_header header;
1535 u32 device_handle;
1536 u16 physical_id;
1537 u16 region_id;
1538 u16 range_index;
1539 u16 region_index;
1540 u64 region_size;
1541 u64 region_offset;
1542 u64 address;
1543 u16 interleave_index;
1544 u16 interleave_ways;
1545 u16 flags;
1546 u16 reserved; /* Reserved, must be zero */
1547};
1548
1549/* Flags */
1550
1551#define ACPI_NFIT_MEM_SAVE_FAILED (1) /* 00: Last SAVE to Memory Device failed */
1552#define ACPI_NFIT_MEM_RESTORE_FAILED (1<<1) /* 01: Last RESTORE from Memory Device failed */
1553#define ACPI_NFIT_MEM_FLUSH_FAILED (1<<2) /* 02: Platform flush failed */
1554#define ACPI_NFIT_MEM_NOT_ARMED (1<<3) /* 03: Memory Device is not armed */
1555#define ACPI_NFIT_MEM_HEALTH_OBSERVED (1<<4) /* 04: Memory Device observed SMART/health events */
1556#define ACPI_NFIT_MEM_HEALTH_ENABLED (1<<5) /* 05: SMART/health events enabled */
1557#define ACPI_NFIT_MEM_MAP_FAILED (1<<6) /* 06: Mapping to SPA failed */
1558
1559/* 2: Interleave Structure */
1560
1561struct acpi_nfit_interleave {
1562 struct acpi_nfit_header header;
1563 u16 interleave_index;
1564 u16 reserved; /* Reserved, must be zero */
1565 u32 line_count;
1566 u32 line_size;
1567 u32 line_offset[1]; /* Variable length */
1568};
1569
1570/* 3: SMBIOS Management Information Structure */
1571
1572struct acpi_nfit_smbios {
1573 struct acpi_nfit_header header;
1574 u32 reserved; /* Reserved, must be zero */
1575 u8 data[1]; /* Variable length */
1576};
1577
1578/* 4: NVDIMM Control Region Structure */
1579
1580struct acpi_nfit_control_region {
1581 struct acpi_nfit_header header;
1582 u16 region_index;
1583 u16 vendor_id;
1584 u16 device_id;
1585 u16 revision_id;
1586 u16 subsystem_vendor_id;
1587 u16 subsystem_device_id;
1588 u16 subsystem_revision_id;
1589 u8 valid_fields;
1590 u8 manufacturing_location;
1591 u16 manufacturing_date;
1592 u8 reserved[2]; /* Reserved, must be zero */
1593 u32 serial_number;
1594 u16 code;
1595 u16 windows;
1596 u64 window_size;
1597 u64 command_offset;
1598 u64 command_size;
1599 u64 status_offset;
1600 u64 status_size;
1601 u16 flags;
1602 u8 reserved1[6]; /* Reserved, must be zero */
1603};
1604
1605/* Flags */
1606
1607#define ACPI_NFIT_CONTROL_BUFFERED (1) /* Block Data Windows implementation is buffered */
1608
1609/* valid_fields bits */
1610
1611#define ACPI_NFIT_CONTROL_MFG_INFO_VALID (1) /* Manufacturing fields are valid */
1612
1613/* 5: NVDIMM Block Data Window Region Structure */
1614
1615struct acpi_nfit_data_region {
1616 struct acpi_nfit_header header;
1617 u16 region_index;
1618 u16 windows;
1619 u64 offset;
1620 u64 size;
1621 u64 capacity;
1622 u64 start_address;
1623};
1624
1625/* 6: Flush Hint Address Structure */
1626
1627struct acpi_nfit_flush_address {
1628 struct acpi_nfit_header header;
1629 u32 device_handle;
1630 u16 hint_count;
1631 u8 reserved[6]; /* Reserved, must be zero */
1632 u64 hint_address[1]; /* Variable length */
1633};
1634
1635/* 7: Platform Capabilities Structure */
1636
1637struct acpi_nfit_capabilities {
1638 struct acpi_nfit_header header;
1639 u8 highest_capability;
1640 u8 reserved[3]; /* Reserved, must be zero */
1641 u32 capabilities;
1642 u32 reserved2;
1643};
1644
1645/* Capabilities Flags */
1646
1647#define ACPI_NFIT_CAPABILITY_CACHE_FLUSH (1) /* 00: Cache Flush to NVDIMM capable */
1648#define ACPI_NFIT_CAPABILITY_MEM_FLUSH (1<<1) /* 01: Memory Flush to NVDIMM capable */
1649#define ACPI_NFIT_CAPABILITY_MEM_MIRRORING (1<<2) /* 02: Memory Mirroring capable */
1650
1651/*
1652 * NFIT/DVDIMM device handle support - used as the _ADR for each NVDIMM
1653 */
1654struct nfit_device_handle {
1655 u32 handle;
1656};
1657
1658/* Device handle construction and extraction macros */
1659
1660#define ACPI_NFIT_DIMM_NUMBER_MASK 0x0000000F
1661#define ACPI_NFIT_CHANNEL_NUMBER_MASK 0x000000F0
1662#define ACPI_NFIT_MEMORY_ID_MASK 0x00000F00
1663#define ACPI_NFIT_SOCKET_ID_MASK 0x0000F000
1664#define ACPI_NFIT_NODE_ID_MASK 0x0FFF0000
1665
1666#define ACPI_NFIT_DIMM_NUMBER_OFFSET 0
1667#define ACPI_NFIT_CHANNEL_NUMBER_OFFSET 4
1668#define ACPI_NFIT_MEMORY_ID_OFFSET 8
1669#define ACPI_NFIT_SOCKET_ID_OFFSET 12
1670#define ACPI_NFIT_NODE_ID_OFFSET 16
1671
1672/* Macro to construct a NFIT/NVDIMM device handle */
1673
1674#define ACPI_NFIT_BUILD_DEVICE_HANDLE(dimm, channel, memory, socket, node) \
1675 ((dimm) | \
1676 ((channel) << ACPI_NFIT_CHANNEL_NUMBER_OFFSET) | \
1677 ((memory) << ACPI_NFIT_MEMORY_ID_OFFSET) | \
1678 ((socket) << ACPI_NFIT_SOCKET_ID_OFFSET) | \
1679 ((node) << ACPI_NFIT_NODE_ID_OFFSET))
1680
1681/* Macros to extract individual fields from a NFIT/NVDIMM device handle */
1682
1683#define ACPI_NFIT_GET_DIMM_NUMBER(handle) \
1684 ((handle) & ACPI_NFIT_DIMM_NUMBER_MASK)
1685
1686#define ACPI_NFIT_GET_CHANNEL_NUMBER(handle) \
1687 (((handle) & ACPI_NFIT_CHANNEL_NUMBER_MASK) >> ACPI_NFIT_CHANNEL_NUMBER_OFFSET)
1688
1689#define ACPI_NFIT_GET_MEMORY_ID(handle) \
1690 (((handle) & ACPI_NFIT_MEMORY_ID_MASK) >> ACPI_NFIT_MEMORY_ID_OFFSET)
1691
1692#define ACPI_NFIT_GET_SOCKET_ID(handle) \
1693 (((handle) & ACPI_NFIT_SOCKET_ID_MASK) >> ACPI_NFIT_SOCKET_ID_OFFSET)
1694
1695#define ACPI_NFIT_GET_NODE_ID(handle) \
1696 (((handle) & ACPI_NFIT_NODE_ID_MASK) >> ACPI_NFIT_NODE_ID_OFFSET)
1697
1698/*******************************************************************************
1699 *
1700 * NHLT - Non HD Audio Link Table
1701 *
1702 * Conforms to: Intel Smart Sound Technology NHLT Specification
1703 * Version 0.8.1, January 2020.
1704 *
1705 ******************************************************************************/
1706
1707/* Main table */
1708
1709struct acpi_table_nhlt {
1710 struct acpi_table_header header; /* Common ACPI table header */
1711 u8 endpoint_count;
1712};
1713
1714struct acpi_nhlt_endpoint {
1715 u32 descriptor_length;
1716 u8 link_type;
1717 u8 instance_id;
1718 u16 vendor_id;
1719 u16 device_id;
1720 u16 revision_id;
1721 u32 subsystem_id;
1722 u8 device_type;
1723 u8 direction;
1724 u8 virtual_bus_id;
1725};
1726
1727/* Types for link_type field above */
1728
1729#define ACPI_NHLT_RESERVED_HD_AUDIO 0
1730#define ACPI_NHLT_RESERVED_DSP 1
1731#define ACPI_NHLT_PDM 2
1732#define ACPI_NHLT_SSP 3
1733#define ACPI_NHLT_RESERVED_SLIMBUS 4
1734#define ACPI_NHLT_RESERVED_SOUNDWIRE 5
1735#define ACPI_NHLT_TYPE_RESERVED 6 /* 6 and above are reserved */
1736
1737/* All other values above are reserved */
1738
1739/* Values for device_id field above */
1740
1741#define ACPI_NHLT_PDM_DMIC 0xAE20
1742#define ACPI_NHLT_BT_SIDEBAND 0xAE30
1743#define ACPI_NHLT_I2S_TDM_CODECS 0xAE23
1744
1745/* Values for device_type field above */
1746
1747/* SSP Link */
1748
1749#define ACPI_NHLT_LINK_BT_SIDEBAND 0
1750#define ACPI_NHLT_LINK_FM 1
1751#define ACPI_NHLT_LINK_MODEM 2
1752/* 3 is reserved */
1753#define ACPI_NHLT_LINK_SSP_ANALOG_CODEC 4
1754
1755/* PDM Link */
1756
1757#define ACPI_NHLT_PDM_ON_CAVS_1P8 0
1758#define ACPI_NHLT_PDM_ON_CAVS_1P5 1
1759
1760/* Values for Direction field above */
1761
1762#define ACPI_NHLT_DIR_RENDER 0
1763#define ACPI_NHLT_DIR_CAPTURE 1
1764#define ACPI_NHLT_DIR_RENDER_LOOPBACK 2
1765#define ACPI_NHLT_DIR_RENDER_FEEDBACK 3
1766#define ACPI_NHLT_DIR_RESERVED 4 /* 4 and above are reserved */
1767
1768struct acpi_nhlt_device_specific_config {
1769 u32 capabilities_size;
1770 u8 virtual_slot;
1771 u8 config_type;
1772};
1773
1774struct acpi_nhlt_device_specific_config_a {
1775 u32 capabilities_size;
1776 u8 virtual_slot;
1777 u8 config_type;
1778 u8 array_type;
1779};
1780
1781/* Values for Config Type above */
1782
1783#define ACPI_NHLT_CONFIG_TYPE_GENERIC 0x00
1784#define ACPI_NHLT_CONFIG_TYPE_MIC_ARRAY 0x01
1785#define ACPI_NHLT_CONFIG_TYPE_RENDER_FEEDBACK 0x03
1786#define ACPI_NHLT_CONFIG_TYPE_RESERVED 0x04 /* 4 and above are reserved */
1787
1788struct acpi_nhlt_device_specific_config_b {
1789 u32 capabilities_size;
1790};
1791
1792struct acpi_nhlt_device_specific_config_c {
1793 u32 capabilities_size;
1794 u8 virtual_slot;
1795};
1796
1797struct acpi_nhlt_render_device_specific_config {
1798 u32 capabilities_size;
1799 u8 virtual_slot;
1800};
1801
1802struct acpi_nhlt_wave_extensible {
1803 u16 format_tag;
1804 u16 channel_count;
1805 u32 samples_per_sec;
1806 u32 avg_bytes_per_sec;
1807 u16 block_align;
1808 u16 bits_per_sample;
1809 u16 extra_format_size;
1810 u16 valid_bits_per_sample;
1811 u32 channel_mask;
1812 u8 sub_format_guid[16];
1813};
1814
1815/* Values for channel_mask above */
1816
1817#define ACPI_NHLT_SPKR_FRONT_LEFT 0x1
1818#define ACPI_NHLT_SPKR_FRONT_RIGHT 0x2
1819#define ACPI_NHLT_SPKR_FRONT_CENTER 0x4
1820#define ACPI_NHLT_SPKR_LOW_FREQ 0x8
1821#define ACPI_NHLT_SPKR_BACK_LEFT 0x10
1822#define ACPI_NHLT_SPKR_BACK_RIGHT 0x20
1823#define ACPI_NHLT_SPKR_FRONT_LEFT_OF_CENTER 0x40
1824#define ACPI_NHLT_SPKR_FRONT_RIGHT_OF_CENTER 0x80
1825#define ACPI_NHLT_SPKR_BACK_CENTER 0x100
1826#define ACPI_NHLT_SPKR_SIDE_LEFT 0x200
1827#define ACPI_NHLT_SPKR_SIDE_RIGHT 0x400
1828#define ACPI_NHLT_SPKR_TOP_CENTER 0x800
1829#define ACPI_NHLT_SPKR_TOP_FRONT_LEFT 0x1000
1830#define ACPI_NHLT_SPKR_TOP_FRONT_CENTER 0x2000
1831#define ACPI_NHLT_SPKR_TOP_FRONT_RIGHT 0x4000
1832#define ACPI_NHLT_SPKR_TOP_BACK_LEFT 0x8000
1833#define ACPI_NHLT_SPKR_TOP_BACK_CENTER 0x10000
1834#define ACPI_NHLT_SPKR_TOP_BACK_RIGHT 0x20000
1835
1836struct acpi_nhlt_format_config {
1837 struct acpi_nhlt_wave_extensible format;
1838 u32 capability_size;
1839 u8 capabilities[];
1840};
1841
1842struct acpi_nhlt_formats_config {
1843 u8 formats_count;
1844};
1845
1846struct acpi_nhlt_device_specific_hdr {
1847 u8 virtual_slot;
1848 u8 config_type;
1849};
1850
1851/* Types for config_type above */
1852
1853#define ACPI_NHLT_GENERIC 0
1854#define ACPI_NHLT_MIC 1
1855#define ACPI_NHLT_RENDER 3
1856
1857struct acpi_nhlt_mic_device_specific_config {
1858 struct acpi_nhlt_device_specific_hdr device_config;
1859 u8 array_type_ext;
1860};
1861
1862/* Values for array_type_ext above */
1863
1864#define ACPI_NHLT_ARRAY_TYPE_RESERVED 0x09 /* 9 and below are reserved */
1865#define ACPI_NHLT_SMALL_LINEAR_2ELEMENT 0x0A
1866#define ACPI_NHLT_BIG_LINEAR_2ELEMENT 0x0B
1867#define ACPI_NHLT_FIRST_GEOMETRY_LINEAR_4ELEMENT 0x0C
1868#define ACPI_NHLT_PLANAR_LSHAPED_4ELEMENT 0x0D
1869#define ACPI_NHLT_SECOND_GEOMETRY_LINEAR_4ELEMENT 0x0E
1870#define ACPI_NHLT_VENDOR_DEFINED 0x0F
1871#define ACPI_NHLT_ARRAY_TYPE_MASK 0x0F
1872#define ACPI_NHLT_ARRAY_TYPE_EXT_MASK 0x10
1873
1874#define ACPI_NHLT_NO_EXTENSION 0x0
1875#define ACPI_NHLT_MIC_SNR_SENSITIVITY_EXT (1<<4)
1876
1877struct acpi_nhlt_vendor_mic_count {
1878 u8 microphone_count;
1879};
1880
1881struct acpi_nhlt_vendor_mic_config {
1882 u8 type;
1883 u8 panel;
1884 u16 speaker_position_distance; /* mm */
1885 u16 horizontal_offset; /* mm */
1886 u16 vertical_offset; /* mm */
1887 u8 frequency_low_band; /* 5*Hz */
1888 u8 frequency_high_band; /* 500*Hz */
1889 u16 direction_angle; /* -180 - + 180 */
1890 u16 elevation_angle; /* -180 - + 180 */
1891 u16 work_vertical_angle_begin; /* -180 - + 180 with 2 deg step */
1892 u16 work_vertical_angle_end; /* -180 - + 180 with 2 deg step */
1893 u16 work_horizontal_angle_begin; /* -180 - + 180 with 2 deg step */
1894 u16 work_horizontal_angle_end; /* -180 - + 180 with 2 deg step */
1895};
1896
1897/* Values for Type field above */
1898
1899#define ACPI_NHLT_MIC_OMNIDIRECTIONAL 0
1900#define ACPI_NHLT_MIC_SUBCARDIOID 1
1901#define ACPI_NHLT_MIC_CARDIOID 2
1902#define ACPI_NHLT_MIC_SUPER_CARDIOID 3
1903#define ACPI_NHLT_MIC_HYPER_CARDIOID 4
1904#define ACPI_NHLT_MIC_8_SHAPED 5
1905#define ACPI_NHLT_MIC_RESERVED6 6 /* 6 is reserved */
1906#define ACPI_NHLT_MIC_VENDOR_DEFINED 7
1907#define ACPI_NHLT_MIC_RESERVED 8 /* 8 and above are reserved */
1908
1909/* Values for Panel field above */
1910
1911#define ACPI_NHLT_MIC_POSITION_TOP 0
1912#define ACPI_NHLT_MIC_POSITION_BOTTOM 1
1913#define ACPI_NHLT_MIC_POSITION_LEFT 2
1914#define ACPI_NHLT_MIC_POSITION_RIGHT 3
1915#define ACPI_NHLT_MIC_POSITION_FRONT 4
1916#define ACPI_NHLT_MIC_POSITION_BACK 5
1917#define ACPI_NHLT_MIC_POSITION_RESERVED 6 /* 6 and above are reserved */
1918
1919struct acpi_nhlt_vendor_mic_device_specific_config {
1920 struct acpi_nhlt_mic_device_specific_config mic_array_device_config;
1921 u8 number_of_microphones;
1922 struct acpi_nhlt_vendor_mic_config mic_config[]; /* Indexed by number_of_microphones */
1923};
1924
1925/* Microphone SNR and Sensitivity extension */
1926
1927struct acpi_nhlt_mic_snr_sensitivity_extension {
1928 u32 SNR;
1929 u32 sensitivity;
1930};
1931
1932/* Render device with feedback */
1933
1934struct acpi_nhlt_render_feedback_device_specific_config {
1935 u8 feedback_virtual_slot; /* Render slot in case of capture */
1936 u16 feedback_channels; /* Informative only */
1937 u16 feedback_valid_bits_per_sample;
1938};
1939
1940/* Non documented structures */
1941
1942struct acpi_nhlt_device_info_count {
1943 u8 structure_count;
1944};
1945
1946struct acpi_nhlt_device_info {
1947 u8 device_id[16];
1948 u8 device_instance_id;
1949 u8 device_port_id;
1950};
1951
1952/*******************************************************************************
1953 *
1954 * PCCT - Platform Communications Channel Table (ACPI 5.0)
1955 * Version 2 (ACPI 6.2)
1956 *
1957 ******************************************************************************/
1958
1959struct acpi_table_pcct {
1960 struct acpi_table_header header; /* Common ACPI table header */
1961 u32 flags;
1962 u64 reserved;
1963};
1964
1965/* Values for Flags field above */
1966
1967#define ACPI_PCCT_DOORBELL 1
1968
1969/* Values for subtable type in struct acpi_subtable_header */
1970
1971enum acpi_pcct_type {
1972 ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
1973 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE = 1,
1974 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2 = 2, /* ACPI 6.1 */
1975 ACPI_PCCT_TYPE_EXT_PCC_MASTER_SUBSPACE = 3, /* ACPI 6.2 */
1976 ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE = 4, /* ACPI 6.2 */
1977 ACPI_PCCT_TYPE_HW_REG_COMM_SUBSPACE = 5, /* ACPI 6.4 */
1978 ACPI_PCCT_TYPE_RESERVED = 6 /* 6 and greater are reserved */
1979};
1980
1981/*
1982 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
1983 */
1984
1985/* 0: Generic Communications Subspace */
1986
1987struct acpi_pcct_subspace {
1988 struct acpi_subtable_header header;
1989 u8 reserved[6];
1990 u64 base_address;
1991 u64 length;
1992 struct acpi_generic_address doorbell_register;
1993 u64 preserve_mask;
1994 u64 write_mask;
1995 u32 latency;
1996 u32 max_access_rate;
1997 u16 min_turnaround_time;
1998};
1999
2000/* 1: HW-reduced Communications Subspace (ACPI 5.1) */
2001
2002struct acpi_pcct_hw_reduced {
2003 struct acpi_subtable_header header;
2004 u32 platform_interrupt;
2005 u8 flags;
2006 u8 reserved;
2007 u64 base_address;
2008 u64 length;
2009 struct acpi_generic_address doorbell_register;
2010 u64 preserve_mask;
2011 u64 write_mask;
2012 u32 latency;
2013 u32 max_access_rate;
2014 u16 min_turnaround_time;
2015};
2016
2017/* 2: HW-reduced Communications Subspace Type 2 (ACPI 6.1) */
2018
2019struct acpi_pcct_hw_reduced_type2 {
2020 struct acpi_subtable_header header;
2021 u32 platform_interrupt;
2022 u8 flags;
2023 u8 reserved;
2024 u64 base_address;
2025 u64 length;
2026 struct acpi_generic_address doorbell_register;
2027 u64 preserve_mask;
2028 u64 write_mask;
2029 u32 latency;
2030 u32 max_access_rate;
2031 u16 min_turnaround_time;
2032 struct acpi_generic_address platform_ack_register;
2033 u64 ack_preserve_mask;
2034 u64 ack_write_mask;
2035};
2036
2037/* 3: Extended PCC Master Subspace Type 3 (ACPI 6.2) */
2038
2039struct acpi_pcct_ext_pcc_master {
2040 struct acpi_subtable_header header;
2041 u32 platform_interrupt;
2042 u8 flags;
2043 u8 reserved1;
2044 u64 base_address;
2045 u32 length;
2046 struct acpi_generic_address doorbell_register;
2047 u64 preserve_mask;
2048 u64 write_mask;
2049 u32 latency;
2050 u32 max_access_rate;
2051 u32 min_turnaround_time;
2052 struct acpi_generic_address platform_ack_register;
2053 u64 ack_preserve_mask;
2054 u64 ack_set_mask;
2055 u64 reserved2;
2056 struct acpi_generic_address cmd_complete_register;
2057 u64 cmd_complete_mask;
2058 struct acpi_generic_address cmd_update_register;
2059 u64 cmd_update_preserve_mask;
2060 u64 cmd_update_set_mask;
2061 struct acpi_generic_address error_status_register;
2062 u64 error_status_mask;
2063};
2064
2065/* 4: Extended PCC Slave Subspace Type 4 (ACPI 6.2) */
2066
2067struct acpi_pcct_ext_pcc_slave {
2068 struct acpi_subtable_header header;
2069 u32 platform_interrupt;
2070 u8 flags;
2071 u8 reserved1;
2072 u64 base_address;
2073 u32 length;
2074 struct acpi_generic_address doorbell_register;
2075 u64 preserve_mask;
2076 u64 write_mask;
2077 u32 latency;
2078 u32 max_access_rate;
2079 u32 min_turnaround_time;
2080 struct acpi_generic_address platform_ack_register;
2081 u64 ack_preserve_mask;
2082 u64 ack_set_mask;
2083 u64 reserved2;
2084 struct acpi_generic_address cmd_complete_register;
2085 u64 cmd_complete_mask;
2086 struct acpi_generic_address cmd_update_register;
2087 u64 cmd_update_preserve_mask;
2088 u64 cmd_update_set_mask;
2089 struct acpi_generic_address error_status_register;
2090 u64 error_status_mask;
2091};
2092
2093/* 5: HW Registers based Communications Subspace */
2094
2095struct acpi_pcct_hw_reg {
2096 struct acpi_subtable_header header;
2097 u16 version;
2098 u64 base_address;
2099 u64 length;
2100 struct acpi_generic_address doorbell_register;
2101 u64 doorbell_preserve;
2102 u64 doorbell_write;
2103 struct acpi_generic_address cmd_complete_register;
2104 u64 cmd_complete_mask;
2105 struct acpi_generic_address error_status_register;
2106 u64 error_status_mask;
2107 u32 nominal_latency;
2108 u32 min_turnaround_time;
2109};
2110
2111/* Values for doorbell flags above */
2112
2113#define ACPI_PCCT_INTERRUPT_POLARITY (1)
2114#define ACPI_PCCT_INTERRUPT_MODE (1<<1)
2115
2116/*
2117 * PCC memory structures (not part of the ACPI table)
2118 */
2119
2120/* Shared Memory Region */
2121
2122struct acpi_pcct_shared_memory {
2123 u32 signature;
2124 u16 command;
2125 u16 status;
2126};
2127
2128/* Extended PCC Subspace Shared Memory Region (ACPI 6.2) */
2129
2130struct acpi_pcct_ext_pcc_shared_memory {
2131 u32 signature;
2132 u32 flags;
2133 u32 length;
2134 u32 command;
2135};
2136
2137/*******************************************************************************
2138 *
2139 * PDTT - Platform Debug Trigger Table (ACPI 6.2)
2140 * Version 0
2141 *
2142 ******************************************************************************/
2143
2144struct acpi_table_pdtt {
2145 struct acpi_table_header header; /* Common ACPI table header */
2146 u8 trigger_count;
2147 u8 reserved[3];
2148 u32 array_offset;
2149};
2150
2151/*
2152 * PDTT Communication Channel Identifier Structure.
2153 * The number of these structures is defined by trigger_count above,
2154 * starting at array_offset.
2155 */
2156struct acpi_pdtt_channel {
2157 u8 subchannel_id;
2158 u8 flags;
2159};
2160
2161/* Flags for above */
2162
2163#define ACPI_PDTT_RUNTIME_TRIGGER (1)
2164#define ACPI_PDTT_WAIT_COMPLETION (1<<1)
2165#define ACPI_PDTT_TRIGGER_ORDER (1<<2)
2166
2167/*******************************************************************************
2168 *
2169 * PHAT - Platform Health Assessment Table (ACPI 6.4)
2170 * Version 1
2171 *
2172 ******************************************************************************/
2173
2174struct acpi_table_phat {
2175 struct acpi_table_header header; /* Common ACPI table header */
2176};
2177
2178/* Common header for PHAT subtables that follow main table */
2179
2180struct acpi_phat_header {
2181 u16 type;
2182 u16 length;
2183 u8 revision;
2184};
2185
2186/* Values for Type field above */
2187
2188#define ACPI_PHAT_TYPE_FW_VERSION_DATA 0
2189#define ACPI_PHAT_TYPE_FW_HEALTH_DATA 1
2190#define ACPI_PHAT_TYPE_RESERVED 2 /* 0x02-0xFFFF are reserved */
2191
2192/*
2193 * PHAT subtables, correspond to Type in struct acpi_phat_header
2194 */
2195
2196/* 0: Firmware Version Data Record */
2197
2198struct acpi_phat_version_data {
2199 struct acpi_phat_header header;
2200 u8 reserved[3];
2201 u32 element_count;
2202};
2203
2204struct acpi_phat_version_element {
2205 u8 guid[16];
2206 u64 version_value;
2207 u32 producer_id;
2208};
2209
2210/* 1: Firmware Health Data Record */
2211
2212struct acpi_phat_health_data {
2213 struct acpi_phat_header header;
2214 u8 reserved[2];
2215 u8 health;
2216 u8 device_guid[16];
2217 u32 device_specific_offset; /* Zero if no Device-specific data */
2218};
2219
2220/* Values for Health field above */
2221
2222#define ACPI_PHAT_ERRORS_FOUND 0
2223#define ACPI_PHAT_NO_ERRORS 1
2224#define ACPI_PHAT_UNKNOWN_ERRORS 2
2225#define ACPI_PHAT_ADVISORY 3
2226
2227/*******************************************************************************
2228 *
2229 * PMTT - Platform Memory Topology Table (ACPI 5.0)
2230 * Version 1
2231 *
2232 ******************************************************************************/
2233
2234struct acpi_table_pmtt {
2235 struct acpi_table_header header; /* Common ACPI table header */
2236 u32 memory_device_count;
2237 /*
2238 * Immediately followed by:
2239 * MEMORY_DEVICE memory_device_struct[memory_device_count];
2240 */
2241};
2242
2243/* Common header for PMTT subtables that follow main table */
2244
2245struct acpi_pmtt_header {
2246 u8 type;
2247 u8 reserved1;
2248 u16 length;
2249 u16 flags;
2250 u16 reserved2;
2251 u32 memory_device_count; /* Zero means no memory device structs follow */
2252 /*
2253 * Immediately followed by:
2254 * u8 type_specific_data[]
2255 * MEMORY_DEVICE memory_device_struct[memory_device_count];
2256 */
2257};
2258
2259/* Values for Type field above */
2260
2261#define ACPI_PMTT_TYPE_SOCKET 0
2262#define ACPI_PMTT_TYPE_CONTROLLER 1
2263#define ACPI_PMTT_TYPE_DIMM 2
2264#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFE are reserved */
2265#define ACPI_PMTT_TYPE_VENDOR 0xFF
2266
2267/* Values for Flags field above */
2268
2269#define ACPI_PMTT_TOP_LEVEL 0x0001
2270#define ACPI_PMTT_PHYSICAL 0x0002
2271#define ACPI_PMTT_MEMORY_TYPE 0x000C
2272
2273/*
2274 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
2275 */
2276
2277/* 0: Socket Structure */
2278
2279struct acpi_pmtt_socket {
2280 struct acpi_pmtt_header header;
2281 u16 socket_id;
2282 u16 reserved;
2283};
2284 /*
2285 * Immediately followed by:
2286 * MEMORY_DEVICE memory_device_struct[memory_device_count];
2287 */
2288
2289/* 1: Memory Controller subtable */
2290
2291struct acpi_pmtt_controller {
2292 struct acpi_pmtt_header header;
2293 u16 controller_id;
2294 u16 reserved;
2295};
2296 /*
2297 * Immediately followed by:
2298 * MEMORY_DEVICE memory_device_struct[memory_device_count];
2299 */
2300
2301/* 2: Physical Component Identifier (DIMM) */
2302
2303struct acpi_pmtt_physical_component {
2304 struct acpi_pmtt_header header;
2305 u32 bios_handle;
2306};
2307
2308/* 0xFF: Vendor Specific Data */
2309
2310struct acpi_pmtt_vendor_specific {
2311 struct acpi_pmtt_header header;
2312 u8 type_uuid[16];
2313 u8 specific[];
2314 /*
2315 * Immediately followed by:
2316 * u8 vendor_specific_data[];
2317 * MEMORY_DEVICE memory_device_struct[memory_device_count];
2318 */
2319};
2320
2321/*******************************************************************************
2322 *
2323 * PPTT - Processor Properties Topology Table (ACPI 6.2)
2324 * Version 1
2325 *
2326 ******************************************************************************/
2327
2328struct acpi_table_pptt {
2329 struct acpi_table_header header; /* Common ACPI table header */
2330};
2331
2332/* Values for Type field above */
2333
2334enum acpi_pptt_type {
2335 ACPI_PPTT_TYPE_PROCESSOR = 0,
2336 ACPI_PPTT_TYPE_CACHE = 1,
2337 ACPI_PPTT_TYPE_ID = 2,
2338 ACPI_PPTT_TYPE_RESERVED = 3
2339};
2340
2341/* 0: Processor Hierarchy Node Structure */
2342
2343struct acpi_pptt_processor {
2344 struct acpi_subtable_header header;
2345 u16 reserved;
2346 u32 flags;
2347 u32 parent;
2348 u32 acpi_processor_id;
2349 u32 number_of_priv_resources;
2350};
2351
2352/* Flags */
2353
2354#define ACPI_PPTT_PHYSICAL_PACKAGE (1)
2355#define ACPI_PPTT_ACPI_PROCESSOR_ID_VALID (1<<1)
2356#define ACPI_PPTT_ACPI_PROCESSOR_IS_THREAD (1<<2) /* ACPI 6.3 */
2357#define ACPI_PPTT_ACPI_LEAF_NODE (1<<3) /* ACPI 6.3 */
2358#define ACPI_PPTT_ACPI_IDENTICAL (1<<4) /* ACPI 6.3 */
2359
2360/* 1: Cache Type Structure */
2361
2362struct acpi_pptt_cache {
2363 struct acpi_subtable_header header;
2364 u16 reserved;
2365 u32 flags;
2366 u32 next_level_of_cache;
2367 u32 size;
2368 u32 number_of_sets;
2369 u8 associativity;
2370 u8 attributes;
2371 u16 line_size;
2372};
2373
2374/* 1: Cache Type Structure for PPTT version 3 */
2375
2376struct acpi_pptt_cache_v1 {
2377 u32 cache_id;
2378};
2379
2380/* Flags */
2381
2382#define ACPI_PPTT_SIZE_PROPERTY_VALID (1) /* Physical property valid */
2383#define ACPI_PPTT_NUMBER_OF_SETS_VALID (1<<1) /* Number of sets valid */
2384#define ACPI_PPTT_ASSOCIATIVITY_VALID (1<<2) /* Associativity valid */
2385#define ACPI_PPTT_ALLOCATION_TYPE_VALID (1<<3) /* Allocation type valid */
2386#define ACPI_PPTT_CACHE_TYPE_VALID (1<<4) /* Cache type valid */
2387#define ACPI_PPTT_WRITE_POLICY_VALID (1<<5) /* Write policy valid */
2388#define ACPI_PPTT_LINE_SIZE_VALID (1<<6) /* Line size valid */
2389#define ACPI_PPTT_CACHE_ID_VALID (1<<7) /* Cache ID valid */
2390
2391/* Masks for Attributes */
2392
2393#define ACPI_PPTT_MASK_ALLOCATION_TYPE (0x03) /* Allocation type */
2394#define ACPI_PPTT_MASK_CACHE_TYPE (0x0C) /* Cache type */
2395#define ACPI_PPTT_MASK_WRITE_POLICY (0x10) /* Write policy */
2396
2397/* Attributes describing cache */
2398#define ACPI_PPTT_CACHE_READ_ALLOCATE (0x0) /* Cache line is allocated on read */
2399#define ACPI_PPTT_CACHE_WRITE_ALLOCATE (0x01) /* Cache line is allocated on write */
2400#define ACPI_PPTT_CACHE_RW_ALLOCATE (0x02) /* Cache line is allocated on read and write */
2401#define ACPI_PPTT_CACHE_RW_ALLOCATE_ALT (0x03) /* Alternate representation of above */
2402
2403#define ACPI_PPTT_CACHE_TYPE_DATA (0x0) /* Data cache */
2404#define ACPI_PPTT_CACHE_TYPE_INSTR (1<<2) /* Instruction cache */
2405#define ACPI_PPTT_CACHE_TYPE_UNIFIED (2<<2) /* Unified I & D cache */
2406#define ACPI_PPTT_CACHE_TYPE_UNIFIED_ALT (3<<2) /* Alternate representation of above */
2407
2408#define ACPI_PPTT_CACHE_POLICY_WB (0x0) /* Cache is write back */
2409#define ACPI_PPTT_CACHE_POLICY_WT (1<<4) /* Cache is write through */
2410
2411/* 2: ID Structure */
2412
2413struct acpi_pptt_id {
2414 struct acpi_subtable_header header;
2415 u16 reserved;
2416 u32 vendor_id;
2417 u64 level1_id;
2418 u64 level2_id;
2419 u16 major_rev;
2420 u16 minor_rev;
2421 u16 spin_rev;
2422};
2423
2424/*******************************************************************************
2425 *
2426 * PRMT - Platform Runtime Mechanism Table
2427 * Version 1
2428 *
2429 ******************************************************************************/
2430
2431struct acpi_table_prmt {
2432 struct acpi_table_header header; /* Common ACPI table header */
2433};
2434
2435struct acpi_table_prmt_header {
2436 u8 platform_guid[16];
2437 u32 module_info_offset;
2438 u32 module_info_count;
2439};
2440
2441struct acpi_prmt_module_header {
2442 u16 revision;
2443 u16 length;
2444};
2445
2446struct acpi_prmt_module_info {
2447 u16 revision;
2448 u16 length;
2449 u8 module_guid[16];
2450 u16 major_rev;
2451 u16 minor_rev;
2452 u16 handler_info_count;
2453 u32 handler_info_offset;
2454 u64 mmio_list_pointer;
2455};
2456
2457struct acpi_prmt_handler_info {
2458 u16 revision;
2459 u16 length;
2460 u8 handler_guid[16];
2461 u64 handler_address;
2462 u64 static_data_buffer_address;
2463 u64 acpi_param_buffer_address;
2464};
2465
2466/*******************************************************************************
2467 *
2468 * RASF - RAS Feature Table (ACPI 5.0)
2469 * Version 1
2470 *
2471 ******************************************************************************/
2472
2473struct acpi_table_rasf {
2474 struct acpi_table_header header; /* Common ACPI table header */
2475 u8 channel_id[12];
2476};
2477
2478/* RASF Platform Communication Channel Shared Memory Region */
2479
2480struct acpi_rasf_shared_memory {
2481 u32 signature;
2482 u16 command;
2483 u16 status;
2484 u16 version;
2485 u8 capabilities[16];
2486 u8 set_capabilities[16];
2487 u16 num_parameter_blocks;
2488 u32 set_capabilities_status;
2489};
2490
2491/* RASF Parameter Block Structure Header */
2492
2493struct acpi_rasf_parameter_block {
2494 u16 type;
2495 u16 version;
2496 u16 length;
2497};
2498
2499/* RASF Parameter Block Structure for PATROL_SCRUB */
2500
2501struct acpi_rasf_patrol_scrub_parameter {
2502 struct acpi_rasf_parameter_block header;
2503 u16 patrol_scrub_command;
2504 u64 requested_address_range[2];
2505 u64 actual_address_range[2];
2506 u16 flags;
2507 u8 requested_speed;
2508};
2509
2510/* Masks for Flags and Speed fields above */
2511
2512#define ACPI_RASF_SCRUBBER_RUNNING 1
2513#define ACPI_RASF_SPEED (7<<1)
2514#define ACPI_RASF_SPEED_SLOW (0<<1)
2515#define ACPI_RASF_SPEED_MEDIUM (4<<1)
2516#define ACPI_RASF_SPEED_FAST (7<<1)
2517
2518/* Channel Commands */
2519
2520enum acpi_rasf_commands {
2521 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
2522};
2523
2524/* Platform RAS Capabilities */
2525
2526enum acpi_rasf_capabiliities {
2527 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
2528 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
2529};
2530
2531/* Patrol Scrub Commands */
2532
2533enum acpi_rasf_patrol_scrub_commands {
2534 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
2535 ACPI_RASF_START_PATROL_SCRUBBER = 2,
2536 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
2537};
2538
2539/* Channel Command flags */
2540
2541#define ACPI_RASF_GENERATE_SCI (1<<15)
2542
2543/* Status values */
2544
2545enum acpi_rasf_status {
2546 ACPI_RASF_SUCCESS = 0,
2547 ACPI_RASF_NOT_VALID = 1,
2548 ACPI_RASF_NOT_SUPPORTED = 2,
2549 ACPI_RASF_BUSY = 3,
2550 ACPI_RASF_FAILED = 4,
2551 ACPI_RASF_ABORTED = 5,
2552 ACPI_RASF_INVALID_DATA = 6
2553};
2554
2555/* Status flags */
2556
2557#define ACPI_RASF_COMMAND_COMPLETE (1)
2558#define ACPI_RASF_SCI_DOORBELL (1<<1)
2559#define ACPI_RASF_ERROR (1<<2)
2560#define ACPI_RASF_STATUS (0x1F<<3)
2561
2562/*******************************************************************************
2563 *
2564 * RGRT - Regulatory Graphics Resource Table
2565 * Version 1
2566 *
2567 * Conforms to "ACPI RGRT" available at:
2568 * https://microsoft.github.io/mu/dyn/mu_plus/ms_core_pkg/acpi_RGRT/feature_acpi_rgrt/
2569 *
2570 ******************************************************************************/
2571
2572struct acpi_table_rgrt {
2573 struct acpi_table_header header; /* Common ACPI table header */
2574 u16 version;
2575 u8 image_type;
2576 u8 reserved;
2577 u8 image[];
2578};
2579
2580/* image_type values */
2581
2582enum acpi_rgrt_image_type {
2583 ACPI_RGRT_TYPE_RESERVED0 = 0,
2584 ACPI_RGRT_IMAGE_TYPE_PNG = 1,
2585 ACPI_RGRT_TYPE_RESERVED = 2 /* 2 and greater are reserved */
2586};
2587
2588/*******************************************************************************
2589 *
2590 * SBST - Smart Battery Specification Table
2591 * Version 1
2592 *
2593 ******************************************************************************/
2594
2595struct acpi_table_sbst {
2596 struct acpi_table_header header; /* Common ACPI table header */
2597 u32 warning_level;
2598 u32 low_level;
2599 u32 critical_level;
2600};
2601
2602/*******************************************************************************
2603 *
2604 * SDEI - Software Delegated Exception Interface Descriptor Table
2605 *
2606 * Conforms to "Software Delegated Exception Interface (SDEI)" ARM DEN0054A,
2607 * May 8th, 2017. Copyright 2017 ARM Ltd.
2608 *
2609 ******************************************************************************/
2610
2611struct acpi_table_sdei {
2612 struct acpi_table_header header; /* Common ACPI table header */
2613};
2614
2615/*******************************************************************************
2616 *
2617 * SDEV - Secure Devices Table (ACPI 6.2)
2618 * Version 1
2619 *
2620 ******************************************************************************/
2621
2622struct acpi_table_sdev {
2623 struct acpi_table_header header; /* Common ACPI table header */
2624};
2625
2626struct acpi_sdev_header {
2627 u8 type;
2628 u8 flags;
2629 u16 length;
2630};
2631
2632/* Values for subtable type above */
2633
2634enum acpi_sdev_type {
2635 ACPI_SDEV_TYPE_NAMESPACE_DEVICE = 0,
2636 ACPI_SDEV_TYPE_PCIE_ENDPOINT_DEVICE = 1,
2637 ACPI_SDEV_TYPE_RESERVED = 2 /* 2 and greater are reserved */
2638};
2639
2640/* Values for flags above */
2641
2642#define ACPI_SDEV_HANDOFF_TO_UNSECURE_OS (1)
2643#define ACPI_SDEV_SECURE_COMPONENTS_PRESENT (1<<1)
2644
2645/*
2646 * SDEV subtables
2647 */
2648
2649/* 0: Namespace Device Based Secure Device Structure */
2650
2651struct acpi_sdev_namespace {
2652 struct acpi_sdev_header header;
2653 u16 device_id_offset;
2654 u16 device_id_length;
2655 u16 vendor_data_offset;
2656 u16 vendor_data_length;
2657};
2658
2659struct acpi_sdev_secure_component {
2660 u16 secure_component_offset;
2661 u16 secure_component_length;
2662};
2663
2664/*
2665 * SDEV sub-subtables ("Components") for above
2666 */
2667struct acpi_sdev_component {
2668 struct acpi_sdev_header header;
2669};
2670
2671/* Values for sub-subtable type above */
2672
2673enum acpi_sac_type {
2674 ACPI_SDEV_TYPE_ID_COMPONENT = 0,
2675 ACPI_SDEV_TYPE_MEM_COMPONENT = 1
2676};
2677
2678struct acpi_sdev_id_component {
2679 struct acpi_sdev_header header;
2680 u16 hardware_id_offset;
2681 u16 hardware_id_length;
2682 u16 subsystem_id_offset;
2683 u16 subsystem_id_length;
2684 u16 hardware_revision;
2685 u8 hardware_rev_present;
2686 u8 class_code_present;
2687 u8 pci_base_class;
2688 u8 pci_sub_class;
2689 u8 pci_programming_xface;
2690};
2691
2692struct acpi_sdev_mem_component {
2693 struct acpi_sdev_header header;
2694 u32 reserved;
2695 u64 memory_base_address;
2696 u64 memory_length;
2697};
2698
2699/* 1: PCIe Endpoint Device Based Device Structure */
2700
2701struct acpi_sdev_pcie {
2702 struct acpi_sdev_header header;
2703 u16 segment;
2704 u16 start_bus;
2705 u16 path_offset;
2706 u16 path_length;
2707 u16 vendor_data_offset;
2708 u16 vendor_data_length;
2709};
2710
2711/* 1a: PCIe Endpoint path entry */
2712
2713struct acpi_sdev_pcie_path {
2714 u8 device;
2715 u8 function;
2716};
2717
2718/*******************************************************************************
2719 *
2720 * SVKL - Storage Volume Key Location Table (ACPI 6.4)
2721 * From: "Guest-Host-Communication Interface (GHCI) for Intel
2722 * Trust Domain Extensions (Intel TDX)".
2723 * Version 1
2724 *
2725 ******************************************************************************/
2726
2727struct acpi_table_svkl {
2728 struct acpi_table_header header; /* Common ACPI table header */
2729 u32 count;
2730};
2731
2732struct acpi_svkl_key {
2733 u16 type;
2734 u16 format;
2735 u32 size;
2736 u64 address;
2737};
2738
2739enum acpi_svkl_type {
2740 ACPI_SVKL_TYPE_MAIN_STORAGE = 0,
2741 ACPI_SVKL_TYPE_RESERVED = 1 /* 1 and greater are reserved */
2742};
2743
2744enum acpi_svkl_format {
2745 ACPI_SVKL_FORMAT_RAW_BINARY = 0,
2746 ACPI_SVKL_FORMAT_RESERVED = 1 /* 1 and greater are reserved */
2747};
2748
2749/*******************************************************************************
2750 *
2751 * TDEL - TD-Event Log
2752 * From: "Guest-Host-Communication Interface (GHCI) for Intel
2753 * Trust Domain Extensions (Intel TDX)".
2754 * September 2020
2755 *
2756 ******************************************************************************/
2757
2758struct acpi_table_tdel {
2759 struct acpi_table_header header; /* Common ACPI table header */
2760 u32 reserved;
2761 u64 log_area_minimum_length;
2762 u64 log_area_start_address;
2763};
2764
2765/* Reset to default packing */
2766
2767#pragma pack()
2768
2769#endif /* __ACTBL2_H__ */