Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_VIRTIO_H
3#define _LINUX_VIRTIO_H
4/* Everything a virtio driver needs to work with any particular virtio
5 * implementation. */
6#include <linux/types.h>
7#include <linux/scatterlist.h>
8#include <linux/spinlock.h>
9#include <linux/device.h>
10#include <linux/mod_devicetable.h>
11#include <linux/gfp.h>
12
13/**
14 * virtqueue - a queue to register buffers for sending or receiving.
15 * @list: the chain of virtqueues for this device
16 * @callback: the function to call when buffers are consumed (can be NULL).
17 * @name: the name of this virtqueue (mainly for debugging)
18 * @vdev: the virtio device this queue was created for.
19 * @priv: a pointer for the virtqueue implementation to use.
20 * @index: the zero-based ordinal number for this queue.
21 * @num_free: number of elements we expect to be able to fit.
22 *
23 * A note on @num_free: with indirect buffers, each buffer needs one
24 * element in the queue, otherwise a buffer will need one element per
25 * sg element.
26 */
27struct virtqueue {
28 struct list_head list;
29 void (*callback)(struct virtqueue *vq);
30 const char *name;
31 struct virtio_device *vdev;
32 unsigned int index;
33 unsigned int num_free;
34 void *priv;
35};
36
37int virtqueue_add_outbuf(struct virtqueue *vq,
38 struct scatterlist sg[], unsigned int num,
39 void *data,
40 gfp_t gfp);
41
42int virtqueue_add_inbuf(struct virtqueue *vq,
43 struct scatterlist sg[], unsigned int num,
44 void *data,
45 gfp_t gfp);
46
47int virtqueue_add_inbuf_ctx(struct virtqueue *vq,
48 struct scatterlist sg[], unsigned int num,
49 void *data,
50 void *ctx,
51 gfp_t gfp);
52
53int virtqueue_add_sgs(struct virtqueue *vq,
54 struct scatterlist *sgs[],
55 unsigned int out_sgs,
56 unsigned int in_sgs,
57 void *data,
58 gfp_t gfp);
59
60bool virtqueue_kick(struct virtqueue *vq);
61
62bool virtqueue_kick_prepare(struct virtqueue *vq);
63
64bool virtqueue_notify(struct virtqueue *vq);
65
66void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
67
68void *virtqueue_get_buf_ctx(struct virtqueue *vq, unsigned int *len,
69 void **ctx);
70
71void virtqueue_disable_cb(struct virtqueue *vq);
72
73bool virtqueue_enable_cb(struct virtqueue *vq);
74
75unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq);
76
77bool virtqueue_poll(struct virtqueue *vq, unsigned);
78
79bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
80
81void *virtqueue_detach_unused_buf(struct virtqueue *vq);
82
83unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
84
85bool virtqueue_is_broken(struct virtqueue *vq);
86
87const struct vring *virtqueue_get_vring(struct virtqueue *vq);
88dma_addr_t virtqueue_get_desc_addr(struct virtqueue *vq);
89dma_addr_t virtqueue_get_avail_addr(struct virtqueue *vq);
90dma_addr_t virtqueue_get_used_addr(struct virtqueue *vq);
91
92/**
93 * virtio_device - representation of a device using virtio
94 * @index: unique position on the virtio bus
95 * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore)
96 * @config_enabled: configuration change reporting enabled
97 * @config_change_pending: configuration change reported while disabled
98 * @config_lock: protects configuration change reporting
99 * @dev: underlying device.
100 * @id: the device type identification (used to match it with a driver).
101 * @config: the configuration ops for this device.
102 * @vringh_config: configuration ops for host vrings.
103 * @vqs: the list of virtqueues for this device.
104 * @features: the features supported by both driver and device.
105 * @priv: private pointer for the driver's use.
106 */
107struct virtio_device {
108 int index;
109 bool failed;
110 bool config_enabled;
111 bool config_change_pending;
112 spinlock_t config_lock;
113 spinlock_t vqs_list_lock; /* Protects VQs list access */
114 struct device dev;
115 struct virtio_device_id id;
116 const struct virtio_config_ops *config;
117 const struct vringh_config_ops *vringh_config;
118 struct list_head vqs;
119 u64 features;
120 void *priv;
121};
122
123static inline struct virtio_device *dev_to_virtio(struct device *_dev)
124{
125 return container_of(_dev, struct virtio_device, dev);
126}
127
128void virtio_add_status(struct virtio_device *dev, unsigned int status);
129int register_virtio_device(struct virtio_device *dev);
130void unregister_virtio_device(struct virtio_device *dev);
131bool is_virtio_device(struct device *dev);
132
133void virtio_break_device(struct virtio_device *dev);
134
135void virtio_config_changed(struct virtio_device *dev);
136int virtio_finalize_features(struct virtio_device *dev);
137#ifdef CONFIG_PM_SLEEP
138int virtio_device_freeze(struct virtio_device *dev);
139int virtio_device_restore(struct virtio_device *dev);
140#endif
141
142size_t virtio_max_dma_size(struct virtio_device *vdev);
143
144#define virtio_device_for_each_vq(vdev, vq) \
145 list_for_each_entry(vq, &vdev->vqs, list)
146
147/**
148 * virtio_driver - operations for a virtio I/O driver
149 * @driver: underlying device driver (populate name and owner).
150 * @id_table: the ids serviced by this driver.
151 * @feature_table: an array of feature numbers supported by this driver.
152 * @feature_table_size: number of entries in the feature table array.
153 * @feature_table_legacy: same as feature_table but when working in legacy mode.
154 * @feature_table_size_legacy: number of entries in feature table legacy array.
155 * @probe: the function to call when a device is found. Returns 0 or -errno.
156 * @scan: optional function to call after successful probe; intended
157 * for virtio-scsi to invoke a scan.
158 * @remove: the function to call when a device is removed.
159 * @config_changed: optional function to call when the device configuration
160 * changes; may be called in interrupt context.
161 * @freeze: optional function to call during suspend/hibernation.
162 * @restore: optional function to call on resume.
163 */
164struct virtio_driver {
165 struct device_driver driver;
166 const struct virtio_device_id *id_table;
167 const unsigned int *feature_table;
168 unsigned int feature_table_size;
169 const unsigned int *feature_table_legacy;
170 unsigned int feature_table_size_legacy;
171 int (*validate)(struct virtio_device *dev);
172 int (*probe)(struct virtio_device *dev);
173 void (*scan)(struct virtio_device *dev);
174 void (*remove)(struct virtio_device *dev);
175 void (*config_changed)(struct virtio_device *dev);
176#ifdef CONFIG_PM
177 int (*freeze)(struct virtio_device *dev);
178 int (*restore)(struct virtio_device *dev);
179#endif
180};
181
182static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv)
183{
184 return container_of(drv, struct virtio_driver, driver);
185}
186
187int register_virtio_driver(struct virtio_driver *drv);
188void unregister_virtio_driver(struct virtio_driver *drv);
189
190/* module_virtio_driver() - Helper macro for drivers that don't do
191 * anything special in module init/exit. This eliminates a lot of
192 * boilerplate. Each module may only use this macro once, and
193 * calling it replaces module_init() and module_exit()
194 */
195#define module_virtio_driver(__virtio_driver) \
196 module_driver(__virtio_driver, register_virtio_driver, \
197 unregister_virtio_driver)
198#endif /* _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#include <linux/vringh.h>
12
13/**
14 * virtqueue - a queue to register buffers for sending or receiving.
15 * @list: the chain of virtqueues for this device
16 * @callback: the function to call when buffers are consumed (can be NULL).
17 * @name: the name of this virtqueue (mainly for debugging)
18 * @vdev: the virtio device this queue was created for.
19 * @priv: a pointer for the virtqueue implementation to use.
20 * @index: the zero-based ordinal number for this queue.
21 * @num_free: number of elements we expect to be able to fit.
22 *
23 * A note on @num_free: with indirect buffers, each buffer needs one
24 * element in the queue, otherwise a buffer will need one element per
25 * sg element.
26 */
27struct virtqueue {
28 struct list_head list;
29 void (*callback)(struct virtqueue *vq);
30 const char *name;
31 struct virtio_device *vdev;
32 unsigned int index;
33 unsigned int num_free;
34 void *priv;
35};
36
37int virtqueue_add_outbuf(struct virtqueue *vq,
38 struct scatterlist sg[], unsigned int num,
39 void *data,
40 gfp_t gfp);
41
42int virtqueue_add_inbuf(struct virtqueue *vq,
43 struct scatterlist sg[], unsigned int num,
44 void *data,
45 gfp_t gfp);
46
47int virtqueue_add_sgs(struct virtqueue *vq,
48 struct scatterlist *sgs[],
49 unsigned int out_sgs,
50 unsigned int in_sgs,
51 void *data,
52 gfp_t gfp);
53
54bool virtqueue_kick(struct virtqueue *vq);
55
56bool virtqueue_kick_prepare(struct virtqueue *vq);
57
58bool virtqueue_notify(struct virtqueue *vq);
59
60void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
61
62void virtqueue_disable_cb(struct virtqueue *vq);
63
64bool virtqueue_enable_cb(struct virtqueue *vq);
65
66unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq);
67
68bool virtqueue_poll(struct virtqueue *vq, unsigned);
69
70bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
71
72void *virtqueue_detach_unused_buf(struct virtqueue *vq);
73
74unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
75
76bool virtqueue_is_broken(struct virtqueue *vq);
77
78const struct vring *virtqueue_get_vring(struct virtqueue *vq);
79dma_addr_t virtqueue_get_desc_addr(struct virtqueue *vq);
80dma_addr_t virtqueue_get_avail_addr(struct virtqueue *vq);
81dma_addr_t virtqueue_get_used_addr(struct virtqueue *vq);
82
83/*
84 * Legacy accessors -- in almost all cases, these are the wrong functions
85 * to use.
86 */
87static inline void *virtqueue_get_desc(struct virtqueue *vq)
88{
89 return virtqueue_get_vring(vq)->desc;
90}
91static inline void *virtqueue_get_avail(struct virtqueue *vq)
92{
93 return virtqueue_get_vring(vq)->avail;
94}
95static inline void *virtqueue_get_used(struct virtqueue *vq)
96{
97 return virtqueue_get_vring(vq)->used;
98}
99
100/**
101 * virtio_device - representation of a device using virtio
102 * @index: unique position on the virtio bus
103 * @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore)
104 * @config_enabled: configuration change reporting enabled
105 * @config_change_pending: configuration change reported while disabled
106 * @config_lock: protects configuration change reporting
107 * @dev: underlying device.
108 * @id: the device type identification (used to match it with a driver).
109 * @config: the configuration ops for this device.
110 * @vringh_config: configuration ops for host vrings.
111 * @vqs: the list of virtqueues for this device.
112 * @features: the features supported by both driver and device.
113 * @priv: private pointer for the driver's use.
114 */
115struct virtio_device {
116 int index;
117 bool failed;
118 bool config_enabled;
119 bool config_change_pending;
120 spinlock_t config_lock;
121 struct device dev;
122 struct virtio_device_id id;
123 const struct virtio_config_ops *config;
124 const struct vringh_config_ops *vringh_config;
125 struct list_head vqs;
126 u64 features;
127 void *priv;
128};
129
130static inline struct virtio_device *dev_to_virtio(struct device *_dev)
131{
132 return container_of(_dev, struct virtio_device, dev);
133}
134
135int register_virtio_device(struct virtio_device *dev);
136void unregister_virtio_device(struct virtio_device *dev);
137
138void virtio_break_device(struct virtio_device *dev);
139
140void virtio_config_changed(struct virtio_device *dev);
141#ifdef CONFIG_PM_SLEEP
142int virtio_device_freeze(struct virtio_device *dev);
143int virtio_device_restore(struct virtio_device *dev);
144#endif
145
146/**
147 * virtio_driver - operations for a virtio I/O driver
148 * @driver: underlying device driver (populate name and owner).
149 * @id_table: the ids serviced by this driver.
150 * @feature_table: an array of feature numbers supported by this driver.
151 * @feature_table_size: number of entries in the feature table array.
152 * @feature_table_legacy: same as feature_table but when working in legacy mode.
153 * @feature_table_size_legacy: number of entries in feature table legacy array.
154 * @probe: the function to call when a device is found. Returns 0 or -errno.
155 * @remove: the function to call when a device is removed.
156 * @config_changed: optional function to call when the device configuration
157 * changes; may be called in interrupt context.
158 */
159struct virtio_driver {
160 struct device_driver driver;
161 const struct virtio_device_id *id_table;
162 const unsigned int *feature_table;
163 unsigned int feature_table_size;
164 const unsigned int *feature_table_legacy;
165 unsigned int feature_table_size_legacy;
166 int (*probe)(struct virtio_device *dev);
167 void (*scan)(struct virtio_device *dev);
168 void (*remove)(struct virtio_device *dev);
169 void (*config_changed)(struct virtio_device *dev);
170#ifdef CONFIG_PM
171 int (*freeze)(struct virtio_device *dev);
172 int (*restore)(struct virtio_device *dev);
173#endif
174};
175
176static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv)
177{
178 return container_of(drv, struct virtio_driver, driver);
179}
180
181int register_virtio_driver(struct virtio_driver *drv);
182void unregister_virtio_driver(struct virtio_driver *drv);
183
184/* module_virtio_driver() - Helper macro for drivers that don't do
185 * anything special in module init/exit. This eliminates a lot of
186 * boilerplate. Each module may only use this macro once, and
187 * calling it replaces module_init() and module_exit()
188 */
189#define module_virtio_driver(__virtio_driver) \
190 module_driver(__virtio_driver, register_virtio_driver, \
191 unregister_virtio_driver)
192#endif /* _LINUX_VIRTIO_H */