Greg Kroah-Hartman | b244131 | 2017-11-01 15:07:57 +0100 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 2 | #ifndef _LINUX_VIRTIO_H |
| 3 | #define _LINUX_VIRTIO_H |
| 4 | /* Everything a virtio driver needs to work with any particular virtio |
| 5 | * implementation. */ |
| 6 | #include <linux/types.h> |
| 7 | #include <linux/scatterlist.h> |
| 8 | #include <linux/spinlock.h> |
| 9 | #include <linux/device.h> |
| 10 | #include <linux/mod_devicetable.h> |
Michael S. Tsirkin | bbd603e | 2010-04-29 17:26:37 +0300 | [diff] [blame] | 11 | #include <linux/gfp.h> |
Sjur Brændeland | 3beee86 | 2013-03-20 13:51:24 +1030 | [diff] [blame] | 12 | #include <linux/vringh.h> |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 13 | |
| 14 | /** |
| 15 | * virtqueue - a queue to register buffers for sending or receiving. |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 16 | * @list: the chain of virtqueues for this device |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 17 | * @callback: the function to call when buffers are consumed (can be NULL). |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 18 | * @name: the name of this virtqueue (mainly for debugging) |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 19 | * @vdev: the virtio device this queue was created for. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 20 | * @priv: a pointer for the virtqueue implementation to use. |
Rusty Russell | 06ca287 | 2012-10-16 23:56:14 +1030 | [diff] [blame] | 21 | * @index: the zero-based ordinal number for this queue. |
| 22 | * @num_free: number of elements we expect to be able to fit. |
| 23 | * |
| 24 | * A note on @num_free: with indirect buffers, each buffer needs one |
| 25 | * element in the queue, otherwise a buffer will need one element per |
| 26 | * sg element. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 27 | */ |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 28 | struct virtqueue { |
| 29 | struct list_head list; |
Rusty Russell | 18445c4 | 2008-02-04 23:49:57 -0500 | [diff] [blame] | 30 | void (*callback)(struct virtqueue *vq); |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 31 | const char *name; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 32 | struct virtio_device *vdev; |
Rusty Russell | 06ca287 | 2012-10-16 23:56:14 +1030 | [diff] [blame] | 33 | unsigned int index; |
| 34 | unsigned int num_free; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 35 | void *priv; |
| 36 | }; |
| 37 | |
Rusty Russell | 282edb3 | 2013-03-20 15:44:26 +1030 | [diff] [blame] | 38 | int virtqueue_add_outbuf(struct virtqueue *vq, |
| 39 | struct scatterlist sg[], unsigned int num, |
| 40 | void *data, |
| 41 | gfp_t gfp); |
| 42 | |
| 43 | int virtqueue_add_inbuf(struct virtqueue *vq, |
| 44 | struct scatterlist sg[], unsigned int num, |
| 45 | void *data, |
| 46 | gfp_t gfp); |
| 47 | |
Michael S. Tsirkin | 5a08b04 | 2017-02-07 06:15:13 +0200 | [diff] [blame] | 48 | int virtqueue_add_inbuf_ctx(struct virtqueue *vq, |
| 49 | struct scatterlist sg[], unsigned int num, |
| 50 | void *data, |
| 51 | void *ctx, |
| 52 | gfp_t gfp); |
| 53 | |
Rusty Russell | 13816c7 | 2013-03-20 15:37:09 +1030 | [diff] [blame] | 54 | int virtqueue_add_sgs(struct virtqueue *vq, |
| 55 | struct scatterlist *sgs[], |
| 56 | unsigned int out_sgs, |
| 57 | unsigned int in_sgs, |
| 58 | void *data, |
| 59 | gfp_t gfp); |
| 60 | |
Heinz Graalfs | 5b1bf7c | 2013-10-29 09:39:48 +1030 | [diff] [blame] | 61 | bool virtqueue_kick(struct virtqueue *vq); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 62 | |
Rusty Russell | 41f0377 | 2012-01-12 15:44:43 +1030 | [diff] [blame] | 63 | bool virtqueue_kick_prepare(struct virtqueue *vq); |
| 64 | |
Heinz Graalfs | 5b1bf7c | 2013-10-29 09:39:48 +1030 | [diff] [blame] | 65 | bool virtqueue_notify(struct virtqueue *vq); |
Rusty Russell | 41f0377 | 2012-01-12 15:44:43 +1030 | [diff] [blame] | 66 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 67 | void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 68 | |
Michael S. Tsirkin | 5a08b04 | 2017-02-07 06:15:13 +0200 | [diff] [blame] | 69 | void *virtqueue_get_buf_ctx(struct virtqueue *vq, unsigned int *len, |
| 70 | void **ctx); |
| 71 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 72 | void virtqueue_disable_cb(struct virtqueue *vq); |
Michael S. Tsirkin | 316f25f | 2010-04-12 16:18:25 +0300 | [diff] [blame] | 73 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 74 | bool virtqueue_enable_cb(struct virtqueue *vq); |
Michael S. Tsirkin | 316f25f | 2010-04-12 16:18:25 +0300 | [diff] [blame] | 75 | |
Michael S. Tsirkin | cc22988 | 2013-07-09 13:19:18 +0300 | [diff] [blame] | 76 | unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq); |
| 77 | |
| 78 | bool virtqueue_poll(struct virtqueue *vq, unsigned); |
| 79 | |
Michael S. Tsirkin | 7ab358c | 2011-05-20 02:11:14 +0300 | [diff] [blame] | 80 | bool virtqueue_enable_cb_delayed(struct virtqueue *vq); |
| 81 | |
Michael S. Tsirkin | 7c5e9ed | 2010-04-12 16:19:07 +0300 | [diff] [blame] | 82 | void *virtqueue_detach_unused_buf(struct virtqueue *vq); |
Michael S. Tsirkin | 316f25f | 2010-04-12 16:18:25 +0300 | [diff] [blame] | 83 | |
Rick Jones | 8f9f466 | 2011-10-19 08:10:59 +0000 | [diff] [blame] | 84 | unsigned int virtqueue_get_vring_size(struct virtqueue *vq); |
| 85 | |
Heinz Graalfs | b3b32c9 | 2013-10-29 09:40:19 +1030 | [diff] [blame] | 86 | bool virtqueue_is_broken(struct virtqueue *vq); |
| 87 | |
Andy Lutomirski | 2a2d138 | 2016-02-02 21:46:37 -0800 | [diff] [blame] | 88 | const struct vring *virtqueue_get_vring(struct virtqueue *vq); |
| 89 | dma_addr_t virtqueue_get_desc_addr(struct virtqueue *vq); |
| 90 | dma_addr_t virtqueue_get_avail_addr(struct virtqueue *vq); |
| 91 | dma_addr_t virtqueue_get_used_addr(struct virtqueue *vq); |
| 92 | |
| 93 | /* |
| 94 | * Legacy accessors -- in almost all cases, these are the wrong functions |
| 95 | * to use. |
| 96 | */ |
| 97 | static inline void *virtqueue_get_desc(struct virtqueue *vq) |
| 98 | { |
| 99 | return virtqueue_get_vring(vq)->desc; |
| 100 | } |
| 101 | static inline void *virtqueue_get_avail(struct virtqueue *vq) |
| 102 | { |
| 103 | return virtqueue_get_vring(vq)->avail; |
| 104 | } |
| 105 | static inline void *virtqueue_get_used(struct virtqueue *vq) |
| 106 | { |
| 107 | return virtqueue_get_vring(vq)->used; |
| 108 | } |
Cornelia Huck | 8906265 | 2014-10-07 16:39:47 +0200 | [diff] [blame] | 109 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 110 | /** |
| 111 | * virtio_device - representation of a device using virtio |
| 112 | * @index: unique position on the virtio bus |
Paul Bolle | cbd7f8d | 2014-11-10 09:33:29 +1030 | [diff] [blame] | 113 | * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore) |
Michael S. Tsirkin | 22b7050 | 2014-10-15 10:21:55 +1030 | [diff] [blame] | 114 | * @config_enabled: configuration change reporting enabled |
| 115 | * @config_change_pending: configuration change reported while disabled |
| 116 | * @config_lock: protects configuration change reporting |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 117 | * @dev: underlying device. |
| 118 | * @id: the device type identification (used to match it with a driver). |
| 119 | * @config: the configuration ops for this device. |
Sjur Brændeland | 3beee86 | 2013-03-20 13:51:24 +1030 | [diff] [blame] | 120 | * @vringh_config: configuration ops for host vrings. |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 121 | * @vqs: the list of virtqueues for this device. |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 122 | * @features: the features supported by both driver and device. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 123 | * @priv: private pointer for the driver's use. |
| 124 | */ |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 125 | struct virtio_device { |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 126 | int index; |
Michael S. Tsirkin | c6716ba | 2014-10-14 10:40:35 +1030 | [diff] [blame] | 127 | bool failed; |
Michael S. Tsirkin | 22b7050 | 2014-10-15 10:21:55 +1030 | [diff] [blame] | 128 | bool config_enabled; |
| 129 | bool config_change_pending; |
| 130 | spinlock_t config_lock; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 131 | struct device dev; |
| 132 | struct virtio_device_id id; |
Stephen Hemminger | 9350393 | 2013-02-10 15:57:38 +1030 | [diff] [blame] | 133 | const struct virtio_config_ops *config; |
Sjur Brændeland | 3beee86 | 2013-03-20 13:51:24 +1030 | [diff] [blame] | 134 | const struct vringh_config_ops *vringh_config; |
Rusty Russell | 9499f5e | 2009-06-12 22:16:35 -0600 | [diff] [blame] | 135 | struct list_head vqs; |
Michael S. Tsirkin | d025477 | 2014-10-07 16:39:43 +0200 | [diff] [blame] | 136 | u64 features; |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 137 | void *priv; |
| 138 | }; |
| 139 | |
Wanlong Gao | 9bffdca | 2012-12-11 11:04:50 +1030 | [diff] [blame] | 140 | static inline struct virtio_device *dev_to_virtio(struct device *_dev) |
| 141 | { |
| 142 | return container_of(_dev, struct virtio_device, dev); |
| 143 | } |
| 144 | |
John Fastabend | 9fe7bfc | 2017-02-02 19:16:01 -0800 | [diff] [blame] | 145 | void virtio_add_status(struct virtio_device *dev, unsigned int status); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 146 | int register_virtio_device(struct virtio_device *dev); |
| 147 | void unregister_virtio_device(struct virtio_device *dev); |
| 148 | |
Rusty Russell | e2dcdfe | 2014-04-28 11:15:08 +0930 | [diff] [blame] | 149 | void virtio_break_device(struct virtio_device *dev); |
| 150 | |
Michael S. Tsirkin | 016c98c | 2014-10-14 10:40:34 +1030 | [diff] [blame] | 151 | void virtio_config_changed(struct virtio_device *dev); |
John Fastabend | 9fe7bfc | 2017-02-02 19:16:01 -0800 | [diff] [blame] | 152 | void virtio_config_disable(struct virtio_device *dev); |
| 153 | void virtio_config_enable(struct virtio_device *dev); |
Michael S. Tsirkin | c6716ba | 2014-10-14 10:40:35 +1030 | [diff] [blame] | 154 | #ifdef CONFIG_PM_SLEEP |
| 155 | int virtio_device_freeze(struct virtio_device *dev); |
| 156 | int virtio_device_restore(struct virtio_device *dev); |
| 157 | #endif |
Michael S. Tsirkin | 016c98c | 2014-10-14 10:40:34 +1030 | [diff] [blame] | 158 | |
Michael S. Tsirkin | 7ae93ff | 2018-04-20 20:22:40 +0300 | [diff] [blame] | 159 | #define virtio_device_for_each_vq(vdev, vq) \ |
| 160 | list_for_each_entry(vq, &vdev->vqs, list) |
| 161 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 162 | /** |
| 163 | * virtio_driver - operations for a virtio I/O driver |
| 164 | * @driver: underlying device driver (populate name and owner). |
| 165 | * @id_table: the ids serviced by this driver. |
Wang Sheng-Hui | 5f41f8b | 2011-08-25 21:04:05 +0800 | [diff] [blame] | 166 | * @feature_table: an array of feature numbers supported by this driver. |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 167 | * @feature_table_size: number of entries in the feature table array. |
Michael S. Tsirkin | b3bb62d | 2014-10-23 18:07:47 +0300 | [diff] [blame] | 168 | * @feature_table_legacy: same as feature_table but when working in legacy mode. |
| 169 | * @feature_table_size_legacy: number of entries in feature table legacy array. |
Rusty Russell | 20f77f5 | 2009-06-12 22:16:33 -0600 | [diff] [blame] | 170 | * @probe: the function to call when a device is found. Returns 0 or -errno. |
Cornelia Huck | 9ea762a | 2017-03-30 13:13:33 +0200 | [diff] [blame] | 171 | * @scan: optional function to call after successful probe; intended |
| 172 | * for virtio-scsi to invoke a scan. |
Wang Sheng-Hui | 5f41f8b | 2011-08-25 21:04:05 +0800 | [diff] [blame] | 173 | * @remove: the function to call when a device is removed. |
Rusty Russell | f957d1f | 2008-02-04 23:49:58 -0500 | [diff] [blame] | 174 | * @config_changed: optional function to call when the device configuration |
| 175 | * changes; may be called in interrupt context. |
Cornelia Huck | 9ea762a | 2017-03-30 13:13:33 +0200 | [diff] [blame] | 176 | * @freeze: optional function to call during suspend/hibernation. |
| 177 | * @restore: optional function to call on resume. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 178 | */ |
| 179 | struct virtio_driver { |
| 180 | struct device_driver driver; |
| 181 | const struct virtio_device_id *id_table; |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 182 | const unsigned int *feature_table; |
| 183 | unsigned int feature_table_size; |
Michael S. Tsirkin | b3bb62d | 2014-10-23 18:07:47 +0300 | [diff] [blame] | 184 | const unsigned int *feature_table_legacy; |
| 185 | unsigned int feature_table_size_legacy; |
Michael S. Tsirkin | 404123c | 2017-03-29 19:06:20 +0300 | [diff] [blame] | 186 | int (*validate)(struct virtio_device *dev); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 187 | int (*probe)(struct virtio_device *dev); |
Nicholas Bellinger | 59057fb | 2012-07-11 21:22:16 +0000 | [diff] [blame] | 188 | void (*scan)(struct virtio_device *dev); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 189 | void (*remove)(struct virtio_device *dev); |
Rusty Russell | f957d1f | 2008-02-04 23:49:58 -0500 | [diff] [blame] | 190 | void (*config_changed)(struct virtio_device *dev); |
Amit Shah | f0fe6f1 | 2011-12-22 16:58:26 +0530 | [diff] [blame] | 191 | #ifdef CONFIG_PM |
| 192 | int (*freeze)(struct virtio_device *dev); |
Amit Shah | f0fe6f1 | 2011-12-22 16:58:26 +0530 | [diff] [blame] | 193 | int (*restore)(struct virtio_device *dev); |
| 194 | #endif |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 195 | }; |
| 196 | |
Wanlong Gao | 9a2bdcc | 2012-12-10 16:38:33 +0800 | [diff] [blame] | 197 | static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv) |
| 198 | { |
| 199 | return container_of(drv, struct virtio_driver, driver); |
| 200 | } |
| 201 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 202 | int register_virtio_driver(struct virtio_driver *drv); |
| 203 | void unregister_virtio_driver(struct virtio_driver *drv); |
Sjur Brændeland | 6e105e0 | 2013-02-13 15:52:36 +1030 | [diff] [blame] | 204 | |
| 205 | /* module_virtio_driver() - Helper macro for drivers that don't do |
| 206 | * anything special in module init/exit. This eliminates a lot of |
| 207 | * boilerplate. Each module may only use this macro once, and |
| 208 | * calling it replaces module_init() and module_exit() |
| 209 | */ |
| 210 | #define module_virtio_driver(__virtio_driver) \ |
| 211 | module_driver(__virtio_driver, register_virtio_driver, \ |
| 212 | unregister_virtio_driver) |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 213 | #endif /* _LINUX_VIRTIO_H */ |