include/linux/intel-iommu.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright © 2006-2015, Intel Corporation.
   4  *
   5  * Authors: Ashok Raj <ashok.raj@intel.com>
   6  *          Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
   7  *          David Woodhouse <David.Woodhouse@intel.com>
   8  */
   9
  10 #ifndef _INTEL_IOMMU_H_
  11 #define _INTEL_IOMMU_H_
  12
  13 #include <linux/types.h>
  14 #include <linux/iova.h>
  15 #include <linux/io.h>
  16 #include <linux/idr.h>
  17 #include <linux/mmu_notifier.h>
  18 #include <linux/list.h>
  19 #include <linux/iommu.h>
  20 #include <linux/io-64-nonatomic-lo-hi.h>
  21 #include <linux/dmar.h>
  22 #include <linux/ioasid.h>
  23
  24 #include <asm/cacheflush.h>
  25 #include <asm/iommu.h>
  26
  27 /*
  28  * VT-d hardware uses 4KiB page size regardless of host page size.
  29  */
  30 #define VTD_PAGE_SHIFT          (12)
  31 #define VTD_PAGE_SIZE           (1UL << VTD_PAGE_SHIFT)
  32 #define VTD_PAGE_MASK           (((u64)-1) << VTD_PAGE_SHIFT)
  33 #define VTD_PAGE_ALIGN(addr)    (((addr) + VTD_PAGE_SIZE - 1) & VTD_PAGE_MASK)
  34
  35 #define VTD_STRIDE_SHIFT        (9)
  36 #define VTD_STRIDE_MASK         (((u64)-1) << VTD_STRIDE_SHIFT)
  37
  38 #define DMA_PTE_READ            BIT_ULL(0)
  39 #define DMA_PTE_WRITE           BIT_ULL(1)
  40 #define DMA_PTE_LARGE_PAGE      BIT_ULL(7)
  41 #define DMA_PTE_SNP             BIT_ULL(11)
  42
  43 #define DMA_FL_PTE_PRESENT      BIT_ULL(0)
  44 #define DMA_FL_PTE_US           BIT_ULL(2)
  45 #define DMA_FL_PTE_ACCESS       BIT_ULL(5)
  46 #define DMA_FL_PTE_DIRTY        BIT_ULL(6)
  47 #define DMA_FL_PTE_XD           BIT_ULL(63)
  48
  49 #define ADDR_WIDTH_5LEVEL       (57)
  50 #define ADDR_WIDTH_4LEVEL       (48)
  51
  52 #define CONTEXT_TT_MULTI_LEVEL  0
  53 #define CONTEXT_TT_DEV_IOTLB    1
  54 #define CONTEXT_TT_PASS_THROUGH 2
  55 #define CONTEXT_PASIDE          BIT_ULL(3)
  56
  57 /*
  58  * Intel IOMMU register specification per version 1.0 public spec.
  59  */
  60 #define DMAR_VER_REG    0x0     /* Arch version supported by this IOMMU */
  61 #define DMAR_CAP_REG    0x8     /* Hardware supported capabilities */
  62 #define DMAR_ECAP_REG   0x10    /* Extended capabilities supported */
  63 #define DMAR_GCMD_REG   0x18    /* Global command register */
  64 #define DMAR_GSTS_REG   0x1c    /* Global status register */
  65 #define DMAR_RTADDR_REG 0x20    /* Root entry table */
  66 #define DMAR_CCMD_REG   0x28    /* Context command reg */
  67 #define DMAR_FSTS_REG   0x34    /* Fault Status register */
  68 #define DMAR_FECTL_REG  0x38    /* Fault control register */
  69 #define DMAR_FEDATA_REG 0x3c    /* Fault event interrupt data register */
  70 #define DMAR_FEADDR_REG 0x40    /* Fault event interrupt addr register */
  71 #define DMAR_FEUADDR_REG 0x44   /* Upper address register */
  72 #define DMAR_AFLOG_REG  0x58    /* Advanced Fault control */
  73 #define DMAR_PMEN_REG   0x64    /* Enable Protected Memory Region */
  74 #define DMAR_PLMBASE_REG 0x68   /* PMRR Low addr */
  75 #define DMAR_PLMLIMIT_REG 0x6c  /* PMRR low limit */
  76 #define DMAR_PHMBASE_REG 0x70   /* pmrr high base addr */
  77 #define DMAR_PHMLIMIT_REG 0x78  /* pmrr high limit */
  78 #define DMAR_IQH_REG    0x80    /* Invalidation queue head register */
  79 #define DMAR_IQT_REG    0x88    /* Invalidation queue tail register */
  80 #define DMAR_IQ_SHIFT   4       /* Invalidation queue head/tail shift */
  81 #define DMAR_IQA_REG    0x90    /* Invalidation queue addr register */
  82 #define DMAR_ICS_REG    0x9c    /* Invalidation complete status register */
  83 #define DMAR_IRTA_REG   0xb8    /* Interrupt remapping table addr register */
  84 #define DMAR_PQH_REG    0xc0    /* Page request queue head register */
  85 #define DMAR_PQT_REG    0xc8    /* Page request queue tail register */
  86 #define DMAR_PQA_REG    0xd0    /* Page request queue address register */
  87 #define DMAR_PRS_REG    0xdc    /* Page request status register */
  88 #define DMAR_PECTL_REG  0xe0    /* Page request event control register */
  89 #define DMAR_PEDATA_REG 0xe4    /* Page request event interrupt data register */
  90 #define DMAR_PEADDR_REG 0xe8    /* Page request event interrupt addr register */
  91 #define DMAR_PEUADDR_REG 0xec   /* Page request event Upper address register */
  92 #define DMAR_MTRRCAP_REG 0x100  /* MTRR capability register */
  93 #define DMAR_MTRRDEF_REG 0x108  /* MTRR default type register */
  94 #define DMAR_MTRR_FIX64K_00000_REG 0x120 /* MTRR Fixed range registers */
  95 #define DMAR_MTRR_FIX16K_80000_REG 0x128
  96 #define DMAR_MTRR_FIX16K_A0000_REG 0x130
  97 #define DMAR_MTRR_FIX4K_C0000_REG 0x138
  98 #define DMAR_MTRR_FIX4K_C8000_REG 0x140
  99 #define DMAR_MTRR_FIX4K_D0000_REG 0x148
 100 #define DMAR_MTRR_FIX4K_D8000_REG 0x150
 101 #define DMAR_MTRR_FIX4K_E0000_REG 0x158
 102 #define DMAR_MTRR_FIX4K_E8000_REG 0x160
 103 #define DMAR_MTRR_FIX4K_F0000_REG 0x168
 104 #define DMAR_MTRR_FIX4K_F8000_REG 0x170
 105 #define DMAR_MTRR_PHYSBASE0_REG 0x180 /* MTRR Variable range registers */
 106 #define DMAR_MTRR_PHYSMASK0_REG 0x188
 107 #define DMAR_MTRR_PHYSBASE1_REG 0x190
 108 #define DMAR_MTRR_PHYSMASK1_REG 0x198
 109 #define DMAR_MTRR_PHYSBASE2_REG 0x1a0
 110 #define DMAR_MTRR_PHYSMASK2_REG 0x1a8
 111 #define DMAR_MTRR_PHYSBASE3_REG 0x1b0
 112 #define DMAR_MTRR_PHYSMASK3_REG 0x1b8
 113 #define DMAR_MTRR_PHYSBASE4_REG 0x1c0
 114 #define DMAR_MTRR_PHYSMASK4_REG 0x1c8
 115 #define DMAR_MTRR_PHYSBASE5_REG 0x1d0
 116 #define DMAR_MTRR_PHYSMASK5_REG 0x1d8
 117 #define DMAR_MTRR_PHYSBASE6_REG 0x1e0
 118 #define DMAR_MTRR_PHYSMASK6_REG 0x1e8
 119 #define DMAR_MTRR_PHYSBASE7_REG 0x1f0
 120 #define DMAR_MTRR_PHYSMASK7_REG 0x1f8
 121 #define DMAR_MTRR_PHYSBASE8_REG 0x200
 122 #define DMAR_MTRR_PHYSMASK8_REG 0x208
 123 #define DMAR_MTRR_PHYSBASE9_REG 0x210
 124 #define DMAR_MTRR_PHYSMASK9_REG 0x218
 125 #define DMAR_VCCAP_REG          0xe00 /* Virtual command capability register */
 126 #define DMAR_VCMD_REG           0xe10 /* Virtual command register */
 127 #define DMAR_VCRSP_REG          0xe20 /* Virtual command response register */
 128
 129 #define OFFSET_STRIDE           (9)
 130
 131 #define dmar_readq(a) readq(a)
 132 #define dmar_writeq(a,v) writeq(v,a)
 133 #define dmar_readl(a) readl(a)
 134 #define dmar_writel(a, v) writel(v, a)
 135
 136 #define DMAR_VER_MAJOR(v)               (((v) & 0xf0) >> 4)
 137 #define DMAR_VER_MINOR(v)               ((v) & 0x0f)
 138
 139 /*
 140  * Decoding Capability Register
 141  */
 142 #define cap_5lp_support(c)      (((c) >> 60) & 1)
 143 #define cap_pi_support(c)       (((c) >> 59) & 1)
 144 #define cap_fl1gp_support(c)    (((c) >> 56) & 1)
 145 #define cap_read_drain(c)       (((c) >> 55) & 1)
 146 #define cap_write_drain(c)      (((c) >> 54) & 1)
 147 #define cap_max_amask_val(c)    (((c) >> 48) & 0x3f)
 148 #define cap_num_fault_regs(c)   ((((c) >> 40) & 0xff) + 1)
 149 #define cap_pgsel_inv(c)        (((c) >> 39) & 1)
 150
 151 #define cap_super_page_val(c)   (((c) >> 34) & 0xf)
 152 #define cap_super_offset(c)     (((find_first_bit(&cap_super_page_val(c), 4)) \
 153                                         * OFFSET_STRIDE) + 21)
 154
 155 #define cap_fault_reg_offset(c) ((((c) >> 24) & 0x3ff) * 16)
 156 #define cap_max_fault_reg_offset(c) \
 157         (cap_fault_reg_offset(c) + cap_num_fault_regs(c) * 16)
 158
 159 #define cap_zlr(c)              (((c) >> 22) & 1)
 160 #define cap_isoch(c)            (((c) >> 23) & 1)
 161 #define cap_mgaw(c)             ((((c) >> 16) & 0x3f) + 1)
 162 #define cap_sagaw(c)            (((c) >> 8) & 0x1f)
 163 #define cap_caching_mode(c)     (((c) >> 7) & 1)
 164 #define cap_phmr(c)             (((c) >> 6) & 1)
 165 #define cap_plmr(c)             (((c) >> 5) & 1)
 166 #define cap_rwbf(c)             (((c) >> 4) & 1)
 167 #define cap_afl(c)              (((c) >> 3) & 1)
 168 #define cap_ndoms(c)            (((unsigned long)1) << (4 + 2 * ((c) & 0x7)))
 169 /*
 170  * Extended Capability Register
 171  */
 172
 173 #define ecap_rps(e)             (((e) >> 49) & 0x1)
 174 #define ecap_smpwc(e)           (((e) >> 48) & 0x1)
 175 #define ecap_flts(e)            (((e) >> 47) & 0x1)
 176 #define ecap_slts(e)            (((e) >> 46) & 0x1)
 177 #define ecap_slads(e)           (((e) >> 45) & 0x1)
 178 #define ecap_vcs(e)             (((e) >> 44) & 0x1)
 179 #define ecap_smts(e)            (((e) >> 43) & 0x1)
 180 #define ecap_dit(e)             (((e) >> 41) & 0x1)
 181 #define ecap_pds(e)             (((e) >> 42) & 0x1)
 182 #define ecap_pasid(e)           (((e) >> 40) & 0x1)
 183 #define ecap_pss(e)             (((e) >> 35) & 0x1f)
 184 #define ecap_eafs(e)            (((e) >> 34) & 0x1)
 185 #define ecap_nwfs(e)            (((e) >> 33) & 0x1)
 186 #define ecap_srs(e)             (((e) >> 31) & 0x1)
 187 #define ecap_ers(e)             (((e) >> 30) & 0x1)
 188 #define ecap_prs(e)             (((e) >> 29) & 0x1)
 189 #define ecap_broken_pasid(e)    (((e) >> 28) & 0x1)
 190 #define ecap_dis(e)             (((e) >> 27) & 0x1)
 191 #define ecap_nest(e)            (((e) >> 26) & 0x1)
 192 #define ecap_mts(e)             (((e) >> 25) & 0x1)
 193 #define ecap_ecs(e)             (((e) >> 24) & 0x1)
 194 #define ecap_iotlb_offset(e)    ((((e) >> 8) & 0x3ff) * 16)
 195 #define ecap_max_iotlb_offset(e) (ecap_iotlb_offset(e) + 16)
 196 #define ecap_coherent(e)        ((e) & 0x1)
 197 #define ecap_qis(e)             ((e) & 0x2)
 198 #define ecap_pass_through(e)    (((e) >> 6) & 0x1)
 199 #define ecap_eim_support(e)     (((e) >> 4) & 0x1)
 200 #define ecap_ir_support(e)      (((e) >> 3) & 0x1)
 201 #define ecap_dev_iotlb_support(e)       (((e) >> 2) & 0x1)
 202 #define ecap_max_handle_mask(e) (((e) >> 20) & 0xf)
 203 #define ecap_sc_support(e)      (((e) >> 7) & 0x1) /* Snooping Control */
 204
 205 /* Virtual command interface capability */
 206 #define vccap_pasid(v)          (((v) & DMA_VCS_PAS)) /* PASID allocation */
 207
 208 /* IOTLB_REG */
 209 #define DMA_TLB_FLUSH_GRANU_OFFSET  60
 210 #define DMA_TLB_GLOBAL_FLUSH (((u64)1) << 60)
 211 #define DMA_TLB_DSI_FLUSH (((u64)2) << 60)
 212 #define DMA_TLB_PSI_FLUSH (((u64)3) << 60)
 213 #define DMA_TLB_IIRG(type) ((type >> 60) & 3)
 214 #define DMA_TLB_IAIG(val) (((val) >> 57) & 3)
 215 #define DMA_TLB_READ_DRAIN (((u64)1) << 49)
 216 #define DMA_TLB_WRITE_DRAIN (((u64)1) << 48)
 217 #define DMA_TLB_DID(id) (((u64)((id) & 0xffff)) << 32)
 218 #define DMA_TLB_IVT (((u64)1) << 63)
 219 #define DMA_TLB_IH_NONLEAF (((u64)1) << 6)
 220 #define DMA_TLB_MAX_SIZE (0x3f)
 221
 222 /* INVALID_DESC */
 223 #define DMA_CCMD_INVL_GRANU_OFFSET  61
 224 #define DMA_ID_TLB_GLOBAL_FLUSH (((u64)1) << 4)
 225 #define DMA_ID_TLB_DSI_FLUSH    (((u64)2) << 4)
 226 #define DMA_ID_TLB_PSI_FLUSH    (((u64)3) << 4)
 227 #define DMA_ID_TLB_READ_DRAIN   (((u64)1) << 7)
 228 #define DMA_ID_TLB_WRITE_DRAIN  (((u64)1) << 6)
 229 #define DMA_ID_TLB_DID(id)      (((u64)((id & 0xffff) << 16)))
 230 #define DMA_ID_TLB_IH_NONLEAF   (((u64)1) << 6)
 231 #define DMA_ID_TLB_ADDR(addr)   (addr)
 232 #define DMA_ID_TLB_ADDR_MASK(mask)      (mask)
 233
 234 /* PMEN_REG */
 235 #define DMA_PMEN_EPM (((u32)1)<<31)
 236 #define DMA_PMEN_PRS (((u32)1)<<0)
 237
 238 /* GCMD_REG */
 239 #define DMA_GCMD_TE (((u32)1) << 31)
 240 #define DMA_GCMD_SRTP (((u32)1) << 30)
 241 #define DMA_GCMD_SFL (((u32)1) << 29)
 242 #define DMA_GCMD_EAFL (((u32)1) << 28)
 243 #define DMA_GCMD_WBF (((u32)1) << 27)
 244 #define DMA_GCMD_QIE (((u32)1) << 26)
 245 #define DMA_GCMD_SIRTP (((u32)1) << 24)
 246 #define DMA_GCMD_IRE (((u32) 1) << 25)
 247 #define DMA_GCMD_CFI (((u32) 1) << 23)
 248
 249 /* GSTS_REG */
 250 #define DMA_GSTS_TES (((u32)1) << 31)
 251 #define DMA_GSTS_RTPS (((u32)1) << 30)
 252 #define DMA_GSTS_FLS (((u32)1) << 29)
 253 #define DMA_GSTS_AFLS (((u32)1) << 28)
 254 #define DMA_GSTS_WBFS (((u32)1) << 27)
 255 #define DMA_GSTS_QIES (((u32)1) << 26)
 256 #define DMA_GSTS_IRTPS (((u32)1) << 24)
 257 #define DMA_GSTS_IRES (((u32)1) << 25)
 258 #define DMA_GSTS_CFIS (((u32)1) << 23)
 259
 260 /* DMA_RTADDR_REG */
 261 #define DMA_RTADDR_RTT (((u64)1) << 11)
 262 #define DMA_RTADDR_SMT (((u64)1) << 10)
 263
 264 /* CCMD_REG */
 265 #define DMA_CCMD_ICC (((u64)1) << 63)
 266 #define DMA_CCMD_GLOBAL_INVL (((u64)1) << 61)
 267 #define DMA_CCMD_DOMAIN_INVL (((u64)2) << 61)
 268 #define DMA_CCMD_DEVICE_INVL (((u64)3) << 61)
 269 #define DMA_CCMD_FM(m) (((u64)((m) & 0x3)) << 32)
 270 #define DMA_CCMD_MASK_NOBIT 0
 271 #define DMA_CCMD_MASK_1BIT 1
 272 #define DMA_CCMD_MASK_2BIT 2
 273 #define DMA_CCMD_MASK_3BIT 3
 274 #define DMA_CCMD_SID(s) (((u64)((s) & 0xffff)) << 16)
 275 #define DMA_CCMD_DID(d) ((u64)((d) & 0xffff))
 276
 277 /* FECTL_REG */
 278 #define DMA_FECTL_IM (((u32)1) << 31)
 279
 280 /* FSTS_REG */
 281 #define DMA_FSTS_PFO (1 << 0) /* Primary Fault Overflow */
 282 #define DMA_FSTS_PPF (1 << 1) /* Primary Pending Fault */
 283 #define DMA_FSTS_IQE (1 << 4) /* Invalidation Queue Error */
 284 #define DMA_FSTS_ICE (1 << 5) /* Invalidation Completion Error */
 285 #define DMA_FSTS_ITE (1 << 6) /* Invalidation Time-out Error */
 286 #define DMA_FSTS_PRO (1 << 7) /* Page Request Overflow */
 287 #define dma_fsts_fault_record_index(s) (((s) >> 8) & 0xff)
 288
 289 /* FRCD_REG, 32 bits access */
 290 #define DMA_FRCD_F (((u32)1) << 31)
 291 #define dma_frcd_type(d) ((d >> 30) & 1)
 292 #define dma_frcd_fault_reason(c) (c & 0xff)
 293 #define dma_frcd_source_id(c) (c & 0xffff)
 294 #define dma_frcd_pasid_value(c) (((c) >> 8) & 0xfffff)
 295 #define dma_frcd_pasid_present(c) (((c) >> 31) & 1)
 296 /* low 64 bit */
 297 #define dma_frcd_page_addr(d) (d & (((u64)-1) << PAGE_SHIFT))
 298
 299 /* PRS_REG */
 300 #define DMA_PRS_PPR     ((u32)1)
 301 #define DMA_PRS_PRO     ((u32)2)
 302
 303 #define DMA_VCS_PAS     ((u64)1)
 304
 305 #define IOMMU_WAIT_OP(iommu, offset, op, cond, sts)                     \
 306 do {                                                                    \
 307         cycles_t start_time = get_cycles();                             \
 308         while (1) {                                                     \
 309                 sts = op(iommu->reg + offset);                          \
 310                 if (cond)                                               \
 311                         break;                                          \
 312                 if (DMAR_OPERATION_TIMEOUT < (get_cycles() - start_time))\
 313                         panic("DMAR hardware is malfunctioning\n");     \
 314                 cpu_relax();                                            \
 315         }                                                               \
 316 } while (0)
 317
 318 #define QI_LENGTH       256     /* queue length */
 319
 320 enum {
 321         QI_FREE,
 322         QI_IN_USE,
 323         QI_DONE,
 324         QI_ABORT
 325 };
 326
 327 #define QI_CC_TYPE              0x1
 328 #define QI_IOTLB_TYPE           0x2
 329 #define QI_DIOTLB_TYPE          0x3
 330 #define QI_IEC_TYPE             0x4
 331 #define QI_IWD_TYPE             0x5
 332 #define QI_EIOTLB_TYPE          0x6
 333 #define QI_PC_TYPE              0x7
 334 #define QI_DEIOTLB_TYPE         0x8
 335 #define QI_PGRP_RESP_TYPE       0x9
 336 #define QI_PSTRM_RESP_TYPE      0xa
 337
 338 #define QI_IEC_SELECTIVE        (((u64)1) << 4)
 339 #define QI_IEC_IIDEX(idx)       (((u64)(idx & 0xffff) << 32))
 340 #define QI_IEC_IM(m)            (((u64)(m & 0x1f) << 27))
 341
 342 #define QI_IWD_STATUS_DATA(d)   (((u64)d) << 32)
 343 #define QI_IWD_STATUS_WRITE     (((u64)1) << 5)
 344 #define QI_IWD_FENCE            (((u64)1) << 6)
 345 #define QI_IWD_PRQ_DRAIN        (((u64)1) << 7)
 346
 347 #define QI_IOTLB_DID(did)       (((u64)did) << 16)
 348 #define QI_IOTLB_DR(dr)         (((u64)dr) << 7)
 349 #define QI_IOTLB_DW(dw)         (((u64)dw) << 6)
 350 #define QI_IOTLB_GRAN(gran)     (((u64)gran) >> (DMA_TLB_FLUSH_GRANU_OFFSET-4))
 351 #define QI_IOTLB_ADDR(addr)     (((u64)addr) & VTD_PAGE_MASK)
 352 #define QI_IOTLB_IH(ih)         (((u64)ih) << 6)
 353 #define QI_IOTLB_AM(am)         (((u8)am) & 0x3f)
 354
 355 #define QI_CC_FM(fm)            (((u64)fm) << 48)
 356 #define QI_CC_SID(sid)          (((u64)sid) << 32)
 357 #define QI_CC_DID(did)          (((u64)did) << 16)
 358 #define QI_CC_GRAN(gran)        (((u64)gran) >> (DMA_CCMD_INVL_GRANU_OFFSET-4))
 359
 360 #define QI_DEV_IOTLB_SID(sid)   ((u64)((sid) & 0xffff) << 32)
 361 #define QI_DEV_IOTLB_QDEP(qdep) (((qdep) & 0x1f) << 16)
 362 #define QI_DEV_IOTLB_ADDR(addr) ((u64)(addr) & VTD_PAGE_MASK)
 363 #define QI_DEV_IOTLB_PFSID(pfsid) (((u64)(pfsid & 0xf) << 12) | \
 364                                    ((u64)((pfsid >> 4) & 0xfff) << 52))
 365 #define QI_DEV_IOTLB_SIZE       1
 366 #define QI_DEV_IOTLB_MAX_INVS   32
 367
 368 #define QI_PC_PASID(pasid)      (((u64)pasid) << 32)
 369 #define QI_PC_DID(did)          (((u64)did) << 16)
 370 #define QI_PC_GRAN(gran)        (((u64)gran) << 4)
 371
 372 /* PASID cache invalidation granu */
 373 #define QI_PC_ALL_PASIDS        0
 374 #define QI_PC_PASID_SEL         1
 375
 376 #define QI_EIOTLB_ADDR(addr)    ((u64)(addr) & VTD_PAGE_MASK)
 377 #define QI_EIOTLB_IH(ih)        (((u64)ih) << 6)
 378 #define QI_EIOTLB_AM(am)        (((u64)am) & 0x3f)
 379 #define QI_EIOTLB_PASID(pasid)  (((u64)pasid) << 32)
 380 #define QI_EIOTLB_DID(did)      (((u64)did) << 16)
 381 #define QI_EIOTLB_GRAN(gran)    (((u64)gran) << 4)
 382
 383 /* QI Dev-IOTLB inv granu */
 384 #define QI_DEV_IOTLB_GRAN_ALL           1
 385 #define QI_DEV_IOTLB_GRAN_PASID_SEL     0
 386
 387 #define QI_DEV_EIOTLB_ADDR(a)   ((u64)(a) & VTD_PAGE_MASK)
 388 #define QI_DEV_EIOTLB_SIZE      (((u64)1) << 11)
 389 #define QI_DEV_EIOTLB_PASID(p)  ((u64)((p) & 0xfffff) << 32)
 390 #define QI_DEV_EIOTLB_SID(sid)  ((u64)((sid) & 0xffff) << 16)
 391 #define QI_DEV_EIOTLB_QDEP(qd)  ((u64)((qd) & 0x1f) << 4)
 392 #define QI_DEV_EIOTLB_PFSID(pfsid) (((u64)(pfsid & 0xf) << 12) | \
 393                                     ((u64)((pfsid >> 4) & 0xfff) << 52))
 394 #define QI_DEV_EIOTLB_MAX_INVS  32
 395
 396 /* Page group response descriptor QW0 */
 397 #define QI_PGRP_PASID_P(p)      (((u64)(p)) << 4)
 398 #define QI_PGRP_PDP(p)          (((u64)(p)) << 5)
 399 #define QI_PGRP_RESP_CODE(res)  (((u64)(res)) << 12)
 400 #define QI_PGRP_DID(rid)        (((u64)(rid)) << 16)
 401 #define QI_PGRP_PASID(pasid)    (((u64)(pasid)) << 32)
 402
 403 /* Page group response descriptor QW1 */
 404 #define QI_PGRP_LPIG(x)         (((u64)(x)) << 2)
 405 #define QI_PGRP_IDX(idx)        (((u64)(idx)) << 3)
 406
 407
 408 #define QI_RESP_SUCCESS         0x0
 409 #define QI_RESP_INVALID         0x1
 410 #define QI_RESP_FAILURE         0xf
 411
 412 #define QI_GRAN_NONG_PASID              2
 413 #define QI_GRAN_PSI_PASID               3
 414
 415 #define qi_shift(iommu)         (DMAR_IQ_SHIFT + !!ecap_smts((iommu)->ecap))
 416
 417 struct qi_desc {
 418         u64 qw0;
 419         u64 qw1;
 420         u64 qw2;
 421         u64 qw3;
 422 };
 423
 424 struct q_inval {
 425         raw_spinlock_t  q_lock;
 426         void            *desc;          /* invalidation queue */
 427         int             *desc_status;   /* desc status */
 428         int             free_head;      /* first free entry */
 429         int             free_tail;      /* last free entry */
 430         int             free_cnt;
 431 };
 432
 433 struct dmar_pci_notify_info;
 434
 435 #ifdef CONFIG_IRQ_REMAP
 436 /* 1MB - maximum possible interrupt remapping table size */
 437 #define INTR_REMAP_PAGE_ORDER   8
 438 #define INTR_REMAP_TABLE_REG_SIZE       0xf
 439 #define INTR_REMAP_TABLE_REG_SIZE_MASK  0xf
 440
 441 #define INTR_REMAP_TABLE_ENTRIES        65536
 442
 443 struct irq_domain;
 444
 445 struct ir_table {
 446         struct irte *base;
 447         unsigned long *bitmap;
 448 };
 449
 450 void intel_irq_remap_add_device(struct dmar_pci_notify_info *info);
 451 #else
 452 static inline void
 453 intel_irq_remap_add_device(struct dmar_pci_notify_info *info) { }
 454 #endif
 455
 456 struct iommu_flush {
 457         void (*flush_context)(struct intel_iommu *iommu, u16 did, u16 sid,
 458                               u8 fm, u64 type);
 459         void (*flush_iotlb)(struct intel_iommu *iommu, u16 did, u64 addr,
 460                             unsigned int size_order, u64 type);
 461 };
 462
 463 enum {
 464         SR_DMAR_FECTL_REG,
 465         SR_DMAR_FEDATA_REG,
 466         SR_DMAR_FEADDR_REG,
 467         SR_DMAR_FEUADDR_REG,
 468         MAX_SR_DMAR_REGS
 469 };
 470
 471 #define VTD_FLAG_TRANS_PRE_ENABLED      (1 << 0)
 472 #define VTD_FLAG_IRQ_REMAP_PRE_ENABLED  (1 << 1)
 473 #define VTD_FLAG_SVM_CAPABLE            (1 << 2)
 474
 475 extern int intel_iommu_sm;
 476 extern spinlock_t device_domain_lock;
 477
 478 #define sm_supported(iommu)     (intel_iommu_sm && ecap_smts((iommu)->ecap))
 479 #define pasid_supported(iommu)  (sm_supported(iommu) &&                 \
 480                                  ecap_pasid((iommu)->ecap))
 481
 482 struct pasid_entry;
 483 struct pasid_state_entry;
 484 struct page_req_dsc;
 485
 486 /*
 487  * 0: Present
 488  * 1-11: Reserved
 489  * 12-63: Context Ptr (12 - (haw-1))
 490  * 64-127: Reserved
 491  */
 492 struct root_entry {
 493         u64     lo;
 494         u64     hi;
 495 };
 496
 497 /*
 498  * low 64 bits:
 499  * 0: present
 500  * 1: fault processing disable
 501  * 2-3: translation type
 502  * 12-63: address space root
 503  * high 64 bits:
 504  * 0-2: address width
 505  * 3-6: aval
 506  * 8-23: domain id
 507  */
 508 struct context_entry {
 509         u64 lo;
 510         u64 hi;
 511 };
 512
 513 /* si_domain contains mulitple devices */
 514 #define DOMAIN_FLAG_STATIC_IDENTITY             BIT(0)
 515
 516 /*
 517  * When VT-d works in the scalable mode, it allows DMA translation to
 518  * happen through either first level or second level page table. This
 519  * bit marks that the DMA translation for the domain goes through the
 520  * first level page table, otherwise, it goes through the second level.
 521  */
 522 #define DOMAIN_FLAG_USE_FIRST_LEVEL             BIT(1)
 523
 524 /*
 525  * Domain represents a virtual machine which demands iommu nested
 526  * translation mode support.
 527  */
 528 #define DOMAIN_FLAG_NESTING_MODE                BIT(2)
 529
 530 struct dmar_domain {
 531         int     nid;                    /* node id */
 532
 533         unsigned        iommu_refcnt[DMAR_UNITS_SUPPORTED];
 534                                         /* Refcount of devices per iommu */
 535
 536
 537         u16             iommu_did[DMAR_UNITS_SUPPORTED];
 538                                         /* Domain ids per IOMMU. Use u16 since
 539                                          * domain ids are 16 bit wide according
 540                                          * to VT-d spec, section 9.3 */
 541
 542         bool has_iotlb_device;
 543         struct list_head devices;       /* all devices' list */
 544         struct list_head subdevices;    /* all subdevices' list */
 545         struct iova_domain iovad;       /* iova's that belong to this domain */
 546
 547         struct dma_pte  *pgd;           /* virtual address */
 548         int             gaw;            /* max guest address width */
 549
 550         /* adjusted guest address width, 0 is level 2 30-bit */
 551         int             agaw;
 552
 553         int             flags;          /* flags to find out type of domain */
 554
 555         int             iommu_coherency;/* indicate coherency of iommu access */
 556         int             iommu_snooping; /* indicate snooping control feature*/
 557         int             iommu_count;    /* reference count of iommu */
 558         int             iommu_superpage;/* Level of superpages supported:
 559                                            0 == 4KiB (no superpages), 1 == 2MiB,
 560                                            2 == 1GiB, 3 == 512GiB, 4 == 1TiB */
 561         u64             max_addr;       /* maximum mapped address */
 562
 563         u32             default_pasid;  /*
 564                                          * The default pasid used for non-SVM
 565                                          * traffic on mediated devices.
 566                                          */
 567
 568         struct iommu_domain domain;     /* generic domain data structure for
 569                                            iommu core */
 570 };
 571
 572 struct intel_iommu {
 573         void __iomem    *reg; /* Pointer to hardware regs, virtual addr */
 574         u64             reg_phys; /* physical address of hw register set */
 575         u64             reg_size; /* size of hw register set */
 576         u64             cap;
 577         u64             ecap;
 578         u64             vccap;
 579         u32             gcmd; /* Holds TE, EAFL. Don't need SRTP, SFL, WBF */
 580         raw_spinlock_t  register_lock; /* protect register handling */
 581         int             seq_id; /* sequence id of the iommu */
 582         int             agaw; /* agaw of this iommu */
 583         int             msagaw; /* max sagaw of this iommu */
 584         unsigned int    irq, pr_irq;
 585         u16             segment;     /* PCI segment# */
 586         unsigned char   name[13];    /* Device Name */
 587
 588 #ifdef CONFIG_INTEL_IOMMU
 589         unsigned long   *domain_ids; /* bitmap of domains */
 590         struct dmar_domain ***domains; /* ptr to domains */
 591         spinlock_t      lock; /* protect context, domain ids */
 592         struct root_entry *root_entry; /* virtual address */
 593
 594         struct iommu_flush flush;
 595 #endif
 596 #ifdef CONFIG_INTEL_IOMMU_SVM
 597         struct page_req_dsc *prq;
 598         unsigned char prq_name[16];    /* Name for PRQ interrupt */
 599         struct completion prq_complete;
 600         struct ioasid_allocator_ops pasid_allocator; /* Custom allocator for PASIDs */
 601 #endif
 602         struct q_inval  *qi;            /* Queued invalidation info */
 603         u32 *iommu_state; /* Store iommu states between suspend and resume.*/
 604
 605 #ifdef CONFIG_IRQ_REMAP
 606         struct ir_table *ir_table;      /* Interrupt remapping info */
 607         struct irq_domain *ir_domain;
 608         struct irq_domain *ir_msi_domain;
 609 #endif
 610         struct iommu_device iommu;  /* IOMMU core code handle */
 611         int             node;
 612         u32             flags;      /* Software defined flags */
 613
 614         struct dmar_drhd_unit *drhd;
 615 };
 616
 617 /* Per subdevice private data */
 618 struct subdev_domain_info {
 619         struct list_head link_phys;     /* link to phys device siblings */
 620         struct list_head link_domain;   /* link to domain siblings */
 621         struct device *pdev;            /* physical device derived from */
 622         struct dmar_domain *domain;     /* aux-domain */
 623         int users;                      /* user count */
 624 };
 625
 626 /* PCI domain-device relationship */
 627 struct device_domain_info {
 628         struct list_head link;  /* link to domain siblings */
 629         struct list_head global; /* link to global list */
 630         struct list_head table; /* link to pasid table */
 631         struct list_head subdevices; /* subdevices sibling */
 632         u32 segment;            /* PCI segment number */
 633         u8 bus;                 /* PCI bus number */
 634         u8 devfn;               /* PCI devfn number */
 635         u16 pfsid;              /* SRIOV physical function source ID */
 636         u8 pasid_supported:3;
 637         u8 pasid_enabled:1;
 638         u8 pri_supported:1;
 639         u8 pri_enabled:1;
 640         u8 ats_supported:1;
 641         u8 ats_enabled:1;
 642         u8 auxd_enabled:1;      /* Multiple domains per device */
 643         u8 ats_qdep;
 644         struct device *dev; /* it's NULL for PCIe-to-PCI bridge */
 645         struct intel_iommu *iommu; /* IOMMU used by this device */
 646         struct dmar_domain *domain; /* pointer to domain */
 647         struct pasid_table *pasid_table; /* pasid table */
 648 };
 649
 650 static inline void __iommu_flush_cache(
 651         struct intel_iommu *iommu, void *addr, int size)
 652 {
 653         if (!ecap_coherent(iommu->ecap))
 654                 clflush_cache_range(addr, size);
 655 }
 656
 657 /* Convert generic struct iommu_domain to private struct dmar_domain */
 658 static inline struct dmar_domain *to_dmar_domain(struct iommu_domain *dom)
 659 {
 660         return container_of(dom, struct dmar_domain, domain);
 661 }
 662
 663 /*
 664  * 0: readable
 665  * 1: writable
 666  * 2-6: reserved
 667  * 7: super page
 668  * 8-10: available
 669  * 11: snoop behavior
 670  * 12-63: Host physical address
 671  */
 672 struct dma_pte {
 673         u64 val;
 674 };
 675
 676 static inline void dma_clear_pte(struct dma_pte *pte)
 677 {
 678         pte->val = 0;
 679 }
 680
 681 static inline u64 dma_pte_addr(struct dma_pte *pte)
 682 {
 683 #ifdef CONFIG_64BIT
 684         return pte->val & VTD_PAGE_MASK & (~DMA_FL_PTE_XD);
 685 #else
 686         /* Must have a full atomic 64-bit read */
 687         return  __cmpxchg64(&pte->val, 0ULL, 0ULL) &
 688                         VTD_PAGE_MASK & (~DMA_FL_PTE_XD);
 689 #endif
 690 }
 691
 692 static inline bool dma_pte_present(struct dma_pte *pte)
 693 {
 694         return (pte->val & 3) != 0;
 695 }
 696
 697 static inline bool dma_pte_superpage(struct dma_pte *pte)
 698 {
 699         return (pte->val & DMA_PTE_LARGE_PAGE);
 700 }
 701
 702 static inline int first_pte_in_page(struct dma_pte *pte)
 703 {
 704         return !((unsigned long)pte & ~VTD_PAGE_MASK);
 705 }
 706
 707 extern struct dmar_drhd_unit * dmar_find_matched_drhd_unit(struct pci_dev *dev);
 708 extern int dmar_find_matched_atsr_unit(struct pci_dev *dev);
 709
 710 extern int dmar_enable_qi(struct intel_iommu *iommu);
 711 extern void dmar_disable_qi(struct intel_iommu *iommu);
 712 extern int dmar_reenable_qi(struct intel_iommu *iommu);
 713 extern void qi_global_iec(struct intel_iommu *iommu);
 714
 715 extern void qi_flush_context(struct intel_iommu *iommu, u16 did, u16 sid,
 716                              u8 fm, u64 type);
 717 extern void qi_flush_iotlb(struct intel_iommu *iommu, u16 did, u64 addr,
 718                           unsigned int size_order, u64 type);
 719 extern void qi_flush_dev_iotlb(struct intel_iommu *iommu, u16 sid, u16 pfsid,
 720                         u16 qdep, u64 addr, unsigned mask);
 721
 722 void qi_flush_piotlb(struct intel_iommu *iommu, u16 did, u32 pasid, u64 addr,
 723                      unsigned long npages, bool ih);
 724
 725 void qi_flush_dev_iotlb_pasid(struct intel_iommu *iommu, u16 sid, u16 pfsid,
 726                               u32 pasid, u16 qdep, u64 addr,
 727                               unsigned int size_order);
 728 void qi_flush_pasid_cache(struct intel_iommu *iommu, u16 did, u64 granu,
 729                           u32 pasid);
 730
 731 int qi_submit_sync(struct intel_iommu *iommu, struct qi_desc *desc,
 732                    unsigned int count, unsigned long options);
 733 /*
 734  * Options used in qi_submit_sync:
 735  * QI_OPT_WAIT_DRAIN - Wait for PRQ drain completion, spec 6.5.2.8.
 736  */
 737 #define QI_OPT_WAIT_DRAIN               BIT(0)
 738
 739 extern int dmar_ir_support(void);
 740
 741 void *alloc_pgtable_page(int node);
 742 void free_pgtable_page(void *vaddr);
 743 struct intel_iommu *domain_get_iommu(struct dmar_domain *domain);
 744 int for_each_device_domain(int (*fn)(struct device_domain_info *info,
 745                                      void *data), void *data);
 746 void iommu_flush_write_buffer(struct intel_iommu *iommu);
 747 int intel_iommu_enable_pasid(struct intel_iommu *iommu, struct device *dev);
 748 struct dmar_domain *find_domain(struct device *dev);
 749 struct device_domain_info *get_domain_info(struct device *dev);
 750 struct intel_iommu *device_to_iommu(struct device *dev, u8 *bus, u8 *devfn);
 751
 752 #ifdef CONFIG_INTEL_IOMMU_SVM
 753 extern void intel_svm_check(struct intel_iommu *iommu);
 754 extern int intel_svm_enable_prq(struct intel_iommu *iommu);
 755 extern int intel_svm_finish_prq(struct intel_iommu *iommu);
 756 int intel_svm_bind_gpasid(struct iommu_domain *domain, struct device *dev,
 757                           struct iommu_gpasid_bind_data *data);
 758 int intel_svm_unbind_gpasid(struct device *dev, u32 pasid);
 759 struct iommu_sva *intel_svm_bind(struct device *dev, struct mm_struct *mm,
 760                                  void *drvdata);
 761 void intel_svm_unbind(struct iommu_sva *handle);
 762 u32 intel_svm_get_pasid(struct iommu_sva *handle);
 763 int intel_svm_page_response(struct device *dev, struct iommu_fault_event *evt,
 764                             struct iommu_page_response *msg);
 765
 766 struct svm_dev_ops;
 767
 768 struct intel_svm_dev {
 769         struct list_head list;
 770         struct rcu_head rcu;
 771         struct device *dev;
 772         struct intel_iommu *iommu;
 773         struct svm_dev_ops *ops;
 774         struct iommu_sva sva;
 775         u32 pasid;
 776         int users;
 777         u16 did;
 778         u16 dev_iotlb:1;
 779         u16 sid, qdep;
 780 };
 781
 782 struct intel_svm {
 783         struct mmu_notifier notifier;
 784         struct mm_struct *mm;
 785
 786         unsigned int flags;
 787         u32 pasid;
 788         int gpasid; /* In case that guest PASID is different from host PASID */
 789         struct list_head devs;
 790         struct list_head list;
 791 };
 792 #else
 793 static inline void intel_svm_check(struct intel_iommu *iommu) {}
 794 #endif
 795
 796 #ifdef CONFIG_INTEL_IOMMU_DEBUGFS
 797 void intel_iommu_debugfs_init(void);
 798 #else
 799 static inline void intel_iommu_debugfs_init(void) {}
 800 #endif /* CONFIG_INTEL_IOMMU_DEBUGFS */
 801
 802 extern const struct attribute_group *intel_iommu_groups[];
 803 bool context_present(struct context_entry *context);
 804 struct context_entry *iommu_context_addr(struct intel_iommu *iommu, u8 bus,
 805                                          u8 devfn, int alloc);
 806
 807 #ifdef CONFIG_INTEL_IOMMU
 808 extern int iommu_calculate_agaw(struct intel_iommu *iommu);
 809 extern int iommu_calculate_max_sagaw(struct intel_iommu *iommu);
 810 extern int dmar_disabled;
 811 extern int intel_iommu_enabled;
 812 extern int intel_iommu_gfx_mapped;
 813 #else
 814 static inline int iommu_calculate_agaw(struct intel_iommu *iommu)
 815 {
 816         return 0;
 817 }
 818 static inline int iommu_calculate_max_sagaw(struct intel_iommu *iommu)
 819 {
 820         return 0;
 821 }
 822 #define dmar_disabled   (1)
 823 #define intel_iommu_enabled (0)
 824 #endif
 825
 826 #endif