]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/virtio/virtio_pci_common.h
virtio_pci: remove struct virtio_pci_vq_info
[karo-tx-linux.git] / 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         /* MSI-X support */
68         int msix_enabled;
69         int intx_enabled;
70         cpumask_var_t *msix_affinity_masks;
71         /* Name strings for interrupts. This size should be enough,
72          * and I'm too lazy to allocate each name separately. */
73         char (*msix_names)[256];
74         /* Number of available vectors */
75         unsigned msix_vectors;
76         /* Vectors allocated, excluding per-vq vectors if any */
77         unsigned msix_used_vectors;
78
79         /* Map of per-VQ MSI-X vectors, may be NULL */
80         unsigned *msix_vector_map;
81
82         struct virtqueue *(*setup_vq)(struct virtio_pci_device *vp_dev,
83                                       unsigned idx,
84                                       void (*callback)(struct virtqueue *vq),
85                                       const char *name,
86                                       u16 msix_vec);
87         void (*del_vq)(struct virtqueue *vq);
88
89         u16 (*config_vector)(struct virtio_pci_device *vp_dev, u16 vector);
90 };
91
92 /* Constants for MSI-X */
93 /* Use first vector for configuration changes, second and the rest for
94  * virtqueues Thus, we need at least 2 vectors for MSI. */
95 enum {
96         VP_MSIX_CONFIG_VECTOR = 0,
97         VP_MSIX_VQ_VECTOR = 1,
98 };
99
100 /* Convert a generic virtio device to our structure */
101 static struct virtio_pci_device *to_vp_device(struct virtio_device *vdev)
102 {
103         return container_of(vdev, struct virtio_pci_device, vdev);
104 }
105
106 /* wait for pending irq handlers */
107 void vp_synchronize_vectors(struct virtio_device *vdev);
108 /* the notify function used when creating a virt queue */
109 bool vp_notify(struct virtqueue *vq);
110 /* the config->del_vqs() implementation */
111 void vp_del_vqs(struct virtio_device *vdev);
112 /* the config->find_vqs() implementation */
113 int vp_find_vqs(struct virtio_device *vdev, unsigned nvqs,
114                        struct virtqueue *vqs[],
115                        vq_callback_t *callbacks[],
116                        const char * const names[]);
117 const char *vp_bus_name(struct virtio_device *vdev);
118
119 /* Setup the affinity for a virtqueue:
120  * - force the affinity for per vq vector
121  * - OR over all affinities for shared MSI
122  * - ignore the affinity request if we're using INTX
123  */
124 int vp_set_vq_affinity(struct virtqueue *vq, int cpu);
125
126 #if IS_ENABLED(CONFIG_VIRTIO_PCI_LEGACY)
127 int virtio_pci_legacy_probe(struct virtio_pci_device *);
128 void virtio_pci_legacy_remove(struct virtio_pci_device *);
129 #else
130 static inline int virtio_pci_legacy_probe(struct virtio_pci_device *vp_dev)
131 {
132         return -ENODEV;
133 }
134 static inline void virtio_pci_legacy_remove(struct virtio_pci_device *vp_dev)
135 {
136 }
137 #endif
138 int virtio_pci_modern_probe(struct virtio_pci_device *);
139 void virtio_pci_modern_remove(struct virtio_pci_device *);
140
141 #endif