1 #ifndef _LINUX_VIRTIO_H
2 #define _LINUX_VIRTIO_H
3 /* Everything a virtio driver needs to work with any particular virtio
5 #include <linux/types.h>
6 #include <linux/scatterlist.h>
7 #include <linux/spinlock.h>
8 #include <linux/device.h>
9 #include <linux/mod_devicetable.h>
10 #include <linux/gfp.h>
13 * virtqueue - a queue to register buffers for sending or receiving.
14 * @list: the chain of virtqueues for this device
15 * @callback: the function to call when buffers are consumed (can be NULL).
16 * @name: the name of this virtqueue (mainly for debugging)
17 * @vdev: the virtio device this queue was created for.
18 * @priv: a pointer for the virtqueue implementation to use.
21 struct list_head list;
22 void (*callback)(struct virtqueue *vq);
24 struct virtio_device *vdev;
28 int virtqueue_add_buf(struct virtqueue *vq,
29 struct scatterlist sg[],
35 void virtqueue_kick(struct virtqueue *vq);
37 void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
39 void virtqueue_disable_cb(struct virtqueue *vq);
41 bool virtqueue_enable_cb(struct virtqueue *vq);
43 bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
45 void *virtqueue_detach_unused_buf(struct virtqueue *vq);
47 unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
50 * virtio_device - representation of a device using virtio
51 * @index: unique position on the virtio bus
52 * @dev: underlying device.
53 * @id: the device type identification (used to match it with a driver).
54 * @config: the configuration ops for this device.
55 * @vqs: the list of virtqueues for this device.
56 * @features: the features supported by both driver and device.
57 * @priv: private pointer for the driver's use.
59 struct virtio_device {
62 struct virtio_device_id id;
63 struct virtio_config_ops *config;
65 /* Note that this is a Linux set_bit-style bitmap. */
66 unsigned long features[1];
70 #define dev_to_virtio(dev) container_of(dev, struct virtio_device, dev)
71 int register_virtio_device(struct virtio_device *dev);
72 void unregister_virtio_device(struct virtio_device *dev);
75 * virtio_driver - operations for a virtio I/O driver
76 * @driver: underlying device driver (populate name and owner).
77 * @id_table: the ids serviced by this driver.
78 * @feature_table: an array of feature numbers supported by this driver.
79 * @feature_table_size: number of entries in the feature table array.
80 * @probe: the function to call when a device is found. Returns 0 or -errno.
81 * @remove: the function to call when a device is removed.
82 * @config_changed: optional function to call when the device configuration
83 * changes; may be called in interrupt context.
85 struct virtio_driver {
86 struct device_driver driver;
87 const struct virtio_device_id *id_table;
88 const unsigned int *feature_table;
89 unsigned int feature_table_size;
90 int (*probe)(struct virtio_device *dev);
91 void (*remove)(struct virtio_device *dev);
92 void (*config_changed)(struct virtio_device *dev);
95 int register_virtio_driver(struct virtio_driver *drv);
96 void unregister_virtio_driver(struct virtio_driver *drv);
97 #endif /* _LINUX_VIRTIO_H */