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
 114 /* IOTLB_REG */
 115 #define VTD_TLB_GLOBAL_FLUSH        (1ULL << 60) /* Global invalidation */
 116 #define VTD_TLB_DSI_FLUSH           (2ULL << 60) /* Domain-selective */
 117 #define VTD_TLB_PSI_FLUSH           (3ULL << 60) /* Page-selective */
 118 #define VTD_TLB_FLUSH_GRANU_MASK    (3ULL << 60)
 119 #define VTD_TLB_GLOBAL_FLUSH_A      (1ULL << 57)
 120 #define VTD_TLB_DSI_FLUSH_A         (2ULL << 57)
 121 #define VTD_TLB_PSI_FLUSH_A         (3ULL << 57)
 122 #define VTD_TLB_FLUSH_GRANU_MASK_A  (3ULL << 57)
 123 #define VTD_TLB_IVT                 (1ULL << 63)
 124
 125 /* GCMD_REG */
 126 #define VTD_GCMD_TE                 (1UL << 31)
 127 #define VTD_GCMD_SRTP               (1UL << 30)
 128 #define VTD_GCMD_SFL                (1UL << 29)
 129 #define VTD_GCMD_EAFL               (1UL << 28)
 130 #define VTD_GCMD_WBF                (1UL << 27)
 131 #define VTD_GCMD_QIE                (1UL << 26)
 132 #define VTD_GCMD_IRE                (1UL << 25)
 133 #define VTD_GCMD_SIRTP              (1UL << 24)
 134 #define VTD_GCMD_CFI                (1UL << 23)
 135
 136 /* GSTS_REG */
 137 #define VTD_GSTS_TES                (1UL << 31)
 138 #define VTD_GSTS_RTPS               (1UL << 30)
 139 #define VTD_GSTS_FLS                (1UL << 29)
 140 #define VTD_GSTS_AFLS               (1UL << 28)
 141 #define VTD_GSTS_WBFS               (1UL << 27)
 142 #define VTD_GSTS_QIES               (1UL << 26)
 143 #define VTD_GSTS_IRES               (1UL << 25)
 144 #define VTD_GSTS_IRTPS              (1UL << 24)
 145 #define VTD_GSTS_CFIS               (1UL << 23)
 146
 147 /* CCMD_REG */
 148 #define VTD_CCMD_ICC                (1ULL << 63)
 149 #define VTD_CCMD_GLOBAL_INVL        (1ULL << 61)
 150 #define VTD_CCMD_DOMAIN_INVL        (2ULL << 61)
 151 #define VTD_CCMD_DEVICE_INVL        (3ULL << 61)
 152 #define VTD_CCMD_CIRG_MASK          (3ULL << 61)
 153 #define VTD_CCMD_GLOBAL_INVL_A      (1ULL << 59)
 154 #define VTD_CCMD_DOMAIN_INVL_A      (2ULL << 59)
 155 #define VTD_CCMD_DEVICE_INVL_A      (3ULL << 59)
 156 #define VTD_CCMD_CAIG_MASK          (3ULL << 59)
 157
 158 /* RTADDR_REG */
 159 #define VTD_RTADDR_RTT              (1ULL << 11)
 160 #define VTD_RTADDR_ADDR_MASK        (VTD_HAW_MASK ^ 0xfffULL)
 161
 162 /* ECAP_REG */
 163 /* (offset >> 4) << 8 */
 164 #define VTD_ECAP_IRO                (DMAR_IOTLB_REG_OFFSET << 4)
 165 #define VTD_ECAP_QI                 (1ULL << 1)
 166
 167 /* CAP_REG */
 168 /* (offset >> 4) << 24 */
 169 #define VTD_CAP_FRO                 (DMAR_FRCD_REG_OFFSET << 20)
 170 #define VTD_CAP_NFR                 ((DMAR_FRCD_REG_NR - 1) << 40)
 171 #define VTD_DOMAIN_ID_SHIFT         16  /* 16-bit domain id for 64K domains */
 172 #define VTD_CAP_ND                  (((VTD_DOMAIN_ID_SHIFT - 4) / 2) & 7ULL)
 173 #define VTD_MGAW                    39  /* Maximum Guest Address Width */
 174 #define VTD_CAP_MGAW                (((VTD_MGAW - 1) & 0x3fULL) << 16)
 175
 176 /* Supported Adjusted Guest Address Widths */
 177 #define VTD_CAP_SAGAW_SHIFT         8
 178 #define VTD_CAP_SAGAW_MASK          (0x1fULL << VTD_CAP_SAGAW_SHIFT)
 179  /* 39-bit AGAW, 3-level page-table */
 180 #define VTD_CAP_SAGAW_39bit         (0x2ULL << VTD_CAP_SAGAW_SHIFT)
 181  /* 48-bit AGAW, 4-level page-table */
 182 #define VTD_CAP_SAGAW_48bit         (0x4ULL << VTD_CAP_SAGAW_SHIFT)
 183 #define VTD_CAP_SAGAW               VTD_CAP_SAGAW_39bit
 184
 185 /* IQT_REG */
 186 #define VTD_IQT_QT(val)             (((val) >> 4) & 0x7fffULL)
 187
 188 /* IQA_REG */
 189 #define VTD_IQA_IQA_MASK            (VTD_HAW_MASK ^ 0xfffULL)
 190 #define VTD_IQA_QS                  0x7ULL
 191
 192 /* IQH_REG */
 193 #define VTD_IQH_QH_SHIFT            4
 194 #define VTD_IQH_QH_MASK             0x7fff0ULL
 195
 196 /* ICS_REG */
 197 #define VTD_ICS_IWC                 1UL
 198
 199 /* IECTL_REG */
 200 #define VTD_IECTL_IM                (1UL << 31)
 201 #define VTD_IECTL_IP                (1UL << 30)
 202
 203 /* FSTS_REG */
 204 #define VTD_FSTS_FRI_MASK       0xff00UL
 205 #define VTD_FSTS_FRI(val)       ((((uint32_t)(val)) << 8) & VTD_FSTS_FRI_MASK)
 206 #define VTD_FSTS_IQE            (1UL << 4)
 207 #define VTD_FSTS_PPF            (1UL << 1)
 208 #define VTD_FSTS_PFO            1UL
 209
 210 /* FECTL_REG */
 211 #define VTD_FECTL_IM            (1UL << 31)
 212 #define VTD_FECTL_IP            (1UL << 30)
 213
 214 /* Fault Recording Register */
 215 /* For the high 64-bit of 128-bit */
 216 #define VTD_FRCD_F              (1ULL << 63)
 217 #define VTD_FRCD_T              (1ULL << 62)
 218 #define VTD_FRCD_FR(val)        (((val) & 0xffULL) << 32)
 219 #define VTD_FRCD_SID_MASK       0xffffULL
 220 #define VTD_FRCD_SID(val)       ((val) & VTD_FRCD_SID_MASK)
 221 /* For the low 64-bit of 128-bit */
 222 #define VTD_FRCD_FI(val)        ((val) & (((1ULL << VTD_MGAW) - 1) ^ 0xfffULL))
 223
 224 /* DMA Remapping Fault Conditions */
 225 typedef enum VTDFaultReason {
 226     VTD_FR_RESERVED = 0,        /* Reserved for Advanced Fault logging */
 227     VTD_FR_ROOT_ENTRY_P = 1,    /* The Present(P) field of root-entry is 0 */
 228     VTD_FR_CONTEXT_ENTRY_P,     /* The Present(P) field of context-entry is 0 */
 229     VTD_FR_CONTEXT_ENTRY_INV,   /* Invalid programming of a context-entry */
 230     VTD_FR_ADDR_BEYOND_MGAW,    /* Input-address above (2^x-1) */
 231     VTD_FR_WRITE,               /* No write permission */
 232     VTD_FR_READ,                /* No read permission */
 233     /* Fail to access a second-level paging entry (not SL_PML4E) */
 234     VTD_FR_PAGING_ENTRY_INV,
 235     VTD_FR_ROOT_TABLE_INV,      /* Fail to access a root-entry */
 236     VTD_FR_CONTEXT_TABLE_INV,   /* Fail to access a context-entry */
 237     /* Non-zero reserved field in a present root-entry */
 238     VTD_FR_ROOT_ENTRY_RSVD,
 239     /* Non-zero reserved field in a present context-entry */
 240     VTD_FR_CONTEXT_ENTRY_RSVD,
 241     /* Non-zero reserved field in a second-level paging entry with at lease one
 242      * Read(R) and Write(W) or Execute(E) field is Set.
 243      */
 244     VTD_FR_PAGING_ENTRY_RSVD,
 245     /* Translation request or translated request explicitly blocked dut to the
 246      * programming of the Translation Type (T) field in the present
 247      * context-entry.
 248      */
 249     VTD_FR_CONTEXT_ENTRY_TT,
 250     /* This is not a normal fault reason. We use this to indicate some faults
 251      * that are not referenced by the VT-d specification.
 252      * Fault event with such reason should not be recorded.
 253      */
 254     VTD_FR_RESERVED_ERR,
 255     VTD_FR_MAX,                 /* Guard */
 256 } VTDFaultReason;
 257
 258 /* Masks for Queued Invalidation Descriptor */
 259 #define VTD_INV_DESC_TYPE           0xf
 260 #define VTD_INV_DESC_CC             0x1 /* Context-cache Invalidate Desc */
 261 #define VTD_INV_DESC_IOTLB          0x2
 262 #define VTD_INV_DESC_WAIT           0x5 /* Invalidation Wait Descriptor */
 263 #define VTD_INV_DESC_NONE           0   /* Not an Invalidate Descriptor */
 264
 265 /* Pagesize of VTD paging structures, including root and context tables */
 266 #define VTD_PAGE_SHIFT              12
 267 #define VTD_PAGE_SIZE               (1ULL << VTD_PAGE_SHIFT)
 268
 269 #define VTD_PAGE_SHIFT_4K           12
 270 #define VTD_PAGE_MASK_4K            (~((1ULL << VTD_PAGE_SHIFT_4K) - 1))
 271 #define VTD_PAGE_SHIFT_2M           21
 272 #define VTD_PAGE_MASK_2M            (~((1ULL << VTD_PAGE_SHIFT_2M) - 1))
 273 #define VTD_PAGE_SHIFT_1G           30
 274 #define VTD_PAGE_MASK_1G            (~((1ULL << VTD_PAGE_SHIFT_1G) - 1))
 275
 276 struct VTDRootEntry {
 277     uint64_t val;
 278     uint64_t rsvd;
 279 };
 280 typedef struct VTDRootEntry VTDRootEntry;
 281
 282 /* Masks for struct VTDRootEntry */
 283 #define VTD_ROOT_ENTRY_P            1ULL
 284 #define VTD_ROOT_ENTRY_CTP          (~0xfffULL)
 285
 286 #define VTD_ROOT_ENTRY_NR           (VTD_PAGE_SIZE / sizeof(VTDRootEntry))
 287 #define VTD_ROOT_ENTRY_RSVD         (0xffeULL | ~VTD_HAW_MASK)
 288
 289 /* Context-Entry */
 290 struct VTDContextEntry {
 291     uint64_t lo;
 292     uint64_t hi;
 293 };
 294 typedef struct VTDContextEntry VTDContextEntry;
 295
 296 /* Masks for struct VTDContextEntry */
 297 /* lo */
 298 #define VTD_CONTEXT_ENTRY_P         (1ULL << 0)
 299 #define VTD_CONTEXT_ENTRY_FPD       (1ULL << 1) /* Fault Processing Disable */
 300 #define VTD_CONTEXT_ENTRY_TT        (3ULL << 2) /* Translation Type */
 301 #define VTD_CONTEXT_TT_MULTI_LEVEL  0
 302 #define VTD_CONTEXT_TT_DEV_IOTLB    1
 303 #define VTD_CONTEXT_TT_PASS_THROUGH 2
 304 /* Second Level Page Translation Pointer*/
 305 #define VTD_CONTEXT_ENTRY_SLPTPTR   (~0xfffULL)
 306 #define VTD_CONTEXT_ENTRY_RSVD_LO   (0xff0ULL | ~VTD_HAW_MASK)
 307 /* hi */
 308 #define VTD_CONTEXT_ENTRY_AW        7ULL /* Adjusted guest-address-width */
 309 #define VTD_CONTEXT_ENTRY_DID       (0xffffULL << 8) /* Domain Identifier */
 310 #define VTD_CONTEXT_ENTRY_RSVD_HI   0xffffffffff000080ULL
 311
 312 #define VTD_CONTEXT_ENTRY_NR        (VTD_PAGE_SIZE / sizeof(VTDContextEntry))
 313
 314 /* Paging Structure common */
 315 #define VTD_SL_PT_PAGE_SIZE_MASK    (1ULL << 7)
 316 /* Bits to decide the offset for each level */
 317 #define VTD_SL_LEVEL_BITS           9
 318
 319 /* Second Level Paging Structure */
 320 #define VTD_SL_PML4_LEVEL           4
 321 #define VTD_SL_PDP_LEVEL            3
 322 #define VTD_SL_PD_LEVEL             2
 323 #define VTD_SL_PT_LEVEL             1
 324 #define VTD_SL_PT_ENTRY_NR          512
 325
 326 /* Masks for Second Level Paging Entry */
 327 #define VTD_SL_RW_MASK              3ULL
 328 #define VTD_SL_R                    1ULL
 329 #define VTD_SL_W                    (1ULL << 1)
 330 #define VTD_SL_PT_BASE_ADDR_MASK    (~(VTD_PAGE_SIZE - 1) & VTD_HAW_MASK)
 331 #define VTD_SL_IGN_COM              0xbff0000000000000ULL
 332
 333 #endif