tests/libqos/virtio-pci.c

   1 /*
   2  * libqos virtio PCI driver
   3  *
   4  * Copyright (c) 2014 Marc Marí
   5  *
   6  * This work is licensed under the terms of the GNU GPL, version 2 or later.
   7  * See the COPYING file in the top-level directory.
   8  */
   9
  10 #include "qemu/osdep.h"
  11 #include "libqtest.h"
  12 #include "libqos/virtio.h"
  13 #include "libqos/virtio-pci.h"
  14 #include "libqos/pci.h"
  15 #include "libqos/pci-pc.h"
  16 #include "libqos/malloc.h"
  17 #include "libqos/malloc-pc.h"
  18 #include "libqos/qgraph.h"
  19 #include "standard-headers/linux/virtio_ring.h"
  20 #include "standard-headers/linux/virtio_pci.h"
  21
  22 #include "hw/pci/pci.h"
  23 #include "hw/pci/pci_regs.h"
  24
  25 /* virtio-pci is a superclass of all virtio-xxx-pci devices;
  26  * the relation between virtio-pci and virtio-xxx-pci is implicit,
  27  * and therefore virtio-pci does not produce virtio and is not
  28  * reached by any edge, not even as a "contains" edge.
  29  * In facts, every device is a QVirtioPCIDevice with
  30  * additional fields, since every one has its own
  31  * number of queues and various attributes.
  32  * Virtio-pci provides default functions to start the
  33  * hw and destroy the object, and nodes that want to
  34  * override them should always remember to call the
  35  * original qvirtio_pci_destructor and qvirtio_pci_start_hw.
  36  */
  37
  38 static inline bool qvirtio_pci_is_big_endian(QVirtioPCIDevice *dev)
  39 {
  40     QPCIBus *bus = dev->pdev->bus;
  41
  42     /* FIXME: virtio 1.0 is always little-endian */
  43     return qtest_big_endian(bus->qts);
  44 }
  45
  46 #define CONFIG_BASE(dev) (VIRTIO_PCI_CONFIG_OFF((dev)->pdev->msix_enabled))
  47
  48 static uint8_t qvirtio_pci_config_readb(QVirtioDevice *d, uint64_t off)
  49 {
  50     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
  51     return qpci_io_readb(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
  52 }
  53
  54 /* PCI is always read in little-endian order
  55  * but virtio ( < 1.0) is in guest order
  56  * so with a big-endian guest the order has been reversed,
  57  * reverse it again
  58  * virtio-1.0 is always little-endian, like PCI, but this
  59  * case will be managed inside qvirtio_pci_is_big_endian()
  60  */
  61
  62 static uint16_t qvirtio_pci_config_readw(QVirtioDevice *d, uint64_t off)
  63 {
  64     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
  65     uint16_t value;
  66
  67     value = qpci_io_readw(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
  68     if (qvirtio_is_big_endian(d)) {
  69         value = bswap16(value);
  70     }
  71     return value;
  72 }
  73
  74 static uint32_t qvirtio_pci_config_readl(QVirtioDevice *d, uint64_t off)
  75 {
  76     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
  77     uint32_t value;
  78
  79     value = qpci_io_readl(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
  80     if (qvirtio_is_big_endian(d)) {
  81         value = bswap32(value);
  82     }
  83     return value;
  84 }
  85
  86 static uint64_t qvirtio_pci_config_readq(QVirtioDevice *d, uint64_t off)
  87 {
  88     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
  89     uint64_t val;
  90
  91     val = qpci_io_readq(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
  92     if (qvirtio_is_big_endian(d)) {
  93         val = bswap64(val);
  94     }
  95
  96     return val;
  97 }
  98
  99 static uint64_t qvirtio_pci_get_features(QVirtioDevice *d)
 100 {
 101     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 102     return qpci_io_readl(dev->pdev, dev->bar, VIRTIO_PCI_HOST_FEATURES);
 103 }
 104
 105 static void qvirtio_pci_set_features(QVirtioDevice *d, uint64_t features)
 106 {
 107     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 108     qpci_io_writel(dev->pdev, dev->bar, VIRTIO_PCI_GUEST_FEATURES, features);
 109 }
 110
 111 static uint64_t qvirtio_pci_get_guest_features(QVirtioDevice *d)
 112 {
 113     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 114     return qpci_io_readl(dev->pdev, dev->bar, VIRTIO_PCI_GUEST_FEATURES);
 115 }
 116
 117 static uint8_t qvirtio_pci_get_status(QVirtioDevice *d)
 118 {
 119     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 120     return qpci_io_readb(dev->pdev, dev->bar, VIRTIO_PCI_STATUS);
 121 }
 122
 123 static void qvirtio_pci_set_status(QVirtioDevice *d, uint8_t status)
 124 {
 125     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 126     qpci_io_writeb(dev->pdev, dev->bar, VIRTIO_PCI_STATUS, status);
 127 }
 128
 129 static bool qvirtio_pci_get_queue_isr_status(QVirtioDevice *d, QVirtQueue *vq)
 130 {
 131     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 132     QVirtQueuePCI *vqpci = (QVirtQueuePCI *)vq;
 133     uint32_t data;
 134
 135     if (dev->pdev->msix_enabled) {
 136         g_assert_cmpint(vqpci->msix_entry, !=, -1);
 137         if (qpci_msix_masked(dev->pdev, vqpci->msix_entry)) {
 138             /* No ISR checking should be done if masked, but read anyway */
 139             return qpci_msix_pending(dev->pdev, vqpci->msix_entry);
 140         } else {
 141             data = qtest_readl(dev->pdev->bus->qts, vqpci->msix_addr);
 142             if (data == vqpci->msix_data) {
 143                 qtest_writel(dev->pdev->bus->qts, vqpci->msix_addr, 0);
 144                 return true;
 145             } else {
 146                 return false;
 147             }
 148         }
 149     } else {
 150         return qpci_io_readb(dev->pdev, dev->bar, VIRTIO_PCI_ISR) & 1;
 151     }
 152 }
 153
 154 static bool qvirtio_pci_get_config_isr_status(QVirtioDevice *d)
 155 {
 156     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 157     uint32_t data;
 158
 159     if (dev->pdev->msix_enabled) {
 160         g_assert_cmpint(dev->config_msix_entry, !=, -1);
 161         if (qpci_msix_masked(dev->pdev, dev->config_msix_entry)) {
 162             /* No ISR checking should be done if masked, but read anyway */
 163             return qpci_msix_pending(dev->pdev, dev->config_msix_entry);
 164         } else {
 165             data = qtest_readl(dev->pdev->bus->qts, dev->config_msix_addr);
 166             if (data == dev->config_msix_data) {
 167                 qtest_writel(dev->pdev->bus->qts, dev->config_msix_addr, 0);
 168                 return true;
 169             } else {
 170                 return false;
 171             }
 172         }
 173     } else {
 174         return qpci_io_readb(dev->pdev, dev->bar, VIRTIO_PCI_ISR) & 2;
 175     }
 176 }
 177
 178 static void qvirtio_pci_wait_config_isr_status(QVirtioDevice *d,
 179                                                gint64 timeout_us)
 180 {
 181     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 182     gint64 start_time = g_get_monotonic_time();
 183
 184     do {
 185         g_assert(g_get_monotonic_time() - start_time <= timeout_us);
 186         qtest_clock_step(dev->pdev->bus->qts, 100);
 187     } while (!qvirtio_pci_get_config_isr_status(d));
 188 }
 189
 190 static void qvirtio_pci_queue_select(QVirtioDevice *d, uint16_t index)
 191 {
 192     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 193     qpci_io_writeb(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_SEL, index);
 194 }
 195
 196 static uint16_t qvirtio_pci_get_queue_size(QVirtioDevice *d)
 197 {
 198     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 199     return qpci_io_readw(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_NUM);
 200 }
 201
 202 static void qvirtio_pci_set_queue_address(QVirtioDevice *d, QVirtQueue *vq)
 203 {
 204     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 205     uint64_t pfn = vq->desc / VIRTIO_PCI_VRING_ALIGN;
 206
 207     qpci_io_writel(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_PFN, pfn);
 208 }
 209
 210 static QVirtQueue *qvirtio_pci_virtqueue_setup(QVirtioDevice *d,
 211                                         QGuestAllocator *alloc, uint16_t index)
 212 {
 213     uint64_t feat;
 214     uint64_t addr;
 215     QVirtQueuePCI *vqpci;
 216     QVirtioPCIDevice *qvpcidev = container_of(d, QVirtioPCIDevice, vdev);
 217
 218     vqpci = g_malloc0(sizeof(*vqpci));
 219     feat = qvirtio_pci_get_guest_features(d);
 220
 221     qvirtio_pci_queue_select(d, index);
 222     vqpci->vq.vdev = d;
 223     vqpci->vq.index = index;
 224     vqpci->vq.size = qvirtio_pci_get_queue_size(d);
 225     vqpci->vq.free_head = 0;
 226     vqpci->vq.num_free = vqpci->vq.size;
 227     vqpci->vq.align = VIRTIO_PCI_VRING_ALIGN;
 228     vqpci->vq.indirect = feat & (1ull << VIRTIO_RING_F_INDIRECT_DESC);
 229     vqpci->vq.event = feat & (1ull << VIRTIO_RING_F_EVENT_IDX);
 230
 231     vqpci->msix_entry = -1;
 232     vqpci->msix_addr = 0;
 233     vqpci->msix_data = 0x12345678;
 234
 235     /* Check different than 0 */
 236     g_assert_cmpint(vqpci->vq.size, !=, 0);
 237
 238     /* Check power of 2 */
 239     g_assert_cmpint(vqpci->vq.size & (vqpci->vq.size - 1), ==, 0);
 240
 241     addr = guest_alloc(alloc, qvring_size(vqpci->vq.size,
 242                                           VIRTIO_PCI_VRING_ALIGN));
 243     qvring_init(qvpcidev->pdev->bus->qts, alloc, &vqpci->vq, addr);
 244     qvirtio_pci_set_queue_address(d, &vqpci->vq);
 245
 246     return &vqpci->vq;
 247 }
 248
 249 static void qvirtio_pci_virtqueue_cleanup(QVirtQueue *vq,
 250                                           QGuestAllocator *alloc)
 251 {
 252     QVirtQueuePCI *vqpci = container_of(vq, QVirtQueuePCI, vq);
 253
 254     guest_free(alloc, vq->desc);
 255     g_free(vqpci);
 256 }
 257
 258 static void qvirtio_pci_virtqueue_kick(QVirtioDevice *d, QVirtQueue *vq)
 259 {
 260     QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
 261     qpci_io_writew(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_NOTIFY, vq->index);
 262 }
 263
 264 const QVirtioBus qvirtio_pci = {
 265     .config_readb = qvirtio_pci_config_readb,
 266     .config_readw = qvirtio_pci_config_readw,
 267     .config_readl = qvirtio_pci_config_readl,
 268     .config_readq = qvirtio_pci_config_readq,
 269     .get_features = qvirtio_pci_get_features,
 270     .set_features = qvirtio_pci_set_features,
 271     .get_guest_features = qvirtio_pci_get_guest_features,
 272     .get_status = qvirtio_pci_get_status,
 273     .set_status = qvirtio_pci_set_status,
 274     .get_queue_isr_status = qvirtio_pci_get_queue_isr_status,
 275     .wait_config_isr_status = qvirtio_pci_wait_config_isr_status,
 276     .queue_select = qvirtio_pci_queue_select,
 277     .get_queue_size = qvirtio_pci_get_queue_size,
 278     .set_queue_address = qvirtio_pci_set_queue_address,
 279     .virtqueue_setup = qvirtio_pci_virtqueue_setup,
 280     .virtqueue_cleanup = qvirtio_pci_virtqueue_cleanup,
 281     .virtqueue_kick = qvirtio_pci_virtqueue_kick,
 282 };
 283
 284 static void qvirtio_pci_set_config_vector(QVirtioPCIDevice *d, uint16_t entry)
 285 {
 286     uint16_t vector;
 287
 288     qpci_io_writew(d->pdev, d->bar, VIRTIO_MSI_CONFIG_VECTOR, entry);
 289     vector = qpci_io_readw(d->pdev, d->bar, VIRTIO_MSI_CONFIG_VECTOR);
 290     g_assert_cmphex(vector, !=, VIRTIO_MSI_NO_VECTOR);
 291 }
 292
 293 static void qvirtio_pci_set_queue_vector(QVirtioPCIDevice *d, uint16_t vq_idx,
 294                                          uint16_t entry)
 295 {
 296     uint16_t vector;
 297
 298     qvirtio_pci_queue_select(&d->vdev, vq_idx);
 299     qpci_io_writew(d->pdev, d->bar, VIRTIO_MSI_QUEUE_VECTOR, entry);
 300     vector = qpci_io_readw(d->pdev, d->bar, VIRTIO_MSI_QUEUE_VECTOR);
 301     g_assert_cmphex(vector, !=, VIRTIO_MSI_NO_VECTOR);
 302 }
 303
 304 static const QVirtioPCIMSIXOps qvirtio_pci_msix_ops_legacy = {
 305     .set_config_vector = qvirtio_pci_set_config_vector,
 306     .set_queue_vector = qvirtio_pci_set_queue_vector,
 307 };
 308
 309 void qvirtio_pci_device_enable(QVirtioPCIDevice *d)
 310 {
 311     qpci_device_enable(d->pdev);
 312     d->bar = qpci_iomap(d->pdev, 0, NULL);
 313 }
 314
 315 void qvirtio_pci_device_disable(QVirtioPCIDevice *d)
 316 {
 317     qpci_iounmap(d->pdev, d->bar);
 318 }
 319
 320 void qvirtqueue_pci_msix_setup(QVirtioPCIDevice *d, QVirtQueuePCI *vqpci,
 321                                         QGuestAllocator *alloc, uint16_t entry)
 322 {
 323     uint32_t control;
 324     uint64_t off;
 325
 326     g_assert(d->pdev->msix_enabled);
 327     off = d->pdev->msix_table_off + (entry * 16);
 328
 329     g_assert_cmpint(entry, >=, 0);
 330     g_assert_cmpint(entry, <, qpci_msix_table_size(d->pdev));
 331     vqpci->msix_entry = entry;
 332
 333     vqpci->msix_addr = guest_alloc(alloc, 4);
 334     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 335                    off + PCI_MSIX_ENTRY_LOWER_ADDR, vqpci->msix_addr & ~0UL);
 336     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 337                    off + PCI_MSIX_ENTRY_UPPER_ADDR,
 338                    (vqpci->msix_addr >> 32) & ~0UL);
 339     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 340                    off + PCI_MSIX_ENTRY_DATA, vqpci->msix_data);
 341
 342     control = qpci_io_readl(d->pdev, d->pdev->msix_table_bar,
 343                             off + PCI_MSIX_ENTRY_VECTOR_CTRL);
 344     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 345                    off + PCI_MSIX_ENTRY_VECTOR_CTRL,
 346                    control & ~PCI_MSIX_ENTRY_CTRL_MASKBIT);
 347
 348     d->msix_ops->set_queue_vector(d, vqpci->vq.index, entry);
 349 }
 350
 351 void qvirtio_pci_set_msix_configuration_vector(QVirtioPCIDevice *d,
 352                                         QGuestAllocator *alloc, uint16_t entry)
 353 {
 354     uint32_t control;
 355     uint64_t off;
 356
 357     g_assert(d->pdev->msix_enabled);
 358     off = d->pdev->msix_table_off + (entry * 16);
 359
 360     g_assert_cmpint(entry, >=, 0);
 361     g_assert_cmpint(entry, <, qpci_msix_table_size(d->pdev));
 362     d->config_msix_entry = entry;
 363
 364     d->config_msix_data = 0x12345678;
 365     d->config_msix_addr = guest_alloc(alloc, 4);
 366
 367     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 368                    off + PCI_MSIX_ENTRY_LOWER_ADDR, d->config_msix_addr & ~0UL);
 369     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 370                    off + PCI_MSIX_ENTRY_UPPER_ADDR,
 371                    (d->config_msix_addr >> 32) & ~0UL);
 372     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 373                    off + PCI_MSIX_ENTRY_DATA, d->config_msix_data);
 374
 375     control = qpci_io_readl(d->pdev, d->pdev->msix_table_bar,
 376                             off + PCI_MSIX_ENTRY_VECTOR_CTRL);
 377     qpci_io_writel(d->pdev, d->pdev->msix_table_bar,
 378                    off + PCI_MSIX_ENTRY_VECTOR_CTRL,
 379                    control & ~PCI_MSIX_ENTRY_CTRL_MASKBIT);
 380
 381     d->msix_ops->set_config_vector(d, entry);
 382 }
 383
 384 void qvirtio_pci_destructor(QOSGraphObject *obj)
 385 {
 386     QVirtioPCIDevice *dev = (QVirtioPCIDevice *)obj;
 387     qvirtio_pci_device_disable(dev);
 388     g_free(dev->pdev);
 389 }
 390
 391 void qvirtio_pci_start_hw(QOSGraphObject *obj)
 392 {
 393     QVirtioPCIDevice *dev = (QVirtioPCIDevice *)obj;
 394     qvirtio_pci_device_enable(dev);
 395     qvirtio_start_device(&dev->vdev);
 396 }
 397
 398 static void qvirtio_pci_init_from_pcidev(QVirtioPCIDevice *dev, QPCIDevice *pci_dev)
 399 {
 400     dev->pdev = pci_dev;
 401     dev->vdev.device_type = qpci_config_readw(pci_dev, PCI_SUBSYSTEM_ID);
 402
 403     dev->config_msix_entry = -1;
 404     dev->msix_ops = &qvirtio_pci_msix_ops_legacy;
 405
 406     dev->vdev.bus = &qvirtio_pci;
 407     dev->vdev.big_endian = qvirtio_pci_is_big_endian(dev);
 408
 409     /* each virtio-xxx-pci device should override at least this function */
 410     dev->obj.get_driver = NULL;
 411     dev->obj.start_hw = qvirtio_pci_start_hw;
 412     dev->obj.destructor = qvirtio_pci_destructor;
 413 }
 414
 415 void virtio_pci_init(QVirtioPCIDevice *dev, QPCIBus *bus, QPCIAddress * addr)
 416 {
 417     QPCIDevice *pci_dev = qpci_device_find(bus, addr->devfn);
 418     g_assert_nonnull(pci_dev);
 419     qvirtio_pci_init_from_pcidev(dev, pci_dev);
 420 }
 421
 422 QVirtioPCIDevice *virtio_pci_new(QPCIBus *bus, QPCIAddress * addr)
 423 {
 424     QVirtioPCIDevice *dev;
 425     QPCIDevice *pci_dev = qpci_device_find(bus, addr->devfn);
 426     if (!pci_dev) {
 427         return NULL;
 428     }
 429
 430     dev = g_new0(QVirtioPCIDevice, 1);
 431     qvirtio_pci_init_from_pcidev(dev, pci_dev);
 432     dev->obj.free = g_free;
 433     return dev;
 434 }