blob: d0018d27c281ffa3a7135c1aa1a8deffc1b900ca [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.
19 */
Rusty Russell9499f5e2009-06-12 22:16:35 -060020struct virtqueue {
21 struct list_head list;
Rusty Russell18445c42008-02-04 23:49:57 -050022 void (*callback)(struct virtqueue *vq);
Rusty Russell9499f5e2009-06-12 22:16:35 -060023 const char *name;
Rusty Russellec3d41c2007-10-22 11:03:36 +100024 struct virtio_device *vdev;
Rusty Russellec3d41c2007-10-22 11:03:36 +100025 void *priv;
26};
27
Rusty Russellf96fde42012-01-12 15:44:42 +103028int virtqueue_add_buf(struct virtqueue *vq,
29 struct scatterlist sg[],
30 unsigned int out_num,
31 unsigned int in_num,
32 void *data,
33 gfp_t gfp);
Rusty Russellec3d41c2007-10-22 11:03:36 +100034
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030035void virtqueue_kick(struct virtqueue *vq);
Rusty Russellec3d41c2007-10-22 11:03:36 +100036
Rusty Russell41f03772012-01-12 15:44:43 +103037bool virtqueue_kick_prepare(struct virtqueue *vq);
38
39void virtqueue_notify(struct virtqueue *vq);
40
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030041void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
Rusty Russellec3d41c2007-10-22 11:03:36 +100042
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030043void virtqueue_disable_cb(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030044
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030045bool virtqueue_enable_cb(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030046
Michael S. Tsirkin7ab358c2011-05-20 02:11:14 +030047bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
48
Michael S. Tsirkin7c5e9ed2010-04-12 16:19:07 +030049void *virtqueue_detach_unused_buf(struct virtqueue *vq);
Michael S. Tsirkin316f25f2010-04-12 16:18:25 +030050
Rick Jones8f9f4662011-10-19 08:10:59 +000051unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
52
Rusty Russellec3d41c2007-10-22 11:03:36 +100053/**
54 * virtio_device - representation of a device using virtio
55 * @index: unique position on the virtio bus
56 * @dev: underlying device.
57 * @id: the device type identification (used to match it with a driver).
58 * @config: the configuration ops for this device.
Rusty Russell9499f5e2009-06-12 22:16:35 -060059 * @vqs: the list of virtqueues for this device.
Rusty Russellc45a6812008-05-02 21:50:50 -050060 * @features: the features supported by both driver and device.
Rusty Russellec3d41c2007-10-22 11:03:36 +100061 * @priv: private pointer for the driver's use.
62 */
Rusty Russell9499f5e2009-06-12 22:16:35 -060063struct virtio_device {
Rusty Russellec3d41c2007-10-22 11:03:36 +100064 int index;
65 struct device dev;
66 struct virtio_device_id id;
67 struct virtio_config_ops *config;
Rusty Russell9499f5e2009-06-12 22:16:35 -060068 struct list_head vqs;
Rusty Russellc45a6812008-05-02 21:50:50 -050069 /* Note that this is a Linux set_bit-style bitmap. */
70 unsigned long features[1];
Rusty Russellec3d41c2007-10-22 11:03:36 +100071 void *priv;
72};
73
Aneesh Kumar K.V86c84372010-03-06 04:44:15 +000074#define dev_to_virtio(dev) container_of(dev, struct virtio_device, dev)
Rusty Russellec3d41c2007-10-22 11:03:36 +100075int register_virtio_device(struct virtio_device *dev);
76void unregister_virtio_device(struct virtio_device *dev);
77
78/**
79 * virtio_driver - operations for a virtio I/O driver
80 * @driver: underlying device driver (populate name and owner).
81 * @id_table: the ids serviced by this driver.
Wang Sheng-Hui5f41f8b2011-08-25 21:04:05 +080082 * @feature_table: an array of feature numbers supported by this driver.
Rusty Russellc45a6812008-05-02 21:50:50 -050083 * @feature_table_size: number of entries in the feature table array.
Rusty Russell20f77f52009-06-12 22:16:33 -060084 * @probe: the function to call when a device is found. Returns 0 or -errno.
Wang Sheng-Hui5f41f8b2011-08-25 21:04:05 +080085 * @remove: the function to call when a device is removed.
Rusty Russellf957d1f2008-02-04 23:49:58 -050086 * @config_changed: optional function to call when the device configuration
87 * changes; may be called in interrupt context.
Rusty Russellec3d41c2007-10-22 11:03:36 +100088 */
89struct virtio_driver {
90 struct device_driver driver;
91 const struct virtio_device_id *id_table;
Rusty Russellc45a6812008-05-02 21:50:50 -050092 const unsigned int *feature_table;
93 unsigned int feature_table_size;
Rusty Russellec3d41c2007-10-22 11:03:36 +100094 int (*probe)(struct virtio_device *dev);
95 void (*remove)(struct virtio_device *dev);
Rusty Russellf957d1f2008-02-04 23:49:58 -050096 void (*config_changed)(struct virtio_device *dev);
Amit Shahf0fe6f12011-12-22 16:58:26 +053097#ifdef CONFIG_PM
98 int (*freeze)(struct virtio_device *dev);
99 int (*thaw)(struct virtio_device *dev);
100 int (*restore)(struct virtio_device *dev);
101#endif
Rusty Russellec3d41c2007-10-22 11:03:36 +1000102};
103
104int register_virtio_driver(struct virtio_driver *drv);
105void unregister_virtio_driver(struct virtio_driver *drv);
106#endif /* _LINUX_VIRTIO_H */