blob: 28f0e65b9a1172b8a08e0ca9bdf85412eecb5dd2 [file] [log] [blame]
Rusty Russellec3d41c2007-10-22 11:03:36 +10001#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>
Michael S. Tsirkinbbd603e2010-04-29 17:26:37 +030010#include <linux/gfp.h>
Sjur Brændeland3beee862013-03-20 13:51:24 +103011#include <linux/vringh.h>
Rusty Russellec3d41c2007-10-22 11:03:36 +100012
13/**
14 * virtqueue - a queue to register buffers for sending or receiving.
Rusty Russell9499f5e2009-06-12 22:16:35 -060015 * @list: the chain of virtqueues for this device
Rusty Russellec3d41c2007-10-22 11:03:36 +100016 * @callback: the function to call when buffers are consumed (can be NULL).
Rusty Russell9499f5e2009-06-12 22:16:35 -060017 * @name: the name of this virtqueue (mainly for debugging)
Rusty Russellec3d41c2007-10-22 11:03:36 +100018 * @vdev: the virtio device this queue was created for.
Rusty Russellec3d41c2007-10-22 11:03:36 +100019 * @priv: a pointer for the virtqueue implementation to use.
Rusty Russell06ca2872012-10-16 23:56:14 +103020 * @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.
Rusty Russellec3d41c2007-10-22 11:03:36 +100026 */
Rusty Russell9499f5e2009-06-12 22:16:35 -060027struct virtqueue {
28 struct list_head list;
Rusty Russell18445c42008-02-04 23:49:57 -050029 void (*callback)(struct virtqueue *vq);
Rusty Russell9499f5e2009-06-12 22:16:35 -060030 const char *name;
Rusty Russellec3d41c2007-10-22 11:03:36 +100031 struct virtio_device *vdev;
Rusty Russell06ca2872012-10-16 23:56:14 +103032 unsigned int index;
33 unsigned int num_free;
Rusty Russellec3d41c2007-10-22 11:03:36 +100034 void *priv;
35};
36
Rusty Russell282edb32013-03-20 15:44:26 +103037int virtqueue_add_outbuf(struct virtqueue *vq,
38 struct scatterlist sg[], unsigned int num,
39 void *data,
40 gfp_t gfp);
41
42int virtqueue_add_inbuf(struct virtqueue *vq,
43 struct scatterlist sg[], unsigned int num,
44 void *data,
45 gfp_t gfp);
46
Rusty Russell13816c72013-03-20 15:37:09 +103047int virtqueue_add_sgs(struct virtqueue *vq,
48 struct scatterlist *sgs[],
49 unsigned int out_sgs,
50 unsigned int in_sgs,
51 void *data,
52 gfp_t gfp);
53
Heinz Graalfs5b1bf7c2013-10-29 09:39:48 +103054bool virtqueue_kick(struct virtqueue *vq);
Rusty Russellec3d41c2007-10-22 11:03:36 +100055
Rusty Russell41f03772012-01-12 15:44:43 +103056bool virtqueue_kick_prepare(struct virtqueue *vq);
57
Heinz Graalfs5b1bf7c2013-10-29 09:39:48 +103058bool virtqueue_notify(struct virtqueue *vq);
Rusty Russell41f03772012-01-12 15:44:43 +103059
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030060void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
Rusty Russellec3d41c2007-10-22 11:03:36 +100061
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030062void virtqueue_disable_cb(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030063
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030064bool virtqueue_enable_cb(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030065
Michael S. Tsirkincc229882013-07-09 13:19:18 +030066unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq);
67
68bool virtqueue_poll(struct virtqueue *vq, unsigned);
69
Michael S. Tsirkin7ab358c2011-05-20 02:11:14 +030070bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
71
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030072void *virtqueue_detach_unused_buf(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030073
Rick Jones8f9f4662011-10-19 08:10:59 +000074unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
75
Heinz Graalfsb3b32c92013-10-29 09:40:19 +103076bool virtqueue_is_broken(struct virtqueue *vq);
77
Cornelia Huck89062652014-10-07 16:39:47 +020078void *virtqueue_get_avail(struct virtqueue *vq);
79void *virtqueue_get_used(struct virtqueue *vq);
80
Rusty Russellec3d41c2007-10-22 11:03:36 +100081/**
82 * virtio_device - representation of a device using virtio
83 * @index: unique position on the virtio bus
Paul Bollecbd7f8d2014-11-10 09:33:29 +103084 * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore)
Michael S. Tsirkin22b70502014-10-15 10:21:55 +103085 * @config_enabled: configuration change reporting enabled
86 * @config_change_pending: configuration change reported while disabled
87 * @config_lock: protects configuration change reporting
Rusty Russellec3d41c2007-10-22 11:03:36 +100088 * @dev: underlying device.
89 * @id: the device type identification (used to match it with a driver).
90 * @config: the configuration ops for this device.
Sjur Brændeland3beee862013-03-20 13:51:24 +103091 * @vringh_config: configuration ops for host vrings.
Rusty Russell9499f5e2009-06-12 22:16:35 -060092 * @vqs: the list of virtqueues for this device.
Rusty Russellc45a6812008-05-02 21:50:50 -050093 * @features: the features supported by both driver and device.
Rusty Russellec3d41c2007-10-22 11:03:36 +100094 * @priv: private pointer for the driver's use.
95 */
Rusty Russell9499f5e2009-06-12 22:16:35 -060096struct virtio_device {
Rusty Russellec3d41c2007-10-22 11:03:36 +100097 int index;
Michael S. Tsirkinc6716ba2014-10-14 10:40:35 +103098 bool failed;
Michael S. Tsirkin22b70502014-10-15 10:21:55 +103099 bool config_enabled;
100 bool config_change_pending;
101 spinlock_t config_lock;
Rusty Russellec3d41c2007-10-22 11:03:36 +1000102 struct device dev;
103 struct virtio_device_id id;
Stephen Hemminger93503932013-02-10 15:57:38 +1030104 const struct virtio_config_ops *config;
Sjur Brændeland3beee862013-03-20 13:51:24 +1030105 const struct vringh_config_ops *vringh_config;
Rusty Russell9499f5e2009-06-12 22:16:35 -0600106 struct list_head vqs;
Michael S. Tsirkind0254772014-10-07 16:39:43 +0200107 u64 features;
Rusty Russellec3d41c2007-10-22 11:03:36 +1000108 void *priv;
109};
110
Michael S. Tsirkinb6098c32014-12-04 18:49:58 +0200111bool virtio_device_is_legacy_only(struct virtio_device_id id);
112
Wanlong Gao9bffdca2012-12-11 11:04:50 +1030113static inline struct virtio_device *dev_to_virtio(struct device *_dev)
114{
115 return container_of(_dev, struct virtio_device, dev);
116}
117
Rusty Russellec3d41c2007-10-22 11:03:36 +1000118int register_virtio_device(struct virtio_device *dev);
119void unregister_virtio_device(struct virtio_device *dev);
120
Rusty Russelle2dcdfe2014-04-28 11:15:08 +0930121void virtio_break_device(struct virtio_device *dev);
122
Michael S. Tsirkin016c98c2014-10-14 10:40:34 +1030123void virtio_config_changed(struct virtio_device *dev);
Michael S. Tsirkinc6716ba2014-10-14 10:40:35 +1030124#ifdef CONFIG_PM_SLEEP
125int virtio_device_freeze(struct virtio_device *dev);
126int virtio_device_restore(struct virtio_device *dev);
127#endif
Michael S. Tsirkin016c98c2014-10-14 10:40:34 +1030128
Rusty Russellec3d41c2007-10-22 11:03:36 +1000129/**
130 * virtio_driver - operations for a virtio I/O driver
131 * @driver: underlying device driver (populate name and owner).
132 * @id_table: the ids serviced by this driver.
Wang Sheng-Hui5f41f8b2011-08-25 21:04:05 +0800133 * @feature_table: an array of feature numbers supported by this driver.
Rusty Russellc45a6812008-05-02 21:50:50 -0500134 * @feature_table_size: number of entries in the feature table array.
Michael S. Tsirkinb3bb62d2014-10-23 18:07:47 +0300135 * @feature_table_legacy: same as feature_table but when working in legacy mode.
136 * @feature_table_size_legacy: number of entries in feature table legacy array.
Rusty Russell20f77f52009-06-12 22:16:33 -0600137 * @probe: the function to call when a device is found. Returns 0 or -errno.
Wang Sheng-Hui5f41f8b2011-08-25 21:04:05 +0800138 * @remove: the function to call when a device is removed.
Rusty Russellf957d1f2008-02-04 23:49:58 -0500139 * @config_changed: optional function to call when the device configuration
140 * changes; may be called in interrupt context.
Rusty Russellec3d41c2007-10-22 11:03:36 +1000141 */
142struct virtio_driver {
143 struct device_driver driver;
144 const struct virtio_device_id *id_table;
Rusty Russellc45a6812008-05-02 21:50:50 -0500145 const unsigned int *feature_table;
146 unsigned int feature_table_size;
Michael S. Tsirkinb3bb62d2014-10-23 18:07:47 +0300147 const unsigned int *feature_table_legacy;
148 unsigned int feature_table_size_legacy;
Rusty Russellec3d41c2007-10-22 11:03:36 +1000149 int (*probe)(struct virtio_device *dev);
Nicholas Bellinger59057fb2012-07-11 21:22:16 +0000150 void (*scan)(struct virtio_device *dev);
Rusty Russellec3d41c2007-10-22 11:03:36 +1000151 void (*remove)(struct virtio_device *dev);
Rusty Russellf957d1f2008-02-04 23:49:58 -0500152 void (*config_changed)(struct virtio_device *dev);
Amit Shahf0fe6f12011-12-22 16:58:26 +0530153#ifdef CONFIG_PM
154 int (*freeze)(struct virtio_device *dev);
Amit Shahf0fe6f12011-12-22 16:58:26 +0530155 int (*restore)(struct virtio_device *dev);
156#endif
Rusty Russellec3d41c2007-10-22 11:03:36 +1000157};
158
Wanlong Gao9a2bdcc2012-12-10 16:38:33 +0800159static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv)
160{
161 return container_of(drv, struct virtio_driver, driver);
162}
163
Rusty Russellec3d41c2007-10-22 11:03:36 +1000164int register_virtio_driver(struct virtio_driver *drv);
165void unregister_virtio_driver(struct virtio_driver *drv);
Sjur Brændeland6e105e02013-02-13 15:52:36 +1030166
167/* module_virtio_driver() - Helper macro for drivers that don't do
168 * anything special in module init/exit. This eliminates a lot of
169 * boilerplate. Each module may only use this macro once, and
170 * calling it replaces module_init() and module_exit()
171 */
172#define module_virtio_driver(__virtio_driver) \
173 module_driver(__virtio_driver, register_virtio_driver, \
174 unregister_virtio_driver)
Rusty Russellec3d41c2007-10-22 11:03:36 +1000175#endif /* _LINUX_VIRTIO_H */