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   <[email protected]>
   9  *  Paul Brook        <[email protected]>
  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 #include "hw/virtio/virtio-input.h"
  28 #ifdef CONFIG_VIRTFS
  29 #include "hw/9pfs/virtio-9p.h"
  30 #endif
  31 #ifdef CONFIG_VHOST_SCSI
  32 #include "hw/virtio/vhost-scsi.h"
  33 #endif
  34
  35 typedef struct VirtIOPCIProxy VirtIOPCIProxy;
  36 typedef struct VirtIOBlkPCI VirtIOBlkPCI;
  37 typedef struct VirtIOSCSIPCI VirtIOSCSIPCI;
  38 typedef struct VirtIOBalloonPCI VirtIOBalloonPCI;
  39 typedef struct VirtIOSerialPCI VirtIOSerialPCI;
  40 typedef struct VirtIONetPCI VirtIONetPCI;
  41 typedef struct VHostSCSIPCI VHostSCSIPCI;
  42 typedef struct VirtIORngPCI VirtIORngPCI;
  43 typedef struct VirtIOInputPCI VirtIOInputPCI;
  44 typedef struct VirtIOInputHIDPCI VirtIOInputHIDPCI;
  45
  46 /* virtio-pci-bus */
  47
  48 typedef struct VirtioBusState VirtioPCIBusState;
  49 typedef struct VirtioBusClass VirtioPCIBusClass;
  50
  51 #define TYPE_VIRTIO_PCI_BUS "virtio-pci-bus"
  52 #define VIRTIO_PCI_BUS(obj) \
  53         OBJECT_CHECK(VirtioPCIBusState, (obj), TYPE_VIRTIO_PCI_BUS)
  54 #define VIRTIO_PCI_BUS_GET_CLASS(obj) \
  55         OBJECT_GET_CLASS(VirtioPCIBusClass, obj, TYPE_VIRTIO_PCI_BUS)
  56 #define VIRTIO_PCI_BUS_CLASS(klass) \
  57         OBJECT_CLASS_CHECK(VirtioPCIBusClass, klass, TYPE_VIRTIO_PCI_BUS)
  58
  59 /* Need to activate work-arounds for buggy guests at vmstate load. */
  60 #define VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION_BIT  0
  61 #define VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION \
  62     (1 << VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION_BIT)
  63
  64 /* Performance improves when virtqueue kick processing is decoupled from the
  65  * vcpu thread using ioeventfd for some devices. */
  66 #define VIRTIO_PCI_FLAG_USE_IOEVENTFD_BIT 1
  67 #define VIRTIO_PCI_FLAG_USE_IOEVENTFD   (1 << VIRTIO_PCI_FLAG_USE_IOEVENTFD_BIT)
  68
  69 /* virtio version flags */
  70 #define VIRTIO_PCI_FLAG_DISABLE_LEGACY_BIT 2
  71 #define VIRTIO_PCI_FLAG_DISABLE_MODERN_BIT 3
  72 #define VIRTIO_PCI_FLAG_DISABLE_LEGACY (1 << VIRTIO_PCI_FLAG_DISABLE_LEGACY_BIT)
  73 #define VIRTIO_PCI_FLAG_DISABLE_MODERN (1 << VIRTIO_PCI_FLAG_DISABLE_MODERN_BIT)
  74
  75 typedef struct {
  76     MSIMessage msg;
  77     int virq;
  78     unsigned int users;
  79 } VirtIOIRQFD;
  80
  81 /*
  82  * virtio-pci: This is the PCIDevice which has a virtio-pci-bus.
  83  */
  84 #define TYPE_VIRTIO_PCI "virtio-pci"
  85 #define VIRTIO_PCI_GET_CLASS(obj) \
  86         OBJECT_GET_CLASS(VirtioPCIClass, obj, TYPE_VIRTIO_PCI)
  87 #define VIRTIO_PCI_CLASS(klass) \
  88         OBJECT_CLASS_CHECK(VirtioPCIClass, klass, TYPE_VIRTIO_PCI)
  89 #define VIRTIO_PCI(obj) \
  90         OBJECT_CHECK(VirtIOPCIProxy, (obj), TYPE_VIRTIO_PCI)
  91
  92 typedef struct VirtioPCIClass {
  93     PCIDeviceClass parent_class;
  94     void (*realize)(VirtIOPCIProxy *vpci_dev, Error **errp);
  95 } VirtioPCIClass;
  96
  97 typedef struct VirtIOPCIRegion {
  98     MemoryRegion mr;
  99     uint32_t offset;
 100     uint32_t size;
 101     uint32_t type;
 102 } VirtIOPCIRegion;
 103
 104 struct VirtIOPCIProxy {
 105     PCIDevice pci_dev;
 106     MemoryRegion bar;
 107     VirtIOPCIRegion common;
 108     VirtIOPCIRegion isr;
 109     VirtIOPCIRegion device;
 110     VirtIOPCIRegion notify;
 111     MemoryRegion modern_bar;
 112     uint32_t legacy_io_bar;
 113     uint32_t msix_bar;
 114     uint32_t modern_mem_bar;
 115     uint32_t flags;
 116     uint32_t class_code;
 117     uint32_t nvectors;
 118     uint32_t dfselect;
 119     uint32_t gfselect;
 120     uint32_t guest_features[2];
 121     struct {
 122         uint16_t num;
 123         bool enabled;
 124         uint32_t desc[2];
 125         uint32_t avail[2];
 126         uint32_t used[2];
 127     } vqs[VIRTIO_QUEUE_MAX];
 128
 129     bool ioeventfd_disabled;
 130     bool ioeventfd_started;
 131     VirtIOIRQFD *vector_irqfd;
 132     int nvqs_with_notifiers;
 133     VirtioBusState bus;
 134 };
 135
 136
 137 /*
 138  * virtio-scsi-pci: This extends VirtioPCIProxy.
 139  */
 140 #define TYPE_VIRTIO_SCSI_PCI "virtio-scsi-pci"
 141 #define VIRTIO_SCSI_PCI(obj) \
 142         OBJECT_CHECK(VirtIOSCSIPCI, (obj), TYPE_VIRTIO_SCSI_PCI)
 143
 144 struct VirtIOSCSIPCI {
 145     VirtIOPCIProxy parent_obj;
 146     VirtIOSCSI vdev;
 147 };
 148
 149 #ifdef CONFIG_VHOST_SCSI
 150 /*
 151  * vhost-scsi-pci: This extends VirtioPCIProxy.
 152  */
 153 #define TYPE_VHOST_SCSI_PCI "vhost-scsi-pci"
 154 #define VHOST_SCSI_PCI(obj) \
 155         OBJECT_CHECK(VHostSCSIPCI, (obj), TYPE_VHOST_SCSI_PCI)
 156
 157 struct VHostSCSIPCI {
 158     VirtIOPCIProxy parent_obj;
 159     VHostSCSI vdev;
 160 };
 161 #endif
 162
 163 /*
 164  * virtio-blk-pci: This extends VirtioPCIProxy.
 165  */
 166 #define TYPE_VIRTIO_BLK_PCI "virtio-blk-pci"
 167 #define VIRTIO_BLK_PCI(obj) \
 168         OBJECT_CHECK(VirtIOBlkPCI, (obj), TYPE_VIRTIO_BLK_PCI)
 169
 170 struct VirtIOBlkPCI {
 171     VirtIOPCIProxy parent_obj;
 172     VirtIOBlock vdev;
 173 };
 174
 175 /*
 176  * virtio-balloon-pci: This extends VirtioPCIProxy.
 177  */
 178 #define TYPE_VIRTIO_BALLOON_PCI "virtio-balloon-pci"
 179 #define VIRTIO_BALLOON_PCI(obj) \
 180         OBJECT_CHECK(VirtIOBalloonPCI, (obj), TYPE_VIRTIO_BALLOON_PCI)
 181
 182 struct VirtIOBalloonPCI {
 183     VirtIOPCIProxy parent_obj;
 184     VirtIOBalloon vdev;
 185 };
 186
 187 /*
 188  * virtio-serial-pci: This extends VirtioPCIProxy.
 189  */
 190 #define TYPE_VIRTIO_SERIAL_PCI "virtio-serial-pci"
 191 #define VIRTIO_SERIAL_PCI(obj) \
 192         OBJECT_CHECK(VirtIOSerialPCI, (obj), TYPE_VIRTIO_SERIAL_PCI)
 193
 194 struct VirtIOSerialPCI {
 195     VirtIOPCIProxy parent_obj;
 196     VirtIOSerial vdev;
 197 };
 198
 199 /*
 200  * virtio-net-pci: This extends VirtioPCIProxy.
 201  */
 202 #define TYPE_VIRTIO_NET_PCI "virtio-net-pci"
 203 #define VIRTIO_NET_PCI(obj) \
 204         OBJECT_CHECK(VirtIONetPCI, (obj), TYPE_VIRTIO_NET_PCI)
 205
 206 struct VirtIONetPCI {
 207     VirtIOPCIProxy parent_obj;
 208     VirtIONet vdev;
 209 };
 210
 211 /*
 212  * virtio-9p-pci: This extends VirtioPCIProxy.
 213  */
 214
 215 #ifdef CONFIG_VIRTFS
 216
 217 #define TYPE_VIRTIO_9P_PCI "virtio-9p-pci"
 218 #define VIRTIO_9P_PCI(obj) \
 219         OBJECT_CHECK(V9fsPCIState, (obj), TYPE_VIRTIO_9P_PCI)
 220
 221 typedef struct V9fsPCIState {
 222     VirtIOPCIProxy parent_obj;
 223     V9fsState vdev;
 224 } V9fsPCIState;
 225
 226 #endif
 227
 228 /*
 229  * virtio-rng-pci: This extends VirtioPCIProxy.
 230  */
 231 #define TYPE_VIRTIO_RNG_PCI "virtio-rng-pci"
 232 #define VIRTIO_RNG_PCI(obj) \
 233         OBJECT_CHECK(VirtIORngPCI, (obj), TYPE_VIRTIO_RNG_PCI)
 234
 235 struct VirtIORngPCI {
 236     VirtIOPCIProxy parent_obj;
 237     VirtIORNG vdev;
 238 };
 239
 240 /*
 241  * virtio-input-pci: This extends VirtioPCIProxy.
 242  */
 243 #define TYPE_VIRTIO_INPUT_PCI "virtio-input-pci"
 244 #define VIRTIO_INPUT_PCI(obj) \
 245         OBJECT_CHECK(VirtIOInputPCI, (obj), TYPE_VIRTIO_INPUT_PCI)
 246
 247 struct VirtIOInputPCI {
 248     VirtIOPCIProxy parent_obj;
 249     VirtIOInput vdev;
 250 };
 251
 252 #define TYPE_VIRTIO_INPUT_HID_PCI "virtio-input-hid-pci"
 253 #define TYPE_VIRTIO_KEYBOARD_PCI  "virtio-keyboard-pci"
 254 #define TYPE_VIRTIO_MOUSE_PCI     "virtio-mouse-pci"
 255 #define TYPE_VIRTIO_TABLET_PCI    "virtio-tablet-pci"
 256 #define VIRTIO_INPUT_HID_PCI(obj) \
 257         OBJECT_CHECK(VirtIOInputHIDPCI, (obj), TYPE_VIRTIO_INPUT_HID_PCI)
 258
 259 struct VirtIOInputHIDPCI {
 260     VirtIOPCIProxy parent_obj;
 261     VirtIOInputHID vdev;
 262 };
 263
 264 /* Virtio ABI version, if we increment this, we break the guest driver. */
 265 #define VIRTIO_PCI_ABI_VERSION          0
 266
 267 #endif