1 #ifndef _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
2 #define _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
4 * Virtio PCI driver - APIs for common functionality for all device versions
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.
9 * Copyright IBM Corp. 2007
10 * Copyright Red Hat, Inc. 2014
13 * Anthony Liguori <aliguori@us.ibm.com>
14 * Rusty Russell <rusty@rustcorp.com.au>
15 * Michael S. Tsirkin <mst@redhat.com>
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.
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>
34 /* Our device structure */
35 struct virtio_pci_device {
36 struct virtio_device vdev;
37 struct pci_dev *pci_dev;
39 /* In legacy mode, these two point to within ->legacy. */
40 /* Where to read and clear interrupt */
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) */
48 /* Base of vq notifications (non-legacy mode). */
49 void __iomem *notify_base;
51 /* So we can sanity-check accesses. */
55 /* Capability for when we need to map notifications per-vq. */
58 /* Multiply queue_notify_off by this value. (non-legacy mode). */
59 u32 notify_offset_multiplier;
63 /* Legacy only field */
64 /* the IO mapping for the PCI config space */
69 cpumask_var_t *msix_affinity_masks;
70 /* Name strings for interrupts. This size should be enough,
71 * and I'm too lazy to allocate each name separately. */
72 char (*msix_names)[256];
73 /* Total Number of MSI-X vectors (including per-VQ ones). */
75 /* Map of per-VQ MSI-X vectors, may be NULL */
76 unsigned *msix_vector_map;
78 struct virtqueue *(*setup_vq)(struct virtio_pci_device *vp_dev,
80 void (*callback)(struct virtqueue *vq),
83 void (*del_vq)(struct virtqueue *vq);
85 u16 (*config_vector)(struct virtio_pci_device *vp_dev, u16 vector);
88 /* Convert a generic virtio device to our structure */
89 static struct virtio_pci_device *to_vp_device(struct virtio_device *vdev)
91 return container_of(vdev, struct virtio_pci_device, vdev);
94 /* wait for pending irq handlers */
95 void vp_synchronize_vectors(struct virtio_device *vdev);
96 /* the notify function used when creating a virt queue */
97 bool vp_notify(struct virtqueue *vq);
98 /* the config->del_vqs() implementation */
99 void vp_del_vqs(struct virtio_device *vdev);
100 /* the config->find_vqs() implementation */
101 int vp_find_vqs(struct virtio_device *vdev, unsigned nvqs,
102 struct virtqueue *vqs[], vq_callback_t *callbacks[],
103 const char * const names[], struct irq_affinity *desc);
104 const char *vp_bus_name(struct virtio_device *vdev);
106 /* Setup the affinity for a virtqueue:
107 * - force the affinity for per vq vector
108 * - OR over all affinities for shared MSI
109 * - ignore the affinity request if we're using INTX
111 int vp_set_vq_affinity(struct virtqueue *vq, int cpu);
113 const struct cpumask *vp_get_vq_affinity(struct virtio_device *vdev, int index);
115 #if IS_ENABLED(CONFIG_VIRTIO_PCI_LEGACY)
116 int virtio_pci_legacy_probe(struct virtio_pci_device *);
117 void virtio_pci_legacy_remove(struct virtio_pci_device *);
119 static inline int virtio_pci_legacy_probe(struct virtio_pci_device *vp_dev)
123 static inline void virtio_pci_legacy_remove(struct virtio_pci_device *vp_dev)
127 int virtio_pci_modern_probe(struct virtio_pci_device *);
128 void virtio_pci_modern_remove(struct virtio_pci_device *);