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