Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 1 | #ifndef _LINUX_VIRTIO_CONFIG_H |
| 2 | #define _LINUX_VIRTIO_CONFIG_H |
Rusty Russell | 674bfc2 | 2008-07-25 12:06:03 -0500 | [diff] [blame] | 3 | |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 4 | #include <linux/err.h> |
Paul Gortmaker | 187f188 | 2011-11-23 20:12:59 -0500 | [diff] [blame] | 5 | #include <linux/bug.h> |
Rusty Russell | 72e61eb | 2008-05-02 21:50:49 -0500 | [diff] [blame] | 6 | #include <linux/virtio.h> |
David Howells | 607ca46 | 2012-10-13 10:46:48 +0100 | [diff] [blame^] | 7 | #include <uapi/linux/virtio_config.h> |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 8 | |
| 9 | /** |
| 10 | * virtio_config_ops - operations for configuring a virtio device |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 11 | * @get: read the value of a configuration field |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 12 | * vdev: the virtio_device |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 13 | * offset: the offset of the configuration field |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 14 | * buf: the buffer to write the field value into. |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 15 | * len: the length of the buffer |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 16 | * @set: write the value of a configuration field |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 17 | * vdev: the virtio_device |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 18 | * offset: the offset of the configuration field |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 19 | * buf: the buffer to read the field value from. |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 20 | * len: the length of the buffer |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 21 | * @get_status: read the status byte |
| 22 | * vdev: the virtio_device |
| 23 | * Returns the status byte |
| 24 | * @set_status: write the status byte |
| 25 | * vdev: the virtio_device |
| 26 | * status: the new status byte |
Rusty Russell | 6e5aa7e | 2008-02-04 23:50:03 -0500 | [diff] [blame] | 27 | * @reset: reset the device |
| 28 | * vdev: the virtio device |
| 29 | * After this, status and feature negotiation must be done again |
Michael S. Tsirkin | e6af578 | 2011-11-17 17:41:15 +0200 | [diff] [blame] | 30 | * Device must not be reset from its vq/config callbacks, or in |
| 31 | * parallel with being added/removed. |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 32 | * @find_vqs: find virtqueues and instantiate them. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 33 | * vdev: the virtio_device |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 34 | * nvqs: the number of virtqueues to find |
| 35 | * vqs: on success, includes new virtqueues |
| 36 | * callbacks: array of callbacks, for each virtqueue |
Michael S. Tsirkin | 6457f12 | 2012-09-05 21:47:45 +0300 | [diff] [blame] | 37 | * include a NULL entry for vqs that do not need a callback |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 38 | * names: array of virtqueue names (mainly for debugging) |
Michael S. Tsirkin | 6457f12 | 2012-09-05 21:47:45 +0300 | [diff] [blame] | 39 | * include a NULL entry for vqs unused by driver |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 40 | * Returns 0 on success or error status |
| 41 | * @del_vqs: free virtqueues found by find_vqs(). |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 42 | * @get_features: get the array of feature bits for this device. |
| 43 | * vdev: the virtio_device |
| 44 | * Returns the first 32 feature bits (all we currently need). |
Rusty Russell | c624896 | 2008-07-25 12:06:07 -0500 | [diff] [blame] | 45 | * @finalize_features: confirm what device features we'll be using. |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 46 | * vdev: the virtio_device |
Rusty Russell | c624896 | 2008-07-25 12:06:07 -0500 | [diff] [blame] | 47 | * This gives the final feature bits for the device: it can change |
| 48 | * the dev->feature bits if it wants. |
Rick Jones | 6684604 | 2011-11-14 14:17:08 +0000 | [diff] [blame] | 49 | * @bus_name: return the bus name associated with the device |
| 50 | * vdev: the virtio_device |
| 51 | * This returns a pointer to the bus name a la pci_name from which |
| 52 | * the caller can then copy. |
Jason Wang | 75a0a52 | 2012-08-28 13:54:14 +0200 | [diff] [blame] | 53 | * @set_vq_affinity: set the affinity for a virtqueue. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 54 | */ |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 55 | typedef void vq_callback_t(struct virtqueue *); |
Rusty Russell | 1842f23 | 2009-07-30 16:03:46 -0600 | [diff] [blame] | 56 | struct virtio_config_ops { |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 57 | void (*get)(struct virtio_device *vdev, unsigned offset, |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 58 | void *buf, unsigned len); |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 59 | void (*set)(struct virtio_device *vdev, unsigned offset, |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 60 | const void *buf, unsigned len); |
| 61 | u8 (*get_status)(struct virtio_device *vdev); |
| 62 | void (*set_status)(struct virtio_device *vdev, u8 status); |
Rusty Russell | 6e5aa7e | 2008-02-04 23:50:03 -0500 | [diff] [blame] | 63 | void (*reset)(struct virtio_device *vdev); |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 64 | int (*find_vqs)(struct virtio_device *, unsigned nvqs, |
| 65 | struct virtqueue *vqs[], |
| 66 | vq_callback_t *callbacks[], |
| 67 | const char *names[]); |
| 68 | void (*del_vqs)(struct virtio_device *); |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 69 | u32 (*get_features)(struct virtio_device *vdev); |
Rusty Russell | c624896 | 2008-07-25 12:06:07 -0500 | [diff] [blame] | 70 | void (*finalize_features)(struct virtio_device *vdev); |
Rick Jones | 6684604 | 2011-11-14 14:17:08 +0000 | [diff] [blame] | 71 | const char *(*bus_name)(struct virtio_device *vdev); |
Jason Wang | 75a0a52 | 2012-08-28 13:54:14 +0200 | [diff] [blame] | 72 | int (*set_vq_affinity)(struct virtqueue *vq, int cpu); |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 73 | }; |
| 74 | |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 75 | /* If driver didn't advertise the feature, it will never appear. */ |
| 76 | void virtio_check_driver_offered_feature(const struct virtio_device *vdev, |
| 77 | unsigned int fbit); |
| 78 | |
| 79 | /** |
| 80 | * virtio_has_feature - helper to determine if this device has this feature. |
| 81 | * @vdev: the device |
| 82 | * @fbit: the feature bit |
| 83 | */ |
| 84 | static inline bool virtio_has_feature(const struct virtio_device *vdev, |
| 85 | unsigned int fbit) |
| 86 | { |
| 87 | /* Did you forget to fix assumptions on max features? */ |
Rusty Russell | 1765e3a | 2011-01-24 14:45:10 -0600 | [diff] [blame] | 88 | if (__builtin_constant_p(fbit)) |
| 89 | BUILD_BUG_ON(fbit >= 32); |
| 90 | else |
| 91 | BUG_ON(fbit >= 32); |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 92 | |
Mark McLoughlin | ee006b3 | 2009-05-11 18:11:44 +0100 | [diff] [blame] | 93 | if (fbit < VIRTIO_TRANSPORT_F_START) |
| 94 | virtio_check_driver_offered_feature(vdev, fbit); |
| 95 | |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 96 | return test_bit(fbit, vdev->features); |
| 97 | } |
| 98 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 99 | /** |
Rusty Russell | 72e61eb | 2008-05-02 21:50:49 -0500 | [diff] [blame] | 100 | * virtio_config_val - look for a feature and get a virtio config entry. |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 101 | * @vdev: the virtio device |
| 102 | * @fbit: the feature bit |
| 103 | * @offset: the type to search for. |
Chen Baozi | c619080 | 2012-05-20 10:44:34 +0800 | [diff] [blame] | 104 | * @v: a pointer to the value to fill in. |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 105 | * |
Rusty Russell | a586d4f | 2008-02-04 23:49:56 -0500 | [diff] [blame] | 106 | * The return value is -ENOENT if the feature doesn't exist. Otherwise |
Rusty Russell | 72e61eb | 2008-05-02 21:50:49 -0500 | [diff] [blame] | 107 | * the config value is copied into whatever is pointed to by v. */ |
| 108 | #define virtio_config_val(vdev, fbit, offset, v) \ |
Christian Borntraeger | 7f31fe0 | 2008-05-29 11:08:01 +0200 | [diff] [blame] | 109 | virtio_config_buf((vdev), (fbit), (offset), (v), sizeof(*v)) |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 110 | |
Sasha Levin | 3ead6f4 | 2011-08-14 17:52:32 +0300 | [diff] [blame] | 111 | #define virtio_config_val_len(vdev, fbit, offset, v, len) \ |
| 112 | virtio_config_buf((vdev), (fbit), (offset), (v), (len)) |
| 113 | |
Rusty Russell | 72e61eb | 2008-05-02 21:50:49 -0500 | [diff] [blame] | 114 | static inline int virtio_config_buf(struct virtio_device *vdev, |
| 115 | unsigned int fbit, |
| 116 | unsigned int offset, |
| 117 | void *buf, unsigned len) |
| 118 | { |
Rusty Russell | c45a681 | 2008-05-02 21:50:50 -0500 | [diff] [blame] | 119 | if (!virtio_has_feature(vdev, fbit)) |
Rusty Russell | 72e61eb | 2008-05-02 21:50:49 -0500 | [diff] [blame] | 120 | return -ENOENT; |
| 121 | |
| 122 | vdev->config->get(vdev, offset, buf, len); |
| 123 | return 0; |
| 124 | } |
Michael S. Tsirkin | d2a7ddd | 2009-06-12 22:16:36 -0600 | [diff] [blame] | 125 | |
| 126 | static inline |
| 127 | struct virtqueue *virtio_find_single_vq(struct virtio_device *vdev, |
| 128 | vq_callback_t *c, const char *n) |
| 129 | { |
| 130 | vq_callback_t *callbacks[] = { c }; |
| 131 | const char *names[] = { n }; |
| 132 | struct virtqueue *vq; |
| 133 | int err = vdev->config->find_vqs(vdev, 1, &vq, callbacks, names); |
| 134 | if (err < 0) |
| 135 | return ERR_PTR(err); |
| 136 | return vq; |
| 137 | } |
Rick Jones | 6684604 | 2011-11-14 14:17:08 +0000 | [diff] [blame] | 138 | |
| 139 | static inline |
| 140 | const char *virtio_bus_name(struct virtio_device *vdev) |
| 141 | { |
| 142 | if (!vdev->config->bus_name) |
| 143 | return "virtio"; |
| 144 | return vdev->config->bus_name(vdev); |
| 145 | } |
| 146 | |
Jason Wang | 75a0a52 | 2012-08-28 13:54:14 +0200 | [diff] [blame] | 147 | /** |
| 148 | * virtqueue_set_affinity - setting affinity for a virtqueue |
| 149 | * @vq: the virtqueue |
| 150 | * @cpu: the cpu no. |
| 151 | * |
| 152 | * Pay attention the function are best-effort: the affinity hint may not be set |
| 153 | * due to config support, irq type and sharing. |
| 154 | * |
| 155 | */ |
| 156 | static inline |
| 157 | int virtqueue_set_affinity(struct virtqueue *vq, int cpu) |
| 158 | { |
| 159 | struct virtio_device *vdev = vq->vdev; |
| 160 | if (vdev->config->set_vq_affinity) |
| 161 | return vdev->config->set_vq_affinity(vq, cpu); |
| 162 | return 0; |
| 163 | } |
| 164 | |
| 165 | |
Rusty Russell | ec3d41c | 2007-10-22 11:03:36 +1000 | [diff] [blame] | 166 | #endif /* _LINUX_VIRTIO_CONFIG_H */ |