hw/i386/intel_iommu_internal.h

   1 /*
   2  * QEMU emulation of an Intel IOMMU (VT-d)
   3  *   (DMA Remapping device)
   4  *
   5  * Copyright (C) 2013 Knut Omang, Oracle <knut.omang@oracle.com>
   6  * Copyright (C) 2014 Le Tan, <tamlokveer@gmail.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, see <http://www.gnu.org/licenses/>.
  20  *
  21  * Lots of defines copied from kernel/include/linux/intel-iommu.h:
  22  *   Copyright (C) 2006-2008 Intel Corporation
  23  *   Author: Ashok Raj <ashok.raj@intel.com>
  24  *   Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
  25  *
  26  */
  27
  28 #ifndef HW_I386_INTEL_IOMMU_INTERNAL_H
  29 #define HW_I386_INTEL_IOMMU_INTERNAL_H
  30 #include "hw/i386/intel_iommu.h"
  31
  32 /*
  33  * Intel IOMMU register specification
  34  */
  35 #define DMAR_VER_REG            0x0  /* Arch version supported by this IOMMU */
  36 #define DMAR_CAP_REG            0x8  /* Hardware supported capabilities */
  37 #define DMAR_CAP_REG_HI         0xc  /* High 32-bit of DMAR_CAP_REG */
  38 #define DMAR_ECAP_REG           0x10 /* Extended capabilities supported */
  39 #define DMAR_ECAP_REG_HI        0X14
  40 #define DMAR_GCMD_REG           0x18 /* Global command */
  41 #define DMAR_GSTS_REG           0x1c /* Global status */
  42 #define DMAR_RTADDR_REG         0x20 /* Root entry table */
  43 #define DMAR_RTADDR_REG_HI      0X24
  44 #define DMAR_CCMD_REG           0x28 /* Context command */
  45 #define DMAR_CCMD_REG_HI        0x2c
  46 #define DMAR_FSTS_REG           0x34 /* Fault status */
  47 #define DMAR_FECTL_REG          0x38 /* Fault control */
  48 #define DMAR_FEDATA_REG         0x3c /* Fault event interrupt data */
  49 #define DMAR_FEADDR_REG         0x40 /* Fault event interrupt addr */
  50 #define DMAR_FEUADDR_REG        0x44 /* Upper address */
  51 #define DMAR_AFLOG_REG          0x58 /* Advanced fault control */
  52 #define DMAR_AFLOG_REG_HI       0X5c
  53 #define DMAR_PMEN_REG           0x64 /* Enable protected memory region */
  54 #define DMAR_PLMBASE_REG        0x68 /* PMRR low addr */
  55 #define DMAR_PLMLIMIT_REG       0x6c /* PMRR low limit */
  56 #define DMAR_PHMBASE_REG        0x70 /* PMRR high base addr */
  57 #define DMAR_PHMBASE_REG_HI     0X74
  58 #define DMAR_PHMLIMIT_REG       0x78 /* PMRR high limit */
  59 #define DMAR_PHMLIMIT_REG_HI    0x7c
  60 #define DMAR_IQH_REG            0x80 /* Invalidation queue head */
  61 #define DMAR_IQH_REG_HI         0X84
  62 #define DMAR_IQT_REG            0x88 /* Invalidation queue tail */
  63 #define DMAR_IQT_REG_HI         0X8c
  64 #define DMAR_IQA_REG            0x90 /* Invalidation queue addr */
  65 #define DMAR_IQA_REG_HI         0x94
  66 #define DMAR_ICS_REG            0x9c /* Invalidation complete status */
  67 #define DMAR_IRTA_REG           0xb8 /* Interrupt remapping table addr */
  68 #define DMAR_IRTA_REG_HI        0xbc
  69 #define DMAR_IECTL_REG          0xa0 /* Invalidation event control */
  70 #define DMAR_IEDATA_REG         0xa4 /* Invalidation event data */
  71 #define DMAR_IEADDR_REG         0xa8 /* Invalidation event address */
  72 #define DMAR_IEUADDR_REG        0xac /* Invalidation event address */
  73 #define DMAR_PQH_REG            0xc0 /* Page request queue head */
  74 #define DMAR_PQH_REG_HI         0xc4
  75 #define DMAR_PQT_REG            0xc8 /* Page request queue tail*/
  76 #define DMAR_PQT_REG_HI         0xcc
  77 #define DMAR_PQA_REG            0xd0 /* Page request queue address */
  78 #define DMAR_PQA_REG_HI         0xd4
  79 #define DMAR_PRS_REG            0xdc /* Page request status */
  80 #define DMAR_PECTL_REG          0xe0 /* Page request event control */
  81 #define DMAR_PEDATA_REG         0xe4 /* Page request event data */
  82 #define DMAR_PEADDR_REG         0xe8 /* Page request event address */
  83 #define DMAR_PEUADDR_REG        0xec /* Page event upper address */
  84 #define DMAR_MTRRCAP_REG        0x100 /* MTRR capability */
  85 #define DMAR_MTRRCAP_REG_HI     0x104
  86 #define DMAR_MTRRDEF_REG        0x108 /* MTRR default type */
  87 #define DMAR_MTRRDEF_REG_HI     0x10c
  88
  89 /* IOTLB registers */
  90 #define DMAR_IOTLB_REG_OFFSET   0xf0 /* Offset to the IOTLB registers */
  91 #define DMAR_IVA_REG            DMAR_IOTLB_REG_OFFSET /* Invalidate address */
  92 #define DMAR_IVA_REG_HI         (DMAR_IVA_REG + 4)
  93 /* IOTLB invalidate register */
  94 #define DMAR_IOTLB_REG          (DMAR_IOTLB_REG_OFFSET + 0x8)
  95 #define DMAR_IOTLB_REG_HI       (DMAR_IOTLB_REG + 4)
  96
  97 /* FRCD */
  98 #define DMAR_FRCD_REG_OFFSET    0x220 /* Offset to the fault recording regs */
  99 /* NOTICE: If you change the DMAR_FRCD_REG_NR, please remember to change the
 100  * DMAR_REG_SIZE in include/hw/i386/intel_iommu.h.
 101  * #define DMAR_REG_SIZE   (DMAR_FRCD_REG_OFFSET + 16 * DMAR_FRCD_REG_NR)
 102  */
 103 #define DMAR_FRCD_REG_NR        1ULL /* Num of fault recording regs */
 104
 105 #define DMAR_FRCD_REG_0_0       0x220 /* The 0th fault recording regs */
 106 #define DMAR_FRCD_REG_0_1       0x224
 107 #define DMAR_FRCD_REG_0_2       0x228
 108 #define DMAR_FRCD_REG_0_3       0x22c
 109
 110 /* Interrupt Address Range */
 111 #define VTD_INTERRUPT_ADDR_FIRST    0xfee00000ULL
 112 #define VTD_INTERRUPT_ADDR_LAST     0xfeefffffULL
 113 #define VTD_INTERRUPT_ADDR_SIZE     (VTD_INTERRUPT_ADDR_LAST - \
 114                                      VTD_INTERRUPT_ADDR_FIRST + 1)
 115
 116 /* The shift of source_id in the key of IOTLB hash table */
 117 #define VTD_IOTLB_SID_SHIFT         36
 118 #define VTD_IOTLB_LVL_SHIFT         52
 119 #define VTD_IOTLB_MAX_SIZE          1024    /* Max size of the hash table */
 120
 121 /* IOTLB_REG */
 122 #define VTD_TLB_GLOBAL_FLUSH        (1ULL << 60) /* Global invalidation */
 123 #define VTD_TLB_DSI_FLUSH           (2ULL << 60) /* Domain-selective */
 124 #define VTD_TLB_PSI_FLUSH           (3ULL << 60) /* Page-selective */
 125 #define VTD_TLB_FLUSH_GRANU_MASK    (3ULL << 60)
 126 #define VTD_TLB_GLOBAL_FLUSH_A      (1ULL << 57)
 127 #define VTD_TLB_DSI_FLUSH_A         (2ULL << 57)
 128 #define VTD_TLB_PSI_FLUSH_A         (3ULL << 57)
 129 #define VTD_TLB_FLUSH_GRANU_MASK_A  (3ULL << 57)
 130 #define VTD_TLB_IVT                 (1ULL << 63)
 131 #define VTD_TLB_DID(val)            (((val) >> 32) & VTD_DOMAIN_ID_MASK)
 132
 133 /* IVA_REG */
 134 #define VTD_IVA_ADDR(val)       ((val) & ~0xfffULL)
 135 #define VTD_IVA_AM(val)         ((val) & 0x3fULL)
 136
 137 /* GCMD_REG */
 138 #define VTD_GCMD_TE                 (1UL << 31)
 139 #define VTD_GCMD_SRTP               (1UL << 30)
 140 #define VTD_GCMD_SFL                (1UL << 29)
 141 #define VTD_GCMD_EAFL               (1UL << 28)
 142 #define VTD_GCMD_WBF                (1UL << 27)
 143 #define VTD_GCMD_QIE                (1UL << 26)
 144 #define VTD_GCMD_IRE                (1UL << 25)
 145 #define VTD_GCMD_SIRTP              (1UL << 24)
 146 #define VTD_GCMD_CFI                (1UL << 23)
 147
 148 /* GSTS_REG */
 149 #define VTD_GSTS_TES                (1UL << 31)
 150 #define VTD_GSTS_RTPS               (1UL << 30)
 151 #define VTD_GSTS_FLS                (1UL << 29)
 152 #define VTD_GSTS_AFLS               (1UL << 28)
 153 #define VTD_GSTS_WBFS               (1UL << 27)
 154 #define VTD_GSTS_QIES               (1UL << 26)
 155 #define VTD_GSTS_IRES               (1UL << 25)
 156 #define VTD_GSTS_IRTPS              (1UL << 24)
 157 #define VTD_GSTS_CFIS               (1UL << 23)
 158
 159 /* CCMD_REG */
 160 #define VTD_CCMD_ICC                (1ULL << 63)
 161 #define VTD_CCMD_GLOBAL_INVL        (1ULL << 61)
 162 #define VTD_CCMD_DOMAIN_INVL        (2ULL << 61)
 163 #define VTD_CCMD_DEVICE_INVL        (3ULL << 61)
 164 #define VTD_CCMD_CIRG_MASK          (3ULL << 61)
 165 #define VTD_CCMD_GLOBAL_INVL_A      (1ULL << 59)
 166 #define VTD_CCMD_DOMAIN_INVL_A      (2ULL << 59)
 167 #define VTD_CCMD_DEVICE_INVL_A      (3ULL << 59)
 168 #define VTD_CCMD_CAIG_MASK          (3ULL << 59)
 169 #define VTD_CCMD_DID(val)           ((val) & VTD_DOMAIN_ID_MASK)
 170 #define VTD_CCMD_SID(val)           (((val) >> 16) & 0xffffULL)
 171 #define VTD_CCMD_FM(val)            (((val) >> 32) & 3ULL)
 172
 173 /* RTADDR_REG */
 174 #define VTD_RTADDR_SMT              (1ULL << 10)
 175 #define VTD_RTADDR_ADDR_MASK(aw)    (VTD_HAW_MASK(aw) ^ 0xfffULL)
 176
 177 /* IRTA_REG */
 178 #define VTD_IRTA_ADDR_MASK(aw)      (VTD_HAW_MASK(aw) ^ 0xfffULL)
 179 #define VTD_IRTA_EIME               (1ULL << 11)
 180 #define VTD_IRTA_SIZE_MASK          (0xfULL)
 181
 182 /* ECAP_REG */
 183 /* (offset >> 4) << 8 */
 184 #define VTD_ECAP_IRO                (DMAR_IOTLB_REG_OFFSET << 4)
 185 #define VTD_ECAP_QI                 (1ULL << 1)
 186 #define VTD_ECAP_DT                 (1ULL << 2)
 187 /* Interrupt Remapping support */
 188 #define VTD_ECAP_IR                 (1ULL << 3)
 189 #define VTD_ECAP_EIM                (1ULL << 4)
 190 #define VTD_ECAP_PT                 (1ULL << 6)
 191 #define VTD_ECAP_MHMV               (15ULL << 20)
 192 #define VTD_ECAP_SRS                (1ULL << 31)
 193 #define VTD_ECAP_SMTS               (1ULL << 43)
 194 #define VTD_ECAP_SLTS               (1ULL << 46)
 195
 196 /* CAP_REG */
 197 /* (offset >> 4) << 24 */
 198 #define VTD_CAP_FRO                 (DMAR_FRCD_REG_OFFSET << 20)
 199 #define VTD_CAP_NFR                 ((DMAR_FRCD_REG_NR - 1) << 40)
 200 #define VTD_DOMAIN_ID_SHIFT         16  /* 16-bit domain id for 64K domains */
 201 #define VTD_DOMAIN_ID_MASK          ((1UL << VTD_DOMAIN_ID_SHIFT) - 1)
 202 #define VTD_CAP_ND                  (((VTD_DOMAIN_ID_SHIFT - 4) / 2) & 7ULL)
 203 #define VTD_ADDRESS_SIZE(aw)        (1ULL << (aw))
 204 #define VTD_CAP_MGAW(aw)            ((((aw) - 1) & 0x3fULL) << 16)
 205 #define VTD_MAMV                    18ULL
 206 #define VTD_CAP_MAMV                (VTD_MAMV << 48)
 207 #define VTD_CAP_PSI                 (1ULL << 39)
 208 #define VTD_CAP_SLLPS               ((1ULL << 34) | (1ULL << 35))
 209 #define VTD_CAP_DRAIN_WRITE         (1ULL << 54)
 210 #define VTD_CAP_DRAIN_READ          (1ULL << 55)
 211 #define VTD_CAP_DRAIN               (VTD_CAP_DRAIN_READ | VTD_CAP_DRAIN_WRITE)
 212 #define VTD_CAP_CM                  (1ULL << 7)
 213
 214 /* Supported Adjusted Guest Address Widths */
 215 #define VTD_CAP_SAGAW_SHIFT         8
 216 #define VTD_CAP_SAGAW_MASK          (0x1fULL << VTD_CAP_SAGAW_SHIFT)
 217  /* 39-bit AGAW, 3-level page-table */
 218 #define VTD_CAP_SAGAW_39bit         (0x2ULL << VTD_CAP_SAGAW_SHIFT)
 219  /* 48-bit AGAW, 4-level page-table */
 220 #define VTD_CAP_SAGAW_48bit         (0x4ULL << VTD_CAP_SAGAW_SHIFT)
 221
 222 /* IQT_REG */
 223 #define VTD_IQT_QT(dw_bit, val)     (dw_bit ? (((val) >> 5) & 0x3fffULL) : \
 224                                      (((val) >> 4) & 0x7fffULL))
 225 #define VTD_IQT_QT_256_RSV_BIT      0x10
 226
 227 /* IQA_REG */
 228 #define VTD_IQA_IQA_MASK(aw)        (VTD_HAW_MASK(aw) ^ 0xfffULL)
 229 #define VTD_IQA_QS                  0x7ULL
 230 #define VTD_IQA_DW_MASK             0x800
 231
 232 /* IQH_REG */
 233 #define VTD_IQH_QH_SHIFT_4          4
 234 #define VTD_IQH_QH_SHIFT_5          5
 235 #define VTD_IQH_QH_MASK             0x7fff0ULL
 236
 237 /* ICS_REG */
 238 #define VTD_ICS_IWC                 1UL
 239
 240 /* IECTL_REG */
 241 #define VTD_IECTL_IM                (1UL << 31)
 242 #define VTD_IECTL_IP                (1UL << 30)
 243
 244 /* FSTS_REG */
 245 #define VTD_FSTS_FRI_MASK       0xff00UL
 246 #define VTD_FSTS_FRI(val)       ((((uint32_t)(val)) << 8) & VTD_FSTS_FRI_MASK)
 247 #define VTD_FSTS_IQE            (1UL << 4)
 248 #define VTD_FSTS_PPF            (1UL << 1)
 249 #define VTD_FSTS_PFO            1UL
 250
 251 /* FECTL_REG */
 252 #define VTD_FECTL_IM            (1UL << 31)
 253 #define VTD_FECTL_IP            (1UL << 30)
 254
 255 /* Fault Recording Register */
 256 /* For the high 64-bit of 128-bit */
 257 #define VTD_FRCD_F              (1ULL << 63)
 258 #define VTD_FRCD_T              (1ULL << 62)
 259 #define VTD_FRCD_FR(val)        (((val) & 0xffULL) << 32)
 260 #define VTD_FRCD_SID_MASK       0xffffULL
 261 #define VTD_FRCD_SID(val)       ((val) & VTD_FRCD_SID_MASK)
 262 /* For the low 64-bit of 128-bit */
 263 #define VTD_FRCD_FI(val)        ((val) & ~0xfffULL)
 264
 265 /* DMA Remapping Fault Conditions */
 266 typedef enum VTDFaultReason {
 267     VTD_FR_RESERVED = 0,        /* Reserved for Advanced Fault logging */
 268     VTD_FR_ROOT_ENTRY_P = 1,    /* The Present(P) field of root-entry is 0 */
 269     VTD_FR_CONTEXT_ENTRY_P,     /* The Present(P) field of context-entry is 0 */
 270     VTD_FR_CONTEXT_ENTRY_INV,   /* Invalid programming of a context-entry */
 271     VTD_FR_ADDR_BEYOND_MGAW,    /* Input-address above (2^x-1) */
 272     VTD_FR_WRITE,               /* No write permission */
 273     VTD_FR_READ,                /* No read permission */
 274     /* Fail to access a second-level paging entry (not SL_PML4E) */
 275     VTD_FR_PAGING_ENTRY_INV,
 276     VTD_FR_ROOT_TABLE_INV,      /* Fail to access a root-entry */
 277     VTD_FR_CONTEXT_TABLE_INV,   /* Fail to access a context-entry */
 278     /* Non-zero reserved field in a present root-entry */
 279     VTD_FR_ROOT_ENTRY_RSVD,
 280     /* Non-zero reserved field in a present context-entry */
 281     VTD_FR_CONTEXT_ENTRY_RSVD,
 282     /* Non-zero reserved field in a second-level paging entry with at lease one
 283      * Read(R) and Write(W) or Execute(E) field is Set.
 284      */
 285     VTD_FR_PAGING_ENTRY_RSVD,
 286     /* Translation request or translated request explicitly blocked dut to the
 287      * programming of the Translation Type (T) field in the present
 288      * context-entry.
 289      */
 290     VTD_FR_CONTEXT_ENTRY_TT,
 291
 292     /* Interrupt remapping transition faults */
 293     VTD_FR_IR_REQ_RSVD = 0x20, /* One or more IR request reserved
 294                                 * fields set */
 295     VTD_FR_IR_INDEX_OVER = 0x21, /* Index value greater than max */
 296     VTD_FR_IR_ENTRY_P = 0x22,    /* Present (P) not set in IRTE */
 297     VTD_FR_IR_ROOT_INVAL = 0x23, /* IR Root table invalid */
 298     VTD_FR_IR_IRTE_RSVD = 0x24,  /* IRTE Rsvd field non-zero with
 299                                   * Present flag set */
 300     VTD_FR_IR_REQ_COMPAT = 0x25, /* Encountered compatible IR
 301                                   * request while disabled */
 302     VTD_FR_IR_SID_ERR = 0x26,   /* Invalid Source-ID */
 303
 304     VTD_FR_PASID_TABLE_INV = 0x58,  /*Invalid PASID table entry */
 305
 306     /* This is not a normal fault reason. We use this to indicate some faults
 307      * that are not referenced by the VT-d specification.
 308      * Fault event with such reason should not be recorded.
 309      */
 310     VTD_FR_RESERVED_ERR,
 311     VTD_FR_MAX,                 /* Guard */
 312 } VTDFaultReason;
 313
 314 #define VTD_CONTEXT_CACHE_GEN_MAX       0xffffffffUL
 315
 316 /* Interrupt Entry Cache Invalidation Descriptor: VT-d 6.5.2.7. */
 317 struct VTDInvDescIEC {
 318     uint32_t type:4;            /* Should always be 0x4 */
 319     uint32_t granularity:1;     /* If set, it's global IR invalidation */
 320     uint32_t resved_1:22;
 321     uint32_t index_mask:5;      /* 2^N for continuous int invalidation */
 322     uint32_t index:16;          /* Start index to invalidate */
 323     uint32_t reserved_2:16;
 324 };
 325 typedef struct VTDInvDescIEC VTDInvDescIEC;
 326
 327 /* Queued Invalidation Descriptor */
 328 union VTDInvDesc {
 329     struct {
 330         uint64_t lo;
 331         uint64_t hi;
 332     };
 333     struct {
 334         uint64_t val[4];
 335     };
 336     union {
 337         VTDInvDescIEC iec;
 338     };
 339 };
 340 typedef union VTDInvDesc VTDInvDesc;
 341
 342 /* Masks for struct VTDInvDesc */
 343 #define VTD_INV_DESC_TYPE               0xf
 344 #define VTD_INV_DESC_CC                 0x1 /* Context-cache Invalidate Desc */
 345 #define VTD_INV_DESC_IOTLB              0x2
 346 #define VTD_INV_DESC_DEVICE             0x3
 347 #define VTD_INV_DESC_IEC                0x4 /* Interrupt Entry Cache
 348                                                Invalidate Descriptor */
 349 #define VTD_INV_DESC_WAIT               0x5 /* Invalidation Wait Descriptor */
 350 #define VTD_INV_DESC_PIOTLB             0x6 /* PASID-IOTLB Invalidate Desc */
 351 #define VTD_INV_DESC_PC                 0x7 /* PASID-cache Invalidate Desc */
 352 #define VTD_INV_DESC_NONE               0   /* Not an Invalidate Descriptor */
 353
 354 /* Masks for Invalidation Wait Descriptor*/
 355 #define VTD_INV_DESC_WAIT_SW            (1ULL << 5)
 356 #define VTD_INV_DESC_WAIT_IF            (1ULL << 4)
 357 #define VTD_INV_DESC_WAIT_FN            (1ULL << 6)
 358 #define VTD_INV_DESC_WAIT_DATA_SHIFT    32
 359 #define VTD_INV_DESC_WAIT_RSVD_LO       0Xffffff80ULL
 360 #define VTD_INV_DESC_WAIT_RSVD_HI       3ULL
 361
 362 /* Masks for Context-cache Invalidation Descriptor */
 363 #define VTD_INV_DESC_CC_G               (3ULL << 4)
 364 #define VTD_INV_DESC_CC_GLOBAL          (1ULL << 4)
 365 #define VTD_INV_DESC_CC_DOMAIN          (2ULL << 4)
 366 #define VTD_INV_DESC_CC_DEVICE          (3ULL << 4)
 367 #define VTD_INV_DESC_CC_DID(val)        (((val) >> 16) & VTD_DOMAIN_ID_MASK)
 368 #define VTD_INV_DESC_CC_SID(val)        (((val) >> 32) & 0xffffUL)
 369 #define VTD_INV_DESC_CC_FM(val)         (((val) >> 48) & 3UL)
 370 #define VTD_INV_DESC_CC_RSVD            0xfffc00000000ffc0ULL
 371
 372 /* Masks for IOTLB Invalidate Descriptor */
 373 #define VTD_INV_DESC_IOTLB_G            (3ULL << 4)
 374 #define VTD_INV_DESC_IOTLB_GLOBAL       (1ULL << 4)
 375 #define VTD_INV_DESC_IOTLB_DOMAIN       (2ULL << 4)
 376 #define VTD_INV_DESC_IOTLB_PAGE         (3ULL << 4)
 377 #define VTD_INV_DESC_IOTLB_DID(val)     (((val) >> 16) & VTD_DOMAIN_ID_MASK)
 378 #define VTD_INV_DESC_IOTLB_ADDR(val)    ((val) & ~0xfffULL)
 379 #define VTD_INV_DESC_IOTLB_AM(val)      ((val) & 0x3fULL)
 380 #define VTD_INV_DESC_IOTLB_RSVD_LO      0xffffffff0000ff00ULL
 381 #define VTD_INV_DESC_IOTLB_RSVD_HI      0xf80ULL
 382
 383 /* Mask for Device IOTLB Invalidate Descriptor */
 384 #define VTD_INV_DESC_DEVICE_IOTLB_ADDR(val) ((val) & 0xfffffffffffff000ULL)
 385 #define VTD_INV_DESC_DEVICE_IOTLB_SIZE(val) ((val) & 0x1)
 386 #define VTD_INV_DESC_DEVICE_IOTLB_SID(val) (((val) >> 32) & 0xFFFFULL)
 387 #define VTD_INV_DESC_DEVICE_IOTLB_RSVD_HI 0xffeULL
 388 #define VTD_INV_DESC_DEVICE_IOTLB_RSVD_LO 0xffff0000ffe0fff8
 389
 390 /* Rsvd field masks for spte */
 391 #define VTD_SPTE_PAGE_L1_RSVD_MASK(aw, dt_supported) \
 392         dt_supported ? \
 393         (0x800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM | VTD_SL_TM)) : \
 394         (0x800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM))
 395 #define VTD_SPTE_PAGE_L2_RSVD_MASK(aw) \
 396         (0x800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM))
 397 #define VTD_SPTE_PAGE_L3_RSVD_MASK(aw) \
 398         (0x800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM))
 399 #define VTD_SPTE_PAGE_L4_RSVD_MASK(aw) \
 400         (0x880ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM))
 401
 402 #define VTD_SPTE_LPAGE_L2_RSVD_MASK(aw, dt_supported) \
 403         dt_supported ? \
 404         (0x1ff800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM | VTD_SL_TM)) : \
 405         (0x1ff800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM))
 406 #define VTD_SPTE_LPAGE_L3_RSVD_MASK(aw, dt_supported) \
 407         dt_supported ? \
 408         (0x3ffff800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM | VTD_SL_TM)) : \
 409         (0x3ffff800ULL | ~(VTD_HAW_MASK(aw) | VTD_SL_IGN_COM))
 410
 411 /* Information about page-selective IOTLB invalidate */
 412 struct VTDIOTLBPageInvInfo {
 413     uint16_t domain_id;
 414     uint64_t addr;
 415     uint8_t mask;
 416 };
 417 typedef struct VTDIOTLBPageInvInfo VTDIOTLBPageInvInfo;
 418
 419 /* Pagesize of VTD paging structures, including root and context tables */
 420 #define VTD_PAGE_SHIFT              12
 421 #define VTD_PAGE_SIZE               (1ULL << VTD_PAGE_SHIFT)
 422
 423 #define VTD_PAGE_SHIFT_4K           12
 424 #define VTD_PAGE_MASK_4K            (~((1ULL << VTD_PAGE_SHIFT_4K) - 1))
 425 #define VTD_PAGE_SHIFT_2M           21
 426 #define VTD_PAGE_MASK_2M            (~((1ULL << VTD_PAGE_SHIFT_2M) - 1))
 427 #define VTD_PAGE_SHIFT_1G           30
 428 #define VTD_PAGE_MASK_1G            (~((1ULL << VTD_PAGE_SHIFT_1G) - 1))
 429
 430 struct VTDRootEntry {
 431     uint64_t lo;
 432     uint64_t hi;
 433 };
 434 typedef struct VTDRootEntry VTDRootEntry;
 435
 436 /* Masks for struct VTDRootEntry */
 437 #define VTD_ROOT_ENTRY_P            1ULL
 438 #define VTD_ROOT_ENTRY_CTP          (~0xfffULL)
 439
 440 #define VTD_ROOT_ENTRY_NR           (VTD_PAGE_SIZE / sizeof(VTDRootEntry))
 441 #define VTD_ROOT_ENTRY_RSVD(aw)     (0xffeULL | ~VTD_HAW_MASK(aw))
 442
 443 #define VTD_DEVFN_CHECK_MASK        0x80
 444
 445 /* Masks for struct VTDContextEntry */
 446 /* lo */
 447 #define VTD_CONTEXT_ENTRY_P         (1ULL << 0)
 448 #define VTD_CONTEXT_ENTRY_FPD       (1ULL << 1) /* Fault Processing Disable */
 449 #define VTD_CONTEXT_ENTRY_TT        (3ULL << 2) /* Translation Type */
 450 #define VTD_CONTEXT_TT_MULTI_LEVEL  0
 451 #define VTD_CONTEXT_TT_DEV_IOTLB    (1ULL << 2)
 452 #define VTD_CONTEXT_TT_PASS_THROUGH (2ULL << 2)
 453 /* Second Level Page Translation Pointer*/
 454 #define VTD_CONTEXT_ENTRY_SLPTPTR   (~0xfffULL)
 455 #define VTD_CONTEXT_ENTRY_RSVD_LO(aw) (0xff0ULL | ~VTD_HAW_MASK(aw))
 456 /* hi */
 457 #define VTD_CONTEXT_ENTRY_AW        7ULL /* Adjusted guest-address-width */
 458 #define VTD_CONTEXT_ENTRY_DID(val)  (((val) >> 8) & VTD_DOMAIN_ID_MASK)
 459 #define VTD_CONTEXT_ENTRY_RSVD_HI   0xffffffffff000080ULL
 460
 461 #define VTD_CONTEXT_ENTRY_NR        (VTD_PAGE_SIZE / sizeof(VTDContextEntry))
 462
 463 #define VTD_CTX_ENTRY_LEGACY_SIZE     16
 464 #define VTD_CTX_ENTRY_SCALABLE_SIZE   32
 465
 466 #define VTD_SM_CONTEXT_ENTRY_RID2PASID_MASK 0xfffff
 467 #define VTD_SM_CONTEXT_ENTRY_RSVD_VAL0(aw)  (0x1e0ULL | ~VTD_HAW_MASK(aw))
 468 #define VTD_SM_CONTEXT_ENTRY_RSVD_VAL1      0xffffffffffe00000ULL
 469
 470 /* PASID Table Related Definitions */
 471 #define VTD_PASID_DIR_BASE_ADDR_MASK  (~0xfffULL)
 472 #define VTD_PASID_TABLE_BASE_ADDR_MASK (~0xfffULL)
 473 #define VTD_PASID_DIR_ENTRY_SIZE      8
 474 #define VTD_PASID_ENTRY_SIZE          64
 475 #define VTD_PASID_DIR_BITS_MASK       (0x3fffULL)
 476 #define VTD_PASID_DIR_INDEX(pasid)    (((pasid) >> 6) & VTD_PASID_DIR_BITS_MASK)
 477 #define VTD_PASID_DIR_FPD             (1ULL << 1) /* Fault Processing Disable */
 478 #define VTD_PASID_TABLE_BITS_MASK     (0x3fULL)
 479 #define VTD_PASID_TABLE_INDEX(pasid)  ((pasid) & VTD_PASID_TABLE_BITS_MASK)
 480 #define VTD_PASID_ENTRY_FPD           (1ULL << 1) /* Fault Processing Disable */
 481
 482 /* PASID Granular Translation Type Mask */
 483 #define VTD_PASID_ENTRY_P              1ULL
 484 #define VTD_SM_PASID_ENTRY_PGTT        (7ULL << 6)
 485 #define VTD_SM_PASID_ENTRY_FLT         (1ULL << 6)
 486 #define VTD_SM_PASID_ENTRY_SLT         (2ULL << 6)
 487 #define VTD_SM_PASID_ENTRY_NESTED      (3ULL << 6)
 488 #define VTD_SM_PASID_ENTRY_PT          (4ULL << 6)
 489
 490 #define VTD_SM_PASID_ENTRY_AW          7ULL /* Adjusted guest-address-width */
 491 #define VTD_SM_PASID_ENTRY_DID(val)    ((val) & VTD_DOMAIN_ID_MASK)
 492
 493 /* Second Level Page Translation Pointer*/
 494 #define VTD_SM_PASID_ENTRY_SLPTPTR     (~0xfffULL)
 495
 496 /* Paging Structure common */
 497 #define VTD_SL_PT_PAGE_SIZE_MASK    (1ULL << 7)
 498 /* Bits to decide the offset for each level */
 499 #define VTD_SL_LEVEL_BITS           9
 500
 501 /* Second Level Paging Structure */
 502 #define VTD_SL_PML4_LEVEL           4
 503 #define VTD_SL_PDP_LEVEL            3
 504 #define VTD_SL_PD_LEVEL             2
 505 #define VTD_SL_PT_LEVEL             1
 506 #define VTD_SL_PT_ENTRY_NR          512
 507
 508 /* Masks for Second Level Paging Entry */
 509 #define VTD_SL_RW_MASK              3ULL
 510 #define VTD_SL_R                    1ULL
 511 #define VTD_SL_W                    (1ULL << 1)
 512 #define VTD_SL_PT_BASE_ADDR_MASK(aw) (~(VTD_PAGE_SIZE - 1) & VTD_HAW_MASK(aw))
 513 #define VTD_SL_IGN_COM              0xbff0000000000000ULL
 514 #define VTD_SL_TM                   (1ULL << 62)
 515
 516 #endif