2 * Volume Management Device driver
3 * Copyright (c) 2015, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/device.h>
16 #include <linux/interrupt.h>
17 #include <linux/irq.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/msi.h>
21 #include <linux/pci.h>
22 #include <linux/rculist.h>
23 #include <linux/rcupdate.h>
25 #include <asm/irqdomain.h>
26 #include <asm/device.h>
28 #include <asm/msidef.h>
35 * Lock for manipulating VMD IRQ lists.
37 static DEFINE_RAW_SPINLOCK(list_lock);
40 * struct vmd_irq - private data to map driver IRQ to the VMD shared vector
41 * @node: list item for parent traversal.
42 * @rcu: RCU callback item for freeing.
43 * @irq: back pointer to parent.
44 * @virq: the virtual IRQ value provided to the requesting driver.
46 * Every MSI/MSI-X IRQ requested for a device in a VMD domain will be mapped to
47 * a VMD IRQ using this structure.
50 struct list_head node;
52 struct vmd_irq_list *irq;
57 * struct vmd_irq_list - list of driver requested IRQs mapping to a VMD vector
58 * @irq_list: the list of irq's the VMD one demuxes to.
59 * @vmd_vector: the h/w IRQ assigned to the VMD.
60 * @index: index into the VMD MSI-X table; used for message routing.
61 * @count: number of child IRQs assigned to this vector; used to track
65 struct list_head irq_list;
67 unsigned int vmd_vector;
79 struct msix_entry *msix_entries;
80 struct vmd_irq_list *irqs;
82 struct pci_sysdata sysdata;
83 struct resource resources[3];
84 struct irq_domain *irq_domain;
87 #ifdef CONFIG_X86_DEV_DMA_OPS
88 struct dma_map_ops dma_ops;
89 struct dma_domain dma_domain;
93 static inline struct vmd_dev *vmd_from_bus(struct pci_bus *bus)
95 return container_of(bus->sysdata, struct vmd_dev, sysdata);
99 * Drivers managing a device in a VMD domain allocate their own IRQs as before,
100 * but the MSI entry for the hardware it's driving will be programmed with a
101 * destination ID for the VMD MSI-X table. The VMD muxes interrupts in its
102 * domain into one of its own, and the VMD driver de-muxes these for the
103 * handlers sharing that VMD IRQ. The vmd irq_domain provides the operations
104 * and irq_chip to set this up.
106 static void vmd_compose_msi_msg(struct irq_data *data, struct msi_msg *msg)
108 struct vmd_irq *vmdirq = data->chip_data;
109 struct vmd_irq_list *irq = vmdirq->irq;
111 msg->address_hi = MSI_ADDR_BASE_HI;
112 msg->address_lo = MSI_ADDR_BASE_LO | MSI_ADDR_DEST_ID(irq->index);
117 * We rely on MSI_FLAG_USE_DEF_CHIP_OPS to set the IRQ mask/unmask ops.
119 static void vmd_irq_enable(struct irq_data *data)
121 struct vmd_irq *vmdirq = data->chip_data;
124 raw_spin_lock_irqsave(&list_lock, flags);
125 list_add_tail_rcu(&vmdirq->node, &vmdirq->irq->irq_list);
126 raw_spin_unlock_irqrestore(&list_lock, flags);
128 data->chip->irq_unmask(data);
131 static void vmd_irq_disable(struct irq_data *data)
133 struct vmd_irq *vmdirq = data->chip_data;
136 data->chip->irq_mask(data);
138 raw_spin_lock_irqsave(&list_lock, flags);
139 list_del_rcu(&vmdirq->node);
140 INIT_LIST_HEAD_RCU(&vmdirq->node);
141 raw_spin_unlock_irqrestore(&list_lock, flags);
145 * XXX: Stubbed until we develop acceptable way to not create conflicts with
146 * other devices sharing the same vector.
148 static int vmd_irq_set_affinity(struct irq_data *data,
149 const struct cpumask *dest, bool force)
154 static struct irq_chip vmd_msi_controller = {
156 .irq_enable = vmd_irq_enable,
157 .irq_disable = vmd_irq_disable,
158 .irq_compose_msi_msg = vmd_compose_msi_msg,
159 .irq_set_affinity = vmd_irq_set_affinity,
162 static irq_hw_number_t vmd_get_hwirq(struct msi_domain_info *info,
163 msi_alloc_info_t *arg)
169 * XXX: We can be even smarter selecting the best IRQ once we solve the
172 static struct vmd_irq_list *vmd_next_irq(struct vmd_dev *vmd, struct msi_desc *desc)
177 if (!desc->msi_attrib.is_msix || vmd->msix_count == 1)
178 return &vmd->irqs[0];
180 raw_spin_lock_irqsave(&list_lock, flags);
181 for (i = 1; i < vmd->msix_count; i++)
182 if (vmd->irqs[i].count < vmd->irqs[best].count)
184 vmd->irqs[best].count++;
185 raw_spin_unlock_irqrestore(&list_lock, flags);
187 return &vmd->irqs[best];
190 static int vmd_msi_init(struct irq_domain *domain, struct msi_domain_info *info,
191 unsigned int virq, irq_hw_number_t hwirq,
192 msi_alloc_info_t *arg)
194 struct msi_desc *desc = arg->desc;
195 struct vmd_dev *vmd = vmd_from_bus(msi_desc_to_pci_dev(desc)->bus);
196 struct vmd_irq *vmdirq = kzalloc(sizeof(*vmdirq), GFP_KERNEL);
201 INIT_LIST_HEAD(&vmdirq->node);
202 vmdirq->irq = vmd_next_irq(vmd, desc);
205 irq_domain_set_info(domain, virq, vmdirq->irq->vmd_vector, info->chip,
206 vmdirq, handle_untracked_irq, vmd, NULL);
210 static void vmd_msi_free(struct irq_domain *domain,
211 struct msi_domain_info *info, unsigned int virq)
213 struct vmd_irq *vmdirq = irq_get_chip_data(virq);
216 /* XXX: Potential optimization to rebalance */
217 raw_spin_lock_irqsave(&list_lock, flags);
218 vmdirq->irq->count--;
219 raw_spin_unlock_irqrestore(&list_lock, flags);
221 kfree_rcu(vmdirq, rcu);
224 static int vmd_msi_prepare(struct irq_domain *domain, struct device *dev,
225 int nvec, msi_alloc_info_t *arg)
227 struct pci_dev *pdev = to_pci_dev(dev);
228 struct vmd_dev *vmd = vmd_from_bus(pdev->bus);
230 if (nvec > vmd->msix_count)
231 return vmd->msix_count;
233 memset(arg, 0, sizeof(*arg));
237 static void vmd_set_desc(msi_alloc_info_t *arg, struct msi_desc *desc)
242 static struct msi_domain_ops vmd_msi_domain_ops = {
243 .get_hwirq = vmd_get_hwirq,
244 .msi_init = vmd_msi_init,
245 .msi_free = vmd_msi_free,
246 .msi_prepare = vmd_msi_prepare,
247 .set_desc = vmd_set_desc,
250 static struct msi_domain_info vmd_msi_domain_info = {
251 .flags = MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
253 .ops = &vmd_msi_domain_ops,
254 .chip = &vmd_msi_controller,
257 #ifdef CONFIG_X86_DEV_DMA_OPS
259 * VMD replaces the requester ID with its own. DMA mappings for devices in a
260 * VMD domain need to be mapped for the VMD, not the device requiring
263 static struct device *to_vmd_dev(struct device *dev)
265 struct pci_dev *pdev = to_pci_dev(dev);
266 struct vmd_dev *vmd = vmd_from_bus(pdev->bus);
268 return &vmd->dev->dev;
271 static struct dma_map_ops *vmd_dma_ops(struct device *dev)
273 return get_dma_ops(to_vmd_dev(dev));
276 static void *vmd_alloc(struct device *dev, size_t size, dma_addr_t *addr,
277 gfp_t flag, unsigned long attrs)
279 return vmd_dma_ops(dev)->alloc(to_vmd_dev(dev), size, addr, flag,
283 static void vmd_free(struct device *dev, size_t size, void *vaddr,
284 dma_addr_t addr, unsigned long attrs)
286 return vmd_dma_ops(dev)->free(to_vmd_dev(dev), size, vaddr, addr,
290 static int vmd_mmap(struct device *dev, struct vm_area_struct *vma,
291 void *cpu_addr, dma_addr_t addr, size_t size,
294 return vmd_dma_ops(dev)->mmap(to_vmd_dev(dev), vma, cpu_addr, addr,
298 static int vmd_get_sgtable(struct device *dev, struct sg_table *sgt,
299 void *cpu_addr, dma_addr_t addr, size_t size,
302 return vmd_dma_ops(dev)->get_sgtable(to_vmd_dev(dev), sgt, cpu_addr,
306 static dma_addr_t vmd_map_page(struct device *dev, struct page *page,
307 unsigned long offset, size_t size,
308 enum dma_data_direction dir,
311 return vmd_dma_ops(dev)->map_page(to_vmd_dev(dev), page, offset, size,
315 static void vmd_unmap_page(struct device *dev, dma_addr_t addr, size_t size,
316 enum dma_data_direction dir, unsigned long attrs)
318 vmd_dma_ops(dev)->unmap_page(to_vmd_dev(dev), addr, size, dir, attrs);
321 static int vmd_map_sg(struct device *dev, struct scatterlist *sg, int nents,
322 enum dma_data_direction dir, unsigned long attrs)
324 return vmd_dma_ops(dev)->map_sg(to_vmd_dev(dev), sg, nents, dir, attrs);
327 static void vmd_unmap_sg(struct device *dev, struct scatterlist *sg, int nents,
328 enum dma_data_direction dir, unsigned long attrs)
330 vmd_dma_ops(dev)->unmap_sg(to_vmd_dev(dev), sg, nents, dir, attrs);
333 static void vmd_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
334 size_t size, enum dma_data_direction dir)
336 vmd_dma_ops(dev)->sync_single_for_cpu(to_vmd_dev(dev), addr, size, dir);
339 static void vmd_sync_single_for_device(struct device *dev, dma_addr_t addr,
340 size_t size, enum dma_data_direction dir)
342 vmd_dma_ops(dev)->sync_single_for_device(to_vmd_dev(dev), addr, size,
346 static void vmd_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
347 int nents, enum dma_data_direction dir)
349 vmd_dma_ops(dev)->sync_sg_for_cpu(to_vmd_dev(dev), sg, nents, dir);
352 static void vmd_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
353 int nents, enum dma_data_direction dir)
355 vmd_dma_ops(dev)->sync_sg_for_device(to_vmd_dev(dev), sg, nents, dir);
358 static int vmd_mapping_error(struct device *dev, dma_addr_t addr)
360 return vmd_dma_ops(dev)->mapping_error(to_vmd_dev(dev), addr);
363 static int vmd_dma_supported(struct device *dev, u64 mask)
365 return vmd_dma_ops(dev)->dma_supported(to_vmd_dev(dev), mask);
368 #ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK
369 static u64 vmd_get_required_mask(struct device *dev)
371 return vmd_dma_ops(dev)->get_required_mask(to_vmd_dev(dev));
375 static void vmd_teardown_dma_ops(struct vmd_dev *vmd)
377 struct dma_domain *domain = &vmd->dma_domain;
379 if (get_dma_ops(&vmd->dev->dev))
380 del_dma_domain(domain);
383 #define ASSIGN_VMD_DMA_OPS(source, dest, fn) \
386 dest->fn = vmd_##fn; \
389 static void vmd_setup_dma_ops(struct vmd_dev *vmd)
391 const struct dma_map_ops *source = get_dma_ops(&vmd->dev->dev);
392 struct dma_map_ops *dest = &vmd->dma_ops;
393 struct dma_domain *domain = &vmd->dma_domain;
395 domain->domain_nr = vmd->sysdata.domain;
396 domain->dma_ops = dest;
400 ASSIGN_VMD_DMA_OPS(source, dest, alloc);
401 ASSIGN_VMD_DMA_OPS(source, dest, free);
402 ASSIGN_VMD_DMA_OPS(source, dest, mmap);
403 ASSIGN_VMD_DMA_OPS(source, dest, get_sgtable);
404 ASSIGN_VMD_DMA_OPS(source, dest, map_page);
405 ASSIGN_VMD_DMA_OPS(source, dest, unmap_page);
406 ASSIGN_VMD_DMA_OPS(source, dest, map_sg);
407 ASSIGN_VMD_DMA_OPS(source, dest, unmap_sg);
408 ASSIGN_VMD_DMA_OPS(source, dest, sync_single_for_cpu);
409 ASSIGN_VMD_DMA_OPS(source, dest, sync_single_for_device);
410 ASSIGN_VMD_DMA_OPS(source, dest, sync_sg_for_cpu);
411 ASSIGN_VMD_DMA_OPS(source, dest, sync_sg_for_device);
412 ASSIGN_VMD_DMA_OPS(source, dest, mapping_error);
413 ASSIGN_VMD_DMA_OPS(source, dest, dma_supported);
414 #ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK
415 ASSIGN_VMD_DMA_OPS(source, dest, get_required_mask);
417 add_dma_domain(domain);
419 #undef ASSIGN_VMD_DMA_OPS
421 static void vmd_teardown_dma_ops(struct vmd_dev *vmd) {}
422 static void vmd_setup_dma_ops(struct vmd_dev *vmd) {}
425 static char __iomem *vmd_cfg_addr(struct vmd_dev *vmd, struct pci_bus *bus,
426 unsigned int devfn, int reg, int len)
428 char __iomem *addr = vmd->cfgbar +
429 (bus->number << 20) + (devfn << 12) + reg;
431 if ((addr - vmd->cfgbar) + len >=
432 resource_size(&vmd->dev->resource[VMD_CFGBAR]))
439 * CPU may deadlock if config space is not serialized on some versions of this
440 * hardware, so all config space access is done under a spinlock.
442 static int vmd_pci_read(struct pci_bus *bus, unsigned int devfn, int reg,
445 struct vmd_dev *vmd = vmd_from_bus(bus);
446 char __iomem *addr = vmd_cfg_addr(vmd, bus, devfn, reg, len);
453 spin_lock_irqsave(&vmd->cfg_lock, flags);
456 *value = readb(addr);
459 *value = readw(addr);
462 *value = readl(addr);
468 spin_unlock_irqrestore(&vmd->cfg_lock, flags);
473 * VMD h/w converts non-posted config writes to posted memory writes. The
474 * read-back in this function forces the completion so it returns only after
475 * the config space was written, as expected.
477 static int vmd_pci_write(struct pci_bus *bus, unsigned int devfn, int reg,
480 struct vmd_dev *vmd = vmd_from_bus(bus);
481 char __iomem *addr = vmd_cfg_addr(vmd, bus, devfn, reg, len);
488 spin_lock_irqsave(&vmd->cfg_lock, flags);
506 spin_unlock_irqrestore(&vmd->cfg_lock, flags);
510 static struct pci_ops vmd_ops = {
511 .read = vmd_pci_read,
512 .write = vmd_pci_write,
515 static void vmd_attach_resources(struct vmd_dev *vmd)
517 vmd->dev->resource[VMD_MEMBAR1].child = &vmd->resources[1];
518 vmd->dev->resource[VMD_MEMBAR2].child = &vmd->resources[2];
521 static void vmd_detach_resources(struct vmd_dev *vmd)
523 vmd->dev->resource[VMD_MEMBAR1].child = NULL;
524 vmd->dev->resource[VMD_MEMBAR2].child = NULL;
528 * VMD domains start at 0x1000 to not clash with ACPI _SEG domains.
530 static int vmd_find_free_domain(void)
533 struct pci_bus *bus = NULL;
535 while ((bus = pci_find_next_bus(bus)) != NULL)
536 domain = max_t(int, domain, pci_domain_nr(bus));
540 static int vmd_enable_domain(struct vmd_dev *vmd)
542 struct pci_sysdata *sd = &vmd->sysdata;
543 struct resource *res;
546 LIST_HEAD(resources);
548 res = &vmd->dev->resource[VMD_CFGBAR];
549 vmd->resources[0] = (struct resource) {
550 .name = "VMD CFGBAR",
552 .end = (resource_size(res) >> 20) - 1,
553 .flags = IORESOURCE_BUS | IORESOURCE_PCI_FIXED,
557 * If the window is below 4GB, clear IORESOURCE_MEM_64 so we can
558 * put 32-bit resources in the window.
560 * There's no hardware reason why a 64-bit window *couldn't*
561 * contain a 32-bit resource, but pbus_size_mem() computes the
562 * bridge window size assuming a 64-bit window will contain no
563 * 32-bit resources. __pci_assign_resource() enforces that
564 * artificial restriction to make sure everything will fit.
566 * The only way we could use a 64-bit non-prefechable MEMBAR is
567 * if its address is <4GB so that we can convert it to a 32-bit
568 * resource. To be visible to the host OS, all VMD endpoints must
569 * be initially configured by platform BIOS, which includes setting
570 * up these resources. We can assume the device is configured
571 * according to the platform needs.
573 res = &vmd->dev->resource[VMD_MEMBAR1];
574 upper_bits = upper_32_bits(res->end);
575 flags = res->flags & ~IORESOURCE_SIZEALIGN;
577 flags &= ~IORESOURCE_MEM_64;
578 vmd->resources[1] = (struct resource) {
579 .name = "VMD MEMBAR1",
586 res = &vmd->dev->resource[VMD_MEMBAR2];
587 upper_bits = upper_32_bits(res->end);
588 flags = res->flags & ~IORESOURCE_SIZEALIGN;
590 flags &= ~IORESOURCE_MEM_64;
591 vmd->resources[2] = (struct resource) {
592 .name = "VMD MEMBAR2",
593 .start = res->start + 0x2000,
599 sd->domain = vmd_find_free_domain();
603 sd->node = pcibus_to_node(vmd->dev->bus);
605 vmd->irq_domain = pci_msi_create_irq_domain(NULL, &vmd_msi_domain_info,
607 if (!vmd->irq_domain)
610 pci_add_resource(&resources, &vmd->resources[0]);
611 pci_add_resource(&resources, &vmd->resources[1]);
612 pci_add_resource(&resources, &vmd->resources[2]);
613 vmd->bus = pci_create_root_bus(&vmd->dev->dev, 0, &vmd_ops, sd,
616 pci_free_resource_list(&resources);
617 irq_domain_remove(vmd->irq_domain);
621 vmd_attach_resources(vmd);
622 vmd_setup_dma_ops(vmd);
623 dev_set_msi_domain(&vmd->bus->dev, vmd->irq_domain);
624 pci_rescan_bus(vmd->bus);
626 WARN(sysfs_create_link(&vmd->dev->dev.kobj, &vmd->bus->dev.kobj,
627 "domain"), "Can't create symlink to domain\n");
631 static irqreturn_t vmd_irq(int irq, void *data)
633 struct vmd_irq_list *irqs = data;
634 struct vmd_irq *vmdirq;
637 list_for_each_entry_rcu(vmdirq, &irqs->irq_list, node)
638 generic_handle_irq(vmdirq->virq);
644 static int vmd_probe(struct pci_dev *dev, const struct pci_device_id *id)
649 if (resource_size(&dev->resource[VMD_CFGBAR]) < (1 << 20))
652 vmd = devm_kzalloc(&dev->dev, sizeof(*vmd), GFP_KERNEL);
657 err = pcim_enable_device(dev);
661 vmd->cfgbar = pcim_iomap(dev, VMD_CFGBAR, 0);
666 if (dma_set_mask_and_coherent(&dev->dev, DMA_BIT_MASK(64)) &&
667 dma_set_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32)))
670 vmd->msix_count = pci_msix_vec_count(dev);
671 if (vmd->msix_count < 0)
674 vmd->irqs = devm_kcalloc(&dev->dev, vmd->msix_count, sizeof(*vmd->irqs),
679 vmd->msix_entries = devm_kcalloc(&dev->dev, vmd->msix_count,
680 sizeof(*vmd->msix_entries),
682 if (!vmd->msix_entries)
684 for (i = 0; i < vmd->msix_count; i++)
685 vmd->msix_entries[i].entry = i;
687 vmd->msix_count = pci_enable_msix_range(vmd->dev, vmd->msix_entries, 1,
689 if (vmd->msix_count < 0)
690 return vmd->msix_count;
692 for (i = 0; i < vmd->msix_count; i++) {
693 INIT_LIST_HEAD(&vmd->irqs[i].irq_list);
694 vmd->irqs[i].vmd_vector = vmd->msix_entries[i].vector;
695 vmd->irqs[i].index = i;
697 err = devm_request_irq(&dev->dev, vmd->irqs[i].vmd_vector,
698 vmd_irq, 0, "vmd", &vmd->irqs[i]);
703 spin_lock_init(&vmd->cfg_lock);
704 pci_set_drvdata(dev, vmd);
705 err = vmd_enable_domain(vmd);
709 dev_info(&vmd->dev->dev, "Bound to PCI domain %04x\n",
710 vmd->sysdata.domain);
714 static void vmd_remove(struct pci_dev *dev)
716 struct vmd_dev *vmd = pci_get_drvdata(dev);
718 vmd_detach_resources(vmd);
719 pci_set_drvdata(dev, NULL);
720 sysfs_remove_link(&vmd->dev->dev.kobj, "domain");
721 pci_stop_root_bus(vmd->bus);
722 pci_remove_root_bus(vmd->bus);
723 vmd_teardown_dma_ops(vmd);
724 irq_domain_remove(vmd->irq_domain);
728 static int vmd_suspend(struct device *dev)
730 struct pci_dev *pdev = to_pci_dev(dev);
732 pci_save_state(pdev);
736 static int vmd_resume(struct device *dev)
738 struct pci_dev *pdev = to_pci_dev(dev);
740 pci_restore_state(pdev);
744 static SIMPLE_DEV_PM_OPS(vmd_dev_pm_ops, vmd_suspend, vmd_resume);
746 static const struct pci_device_id vmd_ids[] = {
747 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x201d),},
750 MODULE_DEVICE_TABLE(pci, vmd_ids);
752 static struct pci_driver vmd_drv = {
756 .remove = vmd_remove,
758 .pm = &vmd_dev_pm_ops,
761 module_pci_driver(vmd_drv);
763 MODULE_AUTHOR("Intel Corporation");
764 MODULE_LICENSE("GPL v2");
765 MODULE_VERSION("0.6");