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, const 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         err = drv->probe(dev);
 309         if (err)
 310                 goto err;
 311
 312         /* If probe didn't do it, mark device DRIVER_OK ourselves. */
 313         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 314                 virtio_device_ready(dev);
 315
 316         if (drv->scan)
 317                 drv->scan(dev);
 318
 319         virtio_config_enable(dev);
 320
 321         return 0;
 322
 323 err:
 324         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 325         return err;
 326
 327 }
 328
 329 static void virtio_dev_remove(struct device *_d)
 330 {
 331         struct virtio_device *dev = dev_to_virtio(_d);
 332         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 333
 334         virtio_config_disable(dev);
 335
 336         drv->remove(dev);
 337
 338         /* Driver should have reset device. */
 339         WARN_ON_ONCE(dev->config->get_status(dev));
 340
 341         /* Acknowledge the device's existence again. */
 342         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 343
 344         of_node_put(dev->dev.of_node);
 345 }
 346
 347 static const struct bus_type virtio_bus = {
 348         .name  = "virtio",
 349         .match = virtio_dev_match,
 350         .dev_groups = virtio_dev_groups,
 351         .uevent = virtio_uevent,
 352         .probe = virtio_dev_probe,
 353         .remove = virtio_dev_remove,
 354 };
 355
 356 int __register_virtio_driver(struct virtio_driver *driver, struct module *owner)
 357 {
 358         /* Catch this early. */
 359         BUG_ON(driver->feature_table_size && !driver->feature_table);
 360         driver->driver.bus = &virtio_bus;
 361         driver->driver.owner = owner;
 362
 363         return driver_register(&driver->driver);
 364 }
 365 EXPORT_SYMBOL_GPL(__register_virtio_driver);
 366
 367 void unregister_virtio_driver(struct virtio_driver *driver)
 368 {
 369         driver_unregister(&driver->driver);
 370 }
 371 EXPORT_SYMBOL_GPL(unregister_virtio_driver);
 372
 373 static int virtio_device_of_init(struct virtio_device *dev)
 374 {
 375         struct device_node *np, *pnode = dev_of_node(dev->dev.parent);
 376         char compat[] = "virtio,deviceXXXXXXXX";
 377         int ret, count;
 378
 379         if (!pnode)
 380                 return 0;
 381
 382         count = of_get_available_child_count(pnode);
 383         if (!count)
 384                 return 0;
 385
 386         /* There can be only 1 child node */
 387         if (WARN_ON(count > 1))
 388                 return -EINVAL;
 389
 390         np = of_get_next_available_child(pnode, NULL);
 391         if (WARN_ON(!np))
 392                 return -ENODEV;
 393
 394         ret = snprintf(compat, sizeof(compat), "virtio,device%x", dev->id.device);
 395         BUG_ON(ret >= sizeof(compat));
 396
 397         /*
 398          * On powerpc/pseries virtio devices are PCI devices so PCI
 399          * vendor/device ids play the role of the "compatible" property.
 400          * Simply don't init of_node in this case.
 401          */
 402         if (!of_device_is_compatible(np, compat)) {
 403                 ret = 0;
 404                 goto out;
 405         }
 406
 407         dev->dev.of_node = np;
 408         return 0;
 409
 410 out:
 411         of_node_put(np);
 412         return ret;
 413 }
 414
 415 /**
 416  * register_virtio_device - register virtio device
 417  * @dev        : virtio device to be registered
 418  *
 419  * On error, the caller must call put_device on &@dev->dev (and not kfree),
 420  * as another code path may have obtained a reference to @dev.
 421  *
 422  * Returns: 0 on suceess, -error on failure
 423  */
 424 int register_virtio_device(struct virtio_device *dev)
 425 {
 426         int err;
 427
 428         dev->dev.bus = &virtio_bus;
 429         device_initialize(&dev->dev);
 430
 431         /* Assign a unique device index and hence name. */
 432         err = ida_alloc(&virtio_index_ida, GFP_KERNEL);
 433         if (err < 0)
 434                 goto out;
 435
 436         dev->index = err;
 437         err = dev_set_name(&dev->dev, "virtio%u", dev->index);
 438         if (err)
 439                 goto out_ida_remove;
 440
 441         err = virtio_device_of_init(dev);
 442         if (err)
 443                 goto out_ida_remove;
 444
 445         spin_lock_init(&dev->config_lock);
 446         dev->config_enabled = false;
 447         dev->config_change_pending = false;
 448
 449         INIT_LIST_HEAD(&dev->vqs);
 450         spin_lock_init(&dev->vqs_list_lock);
 451
 452         /* We always start by resetting the device, in case a previous
 453          * driver messed it up.  This also tests that code path a little. */
 454         virtio_reset_device(dev);
 455
 456         /* Acknowledge that we've seen the device. */
 457         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 458
 459         virtio_debug_device_init(dev);
 460
 461         /*
 462          * device_add() causes the bus infrastructure to look for a matching
 463          * driver.
 464          */
 465         err = device_add(&dev->dev);
 466         if (err)
 467                 goto out_of_node_put;
 468
 469         return 0;
 470
 471 out_of_node_put:
 472         of_node_put(dev->dev.of_node);
 473 out_ida_remove:
 474         ida_free(&virtio_index_ida, dev->index);
 475 out:
 476         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 477         return err;
 478 }
 479 EXPORT_SYMBOL_GPL(register_virtio_device);
 480
 481 bool is_virtio_device(struct device *dev)
 482 {
 483         return dev->bus == &virtio_bus;
 484 }
 485 EXPORT_SYMBOL_GPL(is_virtio_device);
 486
 487 void unregister_virtio_device(struct virtio_device *dev)
 488 {
 489         int index = dev->index; /* save for after device release */
 490
 491         device_unregister(&dev->dev);
 492         virtio_debug_device_exit(dev);
 493         ida_free(&virtio_index_ida, index);
 494 }
 495 EXPORT_SYMBOL_GPL(unregister_virtio_device);
 496
 497 #ifdef CONFIG_PM_SLEEP
 498 int virtio_device_freeze(struct virtio_device *dev)
 499 {
 500         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 501         int ret;
 502
 503         virtio_config_disable(dev);
 504
 505         dev->failed = dev->config->get_status(dev) & VIRTIO_CONFIG_S_FAILED;
 506
 507         if (drv && drv->freeze) {
 508                 ret = drv->freeze(dev);
 509                 if (ret) {
 510                         virtio_config_enable(dev);
 511                         return ret;
 512                 }
 513         }
 514
 515         return 0;
 516 }
 517 EXPORT_SYMBOL_GPL(virtio_device_freeze);
 518
 519 int virtio_device_restore(struct virtio_device *dev)
 520 {
 521         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 522         int ret;
 523
 524         /* We always start by resetting the device, in case a previous
 525          * driver messed it up. */
 526         virtio_reset_device(dev);
 527
 528         /* Acknowledge that we've seen the device. */
 529         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 530
 531         /* Maybe driver failed before freeze.
 532          * Restore the failed status, for debugging. */
 533         if (dev->failed)
 534                 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 535
 536         if (!drv)
 537                 return 0;
 538
 539         /* We have a driver! */
 540         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 541
 542         ret = dev->config->finalize_features(dev);
 543         if (ret)
 544                 goto err;
 545
 546         ret = virtio_features_ok(dev);
 547         if (ret)
 548                 goto err;
 549
 550         if (drv->restore) {
 551                 ret = drv->restore(dev);
 552                 if (ret)
 553                         goto err;
 554         }
 555
 556         /* If restore didn't do it, mark device DRIVER_OK ourselves. */
 557         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 558                 virtio_device_ready(dev);
 559
 560         virtio_config_enable(dev);
 561
 562         return 0;
 563
 564 err:
 565         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 566         return ret;
 567 }
 568 EXPORT_SYMBOL_GPL(virtio_device_restore);
 569 #endif
 570
 571 static int virtio_init(void)
 572 {
 573         if (bus_register(&virtio_bus) != 0)
 574                 panic("virtio bus registration failed");
 575         virtio_debug_init();
 576         return 0;
 577 }
 578
 579 static void __exit virtio_exit(void)
 580 {
 581         virtio_debug_exit();
 582         bus_unregister(&virtio_bus);
 583         ida_destroy(&virtio_index_ida);
 584 }
 585 core_initcall(virtio_init);
 586 module_exit(virtio_exit);
 587
 588 MODULE_DESCRIPTION("Virtio core interface");
 589 MODULE_LICENSE("GPL");