]>
Commit | Line | Data |
---|---|---|
ec3d41c4 RR |
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> | |
bbd603ef | 10 | #include <linux/gfp.h> |
3beee86a | 11 | #include <linux/vringh.h> |
ec3d41c4 RR |
12 | |
13 | /** | |
14 | * 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. | |
22 | * | |
23 | * A note on @num_free: with indirect buffers, each buffer needs one | |
24 | * element in the queue, otherwise a buffer will need one element per | |
25 | * sg element. | |
ec3d41c4 | 26 | */ |
9499f5e7 RR |
27 | struct virtqueue { |
28 | struct list_head list; | |
18445c4d | 29 | void (*callback)(struct virtqueue *vq); |
9499f5e7 | 30 | const char *name; |
ec3d41c4 | 31 | struct virtio_device *vdev; |
06ca287d RR |
32 | unsigned int index; |
33 | unsigned int num_free; | |
ec3d41c4 RR |
34 | void *priv; |
35 | }; | |
36 | ||
f96fde41 RR |
37 | int virtqueue_add_buf(struct virtqueue *vq, |
38 | struct scatterlist sg[], | |
39 | unsigned int out_num, | |
40 | unsigned int in_num, | |
41 | void *data, | |
42 | gfp_t gfp); | |
ec3d41c4 | 43 | |
282edb36 RR |
44 | int virtqueue_add_outbuf(struct virtqueue *vq, |
45 | struct scatterlist sg[], unsigned int num, | |
46 | void *data, | |
47 | gfp_t gfp); | |
48 | ||
49 | int virtqueue_add_inbuf(struct virtqueue *vq, | |
50 | struct scatterlist sg[], unsigned int num, | |
51 | void *data, | |
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 | ||
7c5e9ed0 | 61 | void virtqueue_kick(struct virtqueue *vq); |
ec3d41c4 | 62 | |
41f0377f RR |
63 | bool virtqueue_kick_prepare(struct virtqueue *vq); |
64 | ||
65 | void virtqueue_notify(struct virtqueue *vq); | |
66 | ||
7c5e9ed0 | 67 | void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len); |
316f25f5 | 68 | |
7c5e9ed0 | 69 | void virtqueue_disable_cb(struct virtqueue *vq); |
316f25f5 | 70 | |
7c5e9ed0 | 71 | bool virtqueue_enable_cb(struct virtqueue *vq); |
316f25f5 | 72 | |
7ab358c2 MT |
73 | bool virtqueue_enable_cb_delayed(struct virtqueue *vq); |
74 | ||
7c5e9ed0 | 75 | void *virtqueue_detach_unused_buf(struct virtqueue *vq); |
316f25f5 | 76 | |
8f9f4668 | 77 | unsigned int virtqueue_get_vring_size(struct virtqueue *vq); |
17bb6d40 | 78 | |
ec3d41c4 RR |
79 | /** |
80 | * virtio_device - representation of a device using virtio | |
81 | * @index: unique position on the virtio bus | |
82 | * @dev: underlying device. | |
83 | * @id: the device type identification (used to match it with a driver). | |
84 | * @config: the configuration ops for this device. | |
3beee86a | 85 | * @vringh_config: configuration ops for host vrings. |
9499f5e7 | 86 | * @vqs: the list of virtqueues for this device. |
c45a6816 | 87 | * @features: the features supported by both driver and device. |
ec3d41c4 RR |
88 | * @priv: private pointer for the driver's use. |
89 | */ | |
9499f5e7 | 90 | struct virtio_device { |
ec3d41c4 RR |
91 | int index; |
92 | struct device dev; | |
93 | struct virtio_device_id id; | |
93503932 | 94 | const struct virtio_config_ops *config; |
3beee86a | 95 | const struct vringh_config_ops *vringh_config; |
9499f5e7 | 96 | struct list_head vqs; |
c45a6816 RR |
97 | /* Note that this is a Linux set_bit-style bitmap. */ |
98 | unsigned long features[1]; | |
ec3d41c4 RR |
99 | void *priv; |
100 | }; | |
101 | ||
9bffdca8 WG |
102 | static inline struct virtio_device *dev_to_virtio(struct device *_dev) |
103 | { | |
104 | return container_of(_dev, struct virtio_device, dev); | |
105 | } | |
106 | ||
ec3d41c4 RR |
107 | int register_virtio_device(struct virtio_device *dev); |
108 | void unregister_virtio_device(struct virtio_device *dev); | |
109 | ||
110 | /** | |
111 | * virtio_driver - operations for a virtio I/O driver | |
112 | * @driver: underlying device driver (populate name and owner). | |
113 | * @id_table: the ids serviced by this driver. | |
5f41f8bf | 114 | * @feature_table: an array of feature numbers supported by this driver. |
c45a6816 | 115 | * @feature_table_size: number of entries in the feature table array. |
20f77f56 | 116 | * @probe: the function to call when a device is found. Returns 0 or -errno. |
5f41f8bf | 117 | * @remove: the function to call when a device is removed. |
f957d1f0 RR |
118 | * @config_changed: optional function to call when the device configuration |
119 | * changes; may be called in interrupt context. | |
ec3d41c4 RR |
120 | */ |
121 | struct virtio_driver { | |
122 | struct device_driver driver; | |
123 | const struct virtio_device_id *id_table; | |
c45a6816 RR |
124 | const unsigned int *feature_table; |
125 | unsigned int feature_table_size; | |
ec3d41c4 | 126 | int (*probe)(struct virtio_device *dev); |
59057fbc | 127 | void (*scan)(struct virtio_device *dev); |
ec3d41c4 | 128 | void (*remove)(struct virtio_device *dev); |
f957d1f0 | 129 | void (*config_changed)(struct virtio_device *dev); |
f0fe6f11 AS |
130 | #ifdef CONFIG_PM |
131 | int (*freeze)(struct virtio_device *dev); | |
f0fe6f11 AS |
132 | int (*restore)(struct virtio_device *dev); |
133 | #endif | |
ec3d41c4 RR |
134 | }; |
135 | ||
9a2bdcc8 WG |
136 | static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv) |
137 | { | |
138 | return container_of(drv, struct virtio_driver, driver); | |
139 | } | |
140 | ||
ec3d41c4 RR |
141 | int register_virtio_driver(struct virtio_driver *drv); |
142 | void unregister_virtio_driver(struct virtio_driver *drv); | |
6e105e05 SB |
143 | |
144 | /* module_virtio_driver() - Helper macro for drivers that don't do | |
145 | * anything special in module init/exit. This eliminates a lot of | |
146 | * boilerplate. Each module may only use this macro once, and | |
147 | * calling it replaces module_init() and module_exit() | |
148 | */ | |
149 | #define module_virtio_driver(__virtio_driver) \ | |
150 | module_driver(__virtio_driver, register_virtio_driver, \ | |
151 | unregister_virtio_driver) | |
ec3d41c4 | 152 | #endif /* _LINUX_VIRTIO_H */ |