drivers/virtio/virtio_pci_common.h

   1 #ifndef _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
   2 #define _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
   3 /*
   4  * Virtio PCI driver - APIs for common functionality for all device versions
   5  *
   6  * This module allows virtio devices to be used over a virtual PCI device.
   7  * This can be used with QEMU based VMMs like KVM or Xen.
   8  *
   9  * Copyright IBM Corp. 2007
  10  * Copyright Red Hat, Inc. 2014
  11  *
  12  * Authors:
  13  *  Anthony Liguori  <aliguori@us.ibm.com>
  14  *  Rusty Russell <rusty@rustcorp.com.au>
  15  *  Michael S. Tsirkin <mst@redhat.com>
  16  *
  17  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  18  * See the COPYING file in the top-level directory.
  19  *
  20  */
  21
  22 #include <linux/module.h>
  23 #include <linux/list.h>
  24 #include <linux/pci.h>
  25 #include <linux/slab.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/virtio.h>
  28 #include <linux/virtio_config.h>
  29 #include <linux/virtio_ring.h>
  30 #include <linux/virtio_pci.h>
  31 #include <linux/highmem.h>
  32 #include <linux/spinlock.h>
  33
  34 /* Our device structure */
  35 struct virtio_pci_device {
  36         struct virtio_device vdev;
  37         struct pci_dev *pci_dev;
  38
  39         /* In legacy mode, these two point to within ->legacy. */
  40         /* Where to read and clear interrupt */
  41         u8 __iomem *isr;
  42
  43         /* Modern only fields */
  44         /* The IO mapping for the PCI config space (non-legacy mode) */
  45         struct virtio_pci_common_cfg __iomem *common;
  46         /* Device-specific data (non-legacy mode)  */
  47         void __iomem *device;
  48         /* Base of vq notifications (non-legacy mode). */
  49         void __iomem *notify_base;
  50
  51         /* So we can sanity-check accesses. */
  52         size_t notify_len;
  53         size_t device_len;
  54
  55         /* Capability for when we need to map notifications per-vq. */
  56         int notify_map_cap;
  57
  58         /* Multiply queue_notify_off by this value. (non-legacy mode). */
  59         u32 notify_offset_multiplier;
  60
  61         int modern_bars;
  62
  63         /* Legacy only field */
  64         /* the IO mapping for the PCI config space */
  65         void __iomem *ioaddr;
  66
  67         cpumask_var_t *msix_affinity_masks;
  68         /* Name strings for interrupts. This size should be enough,
  69          * and I'm too lazy to allocate each name separately. */
  70         char (*msix_names)[256];
  71         /* Total Number of MSI-X vectors (including per-VQ ones). */
  72         int msix_vectors;
  73         /* Map of per-VQ MSI-X vectors, may be NULL */
  74         unsigned *msix_vector_map;
  75
  76         struct virtqueue *(*setup_vq)(struct virtio_pci_device *vp_dev,
  77                                       unsigned idx,
  78                                       void (*callback)(struct virtqueue *vq),
  79                                       const char *name,
  80                                       u16 msix_vec);
  81         void (*del_vq)(struct virtqueue *vq);
  82
  83         u16 (*config_vector)(struct virtio_pci_device *vp_dev, u16 vector);
  84 };
  85
  86 /* Convert a generic virtio device to our structure */
  87 static struct virtio_pci_device *to_vp_device(struct virtio_device *vdev)
  88 {
  89         return container_of(vdev, struct virtio_pci_device, vdev);
  90 }
  91
  92 /* wait for pending irq handlers */
  93 void vp_synchronize_vectors(struct virtio_device *vdev);
  94 /* the notify function used when creating a virt queue */
  95 bool vp_notify(struct virtqueue *vq);
  96 /* the config->del_vqs() implementation */
  97 void vp_del_vqs(struct virtio_device *vdev);
  98 /* the config->find_vqs() implementation */
  99 int vp_find_vqs(struct virtio_device *vdev, unsigned nvqs,
 100                 struct virtqueue *vqs[], vq_callback_t *callbacks[],
 101                 const char * const names[], struct irq_affinity *desc);
 102 const char *vp_bus_name(struct virtio_device *vdev);
 103
 104 /* Setup the affinity for a virtqueue:
 105  * - force the affinity for per vq vector
 106  * - OR over all affinities for shared MSI
 107  * - ignore the affinity request if we're using INTX
 108  */
 109 int vp_set_vq_affinity(struct virtqueue *vq, int cpu);
 110
 111 const struct cpumask *vp_get_vq_affinity(struct virtio_device *vdev, int index);
 112
 113 #if IS_ENABLED(CONFIG_VIRTIO_PCI_LEGACY)
 114 int virtio_pci_legacy_probe(struct virtio_pci_device *);
 115 void virtio_pci_legacy_remove(struct virtio_pci_device *);
 116 #else
 117 static inline int virtio_pci_legacy_probe(struct virtio_pci_device *vp_dev)
 118 {
 119         return -ENODEV;
 120 }
 121 static inline void virtio_pci_legacy_remove(struct virtio_pci_device *vp_dev)
 122 {
 123 }
 124 #endif
 125 int virtio_pci_modern_probe(struct virtio_pci_device *);
 126 void virtio_pci_modern_remove(struct virtio_pci_device *);
 127
 128 #endif