Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
ec3d41c4 RR |
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> | |
bbd603ef | 11 | #include <linux/gfp.h> |
b6253b4e | 12 | #include <linux/dma-mapping.h> |
ec3d41c4 RR |
13 | |
14 | /** | |
5c669c4a | 15 | * struct virtqueue - a queue to register buffers for sending or receiving. |
9499f5e7 | 16 | * @list: the chain of virtqueues for this device |
ec3d41c4 | 17 | * @callback: the function to call when buffers are consumed (can be NULL). |
9499f5e7 | 18 | * @name: the name of this virtqueue (mainly for debugging) |
ec3d41c4 | 19 | * @vdev: the virtio device this queue was created for. |
ec3d41c4 | 20 | * @priv: a pointer for the virtqueue implementation to use. |
06ca287d RR |
21 | * @index: the zero-based ordinal number for this queue. |
22 | * @num_free: number of elements we expect to be able to fit. | |
da802961 | 23 | * @num_max: the maximum number of elements supported by the device. |
4913e854 | 24 | * @reset: vq is in reset state or not. |
06ca287d RR |
25 | * |
26 | * A note on @num_free: with indirect buffers, each buffer needs one | |
27 | * element in the queue, otherwise a buffer will need one element per | |
28 | * sg element. | |
ec3d41c4 | 29 | */ |
9499f5e7 RR |
30 | struct virtqueue { |
31 | struct list_head list; | |
18445c4d | 32 | void (*callback)(struct virtqueue *vq); |
9499f5e7 | 33 | const char *name; |
ec3d41c4 | 34 | struct virtio_device *vdev; |
06ca287d RR |
35 | unsigned int index; |
36 | unsigned int num_free; | |
da802961 | 37 | unsigned int num_max; |
4913e854 | 38 | bool reset; |
48cd6bc5 | 39 | void *priv; |
ec3d41c4 RR |
40 | }; |
41 | ||
282edb36 RR |
42 | int virtqueue_add_outbuf(struct virtqueue *vq, |
43 | struct scatterlist sg[], unsigned int num, | |
44 | void *data, | |
45 | gfp_t gfp); | |
46 | ||
47 | int virtqueue_add_inbuf(struct virtqueue *vq, | |
48 | struct scatterlist sg[], unsigned int num, | |
49 | void *data, | |
50 | gfp_t gfp); | |
51 | ||
5a08b04f MT |
52 | int virtqueue_add_inbuf_ctx(struct virtqueue *vq, |
53 | struct scatterlist sg[], unsigned int num, | |
54 | void *data, | |
55 | void *ctx, | |
56 | gfp_t gfp); | |
57 | ||
13816c76 RR |
58 | int virtqueue_add_sgs(struct virtqueue *vq, |
59 | struct scatterlist *sgs[], | |
60 | unsigned int out_sgs, | |
61 | unsigned int in_sgs, | |
62 | void *data, | |
63 | gfp_t gfp); | |
64 | ||
2df64759 XZ |
65 | struct device *virtqueue_dma_dev(struct virtqueue *vq); |
66 | ||
5b1bf7cb | 67 | bool virtqueue_kick(struct virtqueue *vq); |
ec3d41c4 | 68 | |
41f0377f RR |
69 | bool virtqueue_kick_prepare(struct virtqueue *vq); |
70 | ||
5b1bf7cb | 71 | bool virtqueue_notify(struct virtqueue *vq); |
41f0377f | 72 | |
7c5e9ed0 | 73 | void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len); |
316f25f5 | 74 | |
5a08b04f MT |
75 | void *virtqueue_get_buf_ctx(struct virtqueue *vq, unsigned int *len, |
76 | void **ctx); | |
77 | ||
7c5e9ed0 | 78 | void virtqueue_disable_cb(struct virtqueue *vq); |
316f25f5 | 79 | |
7c5e9ed0 | 80 | bool virtqueue_enable_cb(struct virtqueue *vq); |
316f25f5 | 81 | |
cc229884 MT |
82 | unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq); |
83 | ||
8daafe9e XZ |
84 | int virtqueue_set_dma_premapped(struct virtqueue *_vq); |
85 | ||
cc229884 MT |
86 | bool virtqueue_poll(struct virtqueue *vq, unsigned); |
87 | ||
7ab358c2 MT |
88 | bool virtqueue_enable_cb_delayed(struct virtqueue *vq); |
89 | ||
7c5e9ed0 | 90 | void *virtqueue_detach_unused_buf(struct virtqueue *vq); |
316f25f5 | 91 | |
4b6ec919 | 92 | unsigned int virtqueue_get_vring_size(const struct virtqueue *vq); |
17bb6d40 | 93 | |
4b6ec919 | 94 | bool virtqueue_is_broken(const struct virtqueue *vq); |
b3b32c94 | 95 | |
4b6ec919 FL |
96 | const struct vring *virtqueue_get_vring(const struct virtqueue *vq); |
97 | dma_addr_t virtqueue_get_desc_addr(const struct virtqueue *vq); | |
98 | dma_addr_t virtqueue_get_avail_addr(const struct virtqueue *vq); | |
99 | dma_addr_t virtqueue_get_used_addr(const struct virtqueue *vq); | |
2a2d1382 | 100 | |
c790e8e1 XZ |
101 | int virtqueue_resize(struct virtqueue *vq, u32 num, |
102 | void (*recycle)(struct virtqueue *vq, void *buf)); | |
ba3e0c47 XZ |
103 | int virtqueue_reset(struct virtqueue *vq, |
104 | void (*recycle)(struct virtqueue *vq, void *buf)); | |
c790e8e1 | 105 | |
ec3d41c4 | 106 | /** |
5c669c4a | 107 | * struct virtio_device - representation of a device using virtio |
ec3d41c4 | 108 | * @index: unique position on the virtio bus |
cbd7f8d6 | 109 | * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore) |
22b7050a MT |
110 | * @config_enabled: configuration change reporting enabled |
111 | * @config_change_pending: configuration change reported while disabled | |
112 | * @config_lock: protects configuration change reporting | |
33bd91fd | 113 | * @vqs_list_lock: protects @vqs. |
ec3d41c4 RR |
114 | * @dev: underlying device. |
115 | * @id: the device type identification (used to match it with a driver). | |
116 | * @config: the configuration ops for this device. | |
3beee86a | 117 | * @vringh_config: configuration ops for host vrings. |
9499f5e7 | 118 | * @vqs: the list of virtqueues for this device. |
c45a6816 | 119 | * @features: the features supported by both driver and device. |
ec3d41c4 RR |
120 | * @priv: private pointer for the driver's use. |
121 | */ | |
9499f5e7 | 122 | struct virtio_device { |
ec3d41c4 | 123 | int index; |
c6716bae | 124 | bool failed; |
22b7050a MT |
125 | bool config_enabled; |
126 | bool config_change_pending; | |
127 | spinlock_t config_lock; | |
33bd91fd | 128 | spinlock_t vqs_list_lock; |
ec3d41c4 RR |
129 | struct device dev; |
130 | struct virtio_device_id id; | |
93503932 | 131 | const struct virtio_config_ops *config; |
3beee86a | 132 | const struct vringh_config_ops *vringh_config; |
9499f5e7 | 133 | struct list_head vqs; |
d0254773 | 134 | u64 features; |
ec3d41c4 RR |
135 | void *priv; |
136 | }; | |
137 | ||
af3011b6 | 138 | #define dev_to_virtio(_dev) container_of_const(_dev, struct virtio_device, dev) |
9bffdca8 | 139 | |
9fe7bfce | 140 | void virtio_add_status(struct virtio_device *dev, unsigned int status); |
ec3d41c4 RR |
141 | int register_virtio_device(struct virtio_device *dev); |
142 | void unregister_virtio_device(struct virtio_device *dev); | |
a0308938 | 143 | bool is_virtio_device(struct device *dev); |
ec3d41c4 | 144 | |
e2dcdfe9 | 145 | void virtio_break_device(struct virtio_device *dev); |
be83f04d | 146 | void __virtio_unbreak_device(struct virtio_device *dev); |
e2dcdfe9 | 147 | |
32510631 XZ |
148 | void __virtqueue_break(struct virtqueue *_vq); |
149 | void __virtqueue_unbreak(struct virtqueue *_vq); | |
150 | ||
016c98c6 | 151 | void virtio_config_changed(struct virtio_device *dev); |
c6716bae MT |
152 | #ifdef CONFIG_PM_SLEEP |
153 | int virtio_device_freeze(struct virtio_device *dev); | |
154 | int virtio_device_restore(struct virtio_device *dev); | |
155 | #endif | |
d9679d00 | 156 | void virtio_reset_device(struct virtio_device *dev); |
016c98c6 | 157 | |
4b6ec919 | 158 | size_t virtio_max_dma_size(const struct virtio_device *vdev); |
e6d6dd6c | 159 | |
24a7e4d2 MT |
160 | #define virtio_device_for_each_vq(vdev, vq) \ |
161 | list_for_each_entry(vq, &vdev->vqs, list) | |
162 | ||
ec3d41c4 | 163 | /** |
5c669c4a | 164 | * struct virtio_driver - operations for a virtio I/O driver |
ec3d41c4 RR |
165 | * @driver: underlying device driver (populate name and owner). |
166 | * @id_table: the ids serviced by this driver. | |
5f41f8bf | 167 | * @feature_table: an array of feature numbers supported by this driver. |
c45a6816 | 168 | * @feature_table_size: number of entries in the feature table array. |
b3bb62d1 MT |
169 | * @feature_table_legacy: same as feature_table but when working in legacy mode. |
170 | * @feature_table_size_legacy: number of entries in feature table legacy array. | |
33bd91fd SH |
171 | * @validate: the function to call to validate features and config space. |
172 | * Returns 0 or -errno. | |
20f77f56 | 173 | * @probe: the function to call when a device is found. Returns 0 or -errno. |
9ea762a5 CH |
174 | * @scan: optional function to call after successful probe; intended |
175 | * for virtio-scsi to invoke a scan. | |
5f41f8bf | 176 | * @remove: the function to call when a device is removed. |
f957d1f0 RR |
177 | * @config_changed: optional function to call when the device configuration |
178 | * changes; may be called in interrupt context. | |
9ea762a5 CH |
179 | * @freeze: optional function to call during suspend/hibernation. |
180 | * @restore: optional function to call on resume. | |
ec3d41c4 RR |
181 | */ |
182 | struct virtio_driver { | |
183 | struct device_driver driver; | |
184 | const struct virtio_device_id *id_table; | |
c45a6816 RR |
185 | const unsigned int *feature_table; |
186 | unsigned int feature_table_size; | |
b3bb62d1 MT |
187 | const unsigned int *feature_table_legacy; |
188 | unsigned int feature_table_size_legacy; | |
404123c2 | 189 | int (*validate)(struct virtio_device *dev); |
ec3d41c4 | 190 | int (*probe)(struct virtio_device *dev); |
59057fbc | 191 | void (*scan)(struct virtio_device *dev); |
ec3d41c4 | 192 | void (*remove)(struct virtio_device *dev); |
f957d1f0 | 193 | void (*config_changed)(struct virtio_device *dev); |
f0fe6f11 | 194 | int (*freeze)(struct virtio_device *dev); |
f0fe6f11 | 195 | int (*restore)(struct virtio_device *dev); |
ec3d41c4 RR |
196 | }; |
197 | ||
9a2bdcc8 WG |
198 | static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv) |
199 | { | |
200 | return container_of(drv, struct virtio_driver, driver); | |
201 | } | |
202 | ||
ec3d41c4 RR |
203 | int register_virtio_driver(struct virtio_driver *drv); |
204 | void unregister_virtio_driver(struct virtio_driver *drv); | |
6e105e05 SB |
205 | |
206 | /* module_virtio_driver() - Helper macro for drivers that don't do | |
207 | * anything special in module init/exit. This eliminates a lot of | |
208 | * boilerplate. Each module may only use this macro once, and | |
209 | * calling it replaces module_init() and module_exit() | |
210 | */ | |
211 | #define module_virtio_driver(__virtio_driver) \ | |
212 | module_driver(__virtio_driver, register_virtio_driver, \ | |
213 | unregister_virtio_driver) | |
b6253b4e XZ |
214 | |
215 | dma_addr_t virtqueue_dma_map_single_attrs(struct virtqueue *_vq, void *ptr, size_t size, | |
216 | enum dma_data_direction dir, unsigned long attrs); | |
217 | void virtqueue_dma_unmap_single_attrs(struct virtqueue *_vq, dma_addr_t addr, | |
218 | size_t size, enum dma_data_direction dir, | |
219 | unsigned long attrs); | |
220 | int virtqueue_dma_mapping_error(struct virtqueue *_vq, dma_addr_t addr); | |
8bd2f710 XZ |
221 | |
222 | bool virtqueue_dma_need_sync(struct virtqueue *_vq, dma_addr_t addr); | |
223 | void virtqueue_dma_sync_single_range_for_cpu(struct virtqueue *_vq, dma_addr_t addr, | |
224 | unsigned long offset, size_t size, | |
225 | enum dma_data_direction dir); | |
226 | void virtqueue_dma_sync_single_range_for_device(struct virtqueue *_vq, dma_addr_t addr, | |
227 | unsigned long offset, size_t size, | |
228 | enum dma_data_direction dir); | |
ec3d41c4 | 229 | #endif /* _LINUX_VIRTIO_H */ |