hw/virtio/virtio-pci.h

   1 /*
   2  * Virtio PCI Bindings
   3  *
   4  * Copyright IBM, Corp. 2007
   5  * Copyright (c) 2009 CodeSourcery
   6  *
   7  * Authors:
   8  *  Anthony Liguori   <aliguori@us.ibm.com>
   9  *  Paul Brook        <paul@codesourcery.com>
  10  *
  11  * This work is licensed under the terms of the GNU GPL, version 2.  See
  12  * the COPYING file in the top-level directory.
  13  */
  14
  15 #ifndef QEMU_VIRTIO_PCI_H
  16 #define QEMU_VIRTIO_PCI_H
  17
  18 #include "hw/pci/msi.h"
  19 #include "hw/virtio/virtio-blk.h"
  20 #include "hw/virtio/virtio-net.h"
  21 #include "hw/virtio/virtio-rng.h"
  22 #include "hw/virtio/virtio-serial.h"
  23 #include "hw/virtio/virtio-scsi.h"
  24 #include "hw/virtio/virtio-balloon.h"
  25 #include "hw/virtio/virtio-bus.h"
  26 #include "hw/virtio/virtio-9p.h"
  27 #ifdef CONFIG_VIRTFS
  28 #include "hw/9pfs/virtio-9p.h"
  29 #endif
  30 #ifdef CONFIG_VHOST_SCSI
  31 #include "hw/virtio/vhost-scsi.h"
  32 #endif
  33
  34 typedef struct VirtIOPCIProxy VirtIOPCIProxy;
  35 typedef struct VirtIOBlkPCI VirtIOBlkPCI;
  36 typedef struct VirtIOSCSIPCI VirtIOSCSIPCI;
  37 typedef struct VirtIOBalloonPCI VirtIOBalloonPCI;
  38 typedef struct VirtIOSerialPCI VirtIOSerialPCI;
  39 typedef struct VirtIONetPCI VirtIONetPCI;
  40 typedef struct VHostSCSIPCI VHostSCSIPCI;
  41 typedef struct VirtIORngPCI VirtIORngPCI;
  42
  43 /* virtio-pci-bus */
  44
  45 typedef struct VirtioBusState VirtioPCIBusState;
  46 typedef struct VirtioBusClass VirtioPCIBusClass;
  47
  48 #define TYPE_VIRTIO_PCI_BUS "virtio-pci-bus"
  49 #define VIRTIO_PCI_BUS(obj) \
  50         OBJECT_CHECK(VirtioPCIBusState, (obj), TYPE_VIRTIO_PCI_BUS)
  51 #define VIRTIO_PCI_BUS_GET_CLASS(obj) \
  52         OBJECT_GET_CLASS(VirtioPCIBusClass, obj, TYPE_VIRTIO_PCI_BUS)
  53 #define VIRTIO_PCI_BUS_CLASS(klass) \
  54         OBJECT_CLASS_CHECK(VirtioPCIBusClass, klass, TYPE_VIRTIO_PCI_BUS)
  55
  56 /* Need to activate work-arounds for buggy guests at vmstate load. */
  57 #define VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION_BIT  0
  58 #define VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION \
  59     (1 << VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION_BIT)
  60
  61 /* Performance improves when virtqueue kick processing is decoupled from the
  62  * vcpu thread using ioeventfd for some devices. */
  63 #define VIRTIO_PCI_FLAG_USE_IOEVENTFD_BIT 1
  64 #define VIRTIO_PCI_FLAG_USE_IOEVENTFD   (1 << VIRTIO_PCI_FLAG_USE_IOEVENTFD_BIT)
  65
  66 /* virtio version flags */
  67 #define VIRTIO_PCI_FLAG_DISABLE_LEGACY_BIT 2
  68 #define VIRTIO_PCI_FLAG_DISABLE_MODERN_BIT 3
  69 #define VIRTIO_PCI_FLAG_DISABLE_LEGACY (1 << VIRTIO_PCI_FLAG_DISABLE_LEGACY_BIT)
  70 #define VIRTIO_PCI_FLAG_DISABLE_MODERN (1 << VIRTIO_PCI_FLAG_DISABLE_MODERN_BIT)
  71
  72 typedef struct {
  73     MSIMessage msg;
  74     int virq;
  75     unsigned int users;
  76 } VirtIOIRQFD;
  77
  78 /*
  79  * virtio-pci: This is the PCIDevice which has a virtio-pci-bus.
  80  */
  81 #define TYPE_VIRTIO_PCI "virtio-pci"
  82 #define VIRTIO_PCI_GET_CLASS(obj) \
  83         OBJECT_GET_CLASS(VirtioPCIClass, obj, TYPE_VIRTIO_PCI)
  84 #define VIRTIO_PCI_CLASS(klass) \
  85         OBJECT_CLASS_CHECK(VirtioPCIClass, klass, TYPE_VIRTIO_PCI)
  86 #define VIRTIO_PCI(obj) \
  87         OBJECT_CHECK(VirtIOPCIProxy, (obj), TYPE_VIRTIO_PCI)
  88
  89 typedef struct VirtioPCIClass {
  90     PCIDeviceClass parent_class;
  91     void (*realize)(VirtIOPCIProxy *vpci_dev, Error **errp);
  92 } VirtioPCIClass;
  93
  94 typedef struct VirtIOPCIRegion {
  95     MemoryRegion mr;
  96     uint32_t offset;
  97     uint32_t type;
  98 } VirtIOPCIRegion;
  99
 100 struct VirtIOPCIProxy {
 101     PCIDevice pci_dev;
 102     MemoryRegion bar;
 103     VirtIOPCIRegion common;
 104     VirtIOPCIRegion isr;
 105     VirtIOPCIRegion device;
 106     VirtIOPCIRegion notify;
 107     MemoryRegion modern_bar;
 108     uint32_t flags;
 109     uint32_t class_code;
 110     uint32_t nvectors;
 111     uint32_t dfselect;
 112     uint32_t gfselect;
 113     uint32_t guest_features[2];
 114     struct {
 115         uint16_t num;
 116         bool enabled;
 117         uint32_t desc[2];
 118         uint32_t avail[2];
 119         uint32_t used[2];
 120     } vqs[VIRTIO_QUEUE_MAX];
 121
 122     bool ioeventfd_disabled;
 123     bool ioeventfd_started;
 124     VirtIOIRQFD *vector_irqfd;
 125     int nvqs_with_notifiers;
 126     VirtioBusState bus;
 127 };
 128
 129
 130 /*
 131  * virtio-scsi-pci: This extends VirtioPCIProxy.
 132  */
 133 #define TYPE_VIRTIO_SCSI_PCI "virtio-scsi-pci"
 134 #define VIRTIO_SCSI_PCI(obj) \
 135         OBJECT_CHECK(VirtIOSCSIPCI, (obj), TYPE_VIRTIO_SCSI_PCI)
 136
 137 struct VirtIOSCSIPCI {
 138     VirtIOPCIProxy parent_obj;
 139     VirtIOSCSI vdev;
 140 };
 141
 142 #ifdef CONFIG_VHOST_SCSI
 143 /*
 144  * vhost-scsi-pci: This extends VirtioPCIProxy.
 145  */
 146 #define TYPE_VHOST_SCSI_PCI "vhost-scsi-pci"
 147 #define VHOST_SCSI_PCI(obj) \
 148         OBJECT_CHECK(VHostSCSIPCI, (obj), TYPE_VHOST_SCSI_PCI)
 149
 150 struct VHostSCSIPCI {
 151     VirtIOPCIProxy parent_obj;
 152     VHostSCSI vdev;
 153 };
 154 #endif
 155
 156 /*
 157  * virtio-blk-pci: This extends VirtioPCIProxy.
 158  */
 159 #define TYPE_VIRTIO_BLK_PCI "virtio-blk-pci"
 160 #define VIRTIO_BLK_PCI(obj) \
 161         OBJECT_CHECK(VirtIOBlkPCI, (obj), TYPE_VIRTIO_BLK_PCI)
 162
 163 struct VirtIOBlkPCI {
 164     VirtIOPCIProxy parent_obj;
 165     VirtIOBlock vdev;
 166 };
 167
 168 /*
 169  * virtio-balloon-pci: This extends VirtioPCIProxy.
 170  */
 171 #define TYPE_VIRTIO_BALLOON_PCI "virtio-balloon-pci"
 172 #define VIRTIO_BALLOON_PCI(obj) \
 173         OBJECT_CHECK(VirtIOBalloonPCI, (obj), TYPE_VIRTIO_BALLOON_PCI)
 174
 175 struct VirtIOBalloonPCI {
 176     VirtIOPCIProxy parent_obj;
 177     VirtIOBalloon vdev;
 178 };
 179
 180 /*
 181  * virtio-serial-pci: This extends VirtioPCIProxy.
 182  */
 183 #define TYPE_VIRTIO_SERIAL_PCI "virtio-serial-pci"
 184 #define VIRTIO_SERIAL_PCI(obj) \
 185         OBJECT_CHECK(VirtIOSerialPCI, (obj), TYPE_VIRTIO_SERIAL_PCI)
 186
 187 struct VirtIOSerialPCI {
 188     VirtIOPCIProxy parent_obj;
 189     VirtIOSerial vdev;
 190 };
 191
 192 /*
 193  * virtio-net-pci: This extends VirtioPCIProxy.
 194  */
 195 #define TYPE_VIRTIO_NET_PCI "virtio-net-pci"
 196 #define VIRTIO_NET_PCI(obj) \
 197         OBJECT_CHECK(VirtIONetPCI, (obj), TYPE_VIRTIO_NET_PCI)
 198
 199 struct VirtIONetPCI {
 200     VirtIOPCIProxy parent_obj;
 201     VirtIONet vdev;
 202 };
 203
 204 /*
 205  * virtio-9p-pci: This extends VirtioPCIProxy.
 206  */
 207
 208 #ifdef CONFIG_VIRTFS
 209
 210 #define TYPE_VIRTIO_9P_PCI "virtio-9p-pci"
 211 #define VIRTIO_9P_PCI(obj) \
 212         OBJECT_CHECK(V9fsPCIState, (obj), TYPE_VIRTIO_9P_PCI)
 213
 214 typedef struct V9fsPCIState {
 215     VirtIOPCIProxy parent_obj;
 216     V9fsState vdev;
 217 } V9fsPCIState;
 218
 219 #endif
 220
 221 /*
 222  * virtio-rng-pci: This extends VirtioPCIProxy.
 223  */
 224 #define TYPE_VIRTIO_RNG_PCI "virtio-rng-pci"
 225 #define VIRTIO_RNG_PCI(obj) \
 226         OBJECT_CHECK(VirtIORngPCI, (obj), TYPE_VIRTIO_RNG_PCI)
 227
 228 struct VirtIORngPCI {
 229     VirtIOPCIProxy parent_obj;
 230     VirtIORNG vdev;
 231 };
 232
 233 /* Virtio ABI version, if we increment this, we break the guest driver. */
 234 #define VIRTIO_PCI_ABI_VERSION          0
 235
 236 #endif