blob: ff6714e6d0f503f6251ae54856796a06f2314977 [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>
Rusty Russellec3d41c2007-10-22 11:03:36 +100011
12/**
13 * virtqueue - a queue to register buffers for sending or receiving.
Rusty Russell9499f5e2009-06-12 22:16:35 -060014 * @list: the chain of virtqueues for this device
Rusty Russellec3d41c2007-10-22 11:03:36 +100015 * @callback: the function to call when buffers are consumed (can be NULL).
Rusty Russell9499f5e2009-06-12 22:16:35 -060016 * @name: the name of this virtqueue (mainly for debugging)
Rusty Russellec3d41c2007-10-22 11:03:36 +100017 * @vdev: the virtio device this queue was created for.
Rusty Russellec3d41c2007-10-22 11:03:36 +100018 * @priv: a pointer for the virtqueue implementation to use.
Rusty Russell06ca2872012-10-16 23:56:14 +103019 * @index: the zero-based ordinal number for this queue.
20 * @num_free: number of elements we expect to be able to fit.
21 *
22 * A note on @num_free: with indirect buffers, each buffer needs one
23 * element in the queue, otherwise a buffer will need one element per
24 * sg element.
Rusty Russellec3d41c2007-10-22 11:03:36 +100025 */
Rusty Russell9499f5e2009-06-12 22:16:35 -060026struct virtqueue {
27 struct list_head list;
Rusty Russell18445c42008-02-04 23:49:57 -050028 void (*callback)(struct virtqueue *vq);
Rusty Russell9499f5e2009-06-12 22:16:35 -060029 const char *name;
Rusty Russellec3d41c2007-10-22 11:03:36 +100030 struct virtio_device *vdev;
Rusty Russell06ca2872012-10-16 23:56:14 +103031 unsigned int index;
32 unsigned int num_free;
Rusty Russellec3d41c2007-10-22 11:03:36 +100033 void *priv;
34};
35
Rusty Russellf96fde42012-01-12 15:44:42 +103036int virtqueue_add_buf(struct virtqueue *vq,
37 struct scatterlist sg[],
38 unsigned int out_num,
39 unsigned int in_num,
40 void *data,
41 gfp_t gfp);
Rusty Russellec3d41c2007-10-22 11:03:36 +100042
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030043void virtqueue_kick(struct virtqueue *vq);
Rusty Russellec3d41c2007-10-22 11:03:36 +100044
Rusty Russell41f03772012-01-12 15:44:43 +103045bool virtqueue_kick_prepare(struct virtqueue *vq);
46
47void virtqueue_notify(struct virtqueue *vq);
48
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030049void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
Rusty Russellec3d41c2007-10-22 11:03:36 +100050
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030051void virtqueue_disable_cb(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030052
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030053bool virtqueue_enable_cb(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030054
Michael S. Tsirkin7ab358c2011-05-20 02:11:14 +030055bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
56
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030057void *virtqueue_detach_unused_buf(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030058
Rick Jones8f9f4662011-10-19 08:10:59 +000059unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
60
Rusty Russell06ca2872012-10-16 23:56:14 +103061/* FIXME: Obsolete accessor, but required for virtio_net merge. */
62static inline unsigned int virtqueue_get_queue_index(struct virtqueue *vq)
63{
64 return vq->index;
65}
Jason Wang17bb6d42012-08-28 13:54:13 +020066
Rusty Russellec3d41c2007-10-22 11:03:36 +100067/**
68 * virtio_device - representation of a device using virtio
69 * @index: unique position on the virtio bus
70 * @dev: underlying device.
71 * @id: the device type identification (used to match it with a driver).
72 * @config: the configuration ops for this device.
Rusty Russell9499f5e2009-06-12 22:16:35 -060073 * @vqs: the list of virtqueues for this device.
Rusty Russellc45a6812008-05-02 21:50:50 -050074 * @features: the features supported by both driver and device.
Rusty Russellec3d41c2007-10-22 11:03:36 +100075 * @priv: private pointer for the driver's use.
76 */
Rusty Russell9499f5e2009-06-12 22:16:35 -060077struct virtio_device {
Rusty Russellec3d41c2007-10-22 11:03:36 +100078 int index;
79 struct device dev;
80 struct virtio_device_id id;
Stephen Hemminger93503932013-02-10 15:57:38 +103081 const struct virtio_config_ops *config;
Rusty Russell9499f5e2009-06-12 22:16:35 -060082 struct list_head vqs;
Rusty Russellc45a6812008-05-02 21:50:50 -050083 /* Note that this is a Linux set_bit-style bitmap. */
84 unsigned long features[1];
Rusty Russellec3d41c2007-10-22 11:03:36 +100085 void *priv;
86};
87
Wanlong Gao9bffdca2012-12-11 11:04:50 +103088static inline struct virtio_device *dev_to_virtio(struct device *_dev)
89{
90 return container_of(_dev, struct virtio_device, dev);
91}
92
Rusty Russellec3d41c2007-10-22 11:03:36 +100093int register_virtio_device(struct virtio_device *dev);
94void unregister_virtio_device(struct virtio_device *dev);
95
96/**
97 * virtio_driver - operations for a virtio I/O driver
98 * @driver: underlying device driver (populate name and owner).
99 * @id_table: the ids serviced by this driver.
Wang Sheng-Hui5f41f8b2011-08-25 21:04:05 +0800100 * @feature_table: an array of feature numbers supported by this driver.
Rusty Russellc45a6812008-05-02 21:50:50 -0500101 * @feature_table_size: number of entries in the feature table array.
Rusty Russell20f77f52009-06-12 22:16:33 -0600102 * @probe: the function to call when a device is found. Returns 0 or -errno.
Wang Sheng-Hui5f41f8b2011-08-25 21:04:05 +0800103 * @remove: the function to call when a device is removed.
Rusty Russellf957d1f2008-02-04 23:49:58 -0500104 * @config_changed: optional function to call when the device configuration
105 * changes; may be called in interrupt context.
Rusty Russellec3d41c2007-10-22 11:03:36 +1000106 */
107struct virtio_driver {
108 struct device_driver driver;
109 const struct virtio_device_id *id_table;
Rusty Russellc45a6812008-05-02 21:50:50 -0500110 const unsigned int *feature_table;
111 unsigned int feature_table_size;
Rusty Russellec3d41c2007-10-22 11:03:36 +1000112 int (*probe)(struct virtio_device *dev);
Nicholas Bellinger59057fb2012-07-11 21:22:16 +0000113 void (*scan)(struct virtio_device *dev);
Rusty Russellec3d41c2007-10-22 11:03:36 +1000114 void (*remove)(struct virtio_device *dev);
Rusty Russellf957d1f2008-02-04 23:49:58 -0500115 void (*config_changed)(struct virtio_device *dev);
Amit Shahf0fe6f12011-12-22 16:58:26 +0530116#ifdef CONFIG_PM
117 int (*freeze)(struct virtio_device *dev);
Amit Shahf0fe6f12011-12-22 16:58:26 +0530118 int (*restore)(struct virtio_device *dev);
119#endif
Rusty Russellec3d41c2007-10-22 11:03:36 +1000120};
121
Wanlong Gao9a2bdcc2012-12-10 16:38:33 +0800122static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv)
123{
124 return container_of(drv, struct virtio_driver, driver);
125}
126
Rusty Russellec3d41c2007-10-22 11:03:36 +1000127int register_virtio_driver(struct virtio_driver *drv);
128void unregister_virtio_driver(struct virtio_driver *drv);
Sjur Brændeland6e105e02013-02-13 15:52:36 +1030129
130/* module_virtio_driver() - Helper macro for drivers that don't do
131 * anything special in module init/exit. This eliminates a lot of
132 * boilerplate. Each module may only use this macro once, and
133 * calling it replaces module_init() and module_exit()
134 */
135#define module_virtio_driver(__virtio_driver) \
136 module_driver(__virtio_driver, register_virtio_driver, \
137 unregister_virtio_driver)
Rusty Russellec3d41c2007-10-22 11:03:36 +1000138#endif /* _LINUX_VIRTIO_H */