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