]>
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> |
3beee86a | 12 | #include <linux/vringh.h> |
ec3d41c4 RR |
13 | |
14 | /** | |
15 | * 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. | |
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. | |
ec3d41c4 | 27 | */ |
9499f5e7 RR |
28 | struct virtqueue { |
29 | struct list_head list; | |
18445c4d | 30 | void (*callback)(struct virtqueue *vq); |
9499f5e7 | 31 | const char *name; |
ec3d41c4 | 32 | struct virtio_device *vdev; |
06ca287d RR |
33 | unsigned int index; |
34 | unsigned int num_free; | |
ec3d41c4 RR |
35 | void *priv; |
36 | }; | |
37 | ||
282edb36 RR |
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 | ||
5a08b04f MT |
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 | ||
13816c76 RR |
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 | ||
5b1bf7cb | 61 | bool virtqueue_kick(struct virtqueue *vq); |
ec3d41c4 | 62 | |
41f0377f RR |
63 | bool virtqueue_kick_prepare(struct virtqueue *vq); |
64 | ||
5b1bf7cb | 65 | bool virtqueue_notify(struct virtqueue *vq); |
41f0377f | 66 | |
7c5e9ed0 | 67 | void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len); |
316f25f5 | 68 | |
5a08b04f MT |
69 | void *virtqueue_get_buf_ctx(struct virtqueue *vq, unsigned int *len, |
70 | void **ctx); | |
71 | ||
7c5e9ed0 | 72 | void virtqueue_disable_cb(struct virtqueue *vq); |
316f25f5 | 73 | |
7c5e9ed0 | 74 | bool virtqueue_enable_cb(struct virtqueue *vq); |
316f25f5 | 75 | |
cc229884 MT |
76 | unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq); |
77 | ||
78 | bool virtqueue_poll(struct virtqueue *vq, unsigned); | |
79 | ||
7ab358c2 MT |
80 | bool virtqueue_enable_cb_delayed(struct virtqueue *vq); |
81 | ||
7c5e9ed0 | 82 | void *virtqueue_detach_unused_buf(struct virtqueue *vq); |
316f25f5 | 83 | |
8f9f4668 | 84 | unsigned int virtqueue_get_vring_size(struct virtqueue *vq); |
17bb6d40 | 85 | |
b3b32c94 HG |
86 | bool virtqueue_is_broken(struct virtqueue *vq); |
87 | ||
2a2d1382 AL |
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 | } | |
89062652 | 109 | |
ec3d41c4 RR |
110 | /** |
111 | * virtio_device - representation of a device using virtio | |
112 | * @index: unique position on the virtio bus | |
cbd7f8d6 | 113 | * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore) |
22b7050a MT |
114 | * @config_enabled: configuration change reporting enabled |
115 | * @config_change_pending: configuration change reported while disabled | |
116 | * @config_lock: protects configuration change reporting | |
ec3d41c4 RR |
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. | |
3beee86a | 120 | * @vringh_config: configuration ops for host vrings. |
9499f5e7 | 121 | * @vqs: the list of virtqueues for this device. |
c45a6816 | 122 | * @features: the features supported by both driver and device. |
ec3d41c4 RR |
123 | * @priv: private pointer for the driver's use. |
124 | */ | |
9499f5e7 | 125 | struct virtio_device { |
ec3d41c4 | 126 | int index; |
c6716bae | 127 | bool failed; |
22b7050a MT |
128 | bool config_enabled; |
129 | bool config_change_pending; | |
130 | spinlock_t config_lock; | |
ec3d41c4 RR |
131 | struct device dev; |
132 | struct virtio_device_id id; | |
93503932 | 133 | const struct virtio_config_ops *config; |
3beee86a | 134 | const struct vringh_config_ops *vringh_config; |
9499f5e7 | 135 | struct list_head vqs; |
d0254773 | 136 | u64 features; |
ec3d41c4 RR |
137 | void *priv; |
138 | }; | |
139 | ||
9bffdca8 WG |
140 | static inline struct virtio_device *dev_to_virtio(struct device *_dev) |
141 | { | |
142 | return container_of(_dev, struct virtio_device, dev); | |
143 | } | |
144 | ||
9fe7bfce | 145 | void virtio_add_status(struct virtio_device *dev, unsigned int status); |
ec3d41c4 RR |
146 | int register_virtio_device(struct virtio_device *dev); |
147 | void unregister_virtio_device(struct virtio_device *dev); | |
148 | ||
e2dcdfe9 RR |
149 | void virtio_break_device(struct virtio_device *dev); |
150 | ||
016c98c6 | 151 | void virtio_config_changed(struct virtio_device *dev); |
9fe7bfce JF |
152 | void virtio_config_disable(struct virtio_device *dev); |
153 | void virtio_config_enable(struct virtio_device *dev); | |
154 | int virtio_finalize_features(struct virtio_device *dev); | |
c6716bae MT |
155 | #ifdef CONFIG_PM_SLEEP |
156 | int virtio_device_freeze(struct virtio_device *dev); | |
157 | int virtio_device_restore(struct virtio_device *dev); | |
158 | #endif | |
016c98c6 | 159 | |
ec3d41c4 RR |
160 | /** |
161 | * virtio_driver - operations for a virtio I/O driver | |
162 | * @driver: underlying device driver (populate name and owner). | |
163 | * @id_table: the ids serviced by this driver. | |
5f41f8bf | 164 | * @feature_table: an array of feature numbers supported by this driver. |
c45a6816 | 165 | * @feature_table_size: number of entries in the feature table array. |
b3bb62d1 MT |
166 | * @feature_table_legacy: same as feature_table but when working in legacy mode. |
167 | * @feature_table_size_legacy: number of entries in feature table legacy array. | |
20f77f56 | 168 | * @probe: the function to call when a device is found. Returns 0 or -errno. |
9ea762a5 CH |
169 | * @scan: optional function to call after successful probe; intended |
170 | * for virtio-scsi to invoke a scan. | |
5f41f8bf | 171 | * @remove: the function to call when a device is removed. |
f957d1f0 RR |
172 | * @config_changed: optional function to call when the device configuration |
173 | * changes; may be called in interrupt context. | |
9ea762a5 CH |
174 | * @freeze: optional function to call during suspend/hibernation. |
175 | * @restore: optional function to call on resume. | |
ec3d41c4 RR |
176 | */ |
177 | struct virtio_driver { | |
178 | struct device_driver driver; | |
179 | const struct virtio_device_id *id_table; | |
c45a6816 RR |
180 | const unsigned int *feature_table; |
181 | unsigned int feature_table_size; | |
b3bb62d1 MT |
182 | const unsigned int *feature_table_legacy; |
183 | unsigned int feature_table_size_legacy; | |
404123c2 | 184 | int (*validate)(struct virtio_device *dev); |
ec3d41c4 | 185 | int (*probe)(struct virtio_device *dev); |
59057fbc | 186 | void (*scan)(struct virtio_device *dev); |
ec3d41c4 | 187 | void (*remove)(struct virtio_device *dev); |
f957d1f0 | 188 | void (*config_changed)(struct virtio_device *dev); |
f0fe6f11 AS |
189 | #ifdef CONFIG_PM |
190 | int (*freeze)(struct virtio_device *dev); | |
f0fe6f11 AS |
191 | int (*restore)(struct virtio_device *dev); |
192 | #endif | |
ec3d41c4 RR |
193 | }; |
194 | ||
9a2bdcc8 WG |
195 | static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv) |
196 | { | |
197 | return container_of(drv, struct virtio_driver, driver); | |
198 | } | |
199 | ||
ec3d41c4 RR |
200 | int register_virtio_driver(struct virtio_driver *drv); |
201 | void unregister_virtio_driver(struct virtio_driver *drv); | |
6e105e05 SB |
202 | |
203 | /* module_virtio_driver() - Helper macro for drivers that don't do | |
204 | * anything special in module init/exit. This eliminates a lot of | |
205 | * boilerplate. Each module may only use this macro once, and | |
206 | * calling it replaces module_init() and module_exit() | |
207 | */ | |
208 | #define module_virtio_driver(__virtio_driver) \ | |
209 | module_driver(__virtio_driver, register_virtio_driver, \ | |
210 | unregister_virtio_driver) | |
ec3d41c4 | 211 | #endif /* _LINUX_VIRTIO_H */ |