include/linux/intel-iommu.h

   1 /*
   2  * Copyright (c) 2006, Intel Corporation.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms and conditions of the GNU General Public License,
   6  * version 2, as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  15  * Place - Suite 330, Boston, MA 02111-1307 USA.
  16  *
  17  * Copyright (C) 2006-2008 Intel Corporation
  18  * Author: Ashok Raj <ashok.raj@intel.com>
  19  * Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
  20  */
  21
  22 #ifndef _INTEL_IOMMU_H_
  23 #define _INTEL_IOMMU_H_
  24
  25 #include <linux/types.h>
  26 #include <linux/iova.h>
  27 #include <linux/io.h>
  28 #include <linux/dma_remapping.h>
  29 #include <asm/cacheflush.h>
  30 #include <asm/iommu.h>
  31
  32 /*
  33  * Intel IOMMU register specification per version 1.0 public spec.
  34  */
  35
  36 #define DMAR_VER_REG    0x0     /* Arch version supported by this IOMMU */
  37 #define DMAR_CAP_REG    0x8     /* Hardware supported capabilities */
  38 #define DMAR_ECAP_REG   0x10    /* Extended capabilities supported */
  39 #define DMAR_GCMD_REG   0x18    /* Global command register */
  40 #define DMAR_GSTS_REG   0x1c    /* Global status register */
  41 #define DMAR_RTADDR_REG 0x20    /* Root entry table */
  42 #define DMAR_CCMD_REG   0x28    /* Context command reg */
  43 #define DMAR_FSTS_REG   0x34    /* Fault Status register */
  44 #define DMAR_FECTL_REG  0x38    /* Fault control register */
  45 #define DMAR_FEDATA_REG 0x3c    /* Fault event interrupt data register */
  46 #define DMAR_FEADDR_REG 0x40    /* Fault event interrupt addr register */
  47 #define DMAR_FEUADDR_REG 0x44   /* Upper address register */
  48 #define DMAR_AFLOG_REG  0x58    /* Advanced Fault control */
  49 #define DMAR_PMEN_REG   0x64    /* Enable Protected Memory Region */
  50 #define DMAR_PLMBASE_REG 0x68   /* PMRR Low addr */
  51 #define DMAR_PLMLIMIT_REG 0x6c  /* PMRR low limit */
  52 #define DMAR_PHMBASE_REG 0x70   /* pmrr high base addr */
  53 #define DMAR_PHMLIMIT_REG 0x78  /* pmrr high limit */
  54 #define DMAR_IQH_REG    0x80    /* Invalidation queue head register */
  55 #define DMAR_IQT_REG    0x88    /* Invalidation queue tail register */
  56 #define DMAR_IQ_SHIFT   4       /* Invalidation queue head/tail shift */
  57 #define DMAR_IQA_REG    0x90    /* Invalidation queue addr register */
  58 #define DMAR_ICS_REG    0x9c    /* Invalidation complete status register */
  59 #define DMAR_IRTA_REG   0xb8    /* Interrupt remapping table addr register */
  60
  61 #define OFFSET_STRIDE           (9)
  62 /*
  63 #define dmar_readl(dmar, reg) readl(dmar + reg)
  64 #define dmar_readq(dmar, reg) ({ \
  65                 u32 lo, hi; \
  66                 lo = readl(dmar + reg); \
  67                 hi = readl(dmar + reg + 4); \
  68                 (((u64) hi) << 32) + lo; })
  69 */
  70 static inline u64 dmar_readq(void __iomem *addr)
  71 {
  72         u32 lo, hi;
  73         lo = readl(addr);
  74         hi = readl(addr + 4);
  75         return (((u64) hi) << 32) + lo;
  76 }
  77
  78 static inline void dmar_writeq(void __iomem *addr, u64 val)
  79 {
  80         writel((u32)val, addr);
  81         writel((u32)(val >> 32), addr + 4);
  82 }
  83
  84 #define DMAR_VER_MAJOR(v)               (((v) & 0xf0) >> 4)
  85 #define DMAR_VER_MINOR(v)               ((v) & 0x0f)
  86
  87 /*
  88  * Decoding Capability Register
  89  */
  90 #define cap_pi_support(c)       (((c) >> 59) & 1)
  91 #define cap_read_drain(c)       (((c) >> 55) & 1)
  92 #define cap_write_drain(c)      (((c) >> 54) & 1)
  93 #define cap_max_amask_val(c)    (((c) >> 48) & 0x3f)
  94 #define cap_num_fault_regs(c)   ((((c) >> 40) & 0xff) + 1)
  95 #define cap_pgsel_inv(c)        (((c) >> 39) & 1)
  96
  97 #define cap_super_page_val(c)   (((c) >> 34) & 0xf)
  98 #define cap_super_offset(c)     (((find_first_bit(&cap_super_page_val(c), 4)) \
  99                                         * OFFSET_STRIDE) + 21)
 100
 101 #define cap_fault_reg_offset(c) ((((c) >> 24) & 0x3ff) * 16)
 102 #define cap_max_fault_reg_offset(c) \
 103         (cap_fault_reg_offset(c) + cap_num_fault_regs(c) * 16)
 104
 105 #define cap_zlr(c)              (((c) >> 22) & 1)
 106 #define cap_isoch(c)            (((c) >> 23) & 1)
 107 #define cap_mgaw(c)             ((((c) >> 16) & 0x3f) + 1)
 108 #define cap_sagaw(c)            (((c) >> 8) & 0x1f)
 109 #define cap_caching_mode(c)     (((c) >> 7) & 1)
 110 #define cap_phmr(c)             (((c) >> 6) & 1)
 111 #define cap_plmr(c)             (((c) >> 5) & 1)
 112 #define cap_rwbf(c)             (((c) >> 4) & 1)
 113 #define cap_afl(c)              (((c) >> 3) & 1)
 114 #define cap_ndoms(c)            (((unsigned long)1) << (4 + 2 * ((c) & 0x7)))
 115 /*
 116  * Extended Capability Register
 117  */
 118
 119 #define ecap_pasid(e)           ((e >> 40) & 0x1)
 120 #define ecap_pss(e)             ((e >> 35) & 0x1f)
 121 #define ecap_eafs(e)            ((e >> 34) & 0x1)
 122 #define ecap_nwfs(e)            ((e >> 33) & 0x1)
 123 #define ecap_srs(e)             ((e >> 31) & 0x1)
 124 #define ecap_ers(e)             ((e >> 30) & 0x1)
 125 #define ecap_prs(e)             ((e >> 29) & 0x1)
 126 /* PASID support used to be on bit 28 */
 127 #define ecap_dis(e)             ((e >> 27) & 0x1)
 128 #define ecap_nest(e)            ((e >> 26) & 0x1)
 129 #define ecap_mts(e)             ((e >> 25) & 0x1)
 130 #define ecap_ecs(e)             ((e >> 24) & 0x1)
 131 #define ecap_iotlb_offset(e)    ((((e) >> 8) & 0x3ff) * 16)
 132 #define ecap_max_iotlb_offset(e) (ecap_iotlb_offset(e) + 16)
 133 #define ecap_coherent(e)        ((e) & 0x1)
 134 #define ecap_qis(e)             ((e) & 0x2)
 135 #define ecap_pass_through(e)    ((e >> 6) & 0x1)
 136 #define ecap_eim_support(e)     ((e >> 4) & 0x1)
 137 #define ecap_ir_support(e)      ((e >> 3) & 0x1)
 138 #define ecap_dev_iotlb_support(e)       (((e) >> 2) & 0x1)
 139 #define ecap_max_handle_mask(e) ((e >> 20) & 0xf)
 140 #define ecap_sc_support(e)      ((e >> 7) & 0x1) /* Snooping Control */
 141
 142 /* IOTLB_REG */
 143 #define DMA_TLB_FLUSH_GRANU_OFFSET  60
 144 #define DMA_TLB_GLOBAL_FLUSH (((u64)1) << 60)
 145 #define DMA_TLB_DSI_FLUSH (((u64)2) << 60)
 146 #define DMA_TLB_PSI_FLUSH (((u64)3) << 60)
 147 #define DMA_TLB_IIRG(type) ((type >> 60) & 7)
 148 #define DMA_TLB_IAIG(val) (((val) >> 57) & 7)
 149 #define DMA_TLB_READ_DRAIN (((u64)1) << 49)
 150 #define DMA_TLB_WRITE_DRAIN (((u64)1) << 48)
 151 #define DMA_TLB_DID(id) (((u64)((id) & 0xffff)) << 32)
 152 #define DMA_TLB_IVT (((u64)1) << 63)
 153 #define DMA_TLB_IH_NONLEAF (((u64)1) << 6)
 154 #define DMA_TLB_MAX_SIZE (0x3f)
 155
 156 /* INVALID_DESC */
 157 #define DMA_CCMD_INVL_GRANU_OFFSET  61
 158 #define DMA_ID_TLB_GLOBAL_FLUSH (((u64)1) << 3)
 159 #define DMA_ID_TLB_DSI_FLUSH    (((u64)2) << 3)
 160 #define DMA_ID_TLB_PSI_FLUSH    (((u64)3) << 3)
 161 #define DMA_ID_TLB_READ_DRAIN   (((u64)1) << 7)
 162 #define DMA_ID_TLB_WRITE_DRAIN  (((u64)1) << 6)
 163 #define DMA_ID_TLB_DID(id)      (((u64)((id & 0xffff) << 16)))
 164 #define DMA_ID_TLB_IH_NONLEAF   (((u64)1) << 6)
 165 #define DMA_ID_TLB_ADDR(addr)   (addr)
 166 #define DMA_ID_TLB_ADDR_MASK(mask)      (mask)
 167
 168 /* PMEN_REG */
 169 #define DMA_PMEN_EPM (((u32)1)<<31)
 170 #define DMA_PMEN_PRS (((u32)1)<<0)
 171
 172 /* GCMD_REG */
 173 #define DMA_GCMD_TE (((u32)1) << 31)
 174 #define DMA_GCMD_SRTP (((u32)1) << 30)
 175 #define DMA_GCMD_SFL (((u32)1) << 29)
 176 #define DMA_GCMD_EAFL (((u32)1) << 28)
 177 #define DMA_GCMD_WBF (((u32)1) << 27)
 178 #define DMA_GCMD_QIE (((u32)1) << 26)
 179 #define DMA_GCMD_SIRTP (((u32)1) << 24)
 180 #define DMA_GCMD_IRE (((u32) 1) << 25)
 181 #define DMA_GCMD_CFI (((u32) 1) << 23)
 182
 183 /* GSTS_REG */
 184 #define DMA_GSTS_TES (((u32)1) << 31)
 185 #define DMA_GSTS_RTPS (((u32)1) << 30)
 186 #define DMA_GSTS_FLS (((u32)1) << 29)
 187 #define DMA_GSTS_AFLS (((u32)1) << 28)
 188 #define DMA_GSTS_WBFS (((u32)1) << 27)
 189 #define DMA_GSTS_QIES (((u32)1) << 26)
 190 #define DMA_GSTS_IRTPS (((u32)1) << 24)
 191 #define DMA_GSTS_IRES (((u32)1) << 25)
 192 #define DMA_GSTS_CFIS (((u32)1) << 23)
 193
 194 /* DMA_RTADDR_REG */
 195 #define DMA_RTADDR_RTT (((u64)1) << 11)
 196
 197 /* CCMD_REG */
 198 #define DMA_CCMD_ICC (((u64)1) << 63)
 199 #define DMA_CCMD_GLOBAL_INVL (((u64)1) << 61)
 200 #define DMA_CCMD_DOMAIN_INVL (((u64)2) << 61)
 201 #define DMA_CCMD_DEVICE_INVL (((u64)3) << 61)
 202 #define DMA_CCMD_FM(m) (((u64)((m) & 0x3)) << 32)
 203 #define DMA_CCMD_MASK_NOBIT 0
 204 #define DMA_CCMD_MASK_1BIT 1
 205 #define DMA_CCMD_MASK_2BIT 2
 206 #define DMA_CCMD_MASK_3BIT 3
 207 #define DMA_CCMD_SID(s) (((u64)((s) & 0xffff)) << 16)
 208 #define DMA_CCMD_DID(d) ((u64)((d) & 0xffff))
 209
 210 /* FECTL_REG */
 211 #define DMA_FECTL_IM (((u32)1) << 31)
 212
 213 /* FSTS_REG */
 214 #define DMA_FSTS_PPF ((u32)2)
 215 #define DMA_FSTS_PFO ((u32)1)
 216 #define DMA_FSTS_IQE (1 << 4)
 217 #define DMA_FSTS_ICE (1 << 5)
 218 #define DMA_FSTS_ITE (1 << 6)
 219 #define dma_fsts_fault_record_index(s) (((s) >> 8) & 0xff)
 220
 221 /* FRCD_REG, 32 bits access */
 222 #define DMA_FRCD_F (((u32)1) << 31)
 223 #define dma_frcd_type(d) ((d >> 30) & 1)
 224 #define dma_frcd_fault_reason(c) (c & 0xff)
 225 #define dma_frcd_source_id(c) (c & 0xffff)
 226 /* low 64 bit */
 227 #define dma_frcd_page_addr(d) (d & (((u64)-1) << PAGE_SHIFT))
 228
 229 #define IOMMU_WAIT_OP(iommu, offset, op, cond, sts)                     \
 230 do {                                                                    \
 231         cycles_t start_time = get_cycles();                             \
 232         while (1) {                                                     \
 233                 sts = op(iommu->reg + offset);                          \
 234                 if (cond)                                               \
 235                         break;                                          \
 236                 if (DMAR_OPERATION_TIMEOUT < (get_cycles() - start_time))\
 237                         panic("DMAR hardware is malfunctioning\n");     \
 238                 cpu_relax();                                            \
 239         }                                                               \
 240 } while (0)
 241
 242 #define QI_LENGTH       256     /* queue length */
 243
 244 enum {
 245         QI_FREE,
 246         QI_IN_USE,
 247         QI_DONE,
 248         QI_ABORT
 249 };
 250
 251 #define QI_CC_TYPE              0x1
 252 #define QI_IOTLB_TYPE           0x2
 253 #define QI_DIOTLB_TYPE          0x3
 254 #define QI_IEC_TYPE             0x4
 255 #define QI_IWD_TYPE             0x5
 256
 257 #define QI_IEC_SELECTIVE        (((u64)1) << 4)
 258 #define QI_IEC_IIDEX(idx)       (((u64)(idx & 0xffff) << 32))
 259 #define QI_IEC_IM(m)            (((u64)(m & 0x1f) << 27))
 260
 261 #define QI_IWD_STATUS_DATA(d)   (((u64)d) << 32)
 262 #define QI_IWD_STATUS_WRITE     (((u64)1) << 5)
 263
 264 #define QI_IOTLB_DID(did)       (((u64)did) << 16)
 265 #define QI_IOTLB_DR(dr)         (((u64)dr) << 7)
 266 #define QI_IOTLB_DW(dw)         (((u64)dw) << 6)
 267 #define QI_IOTLB_GRAN(gran)     (((u64)gran) >> (DMA_TLB_FLUSH_GRANU_OFFSET-4))
 268 #define QI_IOTLB_ADDR(addr)     (((u64)addr) & VTD_PAGE_MASK)
 269 #define QI_IOTLB_IH(ih)         (((u64)ih) << 6)
 270 #define QI_IOTLB_AM(am)         (((u8)am))
 271
 272 #define QI_CC_FM(fm)            (((u64)fm) << 48)
 273 #define QI_CC_SID(sid)          (((u64)sid) << 32)
 274 #define QI_CC_DID(did)          (((u64)did) << 16)
 275 #define QI_CC_GRAN(gran)        (((u64)gran) >> (DMA_CCMD_INVL_GRANU_OFFSET-4))
 276
 277 #define QI_DEV_IOTLB_SID(sid)   ((u64)((sid) & 0xffff) << 32)
 278 #define QI_DEV_IOTLB_QDEP(qdep) (((qdep) & 0x1f) << 16)
 279 #define QI_DEV_IOTLB_ADDR(addr) ((u64)(addr) & VTD_PAGE_MASK)
 280 #define QI_DEV_IOTLB_SIZE       1
 281 #define QI_DEV_IOTLB_MAX_INVS   32
 282
 283 struct qi_desc {
 284         u64 low, high;
 285 };
 286
 287 struct q_inval {
 288         raw_spinlock_t  q_lock;
 289         struct qi_desc  *desc;          /* invalidation queue */
 290         int             *desc_status;   /* desc status */
 291         int             free_head;      /* first free entry */
 292         int             free_tail;      /* last free entry */
 293         int             free_cnt;
 294 };
 295
 296 #ifdef CONFIG_IRQ_REMAP
 297 /* 1MB - maximum possible interrupt remapping table size */
 298 #define INTR_REMAP_PAGE_ORDER   8
 299 #define INTR_REMAP_TABLE_REG_SIZE       0xf
 300 #define INTR_REMAP_TABLE_REG_SIZE_MASK  0xf
 301
 302 #define INTR_REMAP_TABLE_ENTRIES        65536
 303
 304 struct irq_domain;
 305
 306 struct ir_table {
 307         struct irte *base;
 308         unsigned long *bitmap;
 309 };
 310 #endif
 311
 312 struct iommu_flush {
 313         void (*flush_context)(struct intel_iommu *iommu, u16 did, u16 sid,
 314                               u8 fm, u64 type);
 315         void (*flush_iotlb)(struct intel_iommu *iommu, u16 did, u64 addr,
 316                             unsigned int size_order, u64 type);
 317 };
 318
 319 enum {
 320         SR_DMAR_FECTL_REG,
 321         SR_DMAR_FEDATA_REG,
 322         SR_DMAR_FEADDR_REG,
 323         SR_DMAR_FEUADDR_REG,
 324         MAX_SR_DMAR_REGS
 325 };
 326
 327 #define VTD_FLAG_TRANS_PRE_ENABLED      (1 << 0)
 328 #define VTD_FLAG_IRQ_REMAP_PRE_ENABLED  (1 << 1)
 329
 330 struct intel_iommu {
 331         void __iomem    *reg; /* Pointer to hardware regs, virtual addr */
 332         u64             reg_phys; /* physical address of hw register set */
 333         u64             reg_size; /* size of hw register set */
 334         u64             cap;
 335         u64             ecap;
 336         u32             gcmd; /* Holds TE, EAFL. Don't need SRTP, SFL, WBF */
 337         raw_spinlock_t  register_lock; /* protect register handling */
 338         int             seq_id; /* sequence id of the iommu */
 339         int             agaw; /* agaw of this iommu */
 340         int             msagaw; /* max sagaw of this iommu */
 341         unsigned int    irq;
 342         u16             segment;     /* PCI segment# */
 343         unsigned char   name[13];    /* Device Name */
 344
 345 #ifdef CONFIG_INTEL_IOMMU
 346         unsigned long   *domain_ids; /* bitmap of domains */
 347         struct dmar_domain ***domains; /* ptr to domains */
 348         spinlock_t      lock; /* protect context, domain ids */
 349         struct root_entry *root_entry; /* virtual address */
 350
 351         struct iommu_flush flush;
 352 #endif
 353         struct q_inval  *qi;            /* Queued invalidation info */
 354         u32 *iommu_state; /* Store iommu states between suspend and resume.*/
 355
 356 #ifdef CONFIG_IRQ_REMAP
 357         struct ir_table *ir_table;      /* Interrupt remapping info */
 358         struct irq_domain *ir_domain;
 359         struct irq_domain *ir_msi_domain;
 360 #endif
 361         struct device   *iommu_dev; /* IOMMU-sysfs device */
 362         int             node;
 363         u32             flags;      /* Software defined flags */
 364 };
 365
 366 static inline void __iommu_flush_cache(
 367         struct intel_iommu *iommu, void *addr, int size)
 368 {
 369         if (!ecap_coherent(iommu->ecap))
 370                 clflush_cache_range(addr, size);
 371 }
 372
 373 extern struct dmar_drhd_unit * dmar_find_matched_drhd_unit(struct pci_dev *dev);
 374 extern int dmar_find_matched_atsr_unit(struct pci_dev *dev);
 375
 376 extern int dmar_enable_qi(struct intel_iommu *iommu);
 377 extern void dmar_disable_qi(struct intel_iommu *iommu);
 378 extern int dmar_reenable_qi(struct intel_iommu *iommu);
 379 extern void qi_global_iec(struct intel_iommu *iommu);
 380
 381 extern void qi_flush_context(struct intel_iommu *iommu, u16 did, u16 sid,
 382                              u8 fm, u64 type);
 383 extern void qi_flush_iotlb(struct intel_iommu *iommu, u16 did, u64 addr,
 384                           unsigned int size_order, u64 type);
 385 extern void qi_flush_dev_iotlb(struct intel_iommu *iommu, u16 sid, u16 qdep,
 386                                u64 addr, unsigned mask);
 387
 388 extern int qi_submit_sync(struct qi_desc *desc, struct intel_iommu *iommu);
 389
 390 extern int dmar_ir_support(void);
 391
 392 extern const struct attribute_group *intel_iommu_groups[];
 393
 394 #endif