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