1 // SPDX-License-Identifier: GPL-2.0
3 * intel-pasid.c - PASID idr, table and entry manipulation
5 * Copyright (C) 2018 Intel Corporation
10 #define pr_fmt(fmt) "DMAR: " fmt
12 #include <linux/bitops.h>
13 #include <linux/cpufeature.h>
14 #include <linux/dmar.h>
15 #include <linux/iommu.h>
16 #include <linux/memory.h>
17 #include <linux/pci.h>
18 #include <linux/pci-ats.h>
19 #include <linux/spinlock.h>
25 * Intel IOMMU system wide PASID name space:
27 u32 intel_pasid_max_id = PASID_MAX;
29 int vcmd_alloc_pasid(struct intel_iommu *iommu, u32 *pasid)
36 raw_spin_lock_irqsave(&iommu->register_lock, flags);
37 dmar_writeq(iommu->reg + DMAR_VCMD_REG, VCMD_CMD_ALLOC);
38 IOMMU_WAIT_OP(iommu, DMAR_VCRSP_REG, dmar_readq,
39 !(res & VCMD_VRSP_IP), res);
40 raw_spin_unlock_irqrestore(&iommu->register_lock, flags);
42 status_code = VCMD_VRSP_SC(res);
43 switch (status_code) {
44 case VCMD_VRSP_SC_SUCCESS:
45 *pasid = VCMD_VRSP_RESULT_PASID(res);
47 case VCMD_VRSP_SC_NO_PASID_AVAIL:
48 pr_info("IOMMU: %s: No PASID available\n", iommu->name);
53 pr_warn("IOMMU: %s: Unexpected error code %d\n",
54 iommu->name, status_code);
60 void vcmd_free_pasid(struct intel_iommu *iommu, u32 pasid)
66 raw_spin_lock_irqsave(&iommu->register_lock, flags);
67 dmar_writeq(iommu->reg + DMAR_VCMD_REG,
68 VCMD_CMD_OPERAND(pasid) | VCMD_CMD_FREE);
69 IOMMU_WAIT_OP(iommu, DMAR_VCRSP_REG, dmar_readq,
70 !(res & VCMD_VRSP_IP), res);
71 raw_spin_unlock_irqrestore(&iommu->register_lock, flags);
73 status_code = VCMD_VRSP_SC(res);
74 switch (status_code) {
75 case VCMD_VRSP_SC_SUCCESS:
77 case VCMD_VRSP_SC_INVALID_PASID:
78 pr_info("IOMMU: %s: Invalid PASID\n", iommu->name);
81 pr_warn("IOMMU: %s: Unexpected error code %d\n",
82 iommu->name, status_code);
87 * Per device pasid table management:
91 * Allocate a pasid table for @dev. It should be called in a
92 * single-thread context.
94 int intel_pasid_alloc_table(struct device *dev)
96 struct device_domain_info *info;
97 struct pasid_table *pasid_table;
103 info = dev_iommu_priv_get(dev);
104 if (WARN_ON(!info || !dev_is_pci(dev)))
106 if (WARN_ON(info->pasid_table))
109 pasid_table = kzalloc(sizeof(*pasid_table), GFP_KERNEL);
113 if (info->pasid_supported)
114 max_pasid = min_t(u32, pci_max_pasids(to_pci_dev(dev)),
117 size = max_pasid >> (PASID_PDE_SHIFT - 3);
118 order = size ? get_order(size) : 0;
119 pages = alloc_pages_node(info->iommu->node,
120 GFP_KERNEL | __GFP_ZERO, order);
126 pasid_table->table = page_address(pages);
127 pasid_table->order = order;
128 pasid_table->max_pasid = 1 << (order + PAGE_SHIFT + 3);
129 info->pasid_table = pasid_table;
131 if (!ecap_coherent(info->iommu->ecap))
132 clflush_cache_range(pasid_table->table, size);
137 void intel_pasid_free_table(struct device *dev)
139 struct device_domain_info *info;
140 struct pasid_table *pasid_table;
141 struct pasid_dir_entry *dir;
142 struct pasid_entry *table;
145 info = dev_iommu_priv_get(dev);
146 if (!info || !dev_is_pci(dev) || !info->pasid_table)
149 pasid_table = info->pasid_table;
150 info->pasid_table = NULL;
152 /* Free scalable mode PASID directory tables: */
153 dir = pasid_table->table;
154 max_pde = pasid_table->max_pasid >> PASID_PDE_SHIFT;
155 for (i = 0; i < max_pde; i++) {
156 table = get_pasid_table_from_pde(&dir[i]);
157 free_pgtable_page(table);
160 free_pages((unsigned long)pasid_table->table, pasid_table->order);
164 struct pasid_table *intel_pasid_get_table(struct device *dev)
166 struct device_domain_info *info;
168 info = dev_iommu_priv_get(dev);
172 return info->pasid_table;
175 static int intel_pasid_get_dev_max_id(struct device *dev)
177 struct device_domain_info *info;
179 info = dev_iommu_priv_get(dev);
180 if (!info || !info->pasid_table)
183 return info->pasid_table->max_pasid;
186 static struct pasid_entry *intel_pasid_get_entry(struct device *dev, u32 pasid)
188 struct device_domain_info *info;
189 struct pasid_table *pasid_table;
190 struct pasid_dir_entry *dir;
191 struct pasid_entry *entries;
192 int dir_index, index;
194 pasid_table = intel_pasid_get_table(dev);
195 if (WARN_ON(!pasid_table || pasid >= intel_pasid_get_dev_max_id(dev)))
198 dir = pasid_table->table;
199 info = dev_iommu_priv_get(dev);
200 dir_index = pasid >> PASID_PDE_SHIFT;
201 index = pasid & PASID_PTE_MASK;
204 entries = get_pasid_table_from_pde(&dir[dir_index]);
206 entries = alloc_pgtable_page(info->iommu->node, GFP_ATOMIC);
211 * The pasid directory table entry won't be freed after
212 * allocation. No worry about the race with free and
213 * clear. However, this entry might be populated by others
214 * while we are preparing it. Use theirs with a retry.
216 if (cmpxchg64(&dir[dir_index].val, 0ULL,
217 (u64)virt_to_phys(entries) | PASID_PTE_PRESENT)) {
218 free_pgtable_page(entries);
221 if (!ecap_coherent(info->iommu->ecap)) {
222 clflush_cache_range(entries, VTD_PAGE_SIZE);
223 clflush_cache_range(&dir[dir_index].val, sizeof(*dir));
227 return &entries[index];
231 * Interfaces for PASID table entry manipulation:
233 static inline void pasid_clear_entry(struct pasid_entry *pe)
235 WRITE_ONCE(pe->val[0], 0);
236 WRITE_ONCE(pe->val[1], 0);
237 WRITE_ONCE(pe->val[2], 0);
238 WRITE_ONCE(pe->val[3], 0);
239 WRITE_ONCE(pe->val[4], 0);
240 WRITE_ONCE(pe->val[5], 0);
241 WRITE_ONCE(pe->val[6], 0);
242 WRITE_ONCE(pe->val[7], 0);
245 static inline void pasid_clear_entry_with_fpd(struct pasid_entry *pe)
247 WRITE_ONCE(pe->val[0], PASID_PTE_FPD);
248 WRITE_ONCE(pe->val[1], 0);
249 WRITE_ONCE(pe->val[2], 0);
250 WRITE_ONCE(pe->val[3], 0);
251 WRITE_ONCE(pe->val[4], 0);
252 WRITE_ONCE(pe->val[5], 0);
253 WRITE_ONCE(pe->val[6], 0);
254 WRITE_ONCE(pe->val[7], 0);
258 intel_pasid_clear_entry(struct device *dev, u32 pasid, bool fault_ignore)
260 struct pasid_entry *pe;
262 pe = intel_pasid_get_entry(dev, pasid);
266 if (fault_ignore && pasid_pte_is_present(pe))
267 pasid_clear_entry_with_fpd(pe);
269 pasid_clear_entry(pe);
272 static inline void pasid_set_bits(u64 *ptr, u64 mask, u64 bits)
276 old = READ_ONCE(*ptr);
277 WRITE_ONCE(*ptr, (old & ~mask) | bits);
281 * Setup the DID(Domain Identifier) field (Bit 64~79) of scalable mode
285 pasid_set_domain_id(struct pasid_entry *pe, u64 value)
287 pasid_set_bits(&pe->val[1], GENMASK_ULL(15, 0), value);
291 * Get domain ID value of a scalable mode PASID entry.
294 pasid_get_domain_id(struct pasid_entry *pe)
296 return (u16)(READ_ONCE(pe->val[1]) & GENMASK_ULL(15, 0));
300 * Setup the SLPTPTR(Second Level Page Table Pointer) field (Bit 12~63)
301 * of a scalable mode PASID entry.
304 pasid_set_slptr(struct pasid_entry *pe, u64 value)
306 pasid_set_bits(&pe->val[0], VTD_PAGE_MASK, value);
310 * Setup the AW(Address Width) field (Bit 2~4) of a scalable mode PASID
314 pasid_set_address_width(struct pasid_entry *pe, u64 value)
316 pasid_set_bits(&pe->val[0], GENMASK_ULL(4, 2), value << 2);
320 * Setup the PGTT(PASID Granular Translation Type) field (Bit 6~8)
321 * of a scalable mode PASID entry.
324 pasid_set_translation_type(struct pasid_entry *pe, u64 value)
326 pasid_set_bits(&pe->val[0], GENMASK_ULL(8, 6), value << 6);
330 * Enable fault processing by clearing the FPD(Fault Processing
331 * Disable) field (Bit 1) of a scalable mode PASID entry.
333 static inline void pasid_set_fault_enable(struct pasid_entry *pe)
335 pasid_set_bits(&pe->val[0], 1 << 1, 0);
339 * Setup the WPE(Write Protect Enable) field (Bit 132) of a
340 * scalable mode PASID entry.
342 static inline void pasid_set_wpe(struct pasid_entry *pe)
344 pasid_set_bits(&pe->val[2], 1 << 4, 1 << 4);
348 * Setup the P(Present) field (Bit 0) of a scalable mode PASID
351 static inline void pasid_set_present(struct pasid_entry *pe)
353 pasid_set_bits(&pe->val[0], 1 << 0, 1);
357 * Setup Page Walk Snoop bit (Bit 87) of a scalable mode PASID
360 static inline void pasid_set_page_snoop(struct pasid_entry *pe, bool value)
362 pasid_set_bits(&pe->val[1], 1 << 23, value << 23);
366 * Setup No Execute Enable bit (Bit 133) of a scalable mode PASID
367 * entry. It is required when XD bit of the first level page table
368 * entry is about to be set.
370 static inline void pasid_set_nxe(struct pasid_entry *pe)
372 pasid_set_bits(&pe->val[2], 1 << 5, 1 << 5);
376 * Setup the Page Snoop (PGSNP) field (Bit 88) of a scalable mode
380 pasid_set_pgsnp(struct pasid_entry *pe)
382 pasid_set_bits(&pe->val[1], 1ULL << 24, 1ULL << 24);
386 * Setup the First Level Page table Pointer field (Bit 140~191)
387 * of a scalable mode PASID entry.
390 pasid_set_flptr(struct pasid_entry *pe, u64 value)
392 pasid_set_bits(&pe->val[2], VTD_PAGE_MASK, value);
396 * Setup the First Level Paging Mode field (Bit 130~131) of a
397 * scalable mode PASID entry.
400 pasid_set_flpm(struct pasid_entry *pe, u64 value)
402 pasid_set_bits(&pe->val[2], GENMASK_ULL(3, 2), value << 2);
406 pasid_cache_invalidation_with_pasid(struct intel_iommu *iommu,
411 desc.qw0 = QI_PC_DID(did) | QI_PC_GRAN(QI_PC_PASID_SEL) |
412 QI_PC_PASID(pasid) | QI_PC_TYPE;
417 qi_submit_sync(iommu, &desc, 1, 0);
421 devtlb_invalidation_with_pasid(struct intel_iommu *iommu,
422 struct device *dev, u32 pasid)
424 struct device_domain_info *info;
425 u16 sid, qdep, pfsid;
427 info = dev_iommu_priv_get(dev);
428 if (!info || !info->ats_enabled)
431 sid = info->bus << 8 | info->devfn;
432 qdep = info->ats_qdep;
436 * When PASID 0 is used, it indicates RID2PASID(DMA request w/o PASID),
437 * devTLB flush w/o PASID should be used. For non-zero PASID under
438 * SVA usage, device could do DMA with multiple PASIDs. It is more
439 * efficient to flush devTLB specific to the PASID.
441 if (pasid == PASID_RID2PASID)
442 qi_flush_dev_iotlb(iommu, sid, pfsid, qdep, 0, 64 - VTD_PAGE_SHIFT);
444 qi_flush_dev_iotlb_pasid(iommu, sid, pfsid, pasid, qdep, 0, 64 - VTD_PAGE_SHIFT);
447 void intel_pasid_tear_down_entry(struct intel_iommu *iommu, struct device *dev,
448 u32 pasid, bool fault_ignore)
450 struct pasid_entry *pte;
453 spin_lock(&iommu->lock);
454 pte = intel_pasid_get_entry(dev, pasid);
455 if (WARN_ON(!pte) || !pasid_pte_is_present(pte)) {
456 spin_unlock(&iommu->lock);
460 did = pasid_get_domain_id(pte);
461 pgtt = pasid_pte_get_pgtt(pte);
462 intel_pasid_clear_entry(dev, pasid, fault_ignore);
463 spin_unlock(&iommu->lock);
465 if (!ecap_coherent(iommu->ecap))
466 clflush_cache_range(pte, sizeof(*pte));
468 pasid_cache_invalidation_with_pasid(iommu, did, pasid);
470 if (pgtt == PASID_ENTRY_PGTT_PT || pgtt == PASID_ENTRY_PGTT_FL_ONLY)
471 qi_flush_piotlb(iommu, did, pasid, 0, -1, 0);
473 iommu->flush.flush_iotlb(iommu, did, 0, 0, DMA_TLB_DSI_FLUSH);
475 /* Device IOTLB doesn't need to be flushed in caching mode. */
476 if (!cap_caching_mode(iommu->cap))
477 devtlb_invalidation_with_pasid(iommu, dev, pasid);
481 * This function flushes cache for a newly setup pasid table entry.
482 * Caller of it should not modify the in-use pasid table entries.
484 static void pasid_flush_caches(struct intel_iommu *iommu,
485 struct pasid_entry *pte,
488 if (!ecap_coherent(iommu->ecap))
489 clflush_cache_range(pte, sizeof(*pte));
491 if (cap_caching_mode(iommu->cap)) {
492 pasid_cache_invalidation_with_pasid(iommu, did, pasid);
493 qi_flush_piotlb(iommu, did, pasid, 0, -1, 0);
495 iommu_flush_write_buffer(iommu);
500 * Set up the scalable mode pasid table entry for first only
503 int intel_pasid_setup_first_level(struct intel_iommu *iommu,
504 struct device *dev, pgd_t *pgd,
505 u32 pasid, u16 did, int flags)
507 struct pasid_entry *pte;
509 if (!ecap_flts(iommu->ecap)) {
510 pr_err("No first level translation support on %s\n",
515 if ((flags & PASID_FLAG_FL5LP) && !cap_fl5lp_support(iommu->cap)) {
516 pr_err("No 5-level paging support for first-level on %s\n",
521 spin_lock(&iommu->lock);
522 pte = intel_pasid_get_entry(dev, pasid);
524 spin_unlock(&iommu->lock);
528 if (pasid_pte_is_present(pte)) {
529 spin_unlock(&iommu->lock);
533 pasid_clear_entry(pte);
535 /* Setup the first level page table pointer: */
536 pasid_set_flptr(pte, (u64)__pa(pgd));
538 if (flags & PASID_FLAG_FL5LP)
539 pasid_set_flpm(pte, 1);
541 if (flags & PASID_FLAG_PAGE_SNOOP)
542 pasid_set_pgsnp(pte);
544 pasid_set_domain_id(pte, did);
545 pasid_set_address_width(pte, iommu->agaw);
546 pasid_set_page_snoop(pte, !!ecap_smpwc(iommu->ecap));
549 /* Setup Present and PASID Granular Transfer Type: */
550 pasid_set_translation_type(pte, PASID_ENTRY_PGTT_FL_ONLY);
551 pasid_set_present(pte);
552 spin_unlock(&iommu->lock);
554 pasid_flush_caches(iommu, pte, pasid, did);
560 * Skip top levels of page tables for iommu which has less agaw
561 * than default. Unnecessary for PT mode.
563 static inline int iommu_skip_agaw(struct dmar_domain *domain,
564 struct intel_iommu *iommu,
565 struct dma_pte **pgd)
569 for (agaw = domain->agaw; agaw > iommu->agaw; agaw--) {
570 *pgd = phys_to_virt(dma_pte_addr(*pgd));
571 if (!dma_pte_present(*pgd))
579 * Set up the scalable mode pasid entry for second only translation type.
581 int intel_pasid_setup_second_level(struct intel_iommu *iommu,
582 struct dmar_domain *domain,
583 struct device *dev, u32 pasid)
585 struct pasid_entry *pte;
592 * If hardware advertises no support for second level
593 * translation, return directly.
595 if (!ecap_slts(iommu->ecap)) {
596 pr_err("No second level translation support on %s\n",
602 agaw = iommu_skip_agaw(domain, iommu, &pgd);
604 dev_err(dev, "Invalid domain page table\n");
608 pgd_val = virt_to_phys(pgd);
609 did = domain_id_iommu(domain, iommu);
611 spin_lock(&iommu->lock);
612 pte = intel_pasid_get_entry(dev, pasid);
614 spin_unlock(&iommu->lock);
618 if (pasid_pte_is_present(pte)) {
619 spin_unlock(&iommu->lock);
623 pasid_clear_entry(pte);
624 pasid_set_domain_id(pte, did);
625 pasid_set_slptr(pte, pgd_val);
626 pasid_set_address_width(pte, agaw);
627 pasid_set_translation_type(pte, PASID_ENTRY_PGTT_SL_ONLY);
628 pasid_set_fault_enable(pte);
629 pasid_set_page_snoop(pte, !!ecap_smpwc(iommu->ecap));
631 pasid_set_present(pte);
632 spin_unlock(&iommu->lock);
634 pasid_flush_caches(iommu, pte, pasid, did);
640 * Set up the scalable mode pasid entry for passthrough translation type.
642 int intel_pasid_setup_pass_through(struct intel_iommu *iommu,
643 struct dmar_domain *domain,
644 struct device *dev, u32 pasid)
646 u16 did = FLPT_DEFAULT_DID;
647 struct pasid_entry *pte;
649 spin_lock(&iommu->lock);
650 pte = intel_pasid_get_entry(dev, pasid);
652 spin_unlock(&iommu->lock);
656 if (pasid_pte_is_present(pte)) {
657 spin_unlock(&iommu->lock);
661 pasid_clear_entry(pte);
662 pasid_set_domain_id(pte, did);
663 pasid_set_address_width(pte, iommu->agaw);
664 pasid_set_translation_type(pte, PASID_ENTRY_PGTT_PT);
665 pasid_set_fault_enable(pte);
666 pasid_set_page_snoop(pte, !!ecap_smpwc(iommu->ecap));
667 pasid_set_present(pte);
668 spin_unlock(&iommu->lock);
670 pasid_flush_caches(iommu, pte, pasid, did);
676 * Set the page snoop control for a pasid entry which has been set up.
678 void intel_pasid_setup_page_snoop_control(struct intel_iommu *iommu,
679 struct device *dev, u32 pasid)
681 struct pasid_entry *pte;
684 spin_lock(&iommu->lock);
685 pte = intel_pasid_get_entry(dev, pasid);
686 if (WARN_ON(!pte || !pasid_pte_is_present(pte))) {
687 spin_unlock(&iommu->lock);
691 pasid_set_pgsnp(pte);
692 did = pasid_get_domain_id(pte);
693 spin_unlock(&iommu->lock);
695 if (!ecap_coherent(iommu->ecap))
696 clflush_cache_range(pte, sizeof(*pte));
699 * VT-d spec 3.4 table23 states guides for cache invalidation:
701 * - PASID-selective-within-Domain PASID-cache invalidation
702 * - PASID-selective PASID-based IOTLB invalidation
703 * - If (pasid is RID_PASID)
704 * - Global Device-TLB invalidation to affected functions
706 * - PASID-based Device-TLB invalidation (with S=1 and
707 * Addr[63:12]=0x7FFFFFFF_FFFFF) to affected functions
709 pasid_cache_invalidation_with_pasid(iommu, did, pasid);
710 qi_flush_piotlb(iommu, did, pasid, 0, -1, 0);
712 /* Device IOTLB doesn't need to be flushed in caching mode. */
713 if (!cap_caching_mode(iommu->cap))
714 devtlb_invalidation_with_pasid(iommu, dev, pasid);