Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 */
20struct 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
28int 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);
34
35void virtqueue_kick(struct virtqueue *vq);
36
37bool virtqueue_kick_prepare(struct virtqueue *vq);
38
39void virtqueue_notify(struct virtqueue *vq);
40
41void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
42
43void virtqueue_disable_cb(struct virtqueue *vq);
44
45bool virtqueue_enable_cb(struct virtqueue *vq);
46
47bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
48
49void *virtqueue_detach_unused_buf(struct virtqueue *vq);
50
51unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
52
53int virtqueue_get_queue_index(struct virtqueue *vq);
54
55/**
56 * virtio_device - representation of a device using virtio
57 * @index: unique position on the virtio bus
58 * @dev: underlying device.
59 * @id: the device type identification (used to match it with a driver).
60 * @config: the configuration ops for this device.
61 * @vqs: the list of virtqueues for this device.
62 * @features: the features supported by both driver and device.
63 * @priv: private pointer for the driver's use.
64 */
65struct virtio_device {
66 int index;
67 struct device dev;
68 struct virtio_device_id id;
69 struct virtio_config_ops *config;
70 struct list_head vqs;
71 /* Note that this is a Linux set_bit-style bitmap. */
72 unsigned long features[1];
73 void *priv;
74};
75
76#define dev_to_virtio(dev) container_of(dev, struct virtio_device, dev)
77int register_virtio_device(struct virtio_device *dev);
78void unregister_virtio_device(struct virtio_device *dev);
79
80/**
81 * virtio_driver - operations for a virtio I/O driver
82 * @driver: underlying device driver (populate name and owner).
83 * @id_table: the ids serviced by this driver.
84 * @feature_table: an array of feature numbers supported by this driver.
85 * @feature_table_size: number of entries in the feature table array.
86 * @probe: the function to call when a device is found. Returns 0 or -errno.
87 * @remove: the function to call when a device is removed.
88 * @config_changed: optional function to call when the device configuration
89 * changes; may be called in interrupt context.
90 */
91struct virtio_driver {
92 struct device_driver driver;
93 const struct virtio_device_id *id_table;
94 const unsigned int *feature_table;
95 unsigned int feature_table_size;
96 int (*probe)(struct virtio_device *dev);
97 void (*scan)(struct virtio_device *dev);
98 void (*remove)(struct virtio_device *dev);
99 void (*config_changed)(struct virtio_device *dev);
100#ifdef CONFIG_PM
101 int (*freeze)(struct virtio_device *dev);
102 int (*restore)(struct virtio_device *dev);
103#endif
104};
105
106int register_virtio_driver(struct virtio_driver *drv);
107void unregister_virtio_driver(struct virtio_driver *drv);
108#endif /* _LINUX_VIRTIO_H */