Home | History | Annotate | Line # | Download | only in include
actbl2.h revision 1.1.1.14
      1 /******************************************************************************
      2  *
      3  * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
      4  *
      5  *****************************************************************************/
      6 
      7 /*
      8  * Copyright (C) 2000 - 2018, Intel Corp.
      9  * All rights reserved.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions, and the following disclaimer,
     16  *    without modification.
     17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  *    including a substantially similar Disclaimer requirement for further
     21  *    binary redistribution.
     22  * 3. Neither the names of the above-listed copyright holders nor the names
     23  *    of any contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * Alternatively, this software may be distributed under the terms of the
     27  * GNU General Public License ("GPL") version 2 as published by the Free
     28  * Software Foundation.
     29  *
     30  * NO WARRANTY
     31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  * POSSIBILITY OF SUCH DAMAGES.
     42  */
     43 
     44 #ifndef __ACTBL2_H__
     45 #define __ACTBL2_H__
     46 
     47 
     48 /*******************************************************************************
     49  *
     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_IORT           "IORT"      /* IO Remapping Table */
     64 #define ACPI_SIG_IVRS           "IVRS"      /* I/O Virtualization Reporting Structure */
     65 #define ACPI_SIG_LPIT           "LPIT"      /* Low Power Idle Table */
     66 #define ACPI_SIG_MADT           "APIC"      /* Multiple APIC Description Table */
     67 #define ACPI_SIG_MCFG           "MCFG"      /* PCI Memory Mapped Configuration table */
     68 #define ACPI_SIG_MCHI           "MCHI"      /* Management Controller Host Interface table */
     69 #define ACPI_SIG_MPST           "MPST"      /* Memory Power State Table */
     70 #define ACPI_SIG_MSCT           "MSCT"      /* Maximum System Characteristics Table */
     71 #define ACPI_SIG_MSDM           "MSDM"      /* Microsoft Data Management Table */
     72 #define ACPI_SIG_MTMR           "MTMR"      /* MID Timer table */
     73 #define ACPI_SIG_NFIT           "NFIT"      /* NVDIMM Firmware Interface Table */
     74 #define ACPI_SIG_PCCT           "PCCT"      /* Platform Communications Channel Table */
     75 #define ACPI_SIG_PDTT           "PDTT"      /* Platform Debug Trigger Table */
     76 #define ACPI_SIG_PMTT           "PMTT"      /* Platform Memory Topology Table */
     77 #define ACPI_SIG_PPTT           "PPTT"      /* Processor Properties Topology Table */
     78 #define ACPI_SIG_RASF           "RASF"      /* RAS Feature table */
     79 #define ACPI_SIG_SBST           "SBST"      /* Smart Battery Specification Table */
     80 #define ACPI_SIG_SDEI           "SDEI"      /* Software Delegated Exception Interface Table */
     81 #define ACPI_SIG_SDEV           "SDEV"      /* Secure Devices table */
     82 
     83 
     84 /*
     85  * All tables must be byte-packed to match the ACPI specification, since
     86  * the tables are provided by the system BIOS.
     87  */
     88 #pragma pack(1)
     89 
     90 /*
     91  * Note: C bitfields are not used for this reason:
     92  *
     93  * "Bitfields are great and easy to read, but unfortunately the C language
     94  * does not specify the layout of bitfields in memory, which means they are
     95  * essentially useless for dealing with packed data in on-disk formats or
     96  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
     97  * this decision was a design error in C. Ritchie could have picked an order
     98  * and stuck with it." Norman Ramsey.
     99  * See http://stackoverflow.com/a/1053662/41661
    100  */
    101 
    102 
    103 /*******************************************************************************
    104  *
    105  * IORT - IO Remapping Table
    106  *
    107  * Conforms to "IO Remapping Table System Software on ARM Platforms",
    108  * Document number: ARM DEN 0049C, May 2017
    109  *
    110  ******************************************************************************/
    111 
    112 typedef struct acpi_table_iort
    113 {
    114     ACPI_TABLE_HEADER       Header;
    115     UINT32                  NodeCount;
    116     UINT32                  NodeOffset;
    117     UINT32                  Reserved;
    118 
    119 } ACPI_TABLE_IORT;
    120 
    121 
    122 /*
    123  * IORT subtables
    124  */
    125 typedef struct acpi_iort_node
    126 {
    127     UINT8                   Type;
    128     UINT16                  Length;
    129     UINT8                   Revision;
    130     UINT32                  Reserved;
    131     UINT32                  MappingCount;
    132     UINT32                  MappingOffset;
    133     char                    NodeData[1];
    134 
    135 } ACPI_IORT_NODE;
    136 
    137 /* Values for subtable Type above */
    138 
    139 enum AcpiIortNodeType
    140 {
    141     ACPI_IORT_NODE_ITS_GROUP            = 0x00,
    142     ACPI_IORT_NODE_NAMED_COMPONENT      = 0x01,
    143     ACPI_IORT_NODE_PCI_ROOT_COMPLEX     = 0x02,
    144     ACPI_IORT_NODE_SMMU                 = 0x03,
    145     ACPI_IORT_NODE_SMMU_V3              = 0x04
    146 };
    147 
    148 
    149 typedef struct acpi_iort_id_mapping
    150 {
    151     UINT32                  InputBase;          /* Lowest value in input range */
    152     UINT32                  IdCount;            /* Number of IDs */
    153     UINT32                  OutputBase;         /* Lowest value in output range */
    154     UINT32                  OutputReference;    /* A reference to the output node */
    155     UINT32                  Flags;
    156 
    157 } ACPI_IORT_ID_MAPPING;
    158 
    159 /* Masks for Flags field above for IORT subtable */
    160 
    161 #define ACPI_IORT_ID_SINGLE_MAPPING (1)
    162 
    163 
    164 typedef struct acpi_iort_memory_access
    165 {
    166     UINT32                  CacheCoherency;
    167     UINT8                   Hints;
    168     UINT16                  Reserved;
    169     UINT8                   MemoryFlags;
    170 
    171 } ACPI_IORT_MEMORY_ACCESS;
    172 
    173 /* Values for CacheCoherency field above */
    174 
    175 #define ACPI_IORT_NODE_COHERENT         0x00000001  /* The device node is fully coherent */
    176 #define ACPI_IORT_NODE_NOT_COHERENT     0x00000000  /* The device node is not coherent */
    177 
    178 /* Masks for Hints field above */
    179 
    180 #define ACPI_IORT_HT_TRANSIENT          (1)
    181 #define ACPI_IORT_HT_WRITE              (1<<1)
    182 #define ACPI_IORT_HT_READ               (1<<2)
    183 #define ACPI_IORT_HT_OVERRIDE           (1<<3)
    184 
    185 /* Masks for MemoryFlags field above */
    186 
    187 #define ACPI_IORT_MF_COHERENCY          (1)
    188 #define ACPI_IORT_MF_ATTRIBUTES         (1<<1)
    189 
    190 
    191 /*
    192  * IORT node specific subtables
    193  */
    194 typedef struct acpi_iort_its_group
    195 {
    196     UINT32                  ItsCount;
    197     UINT32                  Identifiers[1];         /* GIC ITS identifier arrary */
    198 
    199 } ACPI_IORT_ITS_GROUP;
    200 
    201 
    202 typedef struct acpi_iort_named_component
    203 {
    204     UINT32                  NodeFlags;
    205     UINT64                  MemoryProperties;       /* Memory access properties */
    206     UINT8                   MemoryAddressLimit;     /* Memory address size limit */
    207     char                    DeviceName[1];          /* Path of namespace object */
    208 
    209 } ACPI_IORT_NAMED_COMPONENT;
    210 
    211 
    212 typedef struct acpi_iort_root_complex
    213 {
    214     UINT64                  MemoryProperties;       /* Memory access properties */
    215     UINT32                  AtsAttribute;
    216     UINT32                  PciSegmentNumber;
    217 
    218 } ACPI_IORT_ROOT_COMPLEX;
    219 
    220 /* Values for AtsAttribute field above */
    221 
    222 #define ACPI_IORT_ATS_SUPPORTED         0x00000001  /* The root complex supports ATS */
    223 #define ACPI_IORT_ATS_UNSUPPORTED       0x00000000  /* The root complex doesn't support ATS */
    224 
    225 
    226 typedef struct acpi_iort_smmu
    227 {
    228     UINT64                  BaseAddress;            /* SMMU base address */
    229     UINT64                  Span;                   /* Length of memory range */
    230     UINT32                  Model;
    231     UINT32                  Flags;
    232     UINT32                  GlobalInterruptOffset;
    233     UINT32                  ContextInterruptCount;
    234     UINT32                  ContextInterruptOffset;
    235     UINT32                  PmuInterruptCount;
    236     UINT32                  PmuInterruptOffset;
    237     UINT64                  Interrupts[1];          /* Interrupt array */
    238 
    239 } ACPI_IORT_SMMU;
    240 
    241 /* Values for Model field above */
    242 
    243 #define ACPI_IORT_SMMU_V1               0x00000000  /* Generic SMMUv1 */
    244 #define ACPI_IORT_SMMU_V2               0x00000001  /* Generic SMMUv2 */
    245 #define ACPI_IORT_SMMU_CORELINK_MMU400  0x00000002  /* ARM Corelink MMU-400 */
    246 #define ACPI_IORT_SMMU_CORELINK_MMU500  0x00000003  /* ARM Corelink MMU-500 */
    247 #define ACPI_IORT_SMMU_CORELINK_MMU401  0x00000004  /* ARM Corelink MMU-401 */
    248 #define ACPI_IORT_SMMU_CAVIUM_THUNDERX  0x00000005  /* Cavium ThunderX SMMUv2 */
    249 
    250 /* Masks for Flags field above */
    251 
    252 #define ACPI_IORT_SMMU_DVM_SUPPORTED    (1)
    253 #define ACPI_IORT_SMMU_COHERENT_WALK    (1<<1)
    254 
    255 /* Global interrupt format */
    256 
    257 typedef struct acpi_iort_smmu_gsi
    258 {
    259     UINT32                  NSgIrpt;
    260     UINT32                  NSgIrptFlags;
    261     UINT32                  NSgCfgIrpt;
    262     UINT32                  NSgCfgIrptFlags;
    263 
    264 } ACPI_IORT_SMMU_GSI;
    265 
    266 
    267 typedef struct acpi_iort_smmu_v3
    268 {
    269     UINT64                  BaseAddress;            /* SMMUv3 base address */
    270     UINT32                  Flags;
    271     UINT32                  Reserved;
    272     UINT64                  VatosAddress;
    273     UINT32                  Model;
    274     UINT32                  EventGsiv;
    275     UINT32                  PriGsiv;
    276     UINT32                  GerrGsiv;
    277     UINT32                  SyncGsiv;
    278     UINT8                   Pxm;
    279     UINT8                   Reserved1;
    280     UINT16                  Reserved2;
    281     UINT32                  IdMappingIndex;
    282 
    283 } ACPI_IORT_SMMU_V3;
    284 
    285 /* Values for Model field above */
    286 
    287 #define ACPI_IORT_SMMU_V3_GENERIC           0x00000000  /* Generic SMMUv3 */
    288 #define ACPI_IORT_SMMU_V3_HISILICON_HI161X  0x00000001  /* HiSilicon Hi161x SMMUv3 */
    289 #define ACPI_IORT_SMMU_V3_CAVIUM_CN99XX     0x00000002  /* Cavium CN99xx SMMUv3 */
    290 
    291 /* Masks for Flags field above */
    292 
    293 #define ACPI_IORT_SMMU_V3_COHACC_OVERRIDE   (1)
    294 #define ACPI_IORT_SMMU_V3_HTTU_OVERRIDE     (1<<1)
    295 #define ACPI_IORT_SMMU_V3_PXM_VALID         (1<<3)
    296 
    297 
    298 /*******************************************************************************
    299  *
    300  * IVRS - I/O Virtualization Reporting Structure
    301  *        Version 1
    302  *
    303  * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
    304  * Revision 1.26, February 2009.
    305  *
    306  ******************************************************************************/
    307 
    308 typedef struct acpi_table_ivrs
    309 {
    310     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
    311     UINT32                  Info;               /* Common virtualization info */
    312     UINT64                  Reserved;
    313 
    314 } ACPI_TABLE_IVRS;
    315 
    316 /* Values for Info field above */
    317 
    318 #define ACPI_IVRS_PHYSICAL_SIZE     0x00007F00  /* 7 bits, physical address size */
    319 #define ACPI_IVRS_VIRTUAL_SIZE      0x003F8000  /* 7 bits, virtual address size */
    320 #define ACPI_IVRS_ATS_RESERVED      0x00400000  /* ATS address translation range reserved */
    321 
    322 
    323 /* IVRS subtable header */
    324 
    325 typedef struct acpi_ivrs_header
    326 {
    327     UINT8                   Type;               /* Subtable type */
    328     UINT8                   Flags;
    329     UINT16                  Length;             /* Subtable length */
    330     UINT16                  DeviceId;           /* ID of IOMMU */
    331 
    332 } ACPI_IVRS_HEADER;
    333 
    334 /* Values for subtable Type above */
    335 
    336 enum AcpiIvrsType
    337 {
    338     ACPI_IVRS_TYPE_HARDWARE         = 0x10,
    339     ACPI_IVRS_TYPE_MEMORY1          = 0x20,
    340     ACPI_IVRS_TYPE_MEMORY2          = 0x21,
    341     ACPI_IVRS_TYPE_MEMORY3          = 0x22
    342 };
    343 
    344 /* Masks for Flags field above for IVHD subtable */
    345 
    346 #define ACPI_IVHD_TT_ENABLE         (1)
    347 #define ACPI_IVHD_PASS_PW           (1<<1)
    348 #define ACPI_IVHD_RES_PASS_PW       (1<<2)
    349 #define ACPI_IVHD_ISOC              (1<<3)
    350 #define ACPI_IVHD_IOTLB             (1<<4)
    351 
    352 /* Masks for Flags field above for IVMD subtable */
    353 
    354 #define ACPI_IVMD_UNITY             (1)
    355 #define ACPI_IVMD_READ              (1<<1)
    356 #define ACPI_IVMD_WRITE             (1<<2)
    357 #define ACPI_IVMD_EXCLUSION_RANGE   (1<<3)
    358 
    359 
    360 /*
    361  * IVRS subtables, correspond to Type in ACPI_IVRS_HEADER
    362  */
    363 
    364 /* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
    365 
    366 typedef struct acpi_ivrs_hardware
    367 {
    368     ACPI_IVRS_HEADER        Header;
    369     UINT16                  CapabilityOffset;   /* Offset for IOMMU control fields */
    370     UINT64                  BaseAddress;        /* IOMMU control registers */
    371     UINT16                  PciSegmentGroup;
    372     UINT16                  Info;               /* MSI number and unit ID */
    373     UINT32                  Reserved;
    374 
    375 } ACPI_IVRS_HARDWARE;
    376 
    377 /* Masks for Info field above */
    378 
    379 #define ACPI_IVHD_MSI_NUMBER_MASK   0x001F      /* 5 bits, MSI message number */
    380 #define ACPI_IVHD_UNIT_ID_MASK      0x1F00      /* 5 bits, UnitID */
    381 
    382 
    383 /*
    384  * Device Entries for IVHD subtable, appear after ACPI_IVRS_HARDWARE structure.
    385  * Upper two bits of the Type field are the (encoded) length of the structure.
    386  * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
    387  * are reserved for future use but not defined.
    388  */
    389 typedef struct acpi_ivrs_de_header
    390 {
    391     UINT8                   Type;
    392     UINT16                  Id;
    393     UINT8                   DataSetting;
    394 
    395 } ACPI_IVRS_DE_HEADER;
    396 
    397 /* Length of device entry is in the top two bits of Type field above */
    398 
    399 #define ACPI_IVHD_ENTRY_LENGTH      0xC0
    400 
    401 /* Values for device entry Type field above */
    402 
    403 enum AcpiIvrsDeviceEntryType
    404 {
    405     /* 4-byte device entries, all use ACPI_IVRS_DEVICE4 */
    406 
    407     ACPI_IVRS_TYPE_PAD4             = 0,
    408     ACPI_IVRS_TYPE_ALL              = 1,
    409     ACPI_IVRS_TYPE_SELECT           = 2,
    410     ACPI_IVRS_TYPE_START            = 3,
    411     ACPI_IVRS_TYPE_END              = 4,
    412 
    413     /* 8-byte device entries */
    414 
    415     ACPI_IVRS_TYPE_PAD8             = 64,
    416     ACPI_IVRS_TYPE_NOT_USED         = 65,
    417     ACPI_IVRS_TYPE_ALIAS_SELECT     = 66, /* Uses ACPI_IVRS_DEVICE8A */
    418     ACPI_IVRS_TYPE_ALIAS_START      = 67, /* Uses ACPI_IVRS_DEVICE8A */
    419     ACPI_IVRS_TYPE_EXT_SELECT       = 70, /* Uses ACPI_IVRS_DEVICE8B */
    420     ACPI_IVRS_TYPE_EXT_START        = 71, /* Uses ACPI_IVRS_DEVICE8B */
    421     ACPI_IVRS_TYPE_SPECIAL          = 72  /* Uses ACPI_IVRS_DEVICE8C */
    422 };
    423 
    424 /* Values for Data field above */
    425 
    426 #define ACPI_IVHD_INIT_PASS         (1)
    427 #define ACPI_IVHD_EINT_PASS         (1<<1)
    428 #define ACPI_IVHD_NMI_PASS          (1<<2)
    429 #define ACPI_IVHD_SYSTEM_MGMT       (3<<4)
    430 #define ACPI_IVHD_LINT0_PASS        (1<<6)
    431 #define ACPI_IVHD_LINT1_PASS        (1<<7)
    432 
    433 
    434 /* Types 0-4: 4-byte device entry */
    435 
    436 typedef struct acpi_ivrs_device4
    437 {
    438     ACPI_IVRS_DE_HEADER     Header;
    439 
    440 } ACPI_IVRS_DEVICE4;
    441 
    442 /* Types 66-67: 8-byte device entry */
    443 
    444 typedef struct acpi_ivrs_device8a
    445 {
    446     ACPI_IVRS_DE_HEADER     Header;
    447     UINT8                   Reserved1;
    448     UINT16                  UsedId;
    449     UINT8                   Reserved2;
    450 
    451 } ACPI_IVRS_DEVICE8A;
    452 
    453 /* Types 70-71: 8-byte device entry */
    454 
    455 typedef struct acpi_ivrs_device8b
    456 {
    457     ACPI_IVRS_DE_HEADER     Header;
    458     UINT32                  ExtendedData;
    459 
    460 } ACPI_IVRS_DEVICE8B;
    461 
    462 /* Values for ExtendedData above */
    463 
    464 #define ACPI_IVHD_ATS_DISABLED      (1<<31)
    465 
    466 /* Type 72: 8-byte device entry */
    467 
    468 typedef struct acpi_ivrs_device8c
    469 {
    470     ACPI_IVRS_DE_HEADER     Header;
    471     UINT8                   Handle;
    472     UINT16                  UsedId;
    473     UINT8                   Variety;
    474 
    475 } ACPI_IVRS_DEVICE8C;
    476 
    477 /* Values for Variety field above */
    478 
    479 #define ACPI_IVHD_IOAPIC            1
    480 #define ACPI_IVHD_HPET              2
    481 
    482 
    483 /* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
    484 
    485 typedef struct acpi_ivrs_memory
    486 {
    487     ACPI_IVRS_HEADER        Header;
    488     UINT16                  AuxData;
    489     UINT64                  Reserved;
    490     UINT64                  StartAddress;
    491     UINT64                  MemoryLength;
    492 
    493 } ACPI_IVRS_MEMORY;
    494 
    495 
    496 /*******************************************************************************
    497  *
    498  * LPIT - Low Power Idle Table
    499  *
    500  * Conforms to "ACPI Low Power Idle Table (LPIT)" July 2014.
    501  *
    502  ******************************************************************************/
    503 
    504 typedef struct acpi_table_lpit
    505 {
    506     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
    507 
    508 } ACPI_TABLE_LPIT;
    509 
    510 
    511 /* LPIT subtable header */
    512 
    513 typedef struct acpi_lpit_header
    514 {
    515     UINT32                  Type;               /* Subtable type */
    516     UINT32                  Length;             /* Subtable length */
    517     UINT16                  UniqueId;
    518     UINT16                  Reserved;
    519     UINT32                  Flags;
    520 
    521 } ACPI_LPIT_HEADER;
    522 
    523 /* Values for subtable Type above */
    524 
    525 enum AcpiLpitType
    526 {
    527     ACPI_LPIT_TYPE_NATIVE_CSTATE    = 0x00,
    528     ACPI_LPIT_TYPE_RESERVED         = 0x01      /* 1 and above are reserved */
    529 };
    530 
    531 /* Masks for Flags field above  */
    532 
    533 #define ACPI_LPIT_STATE_DISABLED    (1)
    534 #define ACPI_LPIT_NO_COUNTER        (1<<1)
    535 
    536 /*
    537  * LPIT subtables, correspond to Type in ACPI_LPIT_HEADER
    538  */
    539 
    540 /* 0x00: Native C-state instruction based LPI structure */
    541 
    542 typedef struct acpi_lpit_native
    543 {
    544     ACPI_LPIT_HEADER        Header;
    545     ACPI_GENERIC_ADDRESS    EntryTrigger;
    546     UINT32                  Residency;
    547     UINT32                  Latency;
    548     ACPI_GENERIC_ADDRESS    ResidencyCounter;
    549     UINT64                  CounterFrequency;
    550 
    551 } ACPI_LPIT_NATIVE;
    552 
    553 
    554 /*******************************************************************************
    555  *
    556  * MADT - Multiple APIC Description Table
    557  *        Version 3
    558  *
    559  ******************************************************************************/
    560 
    561 typedef struct acpi_table_madt
    562 {
    563     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
    564     UINT32                  Address;            /* Physical address of local APIC */
    565     UINT32                  Flags;
    566 
    567 } ACPI_TABLE_MADT;
    568 
    569 /* Masks for Flags field above */
    570 
    571 #define ACPI_MADT_PCAT_COMPAT       (1)         /* 00: System also has dual 8259s */
    572 
    573 /* Values for PCATCompat flag */
    574 
    575 #define ACPI_MADT_DUAL_PIC          1
    576 #define ACPI_MADT_MULTIPLE_APIC     0
    577 
    578 
    579 /* Values for MADT subtable type in ACPI_SUBTABLE_HEADER */
    580 
    581 enum AcpiMadtType
    582 {
    583     ACPI_MADT_TYPE_LOCAL_APIC               = 0,
    584     ACPI_MADT_TYPE_IO_APIC                  = 1,
    585     ACPI_MADT_TYPE_INTERRUPT_OVERRIDE       = 2,
    586     ACPI_MADT_TYPE_NMI_SOURCE               = 3,
    587     ACPI_MADT_TYPE_LOCAL_APIC_NMI           = 4,
    588     ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE      = 5,
    589     ACPI_MADT_TYPE_IO_SAPIC                 = 6,
    590     ACPI_MADT_TYPE_LOCAL_SAPIC              = 7,
    591     ACPI_MADT_TYPE_INTERRUPT_SOURCE         = 8,
    592     ACPI_MADT_TYPE_LOCAL_X2APIC             = 9,
    593     ACPI_MADT_TYPE_LOCAL_X2APIC_NMI         = 10,
    594     ACPI_MADT_TYPE_GENERIC_INTERRUPT        = 11,
    595     ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR      = 12,
    596     ACPI_MADT_TYPE_GENERIC_MSI_FRAME        = 13,
    597     ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR    = 14,
    598     ACPI_MADT_TYPE_GENERIC_TRANSLATOR       = 15,
    599     ACPI_MADT_TYPE_RESERVED                 = 16    /* 16 and greater are reserved */
    600 };
    601 
    602 
    603 /*
    604  * MADT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
    605  */
    606 
    607 /* 0: Processor Local APIC */
    608 
    609 typedef struct acpi_madt_local_apic
    610 {
    611     ACPI_SUBTABLE_HEADER    Header;
    612     UINT8                   ProcessorId;        /* ACPI processor id */
    613     UINT8                   Id;                 /* Processor's local APIC id */
    614     UINT32                  LapicFlags;
    615 
    616 } ACPI_MADT_LOCAL_APIC;
    617 
    618 
    619 /* 1: IO APIC */
    620 
    621 typedef struct acpi_madt_io_apic
    622 {
    623     ACPI_SUBTABLE_HEADER    Header;
    624     UINT8                   Id;                 /* I/O APIC ID */
    625     UINT8                   Reserved;           /* Reserved - must be zero */
    626     UINT32                  Address;            /* APIC physical address */
    627     UINT32                  GlobalIrqBase;      /* Global system interrupt where INTI lines start */
    628 
    629 } ACPI_MADT_IO_APIC;
    630 
    631 
    632 /* 2: Interrupt Override */
    633 
    634 typedef struct acpi_madt_interrupt_override
    635 {
    636     ACPI_SUBTABLE_HEADER    Header;
    637     UINT8                   Bus;                /* 0 - ISA */
    638     UINT8                   SourceIrq;          /* Interrupt source (IRQ) */
    639     UINT32                  GlobalIrq;          /* Global system interrupt */
    640     UINT16                  IntiFlags;
    641 
    642 } ACPI_MADT_INTERRUPT_OVERRIDE;
    643 
    644 
    645 /* 3: NMI Source */
    646 
    647 typedef struct acpi_madt_nmi_source
    648 {
    649     ACPI_SUBTABLE_HEADER    Header;
    650     UINT16                  IntiFlags;
    651     UINT32                  GlobalIrq;          /* Global system interrupt */
    652 
    653 } ACPI_MADT_NMI_SOURCE;
    654 
    655 
    656 /* 4: Local APIC NMI */
    657 
    658 typedef struct acpi_madt_local_apic_nmi
    659 {
    660     ACPI_SUBTABLE_HEADER    Header;
    661     UINT8                   ProcessorId;        /* ACPI processor id */
    662     UINT16                  IntiFlags;
    663     UINT8                   Lint;               /* LINTn to which NMI is connected */
    664 
    665 } ACPI_MADT_LOCAL_APIC_NMI;
    666 
    667 
    668 /* 5: Address Override */
    669 
    670 typedef struct acpi_madt_local_apic_override
    671 {
    672     ACPI_SUBTABLE_HEADER    Header;
    673     UINT16                  Reserved;           /* Reserved, must be zero */
    674     UINT64                  Address;            /* APIC physical address */
    675 
    676 } ACPI_MADT_LOCAL_APIC_OVERRIDE;
    677 
    678 
    679 /* 6: I/O Sapic */
    680 
    681 typedef struct acpi_madt_io_sapic
    682 {
    683     ACPI_SUBTABLE_HEADER    Header;
    684     UINT8                   Id;                 /* I/O SAPIC ID */
    685     UINT8                   Reserved;           /* Reserved, must be zero */
    686     UINT32                  GlobalIrqBase;      /* Global interrupt for SAPIC start */
    687     UINT64                  Address;            /* SAPIC physical address */
    688 
    689 } ACPI_MADT_IO_SAPIC;
    690 
    691 
    692 /* 7: Local Sapic */
    693 
    694 typedef struct acpi_madt_local_sapic
    695 {
    696     ACPI_SUBTABLE_HEADER    Header;
    697     UINT8                   ProcessorId;        /* ACPI processor id */
    698     UINT8                   Id;                 /* SAPIC ID */
    699     UINT8                   Eid;                /* SAPIC EID */
    700     UINT8                   Reserved[3];        /* Reserved, must be zero */
    701     UINT32                  LapicFlags;
    702     UINT32                  Uid;                /* Numeric UID - ACPI 3.0 */
    703     char                    UidString[1];       /* String UID  - ACPI 3.0 */
    704 
    705 } ACPI_MADT_LOCAL_SAPIC;
    706 
    707 
    708 /* 8: Platform Interrupt Source */
    709 
    710 typedef struct acpi_madt_interrupt_source
    711 {
    712     ACPI_SUBTABLE_HEADER    Header;
    713     UINT16                  IntiFlags;
    714     UINT8                   Type;               /* 1=PMI, 2=INIT, 3=corrected */
    715     UINT8                   Id;                 /* Processor ID */
    716     UINT8                   Eid;                /* Processor EID */
    717     UINT8                   IoSapicVector;      /* Vector value for PMI interrupts */
    718     UINT32                  GlobalIrq;          /* Global system interrupt */
    719     UINT32                  Flags;              /* Interrupt Source Flags */
    720 
    721 } ACPI_MADT_INTERRUPT_SOURCE;
    722 
    723 /* Masks for Flags field above */
    724 
    725 #define ACPI_MADT_CPEI_OVERRIDE     (1)
    726 
    727 
    728 /* 9: Processor Local X2APIC (ACPI 4.0) */
    729 
    730 typedef struct acpi_madt_local_x2apic
    731 {
    732     ACPI_SUBTABLE_HEADER    Header;
    733     UINT16                  Reserved;           /* Reserved - must be zero */
    734     UINT32                  LocalApicId;        /* Processor x2APIC ID  */
    735     UINT32                  LapicFlags;
    736     UINT32                  Uid;                /* ACPI processor UID */
    737 
    738 } ACPI_MADT_LOCAL_X2APIC;
    739 
    740 
    741 /* 10: Local X2APIC NMI (ACPI 4.0) */
    742 
    743 typedef struct acpi_madt_local_x2apic_nmi
    744 {
    745     ACPI_SUBTABLE_HEADER    Header;
    746     UINT16                  IntiFlags;
    747     UINT32                  Uid;                /* ACPI processor UID */
    748     UINT8                   Lint;               /* LINTn to which NMI is connected */
    749     UINT8                   Reserved[3];        /* Reserved - must be zero */
    750 
    751 } ACPI_MADT_LOCAL_X2APIC_NMI;
    752 
    753 
    754 /* 11: Generic Interrupt (ACPI 5.0 + ACPI 6.0 changes) */
    755 
    756 typedef struct acpi_madt_generic_interrupt
    757 {
    758     ACPI_SUBTABLE_HEADER    Header;
    759     UINT16                  Reserved;           /* Reserved - must be zero */
    760     UINT32                  CpuInterfaceNumber;
    761     UINT32                  Uid;
    762     UINT32                  Flags;
    763     UINT32                  ParkingVersion;
    764     UINT32                  PerformanceInterrupt;
    765     UINT64                  ParkedAddress;
    766     UINT64                  BaseAddress;
    767     UINT64                  GicvBaseAddress;
    768     UINT64                  GichBaseAddress;
    769     UINT32                  VgicInterrupt;
    770     UINT64                  GicrBaseAddress;
    771     UINT64                  ArmMpidr;
    772     UINT8                   EfficiencyClass;
    773     UINT8                   Reserved2[3];
    774 
    775 } ACPI_MADT_GENERIC_INTERRUPT;
    776 
    777 /* Masks for Flags field above */
    778 
    779 /* ACPI_MADT_ENABLED                    (1)      Processor is usable if set */
    780 #define ACPI_MADT_PERFORMANCE_IRQ_MODE  (1<<1)  /* 01: Performance Interrupt Mode */
    781 #define ACPI_MADT_VGIC_IRQ_MODE         (1<<2)  /* 02: VGIC Maintenance Interrupt mode */
    782 
    783 
    784 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
    785 
    786 typedef struct acpi_madt_generic_distributor
    787 {
    788     ACPI_SUBTABLE_HEADER    Header;
    789     UINT16                  Reserved;           /* Reserved - must be zero */
    790     UINT32                  GicId;
    791     UINT64                  BaseAddress;
    792     UINT32                  GlobalIrqBase;
    793     UINT8                   Version;
    794     UINT8                   Reserved2[3];       /* Reserved - must be zero */
    795 
    796 } ACPI_MADT_GENERIC_DISTRIBUTOR;
    797 
    798 /* Values for Version field above */
    799 
    800 enum AcpiMadtGicVersion
    801 {
    802     ACPI_MADT_GIC_VERSION_NONE          = 0,
    803     ACPI_MADT_GIC_VERSION_V1            = 1,
    804     ACPI_MADT_GIC_VERSION_V2            = 2,
    805     ACPI_MADT_GIC_VERSION_V3            = 3,
    806     ACPI_MADT_GIC_VERSION_V4            = 4,
    807     ACPI_MADT_GIC_VERSION_RESERVED      = 5     /* 5 and greater are reserved */
    808 };
    809 
    810 
    811 /* 13: Generic MSI Frame (ACPI 5.1) */
    812 
    813 typedef struct acpi_madt_generic_msi_frame
    814 {
    815     ACPI_SUBTABLE_HEADER    Header;
    816     UINT16                  Reserved;           /* Reserved - must be zero */
    817     UINT32                  MsiFrameId;
    818     UINT64                  BaseAddress;
    819     UINT32                  Flags;
    820     UINT16                  SpiCount;
    821     UINT16                  SpiBase;
    822 
    823 } ACPI_MADT_GENERIC_MSI_FRAME;
    824 
    825 /* Masks for Flags field above */
    826 
    827 #define ACPI_MADT_OVERRIDE_SPI_VALUES   (1)
    828 
    829 
    830 /* 14: Generic Redistributor (ACPI 5.1) */
    831 
    832 typedef struct acpi_madt_generic_redistributor
    833 {
    834     ACPI_SUBTABLE_HEADER    Header;
    835     UINT16                  Reserved;           /* reserved - must be zero */
    836     UINT64                  BaseAddress;
    837     UINT32                  Length;
    838 
    839 } ACPI_MADT_GENERIC_REDISTRIBUTOR;
    840 
    841 
    842 /* 15: Generic Translator (ACPI 6.0) */
    843 
    844 typedef struct acpi_madt_generic_translator
    845 {
    846     ACPI_SUBTABLE_HEADER    Header;
    847     UINT16                  Reserved;           /* reserved - must be zero */
    848     UINT32                  TranslationId;
    849     UINT64                  BaseAddress;
    850     UINT32                  Reserved2;
    851 
    852 } ACPI_MADT_GENERIC_TRANSLATOR;
    853 
    854 
    855 /*
    856  * Common flags fields for MADT subtables
    857  */
    858 
    859 /* MADT Local APIC flags */
    860 
    861 #define ACPI_MADT_ENABLED           (1)         /* 00: Processor is usable if set */
    862 
    863 /* MADT MPS INTI flags (IntiFlags) */
    864 
    865 #define ACPI_MADT_POLARITY_MASK     (3)         /* 00-01: Polarity of APIC I/O input signals */
    866 #define ACPI_MADT_TRIGGER_MASK      (3<<2)      /* 02-03: Trigger mode of APIC input signals */
    867 
    868 /* Values for MPS INTI flags */
    869 
    870 #define ACPI_MADT_POLARITY_CONFORMS       0
    871 #define ACPI_MADT_POLARITY_ACTIVE_HIGH    1
    872 #define ACPI_MADT_POLARITY_RESERVED       2
    873 #define ACPI_MADT_POLARITY_ACTIVE_LOW     3
    874 
    875 #define ACPI_MADT_TRIGGER_CONFORMS        (0)
    876 #define ACPI_MADT_TRIGGER_EDGE            (1<<2)
    877 #define ACPI_MADT_TRIGGER_RESERVED        (2<<2)
    878 #define ACPI_MADT_TRIGGER_LEVEL           (3<<2)
    879 
    880 
    881 /*******************************************************************************
    882  *
    883  * MCFG - PCI Memory Mapped Configuration table and subtable
    884  *        Version 1
    885  *
    886  * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
    887  *
    888  ******************************************************************************/
    889 
    890 typedef struct acpi_table_mcfg
    891 {
    892     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
    893     UINT8                   Reserved[8];
    894 
    895 } ACPI_TABLE_MCFG;
    896 
    897 
    898 /* Subtable */
    899 
    900 typedef struct acpi_mcfg_allocation
    901 {
    902     UINT64                  Address;            /* Base address, processor-relative */
    903     UINT16                  PciSegment;         /* PCI segment group number */
    904     UINT8                   StartBusNumber;     /* Starting PCI Bus number */
    905     UINT8                   EndBusNumber;       /* Final PCI Bus number */
    906     UINT32                  Reserved;
    907 
    908 } ACPI_MCFG_ALLOCATION;
    909 
    910 
    911 /*******************************************************************************
    912  *
    913  * MCHI - Management Controller Host Interface Table
    914  *        Version 1
    915  *
    916  * Conforms to "Management Component Transport Protocol (MCTP) Host
    917  * Interface Specification", Revision 1.0.0a, October 13, 2009
    918  *
    919  ******************************************************************************/
    920 
    921 typedef struct acpi_table_mchi
    922 {
    923     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
    924     UINT8                   InterfaceType;
    925     UINT8                   Protocol;
    926     UINT64                  ProtocolData;
    927     UINT8                   InterruptType;
    928     UINT8                   Gpe;
    929     UINT8                   PciDeviceFlag;
    930     UINT32                  GlobalInterrupt;
    931     ACPI_GENERIC_ADDRESS    ControlRegister;
    932     UINT8                   PciSegment;
    933     UINT8                   PciBus;
    934     UINT8                   PciDevice;
    935     UINT8                   PciFunction;
    936 
    937 } ACPI_TABLE_MCHI;
    938 
    939 
    940 /*******************************************************************************
    941  *
    942  * MPST - Memory Power State Table (ACPI 5.0)
    943  *        Version 1
    944  *
    945  ******************************************************************************/
    946 
    947 #define ACPI_MPST_CHANNEL_INFO \
    948     UINT8                   ChannelId; \
    949     UINT8                   Reserved1[3]; \
    950     UINT16                  PowerNodeCount; \
    951     UINT16                  Reserved2;
    952 
    953 /* Main table */
    954 
    955 typedef struct acpi_table_mpst
    956 {
    957     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
    958     ACPI_MPST_CHANNEL_INFO                      /* Platform Communication Channel */
    959 
    960 } ACPI_TABLE_MPST;
    961 
    962 
    963 /* Memory Platform Communication Channel Info */
    964 
    965 typedef struct acpi_mpst_channel
    966 {
    967     ACPI_MPST_CHANNEL_INFO                      /* Platform Communication Channel */
    968 
    969 } ACPI_MPST_CHANNEL;
    970 
    971 
    972 /* Memory Power Node Structure */
    973 
    974 typedef struct acpi_mpst_power_node
    975 {
    976     UINT8                   Flags;
    977     UINT8                   Reserved1;
    978     UINT16                  NodeId;
    979     UINT32                  Length;
    980     UINT64                  RangeAddress;
    981     UINT64                  RangeLength;
    982     UINT32                  NumPowerStates;
    983     UINT32                  NumPhysicalComponents;
    984 
    985 } ACPI_MPST_POWER_NODE;
    986 
    987 /* Values for Flags field above */
    988 
    989 #define ACPI_MPST_ENABLED               1
    990 #define ACPI_MPST_POWER_MANAGED         2
    991 #define ACPI_MPST_HOT_PLUG_CAPABLE      4
    992 
    993 
    994 /* Memory Power State Structure (follows POWER_NODE above) */
    995 
    996 typedef struct acpi_mpst_power_state
    997 {
    998     UINT8                   PowerState;
    999     UINT8                   InfoIndex;
   1000 
   1001 } ACPI_MPST_POWER_STATE;
   1002 
   1003 
   1004 /* Physical Component ID Structure (follows POWER_STATE above) */
   1005 
   1006 typedef struct acpi_mpst_component
   1007 {
   1008     UINT16                  ComponentId;
   1009 
   1010 } ACPI_MPST_COMPONENT;
   1011 
   1012 
   1013 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
   1014 
   1015 typedef struct acpi_mpst_data_hdr
   1016 {
   1017     UINT16                  CharacteristicsCount;
   1018     UINT16                  Reserved;
   1019 
   1020 } ACPI_MPST_DATA_HDR;
   1021 
   1022 typedef struct acpi_mpst_power_data
   1023 {
   1024     UINT8                   StructureId;
   1025     UINT8                   Flags;
   1026     UINT16                  Reserved1;
   1027     UINT32                  AveragePower;
   1028     UINT32                  PowerSaving;
   1029     UINT64                  ExitLatency;
   1030     UINT64                  Reserved2;
   1031 
   1032 } ACPI_MPST_POWER_DATA;
   1033 
   1034 /* Values for Flags field above */
   1035 
   1036 #define ACPI_MPST_PRESERVE              1
   1037 #define ACPI_MPST_AUTOENTRY             2
   1038 #define ACPI_MPST_AUTOEXIT              4
   1039 
   1040 
   1041 /* Shared Memory Region (not part of an ACPI table) */
   1042 
   1043 typedef struct acpi_mpst_shared
   1044 {
   1045     UINT32                  Signature;
   1046     UINT16                  PccCommand;
   1047     UINT16                  PccStatus;
   1048     UINT32                  CommandRegister;
   1049     UINT32                  StatusRegister;
   1050     UINT32                  PowerStateId;
   1051     UINT32                  PowerNodeId;
   1052     UINT64                  EnergyConsumed;
   1053     UINT64                  AveragePower;
   1054 
   1055 } ACPI_MPST_SHARED;
   1056 
   1057 
   1058 /*******************************************************************************
   1059  *
   1060  * MSCT - Maximum System Characteristics Table (ACPI 4.0)
   1061  *        Version 1
   1062  *
   1063  ******************************************************************************/
   1064 
   1065 typedef struct acpi_table_msct
   1066 {
   1067     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1068     UINT32                  ProximityOffset;    /* Location of proximity info struct(s) */
   1069     UINT32                  MaxProximityDomains;/* Max number of proximity domains */
   1070     UINT32                  MaxClockDomains;    /* Max number of clock domains */
   1071     UINT64                  MaxAddress;         /* Max physical address in system */
   1072 
   1073 } ACPI_TABLE_MSCT;
   1074 
   1075 
   1076 /* Subtable - Maximum Proximity Domain Information. Version 1 */
   1077 
   1078 typedef struct acpi_msct_proximity
   1079 {
   1080     UINT8                   Revision;
   1081     UINT8                   Length;
   1082     UINT32                  RangeStart;         /* Start of domain range */
   1083     UINT32                  RangeEnd;           /* End of domain range */
   1084     UINT32                  ProcessorCapacity;
   1085     UINT64                  MemoryCapacity;     /* In bytes */
   1086 
   1087 } ACPI_MSCT_PROXIMITY;
   1088 
   1089 
   1090 /*******************************************************************************
   1091  *
   1092  * MSDM - Microsoft Data Management table
   1093  *
   1094  * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
   1095  * November 29, 2011. Copyright 2011 Microsoft
   1096  *
   1097  ******************************************************************************/
   1098 
   1099 /* Basic MSDM table is only the common ACPI header */
   1100 
   1101 typedef struct acpi_table_msdm
   1102 {
   1103     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1104 
   1105 } ACPI_TABLE_MSDM;
   1106 
   1107 
   1108 /*******************************************************************************
   1109  *
   1110  * MTMR - MID Timer Table
   1111  *        Version 1
   1112  *
   1113  * Conforms to "Simple Firmware Interface Specification",
   1114  * Draft 0.8.2, Oct 19, 2010
   1115  * NOTE: The ACPI MTMR is equivalent to the SFI MTMR table.
   1116  *
   1117  ******************************************************************************/
   1118 
   1119 typedef struct acpi_table_mtmr
   1120 {
   1121     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1122 
   1123 } ACPI_TABLE_MTMR;
   1124 
   1125 /* MTMR entry */
   1126 
   1127 typedef struct acpi_mtmr_entry
   1128 {
   1129     ACPI_GENERIC_ADDRESS    PhysicalAddress;
   1130     UINT32                  Frequency;
   1131     UINT32                  Irq;
   1132 
   1133 } ACPI_MTMR_ENTRY;
   1134 
   1135 
   1136 /*******************************************************************************
   1137  *
   1138  * NFIT - NVDIMM Interface Table (ACPI 6.0+)
   1139  *        Version 1
   1140  *
   1141  ******************************************************************************/
   1142 
   1143 typedef struct acpi_table_nfit
   1144 {
   1145     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1146     UINT32                  Reserved;           /* Reserved, must be zero */
   1147 
   1148 } ACPI_TABLE_NFIT;
   1149 
   1150 /* Subtable header for NFIT */
   1151 
   1152 typedef struct acpi_nfit_header
   1153 {
   1154     UINT16                   Type;
   1155     UINT16                   Length;
   1156 
   1157 } ACPI_NFIT_HEADER;
   1158 
   1159 
   1160 /* Values for subtable type in ACPI_NFIT_HEADER */
   1161 
   1162 enum AcpiNfitType
   1163 {
   1164     ACPI_NFIT_TYPE_SYSTEM_ADDRESS       = 0,
   1165     ACPI_NFIT_TYPE_MEMORY_MAP           = 1,
   1166     ACPI_NFIT_TYPE_INTERLEAVE           = 2,
   1167     ACPI_NFIT_TYPE_SMBIOS               = 3,
   1168     ACPI_NFIT_TYPE_CONTROL_REGION       = 4,
   1169     ACPI_NFIT_TYPE_DATA_REGION          = 5,
   1170     ACPI_NFIT_TYPE_FLUSH_ADDRESS        = 6,
   1171     ACPI_NFIT_TYPE_CAPABILITIES         = 7,
   1172     ACPI_NFIT_TYPE_RESERVED             = 8     /* 8 and greater are reserved */
   1173 };
   1174 
   1175 /*
   1176  * NFIT Subtables
   1177  */
   1178 
   1179 /* 0: System Physical Address Range Structure */
   1180 
   1181 typedef struct acpi_nfit_system_address
   1182 {
   1183     ACPI_NFIT_HEADER        Header;
   1184     UINT16                  RangeIndex;
   1185     UINT16                  Flags;
   1186     UINT32                  Reserved;           /* Reserved, must be zero */
   1187     UINT32                  ProximityDomain;
   1188     UINT8                   RangeGuid[16];
   1189     UINT64                  Address;
   1190     UINT64                  Length;
   1191     UINT64                  MemoryMapping;
   1192 
   1193 } ACPI_NFIT_SYSTEM_ADDRESS;
   1194 
   1195 /* Flags */
   1196 
   1197 #define ACPI_NFIT_ADD_ONLINE_ONLY       (1)     /* 00: Add/Online Operation Only */
   1198 #define ACPI_NFIT_PROXIMITY_VALID       (1<<1)  /* 01: Proximity Domain Valid */
   1199 
   1200 /* Range Type GUIDs appear in the include/acuuid.h file */
   1201 
   1202 
   1203 /* 1: Memory Device to System Address Range Map Structure */
   1204 
   1205 typedef struct acpi_nfit_memory_map
   1206 {
   1207     ACPI_NFIT_HEADER        Header;
   1208     UINT32                  DeviceHandle;
   1209     UINT16                  PhysicalId;
   1210     UINT16                  RegionId;
   1211     UINT16                  RangeIndex;
   1212     UINT16                  RegionIndex;
   1213     UINT64                  RegionSize;
   1214     UINT64                  RegionOffset;
   1215     UINT64                  Address;
   1216     UINT16                  InterleaveIndex;
   1217     UINT16                  InterleaveWays;
   1218     UINT16                  Flags;
   1219     UINT16                  Reserved;           /* Reserved, must be zero */
   1220 
   1221 } ACPI_NFIT_MEMORY_MAP;
   1222 
   1223 /* Flags */
   1224 
   1225 #define ACPI_NFIT_MEM_SAVE_FAILED       (1)     /* 00: Last SAVE to Memory Device failed */
   1226 #define ACPI_NFIT_MEM_RESTORE_FAILED    (1<<1)  /* 01: Last RESTORE from Memory Device failed */
   1227 #define ACPI_NFIT_MEM_FLUSH_FAILED      (1<<2)  /* 02: Platform flush failed */
   1228 #define ACPI_NFIT_MEM_NOT_ARMED         (1<<3)  /* 03: Memory Device is not armed */
   1229 #define ACPI_NFIT_MEM_HEALTH_OBSERVED   (1<<4)  /* 04: Memory Device observed SMART/health events */
   1230 #define ACPI_NFIT_MEM_HEALTH_ENABLED    (1<<5)  /* 05: SMART/health events enabled */
   1231 #define ACPI_NFIT_MEM_MAP_FAILED        (1<<6)  /* 06: Mapping to SPA failed */
   1232 
   1233 
   1234 /* 2: Interleave Structure */
   1235 
   1236 typedef struct acpi_nfit_interleave
   1237 {
   1238     ACPI_NFIT_HEADER        Header;
   1239     UINT16                  InterleaveIndex;
   1240     UINT16                  Reserved;           /* Reserved, must be zero */
   1241     UINT32                  LineCount;
   1242     UINT32                  LineSize;
   1243     UINT32                  LineOffset[1];      /* Variable length */
   1244 
   1245 } ACPI_NFIT_INTERLEAVE;
   1246 
   1247 
   1248 /* 3: SMBIOS Management Information Structure */
   1249 
   1250 typedef struct acpi_nfit_smbios
   1251 {
   1252     ACPI_NFIT_HEADER        Header;
   1253     UINT32                  Reserved;           /* Reserved, must be zero */
   1254     UINT8                   Data[1];            /* Variable length */
   1255 
   1256 } ACPI_NFIT_SMBIOS;
   1257 
   1258 
   1259 /* 4: NVDIMM Control Region Structure */
   1260 
   1261 typedef struct acpi_nfit_control_region
   1262 {
   1263     ACPI_NFIT_HEADER        Header;
   1264     UINT16                  RegionIndex;
   1265     UINT16                  VendorId;
   1266     UINT16                  DeviceId;
   1267     UINT16                  RevisionId;
   1268     UINT16                  SubsystemVendorId;
   1269     UINT16                  SubsystemDeviceId;
   1270     UINT16                  SubsystemRevisionId;
   1271     UINT8                   ValidFields;
   1272     UINT8                   ManufacturingLocation;
   1273     UINT16                  ManufacturingDate;
   1274     UINT8                   Reserved[2];        /* Reserved, must be zero */
   1275     UINT32                  SerialNumber;
   1276     UINT16                  Code;
   1277     UINT16                  Windows;
   1278     UINT64                  WindowSize;
   1279     UINT64                  CommandOffset;
   1280     UINT64                  CommandSize;
   1281     UINT64                  StatusOffset;
   1282     UINT64                  StatusSize;
   1283     UINT16                  Flags;
   1284     UINT8                   Reserved1[6];       /* Reserved, must be zero */
   1285 
   1286 } ACPI_NFIT_CONTROL_REGION;
   1287 
   1288 /* Flags */
   1289 
   1290 #define ACPI_NFIT_CONTROL_BUFFERED          (1)     /* Block Data Windows implementation is buffered */
   1291 
   1292 /* ValidFields bits */
   1293 
   1294 #define ACPI_NFIT_CONTROL_MFG_INFO_VALID    (1)     /* Manufacturing fields are valid */
   1295 
   1296 
   1297 /* 5: NVDIMM Block Data Window Region Structure */
   1298 
   1299 typedef struct acpi_nfit_data_region
   1300 {
   1301     ACPI_NFIT_HEADER        Header;
   1302     UINT16                  RegionIndex;
   1303     UINT16                  Windows;
   1304     UINT64                  Offset;
   1305     UINT64                  Size;
   1306     UINT64                  Capacity;
   1307     UINT64                  StartAddress;
   1308 
   1309 } ACPI_NFIT_DATA_REGION;
   1310 
   1311 
   1312 /* 6: Flush Hint Address Structure */
   1313 
   1314 typedef struct acpi_nfit_flush_address
   1315 {
   1316     ACPI_NFIT_HEADER        Header;
   1317     UINT32                  DeviceHandle;
   1318     UINT16                  HintCount;
   1319     UINT8                   Reserved[6];        /* Reserved, must be zero */
   1320     UINT64                  HintAddress[1];     /* Variable length */
   1321 
   1322 } ACPI_NFIT_FLUSH_ADDRESS;
   1323 
   1324 
   1325 /* 7: Platform Capabilities Structure */
   1326 
   1327 typedef struct acpi_nfit_capabilities
   1328 {
   1329     ACPI_NFIT_HEADER        Header;
   1330     UINT8                   HighestCapability;
   1331     UINT8                   Reserved[3];       /* Reserved, must be zero */
   1332     UINT32                  Capabilities;
   1333     UINT32                  Reserved2;
   1334 
   1335 } ACPI_NFIT_CAPABILITIES;
   1336 
   1337 /* Capabilities Flags */
   1338 
   1339 #define ACPI_NFIT_CAPABILITY_CACHE_FLUSH       (1)     /* 00: Cache Flush to NVDIMM capable */
   1340 #define ACPI_NFIT_CAPABILITY_MEM_FLUSH         (1<<1)  /* 01: Memory Flush to NVDIMM capable */
   1341 #define ACPI_NFIT_CAPABILITY_MEM_MIRRORING     (1<<2)  /* 02: Memory Mirroring capable */
   1342 
   1343 
   1344 /*
   1345  * NFIT/DVDIMM device handle support - used as the _ADR for each NVDIMM
   1346  */
   1347 typedef struct nfit_device_handle
   1348 {
   1349     UINT32                  Handle;
   1350 
   1351 } NFIT_DEVICE_HANDLE;
   1352 
   1353 /* Device handle construction and extraction macros */
   1354 
   1355 #define ACPI_NFIT_DIMM_NUMBER_MASK              0x0000000F
   1356 #define ACPI_NFIT_CHANNEL_NUMBER_MASK           0x000000F0
   1357 #define ACPI_NFIT_MEMORY_ID_MASK                0x00000F00
   1358 #define ACPI_NFIT_SOCKET_ID_MASK                0x0000F000
   1359 #define ACPI_NFIT_NODE_ID_MASK                  0x0FFF0000
   1360 
   1361 #define ACPI_NFIT_DIMM_NUMBER_OFFSET            0
   1362 #define ACPI_NFIT_CHANNEL_NUMBER_OFFSET         4
   1363 #define ACPI_NFIT_MEMORY_ID_OFFSET              8
   1364 #define ACPI_NFIT_SOCKET_ID_OFFSET              12
   1365 #define ACPI_NFIT_NODE_ID_OFFSET                16
   1366 
   1367 /* Macro to construct a NFIT/NVDIMM device handle */
   1368 
   1369 #define ACPI_NFIT_BUILD_DEVICE_HANDLE(dimm, channel, memory, socket, node) \
   1370     ((dimm)                                         | \
   1371     ((channel) << ACPI_NFIT_CHANNEL_NUMBER_OFFSET)  | \
   1372     ((memory)  << ACPI_NFIT_MEMORY_ID_OFFSET)       | \
   1373     ((socket)  << ACPI_NFIT_SOCKET_ID_OFFSET)       | \
   1374     ((node)    << ACPI_NFIT_NODE_ID_OFFSET))
   1375 
   1376 /* Macros to extract individual fields from a NFIT/NVDIMM device handle */
   1377 
   1378 #define ACPI_NFIT_GET_DIMM_NUMBER(handle) \
   1379     ((handle) & ACPI_NFIT_DIMM_NUMBER_MASK)
   1380 
   1381 #define ACPI_NFIT_GET_CHANNEL_NUMBER(handle) \
   1382     (((handle) & ACPI_NFIT_CHANNEL_NUMBER_MASK) >> ACPI_NFIT_CHANNEL_NUMBER_OFFSET)
   1383 
   1384 #define ACPI_NFIT_GET_MEMORY_ID(handle) \
   1385     (((handle) & ACPI_NFIT_MEMORY_ID_MASK)      >> ACPI_NFIT_MEMORY_ID_OFFSET)
   1386 
   1387 #define ACPI_NFIT_GET_SOCKET_ID(handle) \
   1388     (((handle) & ACPI_NFIT_SOCKET_ID_MASK)      >> ACPI_NFIT_SOCKET_ID_OFFSET)
   1389 
   1390 #define ACPI_NFIT_GET_NODE_ID(handle) \
   1391     (((handle) & ACPI_NFIT_NODE_ID_MASK)        >> ACPI_NFIT_NODE_ID_OFFSET)
   1392 
   1393 
   1394 /*******************************************************************************
   1395  *
   1396  * PCCT - Platform Communications Channel Table (ACPI 5.0)
   1397  *        Version 2 (ACPI 6.2)
   1398  *
   1399  ******************************************************************************/
   1400 
   1401 typedef struct acpi_table_pcct
   1402 {
   1403     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1404     UINT32                  Flags;
   1405     UINT64                  Reserved;
   1406 
   1407 } ACPI_TABLE_PCCT;
   1408 
   1409 /* Values for Flags field above */
   1410 
   1411 #define ACPI_PCCT_DOORBELL              1
   1412 
   1413 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
   1414 
   1415 enum AcpiPcctType
   1416 {
   1417     ACPI_PCCT_TYPE_GENERIC_SUBSPACE             = 0,
   1418     ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE          = 1,
   1419     ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2    = 2,    /* ACPI 6.1 */
   1420     ACPI_PCCT_TYPE_EXT_PCC_MASTER_SUBSPACE      = 3,    /* ACPI 6.2 */
   1421     ACPI_PCCT_TYPE_EXT_PCC_SLAVE_SUBSPACE       = 4,    /* ACPI 6.2 */
   1422     ACPI_PCCT_TYPE_RESERVED                     = 5     /* 5 and greater are reserved */
   1423 };
   1424 
   1425 /*
   1426  * PCCT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
   1427  */
   1428 
   1429 /* 0: Generic Communications Subspace */
   1430 
   1431 typedef struct acpi_pcct_subspace
   1432 {
   1433     ACPI_SUBTABLE_HEADER    Header;
   1434     UINT8                   Reserved[6];
   1435     UINT64                  BaseAddress;
   1436     UINT64                  Length;
   1437     ACPI_GENERIC_ADDRESS    DoorbellRegister;
   1438     UINT64                  PreserveMask;
   1439     UINT64                  WriteMask;
   1440     UINT32                  Latency;
   1441     UINT32                  MaxAccessRate;
   1442     UINT16                  MinTurnaroundTime;
   1443 
   1444 } ACPI_PCCT_SUBSPACE;
   1445 
   1446 
   1447 /* 1: HW-reduced Communications Subspace (ACPI 5.1) */
   1448 
   1449 typedef struct acpi_pcct_hw_reduced
   1450 {
   1451     ACPI_SUBTABLE_HEADER    Header;
   1452     UINT32                  PlatformInterrupt;
   1453     UINT8                   Flags;
   1454     UINT8                   Reserved;
   1455     UINT64                  BaseAddress;
   1456     UINT64                  Length;
   1457     ACPI_GENERIC_ADDRESS    DoorbellRegister;
   1458     UINT64                  PreserveMask;
   1459     UINT64                  WriteMask;
   1460     UINT32                  Latency;
   1461     UINT32                  MaxAccessRate;
   1462     UINT16                  MinTurnaroundTime;
   1463 
   1464 } ACPI_PCCT_HW_REDUCED;
   1465 
   1466 
   1467 /* 2: HW-reduced Communications Subspace Type 2 (ACPI 6.1) */
   1468 
   1469 typedef struct acpi_pcct_hw_reduced_type2
   1470 {
   1471     ACPI_SUBTABLE_HEADER    Header;
   1472     UINT32                  PlatformInterrupt;
   1473     UINT8                   Flags;
   1474     UINT8                   Reserved;
   1475     UINT64                  BaseAddress;
   1476     UINT64                  Length;
   1477     ACPI_GENERIC_ADDRESS    DoorbellRegister;
   1478     UINT64                  PreserveMask;
   1479     UINT64                  WriteMask;
   1480     UINT32                  Latency;
   1481     UINT32                  MaxAccessRate;
   1482     UINT16                  MinTurnaroundTime;
   1483     ACPI_GENERIC_ADDRESS    PlatformAckRegister;
   1484     UINT64                  AckPreserveMask;
   1485     UINT64                  AckWriteMask;
   1486 
   1487 } ACPI_PCCT_HW_REDUCED_TYPE2;
   1488 
   1489 
   1490 /* 3: Extended PCC Master Subspace Type 3 (ACPI 6.2) */
   1491 
   1492 typedef struct acpi_pcct_ext_pcc_master
   1493 {
   1494     ACPI_SUBTABLE_HEADER    Header;
   1495     UINT32                  PlatformInterrupt;
   1496     UINT8                   Flags;
   1497     UINT8                   Reserved1;
   1498     UINT64                  BaseAddress;
   1499     UINT32                  Length;
   1500     ACPI_GENERIC_ADDRESS    DoorbellRegister;
   1501     UINT64                  PreserveMask;
   1502     UINT64                  WriteMask;
   1503     UINT32                  Latency;
   1504     UINT32                  MaxAccessRate;
   1505     UINT32                  MinTurnaroundTime;
   1506     ACPI_GENERIC_ADDRESS    PlatformAckRegister;
   1507     UINT64                  AckPreserveMask;
   1508     UINT64                  AckSetMask;
   1509     UINT64                  Reserved2;
   1510     ACPI_GENERIC_ADDRESS    CmdCompleteRegister;
   1511     UINT64                  CmdCompleteMask;
   1512     ACPI_GENERIC_ADDRESS    CmdUpdateRegister;
   1513     UINT64                  CmdUpdatePreserveMask;
   1514     UINT64                  CmdUpdateSetMask;
   1515     ACPI_GENERIC_ADDRESS    ErrorStatusRegister;
   1516     UINT64                  ErrorStatusMask;
   1517 
   1518 } ACPI_PCCT_EXT_PCC_MASTER;
   1519 
   1520 
   1521 /* 4: Extended PCC Slave Subspace Type 4 (ACPI 6.2) */
   1522 
   1523 typedef struct acpi_pcct_ext_pcc_slave
   1524 {
   1525     ACPI_SUBTABLE_HEADER    Header;
   1526     UINT32                  PlatformInterrupt;
   1527     UINT8                   Flags;
   1528     UINT8                   Reserved1;
   1529     UINT64                  BaseAddress;
   1530     UINT32                  Length;
   1531     ACPI_GENERIC_ADDRESS    DoorbellRegister;
   1532     UINT64                  PreserveMask;
   1533     UINT64                  WriteMask;
   1534     UINT32                  Latency;
   1535     UINT32                  MaxAccessRate;
   1536     UINT32                  MinTurnaroundTime;
   1537     ACPI_GENERIC_ADDRESS    PlatformAckRegister;
   1538     UINT64                  AckPreserveMask;
   1539     UINT64                  AckSetMask;
   1540     UINT64                  Reserved2;
   1541     ACPI_GENERIC_ADDRESS    CmdCompleteRegister;
   1542     UINT64                  CmdCompleteMask;
   1543     ACPI_GENERIC_ADDRESS    CmdUpdateRegister;
   1544     UINT64                  CmdUpdatePreserveMask;
   1545     UINT64                  CmdUpdateSetMask;
   1546     ACPI_GENERIC_ADDRESS    ErrorStatusRegister;
   1547     UINT64                  ErrorStatusMask;
   1548 
   1549 } ACPI_PCCT_EXT_PCC_SLAVE;
   1550 
   1551 
   1552 /* Values for doorbell flags above */
   1553 
   1554 #define ACPI_PCCT_INTERRUPT_POLARITY    (1)
   1555 #define ACPI_PCCT_INTERRUPT_MODE        (1<<1)
   1556 
   1557 
   1558 /*
   1559  * PCC memory structures (not part of the ACPI table)
   1560  */
   1561 
   1562 /* Shared Memory Region */
   1563 
   1564 typedef struct acpi_pcct_shared_memory
   1565 {
   1566     UINT32                  Signature;
   1567     UINT16                  Command;
   1568     UINT16                  Status;
   1569 
   1570 } ACPI_PCCT_SHARED_MEMORY;
   1571 
   1572 
   1573 /* Extended PCC Subspace Shared Memory Region (ACPI 6.2) */
   1574 
   1575 typedef struct acpi_pcct_ext_pcc_shared_memory
   1576 {
   1577     UINT32                  Signature;
   1578     UINT32                  Flags;
   1579     UINT32                  Length;
   1580     UINT32                  Command;
   1581 
   1582 } ACPI_PCCT_EXT_PCC_SHARED_MEMORY;
   1583 
   1584 
   1585 /*******************************************************************************
   1586  *
   1587  * PDTT - Platform Debug Trigger Table (ACPI 6.2)
   1588  *        Version 0
   1589  *
   1590  ******************************************************************************/
   1591 
   1592 typedef struct acpi_table_pdtt
   1593 {
   1594     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1595     UINT8                   TriggerCount;
   1596     UINT8                   Reserved[3];
   1597     UINT32                  ArrayOffset;
   1598 
   1599 } ACPI_TABLE_PDTT;
   1600 
   1601 
   1602 /*
   1603  * PDTT Communication Channel Identifier Structure.
   1604  * The number of these structures is defined by TriggerCount above,
   1605  * starting at ArrayOffset.
   1606  */
   1607 typedef struct acpi_pdtt_channel
   1608 {
   1609     UINT8                   SubchannelId;
   1610     UINT8                   Flags;
   1611 
   1612 } ACPI_PDTT_CHANNEL;
   1613 
   1614 /* Flags for above */
   1615 
   1616 #define ACPI_PDTT_RUNTIME_TRIGGER           (1)
   1617 #define ACPI_PDTT_WAIT_COMPLETION           (1<<1)
   1618 
   1619 
   1620 /*******************************************************************************
   1621  *
   1622  * PMTT - Platform Memory Topology Table (ACPI 5.0)
   1623  *        Version 1
   1624  *
   1625  ******************************************************************************/
   1626 
   1627 typedef struct acpi_table_pmtt
   1628 {
   1629     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1630     UINT32                  Reserved;
   1631 
   1632 } ACPI_TABLE_PMTT;
   1633 
   1634 
   1635 /* Common header for PMTT subtables that follow main table */
   1636 
   1637 typedef struct acpi_pmtt_header
   1638 {
   1639     UINT8                   Type;
   1640     UINT8                   Reserved1;
   1641     UINT16                  Length;
   1642     UINT16                  Flags;
   1643     UINT16                  Reserved2;
   1644 
   1645 } ACPI_PMTT_HEADER;
   1646 
   1647 /* Values for Type field above */
   1648 
   1649 #define ACPI_PMTT_TYPE_SOCKET           0
   1650 #define ACPI_PMTT_TYPE_CONTROLLER       1
   1651 #define ACPI_PMTT_TYPE_DIMM             2
   1652 #define ACPI_PMTT_TYPE_RESERVED         3 /* 0x03-0xFF are reserved */
   1653 
   1654 /* Values for Flags field above */
   1655 
   1656 #define ACPI_PMTT_TOP_LEVEL             0x0001
   1657 #define ACPI_PMTT_PHYSICAL              0x0002
   1658 #define ACPI_PMTT_MEMORY_TYPE           0x000C
   1659 
   1660 
   1661 /*
   1662  * PMTT subtables, correspond to Type in acpi_pmtt_header
   1663  */
   1664 
   1665 
   1666 /* 0: Socket Structure */
   1667 
   1668 typedef struct acpi_pmtt_socket
   1669 {
   1670     ACPI_PMTT_HEADER        Header;
   1671     UINT16                  SocketId;
   1672     UINT16                  Reserved;
   1673 
   1674 } ACPI_PMTT_SOCKET;
   1675 
   1676 
   1677 /* 1: Memory Controller subtable */
   1678 
   1679 typedef struct acpi_pmtt_controller
   1680 {
   1681     ACPI_PMTT_HEADER        Header;
   1682     UINT32                  ReadLatency;
   1683     UINT32                  WriteLatency;
   1684     UINT32                  ReadBandwidth;
   1685     UINT32                  WriteBandwidth;
   1686     UINT16                  AccessWidth;
   1687     UINT16                  Alignment;
   1688     UINT16                  Reserved;
   1689     UINT16                  DomainCount;
   1690 
   1691 } ACPI_PMTT_CONTROLLER;
   1692 
   1693 /* 1a: Proximity Domain substructure */
   1694 
   1695 typedef struct acpi_pmtt_domain
   1696 {
   1697     UINT32                  ProximityDomain;
   1698 
   1699 } ACPI_PMTT_DOMAIN;
   1700 
   1701 
   1702 /* 2: Physical Component Identifier (DIMM) */
   1703 
   1704 typedef struct acpi_pmtt_physical_component
   1705 {
   1706     ACPI_PMTT_HEADER        Header;
   1707     UINT16                  ComponentId;
   1708     UINT16                  Reserved;
   1709     UINT32                  MemorySize;
   1710     UINT32                  BiosHandle;
   1711 
   1712 } ACPI_PMTT_PHYSICAL_COMPONENT;
   1713 
   1714 
   1715 /*******************************************************************************
   1716  *
   1717  * PPTT - Processor Properties Topology Table (ACPI 6.2)
   1718  *        Version 1
   1719  *
   1720  ******************************************************************************/
   1721 
   1722 typedef struct acpi_table_pptt
   1723 {
   1724     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1725 
   1726 } ACPI_TABLE_PPTT;
   1727 
   1728 /* Values for Type field above */
   1729 
   1730 enum AcpiPpttType
   1731 {
   1732     ACPI_PPTT_TYPE_PROCESSOR            = 0,
   1733     ACPI_PPTT_TYPE_CACHE                = 1,
   1734     ACPI_PPTT_TYPE_ID                   = 2,
   1735     ACPI_PPTT_TYPE_RESERVED             = 3
   1736 };
   1737 
   1738 
   1739 /* 0: Processor Hierarchy Node Structure */
   1740 
   1741 typedef struct acpi_pptt_processor
   1742 {
   1743     ACPI_SUBTABLE_HEADER    Header;
   1744     UINT16                  Reserved;
   1745     UINT32                  Flags;
   1746     UINT32                  Parent;
   1747     UINT32                  AcpiProcessorId;
   1748     UINT32                  NumberOfPrivResources;
   1749 
   1750 } ACPI_PPTT_PROCESSOR;
   1751 
   1752 /* Flags */
   1753 
   1754 #define ACPI_PPTT_PHYSICAL_PACKAGE          (1)     /* Physical package */
   1755 #define ACPI_PPTT_ACPI_PROCESSOR_ID_VALID   (2)     /* ACPI Processor ID valid */
   1756 
   1757 
   1758 /* 1: Cache Type Structure */
   1759 
   1760 typedef struct acpi_pptt_cache
   1761 {
   1762     ACPI_SUBTABLE_HEADER    Header;
   1763     UINT16                  Reserved;
   1764     UINT32                  Flags;
   1765     UINT32                  NextLevelOfCache;
   1766     UINT32                  Size;
   1767     UINT32                  NumberOfSets;
   1768     UINT8                   Associativity;
   1769     UINT8                   Attributes;
   1770     UINT16                  LineSize;
   1771 
   1772 } ACPI_PPTT_CACHE;
   1773 
   1774 /* Flags */
   1775 
   1776 #define ACPI_PPTT_SIZE_PROPERTY_VALID       (1)     /* Physical property valid */
   1777 #define ACPI_PPTT_NUMBER_OF_SETS_VALID      (1<<1)  /* Number of sets valid */
   1778 #define ACPI_PPTT_ASSOCIATIVITY_VALID       (1<<2)  /* Associativity valid */
   1779 #define ACPI_PPTT_ALLOCATION_TYPE_VALID     (1<<3)  /* Allocation type valid */
   1780 #define ACPI_PPTT_CACHE_TYPE_VALID          (1<<4)  /* Cache type valid */
   1781 #define ACPI_PPTT_WRITE_POLICY_VALID        (1<<5)  /* Write policy valid */
   1782 #define ACPI_PPTT_LINE_SIZE_VALID           (1<<6)  /* Line size valid */
   1783 
   1784 /* Masks for Attributes */
   1785 
   1786 #define ACPI_PPTT_MASK_ALLOCATION_TYPE      (0x03)  /* Allocation type */
   1787 #define ACPI_PPTT_MASK_CACHE_TYPE           (0x0C)  /* Cache type */
   1788 #define ACPI_PPTT_MASK_WRITE_POLICY         (0x10)  /* Write policy */
   1789 
   1790 /* Attributes describing cache */
   1791 #define ACPI_PPTT_CACHE_READ_ALLOCATE       (0x0)   /* Cache line is allocated on read */
   1792 #define ACPI_PPTT_CACHE_WRITE_ALLOCATE      (0x01)  /* Cache line is allocated on write */
   1793 #define ACPI_PPTT_CACHE_RW_ALLOCATE         (0x02)  /* Cache line is allocated on read and write */
   1794 #define ACPI_PPTT_CACHE_RW_ALLOCATE_ALT     (0x03)  /* Alternate representation of above */
   1795 
   1796 #define ACPI_PPTT_CACHE_TYPE_DATA           (0x0)   /* Data cache */
   1797 #define ACPI_PPTT_CACHE_TYPE_INSTR          (1<<2)  /* Instruction cache */
   1798 #define ACPI_PPTT_CACHE_TYPE_UNIFIED        (2<<2)  /* Unified I & D cache */
   1799 #define ACPI_PPTT_CACHE_TYPE_UNIFIED_ALT    (3<<2)  /* Alternate representation of above */
   1800 
   1801 #define ACPI_PPTT_CACHE_POLICY_WB           (0x0)   /* Cache is write back */
   1802 #define ACPI_PPTT_CACHE_POLICY_WT           (1<<4)  /* Cache is write through */
   1803 
   1804 /* 2: ID Structure */
   1805 
   1806 typedef struct acpi_pptt_id
   1807 {
   1808     ACPI_SUBTABLE_HEADER    Header;
   1809     UINT16                  Reserved;
   1810     UINT32                  VendorId;
   1811     UINT64                  Level1Id;
   1812     UINT64                  Level2Id;
   1813     UINT16                  MajorRev;
   1814     UINT16                  MinorRev;
   1815     UINT16                  SpinRev;
   1816 
   1817 } ACPI_PPTT_ID;
   1818 
   1819 
   1820 /*******************************************************************************
   1821  *
   1822  * RASF - RAS Feature Table (ACPI 5.0)
   1823  *        Version 1
   1824  *
   1825  ******************************************************************************/
   1826 
   1827 typedef struct acpi_table_rasf
   1828 {
   1829     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1830     UINT8                   ChannelId[12];
   1831 
   1832 } ACPI_TABLE_RASF;
   1833 
   1834 /* RASF Platform Communication Channel Shared Memory Region */
   1835 
   1836 typedef struct acpi_rasf_shared_memory
   1837 {
   1838     UINT32                  Signature;
   1839     UINT16                  Command;
   1840     UINT16                  Status;
   1841     UINT16                  Version;
   1842     UINT8                   Capabilities[16];
   1843     UINT8                   SetCapabilities[16];
   1844     UINT16                  NumParameterBlocks;
   1845     UINT32                  SetCapabilitiesStatus;
   1846 
   1847 } ACPI_RASF_SHARED_MEMORY;
   1848 
   1849 /* RASF Parameter Block Structure Header */
   1850 
   1851 typedef struct acpi_rasf_parameter_block
   1852 {
   1853     UINT16                  Type;
   1854     UINT16                  Version;
   1855     UINT16                  Length;
   1856 
   1857 } ACPI_RASF_PARAMETER_BLOCK;
   1858 
   1859 /* RASF Parameter Block Structure for PATROL_SCRUB */
   1860 
   1861 typedef struct acpi_rasf_patrol_scrub_parameter
   1862 {
   1863     ACPI_RASF_PARAMETER_BLOCK   Header;
   1864     UINT16                      PatrolScrubCommand;
   1865     UINT64                      RequestedAddressRange[2];
   1866     UINT64                      ActualAddressRange[2];
   1867     UINT16                      Flags;
   1868     UINT8                       RequestedSpeed;
   1869 
   1870 } ACPI_RASF_PATROL_SCRUB_PARAMETER;
   1871 
   1872 /* Masks for Flags and Speed fields above */
   1873 
   1874 #define ACPI_RASF_SCRUBBER_RUNNING      1
   1875 #define ACPI_RASF_SPEED                 (7<<1)
   1876 #define ACPI_RASF_SPEED_SLOW            (0<<1)
   1877 #define ACPI_RASF_SPEED_MEDIUM          (4<<1)
   1878 #define ACPI_RASF_SPEED_FAST            (7<<1)
   1879 
   1880 /* Channel Commands */
   1881 
   1882 enum AcpiRasfCommands
   1883 {
   1884     ACPI_RASF_EXECUTE_RASF_COMMAND      = 1
   1885 };
   1886 
   1887 /* Platform RAS Capabilities */
   1888 
   1889 enum AcpiRasfCapabiliities
   1890 {
   1891     ACPI_HW_PATROL_SCRUB_SUPPORTED      = 0,
   1892     ACPI_SW_PATROL_SCRUB_EXPOSED        = 1
   1893 };
   1894 
   1895 /* Patrol Scrub Commands */
   1896 
   1897 enum AcpiRasfPatrolScrubCommands
   1898 {
   1899     ACPI_RASF_GET_PATROL_PARAMETERS     = 1,
   1900     ACPI_RASF_START_PATROL_SCRUBBER     = 2,
   1901     ACPI_RASF_STOP_PATROL_SCRUBBER      = 3
   1902 };
   1903 
   1904 /* Channel Command flags */
   1905 
   1906 #define ACPI_RASF_GENERATE_SCI          (1<<15)
   1907 
   1908 /* Status values */
   1909 
   1910 enum AcpiRasfStatus
   1911 {
   1912     ACPI_RASF_SUCCESS                   = 0,
   1913     ACPI_RASF_NOT_VALID                 = 1,
   1914     ACPI_RASF_NOT_SUPPORTED             = 2,
   1915     ACPI_RASF_BUSY                      = 3,
   1916     ACPI_RASF_FAILED                    = 4,
   1917     ACPI_RASF_ABORTED                   = 5,
   1918     ACPI_RASF_INVALID_DATA              = 6
   1919 };
   1920 
   1921 /* Status flags */
   1922 
   1923 #define ACPI_RASF_COMMAND_COMPLETE      (1)
   1924 #define ACPI_RASF_SCI_DOORBELL          (1<<1)
   1925 #define ACPI_RASF_ERROR                 (1<<2)
   1926 #define ACPI_RASF_STATUS                (0x1F<<3)
   1927 
   1928 
   1929 /*******************************************************************************
   1930  *
   1931  * SBST - Smart Battery Specification Table
   1932  *        Version 1
   1933  *
   1934  ******************************************************************************/
   1935 
   1936 typedef struct acpi_table_sbst
   1937 {
   1938     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1939     UINT32                  WarningLevel;
   1940     UINT32                  LowLevel;
   1941     UINT32                  CriticalLevel;
   1942 
   1943 } ACPI_TABLE_SBST;
   1944 
   1945 
   1946 /*******************************************************************************
   1947  *
   1948  * SDEI - Software Delegated Exception Interface Descriptor Table
   1949  *
   1950  * Conforms to "Software Delegated Exception Interface (SDEI)" ARM DEN0054A,
   1951  * May 8th, 2017. Copyright 2017 ARM Ltd.
   1952  *
   1953  ******************************************************************************/
   1954 
   1955 typedef struct acpi_table_sdei
   1956 {
   1957     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1958 
   1959 } ACPI_TABLE_SDEI;
   1960 
   1961 
   1962 /*******************************************************************************
   1963  *
   1964  * SDEV - Secure Devices Table (ACPI 6.2)
   1965  *        Version 1
   1966  *
   1967  ******************************************************************************/
   1968 
   1969 typedef struct acpi_table_sdev
   1970 {
   1971     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
   1972 
   1973 } ACPI_TABLE_SDEV;
   1974 
   1975 
   1976 typedef struct acpi_sdev_header
   1977 {
   1978     UINT8                   Type;
   1979     UINT8                   Flags;
   1980     UINT16                  Length;
   1981 
   1982 } ACPI_SDEV_HEADER;
   1983 
   1984 
   1985 /* Values for subtable type above */
   1986 
   1987 enum AcpiSdevType
   1988 {
   1989     ACPI_SDEV_TYPE_NAMESPACE_DEVICE     = 0,
   1990     ACPI_SDEV_TYPE_PCIE_ENDPOINT_DEVICE = 1,
   1991     ACPI_SDEV_TYPE_RESERVED             = 2     /* 2 and greater are reserved */
   1992 };
   1993 
   1994 /* Values for flags above */
   1995 
   1996 #define ACPI_SDEV_HANDOFF_TO_UNSECURE_OS    (1)
   1997 
   1998 /*
   1999  * SDEV subtables
   2000  */
   2001 
   2002 /* 0: Namespace Device Based Secure Device Structure */
   2003 
   2004 typedef struct acpi_sdev_namespace
   2005 {
   2006     ACPI_SDEV_HEADER        Header;
   2007     UINT16                  DeviceIdOffset;
   2008     UINT16                  DeviceIdLength;
   2009     UINT16                  VendorDataOffset;
   2010     UINT16                  VendorDataLength;
   2011 
   2012 } ACPI_SDEV_NAMESPACE;
   2013 
   2014 /* 1: PCIe Endpoint Device Based Device Structure */
   2015 
   2016 typedef struct acpi_sdev_pcie
   2017 {
   2018     ACPI_SDEV_HEADER        Header;
   2019     UINT16                  Segment;
   2020     UINT16                  StartBus;
   2021     UINT16                  PathOffset;
   2022     UINT16                  PathLength;
   2023     UINT16                  VendorDataOffset;
   2024     UINT16                  VendorDataLength;
   2025 
   2026 } ACPI_SDEV_PCIE;
   2027 
   2028 /* 1a: PCIe Endpoint path entry */
   2029 
   2030 typedef struct acpi_sdev_pcie_path
   2031 {
   2032     UINT8                   Device;
   2033     UINT8                   Function;
   2034 
   2035 } ACPI_SDEV_PCIE_PATH;
   2036 
   2037 
   2038 /* Reset to default packing */
   2039 
   2040 #pragma pack()
   2041 
   2042 #endif /* __ACTBL2_H__ */
   2043