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