blob: 800617b4ddd56c3dd0a790f97a4c73f2fa38de64 [file] [log] [blame]
Rusty Russellec3d41c2007-10-22 11:03:36 +10001#ifndef _LINUX_VIRTIO_CONFIG_H
2#define _LINUX_VIRTIO_CONFIG_H
Rusty Russell674bfc22008-07-25 12:06:03 -05003/* This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
4 * anyone can use the definitions to implement compatible drivers/servers. */
5
Rusty Russellec3d41c2007-10-22 11:03:36 +10006/* Virtio devices use a standardized configuration space to define their
7 * features and pass configuration information, but each implementation can
8 * store and access that space differently. */
9#include <linux/types.h>
10
Rusty Russella586d4f2008-02-04 23:49:56 -050011/* Status byte for guest to report progress, and synchronize features. */
Rusty Russellec3d41c2007-10-22 11:03:36 +100012/* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
13#define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
14/* We have found a driver for the device. */
15#define VIRTIO_CONFIG_S_DRIVER 2
16/* Driver has used its parts of the config, and is happy */
17#define VIRTIO_CONFIG_S_DRIVER_OK 4
18/* We've given up on this device. */
19#define VIRTIO_CONFIG_S_FAILED 0x80
20
Rusty Russelldd7c7bc2008-07-25 12:06:07 -050021/* Some virtio feature bits (currently bits 28 through 31) are reserved for the
22 * transport being used (eg. virtio_ring), the rest are per-device feature
23 * bits. */
24#define VIRTIO_TRANSPORT_F_START 28
25#define VIRTIO_TRANSPORT_F_END 32
26
Rusty Russellb4f68be2008-05-30 15:09:45 -050027/* Do we get callbacks when the ring is completely used, even if we've
28 * suppressed them? */
29#define VIRTIO_F_NOTIFY_ON_EMPTY 24
30
Rusty Russellec3d41c2007-10-22 11:03:36 +100031#ifdef __KERNEL__
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -060032#include <linux/err.h>
Rusty Russell72e61eb2008-05-02 21:50:49 -050033#include <linux/virtio.h>
Rusty Russellec3d41c2007-10-22 11:03:36 +100034
35/**
36 * virtio_config_ops - operations for configuring a virtio device
Rusty Russella586d4f2008-02-04 23:49:56 -050037 * @get: read the value of a configuration field
Rusty Russellec3d41c2007-10-22 11:03:36 +100038 * vdev: the virtio_device
Rusty Russella586d4f2008-02-04 23:49:56 -050039 * offset: the offset of the configuration field
Rusty Russellec3d41c2007-10-22 11:03:36 +100040 * buf: the buffer to write the field value into.
Rusty Russella586d4f2008-02-04 23:49:56 -050041 * len: the length of the buffer
Rusty Russella586d4f2008-02-04 23:49:56 -050042 * @set: write the value of a configuration field
Rusty Russellec3d41c2007-10-22 11:03:36 +100043 * vdev: the virtio_device
Rusty Russella586d4f2008-02-04 23:49:56 -050044 * offset: the offset of the configuration field
Rusty Russellec3d41c2007-10-22 11:03:36 +100045 * buf: the buffer to read the field value from.
Rusty Russella586d4f2008-02-04 23:49:56 -050046 * len: the length of the buffer
Rusty Russellec3d41c2007-10-22 11:03:36 +100047 * @get_status: read the status byte
48 * vdev: the virtio_device
49 * Returns the status byte
50 * @set_status: write the status byte
51 * vdev: the virtio_device
52 * status: the new status byte
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -060053 * @request_vqs: request the specified number of virtqueues
54 * vdev: the virtio_device
55 * max_vqs: the max number of virtqueues we want
56 * If supplied, must call before any virtqueues are instantiated.
57 * To modify the max number of virtqueues after request_vqs has been
58 * called, call free_vqs and then request_vqs with a new value.
59 * @free_vqs: cleanup resources allocated by request_vqs
60 * vdev: the virtio_device
61 * If supplied, must call after all virtqueues have been deleted.
Rusty Russell6e5aa7e2008-02-04 23:50:03 -050062 * @reset: reset the device
63 * vdev: the virtio device
64 * After this, status and feature negotiation must be done again
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -060065 * @find_vqs: find virtqueues and instantiate them.
Rusty Russellec3d41c2007-10-22 11:03:36 +100066 * vdev: the virtio_device
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -060067 * nvqs: the number of virtqueues to find
68 * vqs: on success, includes new virtqueues
69 * callbacks: array of callbacks, for each virtqueue
70 * names: array of virtqueue names (mainly for debugging)
71 * Returns 0 on success or error status
72 * @del_vqs: free virtqueues found by find_vqs().
Rusty Russellc45a6812008-05-02 21:50:50 -050073 * @get_features: get the array of feature bits for this device.
74 * vdev: the virtio_device
75 * Returns the first 32 feature bits (all we currently need).
Rusty Russellc6248962008-07-25 12:06:07 -050076 * @finalize_features: confirm what device features we'll be using.
Rusty Russellc45a6812008-05-02 21:50:50 -050077 * vdev: the virtio_device
Rusty Russellc6248962008-07-25 12:06:07 -050078 * This gives the final feature bits for the device: it can change
79 * the dev->feature bits if it wants.
Rusty Russellec3d41c2007-10-22 11:03:36 +100080 */
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -060081typedef void vq_callback_t(struct virtqueue *);
Rusty Russell1842f232009-07-30 16:03:46 -060082struct virtio_config_ops {
Rusty Russella586d4f2008-02-04 23:49:56 -050083 void (*get)(struct virtio_device *vdev, unsigned offset,
Rusty Russellec3d41c2007-10-22 11:03:36 +100084 void *buf, unsigned len);
Rusty Russella586d4f2008-02-04 23:49:56 -050085 void (*set)(struct virtio_device *vdev, unsigned offset,
Rusty Russellec3d41c2007-10-22 11:03:36 +100086 const void *buf, unsigned len);
87 u8 (*get_status)(struct virtio_device *vdev);
88 void (*set_status)(struct virtio_device *vdev, u8 status);
Rusty Russell6e5aa7e2008-02-04 23:50:03 -050089 void (*reset)(struct virtio_device *vdev);
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -060090 int (*find_vqs)(struct virtio_device *, unsigned nvqs,
91 struct virtqueue *vqs[],
92 vq_callback_t *callbacks[],
93 const char *names[]);
94 void (*del_vqs)(struct virtio_device *);
Rusty Russellc45a6812008-05-02 21:50:50 -050095 u32 (*get_features)(struct virtio_device *vdev);
Rusty Russellc6248962008-07-25 12:06:07 -050096 void (*finalize_features)(struct virtio_device *vdev);
Rusty Russellec3d41c2007-10-22 11:03:36 +100097};
98
Rusty Russellc45a6812008-05-02 21:50:50 -050099/* If driver didn't advertise the feature, it will never appear. */
100void virtio_check_driver_offered_feature(const struct virtio_device *vdev,
101 unsigned int fbit);
102
103/**
104 * virtio_has_feature - helper to determine if this device has this feature.
105 * @vdev: the device
106 * @fbit: the feature bit
107 */
108static inline bool virtio_has_feature(const struct virtio_device *vdev,
109 unsigned int fbit)
110{
111 /* Did you forget to fix assumptions on max features? */
Rusty Russell1765e3a2011-01-24 14:45:10 -0600112 if (__builtin_constant_p(fbit))
113 BUILD_BUG_ON(fbit >= 32);
114 else
115 BUG_ON(fbit >= 32);
Rusty Russellc45a6812008-05-02 21:50:50 -0500116
Mark McLoughlinee006b32009-05-11 18:11:44 +0100117 if (fbit < VIRTIO_TRANSPORT_F_START)
118 virtio_check_driver_offered_feature(vdev, fbit);
119
Rusty Russellc45a6812008-05-02 21:50:50 -0500120 return test_bit(fbit, vdev->features);
121}
122
Rusty Russellec3d41c2007-10-22 11:03:36 +1000123/**
Rusty Russell72e61eb2008-05-02 21:50:49 -0500124 * virtio_config_val - look for a feature and get a virtio config entry.
Rusty Russella586d4f2008-02-04 23:49:56 -0500125 * @vdev: the virtio device
126 * @fbit: the feature bit
127 * @offset: the type to search for.
Rusty Russellec3d41c2007-10-22 11:03:36 +1000128 * @val: a pointer to the value to fill in.
129 *
Rusty Russella586d4f2008-02-04 23:49:56 -0500130 * The return value is -ENOENT if the feature doesn't exist. Otherwise
Rusty Russell72e61eb2008-05-02 21:50:49 -0500131 * the config value is copied into whatever is pointed to by v. */
132#define virtio_config_val(vdev, fbit, offset, v) \
Christian Borntraeger7f31fe02008-05-29 11:08:01 +0200133 virtio_config_buf((vdev), (fbit), (offset), (v), sizeof(*v))
Rusty Russellec3d41c2007-10-22 11:03:36 +1000134
Rusty Russell72e61eb2008-05-02 21:50:49 -0500135static inline int virtio_config_buf(struct virtio_device *vdev,
136 unsigned int fbit,
137 unsigned int offset,
138 void *buf, unsigned len)
139{
Rusty Russellc45a6812008-05-02 21:50:50 -0500140 if (!virtio_has_feature(vdev, fbit))
Rusty Russell72e61eb2008-05-02 21:50:49 -0500141 return -ENOENT;
142
143 vdev->config->get(vdev, offset, buf, len);
144 return 0;
145}
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -0600146
147static inline
148struct virtqueue *virtio_find_single_vq(struct virtio_device *vdev,
149 vq_callback_t *c, const char *n)
150{
151 vq_callback_t *callbacks[] = { c };
152 const char *names[] = { n };
153 struct virtqueue *vq;
154 int err = vdev->config->find_vqs(vdev, 1, &vq, callbacks, names);
155 if (err < 0)
156 return ERR_PTR(err);
157 return vq;
158}
Rusty Russellec3d41c2007-10-22 11:03:36 +1000159#endif /* __KERNEL__ */
160#endif /* _LINUX_VIRTIO_CONFIG_H */