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