drivers/virtio/virtio.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 #include <linux/virtio.h>
   3 #include <linux/spinlock.h>
   4 #include <linux/virtio_config.h>
   5 #include <linux/virtio_anchor.h>
   6 #include <linux/module.h>
   7 #include <linux/idr.h>
   8 #include <linux/of.h>
   9 #include <uapi/linux/virtio_ids.h>
  10
  11 /* Unique numbering for virtio devices. */
  12 static DEFINE_IDA(virtio_index_ida);
  13
  14 static ssize_t device_show(struct device *_d,
  15                            struct device_attribute *attr, char *buf)
  16 {
  17         struct virtio_device *dev = dev_to_virtio(_d);
  18         return sysfs_emit(buf, "0x%04x\n", dev->id.device);
  19 }
  20 static DEVICE_ATTR_RO(device);
  21
  22 static ssize_t vendor_show(struct device *_d,
  23                            struct device_attribute *attr, char *buf)
  24 {
  25         struct virtio_device *dev = dev_to_virtio(_d);
  26         return sysfs_emit(buf, "0x%04x\n", dev->id.vendor);
  27 }
  28 static DEVICE_ATTR_RO(vendor);
  29
  30 static ssize_t status_show(struct device *_d,
  31                            struct device_attribute *attr, char *buf)
  32 {
  33         struct virtio_device *dev = dev_to_virtio(_d);
  34         return sysfs_emit(buf, "0x%08x\n", dev->config->get_status(dev));
  35 }
  36 static DEVICE_ATTR_RO(status);
  37
  38 static ssize_t modalias_show(struct device *_d,
  39                              struct device_attribute *attr, char *buf)
  40 {
  41         struct virtio_device *dev = dev_to_virtio(_d);
  42         return sysfs_emit(buf, "virtio:d%08Xv%08X\n",
  43                        dev->id.device, dev->id.vendor);
  44 }
  45 static DEVICE_ATTR_RO(modalias);
  46
  47 static ssize_t features_show(struct device *_d,
  48                              struct device_attribute *attr, char *buf)
  49 {
  50         struct virtio_device *dev = dev_to_virtio(_d);
  51         unsigned int i;
  52         ssize_t len = 0;
  53
  54         /* We actually represent this as a bitstring, as it could be
  55          * arbitrary length in future. */
  56         for (i = 0; i < sizeof(dev->features)*8; i++)
  57                 len += sysfs_emit_at(buf, len, "%c",
  58                                __virtio_test_bit(dev, i) ? '1' : '0');
  59         len += sysfs_emit_at(buf, len, "\n");
  60         return len;
  61 }
  62 static DEVICE_ATTR_RO(features);
  63
  64 static struct attribute *virtio_dev_attrs[] = {
  65         &dev_attr_device.attr,
  66         &dev_attr_vendor.attr,
  67         &dev_attr_status.attr,
  68         &dev_attr_modalias.attr,
  69         &dev_attr_features.attr,
  70         NULL,
  71 };
  72 ATTRIBUTE_GROUPS(virtio_dev);
  73
  74 static inline int virtio_id_match(const struct virtio_device *dev,
  75                                   const struct virtio_device_id *id)
  76 {
  77         if (id->device != dev->id.device && id->device != VIRTIO_DEV_ANY_ID)
  78                 return 0;
  79
  80         return id->vendor == VIRTIO_DEV_ANY_ID || id->vendor == dev->id.vendor;
  81 }
  82
  83 /* This looks through all the IDs a driver claims to support.  If any of them
  84  * match, we return 1 and the kernel will call virtio_dev_probe(). */
  85 static int virtio_dev_match(struct device *_dv, struct device_driver *_dr)
  86 {
  87         unsigned int i;
  88         struct virtio_device *dev = dev_to_virtio(_dv);
  89         const struct virtio_device_id *ids;
  90
  91         ids = drv_to_virtio(_dr)->id_table;
  92         for (i = 0; ids[i].device; i++)
  93                 if (virtio_id_match(dev, &ids[i]))
  94                         return 1;
  95         return 0;
  96 }
  97
  98 static int virtio_uevent(const struct device *_dv, struct kobj_uevent_env *env)
  99 {
 100         const struct virtio_device *dev = dev_to_virtio(_dv);
 101
 102         return add_uevent_var(env, "MODALIAS=virtio:d%08Xv%08X",
 103                               dev->id.device, dev->id.vendor);
 104 }
 105
 106 void virtio_check_driver_offered_feature(const struct virtio_device *vdev,
 107                                          unsigned int fbit)
 108 {
 109         unsigned int i;
 110         struct virtio_driver *drv = drv_to_virtio(vdev->dev.driver);
 111
 112         for (i = 0; i < drv->feature_table_size; i++)
 113                 if (drv->feature_table[i] == fbit)
 114                         return;
 115
 116         if (drv->feature_table_legacy) {
 117                 for (i = 0; i < drv->feature_table_size_legacy; i++)
 118                         if (drv->feature_table_legacy[i] == fbit)
 119                                 return;
 120         }
 121
 122         BUG();
 123 }
 124 EXPORT_SYMBOL_GPL(virtio_check_driver_offered_feature);
 125
 126 static void __virtio_config_changed(struct virtio_device *dev)
 127 {
 128         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 129
 130         if (!dev->config_enabled)
 131                 dev->config_change_pending = true;
 132         else if (drv && drv->config_changed)
 133                 drv->config_changed(dev);
 134 }
 135
 136 void virtio_config_changed(struct virtio_device *dev)
 137 {
 138         unsigned long flags;
 139
 140         spin_lock_irqsave(&dev->config_lock, flags);
 141         __virtio_config_changed(dev);
 142         spin_unlock_irqrestore(&dev->config_lock, flags);
 143 }
 144 EXPORT_SYMBOL_GPL(virtio_config_changed);
 145
 146 static void virtio_config_disable(struct virtio_device *dev)
 147 {
 148         spin_lock_irq(&dev->config_lock);
 149         dev->config_enabled = false;
 150         spin_unlock_irq(&dev->config_lock);
 151 }
 152
 153 static void virtio_config_enable(struct virtio_device *dev)
 154 {
 155         spin_lock_irq(&dev->config_lock);
 156         dev->config_enabled = true;
 157         if (dev->config_change_pending)
 158                 __virtio_config_changed(dev);
 159         dev->config_change_pending = false;
 160         spin_unlock_irq(&dev->config_lock);
 161 }
 162
 163 void virtio_add_status(struct virtio_device *dev, unsigned int status)
 164 {
 165         might_sleep();
 166         dev->config->set_status(dev, dev->config->get_status(dev) | status);
 167 }
 168 EXPORT_SYMBOL_GPL(virtio_add_status);
 169
 170 /* Do some validation, then set FEATURES_OK */
 171 static int virtio_features_ok(struct virtio_device *dev)
 172 {
 173         unsigned int status;
 174
 175         might_sleep();
 176
 177         if (virtio_check_mem_acc_cb(dev)) {
 178                 if (!virtio_has_feature(dev, VIRTIO_F_VERSION_1)) {
 179                         dev_warn(&dev->dev,
 180                                  "device must provide VIRTIO_F_VERSION_1\n");
 181                         return -ENODEV;
 182                 }
 183
 184                 if (!virtio_has_feature(dev, VIRTIO_F_ACCESS_PLATFORM)) {
 185                         dev_warn(&dev->dev,
 186                                  "device must provide VIRTIO_F_ACCESS_PLATFORM\n");
 187                         return -ENODEV;
 188                 }
 189         }
 190
 191         if (!virtio_has_feature(dev, VIRTIO_F_VERSION_1))
 192                 return 0;
 193
 194         virtio_add_status(dev, VIRTIO_CONFIG_S_FEATURES_OK);
 195         status = dev->config->get_status(dev);
 196         if (!(status & VIRTIO_CONFIG_S_FEATURES_OK)) {
 197                 dev_err(&dev->dev, "virtio: device refuses features: %x\n",
 198                         status);
 199                 return -ENODEV;
 200         }
 201         return 0;
 202 }
 203
 204 /**
 205  * virtio_reset_device - quiesce device for removal
 206  * @dev: the device to reset
 207  *
 208  * Prevents device from sending interrupts and accessing memory.
 209  *
 210  * Generally used for cleanup during driver / device removal.
 211  *
 212  * Once this has been invoked, caller must ensure that
 213  * virtqueue_notify / virtqueue_kick are not in progress.
 214  *
 215  * Note: this guarantees that vq callbacks are not in progress, however caller
 216  * is responsible for preventing access from other contexts, such as a system
 217  * call/workqueue/bh.  Invoking virtio_break_device then flushing any such
 218  * contexts is one way to handle that.
 219  * */
 220 void virtio_reset_device(struct virtio_device *dev)
 221 {
 222 #ifdef CONFIG_VIRTIO_HARDEN_NOTIFICATION
 223         /*
 224          * The below virtio_synchronize_cbs() guarantees that any
 225          * interrupt for this line arriving after
 226          * virtio_synchronize_vqs() has completed is guaranteed to see
 227          * vq->broken as true.
 228          */
 229         virtio_break_device(dev);
 230         virtio_synchronize_cbs(dev);
 231 #endif
 232
 233         dev->config->reset(dev);
 234 }
 235 EXPORT_SYMBOL_GPL(virtio_reset_device);
 236
 237 static int virtio_dev_probe(struct device *_d)
 238 {
 239         int err, i;
 240         struct virtio_device *dev = dev_to_virtio(_d);
 241         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 242         u64 device_features;
 243         u64 driver_features;
 244         u64 driver_features_legacy;
 245
 246         /* We have a driver! */
 247         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 248
 249         /* Figure out what features the device supports. */
 250         device_features = dev->config->get_features(dev);
 251
 252         /* Figure out what features the driver supports. */
 253         driver_features = 0;
 254         for (i = 0; i < drv->feature_table_size; i++) {
 255                 unsigned int f = drv->feature_table[i];
 256                 BUG_ON(f >= 64);
 257                 driver_features |= (1ULL << f);
 258         }
 259
 260         /* Some drivers have a separate feature table for virtio v1.0 */
 261         if (drv->feature_table_legacy) {
 262                 driver_features_legacy = 0;
 263                 for (i = 0; i < drv->feature_table_size_legacy; i++) {
 264                         unsigned int f = drv->feature_table_legacy[i];
 265                         BUG_ON(f >= 64);
 266                         driver_features_legacy |= (1ULL << f);
 267                 }
 268         } else {
 269                 driver_features_legacy = driver_features;
 270         }
 271
 272         if (device_features & (1ULL << VIRTIO_F_VERSION_1))
 273                 dev->features = driver_features & device_features;
 274         else
 275                 dev->features = driver_features_legacy & device_features;
 276
 277         /* When debugging, user may filter some features by hand. */
 278         virtio_debug_device_filter_features(dev);
 279
 280         /* Transport features always preserved to pass to finalize_features. */
 281         for (i = VIRTIO_TRANSPORT_F_START; i < VIRTIO_TRANSPORT_F_END; i++)
 282                 if (device_features & (1ULL << i))
 283                         __virtio_set_bit(dev, i);
 284
 285         err = dev->config->finalize_features(dev);
 286         if (err)
 287                 goto err;
 288
 289         if (drv->validate) {
 290                 u64 features = dev->features;
 291
 292                 err = drv->validate(dev);
 293                 if (err)
 294                         goto err;
 295
 296                 /* Did validation change any features? Then write them again. */
 297                 if (features != dev->features) {
 298                         err = dev->config->finalize_features(dev);
 299                         if (err)
 300                                 goto err;
 301                 }
 302         }
 303
 304         err = virtio_features_ok(dev);
 305         if (err)
 306                 goto err;
 307
 308         if (dev->config->create_avq) {
 309                 err = dev->config->create_avq(dev);
 310                 if (err)
 311                         goto err;
 312         }
 313
 314         err = drv->probe(dev);
 315         if (err)
 316                 goto err_probe;
 317
 318         /* If probe didn't do it, mark device DRIVER_OK ourselves. */
 319         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 320                 virtio_device_ready(dev);
 321
 322         if (drv->scan)
 323                 drv->scan(dev);
 324
 325         virtio_config_enable(dev);
 326
 327         return 0;
 328
 329 err_probe:
 330         if (dev->config->destroy_avq)
 331                 dev->config->destroy_avq(dev);
 332 err:
 333         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 334         return err;
 335
 336 }
 337
 338 static void virtio_dev_remove(struct device *_d)
 339 {
 340         struct virtio_device *dev = dev_to_virtio(_d);
 341         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 342
 343         virtio_config_disable(dev);
 344
 345         drv->remove(dev);
 346
 347         if (dev->config->destroy_avq)
 348                 dev->config->destroy_avq(dev);
 349
 350         /* Driver should have reset device. */
 351         WARN_ON_ONCE(dev->config->get_status(dev));
 352
 353         /* Acknowledge the device's existence again. */
 354         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 355
 356         of_node_put(dev->dev.of_node);
 357 }
 358
 359 static const struct bus_type virtio_bus = {
 360         .name  = "virtio",
 361         .match = virtio_dev_match,
 362         .dev_groups = virtio_dev_groups,
 363         .uevent = virtio_uevent,
 364         .probe = virtio_dev_probe,
 365         .remove = virtio_dev_remove,
 366 };
 367
 368 int __register_virtio_driver(struct virtio_driver *driver, struct module *owner)
 369 {
 370         /* Catch this early. */
 371         BUG_ON(driver->feature_table_size && !driver->feature_table);
 372         driver->driver.bus = &virtio_bus;
 373         driver->driver.owner = owner;
 374
 375         return driver_register(&driver->driver);
 376 }
 377 EXPORT_SYMBOL_GPL(__register_virtio_driver);
 378
 379 void unregister_virtio_driver(struct virtio_driver *driver)
 380 {
 381         driver_unregister(&driver->driver);
 382 }
 383 EXPORT_SYMBOL_GPL(unregister_virtio_driver);
 384
 385 static int virtio_device_of_init(struct virtio_device *dev)
 386 {
 387         struct device_node *np, *pnode = dev_of_node(dev->dev.parent);
 388         char compat[] = "virtio,deviceXXXXXXXX";
 389         int ret, count;
 390
 391         if (!pnode)
 392                 return 0;
 393
 394         count = of_get_available_child_count(pnode);
 395         if (!count)
 396                 return 0;
 397
 398         /* There can be only 1 child node */
 399         if (WARN_ON(count > 1))
 400                 return -EINVAL;
 401
 402         np = of_get_next_available_child(pnode, NULL);
 403         if (WARN_ON(!np))
 404                 return -ENODEV;
 405
 406         ret = snprintf(compat, sizeof(compat), "virtio,device%x", dev->id.device);
 407         BUG_ON(ret >= sizeof(compat));
 408
 409         /*
 410          * On powerpc/pseries virtio devices are PCI devices so PCI
 411          * vendor/device ids play the role of the "compatible" property.
 412          * Simply don't init of_node in this case.
 413          */
 414         if (!of_device_is_compatible(np, compat)) {
 415                 ret = 0;
 416                 goto out;
 417         }
 418
 419         dev->dev.of_node = np;
 420         return 0;
 421
 422 out:
 423         of_node_put(np);
 424         return ret;
 425 }
 426
 427 /**
 428  * register_virtio_device - register virtio device
 429  * @dev        : virtio device to be registered
 430  *
 431  * On error, the caller must call put_device on &@dev->dev (and not kfree),
 432  * as another code path may have obtained a reference to @dev.
 433  *
 434  * Returns: 0 on suceess, -error on failure
 435  */
 436 int register_virtio_device(struct virtio_device *dev)
 437 {
 438         int err;
 439
 440         dev->dev.bus = &virtio_bus;
 441         device_initialize(&dev->dev);
 442
 443         /* Assign a unique device index and hence name. */
 444         err = ida_alloc(&virtio_index_ida, GFP_KERNEL);
 445         if (err < 0)
 446                 goto out;
 447
 448         dev->index = err;
 449         err = dev_set_name(&dev->dev, "virtio%u", dev->index);
 450         if (err)
 451                 goto out_ida_remove;
 452
 453         err = virtio_device_of_init(dev);
 454         if (err)
 455                 goto out_ida_remove;
 456
 457         spin_lock_init(&dev->config_lock);
 458         dev->config_enabled = false;
 459         dev->config_change_pending = false;
 460
 461         INIT_LIST_HEAD(&dev->vqs);
 462         spin_lock_init(&dev->vqs_list_lock);
 463
 464         /* We always start by resetting the device, in case a previous
 465          * driver messed it up.  This also tests that code path a little. */
 466         virtio_reset_device(dev);
 467
 468         /* Acknowledge that we've seen the device. */
 469         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 470
 471         virtio_debug_device_init(dev);
 472
 473         /*
 474          * device_add() causes the bus infrastructure to look for a matching
 475          * driver.
 476          */
 477         err = device_add(&dev->dev);
 478         if (err)
 479                 goto out_of_node_put;
 480
 481         return 0;
 482
 483 out_of_node_put:
 484         of_node_put(dev->dev.of_node);
 485 out_ida_remove:
 486         ida_free(&virtio_index_ida, dev->index);
 487 out:
 488         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 489         return err;
 490 }
 491 EXPORT_SYMBOL_GPL(register_virtio_device);
 492
 493 bool is_virtio_device(struct device *dev)
 494 {
 495         return dev->bus == &virtio_bus;
 496 }
 497 EXPORT_SYMBOL_GPL(is_virtio_device);
 498
 499 void unregister_virtio_device(struct virtio_device *dev)
 500 {
 501         int index = dev->index; /* save for after device release */
 502
 503         device_unregister(&dev->dev);
 504         virtio_debug_device_exit(dev);
 505         ida_free(&virtio_index_ida, index);
 506 }
 507 EXPORT_SYMBOL_GPL(unregister_virtio_device);
 508
 509 #ifdef CONFIG_PM_SLEEP
 510 int virtio_device_freeze(struct virtio_device *dev)
 511 {
 512         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 513         int ret;
 514
 515         virtio_config_disable(dev);
 516
 517         dev->failed = dev->config->get_status(dev) & VIRTIO_CONFIG_S_FAILED;
 518
 519         if (drv && drv->freeze) {
 520                 ret = drv->freeze(dev);
 521                 if (ret) {
 522                         virtio_config_enable(dev);
 523                         return ret;
 524                 }
 525         }
 526
 527         if (dev->config->destroy_avq)
 528                 dev->config->destroy_avq(dev);
 529
 530         return 0;
 531 }
 532 EXPORT_SYMBOL_GPL(virtio_device_freeze);
 533
 534 int virtio_device_restore(struct virtio_device *dev)
 535 {
 536         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 537         int ret;
 538
 539         /* We always start by resetting the device, in case a previous
 540          * driver messed it up. */
 541         virtio_reset_device(dev);
 542
 543         /* Acknowledge that we've seen the device. */
 544         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 545
 546         /* Maybe driver failed before freeze.
 547          * Restore the failed status, for debugging. */
 548         if (dev->failed)
 549                 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 550
 551         if (!drv)
 552                 return 0;
 553
 554         /* We have a driver! */
 555         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 556
 557         ret = dev->config->finalize_features(dev);
 558         if (ret)
 559                 goto err;
 560
 561         ret = virtio_features_ok(dev);
 562         if (ret)
 563                 goto err;
 564
 565         if (dev->config->create_avq) {
 566                 ret = dev->config->create_avq(dev);
 567                 if (ret)
 568                         goto err;
 569         }
 570
 571         if (drv->restore) {
 572                 ret = drv->restore(dev);
 573                 if (ret)
 574                         goto err_restore;
 575         }
 576
 577         /* If restore didn't do it, mark device DRIVER_OK ourselves. */
 578         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 579                 virtio_device_ready(dev);
 580
 581         virtio_config_enable(dev);
 582
 583         return 0;
 584
 585 err_restore:
 586         if (dev->config->destroy_avq)
 587                 dev->config->destroy_avq(dev);
 588 err:
 589         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 590         return ret;
 591 }
 592 EXPORT_SYMBOL_GPL(virtio_device_restore);
 593 #endif
 594
 595 static int virtio_init(void)
 596 {
 597         if (bus_register(&virtio_bus) != 0)
 598                 panic("virtio bus registration failed");
 599         virtio_debug_init();
 600         return 0;
 601 }
 602
 603 static void __exit virtio_exit(void)
 604 {
 605         virtio_debug_exit();
 606         bus_unregister(&virtio_bus);
 607         ida_destroy(&virtio_index_ida);
 608 }
 609 core_initcall(virtio_init);
 610 module_exit(virtio_exit);
 611
 612 MODULE_LICENSE("GPL");