Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 1 | #ifndef _LINUX_VIRTIO_H |
| 2 | #define _LINUX_VIRTIO_H |
| 3 | /* Everything a virtio driver needs to work with any particular virtio |
| 4 | * implementation. */ |
| 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> |
Michael S. Tsirkin | bbd603e | 2010-04-29 17:26:37 +0300 | [diff] [blame] | 10 | #include <linux/gfp.h> |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 11 | |
| 12 | /** |
| 13 | * virtqueue - a queue to register buffers for sending or receiving. |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 14 | * @list: the chain of virtqueues for this device |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 15 | * @callback: the function to call when buffers are consumed (can be NULL). |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 16 | * @name: the name of this virtqueue (mainly for debugging) |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 17 | * @vdev: the virtio device this queue was created for. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 18 | * @priv: a pointer for the virtqueue implementation to use. |
Rusty Russell | 06ca287 | 2012-10-16 23:56:14 +1030 | [diff] [blame] | 19 | * @index: the zero-based ordinal number for this queue. |
| 20 | * @num_free: number of elements we expect to be able to fit. |
| 21 | * |
| 22 | * A note on @num_free: with indirect buffers, each buffer needs one |
| 23 | * element in the queue, otherwise a buffer will need one element per |
| 24 | * sg element. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 25 | */ |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 26 | struct virtqueue { |
| 27 | struct list_head list; |
Rusty Russell | 18445c4 | 2008-02-04 23:49:57 -0500 | [diff] [blame] | 28 | void (*callback)(struct virtqueue *vq); |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 29 | const char *name; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 30 | struct virtio_device *vdev; |
Rusty Russell | 06ca287 | 2012-10-16 23:56:14 +1030 | [diff] [blame] | 31 | unsigned int index; |
| 32 | unsigned int num_free; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 33 | void *priv; |
| 34 | }; |
| 35 | |
Rusty Russell | f96fde4 | 2012-01-12 15:44:42 +1030 | [diff] [blame] | 36 | int virtqueue_add_buf(struct virtqueue *vq, |
| 37 | struct scatterlist sg[], |
| 38 | unsigned int out_num, |
| 39 | unsigned int in_num, |
| 40 | void *data, |
| 41 | gfp_t gfp); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 42 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 43 | void virtqueue_kick(struct virtqueue *vq); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 44 | |
Rusty Russell | 41f0377 | 2012-01-12 15:44:43 +1030 | [diff] [blame] | 45 | bool virtqueue_kick_prepare(struct virtqueue *vq); |
| 46 | |
| 47 | void virtqueue_notify(struct virtqueue *vq); |
| 48 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 49 | void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 50 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 51 | void virtqueue_disable_cb(struct virtqueue *vq); |
Michael S. Tsirkin | 316f25f | 2010-04-12 16:18:25 +0300 | [diff] [blame] | 52 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 53 | bool virtqueue_enable_cb(struct virtqueue *vq); |
Michael S. Tsirkin | 316f25f | 2010-04-12 16:18:25 +0300 | [diff] [blame] | 54 | |
Michael S. Tsirkin | 7ab358c | 2011-05-20 02:11:14 +0300 | [diff] [blame] | 55 | bool virtqueue_enable_cb_delayed(struct virtqueue *vq); |
| 56 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 57 | void *virtqueue_detach_unused_buf(struct virtqueue *vq); |
Michael S. Tsirkin | 316f25f | 2010-04-12 16:18:25 +0300 | [diff] [blame] | 58 | |
Rick Jones | 8f9f466 | 2011-10-19 08:10:59 +0000 | [diff] [blame] | 59 | unsigned int virtqueue_get_vring_size(struct virtqueue *vq); |
| 60 | |
Rusty Russell | 06ca287 | 2012-10-16 23:56:14 +1030 | [diff] [blame] | 61 | /* FIXME: Obsolete accessor, but required for virtio_net merge. */ |
| 62 | static inline unsigned int virtqueue_get_queue_index(struct virtqueue *vq) |
| 63 | { |
| 64 | return vq->index; |
| 65 | } |
Jason Wang | 17bb6d4 | 2012-08-28 13:54:13 +0200 | [diff] [blame] | 66 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 67 | /** |
| 68 | * virtio_device - representation of a device using virtio |
| 69 | * @index: unique position on the virtio bus |
| 70 | * @dev: underlying device. |
| 71 | * @id: the device type identification (used to match it with a driver). |
| 72 | * @config: the configuration ops for this device. |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 73 | * @vqs: the list of virtqueues for this device. |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 74 | * @features: the features supported by both driver and device. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 75 | * @priv: private pointer for the driver's use. |
| 76 | */ |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 77 | struct virtio_device { |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 78 | int index; |
| 79 | struct device dev; |
| 80 | struct virtio_device_id id; |
Stephen Hemminger | 9350393 | 2013-02-10 15:57:38 +1030 | [diff] [blame] | 81 | const struct virtio_config_ops *config; |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 82 | struct list_head vqs; |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 83 | /* Note that this is a Linux set_bit-style bitmap. */ |
| 84 | unsigned long features[1]; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 85 | void *priv; |
| 86 | }; |
| 87 | |
Wanlong Gao | 9bffdca | 2012-12-11 11:04:50 +1030 | [diff] [blame] | 88 | static inline struct virtio_device *dev_to_virtio(struct device *_dev) |
| 89 | { |
| 90 | return container_of(_dev, struct virtio_device, dev); |
| 91 | } |
| 92 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 93 | int register_virtio_device(struct virtio_device *dev); |
| 94 | void unregister_virtio_device(struct virtio_device *dev); |
| 95 | |
| 96 | /** |
| 97 | * virtio_driver - operations for a virtio I/O driver |
| 98 | * @driver: underlying device driver (populate name and owner). |
| 99 | * @id_table: the ids serviced by this driver. |
Wang Sheng-Hui | 5f41f8b | 2011-08-25 21:04:05 +0800 | [diff] [blame] | 100 | * @feature_table: an array of feature numbers supported by this driver. |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 101 | * @feature_table_size: number of entries in the feature table array. |
Rusty Russell | 20f77f5 | 2009-06-12 22:16:33 -0600 | [diff] [blame] | 102 | * @probe: the function to call when a device is found. Returns 0 or -errno. |
Wang Sheng-Hui | 5f41f8b | 2011-08-25 21:04:05 +0800 | [diff] [blame] | 103 | * @remove: the function to call when a device is removed. |
Rusty Russell | f957d1f | 2008-02-04 23:49:58 -0500 | [diff] [blame] | 104 | * @config_changed: optional function to call when the device configuration |
| 105 | * changes; may be called in interrupt context. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 106 | */ |
| 107 | struct virtio_driver { |
| 108 | struct device_driver driver; |
| 109 | const struct virtio_device_id *id_table; |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 110 | const unsigned int *feature_table; |
| 111 | unsigned int feature_table_size; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 112 | int (*probe)(struct virtio_device *dev); |
Nicholas Bellinger | 59057fb | 2012-07-11 21:22:16 +0000 | [diff] [blame] | 113 | void (*scan)(struct virtio_device *dev); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 114 | void (*remove)(struct virtio_device *dev); |
Rusty Russell | f957d1f | 2008-02-04 23:49:58 -0500 | [diff] [blame] | 115 | void (*config_changed)(struct virtio_device *dev); |
Amit Shah | f0fe6f1 | 2011-12-22 16:58:26 +0530 | [diff] [blame] | 116 | #ifdef CONFIG_PM |
| 117 | int (*freeze)(struct virtio_device *dev); |
Amit Shah | f0fe6f1 | 2011-12-22 16:58:26 +0530 | [diff] [blame] | 118 | int (*restore)(struct virtio_device *dev); |
| 119 | #endif |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 120 | }; |
| 121 | |
Wanlong Gao | 9a2bdcc | 2012-12-10 16:38:33 +0800 | [diff] [blame] | 122 | static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv) |
| 123 | { |
| 124 | return container_of(drv, struct virtio_driver, driver); |
| 125 | } |
| 126 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 127 | int register_virtio_driver(struct virtio_driver *drv); |
| 128 | void unregister_virtio_driver(struct virtio_driver *drv); |
Sjur Brændeland | 6e105e0 | 2013-02-13 15:52:36 +1030 | [diff] [blame] | 129 | |
| 130 | /* module_virtio_driver() - Helper macro for drivers that don't do |
| 131 | * anything special in module init/exit. This eliminates a lot of |
| 132 | * boilerplate. Each module may only use this macro once, and |
| 133 | * calling it replaces module_init() and module_exit() |
| 134 | */ |
| 135 | #define module_virtio_driver(__virtio_driver) \ |
| 136 | module_driver(__virtio_driver, register_virtio_driver, \ |
| 137 | unregister_virtio_driver) |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 138 | #endif /* _LINUX_VIRTIO_H */ |