1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Virtio PCI driver - common functionality for all device versions
5 * This module allows virtio devices to be used over a virtual PCI device.
6 * This can be used with QEMU based VMMs like KVM or Xen.
8 * Copyright IBM Corp. 2007
9 * Copyright Red Hat, Inc. 2014
17 #include "virtio_pci_common.h"
19 static bool force_legacy = false;
21 #if IS_ENABLED(CONFIG_VIRTIO_PCI_LEGACY)
22 module_param(force_legacy, bool, 0444);
23 MODULE_PARM_DESC(force_legacy,
24 "Force legacy mode for transitional virtio 1 devices");
27 /* wait for pending irq handlers */
28 void vp_synchronize_vectors(struct virtio_device *vdev)
30 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
33 if (vp_dev->intx_enabled)
34 synchronize_irq(vp_dev->pci_dev->irq);
36 for (i = 0; i < vp_dev->msix_vectors; ++i)
37 synchronize_irq(pci_irq_vector(vp_dev->pci_dev, i));
40 /* the notify function used when creating a virt queue */
41 bool vp_notify(struct virtqueue *vq)
43 /* we write the queue's selector into the notification register to
44 * signal the other end */
45 iowrite16(vq->index, (void __iomem *)vq->priv);
49 /* Handle a configuration change: Tell driver if it wants to know. */
50 static irqreturn_t vp_config_changed(int irq, void *opaque)
52 struct virtio_pci_device *vp_dev = opaque;
54 virtio_config_changed(&vp_dev->vdev);
58 /* Notify all virtqueues on an interrupt. */
59 static irqreturn_t vp_vring_interrupt(int irq, void *opaque)
61 struct virtio_pci_device *vp_dev = opaque;
62 struct virtio_pci_vq_info *info;
63 irqreturn_t ret = IRQ_NONE;
66 spin_lock_irqsave(&vp_dev->lock, flags);
67 list_for_each_entry(info, &vp_dev->virtqueues, node) {
68 if (vring_interrupt(irq, info->vq) == IRQ_HANDLED)
71 spin_unlock_irqrestore(&vp_dev->lock, flags);
76 /* A small wrapper to also acknowledge the interrupt when it's handled.
77 * I really need an EIO hook for the vring so I can ack the interrupt once we
78 * know that we'll be handling the IRQ but before we invoke the callback since
79 * the callback may notify the host which results in the host attempting to
80 * raise an interrupt that we would then mask once we acknowledged the
82 static irqreturn_t vp_interrupt(int irq, void *opaque)
84 struct virtio_pci_device *vp_dev = opaque;
87 /* reading the ISR has the effect of also clearing it so it's very
88 * important to save off the value. */
89 isr = ioread8(vp_dev->isr);
91 /* It's definitely not us if the ISR was not high */
95 /* Configuration change? Tell driver if it wants to know. */
96 if (isr & VIRTIO_PCI_ISR_CONFIG)
97 vp_config_changed(irq, opaque);
99 return vp_vring_interrupt(irq, opaque);
102 static int vp_request_msix_vectors(struct virtio_device *vdev, int nvectors,
103 bool per_vq_vectors, struct irq_affinity *desc)
105 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
106 const char *name = dev_name(&vp_dev->vdev.dev);
107 unsigned int flags = PCI_IRQ_MSIX;
111 vp_dev->msix_vectors = nvectors;
113 vp_dev->msix_names = kmalloc_array(nvectors,
114 sizeof(*vp_dev->msix_names),
116 if (!vp_dev->msix_names)
118 vp_dev->msix_affinity_masks
119 = kcalloc(nvectors, sizeof(*vp_dev->msix_affinity_masks),
121 if (!vp_dev->msix_affinity_masks)
123 for (i = 0; i < nvectors; ++i)
124 if (!alloc_cpumask_var(&vp_dev->msix_affinity_masks[i],
129 flags |= PCI_IRQ_AFFINITY;
130 desc->pre_vectors++; /* virtio config vector */
133 err = pci_alloc_irq_vectors_affinity(vp_dev->pci_dev, nvectors,
134 nvectors, flags, desc);
137 vp_dev->msix_enabled = 1;
139 /* Set the vector used for configuration */
140 v = vp_dev->msix_used_vectors;
141 snprintf(vp_dev->msix_names[v], sizeof *vp_dev->msix_names,
143 err = request_irq(pci_irq_vector(vp_dev->pci_dev, v),
144 vp_config_changed, 0, vp_dev->msix_names[v],
148 ++vp_dev->msix_used_vectors;
150 v = vp_dev->config_vector(vp_dev, v);
151 /* Verify we had enough resources to assign the vector */
152 if (v == VIRTIO_MSI_NO_VECTOR) {
157 if (!per_vq_vectors) {
158 /* Shared vector for all VQs */
159 v = vp_dev->msix_used_vectors;
160 snprintf(vp_dev->msix_names[v], sizeof *vp_dev->msix_names,
161 "%s-virtqueues", name);
162 err = request_irq(pci_irq_vector(vp_dev->pci_dev, v),
163 vp_vring_interrupt, 0, vp_dev->msix_names[v],
167 ++vp_dev->msix_used_vectors;
174 static struct virtqueue *vp_setup_vq(struct virtio_device *vdev, unsigned int index,
175 void (*callback)(struct virtqueue *vq),
180 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
181 struct virtio_pci_vq_info *info = kmalloc(sizeof *info, GFP_KERNEL);
182 struct virtqueue *vq;
185 /* fill out our structure that represents an active queue */
187 return ERR_PTR(-ENOMEM);
189 vq = vp_dev->setup_vq(vp_dev, info, index, callback, name, ctx,
196 spin_lock_irqsave(&vp_dev->lock, flags);
197 list_add(&info->node, &vp_dev->virtqueues);
198 spin_unlock_irqrestore(&vp_dev->lock, flags);
200 INIT_LIST_HEAD(&info->node);
203 vp_dev->vqs[index] = info;
211 static void vp_del_vq(struct virtqueue *vq)
213 struct virtio_pci_device *vp_dev = to_vp_device(vq->vdev);
214 struct virtio_pci_vq_info *info = vp_dev->vqs[vq->index];
218 * If it fails during re-enable reset vq. This way we won't rejoin
219 * info->node to the queue. Prevent unexpected irqs.
222 spin_lock_irqsave(&vp_dev->lock, flags);
223 list_del(&info->node);
224 spin_unlock_irqrestore(&vp_dev->lock, flags);
227 vp_dev->del_vq(info);
231 /* the config->del_vqs() implementation */
232 void vp_del_vqs(struct virtio_device *vdev)
234 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
235 struct virtqueue *vq, *n;
238 list_for_each_entry_safe(vq, n, &vdev->vqs, list) {
239 if (vp_dev->is_avq(vdev, vq->index))
242 if (vp_dev->per_vq_vectors) {
243 int v = vp_dev->vqs[vq->index]->msix_vector;
245 if (v != VIRTIO_MSI_NO_VECTOR) {
246 int irq = pci_irq_vector(vp_dev->pci_dev, v);
248 irq_update_affinity_hint(irq, NULL);
254 vp_dev->per_vq_vectors = false;
256 if (vp_dev->intx_enabled) {
257 free_irq(vp_dev->pci_dev->irq, vp_dev);
258 vp_dev->intx_enabled = 0;
261 for (i = 0; i < vp_dev->msix_used_vectors; ++i)
262 free_irq(pci_irq_vector(vp_dev->pci_dev, i), vp_dev);
264 if (vp_dev->msix_affinity_masks) {
265 for (i = 0; i < vp_dev->msix_vectors; i++)
266 free_cpumask_var(vp_dev->msix_affinity_masks[i]);
269 if (vp_dev->msix_enabled) {
270 /* Disable the vector used for configuration */
271 vp_dev->config_vector(vp_dev, VIRTIO_MSI_NO_VECTOR);
273 pci_free_irq_vectors(vp_dev->pci_dev);
274 vp_dev->msix_enabled = 0;
277 vp_dev->msix_vectors = 0;
278 vp_dev->msix_used_vectors = 0;
279 kfree(vp_dev->msix_names);
280 vp_dev->msix_names = NULL;
281 kfree(vp_dev->msix_affinity_masks);
282 vp_dev->msix_affinity_masks = NULL;
287 static int vp_find_vqs_msix(struct virtio_device *vdev, unsigned int nvqs,
288 struct virtqueue *vqs[], vq_callback_t *callbacks[],
289 const char * const names[], bool per_vq_vectors,
291 struct irq_affinity *desc)
293 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
295 int i, err, nvectors, allocated_vectors, queue_idx = 0;
297 vp_dev->vqs = kcalloc(nvqs, sizeof(*vp_dev->vqs), GFP_KERNEL);
301 if (per_vq_vectors) {
302 /* Best option: one for change interrupt, one per vq. */
304 for (i = 0; i < nvqs; ++i)
305 if (names[i] && callbacks[i])
308 /* Second best: one for change, shared for all vqs. */
312 err = vp_request_msix_vectors(vdev, nvectors, per_vq_vectors,
313 per_vq_vectors ? desc : NULL);
317 vp_dev->per_vq_vectors = per_vq_vectors;
318 allocated_vectors = vp_dev->msix_used_vectors;
319 for (i = 0; i < nvqs; ++i) {
326 msix_vec = VIRTIO_MSI_NO_VECTOR;
327 else if (vp_dev->per_vq_vectors)
328 msix_vec = allocated_vectors++;
330 msix_vec = VP_MSIX_VQ_VECTOR;
331 vqs[i] = vp_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
332 ctx ? ctx[i] : false,
334 if (IS_ERR(vqs[i])) {
335 err = PTR_ERR(vqs[i]);
339 if (!vp_dev->per_vq_vectors || msix_vec == VIRTIO_MSI_NO_VECTOR)
342 /* allocate per-vq irq if available and necessary */
343 snprintf(vp_dev->msix_names[msix_vec],
344 sizeof *vp_dev->msix_names,
346 dev_name(&vp_dev->vdev.dev), names[i]);
347 err = request_irq(pci_irq_vector(vp_dev->pci_dev, msix_vec),
349 vp_dev->msix_names[msix_vec],
361 static int vp_find_vqs_intx(struct virtio_device *vdev, unsigned int nvqs,
362 struct virtqueue *vqs[], vq_callback_t *callbacks[],
363 const char * const names[], const bool *ctx)
365 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
366 int i, err, queue_idx = 0;
368 vp_dev->vqs = kcalloc(nvqs, sizeof(*vp_dev->vqs), GFP_KERNEL);
372 err = request_irq(vp_dev->pci_dev->irq, vp_interrupt, IRQF_SHARED,
373 dev_name(&vdev->dev), vp_dev);
377 vp_dev->intx_enabled = 1;
378 vp_dev->per_vq_vectors = false;
379 for (i = 0; i < nvqs; ++i) {
384 vqs[i] = vp_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
385 ctx ? ctx[i] : false,
386 VIRTIO_MSI_NO_VECTOR);
387 if (IS_ERR(vqs[i])) {
388 err = PTR_ERR(vqs[i]);
399 /* the config->find_vqs() implementation */
400 int vp_find_vqs(struct virtio_device *vdev, unsigned int nvqs,
401 struct virtqueue *vqs[], vq_callback_t *callbacks[],
402 const char * const names[], const bool *ctx,
403 struct irq_affinity *desc)
407 /* Try MSI-X with one vector per queue. */
408 err = vp_find_vqs_msix(vdev, nvqs, vqs, callbacks, names, true, ctx, desc);
411 /* Fallback: MSI-X with one vector for config, one shared for queues. */
412 err = vp_find_vqs_msix(vdev, nvqs, vqs, callbacks, names, false, ctx, desc);
415 /* Is there an interrupt? If not give up. */
416 if (!(to_vp_device(vdev)->pci_dev->irq))
418 /* Finally fall back to regular interrupts. */
419 return vp_find_vqs_intx(vdev, nvqs, vqs, callbacks, names, ctx);
422 const char *vp_bus_name(struct virtio_device *vdev)
424 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
426 return pci_name(vp_dev->pci_dev);
429 /* Setup the affinity for a virtqueue:
430 * - force the affinity for per vq vector
431 * - OR over all affinities for shared MSI
432 * - ignore the affinity request if we're using INTX
434 int vp_set_vq_affinity(struct virtqueue *vq, const struct cpumask *cpu_mask)
436 struct virtio_device *vdev = vq->vdev;
437 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
438 struct virtio_pci_vq_info *info = vp_dev->vqs[vq->index];
439 struct cpumask *mask;
445 if (vp_dev->msix_enabled) {
446 mask = vp_dev->msix_affinity_masks[info->msix_vector];
447 irq = pci_irq_vector(vp_dev->pci_dev, info->msix_vector);
449 irq_update_affinity_hint(irq, NULL);
451 cpumask_copy(mask, cpu_mask);
452 irq_set_affinity_and_hint(irq, mask);
458 const struct cpumask *vp_get_vq_affinity(struct virtio_device *vdev, int index)
460 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
462 if (!vp_dev->per_vq_vectors ||
463 vp_dev->vqs[index]->msix_vector == VIRTIO_MSI_NO_VECTOR)
466 return pci_irq_get_affinity(vp_dev->pci_dev,
467 vp_dev->vqs[index]->msix_vector);
470 #ifdef CONFIG_PM_SLEEP
471 static int virtio_pci_freeze(struct device *dev)
473 struct pci_dev *pci_dev = to_pci_dev(dev);
474 struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
477 ret = virtio_device_freeze(&vp_dev->vdev);
480 pci_disable_device(pci_dev);
484 static int virtio_pci_restore(struct device *dev)
486 struct pci_dev *pci_dev = to_pci_dev(dev);
487 struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
490 ret = pci_enable_device(pci_dev);
494 pci_set_master(pci_dev);
495 return virtio_device_restore(&vp_dev->vdev);
498 static bool vp_supports_pm_no_reset(struct device *dev)
500 struct pci_dev *pci_dev = to_pci_dev(dev);
503 if (!pci_dev->pm_cap)
506 pci_read_config_word(pci_dev, pci_dev->pm_cap + PCI_PM_CTRL, &pmcsr);
507 if (PCI_POSSIBLE_ERROR(pmcsr)) {
508 dev_err(dev, "Unable to query pmcsr");
512 return pmcsr & PCI_PM_CTRL_NO_SOFT_RESET;
515 static int virtio_pci_suspend(struct device *dev)
517 return vp_supports_pm_no_reset(dev) ? 0 : virtio_pci_freeze(dev);
520 static int virtio_pci_resume(struct device *dev)
522 return vp_supports_pm_no_reset(dev) ? 0 : virtio_pci_restore(dev);
525 static const struct dev_pm_ops virtio_pci_pm_ops = {
526 .suspend = virtio_pci_suspend,
527 .resume = virtio_pci_resume,
528 .freeze = virtio_pci_freeze,
529 .thaw = virtio_pci_restore,
530 .poweroff = virtio_pci_freeze,
531 .restore = virtio_pci_restore,
536 /* Qumranet donated their vendor ID for devices 0x1000 thru 0x10FF. */
537 static const struct pci_device_id virtio_pci_id_table[] = {
538 { PCI_DEVICE(PCI_VENDOR_ID_REDHAT_QUMRANET, PCI_ANY_ID) },
542 MODULE_DEVICE_TABLE(pci, virtio_pci_id_table);
544 static void virtio_pci_release_dev(struct device *_d)
546 struct virtio_device *vdev = dev_to_virtio(_d);
547 struct virtio_pci_device *vp_dev = to_vp_device(vdev);
549 /* As struct device is a kobject, it's not safe to
550 * free the memory (including the reference counter itself)
551 * until it's release callback. */
555 static int virtio_pci_probe(struct pci_dev *pci_dev,
556 const struct pci_device_id *id)
558 struct virtio_pci_device *vp_dev, *reg_dev = NULL;
561 /* allocate our structure and fill it out */
562 vp_dev = kzalloc(sizeof(struct virtio_pci_device), GFP_KERNEL);
566 pci_set_drvdata(pci_dev, vp_dev);
567 vp_dev->vdev.dev.parent = &pci_dev->dev;
568 vp_dev->vdev.dev.release = virtio_pci_release_dev;
569 vp_dev->pci_dev = pci_dev;
570 INIT_LIST_HEAD(&vp_dev->virtqueues);
571 spin_lock_init(&vp_dev->lock);
573 /* enable the device */
574 rc = pci_enable_device(pci_dev);
576 goto err_enable_device;
579 rc = virtio_pci_legacy_probe(vp_dev);
580 /* Also try modern mode if we can't map BAR0 (no IO space). */
581 if (rc == -ENODEV || rc == -ENOMEM)
582 rc = virtio_pci_modern_probe(vp_dev);
586 rc = virtio_pci_modern_probe(vp_dev);
588 rc = virtio_pci_legacy_probe(vp_dev);
593 pci_set_master(pci_dev);
595 rc = register_virtio_device(&vp_dev->vdev);
603 if (vp_dev->is_legacy)
604 virtio_pci_legacy_remove(vp_dev);
606 virtio_pci_modern_remove(vp_dev);
608 pci_disable_device(pci_dev);
611 put_device(&vp_dev->vdev.dev);
617 static void virtio_pci_remove(struct pci_dev *pci_dev)
619 struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
620 struct device *dev = get_device(&vp_dev->vdev.dev);
623 * Device is marked broken on surprise removal so that virtio upper
624 * layers can abort any ongoing operation.
626 if (!pci_device_is_present(pci_dev))
627 virtio_break_device(&vp_dev->vdev);
629 pci_disable_sriov(pci_dev);
631 unregister_virtio_device(&vp_dev->vdev);
633 if (vp_dev->is_legacy)
634 virtio_pci_legacy_remove(vp_dev);
636 virtio_pci_modern_remove(vp_dev);
638 pci_disable_device(pci_dev);
642 static int virtio_pci_sriov_configure(struct pci_dev *pci_dev, int num_vfs)
644 struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
645 struct virtio_device *vdev = &vp_dev->vdev;
648 if (!(vdev->config->get_status(vdev) & VIRTIO_CONFIG_S_DRIVER_OK))
651 if (!__virtio_test_bit(vdev, VIRTIO_F_SR_IOV))
654 if (pci_vfs_assigned(pci_dev))
658 pci_disable_sriov(pci_dev);
662 ret = pci_enable_sriov(pci_dev, num_vfs);
669 static struct pci_driver virtio_pci_driver = {
670 .name = "virtio-pci",
671 .id_table = virtio_pci_id_table,
672 .probe = virtio_pci_probe,
673 .remove = virtio_pci_remove,
674 #ifdef CONFIG_PM_SLEEP
675 .driver.pm = &virtio_pci_pm_ops,
677 .sriov_configure = virtio_pci_sriov_configure,
680 struct virtio_device *virtio_pci_vf_get_pf_dev(struct pci_dev *pdev)
682 struct virtio_pci_device *pf_vp_dev;
684 pf_vp_dev = pci_iov_get_pf_drvdata(pdev, &virtio_pci_driver);
685 if (IS_ERR(pf_vp_dev))
688 return &pf_vp_dev->vdev;
691 module_pci_driver(virtio_pci_driver);
694 MODULE_DESCRIPTION("virtio-pci");
695 MODULE_LICENSE("GPL");