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-input.h"
  27 #include "hw/virtio/virtio-gpu.h"
  28 #include "hw/virtio/virtio-crypto.h"
  29
  30 #ifdef CONFIG_VIRTFS
  31 #include "hw/9pfs/virtio-9p.h"
  32 #endif
  33 #ifdef CONFIG_VHOST_SCSI
  34 #include "hw/virtio/vhost-scsi.h"
  35 #endif
  36 #ifdef CONFIG_VHOST_VSOCK
  37 #include "hw/virtio/vhost-vsock.h"
  38 #endif
  39
  40 typedef struct VirtIOPCIProxy VirtIOPCIProxy;
  41 typedef struct VirtIOBlkPCI VirtIOBlkPCI;
  42 typedef struct VirtIOSCSIPCI VirtIOSCSIPCI;
  43 typedef struct VirtIOBalloonPCI VirtIOBalloonPCI;
  44 typedef struct VirtIOSerialPCI VirtIOSerialPCI;
  45 typedef struct VirtIONetPCI VirtIONetPCI;
  46 typedef struct VHostSCSIPCI VHostSCSIPCI;
  47 typedef struct VirtIORngPCI VirtIORngPCI;
  48 typedef struct VirtIOInputPCI VirtIOInputPCI;
  49 typedef struct VirtIOInputHIDPCI VirtIOInputHIDPCI;
  50 typedef struct VirtIOInputHostPCI VirtIOInputHostPCI;
  51 typedef struct VirtIOGPUPCI VirtIOGPUPCI;
  52 typedef struct VHostVSockPCI VHostVSockPCI;
  53 typedef struct VirtIOCryptoPCI VirtIOCryptoPCI;
  54
  55 /* virtio-pci-bus */
  56
  57 typedef struct VirtioBusState VirtioPCIBusState;
  58 typedef struct VirtioBusClass VirtioPCIBusClass;
  59
  60 #define TYPE_VIRTIO_PCI_BUS "virtio-pci-bus"
  61 #define VIRTIO_PCI_BUS(obj) \
  62         OBJECT_CHECK(VirtioPCIBusState, (obj), TYPE_VIRTIO_PCI_BUS)
  63 #define VIRTIO_PCI_BUS_GET_CLASS(obj) \
  64         OBJECT_GET_CLASS(VirtioPCIBusClass, obj, TYPE_VIRTIO_PCI_BUS)
  65 #define VIRTIO_PCI_BUS_CLASS(klass) \
  66         OBJECT_CLASS_CHECK(VirtioPCIBusClass, klass, TYPE_VIRTIO_PCI_BUS)
  67
  68 enum {
  69     VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION_BIT,
  70     VIRTIO_PCI_FLAG_USE_IOEVENTFD_BIT,
  71     VIRTIO_PCI_FLAG_MIGRATE_EXTRA_BIT,
  72     VIRTIO_PCI_FLAG_MODERN_PIO_NOTIFY_BIT,
  73     VIRTIO_PCI_FLAG_DISABLE_PCIE_BIT,
  74     VIRTIO_PCI_FLAG_PAGE_PER_VQ_BIT,
  75 };
  76
  77 /* Need to activate work-arounds for buggy guests at vmstate load. */
  78 #define VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION \
  79     (1 << VIRTIO_PCI_FLAG_BUS_MASTER_BUG_MIGRATION_BIT)
  80
  81 /* Performance improves when virtqueue kick processing is decoupled from the
  82  * vcpu thread using ioeventfd for some devices. */
  83 #define VIRTIO_PCI_FLAG_USE_IOEVENTFD   (1 << VIRTIO_PCI_FLAG_USE_IOEVENTFD_BIT)
  84
  85 /* virtio version flags */
  86 #define VIRTIO_PCI_FLAG_DISABLE_PCIE (1 << VIRTIO_PCI_FLAG_DISABLE_PCIE_BIT)
  87
  88 /* migrate extra state */
  89 #define VIRTIO_PCI_FLAG_MIGRATE_EXTRA (1 << VIRTIO_PCI_FLAG_MIGRATE_EXTRA_BIT)
  90
  91 /* have pio notification for modern device ? */
  92 #define VIRTIO_PCI_FLAG_MODERN_PIO_NOTIFY \
  93     (1 << VIRTIO_PCI_FLAG_MODERN_PIO_NOTIFY_BIT)
  94
  95 /* page per vq flag to be used by split drivers within guests */
  96 #define VIRTIO_PCI_FLAG_PAGE_PER_VQ \
  97     (1 << VIRTIO_PCI_FLAG_PAGE_PER_VQ_BIT)
  98
  99 typedef struct {
 100     MSIMessage msg;
 101     int virq;
 102     unsigned int users;
 103 } VirtIOIRQFD;
 104
 105 /*
 106  * virtio-pci: This is the PCIDevice which has a virtio-pci-bus.
 107  */
 108 #define TYPE_VIRTIO_PCI "virtio-pci"
 109 #define VIRTIO_PCI_GET_CLASS(obj) \
 110         OBJECT_GET_CLASS(VirtioPCIClass, obj, TYPE_VIRTIO_PCI)
 111 #define VIRTIO_PCI_CLASS(klass) \
 112         OBJECT_CLASS_CHECK(VirtioPCIClass, klass, TYPE_VIRTIO_PCI)
 113 #define VIRTIO_PCI(obj) \
 114         OBJECT_CHECK(VirtIOPCIProxy, (obj), TYPE_VIRTIO_PCI)
 115
 116 typedef struct VirtioPCIClass {
 117     PCIDeviceClass parent_class;
 118     DeviceRealize parent_dc_realize;
 119     void (*realize)(VirtIOPCIProxy *vpci_dev, Error **errp);
 120 } VirtioPCIClass;
 121
 122 typedef struct VirtIOPCIRegion {
 123     MemoryRegion mr;
 124     uint32_t offset;
 125     uint32_t size;
 126     uint32_t type;
 127 } VirtIOPCIRegion;
 128
 129 typedef struct VirtIOPCIQueue {
 130   uint16_t num;
 131   bool enabled;
 132   uint32_t desc[2];
 133   uint32_t avail[2];
 134   uint32_t used[2];
 135 } VirtIOPCIQueue;
 136
 137 struct VirtIOPCIProxy {
 138     PCIDevice pci_dev;
 139     MemoryRegion bar;
 140     VirtIOPCIRegion common;
 141     VirtIOPCIRegion isr;
 142     VirtIOPCIRegion device;
 143     VirtIOPCIRegion notify;
 144     VirtIOPCIRegion notify_pio;
 145     MemoryRegion modern_bar;
 146     MemoryRegion io_bar;
 147     MemoryRegion modern_cfg;
 148     AddressSpace modern_as;
 149     uint32_t legacy_io_bar_idx;
 150     uint32_t msix_bar_idx;
 151     uint32_t modern_io_bar_idx;
 152     uint32_t modern_mem_bar_idx;
 153     int config_cap;
 154     uint32_t flags;
 155     bool disable_modern;
 156     OnOffAuto disable_legacy;
 157     uint32_t class_code;
 158     uint32_t nvectors;
 159     uint32_t dfselect;
 160     uint32_t gfselect;
 161     uint32_t guest_features[2];
 162     VirtIOPCIQueue vqs[VIRTIO_QUEUE_MAX];
 163
 164     VirtIOIRQFD *vector_irqfd;
 165     int nvqs_with_notifiers;
 166     VirtioBusState bus;
 167 };
 168
 169 static inline bool virtio_pci_modern(VirtIOPCIProxy *proxy)
 170 {
 171     return !proxy->disable_modern;
 172 }
 173
 174 static inline bool virtio_pci_legacy(VirtIOPCIProxy *proxy)
 175 {
 176     return proxy->disable_legacy == ON_OFF_AUTO_OFF;
 177 }
 178
 179 static inline void virtio_pci_force_virtio_1(VirtIOPCIProxy *proxy)
 180 {
 181     proxy->disable_modern = false;
 182     proxy->disable_legacy = ON_OFF_AUTO_ON;
 183 }
 184
 185 static inline void virtio_pci_disable_modern(VirtIOPCIProxy *proxy)
 186 {
 187     proxy->disable_modern = true;
 188 }
 189
 190 /*
 191  * virtio-scsi-pci: This extends VirtioPCIProxy.
 192  */
 193 #define TYPE_VIRTIO_SCSI_PCI "virtio-scsi-pci"
 194 #define VIRTIO_SCSI_PCI(obj) \
 195         OBJECT_CHECK(VirtIOSCSIPCI, (obj), TYPE_VIRTIO_SCSI_PCI)
 196
 197 struct VirtIOSCSIPCI {
 198     VirtIOPCIProxy parent_obj;
 199     VirtIOSCSI vdev;
 200 };
 201
 202 #ifdef CONFIG_VHOST_SCSI
 203 /*
 204  * vhost-scsi-pci: This extends VirtioPCIProxy.
 205  */
 206 #define TYPE_VHOST_SCSI_PCI "vhost-scsi-pci"
 207 #define VHOST_SCSI_PCI(obj) \
 208         OBJECT_CHECK(VHostSCSIPCI, (obj), TYPE_VHOST_SCSI_PCI)
 209
 210 struct VHostSCSIPCI {
 211     VirtIOPCIProxy parent_obj;
 212     VHostSCSI vdev;
 213 };
 214 #endif
 215
 216 /*
 217  * virtio-blk-pci: This extends VirtioPCIProxy.
 218  */
 219 #define TYPE_VIRTIO_BLK_PCI "virtio-blk-pci"
 220 #define VIRTIO_BLK_PCI(obj) \
 221         OBJECT_CHECK(VirtIOBlkPCI, (obj), TYPE_VIRTIO_BLK_PCI)
 222
 223 struct VirtIOBlkPCI {
 224     VirtIOPCIProxy parent_obj;
 225     VirtIOBlock vdev;
 226 };
 227
 228 /*
 229  * virtio-balloon-pci: This extends VirtioPCIProxy.
 230  */
 231 #define TYPE_VIRTIO_BALLOON_PCI "virtio-balloon-pci"
 232 #define VIRTIO_BALLOON_PCI(obj) \
 233         OBJECT_CHECK(VirtIOBalloonPCI, (obj), TYPE_VIRTIO_BALLOON_PCI)
 234
 235 struct VirtIOBalloonPCI {
 236     VirtIOPCIProxy parent_obj;
 237     VirtIOBalloon vdev;
 238 };
 239
 240 /*
 241  * virtio-serial-pci: This extends VirtioPCIProxy.
 242  */
 243 #define TYPE_VIRTIO_SERIAL_PCI "virtio-serial-pci"
 244 #define VIRTIO_SERIAL_PCI(obj) \
 245         OBJECT_CHECK(VirtIOSerialPCI, (obj), TYPE_VIRTIO_SERIAL_PCI)
 246
 247 struct VirtIOSerialPCI {
 248     VirtIOPCIProxy parent_obj;
 249     VirtIOSerial vdev;
 250 };
 251
 252 /*
 253  * virtio-net-pci: This extends VirtioPCIProxy.
 254  */
 255 #define TYPE_VIRTIO_NET_PCI "virtio-net-pci"
 256 #define VIRTIO_NET_PCI(obj) \
 257         OBJECT_CHECK(VirtIONetPCI, (obj), TYPE_VIRTIO_NET_PCI)
 258
 259 struct VirtIONetPCI {
 260     VirtIOPCIProxy parent_obj;
 261     VirtIONet vdev;
 262 };
 263
 264 /*
 265  * virtio-9p-pci: This extends VirtioPCIProxy.
 266  */
 267
 268 #ifdef CONFIG_VIRTFS
 269
 270 #define TYPE_VIRTIO_9P_PCI "virtio-9p-pci"
 271 #define VIRTIO_9P_PCI(obj) \
 272         OBJECT_CHECK(V9fsPCIState, (obj), TYPE_VIRTIO_9P_PCI)
 273
 274 typedef struct V9fsPCIState {
 275     VirtIOPCIProxy parent_obj;
 276     V9fsVirtioState vdev;
 277 } V9fsPCIState;
 278
 279 #endif
 280
 281 /*
 282  * virtio-rng-pci: This extends VirtioPCIProxy.
 283  */
 284 #define TYPE_VIRTIO_RNG_PCI "virtio-rng-pci"
 285 #define VIRTIO_RNG_PCI(obj) \
 286         OBJECT_CHECK(VirtIORngPCI, (obj), TYPE_VIRTIO_RNG_PCI)
 287
 288 struct VirtIORngPCI {
 289     VirtIOPCIProxy parent_obj;
 290     VirtIORNG vdev;
 291 };
 292
 293 /*
 294  * virtio-input-pci: This extends VirtioPCIProxy.
 295  */
 296 #define TYPE_VIRTIO_INPUT_PCI "virtio-input-pci"
 297 #define VIRTIO_INPUT_PCI(obj) \
 298         OBJECT_CHECK(VirtIOInputPCI, (obj), TYPE_VIRTIO_INPUT_PCI)
 299
 300 struct VirtIOInputPCI {
 301     VirtIOPCIProxy parent_obj;
 302     VirtIOInput vdev;
 303 };
 304
 305 #define TYPE_VIRTIO_INPUT_HID_PCI "virtio-input-hid-pci"
 306 #define TYPE_VIRTIO_KEYBOARD_PCI  "virtio-keyboard-pci"
 307 #define TYPE_VIRTIO_MOUSE_PCI     "virtio-mouse-pci"
 308 #define TYPE_VIRTIO_TABLET_PCI    "virtio-tablet-pci"
 309 #define VIRTIO_INPUT_HID_PCI(obj) \
 310         OBJECT_CHECK(VirtIOInputHIDPCI, (obj), TYPE_VIRTIO_INPUT_HID_PCI)
 311
 312 struct VirtIOInputHIDPCI {
 313     VirtIOPCIProxy parent_obj;
 314     VirtIOInputHID vdev;
 315 };
 316
 317 #ifdef CONFIG_LINUX
 318
 319 #define TYPE_VIRTIO_INPUT_HOST_PCI "virtio-input-host-pci"
 320 #define VIRTIO_INPUT_HOST_PCI(obj) \
 321         OBJECT_CHECK(VirtIOInputHostPCI, (obj), TYPE_VIRTIO_INPUT_HOST_PCI)
 322
 323 struct VirtIOInputHostPCI {
 324     VirtIOPCIProxy parent_obj;
 325     VirtIOInputHost vdev;
 326 };
 327
 328 #endif
 329
 330 /*
 331  * virtio-gpu-pci: This extends VirtioPCIProxy.
 332  */
 333 #define TYPE_VIRTIO_GPU_PCI "virtio-gpu-pci"
 334 #define VIRTIO_GPU_PCI(obj) \
 335         OBJECT_CHECK(VirtIOGPUPCI, (obj), TYPE_VIRTIO_GPU_PCI)
 336
 337 struct VirtIOGPUPCI {
 338     VirtIOPCIProxy parent_obj;
 339     VirtIOGPU vdev;
 340 };
 341
 342 #ifdef CONFIG_VHOST_VSOCK
 343 /*
 344  * vhost-vsock-pci: This extends VirtioPCIProxy.
 345  */
 346 #define TYPE_VHOST_VSOCK_PCI "vhost-vsock-pci"
 347 #define VHOST_VSOCK_PCI(obj) \
 348         OBJECT_CHECK(VHostVSockPCI, (obj), TYPE_VHOST_VSOCK_PCI)
 349
 350 struct VHostVSockPCI {
 351     VirtIOPCIProxy parent_obj;
 352     VHostVSock vdev;
 353 };
 354 #endif
 355
 356 /*
 357  * virtio-crypto-pci: This extends VirtioPCIProxy.
 358  */
 359 #define TYPE_VIRTIO_CRYPTO_PCI "virtio-crypto-pci"
 360 #define VIRTIO_CRYPTO_PCI(obj) \
 361         OBJECT_CHECK(VirtIOCryptoPCI, (obj), TYPE_VIRTIO_CRYPTO_PCI)
 362
 363 struct VirtIOCryptoPCI {
 364     VirtIOPCIProxy parent_obj;
 365     VirtIOCrypto vdev;
 366 };
 367
 368 /* Virtio ABI version, if we increment this, we break the guest driver. */
 369 #define VIRTIO_PCI_ABI_VERSION          0
 370
 371 #endif