virtio: Add ability to detach unused buffers from vrings
[linux-2.6.git] / include / linux / virtio.h
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>
10
11 /**
12  * virtqueue - a queue to register buffers for sending or receiving.
13  * @list: the chain of virtqueues for this device
14  * @callback: the function to call when buffers are consumed (can be NULL).
15  * @name: the name of this virtqueue (mainly for debugging)
16  * @vdev: the virtio device this queue was created for.
17  * @vq_ops: the operations for this virtqueue (see below).
18  * @priv: a pointer for the virtqueue implementation to use.
19  */
20 struct virtqueue {
21         struct list_head list;
22         void (*callback)(struct virtqueue *vq);
23         const char *name;
24         struct virtio_device *vdev;
25         struct virtqueue_ops *vq_ops;
26         void *priv;
27 };
28
29 /**
30  * virtqueue_ops - operations for virtqueue abstraction layer
31  * @add_buf: expose buffer to other end
32  *      vq: the struct virtqueue we're talking about.
33  *      sg: the description of the buffer(s).
34  *      out_num: the number of sg readable by other side
35  *      in_num: the number of sg which are writable (after readable ones)
36  *      data: the token identifying the buffer.
37  *      Returns remaining capacity of queue (sg segments) or a negative error.
38  * @kick: update after add_buf
39  *      vq: the struct virtqueue
40  *      After one or more add_buf calls, invoke this to kick the other side.
41  * @get_buf: get the next used buffer
42  *      vq: the struct virtqueue we're talking about.
43  *      len: the length written into the buffer
44  *      Returns NULL or the "data" token handed to add_buf.
45  * @disable_cb: disable callbacks
46  *      vq: the struct virtqueue we're talking about.
47  *      Note that this is not necessarily synchronous, hence unreliable and only
48  *      useful as an optimization.
49  * @enable_cb: restart callbacks after disable_cb.
50  *      vq: the struct virtqueue we're talking about.
51  *      This re-enables callbacks; it returns "false" if there are pending
52  *      buffers in the queue, to detect a possible race between the driver
53  *      checking for more work, and enabling callbacks.
54  * @detach_unused_buf: detach first unused buffer
55  *      vq: the struct virtqueue we're talking about.
56  *      Returns NULL or the "data" token handed to add_buf
57  *
58  * Locking rules are straightforward: the driver is responsible for
59  * locking.  No two operations may be invoked simultaneously, with the exception
60  * of @disable_cb.
61  *
62  * All operations can be called in any context.
63  */
64 struct virtqueue_ops {
65         int (*add_buf)(struct virtqueue *vq,
66                        struct scatterlist sg[],
67                        unsigned int out_num,
68                        unsigned int in_num,
69                        void *data);
70
71         void (*kick)(struct virtqueue *vq);
72
73         void *(*get_buf)(struct virtqueue *vq, unsigned int *len);
74
75         void (*disable_cb)(struct virtqueue *vq);
76         bool (*enable_cb)(struct virtqueue *vq);
77         void *(*detach_unused_buf)(struct virtqueue *vq);
78 };
79
80 /**
81  * virtio_device - representation of a device using virtio
82  * @index: unique position on the virtio bus
83  * @dev: underlying device.
84  * @id: the device type identification (used to match it with a driver).
85  * @config: the configuration ops for this device.
86  * @vqs: the list of virtqueues for this device.
87  * @features: the features supported by both driver and device.
88  * @priv: private pointer for the driver's use.
89  */
90 struct virtio_device {
91         int index;
92         struct device dev;
93         struct virtio_device_id id;
94         struct virtio_config_ops *config;
95         struct list_head vqs;
96         /* Note that this is a Linux set_bit-style bitmap. */
97         unsigned long features[1];
98         void *priv;
99 };
100
101 int register_virtio_device(struct virtio_device *dev);
102 void unregister_virtio_device(struct virtio_device *dev);
103
104 /**
105  * virtio_driver - operations for a virtio I/O driver
106  * @driver: underlying device driver (populate name and owner).
107  * @id_table: the ids serviced by this driver.
108  * @feature_table: an array of feature numbers supported by this device.
109  * @feature_table_size: number of entries in the feature table array.
110  * @probe: the function to call when a device is found.  Returns 0 or -errno.
111  * @remove: the function when a device is removed.
112  * @config_changed: optional function to call when the device configuration
113  *    changes; may be called in interrupt context.
114  */
115 struct virtio_driver {
116         struct device_driver driver;
117         const struct virtio_device_id *id_table;
118         const unsigned int *feature_table;
119         unsigned int feature_table_size;
120         int (*probe)(struct virtio_device *dev);
121         void (*remove)(struct virtio_device *dev);
122         void (*config_changed)(struct virtio_device *dev);
123 };
124
125 int register_virtio_driver(struct virtio_driver *drv);
126 void unregister_virtio_driver(struct virtio_driver *drv);
127 #endif /* _LINUX_VIRTIO_H */