actbl2.h revision 1.1.1.20 1 /******************************************************************************
2 *
3 * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2021, 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 MERCHANTABILITY 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 *
50 * Additional ACPI Tables (2)
51 *
52 * These tables are not consumed directly by the ACPICA subsystem, but are
53 * included here to support device drivers and the AML disassembler.
54 *
55 ******************************************************************************/
56
57
58 /*
59 * Values for description table header signatures for tables defined in this
60 * file. Useful because they make it more difficult to inadvertently type in
61 * the wrong signature.
62 */
63 #define ACPI_SIG_BDAT "BDAT" /* BIOS Data ACPI Table */
64 #define ACPI_SIG_IORT "IORT" /* IO Remapping Table */
65 #define ACPI_SIG_IVRS "IVRS" /* I/O Virtualization Reporting Structure */
66 #define ACPI_SIG_LPIT "LPIT" /* Low Power Idle Table */
67 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
68 #define ACPI_SIG_MCFG "MCFG" /* PCI Memory Mapped Configuration table */
69 #define ACPI_SIG_MCHI "MCHI" /* Management Controller Host Interface table */
70 #define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
71 #define ACPI_SIG_MSCT "MSCT" /* Maximum System Characteristics Table */
72 #define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
73 #define ACPI_SIG_NFIT "NFIT" /* NVDIMM Firmware Interface Table */
74 #define ACPI_SIG_NHLT "NHLT" /* Non HD Audio Link Table */
75 #define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
76 #define ACPI_SIG_PDTT "PDTT" /* Platform Debug Trigger Table */
77 #define ACPI_SIG_PHAT "PHAT" /* Platform Health Assessment Table */
78 #define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
79 #define ACPI_SIG_PPTT "PPTT" /* Processor Properties Topology Table */
80 #define ACPI_SIG_PRMT "PRMT" /* Platform Runtime Mechanism Table */
81 #define ACPI_SIG_RASF "RASF" /* RAS Feature table */
82 #define ACPI_SIG_RGRT "RGRT" /* Regulatory Graphics Resource Table */
83 #define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
84 #define ACPI_SIG_SDEI "SDEI" /* Software Delegated Exception Interface Table */
85 #define ACPI_SIG_SDEV "SDEV" /* Secure Devices table */
86 #define ACPI_SIG_SVKL "SVKL" /* Storage Volume Key Location Table */
87
88
89 /*
90 * All tables must be byte-packed to match the ACPI specification, since
91 * the tables are provided by the system BIOS.
92 */
93 #pragma pack(1)
94
95 /*
96 * Note: C bitfields are not used for this reason:
97 *
98 * "Bitfields are great and easy to read, but unfortunately the C language
99 * does not specify the layout of bitfields in memory, which means they are
100 * essentially useless for dealing with packed data in on-disk formats or
101 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
102 * this decision was a design error in C. Ritchie could have picked an order
103 * and stuck with it." Norman Ramsey.
104 * See http://stackoverflow.com/a/1053662/41661
105 */
106
107
108 /*******************************************************************************
109 *
110 * AEST - Arm Error Source Table
111 *
112 * Conforms to: ACPI for the Armv8 RAS Extensions 1.1 Platform Design Document
113 * September 2020.
114 *
115 ******************************************************************************/
116
117 typedef struct acpi_table_aest
118 {
119 ACPI_TABLE_HEADER Header;
120 void *NodeArray[];
121
122 } ACPI_TABLE_AEST;
123
124 /* Common Subtable header - one per Node Structure (Subtable) */
125
126 typedef struct acpi_aest_hdr
127 {
128 UINT8 Type;
129 UINT16 Length;
130 UINT8 Reserved;
131 UINT32 NodeSpecificOffset;
132 UINT32 NodeInterfaceOffset;
133 UINT32 NodeInterruptOffset;
134 UINT32 NodeInterruptCount;
135 UINT64 TimestampRate;
136 UINT64 Reserved1;
137 UINT64 ErrorInjectionRate;
138
139 } ACPI_AEST_HEADER;
140
141 /* Values for Type above */
142
143 #define ACPI_AEST_PROCESSOR_ERROR_NODE 0
144 #define ACPI_AEST_MEMORY_ERROR_NODE 1
145 #define ACPI_AEST_SMMU_ERROR_NODE 2
146 #define ACPI_AEST_VENDOR_ERROR_NODE 3
147 #define ACPI_AEST_GIC_ERROR_NODE 4
148 #define ACPI_AEST_NODE_TYPE_RESERVED 5 /* 5 and above are reserved */
149
150
151 /*
152 * AEST subtables (Error nodes)
153 */
154
155 /* 0: Processor Error */
156
157 typedef struct acpi_aest_processor
158 {
159 UINT32 ProcessorId;
160 UINT8 ResourceType;
161 UINT8 Reserved;
162 UINT8 Flags;
163 UINT8 Revision;
164 UINT64 ProcessorAffinity;
165
166 } ACPI_AEST_PROCESSOR;
167
168 /* Values for ResourceType above, related structs below */
169
170 #define ACPI_AEST_CACHE_RESOURCE 0
171 #define ACPI_AEST_TLB_RESOURCE 1
172 #define ACPI_AEST_GENERIC_RESOURCE 2
173 #define ACPI_AEST_RESOURCE_RESERVED 3 /* 3 and above are reserved */
174
175 /* 0R: Processor Cache Resource Substructure */
176
177 typedef struct acpi_aest_processor_cache
178 {
179 UINT32 CacheReference;
180 UINT32 Reserved;
181
182 } ACPI_AEST_PROCESSOR_CACHE;
183
184 /* Values for CacheType above */
185
186 #define ACPI_AEST_CACHE_DATA 0
187 #define ACPI_AEST_CACHE_INSTRUCTION 1
188 #define ACPI_AEST_CACHE_UNIFIED 2
189 #define ACPI_AEST_CACHE_RESERVED 3 /* 3 and above are reserved */
190
191 /* 1R: Processor TLB Resource Substructure */
192
193 typedef struct acpi_aest_processor_tlb
194 {
195 UINT32 TlbLevel;
196 UINT32 Reserved;
197
198 } ACPI_AEST_PROCESSOR_TLB;
199
200 /* 2R: Processor Generic Resource Substructure */
201
202 typedef struct acpi_aest_processor_generic
203 {
204 UINT8 *Resource;
205
206 } ACPI_AEST_PROCESSOR_GENERIC;
207
208 /* 1: Memory Error */
209
210 typedef struct acpi_aest_memory
211 {
212 UINT32 SratProximityDomain;
213
214 } ACPI_AEST_MEMORY;
215
216 /* 2: Smmu Error */
217
218 typedef struct acpi_aest_smmu
219 {
220 UINT32 IortNodeReference;
221 UINT32 SubcomponentReference;
222
223 } ACPI_AEST_SMMU;
224
225 /* 3: Vendor Defined */
226
227 typedef struct acpi_aest_vendor
228 {
229 UINT32 AcpiHid;
230 UINT32 AcpiUid;
231 UINT8 VendorSpecificData[16];
232
233 } ACPI_AEST_VENDOR;
234
235 /* 4: Gic Error */
236
237 typedef struct acpi_aest_gic
238 {
239 UINT32 InterfaceType;
240 UINT32 InstanceId;
241
242 } ACPI_AEST_GIC;
243
244 /* Values for InterfaceType above */
245
246 #define ACPI_AEST_GIC_CPU 0
247 #define ACPI_AEST_GIC_DISTRIBUTOR 1
248 #define ACPI_AEST_GIC_REDISTRIBUTOR 2
249 #define ACPI_AEST_GIC_ITS 3
250 #define ACPI_AEST_GIC_RESERVED 4 /* 4 and above are reserved */
251
252
253 /* Node Interface Structure */
254
255 typedef struct acpi_aest_node_interface
256 {
257 UINT8 Type;
258 UINT8 Reserved[3];
259 UINT32 Flags;
260 UINT64 Address;
261 UINT32 ErrorRecordIndex;
262 UINT32 ErrorRecordCount;
263 UINT64 ErrorRecordImplemented;
264 UINT64 ErrorStatusReporting;
265 UINT64 AddressingMode;
266
267 } ACPI_AEST_NODE_INTERFACE;
268
269 /* Values for Type field above */
270
271 #define ACPI_AEST_NODE_SYSTEM_REGISTER 0
272 #define ACPI_AEST_NODE_MEMORY_MAPPED 1
273 #define ACPI_AEST_XFACE_RESERVED 2 /* 2 and above are reserved */
274
275 /* Node Interrupt Structure */
276
277 typedef struct acpi_aest_node_interrupt
278 {
279 UINT8 Type;
280 UINT8 Reserved[2];
281 UINT8 Flags;
282 UINT32 Gsiv;
283 UINT8 IortId;
284 UINT8 Reserved1[3];
285
286 } ACPI_AEST_NODE_INTERRUPT;
287
288 /* Values for Type field above */
289
290 #define ACPI_AEST_NODE_FAULT_HANDLING 0
291 #define ACPI_AEST_NODE_ERROR_RECOVERY 1
292 #define ACPI_AEST_XRUPT_RESERVED 2 /* 2 and above are reserved */
293
294
295 /*******************************************************************************
296 *
297 * BDAT - BIOS Data ACPI Table
298 *
299 * Conforms to "BIOS Data ACPI Table", Interface Specification v4.0 Draft 5
300 * Nov 2020
301 *
302 ******************************************************************************/
303
304 typedef struct acpi_table_bdat
305 {
306 ACPI_TABLE_HEADER Header;
307 ACPI_GENERIC_ADDRESS Gas;
308
309 } ACPI_TABLE_BDAT;
310
311
312 /*******************************************************************************
313 *
314 * IORT - IO Remapping Table
315 *
316 * Conforms to "IO Remapping Table System Software on ARM Platforms",
317 * Document number: ARM DEN 0049E.b, Feb 2021
318 *
319 ******************************************************************************/
320
321 typedef struct acpi_table_iort
322 {
323 ACPI_TABLE_HEADER Header;
324 UINT32 NodeCount;
325 UINT32 NodeOffset;
326 UINT32 Reserved;
327
328 } ACPI_TABLE_IORT;
329
330
331 /*
332 * IORT subtables
333 */
334 typedef struct acpi_iort_node
335 {
336 UINT8 Type;
337 UINT16 Length;
338 UINT8 Revision;
339 UINT32 Identifier;
340 UINT32 MappingCount;
341 UINT32 MappingOffset;
342 char NodeData[1];
343
344 } ACPI_IORT_NODE;
345
346 /* Values for subtable Type above */
347
348 enum AcpiIortNodeType
349 {
350 ACPI_IORT_NODE_ITS_GROUP = 0x00,
351 ACPI_IORT_NODE_NAMED_COMPONENT = 0x01,
352 ACPI_IORT_NODE_PCI_ROOT_COMPLEX = 0x02,
353 ACPI_IORT_NODE_SMMU = 0x03,
354 ACPI_IORT_NODE_SMMU_V3 = 0x04,
355 ACPI_IORT_NODE_PMCG = 0x05,
356 ACPI_IORT_NODE_RMR = 0x06,
357 };
358
359
360 typedef struct acpi_iort_id_mapping
361 {
362 UINT32 InputBase; /* Lowest value in input range */
363 UINT32 IdCount; /* Number of IDs */
364 UINT32 OutputBase; /* Lowest value in output range */
365 UINT32 OutputReference; /* A reference to the output node */
366 UINT32 Flags;
367
368 } ACPI_IORT_ID_MAPPING;
369
370 /* Masks for Flags field above for IORT subtable */
371
372 #define ACPI_IORT_ID_SINGLE_MAPPING (1)
373
374
375 typedef struct acpi_iort_memory_access
376 {
377 UINT32 CacheCoherency;
378 UINT8 Hints;
379 UINT16 Reserved;
380 UINT8 MemoryFlags;
381
382 } ACPI_IORT_MEMORY_ACCESS;
383
384 /* Values for CacheCoherency field above */
385
386 #define ACPI_IORT_NODE_COHERENT 0x00000001 /* The device node is fully coherent */
387 #define ACPI_IORT_NODE_NOT_COHERENT 0x00000000 /* The device node is not coherent */
388
389 /* Masks for Hints field above */
390
391 #define ACPI_IORT_HT_TRANSIENT (1)
392 #define ACPI_IORT_HT_WRITE (1<<1)
393 #define ACPI_IORT_HT_READ (1<<2)
394 #define ACPI_IORT_HT_OVERRIDE (1<<3)
395
396 /* Masks for MemoryFlags field above */
397
398 #define ACPI_IORT_MF_COHERENCY (1)
399 #define ACPI_IORT_MF_ATTRIBUTES (1<<1)
400
401
402 /*
403 * IORT node specific subtables
404 */
405 typedef struct acpi_iort_its_group
406 {
407 UINT32 ItsCount;
408 UINT32 Identifiers[1]; /* GIC ITS identifier array */
409
410 } ACPI_IORT_ITS_GROUP;
411
412
413 typedef struct acpi_iort_named_component
414 {
415 UINT32 NodeFlags;
416 UINT64 MemoryProperties; /* Memory access properties */
417 UINT8 MemoryAddressLimit; /* Memory address size limit */
418 char DeviceName[1]; /* Path of namespace object */
419
420 } ACPI_IORT_NAMED_COMPONENT;
421
422 /* Masks for Flags field above */
423
424 #define ACPI_IORT_NC_STALL_SUPPORTED (1)
425 #define ACPI_IORT_NC_PASID_BITS (31<<1)
426
427 typedef struct acpi_iort_root_complex
428 {
429 UINT64 MemoryProperties; /* Memory access properties */
430 UINT32 AtsAttribute;
431 UINT32 PciSegmentNumber;
432 UINT8 MemoryAddressLimit; /* Memory address size limit */
433 UINT8 Reserved[3]; /* Reserved, must be zero */
434
435 } ACPI_IORT_ROOT_COMPLEX;
436
437 /* Masks for AtsAttribute field above */
438
439 #define ACPI_IORT_ATS_SUPPORTED (1) /* The root complex ATS support */
440 #define ACPI_IORT_PRI_SUPPORTED (1<<1) /* The root complex PRI support */
441 #define ACPI_IORT_PASID_FWD_SUPPORTED (1<<2) /* The root complex PASID forward support */
442
443
444 typedef struct acpi_iort_smmu
445 {
446 UINT64 BaseAddress; /* SMMU base address */
447 UINT64 Span; /* Length of memory range */
448 UINT32 Model;
449 UINT32 Flags;
450 UINT32 GlobalInterruptOffset;
451 UINT32 ContextInterruptCount;
452 UINT32 ContextInterruptOffset;
453 UINT32 PmuInterruptCount;
454 UINT32 PmuInterruptOffset;
455 UINT64 Interrupts[1]; /* Interrupt array */
456
457 } ACPI_IORT_SMMU;
458
459 /* Values for Model field above */
460
461 #define ACPI_IORT_SMMU_V1 0x00000000 /* Generic SMMUv1 */
462 #define ACPI_IORT_SMMU_V2 0x00000001 /* Generic SMMUv2 */
463 #define ACPI_IORT_SMMU_CORELINK_MMU400 0x00000002 /* ARM Corelink MMU-400 */
464 #define ACPI_IORT_SMMU_CORELINK_MMU500 0x00000003 /* ARM Corelink MMU-500 */
465 #define ACPI_IORT_SMMU_CORELINK_MMU401 0x00000004 /* ARM Corelink MMU-401 */
466 #define ACPI_IORT_SMMU_CAVIUM_THUNDERX 0x00000005 /* Cavium ThunderX SMMUv2 */
467
468 /* Masks for Flags field above */
469
470 #define ACPI_IORT_SMMU_DVM_SUPPORTED (1)
471 #define ACPI_IORT_SMMU_COHERENT_WALK (1<<1)
472
473 /* Global interrupt format */
474
475 typedef struct acpi_iort_smmu_gsi
476 {
477 UINT32 NSgIrpt;
478 UINT32 NSgIrptFlags;
479 UINT32 NSgCfgIrpt;
480 UINT32 NSgCfgIrptFlags;
481
482 } ACPI_IORT_SMMU_GSI;
483
484
485 typedef struct acpi_iort_smmu_v3
486 {
487 UINT64 BaseAddress; /* SMMUv3 base address */
488 UINT32 Flags;
489 UINT32 Reserved;
490 UINT64 VatosAddress;
491 UINT32 Model;
492 UINT32 EventGsiv;
493 UINT32 PriGsiv;
494 UINT32 GerrGsiv;
495 UINT32 SyncGsiv;
496 UINT32 Pxm;
497 UINT32 IdMappingIndex;
498
499 } ACPI_IORT_SMMU_V3;
500
501 /* Values for Model field above */
502
503 #define ACPI_IORT_SMMU_V3_GENERIC 0x00000000 /* Generic SMMUv3 */
504 #define ACPI_IORT_SMMU_V3_HISILICON_HI161X 0x00000001 /* HiSilicon Hi161x SMMUv3 */
505 #define ACPI_IORT_SMMU_V3_CAVIUM_CN99XX 0x00000002 /* Cavium CN99xx SMMUv3 */
506
507 /* Masks for Flags field above */
508
509 #define ACPI_IORT_SMMU_V3_COHACC_OVERRIDE (1)
510 #define ACPI_IORT_SMMU_V3_HTTU_OVERRIDE (3<<1)
511 #define ACPI_IORT_SMMU_V3_PXM_VALID (1<<3)
512
513 typedef struct acpi_iort_pmcg
514 {
515 UINT64 Page0BaseAddress;
516 UINT32 OverflowGsiv;
517 UINT32 NodeReference;
518 UINT64 Page1BaseAddress;
519
520 } ACPI_IORT_PMCG;
521
522 typedef struct acpi_iort_rmr {
523 UINT32 Flags;
524 UINT32 RmrCount;
525 UINT32 RmrOffset;
526
527 } ACPI_IORT_RMR;
528
529 typedef struct acpi_iort_rmr_desc {
530 UINT64 BaseAddress;
531 UINT64 Length;
532 UINT32 Reserved;
533
534 } ACPI_IORT_RMR_DESC;
535
536 /*******************************************************************************
537 *
538 * IVRS - I/O Virtualization Reporting Structure
539 * Version 1
540 *
541 * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
542 * Revision 1.26, February 2009.
543 *
544 ******************************************************************************/
545
546 typedef struct acpi_table_ivrs
547 {
548 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
549 UINT32 Info; /* Common virtualization info */
550 UINT64 Reserved;
551
552 } ACPI_TABLE_IVRS;
553
554 /* Values for Info field above */
555
556 #define ACPI_IVRS_PHYSICAL_SIZE 0x00007F00 /* 7 bits, physical address size */
557 #define ACPI_IVRS_VIRTUAL_SIZE 0x003F8000 /* 7 bits, virtual address size */
558 #define ACPI_IVRS_ATS_RESERVED 0x00400000 /* ATS address translation range reserved */
559
560
561 /* IVRS subtable header */
562
563 typedef struct acpi_ivrs_header
564 {
565 UINT8 Type; /* Subtable type */
566 UINT8 Flags;
567 UINT16 Length; /* Subtable length */
568 UINT16 DeviceId; /* ID of IOMMU */
569
570 } ACPI_IVRS_HEADER;
571
572 /* Values for subtable Type above */
573
574 enum AcpiIvrsType
575 {
576 ACPI_IVRS_TYPE_HARDWARE1 = 0x10,
577 ACPI_IVRS_TYPE_HARDWARE2 = 0x11,
578 ACPI_IVRS_TYPE_HARDWARE3 = 0x40,
579 ACPI_IVRS_TYPE_MEMORY1 = 0x20,
580 ACPI_IVRS_TYPE_MEMORY2 = 0x21,
581 ACPI_IVRS_TYPE_MEMORY3 = 0x22
582 };
583
584 /* Masks for Flags field above for IVHD subtable */
585
586 #define ACPI_IVHD_TT_ENABLE (1)
587 #define ACPI_IVHD_PASS_PW (1<<1)
588 #define ACPI_IVHD_RES_PASS_PW (1<<2)
589 #define ACPI_IVHD_ISOC (1<<3)
590 #define ACPI_IVHD_IOTLB (1<<4)
591
592 /* Masks for Flags field above for IVMD subtable */
593
594 #define ACPI_IVMD_UNITY (1)
595 #define ACPI_IVMD_READ (1<<1)
596 #define ACPI_IVMD_WRITE (1<<2)
597 #define ACPI_IVMD_EXCLUSION_RANGE (1<<3)
598
599
600 /*
601 * IVRS subtables, correspond to Type in ACPI_IVRS_HEADER
602 */
603
604 /* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
605
606 typedef struct acpi_ivrs_hardware_10
607 {
608 ACPI_IVRS_HEADER Header;
609 UINT16 CapabilityOffset; /* Offset for IOMMU control fields */
610 UINT64 BaseAddress; /* IOMMU control registers */
611 UINT16 PciSegmentGroup;
612 UINT16 Info; /* MSI number and unit ID */
613 UINT32 FeatureReporting;
614
615 } ACPI_IVRS_HARDWARE1;
616
617 /* 0x11: I/O Virtualization Hardware Definition Block (IVHD) */
618
619 typedef struct acpi_ivrs_hardware_11
620 {
621 ACPI_IVRS_HEADER Header;
622 UINT16 CapabilityOffset; /* Offset for IOMMU control fields */
623 UINT64 BaseAddress; /* IOMMU control registers */
624 UINT16 PciSegmentGroup;
625 UINT16 Info; /* MSI number and unit ID */
626 UINT32 Attributes;
627 UINT64 EfrRegisterImage;
628 UINT64 Reserved;
629 } ACPI_IVRS_HARDWARE2;
630
631 /* Masks for Info field above */
632
633 #define ACPI_IVHD_MSI_NUMBER_MASK 0x001F /* 5 bits, MSI message number */
634 #define ACPI_IVHD_UNIT_ID_MASK 0x1F00 /* 5 bits, UnitID */
635
636
637 /*
638 * Device Entries for IVHD subtable, appear after ACPI_IVRS_HARDWARE structure.
639 * Upper two bits of the Type field are the (encoded) length of the structure.
640 * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
641 * are reserved for future use but not defined.
642 */
643 typedef struct acpi_ivrs_de_header
644 {
645 UINT8 Type;
646 UINT16 Id;
647 UINT8 DataSetting;
648
649 } ACPI_IVRS_DE_HEADER;
650
651 /* Length of device entry is in the top two bits of Type field above */
652
653 #define ACPI_IVHD_ENTRY_LENGTH 0xC0
654
655 /* Values for device entry Type field above */
656
657 enum AcpiIvrsDeviceEntryType
658 {
659 /* 4-byte device entries, all use ACPI_IVRS_DEVICE4 */
660
661 ACPI_IVRS_TYPE_PAD4 = 0,
662 ACPI_IVRS_TYPE_ALL = 1,
663 ACPI_IVRS_TYPE_SELECT = 2,
664 ACPI_IVRS_TYPE_START = 3,
665 ACPI_IVRS_TYPE_END = 4,
666
667 /* 8-byte device entries */
668
669 ACPI_IVRS_TYPE_PAD8 = 64,
670 ACPI_IVRS_TYPE_NOT_USED = 65,
671 ACPI_IVRS_TYPE_ALIAS_SELECT = 66, /* Uses ACPI_IVRS_DEVICE8A */
672 ACPI_IVRS_TYPE_ALIAS_START = 67, /* Uses ACPI_IVRS_DEVICE8A */
673 ACPI_IVRS_TYPE_EXT_SELECT = 70, /* Uses ACPI_IVRS_DEVICE8B */
674 ACPI_IVRS_TYPE_EXT_START = 71, /* Uses ACPI_IVRS_DEVICE8B */
675 ACPI_IVRS_TYPE_SPECIAL = 72, /* Uses ACPI_IVRS_DEVICE8C */
676
677 /* Variable-length device entries */
678
679 ACPI_IVRS_TYPE_HID = 240 /* Uses ACPI_IVRS_DEVICE_HID */
680 };
681
682 /* Values for Data field above */
683
684 #define ACPI_IVHD_INIT_PASS (1)
685 #define ACPI_IVHD_EINT_PASS (1<<1)
686 #define ACPI_IVHD_NMI_PASS (1<<2)
687 #define ACPI_IVHD_SYSTEM_MGMT (3<<4)
688 #define ACPI_IVHD_LINT0_PASS (1<<6)
689 #define ACPI_IVHD_LINT1_PASS (1<<7)
690
691
692 /* Types 0-4: 4-byte device entry */
693
694 typedef struct acpi_ivrs_device4
695 {
696 ACPI_IVRS_DE_HEADER Header;
697
698 } ACPI_IVRS_DEVICE4;
699
700 /* Types 66-67: 8-byte device entry */
701
702 typedef struct acpi_ivrs_device8a
703 {
704 ACPI_IVRS_DE_HEADER Header;
705 UINT8 Reserved1;
706 UINT16 UsedId;
707 UINT8 Reserved2;
708
709 } ACPI_IVRS_DEVICE8A;
710
711 /* Types 70-71: 8-byte device entry */
712
713 typedef struct acpi_ivrs_device8b
714 {
715 ACPI_IVRS_DE_HEADER Header;
716 UINT32 ExtendedData;
717
718 } ACPI_IVRS_DEVICE8B;
719
720 /* Values for ExtendedData above */
721
722 #define ACPI_IVHD_ATS_DISABLED (1<<31)
723
724 /* Type 72: 8-byte device entry */
725
726 typedef struct acpi_ivrs_device8c
727 {
728 ACPI_IVRS_DE_HEADER Header;
729 UINT8 Handle;
730 UINT16 UsedId;
731 UINT8 Variety;
732
733 } ACPI_IVRS_DEVICE8C;
734
735 /* Values for Variety field above */
736
737 #define ACPI_IVHD_IOAPIC 1
738 #define ACPI_IVHD_HPET 2
739
740 /* Type 240: variable-length device entry */
741
742 typedef struct acpi_ivrs_device_hid
743 {
744 ACPI_IVRS_DE_HEADER Header;
745 UINT64 AcpiHid;
746 UINT64 AcpiCid;
747 UINT8 UidType;
748 UINT8 UidLength;
749
750 } ACPI_IVRS_DEVICE_HID;
751
752 /* Values for UidType above */
753
754 #define ACPI_IVRS_UID_NOT_PRESENT 0
755 #define ACPI_IVRS_UID_IS_INTEGER 1
756 #define ACPI_IVRS_UID_IS_STRING 2
757
758 /* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
759
760 typedef struct acpi_ivrs_memory
761 {
762 ACPI_IVRS_HEADER Header;
763 UINT16 AuxData;
764 UINT64 Reserved;
765 UINT64 StartAddress;
766 UINT64 MemoryLength;
767
768 } ACPI_IVRS_MEMORY;
769
770
771 /*******************************************************************************
772 *
773 * LPIT - Low Power Idle Table
774 *
775 * Conforms to "ACPI Low Power Idle Table (LPIT)" July 2014.
776 *
777 ******************************************************************************/
778
779 typedef struct acpi_table_lpit
780 {
781 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
782
783 } ACPI_TABLE_LPIT;
784
785
786 /* LPIT subtable header */
787
788 typedef struct acpi_lpit_header
789 {
790 UINT32 Type; /* Subtable type */
791 UINT32 Length; /* Subtable length */
792 UINT16 UniqueId;
793 UINT16 Reserved;
794 UINT32 Flags;
795
796 } ACPI_LPIT_HEADER;
797
798 /* Values for subtable Type above */
799
800 enum AcpiLpitType
801 {
802 ACPI_LPIT_TYPE_NATIVE_CSTATE = 0x00,
803 ACPI_LPIT_TYPE_RESERVED = 0x01 /* 1 and above are reserved */
804 };
805
806 /* Masks for Flags field above */
807
808 #define ACPI_LPIT_STATE_DISABLED (1)
809 #define ACPI_LPIT_NO_COUNTER (1<<1)
810
811 /*
812 * LPIT subtables, correspond to Type in ACPI_LPIT_HEADER
813 */
814
815 /* 0x00: Native C-state instruction based LPI structure */
816
817 typedef struct acpi_lpit_native
818 {
819 ACPI_LPIT_HEADER Header;
820 ACPI_GENERIC_ADDRESS EntryTrigger;
821 UINT32 Residency;
822 UINT32 Latency;
823 ACPI_GENERIC_ADDRESS ResidencyCounter;
824 UINT64 CounterFrequency;
825
826 } ACPI_LPIT_NATIVE;
827
828
829 /*******************************************************************************
830 *
831 * MADT - Multiple APIC Description Table
832 * Version 3
833 *
834 ******************************************************************************/
835
836 typedef struct acpi_table_madt
837 {
838 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
839 UINT32 Address; /* Physical address of local APIC */
840 UINT32 Flags;
841
842 } ACPI_TABLE_MADT;
843
844 /* Masks for Flags field above */
845
846 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
847
848 /* Values for PCATCompat flag */
849
850 #define ACPI_MADT_DUAL_PIC 1
851 #define ACPI_MADT_MULTIPLE_APIC 0
852
853
854 /* Values for MADT subtable type in ACPI_SUBTABLE_HEADER */
855
856 enum AcpiMadtType
857 {
858 ACPI_MADT_TYPE_LOCAL_APIC = 0,
859 ACPI_MADT_TYPE_IO_APIC = 1,
860 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
861 ACPI_MADT_TYPE_NMI_SOURCE = 3,
862 ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
863 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
864 ACPI_MADT_TYPE_IO_SAPIC = 6,
865 ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
866 ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
867 ACPI_MADT_TYPE_LOCAL_X2APIC = 9,
868 ACPI_MADT_TYPE_LOCAL_X2APIC_NMI = 10,
869 ACPI_MADT_TYPE_GENERIC_INTERRUPT = 11,
870 ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR = 12,
871 ACPI_MADT_TYPE_GENERIC_MSI_FRAME = 13,
872 ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR = 14,
873 ACPI_MADT_TYPE_GENERIC_TRANSLATOR = 15,
874 ACPI_MADT_TYPE_MULTIPROC_WAKEUP = 16,
875 ACPI_MADT_TYPE_RESERVED = 17 /* 17 and greater are reserved */
876 };
877
878
879 /*
880 * MADT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
881 */
882
883 /* 0: Processor Local APIC */
884
885 typedef struct acpi_madt_local_apic
886 {
887 ACPI_SUBTABLE_HEADER Header;
888 UINT8 ProcessorId; /* ACPI processor id */
889 UINT8 Id; /* Processor's local APIC id */
890 UINT32 LapicFlags;
891
892 } ACPI_MADT_LOCAL_APIC;
893
894
895 /* 1: IO APIC */
896
897 typedef struct acpi_madt_io_apic
898 {
899 ACPI_SUBTABLE_HEADER Header;
900 UINT8 Id; /* I/O APIC ID */
901 UINT8 Reserved; /* Reserved - must be zero */
902 UINT32 Address; /* APIC physical address */
903 UINT32 GlobalIrqBase; /* Global system interrupt where INTI lines start */
904
905 } ACPI_MADT_IO_APIC;
906
907
908 /* 2: Interrupt Override */
909
910 typedef struct acpi_madt_interrupt_override
911 {
912 ACPI_SUBTABLE_HEADER Header;
913 UINT8 Bus; /* 0 - ISA */
914 UINT8 SourceIrq; /* Interrupt source (IRQ) */
915 UINT32 GlobalIrq; /* Global system interrupt */
916 UINT16 IntiFlags;
917
918 } ACPI_MADT_INTERRUPT_OVERRIDE;
919
920
921 /* 3: NMI Source */
922
923 typedef struct acpi_madt_nmi_source
924 {
925 ACPI_SUBTABLE_HEADER Header;
926 UINT16 IntiFlags;
927 UINT32 GlobalIrq; /* Global system interrupt */
928
929 } ACPI_MADT_NMI_SOURCE;
930
931
932 /* 4: Local APIC NMI */
933
934 typedef struct acpi_madt_local_apic_nmi
935 {
936 ACPI_SUBTABLE_HEADER Header;
937 UINT8 ProcessorId; /* ACPI processor id */
938 UINT16 IntiFlags;
939 UINT8 Lint; /* LINTn to which NMI is connected */
940
941 } ACPI_MADT_LOCAL_APIC_NMI;
942
943
944 /* 5: Address Override */
945
946 typedef struct acpi_madt_local_apic_override
947 {
948 ACPI_SUBTABLE_HEADER Header;
949 UINT16 Reserved; /* Reserved, must be zero */
950 UINT64 Address; /* APIC physical address */
951
952 } ACPI_MADT_LOCAL_APIC_OVERRIDE;
953
954
955 /* 6: I/O Sapic */
956
957 typedef struct acpi_madt_io_sapic
958 {
959 ACPI_SUBTABLE_HEADER Header;
960 UINT8 Id; /* I/O SAPIC ID */
961 UINT8 Reserved; /* Reserved, must be zero */
962 UINT32 GlobalIrqBase; /* Global interrupt for SAPIC start */
963 UINT64 Address; /* SAPIC physical address */
964
965 } ACPI_MADT_IO_SAPIC;
966
967
968 /* 7: Local Sapic */
969
970 typedef struct acpi_madt_local_sapic
971 {
972 ACPI_SUBTABLE_HEADER Header;
973 UINT8 ProcessorId; /* ACPI processor id */
974 UINT8 Id; /* SAPIC ID */
975 UINT8 Eid; /* SAPIC EID */
976 UINT8 Reserved[3]; /* Reserved, must be zero */
977 UINT32 LapicFlags;
978 UINT32 Uid; /* Numeric UID - ACPI 3.0 */
979 char UidString[1]; /* String UID - ACPI 3.0 */
980
981 } ACPI_MADT_LOCAL_SAPIC;
982
983
984 /* 8: Platform Interrupt Source */
985
986 typedef struct acpi_madt_interrupt_source
987 {
988 ACPI_SUBTABLE_HEADER Header;
989 UINT16 IntiFlags;
990 UINT8 Type; /* 1=PMI, 2=INIT, 3=corrected */
991 UINT8 Id; /* Processor ID */
992 UINT8 Eid; /* Processor EID */
993 UINT8 IoSapicVector; /* Vector value for PMI interrupts */
994 UINT32 GlobalIrq; /* Global system interrupt */
995 UINT32 Flags; /* Interrupt Source Flags */
996
997 } ACPI_MADT_INTERRUPT_SOURCE;
998
999 /* Masks for Flags field above */
1000
1001 #define ACPI_MADT_CPEI_OVERRIDE (1)
1002
1003
1004 /* 9: Processor Local X2APIC (ACPI 4.0) */
1005
1006 typedef struct acpi_madt_local_x2apic
1007 {
1008 ACPI_SUBTABLE_HEADER Header;
1009 UINT16 Reserved; /* Reserved - must be zero */
1010 UINT32 LocalApicId; /* Processor x2APIC ID */
1011 UINT32 LapicFlags;
1012 UINT32 Uid; /* ACPI processor UID */
1013
1014 } ACPI_MADT_LOCAL_X2APIC;
1015
1016
1017 /* 10: Local X2APIC NMI (ACPI 4.0) */
1018
1019 typedef struct acpi_madt_local_x2apic_nmi
1020 {
1021 ACPI_SUBTABLE_HEADER Header;
1022 UINT16 IntiFlags;
1023 UINT32 Uid; /* ACPI processor UID */
1024 UINT8 Lint; /* LINTn to which NMI is connected */
1025 UINT8 Reserved[3]; /* Reserved - must be zero */
1026
1027 } ACPI_MADT_LOCAL_X2APIC_NMI;
1028
1029
1030 /* 11: Generic Interrupt - GICC (ACPI 5.0 + ACPI 6.0 + ACPI 6.3 changes) */
1031
1032 typedef struct acpi_madt_generic_interrupt
1033 {
1034 ACPI_SUBTABLE_HEADER Header;
1035 UINT16 Reserved; /* Reserved - must be zero */
1036 UINT32 CpuInterfaceNumber;
1037 UINT32 Uid;
1038 UINT32 Flags;
1039 UINT32 ParkingVersion;
1040 UINT32 PerformanceInterrupt;
1041 UINT64 ParkedAddress;
1042 UINT64 BaseAddress;
1043 UINT64 GicvBaseAddress;
1044 UINT64 GichBaseAddress;
1045 UINT32 VgicInterrupt;
1046 UINT64 GicrBaseAddress;
1047 UINT64 ArmMpidr;
1048 UINT8 EfficiencyClass;
1049 UINT8 Reserved2[1];
1050 UINT16 SpeInterrupt; /* ACPI 6.3 */
1051
1052 } ACPI_MADT_GENERIC_INTERRUPT;
1053
1054 /* Masks for Flags field above */
1055
1056 /* ACPI_MADT_ENABLED (1) Processor is usable if set */
1057 #define ACPI_MADT_PERFORMANCE_IRQ_MODE (1<<1) /* 01: Performance Interrupt Mode */
1058 #define ACPI_MADT_VGIC_IRQ_MODE (1<<2) /* 02: VGIC Maintenance Interrupt mode */
1059
1060
1061 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
1062
1063 typedef struct acpi_madt_generic_distributor
1064 {
1065 ACPI_SUBTABLE_HEADER Header;
1066 UINT16 Reserved; /* Reserved - must be zero */
1067 UINT32 GicId;
1068 UINT64 BaseAddress;
1069 UINT32 GlobalIrqBase;
1070 UINT8 Version;
1071 UINT8 Reserved2[3]; /* Reserved - must be zero */
1072
1073 } ACPI_MADT_GENERIC_DISTRIBUTOR;
1074
1075 /* Values for Version field above */
1076
1077 enum AcpiMadtGicVersion
1078 {
1079 ACPI_MADT_GIC_VERSION_NONE = 0,
1080 ACPI_MADT_GIC_VERSION_V1 = 1,
1081 ACPI_MADT_GIC_VERSION_V2 = 2,
1082 ACPI_MADT_GIC_VERSION_V3 = 3,
1083 ACPI_MADT_GIC_VERSION_V4 = 4,
1084 ACPI_MADT_GIC_VERSION_RESERVED = 5 /* 5 and greater are reserved */
1085 };
1086
1087
1088 /* 13: Generic MSI Frame (ACPI 5.1) */
1089
1090 typedef struct acpi_madt_generic_msi_frame
1091 {
1092 ACPI_SUBTABLE_HEADER Header;
1093 UINT16 Reserved; /* Reserved - must be zero */
1094 UINT32 MsiFrameId;
1095 UINT64 BaseAddress;
1096 UINT32 Flags;
1097 UINT16 SpiCount;
1098 UINT16 SpiBase;
1099
1100 } ACPI_MADT_GENERIC_MSI_FRAME;
1101
1102 /* Masks for Flags field above */
1103
1104 #define ACPI_MADT_OVERRIDE_SPI_VALUES (1)
1105
1106
1107 /* 14: Generic Redistributor (ACPI 5.1) */
1108
1109 typedef struct acpi_madt_generic_redistributor
1110 {
1111 ACPI_SUBTABLE_HEADER Header;
1112 UINT16 Reserved; /* reserved - must be zero */
1113 UINT64 BaseAddress;
1114 UINT32 Length;
1115
1116 } ACPI_MADT_GENERIC_REDISTRIBUTOR;
1117
1118
1119 /* 15: Generic Translator (ACPI 6.0) */
1120
1121 typedef struct acpi_madt_generic_translator
1122 {
1123 ACPI_SUBTABLE_HEADER Header;
1124 UINT16 Reserved; /* reserved - must be zero */
1125 UINT32 TranslationId;
1126 UINT64 BaseAddress;
1127 UINT32 Reserved2;
1128
1129 } ACPI_MADT_GENERIC_TRANSLATOR;
1130
1131 /* 16: Multiprocessor wakeup (ACPI 6.4) */
1132
1133 typedef struct acpi_madt_multiproc_wakeup
1134 {
1135 ACPI_SUBTABLE_HEADER Header;
1136 UINT16 MailboxVersion;
1137 UINT32 Reserved; /* reserved - must be zero */
1138 UINT64 BaseAddress;
1139
1140 } ACPI_MADT_MULTIPROC_WAKEUP;
1141
1142 #define ACPI_MULTIPROC_WAKEUP_MB_OS_SIZE 2032
1143 #define ACPI_MULTIPROC_WAKEUP_MB_FIRMWARE_SIZE 2048
1144
1145 typedef struct acpi_madt_multiproc_wakeup_mailbox
1146 {
1147 UINT16 Command;
1148 UINT16 Reserved; /* reserved - must be zero */
1149 UINT32 ApicId;
1150 UINT64 WakeupVector;
1151 UINT8 ReservedOs[ACPI_MULTIPROC_WAKEUP_MB_OS_SIZE]; /* reserved for OS use */
1152 UINT8 ReservedFirmware[ACPI_MULTIPROC_WAKEUP_MB_FIRMWARE_SIZE]; /* reserved for firmware use */
1153
1154 } ACPI_MADT_MULTIPROC_WAKEUP_MAILBOX;
1155
1156 #define ACPI_MP_WAKE_COMMAND_WAKEUP 1
1157
1158
1159 /*
1160 * Common flags fields for MADT subtables
1161 */
1162
1163 /* MADT Local APIC flags */
1164
1165 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
1166 #define ACPI_MADT_ONLINE_CAPABLE (2) /* 01: System HW supports enabling processor at runtime */
1167
1168 /* MADT MPS INTI flags (IntiFlags) */
1169
1170 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
1171 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
1172
1173 /* Values for MPS INTI flags */
1174
1175 #define ACPI_MADT_POLARITY_CONFORMS 0
1176 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
1177 #define ACPI_MADT_POLARITY_RESERVED 2
1178 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
1179
1180 #define ACPI_MADT_TRIGGER_CONFORMS (0)
1181 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
1182 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
1183 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
1184
1185
1186 /*******************************************************************************
1187 *
1188 * MCFG - PCI Memory Mapped Configuration table and subtable
1189 * Version 1
1190 *
1191 * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
1192 *
1193 ******************************************************************************/
1194
1195 typedef struct acpi_table_mcfg
1196 {
1197 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1198 UINT8 Reserved[8];
1199
1200 } ACPI_TABLE_MCFG;
1201
1202
1203 /* Subtable */
1204
1205 typedef struct acpi_mcfg_allocation
1206 {
1207 UINT64 Address; /* Base address, processor-relative */
1208 UINT16 PciSegment; /* PCI segment group number */
1209 UINT8 StartBusNumber; /* Starting PCI Bus number */
1210 UINT8 EndBusNumber; /* Final PCI Bus number */
1211 UINT32 Reserved;
1212
1213 } ACPI_MCFG_ALLOCATION;
1214
1215
1216 /*******************************************************************************
1217 *
1218 * MCHI - Management Controller Host Interface Table
1219 * Version 1
1220 *
1221 * Conforms to "Management Component Transport Protocol (MCTP) Host
1222 * Interface Specification", Revision 1.0.0a, October 13, 2009
1223 *
1224 ******************************************************************************/
1225
1226 typedef struct acpi_table_mchi
1227 {
1228 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1229 UINT8 InterfaceType;
1230 UINT8 Protocol;
1231 UINT64 ProtocolData;
1232 UINT8 InterruptType;
1233 UINT8 Gpe;
1234 UINT8 PciDeviceFlag;
1235 UINT32 GlobalInterrupt;
1236 ACPI_GENERIC_ADDRESS ControlRegister;
1237 UINT8 PciSegment;
1238 UINT8 PciBus;
1239 UINT8 PciDevice;
1240 UINT8 PciFunction;
1241
1242 } ACPI_TABLE_MCHI;
1243
1244
1245 /*******************************************************************************
1246 *
1247 * MPST - Memory Power State Table (ACPI 5.0)
1248 * Version 1
1249 *
1250 ******************************************************************************/
1251
1252 #define ACPI_MPST_CHANNEL_INFO \
1253 UINT8 ChannelId; \
1254 UINT8 Reserved1[3]; \
1255 UINT16 PowerNodeCount; \
1256 UINT16 Reserved2;
1257
1258 /* Main table */
1259
1260 typedef struct acpi_table_mpst
1261 {
1262 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1263 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
1264
1265 } ACPI_TABLE_MPST;
1266
1267
1268 /* Memory Platform Communication Channel Info */
1269
1270 typedef struct acpi_mpst_channel
1271 {
1272 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
1273
1274 } ACPI_MPST_CHANNEL;
1275
1276
1277 /* Memory Power Node Structure */
1278
1279 typedef struct acpi_mpst_power_node
1280 {
1281 UINT8 Flags;
1282 UINT8 Reserved1;
1283 UINT16 NodeId;
1284 UINT32 Length;
1285 UINT64 RangeAddress;
1286 UINT64 RangeLength;
1287 UINT32 NumPowerStates;
1288 UINT32 NumPhysicalComponents;
1289
1290 } ACPI_MPST_POWER_NODE;
1291
1292 /* Values for Flags field above */
1293
1294 #define ACPI_MPST_ENABLED 1
1295 #define ACPI_MPST_POWER_MANAGED 2
1296 #define ACPI_MPST_HOT_PLUG_CAPABLE 4
1297
1298
1299 /* Memory Power State Structure (follows POWER_NODE above) */
1300
1301 typedef struct acpi_mpst_power_state
1302 {
1303 UINT8 PowerState;
1304 UINT8 InfoIndex;
1305
1306 } ACPI_MPST_POWER_STATE;
1307
1308
1309 /* Physical Component ID Structure (follows POWER_STATE above) */
1310
1311 typedef struct acpi_mpst_component
1312 {
1313 UINT16 ComponentId;
1314
1315 } ACPI_MPST_COMPONENT;
1316
1317
1318 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
1319
1320 typedef struct acpi_mpst_data_hdr
1321 {
1322 UINT16 CharacteristicsCount;
1323 UINT16 Reserved;
1324
1325 } ACPI_MPST_DATA_HDR;
1326
1327 typedef struct acpi_mpst_power_data
1328 {
1329 UINT8 StructureId;
1330 UINT8 Flags;
1331 UINT16 Reserved1;
1332 UINT32 AveragePower;
1333 UINT32 PowerSaving;
1334 UINT64 ExitLatency;
1335 UINT64 Reserved2;
1336
1337 } ACPI_MPST_POWER_DATA;
1338
1339 /* Values for Flags field above */
1340
1341 #define ACPI_MPST_PRESERVE 1
1342 #define ACPI_MPST_AUTOENTRY 2
1343 #define ACPI_MPST_AUTOEXIT 4
1344
1345
1346 /* Shared Memory Region (not part of an ACPI table) */
1347
1348 typedef struct acpi_mpst_shared
1349 {
1350 UINT32 Signature;
1351 UINT16 PccCommand;
1352 UINT16 PccStatus;
1353 UINT32 CommandRegister;
1354 UINT32 StatusRegister;
1355 UINT32 PowerStateId;
1356 UINT32 PowerNodeId;
1357 UINT64 EnergyConsumed;
1358 UINT64 AveragePower;
1359
1360 } ACPI_MPST_SHARED;
1361
1362
1363 /*******************************************************************************
1364 *
1365 * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1366 * Version 1
1367 *
1368 ******************************************************************************/
1369
1370 typedef struct acpi_table_msct
1371 {
1372 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1373 UINT32 ProximityOffset; /* Location of proximity info struct(s) */
1374 UINT32 MaxProximityDomains;/* Max number of proximity domains */
1375 UINT32 MaxClockDomains; /* Max number of clock domains */
1376 UINT64 MaxAddress; /* Max physical address in system */
1377
1378 } ACPI_TABLE_MSCT;
1379
1380
1381 /* Subtable - Maximum Proximity Domain Information. Version 1 */
1382
1383 typedef struct acpi_msct_proximity
1384 {
1385 UINT8 Revision;
1386 UINT8 Length;
1387 UINT32 RangeStart; /* Start of domain range */
1388 UINT32 RangeEnd; /* End of domain range */
1389 UINT32 ProcessorCapacity;
1390 UINT64 MemoryCapacity; /* In bytes */
1391
1392 } ACPI_MSCT_PROXIMITY;
1393
1394
1395 /*******************************************************************************
1396 *
1397 * MSDM - Microsoft Data Management table
1398 *
1399 * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
1400 * November 29, 2011. Copyright 2011 Microsoft
1401 *
1402 ******************************************************************************/
1403
1404 /* Basic MSDM table is only the common ACPI header */
1405
1406 typedef struct acpi_table_msdm
1407 {
1408 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1409
1410 } ACPI_TABLE_MSDM;
1411
1412
1413 /*******************************************************************************
1414 *
1415 * NFIT - NVDIMM Interface Table (ACPI 6.0+)
1416 * Version 1
1417 *
1418 ******************************************************************************/
1419
1420 typedef struct acpi_table_nfit
1421 {
1422 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1423 UINT32 Reserved; /* Reserved, must be zero */
1424
1425 } ACPI_TABLE_NFIT;
1426
1427 /* Subtable header for NFIT */
1428
1429 typedef struct acpi_nfit_header
1430 {
1431 UINT16 Type;
1432 UINT16 Length;
1433
1434 } ACPI_NFIT_HEADER;
1435
1436
1437 /* Values for subtable type in ACPI_NFIT_HEADER */
1438
1439 enum AcpiNfitType
1440 {
1441 ACPI_NFIT_TYPE_SYSTEM_ADDRESS = 0,
1442 ACPI_NFIT_TYPE_MEMORY_MAP = 1,
1443 ACPI_NFIT_TYPE_INTERLEAVE = 2,
1444 ACPI_NFIT_TYPE_SMBIOS = 3,
1445 ACPI_NFIT_TYPE_CONTROL_REGION = 4,
1446 ACPI_NFIT_TYPE_DATA_REGION = 5,
1447 ACPI_NFIT_TYPE_FLUSH_ADDRESS = 6,
1448 ACPI_NFIT_TYPE_CAPABILITIES = 7,
1449 ACPI_NFIT_TYPE_RESERVED = 8 /* 8 and greater are reserved */
1450 };
1451
1452 /*
1453 * NFIT Subtables
1454 */
1455
1456 /* 0: System Physical Address Range Structure */
1457
1458 typedef struct acpi_nfit_system_address
1459 {
1460 ACPI_NFIT_HEADER Header;
1461 UINT16 RangeIndex;
1462 UINT16 Flags;
1463 UINT32 Reserved; /* Reserved, must be zero */
1464 UINT32 ProximityDomain;
1465 UINT8 RangeGuid[16];
1466 UINT64 Address;
1467 UINT64 Length;
1468 UINT64 MemoryMapping;
1469 UINT64 LocationCookie; /* ACPI 6.4 */
1470
1471 } ACPI_NFIT_SYSTEM_ADDRESS;
1472
1473 /* Flags */
1474
1475 #define ACPI_NFIT_ADD_ONLINE_ONLY (1) /* 00: Add/Online Operation Only */
1476 #define ACPI_NFIT_PROXIMITY_VALID (1<<1) /* 01: Proximity Domain Valid */
1477 #define ACPI_NFIT_LOCATION_COOKIE_VALID (1<<2) /* 02: SPA location cookie valid (ACPI 6.4) */
1478
1479 /* Range Type GUIDs appear in the include/acuuid.h file */
1480
1481
1482 /* 1: Memory Device to System Address Range Map Structure */
1483
1484 typedef struct acpi_nfit_memory_map
1485 {
1486 ACPI_NFIT_HEADER Header;
1487 UINT32 DeviceHandle;
1488 UINT16 PhysicalId;
1489 UINT16 RegionId;
1490 UINT16 RangeIndex;
1491 UINT16 RegionIndex;
1492 UINT64 RegionSize;
1493 UINT64 RegionOffset;
1494 UINT64 Address;
1495 UINT16 InterleaveIndex;
1496 UINT16 InterleaveWays;
1497 UINT16 Flags;
1498 UINT16 Reserved; /* Reserved, must be zero */
1499
1500 } ACPI_NFIT_MEMORY_MAP;
1501
1502 /* Flags */
1503
1504 #define ACPI_NFIT_MEM_SAVE_FAILED (1) /* 00: Last SAVE to Memory Device failed */
1505 #define ACPI_NFIT_MEM_RESTORE_FAILED (1<<1) /* 01: Last RESTORE from Memory Device failed */
1506 #define ACPI_NFIT_MEM_FLUSH_FAILED (1<<2) /* 02: Platform flush failed */
1507 #define ACPI_NFIT_MEM_NOT_ARMED (1<<3) /* 03: Memory Device is not armed */
1508 #define ACPI_NFIT_MEM_HEALTH_OBSERVED (1<<4) /* 04: Memory Device observed SMART/health events */
1509 #define ACPI_NFIT_MEM_HEALTH_ENABLED (1<<5) /* 05: SMART/health events enabled */
1510 #define ACPI_NFIT_MEM_MAP_FAILED (1<<6) /* 06: Mapping to SPA failed */
1511
1512
1513 /* 2: Interleave Structure */
1514
1515 typedef struct acpi_nfit_interleave
1516 {
1517 ACPI_NFIT_HEADER Header;
1518 UINT16 InterleaveIndex;
1519 UINT16 Reserved; /* Reserved, must be zero */
1520 UINT32 LineCount;
1521 UINT32 LineSize;
1522 UINT32 LineOffset[1]; /* Variable length */
1523
1524 } ACPI_NFIT_INTERLEAVE;
1525
1526
1527 /* 3: SMBIOS Management Information Structure */
1528
1529 typedef struct acpi_nfit_smbios
1530 {
1531 ACPI_NFIT_HEADER Header;
1532 UINT32 Reserved; /* Reserved, must be zero */
1533 UINT8 Data[1]; /* Variable length */
1534
1535 } ACPI_NFIT_SMBIOS;
1536
1537
1538 /* 4: NVDIMM Control Region Structure */
1539
1540 typedef struct acpi_nfit_control_region
1541 {
1542 ACPI_NFIT_HEADER Header;
1543 UINT16 RegionIndex;
1544 UINT16 VendorId;
1545 UINT16 DeviceId;
1546 UINT16 RevisionId;
1547 UINT16 SubsystemVendorId;
1548 UINT16 SubsystemDeviceId;
1549 UINT16 SubsystemRevisionId;
1550 UINT8 ValidFields;
1551 UINT8 ManufacturingLocation;
1552 UINT16 ManufacturingDate;
1553 UINT8 Reserved[2]; /* Reserved, must be zero */
1554 UINT32 SerialNumber;
1555 UINT16 Code;
1556 UINT16 Windows;
1557 UINT64 WindowSize;
1558 UINT64 CommandOffset;
1559 UINT64 CommandSize;
1560 UINT64 StatusOffset;
1561 UINT64 StatusSize;
1562 UINT16 Flags;
1563 UINT8 Reserved1[6]; /* Reserved, must be zero */
1564
1565 } ACPI_NFIT_CONTROL_REGION;
1566
1567 /* Flags */
1568
1569 #define ACPI_NFIT_CONTROL_BUFFERED (1) /* Block Data Windows implementation is buffered */
1570
1571 /* ValidFields bits */
1572
1573 #define ACPI_NFIT_CONTROL_MFG_INFO_VALID (1) /* Manufacturing fields are valid */
1574
1575
1576 /* 5: NVDIMM Block Data Window Region Structure */
1577
1578 typedef struct acpi_nfit_data_region
1579 {
1580 ACPI_NFIT_HEADER Header;
1581 UINT16 RegionIndex;
1582 UINT16 Windows;
1583 UINT64 Offset;
1584 UINT64 Size;
1585 UINT64 Capacity;
1586 UINT64 StartAddress;
1587
1588 } ACPI_NFIT_DATA_REGION;
1589
1590
1591 /* 6: Flush Hint Address Structure */
1592
1593 typedef struct acpi_nfit_flush_address
1594 {
1595 ACPI_NFIT_HEADER Header;
1596 UINT32 DeviceHandle;
1597 UINT16 HintCount;
1598 UINT8 Reserved[6]; /* Reserved, must be zero */
1599 UINT64 HintAddress[1]; /* Variable length */
1600
1601 } ACPI_NFIT_FLUSH_ADDRESS;
1602
1603
1604 /* 7: Platform Capabilities Structure */
1605
1606 typedef struct acpi_nfit_capabilities
1607 {
1608 ACPI_NFIT_HEADER Header;
1609 UINT8 HighestCapability;
1610 UINT8 Reserved[3]; /* Reserved, must be zero */
1611 UINT32 Capabilities;
1612 UINT32 Reserved2;
1613
1614 } ACPI_NFIT_CAPABILITIES;
1615
1616 /* Capabilities Flags */
1617
1618 #define ACPI_NFIT_CAPABILITY_CACHE_FLUSH (1) /* 00: Cache Flush to NVDIMM capable */
1619 #define ACPI_NFIT_CAPABILITY_MEM_FLUSH (1<<1) /* 01: Memory Flush to NVDIMM capable */
1620 #define ACPI_NFIT_CAPABILITY_MEM_MIRRORING (1<<2) /* 02: Memory Mirroring capable */
1621
1622
1623 /*
1624 * NFIT/DVDIMM device handle support - used as the _ADR for each NVDIMM
1625 */
1626 typedef struct nfit_device_handle
1627 {
1628 UINT32 Handle;
1629
1630 } NFIT_DEVICE_HANDLE;
1631
1632 /* Device handle construction and extraction macros */
1633
1634 #define ACPI_NFIT_DIMM_NUMBER_MASK 0x0000000F
1635 #define ACPI_NFIT_CHANNEL_NUMBER_MASK 0x000000F0
1636 #define ACPI_NFIT_MEMORY_ID_MASK 0x00000F00
1637 #define ACPI_NFIT_SOCKET_ID_MASK 0x0000F000
1638 #define ACPI_NFIT_NODE_ID_MASK 0x0FFF0000
1639
1640 #define ACPI_NFIT_DIMM_NUMBER_OFFSET 0
1641 #define ACPI_NFIT_CHANNEL_NUMBER_OFFSET 4
1642 #define ACPI_NFIT_MEMORY_ID_OFFSET 8
1643 #define ACPI_NFIT_SOCKET_ID_OFFSET 12
1644 #define ACPI_NFIT_NODE_ID_OFFSET 16
1645
1646 /* Macro to construct a NFIT/NVDIMM device handle */
1647
1648 #define ACPI_NFIT_BUILD_DEVICE_HANDLE(dimm, channel, memory, socket, node) \
1649 ((dimm) | \
1650 ((channel) << ACPI_NFIT_CHANNEL_NUMBER_OFFSET) | \
1651 ((memory) << ACPI_NFIT_MEMORY_ID_OFFSET) | \
1652 ((socket) << ACPI_NFIT_SOCKET_ID_OFFSET) | \
1653 ((node) << ACPI_NFIT_NODE_ID_OFFSET))
1654
1655 /* Macros to extract individual fields from a NFIT/NVDIMM device handle */
1656
1657 #define ACPI_NFIT_GET_DIMM_NUMBER(handle) \
1658 ((handle) & ACPI_NFIT_DIMM_NUMBER_MASK)
1659
1660 #define ACPI_NFIT_GET_CHANNEL_NUMBER(handle) \
1661 (((handle) & ACPI_NFIT_CHANNEL_NUMBER_MASK) >> ACPI_NFIT_CHANNEL_NUMBER_OFFSET)
1662
1663 #define ACPI_NFIT_GET_MEMORY_ID(handle) \
1664 (((handle) & ACPI_NFIT_MEMORY_ID_MASK) >> ACPI_NFIT_MEMORY_ID_OFFSET)
1665
1666 #define ACPI_NFIT_GET_SOCKET_ID(handle) \
1667 (((handle) & ACPI_NFIT_SOCKET_ID_MASK) >> ACPI_NFIT_SOCKET_ID_OFFSET)
1668
1669 #define ACPI_NFIT_GET_NODE_ID(handle) \
1670 (((handle) & ACPI_NFIT_NODE_ID_MASK) >> ACPI_NFIT_NODE_ID_OFFSET)
1671
1672
1673 /*******************************************************************************
1674 *
1675 * NHLT - Non HD Audio Link Table
1676 *
1677 * Conforms to: Intel Smart Sound Technology NHLT Specification
1678 * Version 0.8.1, January 2020.
1679 *
1680 ******************************************************************************/
1681
1682 /* Main table */
1683
1684 typedef struct acpi_table_nhlt
1685 {
1686 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1687 UINT8 EndpointCount;
1688
1689 } ACPI_TABLE_NHLT;
1690
1691 typedef struct acpi_nhlt_endpoint
1692 {
1693 UINT32 DescriptorLength;
1694 UINT8 LinkType;
1695 UINT8 InstanceId;
1696 UINT16 VendorId;
1697 UINT16 DeviceId;
1698 UINT16 RevisionId;
1699 UINT32 SubsystemId;
1700 UINT8 DeviceType;
1701 UINT8 Direction;
1702 UINT8 VirtualBusId;
1703
1704 } ACPI_NHLT_ENDPOINT;
1705
1706 /* Types for LinkType field above */
1707
1708 #define ACPI_NHLT_RESERVED_HD_AUDIO 0
1709 #define ACPI_NHLT_RESERVED_DSP 1
1710 #define ACPI_NHLT_PDM 2
1711 #define ACPI_NHLT_SSP 3
1712 #define ACPI_NHLT_RESERVED_SLIMBUS 4
1713 #define ACPI_NHLT_RESERVED_SOUNDWIRE 5
1714 #define ACPI_NHLT_TYPE_RESERVED 6 /* 6 and above are reserved */
1715
1716 /* All other values above are reserved */
1717
1718 /* Values for DeviceId field above */
1719
1720 #define ACPI_NHLT_PDM_DMIC 0xAE20
1721 #define ACPI_NHLT_BT_SIDEBAND 0xAE30
1722 #define ACPI_NHLT_I2S_TDM_CODECS 0xAE23
1723
1724 /* Values for DeviceType field above */
1725
1726 /* SSP Link */
1727
1728 #define ACPI_NHLT_LINK_BT_SIDEBAND 0
1729 #define ACPI_NHLT_LINK_FM 1
1730 #define ACPI_NHLT_LINK_MODEM 2
1731 /* 3 is reserved */
1732 #define ACPI_NHLT_LINK_SSP_ANALOG_CODEC 4
1733
1734 /* PDM Link */
1735
1736 #define ACPI_NHLT_PDM_ON_CAVS_1P8 0
1737 #define ACPI_NHLT_PDM_ON_CAVS_1P5 1
1738
1739 /* Values for Direction field above */
1740
1741 #define ACPI_NHLT_DIR_RENDER 0
1742 #define ACPI_NHLT_DIR_CAPTURE 1
1743 #define ACPI_NHLT_DIR_RENDER_LOOPBACK 2
1744 #define ACPI_NHLT_DIR_RENDER_FEEDBACK 3
1745 #define ACPI_NHLT_DIR_RESERVED 4 /* 4 and above are reserved */
1746
1747 typedef struct acpi_nhlt_device_specific_config
1748 {
1749 UINT32 CapabilitiesSize;
1750 UINT8 VirtualSlot;
1751 UINT8 ConfigType;
1752
1753 } ACPI_NHLT_DEVICE_SPECIFIC_CONFIG;
1754
1755 typedef struct acpi_nhlt_device_specific_config_a
1756 {
1757 UINT32 CapabilitiesSize;
1758 UINT8 VirtualSlot;
1759 UINT8 ConfigType;
1760 UINT8 ArrayType;
1761
1762 } ACPI_NHLT_DEVICE_SPECIFIC_CONFIG_A;
1763
1764 /* Values for Config Type above */
1765
1766 #define ACPI_NHLT_TYPE_MIC_ARRAY 0x01
1767 #define ACPI_NHLT_TYPE_GENERIC 0x00
1768
1769 /* Mask for Extension field of ArrayType */
1770
1771 #define ACPI_NHLT_ARRAY_TYPE_MASK 0x10
1772
1773 typedef struct acpi_nhlt_device_specific_config_b
1774 {
1775 UINT32 CapabilitiesSize;
1776
1777 } ACPI_NHLT_DEVICE_SPECIFIC_CONFIG_B;
1778
1779 typedef struct acpi_nhlt_device_specific_config_c
1780 {
1781 UINT32 CapabilitiesSize;
1782 UINT8 VirtualSlot;
1783
1784 } ACPI_NHLT_DEVICE_SPECIFIC_CONFIG_C;
1785
1786 typedef struct acpi_nhlt_wave_extensible
1787 {
1788 UINT16 FormatTag;
1789 UINT16 ChannelCount;
1790 UINT32 SamplesPerSec;
1791 UINT32 AvgBytesPerSec;
1792 UINT16 BlockAlign;
1793 UINT16 BitsPerSample;
1794 UINT16 ExtraFormatSize;
1795 UINT16 ValidBitsPerSample;
1796 UINT32 ChannelMask;
1797 UINT8 SubFormatGuid[16];
1798
1799 } ACPI_NHLT_WAVE_EXTENSIBLE;
1800
1801 /* Values for ChannelMask above */
1802
1803 #define ACPI_NHLT_SPKR_FRONT_LEFT 0x1
1804 #define ACPI_NHLT_SPKR_FRONT_RIGHT 0x2
1805 #define ACPI_NHLT_SPKR_FRONT_CENTER 0x4
1806 #define ACPI_NHLT_SPKR_LOW_FREQ 0x8
1807 #define ACPI_NHLT_SPKR_BACK_LEFT 0x10
1808 #define ACPI_NHLT_SPKR_BACK_RIGHT 0x20
1809 #define ACPI_NHLT_SPKR_FRONT_LEFT_OF_CENTER 0x40
1810 #define ACPI_NHLT_SPKR_FRONT_RIGHT_OF_CENTER 0x80
1811 #define ACPI_NHLT_SPKR_BACK_CENTER 0x100
1812 #define ACPI_NHLT_SPKR_SIDE_LEFT 0x200
1813 #define ACPI_NHLT_SPKR_SIDE_RIGHT 0x400
1814 #define ACPI_NHLT_SPKR_TOP_CENTER 0x800
1815 #define ACPI_NHLT_SPKR_TOP_FRONT_LEFT 0x1000
1816 #define ACPI_NHLT_SPKR_TOP_FRONT_CENTER 0x2000
1817 #define ACPI_NHLT_SPKR_TOP_FRONT_RIGHT 0x4000
1818 #define ACPI_NHLT_SPKR_TOP_BACK_LEFT 0x8000
1819 #define ACPI_NHLT_SPKR_TOP_BACK_CENTER 0x10000
1820 #define ACPI_NHLT_SPKR_TOP_BACK_RIGHT 0x20000
1821
1822 typedef struct acpi_nhlt_format_config
1823 {
1824 ACPI_NHLT_WAVE_EXTENSIBLE Format;
1825 UINT32 CapabilitySize;
1826 UINT8 Capabilities[];
1827
1828 } ACPI_NHLT_FORMAT_CONFIG;
1829
1830 typedef struct acpi_nhlt_formats_config
1831 {
1832 UINT8 FormatsCount;
1833
1834 } ACPI_NHLT_FORMATS_CONFIG;
1835
1836 typedef struct acpi_nhlt_device_specific_hdr
1837 {
1838 UINT8 VirtualSlot;
1839 UINT8 ConfigType;
1840
1841 } ACPI_NHLT_DEVICE_SPECIFIC_HDR;
1842
1843 /* Types for ConfigType above */
1844
1845 #define ACPI_NHLT_GENERIC 0
1846 #define ACPI_NHLT_MIC 1
1847 #define ACPI_NHLT_RENDER 3
1848
1849 typedef struct acpi_nhlt_mic_device_specific_config
1850 {
1851 ACPI_NHLT_DEVICE_SPECIFIC_HDR DeviceConfig;
1852 UINT8 ArrayTypeExt;
1853
1854 } ACPI_NHLT_MIC_DEVICE_SPECIFIC_CONFIG;
1855
1856 /* Values for ArrayTypeExt above */
1857
1858 #define SMALL_LINEAR_2ELEMENT 0x0A
1859 #define BIG_LINEAR_2ELEMENT 0x0B
1860 #define FIRST_GEOMETRY_LINEAR_4ELEMENT 0x0C
1861 #define PLANAR_LSHAPED_4ELEMENT 0x0D
1862 #define SECOND_GEOMETRY_LINEAR_4ELEMENT 0x0E
1863 #define VENDOR_DEFINED 0x0F
1864 #define ARRAY_TYPE_MASK 0x0F
1865 #define ARRAY_TYPE_EXT_MASK 0x10
1866
1867 #define NO_EXTENSION 0x0
1868 #define MIC_SNR_SENSITIVITY_EXT 0x1
1869
1870
1871 typedef struct acpi_nhlt_vendor_mic_config
1872 {
1873 UINT8 Type;
1874 UINT8 Panel;
1875 UINT16 SpeakerPositionDistance; // mm
1876 UINT16 HorizontalOffset; // mm
1877 UINT16 VerticalOffset; // mm
1878 UINT8 FrequencyLowBand; // 5*Hz
1879 UINT8 FrequencyHighBand; // 500*Hz
1880 UINT16 DirectionAngle; // -180 - + 180
1881 UINT16 ElevationAngle; // -180 - + 180
1882 UINT16 WorkVerticalAngleBegin; // -180 - + 180 with 2 deg step
1883 UINT16 WorkVerticalAngleEnd; // -180 - + 180 with 2 deg step
1884 UINT16 WorkHorizontalAngleBegin; // -180 - + 180 with 2 deg step
1885 UINT16 WorkHorizontalAngleEnd; // -180 - + 180 with 2 deg step
1886
1887 } ACPI_NHLT_VENDOR_MIC_CONFIG;
1888
1889 /* Values for Type field above */
1890
1891 #define MIC_OMNIDIRECTIONAL 0
1892 #define MIC_SUBCARDIOID 1
1893 #define MIC_CARDIOID 2
1894 #define MIC_SUPER_CARDIOID 3
1895 #define MIC_HYPER_CARDIOID 4
1896 #define MIC_8_SHAPED 5
1897 #define MIC_VENDOR_DEFINED 7
1898
1899 /* Values for Panel field above */
1900
1901 #define MIC_TOP 0
1902 #define MIC_BOTTOM 1
1903 #define MIC_LEFT 2
1904 #define MIC_RIGHT 3
1905 #define MIC_FRONT 4
1906 #define MIC_REAR 5
1907
1908 typedef struct acpi_nhlt_vendor_mic_device_specific_config
1909 {
1910 ACPI_NHLT_MIC_DEVICE_SPECIFIC_CONFIG MicArrayDeviceConfig;
1911 UINT8 NumberOfMicrophones;
1912 ACPI_NHLT_VENDOR_MIC_CONFIG MicConfig[]; // Indexed by NumberOfMicrophones
1913
1914 } ACPI_NHLT_VENDOR_MIC_DEVICE_SPECIFIC_CONFIG;
1915
1916 /* Microphone SNR and Sensitivity extension */
1917
1918 typedef struct acpi_nhlt_mic_snr_sensitivity_extension
1919 {
1920 UINT32 SNR;
1921 UINT32 Sensitivity;
1922
1923 } ACPI_NHLT_MIC_SNR_SENSITIVITY_EXTENSION;
1924
1925 typedef struct acpi_nhlt_render_feedback_device_specific_config
1926 {
1927 ACPI_NHLT_DEVICE_SPECIFIC_CONFIG DeviceConfig;
1928 UINT8 FeedbackVirtualSlot; // Render slot in case of capture
1929 UINT16 FeedbackChannels; // Informative only
1930 UINT16 FeedbackValidBitsPerSample;
1931
1932 } ACPI_NHLT_RENDER_FEEDBACK_DEVICE_SPECIFIC_CONFIG;
1933
1934 /* Linux-specific structures */
1935
1936 typedef struct acpi_nhlt_linux_specific_count
1937 {
1938 UINT8 StructureCount;
1939
1940 } ACPI_NHLT_LINUX_SPECIFIC_COUNT;
1941
1942 typedef struct acpi_nhlt_linux_specific_data
1943 {
1944 UINT8 DeviceId[16];
1945 UINT8 DeviceInstanceId;
1946 UINT8 DevicePortId;
1947 UINT8 Filler[18];
1948
1949 } ACPI_NHLT_LINUX_SPECIFIC_DATA;
1950
1951 typedef struct acpi_nhlt_table_terminator
1952 {
1953 UINT32 TerminatorValue;
1954 UINT32 TerminatorSignature;
1955
1956 } ACPI_NHLT_TABLE_TERMINATOR;
1957
1958
1959 /*******************************************************************************
1960 *
1961 * PCCT - Platform Communications Channel Table (ACPI 5.0)
1962 * Version 2 (ACPI 6.2)
1963 *
1964 ******************************************************************************/
1965
1966 typedef struct acpi_table_pcct
1967 {
1968 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1969 UINT32 Flags;
1970 UINT64 Reserved;
1971
1972 } ACPI_TABLE_PCCT;
1973
1974 /* Values for Flags field above */
1975
1976 #define ACPI_PCCT_DOORBELL 1
1977
1978 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
1979
1980 enum AcpiPcctType
1981 {
1982 ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
1983 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE = 1,
1984 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2 = 2, /* ACPI 6.1 */
1985 ACPI_PCCT_TYPE_EXT_PCC_MASTER_SUBSPACE = 3, /* ACPI 6.2 */
1986 ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE = 4, /* ACPI 6.2 */
1987 ACPI_PCCT_TYPE_HW_REG_COMM_SUBSPACE = 5, /* ACPI 6.4 */
1988 ACPI_PCCT_TYPE_RESERVED = 6 /* 6 and greater are reserved */
1989 };
1990
1991 /*
1992 * PCCT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
1993 */
1994
1995 /* 0: Generic Communications Subspace */
1996
1997 typedef struct acpi_pcct_subspace
1998 {
1999 ACPI_SUBTABLE_HEADER Header;
2000 UINT8 Reserved[6];
2001 UINT64 BaseAddress;
2002 UINT64 Length;
2003 ACPI_GENERIC_ADDRESS DoorbellRegister;
2004 UINT64 PreserveMask;
2005 UINT64 WriteMask;
2006 UINT32 Latency;
2007 UINT32 MaxAccessRate;
2008 UINT16 MinTurnaroundTime;
2009
2010 } ACPI_PCCT_SUBSPACE;
2011
2012
2013 /* 1: HW-reduced Communications Subspace (ACPI 5.1) */
2014
2015 typedef struct acpi_pcct_hw_reduced
2016 {
2017 ACPI_SUBTABLE_HEADER Header;
2018 UINT32 PlatformInterrupt;
2019 UINT8 Flags;
2020 UINT8 Reserved;
2021 UINT64 BaseAddress;
2022 UINT64 Length;
2023 ACPI_GENERIC_ADDRESS DoorbellRegister;
2024 UINT64 PreserveMask;
2025 UINT64 WriteMask;
2026 UINT32 Latency;
2027 UINT32 MaxAccessRate;
2028 UINT16 MinTurnaroundTime;
2029
2030 } ACPI_PCCT_HW_REDUCED;
2031
2032
2033 /* 2: HW-reduced Communications Subspace Type 2 (ACPI 6.1) */
2034
2035 typedef struct acpi_pcct_hw_reduced_type2
2036 {
2037 ACPI_SUBTABLE_HEADER Header;
2038 UINT32 PlatformInterrupt;
2039 UINT8 Flags;
2040 UINT8 Reserved;
2041 UINT64 BaseAddress;
2042 UINT64 Length;
2043 ACPI_GENERIC_ADDRESS DoorbellRegister;
2044 UINT64 PreserveMask;
2045 UINT64 WriteMask;
2046 UINT32 Latency;
2047 UINT32 MaxAccessRate;
2048 UINT16 MinTurnaroundTime;
2049 ACPI_GENERIC_ADDRESS PlatformAckRegister;
2050 UINT64 AckPreserveMask;
2051 UINT64 AckWriteMask;
2052
2053 } ACPI_PCCT_HW_REDUCED_TYPE2;
2054
2055
2056 /* 3: Extended PCC Master Subspace Type 3 (ACPI 6.2) */
2057
2058 typedef struct acpi_pcct_ext_pcc_master
2059 {
2060 ACPI_SUBTABLE_HEADER Header;
2061 UINT32 PlatformInterrupt;
2062 UINT8 Flags;
2063 UINT8 Reserved1;
2064 UINT64 BaseAddress;
2065 UINT32 Length;
2066 ACPI_GENERIC_ADDRESS DoorbellRegister;
2067 UINT64 PreserveMask;
2068 UINT64 WriteMask;
2069 UINT32 Latency;
2070 UINT32 MaxAccessRate;
2071 UINT32 MinTurnaroundTime;
2072 ACPI_GENERIC_ADDRESS PlatformAckRegister;
2073 UINT64 AckPreserveMask;
2074 UINT64 AckSetMask;
2075 UINT64 Reserved2;
2076 ACPI_GENERIC_ADDRESS CmdCompleteRegister;
2077 UINT64 CmdCompleteMask;
2078 ACPI_GENERIC_ADDRESS CmdUpdateRegister;
2079 UINT64 CmdUpdatePreserveMask;
2080 UINT64 CmdUpdateSetMask;
2081 ACPI_GENERIC_ADDRESS ErrorStatusRegister;
2082 UINT64 ErrorStatusMask;
2083
2084 } ACPI_PCCT_EXT_PCC_MASTER;
2085
2086
2087 /* 4: Extended PCC Slave Subspace Type 4 (ACPI 6.2) */
2088
2089 typedef struct acpi_pcct_ext_pcc_slave
2090 {
2091 ACPI_SUBTABLE_HEADER Header;
2092 UINT32 PlatformInterrupt;
2093 UINT8 Flags;
2094 UINT8 Reserved1;
2095 UINT64 BaseAddress;
2096 UINT32 Length;
2097 ACPI_GENERIC_ADDRESS DoorbellRegister;
2098 UINT64 PreserveMask;
2099 UINT64 WriteMask;
2100 UINT32 Latency;
2101 UINT32 MaxAccessRate;
2102 UINT32 MinTurnaroundTime;
2103 ACPI_GENERIC_ADDRESS PlatformAckRegister;
2104 UINT64 AckPreserveMask;
2105 UINT64 AckSetMask;
2106 UINT64 Reserved2;
2107 ACPI_GENERIC_ADDRESS CmdCompleteRegister;
2108 UINT64 CmdCompleteMask;
2109 ACPI_GENERIC_ADDRESS CmdUpdateRegister;
2110 UINT64 CmdUpdatePreserveMask;
2111 UINT64 CmdUpdateSetMask;
2112 ACPI_GENERIC_ADDRESS ErrorStatusRegister;
2113 UINT64 ErrorStatusMask;
2114
2115 } ACPI_PCCT_EXT_PCC_SLAVE;
2116
2117 /* 5: HW Registers based Communications Subspace */
2118
2119 typedef struct acpi_pcct_hw_reg
2120 {
2121 ACPI_SUBTABLE_HEADER Header;
2122 UINT16 Version;
2123 UINT64 BaseAddress;
2124 UINT64 Length;
2125 ACPI_GENERIC_ADDRESS DoorbellRegister;
2126 UINT64 DoorbellPreserve;
2127 UINT64 DoorbellWrite;
2128 ACPI_GENERIC_ADDRESS CmdCompleteRegister;
2129 UINT64 CmdCompleteMask;
2130 ACPI_GENERIC_ADDRESS ErrorStatusRegister;
2131 UINT64 ErrorStatusMask;
2132 UINT32 NominalLatency;
2133 UINT32 MinTurnaroundTime;
2134
2135 } ACPI_PCCT_HW_REG;
2136
2137
2138 /* Values for doorbell flags above */
2139
2140 #define ACPI_PCCT_INTERRUPT_POLARITY (1)
2141 #define ACPI_PCCT_INTERRUPT_MODE (1<<1)
2142
2143
2144 /*
2145 * PCC memory structures (not part of the ACPI table)
2146 */
2147
2148 /* Shared Memory Region */
2149
2150 typedef struct acpi_pcct_shared_memory
2151 {
2152 UINT32 Signature;
2153 UINT16 Command;
2154 UINT16 Status;
2155
2156 } ACPI_PCCT_SHARED_MEMORY;
2157
2158
2159 /* Extended PCC Subspace Shared Memory Region (ACPI 6.2) */
2160
2161 typedef struct acpi_pcct_ext_pcc_shared_memory
2162 {
2163 UINT32 Signature;
2164 UINT32 Flags;
2165 UINT32 Length;
2166 UINT32 Command;
2167
2168 } ACPI_PCCT_EXT_PCC_SHARED_MEMORY;
2169
2170
2171 /*******************************************************************************
2172 *
2173 * PDTT - Platform Debug Trigger Table (ACPI 6.2)
2174 * Version 0
2175 *
2176 ******************************************************************************/
2177
2178 typedef struct acpi_table_pdtt
2179 {
2180 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2181 UINT8 TriggerCount;
2182 UINT8 Reserved[3];
2183 UINT32 ArrayOffset;
2184
2185 } ACPI_TABLE_PDTT;
2186
2187
2188 /*
2189 * PDTT Communication Channel Identifier Structure.
2190 * The number of these structures is defined by TriggerCount above,
2191 * starting at ArrayOffset.
2192 */
2193 typedef struct acpi_pdtt_channel
2194 {
2195 UINT8 SubchannelId;
2196 UINT8 Flags;
2197
2198 } ACPI_PDTT_CHANNEL;
2199
2200 /* Flags for above */
2201
2202 #define ACPI_PDTT_RUNTIME_TRIGGER (1)
2203 #define ACPI_PDTT_WAIT_COMPLETION (1<<1)
2204 #define ACPI_PDTT_TRIGGER_ORDER (1<<2)
2205
2206
2207 /*******************************************************************************
2208 *
2209 * PHAT - Platform Health Assessment Table (ACPI 6.4)
2210 * Version 1
2211 *
2212 ******************************************************************************/
2213
2214 typedef struct acpi_table_phat
2215 {
2216 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2217
2218 } ACPI_TABLE_PHAT;
2219
2220 /* Common header for PHAT subtables that follow main table */
2221
2222 typedef struct acpi_phat_header
2223 {
2224 UINT16 Type;
2225 UINT16 Length;
2226 UINT8 Revision;
2227
2228 } ACPI_PHAT_HEADER;
2229
2230
2231 /* Values for Type field above */
2232
2233 #define ACPI_PHAT_TYPE_FW_VERSION_DATA 0
2234 #define ACPI_PHAT_TYPE_FW_HEALTH_DATA 1
2235 #define ACPI_PHAT_TYPE_RESERVED 2 /* 0x02-0xFFFF are reserved */
2236
2237 /*
2238 * PHAT subtables, correspond to Type in ACPI_PHAT_HEADER
2239 */
2240
2241 /* 0: Firmware Version Data Record */
2242
2243 typedef struct acpi_phat_version_data
2244 {
2245 ACPI_PHAT_HEADER Header;
2246 UINT8 Reserved[3];
2247 UINT32 ElementCount;
2248
2249 } ACPI_PHAT_VERSION_DATA;
2250
2251 typedef struct acpi_phat_version_element
2252 {
2253 UINT8 Guid[16];
2254 UINT64 VersionValue;
2255 UINT32 ProducerId;
2256
2257 } ACPI_PHAT_VERSION_ELEMENT;
2258
2259
2260 /* 1: Firmware Health Data Record */
2261
2262 typedef struct acpi_phat_health_data
2263 {
2264 ACPI_PHAT_HEADER Header;
2265 UINT8 Reserved[2];
2266 UINT8 Health;
2267 UINT8 DeviceGuid[16];
2268 UINT32 DeviceSpecificOffset; /* Zero if no Device-specific data */
2269
2270 } ACPI_PHAT_HEALTH_DATA;
2271
2272 /* Values for Health field above */
2273
2274 #define ACPI_PHAT_ERRORS_FOUND 0
2275 #define ACPI_PHAT_NO_ERRORS 1
2276 #define ACPI_PHAT_UNKNOWN_ERRORS 2
2277 #define ACPI_PHAT_ADVISORY 3
2278
2279
2280 /*******************************************************************************
2281 *
2282 * PMTT - Platform Memory Topology Table (ACPI 5.0)
2283 * Version 1
2284 *
2285 ******************************************************************************/
2286
2287 typedef struct acpi_table_pmtt
2288 {
2289 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2290 UINT32 MemoryDeviceCount;
2291 /*
2292 * Immediately followed by:
2293 * MEMORY_DEVICE MemoryDeviceStruct[MemoryDeviceCount];
2294 */
2295
2296 } ACPI_TABLE_PMTT;
2297
2298
2299 /* Common header for PMTT subtables that follow main table */
2300
2301 typedef struct acpi_pmtt_header
2302 {
2303 UINT8 Type;
2304 UINT8 Reserved1;
2305 UINT16 Length;
2306 UINT16 Flags;
2307 UINT16 Reserved2;
2308 UINT32 MemoryDeviceCount; /* Zero means no memory device structs follow */
2309 /*
2310 * Immediately followed by:
2311 * UINT8 TypeSpecificData[]
2312 * MEMORY_DEVICE MemoryDeviceStruct[MemoryDeviceCount];
2313 */
2314
2315 } ACPI_PMTT_HEADER;
2316
2317 /* Values for Type field above */
2318
2319 #define ACPI_PMTT_TYPE_SOCKET 0
2320 #define ACPI_PMTT_TYPE_CONTROLLER 1
2321 #define ACPI_PMTT_TYPE_DIMM 2
2322 #define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFE are reserved */
2323 #define ACPI_PMTT_TYPE_VENDOR 0xFF
2324
2325 /* Values for Flags field above */
2326
2327 #define ACPI_PMTT_TOP_LEVEL 0x0001
2328 #define ACPI_PMTT_PHYSICAL 0x0002
2329 #define ACPI_PMTT_MEMORY_TYPE 0x000C
2330
2331
2332 /*
2333 * PMTT subtables, correspond to Type in acpi_pmtt_header
2334 */
2335
2336
2337 /* 0: Socket Structure */
2338
2339 typedef struct acpi_pmtt_socket
2340 {
2341 ACPI_PMTT_HEADER Header;
2342 UINT16 SocketId;
2343 UINT16 Reserved;
2344
2345 } ACPI_PMTT_SOCKET;
2346 /*
2347 * Immediately followed by:
2348 * MEMORY_DEVICE MemoryDeviceStruct[MemoryDeviceCount];
2349 */
2350
2351
2352 /* 1: Memory Controller subtable */
2353
2354 typedef struct acpi_pmtt_controller
2355 {
2356 ACPI_PMTT_HEADER Header;
2357 UINT16 ControllerId;
2358 UINT16 Reserved;
2359
2360 } ACPI_PMTT_CONTROLLER;
2361 /*
2362 * Immediately followed by:
2363 * MEMORY_DEVICE MemoryDeviceStruct[MemoryDeviceCount];
2364 */
2365
2366
2367 /* 2: Physical Component Identifier (DIMM) */
2368
2369 typedef struct acpi_pmtt_physical_component
2370 {
2371 ACPI_PMTT_HEADER Header;
2372 UINT32 BiosHandle;
2373
2374 } ACPI_PMTT_PHYSICAL_COMPONENT;
2375
2376
2377 /* 0xFF: Vendor Specific Data */
2378
2379 typedef struct acpi_pmtt_vendor_specific
2380 {
2381 ACPI_PMTT_HEADER Header;
2382 UINT8 TypeUuid[16];
2383 UINT8 Specific[];
2384 /*
2385 * Immediately followed by:
2386 * UINT8 VendorSpecificData[];
2387 * MEMORY_DEVICE MemoryDeviceStruct[MemoryDeviceCount];
2388 */
2389
2390 } ACPI_PMTT_VENDOR_SPECIFIC;
2391
2392
2393 /*******************************************************************************
2394 *
2395 * PPTT - Processor Properties Topology Table (ACPI 6.2)
2396 * Version 1
2397 *
2398 ******************************************************************************/
2399
2400 typedef struct acpi_table_pptt
2401 {
2402 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2403
2404 } ACPI_TABLE_PPTT;
2405
2406 /* Values for Type field above */
2407
2408 enum AcpiPpttType
2409 {
2410 ACPI_PPTT_TYPE_PROCESSOR = 0,
2411 ACPI_PPTT_TYPE_CACHE = 1,
2412 ACPI_PPTT_TYPE_ID = 2,
2413 ACPI_PPTT_TYPE_RESERVED = 3
2414 };
2415
2416
2417 /* 0: Processor Hierarchy Node Structure */
2418
2419 typedef struct acpi_pptt_processor
2420 {
2421 ACPI_SUBTABLE_HEADER Header;
2422 UINT16 Reserved;
2423 UINT32 Flags;
2424 UINT32 Parent;
2425 UINT32 AcpiProcessorId;
2426 UINT32 NumberOfPrivResources;
2427
2428 } ACPI_PPTT_PROCESSOR;
2429
2430 /* Flags */
2431
2432 #define ACPI_PPTT_PHYSICAL_PACKAGE (1)
2433 #define ACPI_PPTT_ACPI_PROCESSOR_ID_VALID (1<<1)
2434 #define ACPI_PPTT_ACPI_PROCESSOR_IS_THREAD (1<<2) /* ACPI 6.3 */
2435 #define ACPI_PPTT_ACPI_LEAF_NODE (1<<3) /* ACPI 6.3 */
2436 #define ACPI_PPTT_ACPI_IDENTICAL (1<<4) /* ACPI 6.3 */
2437
2438
2439 /* 1: Cache Type Structure */
2440
2441 typedef struct acpi_pptt_cache
2442 {
2443 ACPI_SUBTABLE_HEADER Header;
2444 UINT16 Reserved;
2445 UINT32 Flags;
2446 UINT32 NextLevelOfCache;
2447 UINT32 Size;
2448 UINT32 NumberOfSets;
2449 UINT8 Associativity;
2450 UINT8 Attributes;
2451 UINT16 LineSize;
2452
2453 } ACPI_PPTT_CACHE;
2454
2455 /* 1: Cache Type Structure for PPTT version 3 */
2456
2457 typedef struct acpi_pptt_cache_v1
2458 {
2459 UINT32 CacheId;
2460
2461 } ACPI_PPTT_CACHE_V1;
2462
2463
2464 /* Flags */
2465
2466 #define ACPI_PPTT_SIZE_PROPERTY_VALID (1) /* Physical property valid */
2467 #define ACPI_PPTT_NUMBER_OF_SETS_VALID (1<<1) /* Number of sets valid */
2468 #define ACPI_PPTT_ASSOCIATIVITY_VALID (1<<2) /* Associativity valid */
2469 #define ACPI_PPTT_ALLOCATION_TYPE_VALID (1<<3) /* Allocation type valid */
2470 #define ACPI_PPTT_CACHE_TYPE_VALID (1<<4) /* Cache type valid */
2471 #define ACPI_PPTT_WRITE_POLICY_VALID (1<<5) /* Write policy valid */
2472 #define ACPI_PPTT_LINE_SIZE_VALID (1<<6) /* Line size valid */
2473 #define ACPI_PPTT_CACHE_ID_VALID (1<<7) /* Cache ID valid */
2474
2475 /* Masks for Attributes */
2476
2477 #define ACPI_PPTT_MASK_ALLOCATION_TYPE (0x03) /* Allocation type */
2478 #define ACPI_PPTT_MASK_CACHE_TYPE (0x0C) /* Cache type */
2479 #define ACPI_PPTT_MASK_WRITE_POLICY (0x10) /* Write policy */
2480
2481 /* Attributes describing cache */
2482 #define ACPI_PPTT_CACHE_READ_ALLOCATE (0x0) /* Cache line is allocated on read */
2483 #define ACPI_PPTT_CACHE_WRITE_ALLOCATE (0x01) /* Cache line is allocated on write */
2484 #define ACPI_PPTT_CACHE_RW_ALLOCATE (0x02) /* Cache line is allocated on read and write */
2485 #define ACPI_PPTT_CACHE_RW_ALLOCATE_ALT (0x03) /* Alternate representation of above */
2486
2487 #define ACPI_PPTT_CACHE_TYPE_DATA (0x0) /* Data cache */
2488 #define ACPI_PPTT_CACHE_TYPE_INSTR (1<<2) /* Instruction cache */
2489 #define ACPI_PPTT_CACHE_TYPE_UNIFIED (2<<2) /* Unified I & D cache */
2490 #define ACPI_PPTT_CACHE_TYPE_UNIFIED_ALT (3<<2) /* Alternate representation of above */
2491
2492 #define ACPI_PPTT_CACHE_POLICY_WB (0x0) /* Cache is write back */
2493 #define ACPI_PPTT_CACHE_POLICY_WT (1<<4) /* Cache is write through */
2494
2495 /* 2: ID Structure */
2496
2497 typedef struct acpi_pptt_id
2498 {
2499 ACPI_SUBTABLE_HEADER Header;
2500 UINT16 Reserved;
2501 UINT32 VendorId;
2502 UINT64 Level1Id;
2503 UINT64 Level2Id;
2504 UINT16 MajorRev;
2505 UINT16 MinorRev;
2506 UINT16 SpinRev;
2507
2508 } ACPI_PPTT_ID;
2509
2510
2511 /*******************************************************************************
2512 *
2513 * PRMT - Platform Runtime Mechanism Table
2514 * Version 1
2515 *
2516 ******************************************************************************/
2517
2518 typedef struct acpi_table_prmt
2519 {
2520 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2521
2522 } ACPI_TABLE_PRMT;
2523
2524 typedef struct acpi_table_prmt_header
2525 {
2526 UINT8 PlatformGuid[16];
2527 UINT32 ModuleInfoOffset;
2528 UINT32 ModuleInfoCount;
2529
2530 } ACPI_TABLE_PRMT_HEADER;
2531
2532 typedef struct acpi_prmt_module_header
2533 {
2534 UINT16 Revision;
2535 UINT16 Length;
2536
2537 } ACPI_PRMT_MODULE_HEADER;
2538
2539 typedef struct acpi_prmt_module_info
2540 {
2541 UINT16 Revision;
2542 UINT16 Length;
2543 UINT8 ModuleGuid[16];
2544 UINT16 MajorRev;
2545 UINT16 MinorRev;
2546 UINT16 HandlerInfoCount;
2547 UINT32 HandlerInfoOffset;
2548 UINT64 MmioListPointer;
2549
2550 } ACPI_PRMT_MODULE_INFO;
2551
2552 typedef struct acpi_prmt_handler_info
2553 {
2554 UINT16 Revision;
2555 UINT16 Length;
2556 UINT8 HandlerGuid[16];
2557 UINT64 HandlerAddress;
2558 UINT64 StaticDataBufferAddress;
2559 UINT64 AcpiParamBufferAddress;
2560
2561 } ACPI_PRMT_HANDLER_INFO;
2562
2563
2564 /*******************************************************************************
2565 *
2566 * RASF - RAS Feature Table (ACPI 5.0)
2567 * Version 1
2568 *
2569 ******************************************************************************/
2570
2571 typedef struct acpi_table_rasf
2572 {
2573 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2574 UINT8 ChannelId[12];
2575
2576 } ACPI_TABLE_RASF;
2577
2578 /* RASF Platform Communication Channel Shared Memory Region */
2579
2580 typedef struct acpi_rasf_shared_memory
2581 {
2582 UINT32 Signature;
2583 UINT16 Command;
2584 UINT16 Status;
2585 UINT16 Version;
2586 UINT8 Capabilities[16];
2587 UINT8 SetCapabilities[16];
2588 UINT16 NumParameterBlocks;
2589 UINT32 SetCapabilitiesStatus;
2590
2591 } ACPI_RASF_SHARED_MEMORY;
2592
2593 /* RASF Parameter Block Structure Header */
2594
2595 typedef struct acpi_rasf_parameter_block
2596 {
2597 UINT16 Type;
2598 UINT16 Version;
2599 UINT16 Length;
2600
2601 } ACPI_RASF_PARAMETER_BLOCK;
2602
2603 /* RASF Parameter Block Structure for PATROL_SCRUB */
2604
2605 typedef struct acpi_rasf_patrol_scrub_parameter
2606 {
2607 ACPI_RASF_PARAMETER_BLOCK Header;
2608 UINT16 PatrolScrubCommand;
2609 UINT64 RequestedAddressRange[2];
2610 UINT64 ActualAddressRange[2];
2611 UINT16 Flags;
2612 UINT8 RequestedSpeed;
2613
2614 } ACPI_RASF_PATROL_SCRUB_PARAMETER;
2615
2616 /* Masks for Flags and Speed fields above */
2617
2618 #define ACPI_RASF_SCRUBBER_RUNNING 1
2619 #define ACPI_RASF_SPEED (7<<1)
2620 #define ACPI_RASF_SPEED_SLOW (0<<1)
2621 #define ACPI_RASF_SPEED_MEDIUM (4<<1)
2622 #define ACPI_RASF_SPEED_FAST (7<<1)
2623
2624 /* Channel Commands */
2625
2626 enum AcpiRasfCommands
2627 {
2628 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
2629 };
2630
2631 /* Platform RAS Capabilities */
2632
2633 enum AcpiRasfCapabiliities
2634 {
2635 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
2636 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
2637 };
2638
2639 /* Patrol Scrub Commands */
2640
2641 enum AcpiRasfPatrolScrubCommands
2642 {
2643 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
2644 ACPI_RASF_START_PATROL_SCRUBBER = 2,
2645 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
2646 };
2647
2648 /* Channel Command flags */
2649
2650 #define ACPI_RASF_GENERATE_SCI (1<<15)
2651
2652 /* Status values */
2653
2654 enum AcpiRasfStatus
2655 {
2656 ACPI_RASF_SUCCESS = 0,
2657 ACPI_RASF_NOT_VALID = 1,
2658 ACPI_RASF_NOT_SUPPORTED = 2,
2659 ACPI_RASF_BUSY = 3,
2660 ACPI_RASF_FAILED = 4,
2661 ACPI_RASF_ABORTED = 5,
2662 ACPI_RASF_INVALID_DATA = 6
2663 };
2664
2665 /* Status flags */
2666
2667 #define ACPI_RASF_COMMAND_COMPLETE (1)
2668 #define ACPI_RASF_SCI_DOORBELL (1<<1)
2669 #define ACPI_RASF_ERROR (1<<2)
2670 #define ACPI_RASF_STATUS (0x1F<<3)
2671
2672
2673 /*******************************************************************************
2674 *
2675 * RGRT - Regulatory Graphics Resource Table
2676 * Version 1
2677 *
2678 * Conforms to "ACPI RGRT" available at:
2679 * https://microsoft.github.io/mu/dyn/mu_plus/MsCorePkg/AcpiRGRT/feature_acpi_rgrt/
2680 *
2681 ******************************************************************************/
2682
2683 typedef struct acpi_table_rgrt
2684 {
2685 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2686 UINT16 Version;
2687 UINT8 ImageType;
2688 UINT8 Reserved;
2689 UINT8 Image[0];
2690
2691 } ACPI_TABLE_RGRT;
2692
2693 /* ImageType values */
2694
2695 enum AcpiRgrtImageType
2696 {
2697 ACPI_RGRT_TYPE_RESERVED0 = 0,
2698 ACPI_RGRT_IMAGE_TYPE_PNG = 1,
2699 ACPI_RGRT_TYPE_RESERVED = 2 /* 2 and greater are reserved */
2700 };
2701
2702
2703 /*******************************************************************************
2704 *
2705 * SBST - Smart Battery Specification Table
2706 * Version 1
2707 *
2708 ******************************************************************************/
2709
2710 typedef struct acpi_table_sbst
2711 {
2712 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2713 UINT32 WarningLevel;
2714 UINT32 LowLevel;
2715 UINT32 CriticalLevel;
2716
2717 } ACPI_TABLE_SBST;
2718
2719
2720 /*******************************************************************************
2721 *
2722 * SDEI - Software Delegated Exception Interface Descriptor Table
2723 *
2724 * Conforms to "Software Delegated Exception Interface (SDEI)" ARM DEN0054A,
2725 * May 8th, 2017. Copyright 2017 ARM Ltd.
2726 *
2727 ******************************************************************************/
2728
2729 typedef struct acpi_table_sdei
2730 {
2731 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2732
2733 } ACPI_TABLE_SDEI;
2734
2735
2736 /*******************************************************************************
2737 *
2738 * SDEV - Secure Devices Table (ACPI 6.2)
2739 * Version 1
2740 *
2741 ******************************************************************************/
2742
2743 typedef struct acpi_table_sdev
2744 {
2745 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2746
2747 } ACPI_TABLE_SDEV;
2748
2749
2750 typedef struct acpi_sdev_header
2751 {
2752 UINT8 Type;
2753 UINT8 Flags;
2754 UINT16 Length;
2755
2756 } ACPI_SDEV_HEADER;
2757
2758
2759 /* Values for subtable type above */
2760
2761 enum AcpiSdevType
2762 {
2763 ACPI_SDEV_TYPE_NAMESPACE_DEVICE = 0,
2764 ACPI_SDEV_TYPE_PCIE_ENDPOINT_DEVICE = 1,
2765 ACPI_SDEV_TYPE_RESERVED = 2 /* 2 and greater are reserved */
2766 };
2767
2768 /* Values for flags above */
2769
2770 #define ACPI_SDEV_HANDOFF_TO_UNSECURE_OS (1)
2771 #define ACPI_SDEV_SECURE_COMPONENTS_PRESENT (1<<1)
2772
2773 /*
2774 * SDEV subtables
2775 */
2776
2777 /* 0: Namespace Device Based Secure Device Structure */
2778
2779 typedef struct acpi_sdev_namespace
2780 {
2781 ACPI_SDEV_HEADER Header;
2782 UINT16 DeviceIdOffset;
2783 UINT16 DeviceIdLength;
2784 UINT16 VendorDataOffset;
2785 UINT16 VendorDataLength;
2786
2787 } ACPI_SDEV_NAMESPACE;
2788
2789 typedef struct acpi_sdev_secure_component
2790 {
2791 UINT16 SecureComponentOffset;
2792 UINT16 SecureComponentLength;
2793
2794 } ACPI_SDEV_SECURE_COMPONENT;
2795
2796
2797 /*
2798 * SDEV sub-subtables ("Components") for above
2799 */
2800 typedef struct acpi_sdev_component
2801 {
2802 ACPI_SDEV_HEADER Header;
2803
2804 } ACPI_SDEV_COMPONENT;
2805
2806
2807 /* Values for sub-subtable type above */
2808
2809 enum AcpiSacType
2810 {
2811 ACPI_SDEV_TYPE_ID_COMPONENT = 0,
2812 ACPI_SDEV_TYPE_MEM_COMPONENT = 1
2813 };
2814
2815 typedef struct acpi_sdev_id_component
2816 {
2817 ACPI_SDEV_HEADER Header;
2818 UINT16 HardwareIdOffset;
2819 UINT16 HardwareIdLength;
2820 UINT16 SubsystemIdOffset;
2821 UINT16 SubsystemIdLength;
2822 UINT16 HardwareRevision;
2823 UINT8 HardwareRevPresent;
2824 UINT8 ClassCodePresent;
2825 UINT8 PciBaseClass;
2826 UINT8 PciSubClass;
2827 UINT8 PciProgrammingXface;
2828
2829 } ACPI_SDEV_ID_COMPONENT;
2830
2831 typedef struct acpi_sdev_mem_component
2832 {
2833 ACPI_SDEV_HEADER Header;
2834 UINT32 Reserved;
2835 UINT64 MemoryBaseAddress;
2836 UINT64 MemoryLength;
2837
2838 } ACPI_SDEV_MEM_COMPONENT;
2839
2840
2841 /* 1: PCIe Endpoint Device Based Device Structure */
2842
2843 typedef struct acpi_sdev_pcie
2844 {
2845 ACPI_SDEV_HEADER Header;
2846 UINT16 Segment;
2847 UINT16 StartBus;
2848 UINT16 PathOffset;
2849 UINT16 PathLength;
2850 UINT16 VendorDataOffset;
2851 UINT16 VendorDataLength;
2852
2853 } ACPI_SDEV_PCIE;
2854
2855 /* 1a: PCIe Endpoint path entry */
2856
2857 typedef struct acpi_sdev_pcie_path
2858 {
2859 UINT8 Device;
2860 UINT8 Function;
2861
2862 } ACPI_SDEV_PCIE_PATH;
2863
2864
2865 /*******************************************************************************
2866 *
2867 * SVKL - Storage Volume Key Location Table (ACPI 6.4)
2868 * From: "Guest-Host-Communication Interface (GHCI) for Intel
2869 * Trust Domain Extensions (Intel TDX)".
2870 * Version 1
2871 *
2872 ******************************************************************************/
2873
2874 typedef struct acpi_table_svkl
2875 {
2876 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
2877 UINT32 Count;
2878
2879 } ACPI_TABLE_SVKL;
2880
2881 typedef struct acpi_svkl_key
2882 {
2883 UINT16 Type;
2884 UINT16 Format;
2885 UINT32 Size;
2886 UINT64 Address;
2887
2888 } ACPI_SVKL_KEY;
2889
2890 enum acpi_svkl_type
2891 {
2892 ACPI_SVKL_TYPE_MAIN_STORAGE = 0,
2893 ACPI_SVKL_TYPE_RESERVED = 1 /* 1 and greater are reserved */
2894 };
2895
2896 enum acpi_svkl_format
2897 {
2898 ACPI_SVKL_FORMAT_RAW_BINARY = 0,
2899 ACPI_SVKL_FORMAT_RESERVED = 1 /* 1 and greater are reserved */
2900 };
2901
2902
2903 /* Reset to default packing */
2904
2905 #pragma pack()
2906
2907 #endif /* __ACTBL2_H__ */
2908