73ad7243128f7550d37730d9c63270fae17fa3ce
[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 #include <linux/gfp.h>
11
12 /**
13  * virtqueue - a queue to register buffers for sending or receiving.
14  * @list: the chain of virtqueues for this device
15  * @callback: the function to call when buffers are consumed (can be NULL).
16  * @name: the name of this virtqueue (mainly for debugging)
17  * @vdev: the virtio device this queue was created for.
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         void *priv;
26 };
27
28 int virtqueue_add_buf_gfp(struct virtqueue *vq,
29                           struct scatterlist sg[],
30                           unsigned int out_num,
31                           unsigned int in_num,
32                           void *data,
33                           gfp_t gfp);
34
35 static inline int virtqueue_add_buf(struct virtqueue *vq,
36                                     struct scatterlist sg[],
37                                     unsigned int out_num,
38                                     unsigned int in_num,
39                                     void *data)
40 {
41         return virtqueue_add_buf_gfp(vq, sg, out_num, in_num, data, GFP_ATOMIC);
42 }
43
44 void virtqueue_kick(struct virtqueue *vq);
45
46 void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
47
48 void virtqueue_disable_cb(struct virtqueue *vq);
49
50 bool virtqueue_enable_cb(struct virtqueue *vq);
51
52 bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
53
54 void *virtqueue_detach_unused_buf(struct virtqueue *vq);
55
56 unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
57
58 /**
59  * virtio_device - representation of a device using virtio
60  * @index: unique position on the virtio bus
61  * @dev: underlying device.
62  * @id: the device type identification (used to match it with a driver).
63  * @config: the configuration ops for this device.
64  * @vqs: the list of virtqueues for this device.
65  * @features: the features supported by both driver and device.
66  * @priv: private pointer for the driver's use.
67  */
68 struct virtio_device {
69         int index;
70         struct device dev;
71         struct virtio_device_id id;
72         struct virtio_config_ops *config;
73         struct list_head vqs;
74         /* Note that this is a Linux set_bit-style bitmap. */
75         unsigned long features[1];
76         void *priv;
77 };
78
79 #define dev_to_virtio(dev) container_of(dev, struct virtio_device, dev)
80 int register_virtio_device(struct virtio_device *dev);
81 void unregister_virtio_device(struct virtio_device *dev);
82
83 /**
84  * virtio_driver - operations for a virtio I/O driver
85  * @driver: underlying device driver (populate name and owner).
86  * @id_table: the ids serviced by this driver.
87  * @feature_table: an array of feature numbers supported by this driver.
88  * @feature_table_size: number of entries in the feature table array.
89  * @probe: the function to call when a device is found.  Returns 0 or -errno.
90  * @remove: the function to call when a device is removed.
91  * @config_changed: optional function to call when the device configuration
92  *    changes; may be called in interrupt context.
93  */
94 struct virtio_driver {
95         struct device_driver driver;
96         const struct virtio_device_id *id_table;
97         const unsigned int *feature_table;
98         unsigned int feature_table_size;
99         int (*probe)(struct virtio_device *dev);
100         void (*remove)(struct virtio_device *dev);
101         void (*config_changed)(struct virtio_device *dev);
102 };
103
104 int register_virtio_driver(struct virtio_driver *drv);
105 void unregister_virtio_driver(struct virtio_driver *drv);
106 #endif /* _LINUX_VIRTIO_H */