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/module.h>
   6 #include <linux/idr.h>
   7 #include <linux/of.h>
   8 #include <linux/platform-feature.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 sprintf(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 sprintf(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 sprintf(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 sprintf(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 += sprintf(buf+len, "%c",
  58                                __virtio_test_bit(dev, i) ? '1' : '0');
  59         len += sprintf(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(struct device *_dv, struct kobj_uevent_env *env)
  99 {
 100         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 (platform_has(PLATFORM_VIRTIO_RESTRICTED_MEM_ACCESS)) {
 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         /*
 223          * The below virtio_synchronize_cbs() guarantees that any
 224          * interrupt for this line arriving after
 225          * virtio_synchronize_vqs() has completed is guaranteed to see
 226          * vq->broken as true.
 227          */
 228         virtio_break_device(dev);
 229         virtio_synchronize_cbs(dev);
 230
 231         dev->config->reset(dev);
 232 }
 233 EXPORT_SYMBOL_GPL(virtio_reset_device);
 234
 235 static int virtio_dev_probe(struct device *_d)
 236 {
 237         int err, i;
 238         struct virtio_device *dev = dev_to_virtio(_d);
 239         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 240         u64 device_features;
 241         u64 driver_features;
 242         u64 driver_features_legacy;
 243
 244         /* We have a driver! */
 245         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 246
 247         /* Figure out what features the device supports. */
 248         device_features = dev->config->get_features(dev);
 249
 250         /* Figure out what features the driver supports. */
 251         driver_features = 0;
 252         for (i = 0; i < drv->feature_table_size; i++) {
 253                 unsigned int f = drv->feature_table[i];
 254                 BUG_ON(f >= 64);
 255                 driver_features |= (1ULL << f);
 256         }
 257
 258         /* Some drivers have a separate feature table for virtio v1.0 */
 259         if (drv->feature_table_legacy) {
 260                 driver_features_legacy = 0;
 261                 for (i = 0; i < drv->feature_table_size_legacy; i++) {
 262                         unsigned int f = drv->feature_table_legacy[i];
 263                         BUG_ON(f >= 64);
 264                         driver_features_legacy |= (1ULL << f);
 265                 }
 266         } else {
 267                 driver_features_legacy = driver_features;
 268         }
 269
 270         if (device_features & (1ULL << VIRTIO_F_VERSION_1))
 271                 dev->features = driver_features & device_features;
 272         else
 273                 dev->features = driver_features_legacy & device_features;
 274
 275         /* Transport features always preserved to pass to finalize_features. */
 276         for (i = VIRTIO_TRANSPORT_F_START; i < VIRTIO_TRANSPORT_F_END; i++)
 277                 if (device_features & (1ULL << i))
 278                         __virtio_set_bit(dev, i);
 279
 280         err = dev->config->finalize_features(dev);
 281         if (err)
 282                 goto err;
 283
 284         if (drv->validate) {
 285                 u64 features = dev->features;
 286
 287                 err = drv->validate(dev);
 288                 if (err)
 289                         goto err;
 290
 291                 /* Did validation change any features? Then write them again. */
 292                 if (features != dev->features) {
 293                         err = dev->config->finalize_features(dev);
 294                         if (err)
 295                                 goto err;
 296                 }
 297         }
 298
 299         err = virtio_features_ok(dev);
 300         if (err)
 301                 goto err;
 302
 303         err = drv->probe(dev);
 304         if (err)
 305                 goto err;
 306
 307         /* If probe didn't do it, mark device DRIVER_OK ourselves. */
 308         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 309                 virtio_device_ready(dev);
 310
 311         if (drv->scan)
 312                 drv->scan(dev);
 313
 314         virtio_config_enable(dev);
 315
 316         return 0;
 317 err:
 318         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 319         return err;
 320
 321 }
 322
 323 static void virtio_dev_remove(struct device *_d)
 324 {
 325         struct virtio_device *dev = dev_to_virtio(_d);
 326         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 327
 328         virtio_config_disable(dev);
 329
 330         drv->remove(dev);
 331
 332         /* Driver should have reset device. */
 333         WARN_ON_ONCE(dev->config->get_status(dev));
 334
 335         /* Acknowledge the device's existence again. */
 336         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 337
 338         of_node_put(dev->dev.of_node);
 339 }
 340
 341 static struct bus_type virtio_bus = {
 342         .name  = "virtio",
 343         .match = virtio_dev_match,
 344         .dev_groups = virtio_dev_groups,
 345         .uevent = virtio_uevent,
 346         .probe = virtio_dev_probe,
 347         .remove = virtio_dev_remove,
 348 };
 349
 350 int register_virtio_driver(struct virtio_driver *driver)
 351 {
 352         /* Catch this early. */
 353         BUG_ON(driver->feature_table_size && !driver->feature_table);
 354         driver->driver.bus = &virtio_bus;
 355         return driver_register(&driver->driver);
 356 }
 357 EXPORT_SYMBOL_GPL(register_virtio_driver);
 358
 359 void unregister_virtio_driver(struct virtio_driver *driver)
 360 {
 361         driver_unregister(&driver->driver);
 362 }
 363 EXPORT_SYMBOL_GPL(unregister_virtio_driver);
 364
 365 static int virtio_device_of_init(struct virtio_device *dev)
 366 {
 367         struct device_node *np, *pnode = dev_of_node(dev->dev.parent);
 368         char compat[] = "virtio,deviceXXXXXXXX";
 369         int ret, count;
 370
 371         if (!pnode)
 372                 return 0;
 373
 374         count = of_get_available_child_count(pnode);
 375         if (!count)
 376                 return 0;
 377
 378         /* There can be only 1 child node */
 379         if (WARN_ON(count > 1))
 380                 return -EINVAL;
 381
 382         np = of_get_next_available_child(pnode, NULL);
 383         if (WARN_ON(!np))
 384                 return -ENODEV;
 385
 386         ret = snprintf(compat, sizeof(compat), "virtio,device%x", dev->id.device);
 387         BUG_ON(ret >= sizeof(compat));
 388
 389         /*
 390          * On powerpc/pseries virtio devices are PCI devices so PCI
 391          * vendor/device ids play the role of the "compatible" property.
 392          * Simply don't init of_node in this case.
 393          */
 394         if (!of_device_is_compatible(np, compat)) {
 395                 ret = 0;
 396                 goto out;
 397         }
 398
 399         dev->dev.of_node = np;
 400         return 0;
 401
 402 out:
 403         of_node_put(np);
 404         return ret;
 405 }
 406
 407 /**
 408  * register_virtio_device - register virtio device
 409  * @dev        : virtio device to be registered
 410  *
 411  * On error, the caller must call put_device on &@dev->dev (and not kfree),
 412  * as another code path may have obtained a reference to @dev.
 413  *
 414  * Returns: 0 on suceess, -error on failure
 415  */
 416 int register_virtio_device(struct virtio_device *dev)
 417 {
 418         int err;
 419
 420         dev->dev.bus = &virtio_bus;
 421         device_initialize(&dev->dev);
 422
 423         /* Assign a unique device index and hence name. */
 424         err = ida_alloc(&virtio_index_ida, GFP_KERNEL);
 425         if (err < 0)
 426                 goto out;
 427
 428         dev->index = err;
 429         dev_set_name(&dev->dev, "virtio%u", dev->index);
 430
 431         err = virtio_device_of_init(dev);
 432         if (err)
 433                 goto out_ida_remove;
 434
 435         spin_lock_init(&dev->config_lock);
 436         dev->config_enabled = false;
 437         dev->config_change_pending = false;
 438
 439         INIT_LIST_HEAD(&dev->vqs);
 440         spin_lock_init(&dev->vqs_list_lock);
 441
 442         /* We always start by resetting the device, in case a previous
 443          * driver messed it up.  This also tests that code path a little. */
 444         virtio_reset_device(dev);
 445
 446         /* Acknowledge that we've seen the device. */
 447         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 448
 449         /*
 450          * device_add() causes the bus infrastructure to look for a matching
 451          * driver.
 452          */
 453         err = device_add(&dev->dev);
 454         if (err)
 455                 goto out_of_node_put;
 456
 457         return 0;
 458
 459 out_of_node_put:
 460         of_node_put(dev->dev.of_node);
 461 out_ida_remove:
 462         ida_free(&virtio_index_ida, dev->index);
 463 out:
 464         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 465         return err;
 466 }
 467 EXPORT_SYMBOL_GPL(register_virtio_device);
 468
 469 bool is_virtio_device(struct device *dev)
 470 {
 471         return dev->bus == &virtio_bus;
 472 }
 473 EXPORT_SYMBOL_GPL(is_virtio_device);
 474
 475 void unregister_virtio_device(struct virtio_device *dev)
 476 {
 477         int index = dev->index; /* save for after device release */
 478
 479         device_unregister(&dev->dev);
 480         ida_free(&virtio_index_ida, index);
 481 }
 482 EXPORT_SYMBOL_GPL(unregister_virtio_device);
 483
 484 #ifdef CONFIG_PM_SLEEP
 485 int virtio_device_freeze(struct virtio_device *dev)
 486 {
 487         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 488
 489         virtio_config_disable(dev);
 490
 491         dev->failed = dev->config->get_status(dev) & VIRTIO_CONFIG_S_FAILED;
 492
 493         if (drv && drv->freeze)
 494                 return drv->freeze(dev);
 495
 496         return 0;
 497 }
 498 EXPORT_SYMBOL_GPL(virtio_device_freeze);
 499
 500 int virtio_device_restore(struct virtio_device *dev)
 501 {
 502         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 503         int ret;
 504
 505         /* We always start by resetting the device, in case a previous
 506          * driver messed it up. */
 507         virtio_reset_device(dev);
 508
 509         /* Acknowledge that we've seen the device. */
 510         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 511
 512         /* Maybe driver failed before freeze.
 513          * Restore the failed status, for debugging. */
 514         if (dev->failed)
 515                 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 516
 517         if (!drv)
 518                 return 0;
 519
 520         /* We have a driver! */
 521         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 522
 523         ret = dev->config->finalize_features(dev);
 524         if (ret)
 525                 goto err;
 526
 527         ret = virtio_features_ok(dev);
 528         if (ret)
 529                 goto err;
 530
 531         if (drv->restore) {
 532                 ret = drv->restore(dev);
 533                 if (ret)
 534                         goto err;
 535         }
 536
 537         /* If restore didn't do it, mark device DRIVER_OK ourselves. */
 538         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 539                 virtio_device_ready(dev);
 540
 541         virtio_config_enable(dev);
 542
 543         return 0;
 544
 545 err:
 546         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 547         return ret;
 548 }
 549 EXPORT_SYMBOL_GPL(virtio_device_restore);
 550 #endif
 551
 552 static int virtio_init(void)
 553 {
 554         if (bus_register(&virtio_bus) != 0)
 555                 panic("virtio bus registration failed");
 556         return 0;
 557 }
 558
 559 static void __exit virtio_exit(void)
 560 {
 561         bus_unregister(&virtio_bus);
 562         ida_destroy(&virtio_index_ida);
 563 }
 564 core_initcall(virtio_init);
 565 module_exit(virtio_exit);
 566
 567 MODULE_LICENSE("GPL");