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