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 struct VirtIOPCIProxy {
  95     PCIDevice pci_dev;
  96     MemoryRegion bar;
  97     MemoryRegion common;
  98     MemoryRegion isr;
  99     MemoryRegion device;
 100     MemoryRegion notify;
 101     MemoryRegion modern_bar;
 102     uint32_t flags;
 103     uint32_t class_code;
 104     uint32_t nvectors;
 105     uint32_t dfselect;
 106     uint32_t gfselect;
 107     uint32_t guest_features[2];
 108     struct {
 109         uint16_t num;
 110         bool enabled;
 111         uint32_t desc[2];
 112         uint32_t avail[2];
 113         uint32_t used[2];
 114     } vqs[VIRTIO_QUEUE_MAX];
 115
 116     bool ioeventfd_disabled;
 117     bool ioeventfd_started;
 118     VirtIOIRQFD *vector_irqfd;
 119     int nvqs_with_notifiers;
 120     VirtioBusState bus;
 121 };
 122
 123
 124 /*
 125  * virtio-scsi-pci: This extends VirtioPCIProxy.
 126  */
 127 #define TYPE_VIRTIO_SCSI_PCI "virtio-scsi-pci"
 128 #define VIRTIO_SCSI_PCI(obj) \
 129         OBJECT_CHECK(VirtIOSCSIPCI, (obj), TYPE_VIRTIO_SCSI_PCI)
 130
 131 struct VirtIOSCSIPCI {
 132     VirtIOPCIProxy parent_obj;
 133     VirtIOSCSI vdev;
 134 };
 135
 136 #ifdef CONFIG_VHOST_SCSI
 137 /*
 138  * vhost-scsi-pci: This extends VirtioPCIProxy.
 139  */
 140 #define TYPE_VHOST_SCSI_PCI "vhost-scsi-pci"
 141 #define VHOST_SCSI_PCI(obj) \
 142         OBJECT_CHECK(VHostSCSIPCI, (obj), TYPE_VHOST_SCSI_PCI)
 143
 144 struct VHostSCSIPCI {
 145     VirtIOPCIProxy parent_obj;
 146     VHostSCSI vdev;
 147 };
 148 #endif
 149
 150 /*
 151  * virtio-blk-pci: This extends VirtioPCIProxy.
 152  */
 153 #define TYPE_VIRTIO_BLK_PCI "virtio-blk-pci"
 154 #define VIRTIO_BLK_PCI(obj) \
 155         OBJECT_CHECK(VirtIOBlkPCI, (obj), TYPE_VIRTIO_BLK_PCI)
 156
 157 struct VirtIOBlkPCI {
 158     VirtIOPCIProxy parent_obj;
 159     VirtIOBlock vdev;
 160 };
 161
 162 /*
 163  * virtio-balloon-pci: This extends VirtioPCIProxy.
 164  */
 165 #define TYPE_VIRTIO_BALLOON_PCI "virtio-balloon-pci"
 166 #define VIRTIO_BALLOON_PCI(obj) \
 167         OBJECT_CHECK(VirtIOBalloonPCI, (obj), TYPE_VIRTIO_BALLOON_PCI)
 168
 169 struct VirtIOBalloonPCI {
 170     VirtIOPCIProxy parent_obj;
 171     VirtIOBalloon vdev;
 172 };
 173
 174 /*
 175  * virtio-serial-pci: This extends VirtioPCIProxy.
 176  */
 177 #define TYPE_VIRTIO_SERIAL_PCI "virtio-serial-pci"
 178 #define VIRTIO_SERIAL_PCI(obj) \
 179         OBJECT_CHECK(VirtIOSerialPCI, (obj), TYPE_VIRTIO_SERIAL_PCI)
 180
 181 struct VirtIOSerialPCI {
 182     VirtIOPCIProxy parent_obj;
 183     VirtIOSerial vdev;
 184 };
 185
 186 /*
 187  * virtio-net-pci: This extends VirtioPCIProxy.
 188  */
 189 #define TYPE_VIRTIO_NET_PCI "virtio-net-pci"
 190 #define VIRTIO_NET_PCI(obj) \
 191         OBJECT_CHECK(VirtIONetPCI, (obj), TYPE_VIRTIO_NET_PCI)
 192
 193 struct VirtIONetPCI {
 194     VirtIOPCIProxy parent_obj;
 195     VirtIONet vdev;
 196 };
 197
 198 /*
 199  * virtio-9p-pci: This extends VirtioPCIProxy.
 200  */
 201
 202 #ifdef CONFIG_VIRTFS
 203
 204 #define TYPE_VIRTIO_9P_PCI "virtio-9p-pci"
 205 #define VIRTIO_9P_PCI(obj) \
 206         OBJECT_CHECK(V9fsPCIState, (obj), TYPE_VIRTIO_9P_PCI)
 207
 208 typedef struct V9fsPCIState {
 209     VirtIOPCIProxy parent_obj;
 210     V9fsState vdev;
 211 } V9fsPCIState;
 212
 213 #endif
 214
 215 /*
 216  * virtio-rng-pci: This extends VirtioPCIProxy.
 217  */
 218 #define TYPE_VIRTIO_RNG_PCI "virtio-rng-pci"
 219 #define VIRTIO_RNG_PCI(obj) \
 220         OBJECT_CHECK(VirtIORngPCI, (obj), TYPE_VIRTIO_RNG_PCI)
 221
 222 struct VirtIORngPCI {
 223     VirtIOPCIProxy parent_obj;
 224     VirtIORNG vdev;
 225 };
 226
 227 /* Virtio ABI version, if we increment this, we break the guest driver. */
 228 #define VIRTIO_PCI_ABI_VERSION          0
 229
 230 #endif