drivers/virtio/virtio.c

   1 #include <linux/virtio.h>
   2 #include <linux/spinlock.h>
   3 #include <linux/virtio_config.h>
   4 #include <linux/module.h>
   5 #include <linux/idr.h>
   6 #include <uapi/linux/virtio_ids.h>
   7
   8 /* Unique numbering for virtio devices. */
   9 static DEFINE_IDA(virtio_index_ida);
  10
  11 static ssize_t device_show(struct device *_d,
  12                            struct device_attribute *attr, char *buf)
  13 {
  14         struct virtio_device *dev = dev_to_virtio(_d);
  15         return sprintf(buf, "0x%04x\n", dev->id.device);
  16 }
  17 static DEVICE_ATTR_RO(device);
  18
  19 static ssize_t vendor_show(struct device *_d,
  20                            struct device_attribute *attr, char *buf)
  21 {
  22         struct virtio_device *dev = dev_to_virtio(_d);
  23         return sprintf(buf, "0x%04x\n", dev->id.vendor);
  24 }
  25 static DEVICE_ATTR_RO(vendor);
  26
  27 static ssize_t status_show(struct device *_d,
  28                            struct device_attribute *attr, char *buf)
  29 {
  30         struct virtio_device *dev = dev_to_virtio(_d);
  31         return sprintf(buf, "0x%08x\n", dev->config->get_status(dev));
  32 }
  33 static DEVICE_ATTR_RO(status);
  34
  35 static ssize_t modalias_show(struct device *_d,
  36                              struct device_attribute *attr, char *buf)
  37 {
  38         struct virtio_device *dev = dev_to_virtio(_d);
  39         return sprintf(buf, "virtio:d%08Xv%08X\n",
  40                        dev->id.device, dev->id.vendor);
  41 }
  42 static DEVICE_ATTR_RO(modalias);
  43
  44 static ssize_t features_show(struct device *_d,
  45                              struct device_attribute *attr, char *buf)
  46 {
  47         struct virtio_device *dev = dev_to_virtio(_d);
  48         unsigned int i;
  49         ssize_t len = 0;
  50
  51         /* We actually represent this as a bitstring, as it could be
  52          * arbitrary length in future. */
  53         for (i = 0; i < sizeof(dev->features)*8; i++)
  54                 len += sprintf(buf+len, "%c",
  55                                __virtio_test_bit(dev, i) ? '1' : '0');
  56         len += sprintf(buf+len, "\n");
  57         return len;
  58 }
  59 static DEVICE_ATTR_RO(features);
  60
  61 static struct attribute *virtio_dev_attrs[] = {
  62         &dev_attr_device.attr,
  63         &dev_attr_vendor.attr,
  64         &dev_attr_status.attr,
  65         &dev_attr_modalias.attr,
  66         &dev_attr_features.attr,
  67         NULL,
  68 };
  69 ATTRIBUTE_GROUPS(virtio_dev);
  70
  71 static inline int virtio_id_match(const struct virtio_device *dev,
  72                                   const struct virtio_device_id *id)
  73 {
  74         if (id->device != dev->id.device && id->device != VIRTIO_DEV_ANY_ID)
  75                 return 0;
  76
  77         return id->vendor == VIRTIO_DEV_ANY_ID || id->vendor == dev->id.vendor;
  78 }
  79
  80 /* This looks through all the IDs a driver claims to support.  If any of them
  81  * match, we return 1 and the kernel will call virtio_dev_probe(). */
  82 static int virtio_dev_match(struct device *_dv, struct device_driver *_dr)
  83 {
  84         unsigned int i;
  85         struct virtio_device *dev = dev_to_virtio(_dv);
  86         const struct virtio_device_id *ids;
  87
  88         ids = drv_to_virtio(_dr)->id_table;
  89         for (i = 0; ids[i].device; i++)
  90                 if (virtio_id_match(dev, &ids[i]))
  91                         return 1;
  92         return 0;
  93 }
  94
  95 static int virtio_uevent(struct device *_dv, struct kobj_uevent_env *env)
  96 {
  97         struct virtio_device *dev = dev_to_virtio(_dv);
  98
  99         return add_uevent_var(env, "MODALIAS=virtio:d%08Xv%08X",
 100                               dev->id.device, dev->id.vendor);
 101 }
 102
 103 void virtio_check_driver_offered_feature(const struct virtio_device *vdev,
 104                                          unsigned int fbit)
 105 {
 106         unsigned int i;
 107         struct virtio_driver *drv = drv_to_virtio(vdev->dev.driver);
 108
 109         for (i = 0; i < drv->feature_table_size; i++)
 110                 if (drv->feature_table[i] == fbit)
 111                         return;
 112
 113         if (drv->feature_table_legacy) {
 114                 for (i = 0; i < drv->feature_table_size_legacy; i++)
 115                         if (drv->feature_table_legacy[i] == fbit)
 116                                 return;
 117         }
 118
 119         BUG();
 120 }
 121 EXPORT_SYMBOL_GPL(virtio_check_driver_offered_feature);
 122
 123 static void __virtio_config_changed(struct virtio_device *dev)
 124 {
 125         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 126
 127         if (!dev->config_enabled)
 128                 dev->config_change_pending = true;
 129         else if (drv && drv->config_changed)
 130                 drv->config_changed(dev);
 131 }
 132
 133 void virtio_config_changed(struct virtio_device *dev)
 134 {
 135         unsigned long flags;
 136
 137         spin_lock_irqsave(&dev->config_lock, flags);
 138         __virtio_config_changed(dev);
 139         spin_unlock_irqrestore(&dev->config_lock, flags);
 140 }
 141 EXPORT_SYMBOL_GPL(virtio_config_changed);
 142
 143 void virtio_config_disable(struct virtio_device *dev)
 144 {
 145         spin_lock_irq(&dev->config_lock);
 146         dev->config_enabled = false;
 147         spin_unlock_irq(&dev->config_lock);
 148 }
 149 EXPORT_SYMBOL_GPL(virtio_config_disable);
 150
 151 void virtio_config_enable(struct virtio_device *dev)
 152 {
 153         spin_lock_irq(&dev->config_lock);
 154         dev->config_enabled = true;
 155         if (dev->config_change_pending)
 156                 __virtio_config_changed(dev);
 157         dev->config_change_pending = false;
 158         spin_unlock_irq(&dev->config_lock);
 159 }
 160 EXPORT_SYMBOL_GPL(virtio_config_enable);
 161
 162 void virtio_add_status(struct virtio_device *dev, unsigned int status)
 163 {
 164         dev->config->set_status(dev, dev->config->get_status(dev) | status);
 165 }
 166 EXPORT_SYMBOL_GPL(virtio_add_status);
 167
 168 /* Do some validation, then set FEATURES_OK */
 169 static int virtio_features_ok(struct virtio_device *dev)
 170 {
 171         unsigned status;
 172
 173         if (!virtio_has_feature(dev, VIRTIO_F_VERSION_1))
 174                 return 0;
 175
 176         virtio_add_status(dev, VIRTIO_CONFIG_S_FEATURES_OK);
 177         status = dev->config->get_status(dev);
 178         if (!(status & VIRTIO_CONFIG_S_FEATURES_OK)) {
 179                 dev_err(&dev->dev, "virtio: device refuses features: %x\n",
 180                         status);
 181                 return -ENODEV;
 182         }
 183         return 0;
 184 }
 185
 186 static int virtio_dev_probe(struct device *_d)
 187 {
 188         int err, i;
 189         struct virtio_device *dev = dev_to_virtio(_d);
 190         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 191         u64 device_features;
 192         u64 driver_features;
 193         u64 driver_features_legacy;
 194
 195         /* We have a driver! */
 196         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 197
 198         /* Figure out what features the device supports. */
 199         device_features = dev->config->get_features(dev);
 200
 201         /* Figure out what features the driver supports. */
 202         driver_features = 0;
 203         for (i = 0; i < drv->feature_table_size; i++) {
 204                 unsigned int f = drv->feature_table[i];
 205                 BUG_ON(f >= 64);
 206                 driver_features |= (1ULL << f);
 207         }
 208
 209         /* Some drivers have a separate feature table for virtio v1.0 */
 210         if (drv->feature_table_legacy) {
 211                 driver_features_legacy = 0;
 212                 for (i = 0; i < drv->feature_table_size_legacy; i++) {
 213                         unsigned int f = drv->feature_table_legacy[i];
 214                         BUG_ON(f >= 64);
 215                         driver_features_legacy |= (1ULL << f);
 216                 }
 217         } else {
 218                 driver_features_legacy = driver_features;
 219         }
 220
 221         if (device_features & (1ULL << VIRTIO_F_VERSION_1))
 222                 dev->features = driver_features & device_features;
 223         else
 224                 dev->features = driver_features_legacy & device_features;
 225
 226         /* Transport features always preserved to pass to finalize_features. */
 227         for (i = VIRTIO_TRANSPORT_F_START; i < VIRTIO_TRANSPORT_F_END; i++)
 228                 if (device_features & (1ULL << i))
 229                         __virtio_set_bit(dev, i);
 230
 231         err = dev->config->finalize_features(dev);
 232         if (err)
 233                 goto err;
 234
 235         if (drv->validate) {
 236                 u64 features = dev->features;
 237
 238                 err = drv->validate(dev);
 239                 if (err)
 240                         goto err;
 241
 242                 /* Did validation change any features? Then write them again. */
 243                 if (features != dev->features) {
 244                         err = dev->config->finalize_features(dev);
 245                         if (err)
 246                                 goto err;
 247                 }
 248         }
 249
 250         err = virtio_features_ok(dev);
 251         if (err)
 252                 goto err;
 253
 254         err = drv->probe(dev);
 255         if (err)
 256                 goto err;
 257
 258         /* If probe didn't do it, mark device DRIVER_OK ourselves. */
 259         if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
 260                 virtio_device_ready(dev);
 261
 262         if (drv->scan)
 263                 drv->scan(dev);
 264
 265         virtio_config_enable(dev);
 266
 267         return 0;
 268 err:
 269         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 270         return err;
 271
 272 }
 273
 274 static int virtio_dev_remove(struct device *_d)
 275 {
 276         struct virtio_device *dev = dev_to_virtio(_d);
 277         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 278
 279         virtio_config_disable(dev);
 280
 281         drv->remove(dev);
 282
 283         /* Driver should have reset device. */
 284         WARN_ON_ONCE(dev->config->get_status(dev));
 285
 286         /* Acknowledge the device's existence again. */
 287         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 288         return 0;
 289 }
 290
 291 static struct bus_type virtio_bus = {
 292         .name  = "virtio",
 293         .match = virtio_dev_match,
 294         .dev_groups = virtio_dev_groups,
 295         .uevent = virtio_uevent,
 296         .probe = virtio_dev_probe,
 297         .remove = virtio_dev_remove,
 298 };
 299
 300 int register_virtio_driver(struct virtio_driver *driver)
 301 {
 302         /* Catch this early. */
 303         BUG_ON(driver->feature_table_size && !driver->feature_table);
 304         driver->driver.bus = &virtio_bus;
 305         return driver_register(&driver->driver);
 306 }
 307 EXPORT_SYMBOL_GPL(register_virtio_driver);
 308
 309 void unregister_virtio_driver(struct virtio_driver *driver)
 310 {
 311         driver_unregister(&driver->driver);
 312 }
 313 EXPORT_SYMBOL_GPL(unregister_virtio_driver);
 314
 315 /**
 316  * register_virtio_device - register virtio device
 317  * @dev        : virtio device to be registered
 318  *
 319  * On error, the caller must call put_device on &@dev->dev (and not kfree),
 320  * as another code path may have obtained a reference to @dev.
 321  *
 322  * Returns: 0 on suceess, -error on failure
 323  */
 324 int register_virtio_device(struct virtio_device *dev)
 325 {
 326         int err;
 327
 328         dev->dev.bus = &virtio_bus;
 329         device_initialize(&dev->dev);
 330
 331         /* Assign a unique device index and hence name. */
 332         err = ida_simple_get(&virtio_index_ida, 0, 0, GFP_KERNEL);
 333         if (err < 0)
 334                 goto out;
 335
 336         dev->index = err;
 337         dev_set_name(&dev->dev, "virtio%u", dev->index);
 338
 339         spin_lock_init(&dev->config_lock);
 340         dev->config_enabled = false;
 341         dev->config_change_pending = false;
 342
 343         /* We always start by resetting the device, in case a previous
 344          * driver messed it up.  This also tests that code path a little. */
 345         dev->config->reset(dev);
 346
 347         /* Acknowledge that we've seen the device. */
 348         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 349
 350         INIT_LIST_HEAD(&dev->vqs);
 351
 352         /*
 353          * device_add() causes the bus infrastructure to look for a matching
 354          * driver.
 355          */
 356         err = device_add(&dev->dev);
 357         if (err)
 358                 ida_simple_remove(&virtio_index_ida, dev->index);
 359 out:
 360         if (err)
 361                 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 362         return err;
 363 }
 364 EXPORT_SYMBOL_GPL(register_virtio_device);
 365
 366 void unregister_virtio_device(struct virtio_device *dev)
 367 {
 368         int index = dev->index; /* save for after device release */
 369
 370         device_unregister(&dev->dev);
 371         ida_simple_remove(&virtio_index_ida, index);
 372 }
 373 EXPORT_SYMBOL_GPL(unregister_virtio_device);
 374
 375 #ifdef CONFIG_PM_SLEEP
 376 int virtio_device_freeze(struct virtio_device *dev)
 377 {
 378         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 379
 380         virtio_config_disable(dev);
 381
 382         dev->failed = dev->config->get_status(dev) & VIRTIO_CONFIG_S_FAILED;
 383
 384         if (drv && drv->freeze)
 385                 return drv->freeze(dev);
 386
 387         return 0;
 388 }
 389 EXPORT_SYMBOL_GPL(virtio_device_freeze);
 390
 391 int virtio_device_restore(struct virtio_device *dev)
 392 {
 393         struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
 394         int ret;
 395
 396         /* We always start by resetting the device, in case a previous
 397          * driver messed it up. */
 398         dev->config->reset(dev);
 399
 400         /* Acknowledge that we've seen the device. */
 401         virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
 402
 403         /* Maybe driver failed before freeze.
 404          * Restore the failed status, for debugging. */
 405         if (dev->failed)
 406                 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 407
 408         if (!drv)
 409                 return 0;
 410
 411         /* We have a driver! */
 412         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
 413
 414         ret = dev->config->finalize_features(dev);
 415         if (ret)
 416                 goto err;
 417
 418         ret = virtio_features_ok(dev);
 419         if (ret)
 420                 goto err;
 421
 422         if (drv->restore) {
 423                 ret = drv->restore(dev);
 424                 if (ret)
 425                         goto err;
 426         }
 427
 428         /* Finally, tell the device we're all set */
 429         virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER_OK);
 430
 431         virtio_config_enable(dev);
 432
 433         return 0;
 434
 435 err:
 436         virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
 437         return ret;
 438 }
 439 EXPORT_SYMBOL_GPL(virtio_device_restore);
 440 #endif
 441
 442 static int virtio_init(void)
 443 {
 444         if (bus_register(&virtio_bus) != 0)
 445                 panic("virtio bus registration failed");
 446         return 0;
 447 }
 448
 449 static void __exit virtio_exit(void)
 450 {
 451         bus_unregister(&virtio_bus);
 452         ida_destroy(&virtio_index_ida);
 453 }
 454 core_initcall(virtio_init);
 455 module_exit(virtio_exit);
 456
 457 MODULE_LICENSE("GPL");