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>
7 #include <uapi/linux/virtio_ids.h>
9 /* Unique numbering for virtio devices. */
10 static DEFINE_IDA(virtio_index_ida);
12 static ssize_t device_show(struct device *_d,
13 struct device_attribute *attr, char *buf)
15 struct virtio_device *dev = dev_to_virtio(_d);
16 return sprintf(buf, "0x%04x\n", dev->id.device);
18 static DEVICE_ATTR_RO(device);
20 static ssize_t vendor_show(struct device *_d,
21 struct device_attribute *attr, char *buf)
23 struct virtio_device *dev = dev_to_virtio(_d);
24 return sprintf(buf, "0x%04x\n", dev->id.vendor);
26 static DEVICE_ATTR_RO(vendor);
28 static ssize_t status_show(struct device *_d,
29 struct device_attribute *attr, char *buf)
31 struct virtio_device *dev = dev_to_virtio(_d);
32 return sprintf(buf, "0x%08x\n", dev->config->get_status(dev));
34 static DEVICE_ATTR_RO(status);
36 static ssize_t modalias_show(struct device *_d,
37 struct device_attribute *attr, char *buf)
39 struct virtio_device *dev = dev_to_virtio(_d);
40 return sprintf(buf, "virtio:d%08Xv%08X\n",
41 dev->id.device, dev->id.vendor);
43 static DEVICE_ATTR_RO(modalias);
45 static ssize_t features_show(struct device *_d,
46 struct device_attribute *attr, char *buf)
48 struct virtio_device *dev = dev_to_virtio(_d);
52 /* We actually represent this as a bitstring, as it could be
53 * arbitrary length in future. */
54 for (i = 0; i < sizeof(dev->features)*8; i++)
55 len += sprintf(buf+len, "%c",
56 __virtio_test_bit(dev, i) ? '1' : '0');
57 len += sprintf(buf+len, "\n");
60 static DEVICE_ATTR_RO(features);
62 static struct attribute *virtio_dev_attrs[] = {
63 &dev_attr_device.attr,
64 &dev_attr_vendor.attr,
65 &dev_attr_status.attr,
66 &dev_attr_modalias.attr,
67 &dev_attr_features.attr,
70 ATTRIBUTE_GROUPS(virtio_dev);
72 static inline int virtio_id_match(const struct virtio_device *dev,
73 const struct virtio_device_id *id)
75 if (id->device != dev->id.device && id->device != VIRTIO_DEV_ANY_ID)
78 return id->vendor == VIRTIO_DEV_ANY_ID || id->vendor == dev->id.vendor;
81 /* This looks through all the IDs a driver claims to support. If any of them
82 * match, we return 1 and the kernel will call virtio_dev_probe(). */
83 static int virtio_dev_match(struct device *_dv, struct device_driver *_dr)
86 struct virtio_device *dev = dev_to_virtio(_dv);
87 const struct virtio_device_id *ids;
89 ids = drv_to_virtio(_dr)->id_table;
90 for (i = 0; ids[i].device; i++)
91 if (virtio_id_match(dev, &ids[i]))
96 static int virtio_uevent(struct device *_dv, struct kobj_uevent_env *env)
98 struct virtio_device *dev = dev_to_virtio(_dv);
100 return add_uevent_var(env, "MODALIAS=virtio:d%08Xv%08X",
101 dev->id.device, dev->id.vendor);
104 void virtio_check_driver_offered_feature(const struct virtio_device *vdev,
108 struct virtio_driver *drv = drv_to_virtio(vdev->dev.driver);
110 for (i = 0; i < drv->feature_table_size; i++)
111 if (drv->feature_table[i] == fbit)
114 if (drv->feature_table_legacy) {
115 for (i = 0; i < drv->feature_table_size_legacy; i++)
116 if (drv->feature_table_legacy[i] == fbit)
122 EXPORT_SYMBOL_GPL(virtio_check_driver_offered_feature);
124 static void __virtio_config_changed(struct virtio_device *dev)
126 struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
128 if (!dev->config_enabled)
129 dev->config_change_pending = true;
130 else if (drv && drv->config_changed)
131 drv->config_changed(dev);
134 void virtio_config_changed(struct virtio_device *dev)
138 spin_lock_irqsave(&dev->config_lock, flags);
139 __virtio_config_changed(dev);
140 spin_unlock_irqrestore(&dev->config_lock, flags);
142 EXPORT_SYMBOL_GPL(virtio_config_changed);
144 void virtio_config_disable(struct virtio_device *dev)
146 spin_lock_irq(&dev->config_lock);
147 dev->config_enabled = false;
148 spin_unlock_irq(&dev->config_lock);
150 EXPORT_SYMBOL_GPL(virtio_config_disable);
152 void virtio_config_enable(struct virtio_device *dev)
154 spin_lock_irq(&dev->config_lock);
155 dev->config_enabled = true;
156 if (dev->config_change_pending)
157 __virtio_config_changed(dev);
158 dev->config_change_pending = false;
159 spin_unlock_irq(&dev->config_lock);
161 EXPORT_SYMBOL_GPL(virtio_config_enable);
163 void virtio_add_status(struct virtio_device *dev, unsigned int status)
166 dev->config->set_status(dev, dev->config->get_status(dev) | status);
168 EXPORT_SYMBOL_GPL(virtio_add_status);
170 /* Do some validation, then set FEATURES_OK */
171 static int virtio_features_ok(struct virtio_device *dev)
178 ret = arch_has_restricted_virtio_memory_access();
180 if (!virtio_has_feature(dev, VIRTIO_F_VERSION_1)) {
182 "device must provide VIRTIO_F_VERSION_1\n");
186 if (!virtio_has_feature(dev, VIRTIO_F_ACCESS_PLATFORM)) {
188 "device must provide VIRTIO_F_ACCESS_PLATFORM\n");
193 if (!virtio_has_feature(dev, VIRTIO_F_VERSION_1))
196 virtio_add_status(dev, VIRTIO_CONFIG_S_FEATURES_OK);
197 status = dev->config->get_status(dev);
198 if (!(status & VIRTIO_CONFIG_S_FEATURES_OK)) {
199 dev_err(&dev->dev, "virtio: device refuses features: %x\n",
206 static int virtio_dev_probe(struct device *_d)
209 struct virtio_device *dev = dev_to_virtio(_d);
210 struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
213 u64 driver_features_legacy;
215 /* We have a driver! */
216 virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
218 /* Figure out what features the device supports. */
219 device_features = dev->config->get_features(dev);
221 /* Figure out what features the driver supports. */
223 for (i = 0; i < drv->feature_table_size; i++) {
224 unsigned int f = drv->feature_table[i];
226 driver_features |= (1ULL << f);
229 /* Some drivers have a separate feature table for virtio v1.0 */
230 if (drv->feature_table_legacy) {
231 driver_features_legacy = 0;
232 for (i = 0; i < drv->feature_table_size_legacy; i++) {
233 unsigned int f = drv->feature_table_legacy[i];
235 driver_features_legacy |= (1ULL << f);
238 driver_features_legacy = driver_features;
241 if (device_features & (1ULL << VIRTIO_F_VERSION_1))
242 dev->features = driver_features & device_features;
244 dev->features = driver_features_legacy & device_features;
246 /* Transport features always preserved to pass to finalize_features. */
247 for (i = VIRTIO_TRANSPORT_F_START; i < VIRTIO_TRANSPORT_F_END; i++)
248 if (device_features & (1ULL << i))
249 __virtio_set_bit(dev, i);
251 err = dev->config->finalize_features(dev);
256 u64 features = dev->features;
258 err = drv->validate(dev);
262 /* Did validation change any features? Then write them again. */
263 if (features != dev->features) {
264 err = dev->config->finalize_features(dev);
270 err = virtio_features_ok(dev);
274 err = drv->probe(dev);
278 /* If probe didn't do it, mark device DRIVER_OK ourselves. */
279 if (!(dev->config->get_status(dev) & VIRTIO_CONFIG_S_DRIVER_OK))
280 virtio_device_ready(dev);
285 virtio_config_enable(dev);
289 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
294 static int virtio_dev_remove(struct device *_d)
296 struct virtio_device *dev = dev_to_virtio(_d);
297 struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
299 virtio_config_disable(dev);
303 /* Driver should have reset device. */
304 WARN_ON_ONCE(dev->config->get_status(dev));
306 /* Acknowledge the device's existence again. */
307 virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
311 static struct bus_type virtio_bus = {
313 .match = virtio_dev_match,
314 .dev_groups = virtio_dev_groups,
315 .uevent = virtio_uevent,
316 .probe = virtio_dev_probe,
317 .remove = virtio_dev_remove,
320 int register_virtio_driver(struct virtio_driver *driver)
322 /* Catch this early. */
323 BUG_ON(driver->feature_table_size && !driver->feature_table);
324 driver->driver.bus = &virtio_bus;
325 return driver_register(&driver->driver);
327 EXPORT_SYMBOL_GPL(register_virtio_driver);
329 void unregister_virtio_driver(struct virtio_driver *driver)
331 driver_unregister(&driver->driver);
333 EXPORT_SYMBOL_GPL(unregister_virtio_driver);
336 * register_virtio_device - register virtio device
337 * @dev : virtio device to be registered
339 * On error, the caller must call put_device on &@dev->dev (and not kfree),
340 * as another code path may have obtained a reference to @dev.
342 * Returns: 0 on suceess, -error on failure
344 int register_virtio_device(struct virtio_device *dev)
348 dev->dev.bus = &virtio_bus;
349 device_initialize(&dev->dev);
351 /* Assign a unique device index and hence name. */
352 err = ida_simple_get(&virtio_index_ida, 0, 0, GFP_KERNEL);
357 dev_set_name(&dev->dev, "virtio%u", dev->index);
359 spin_lock_init(&dev->config_lock);
360 dev->config_enabled = false;
361 dev->config_change_pending = false;
363 /* We always start by resetting the device, in case a previous
364 * driver messed it up. This also tests that code path a little. */
365 dev->config->reset(dev);
367 /* Acknowledge that we've seen the device. */
368 virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
370 INIT_LIST_HEAD(&dev->vqs);
371 spin_lock_init(&dev->vqs_list_lock);
374 * device_add() causes the bus infrastructure to look for a matching
377 err = device_add(&dev->dev);
379 ida_simple_remove(&virtio_index_ida, dev->index);
382 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
385 EXPORT_SYMBOL_GPL(register_virtio_device);
387 bool is_virtio_device(struct device *dev)
389 return dev->bus == &virtio_bus;
391 EXPORT_SYMBOL_GPL(is_virtio_device);
393 void unregister_virtio_device(struct virtio_device *dev)
395 int index = dev->index; /* save for after device release */
397 device_unregister(&dev->dev);
398 ida_simple_remove(&virtio_index_ida, index);
400 EXPORT_SYMBOL_GPL(unregister_virtio_device);
402 #ifdef CONFIG_PM_SLEEP
403 int virtio_device_freeze(struct virtio_device *dev)
405 struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
408 virtio_config_disable(dev);
410 dev->failed = dev->config->get_status(dev) & VIRTIO_CONFIG_S_FAILED;
412 if (drv && drv->freeze) {
413 ret = drv->freeze(dev);
415 virtio_config_enable(dev);
422 EXPORT_SYMBOL_GPL(virtio_device_freeze);
424 int virtio_device_restore(struct virtio_device *dev)
426 struct virtio_driver *drv = drv_to_virtio(dev->dev.driver);
429 /* We always start by resetting the device, in case a previous
430 * driver messed it up. */
431 dev->config->reset(dev);
433 /* Acknowledge that we've seen the device. */
434 virtio_add_status(dev, VIRTIO_CONFIG_S_ACKNOWLEDGE);
436 /* Maybe driver failed before freeze.
437 * Restore the failed status, for debugging. */
439 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
444 /* We have a driver! */
445 virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER);
447 ret = dev->config->finalize_features(dev);
451 ret = virtio_features_ok(dev);
456 ret = drv->restore(dev);
461 /* Finally, tell the device we're all set */
462 virtio_add_status(dev, VIRTIO_CONFIG_S_DRIVER_OK);
464 virtio_config_enable(dev);
469 virtio_add_status(dev, VIRTIO_CONFIG_S_FAILED);
472 EXPORT_SYMBOL_GPL(virtio_device_restore);
475 static int virtio_init(void)
477 if (bus_register(&virtio_bus) != 0)
478 panic("virtio bus registration failed");
482 static void __exit virtio_exit(void)
484 bus_unregister(&virtio_bus);
485 ida_destroy(&virtio_index_ida);
487 core_initcall(virtio_init);
488 module_exit(virtio_exit);
490 MODULE_LICENSE("GPL");