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