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
  11 /**
  12  * virtqueue - a queue to register buffers for sending or receiving.
  13  * @list: the chain of virtqueues for this device
  14  * @callback: the function to call when buffers are consumed (can be NULL).
  15  * @name: the name of this virtqueue (mainly for debugging)
  16  * @vdev: the virtio device this queue was created for.
  17  * @vq_ops: the operations for this virtqueue (see below).
  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         struct virtqueue_ops *vq_ops;
  26         void *priv;
  27 };
  28
  29 /**
  30  * virtqueue_ops - operations for virtqueue abstraction layer
  31  * @add_buf: expose buffer to other end
  32  *      vq: the struct virtqueue we're talking about.
  33  *      sg: the description of the buffer(s).
  34  *      out_num: the number of sg readable by other side
  35  *      in_num: the number of sg which are writable (after readable ones)
  36  *      data: the token identifying the buffer.
  37  *      Returns remaining capacity of queue (sg segments) or a negative error.
  38  * @kick: update after add_buf
  39  *      vq: the struct virtqueue
  40  *      After one or more add_buf calls, invoke this to kick the other side.
  41  * @get_buf: get the next used buffer
  42  *      vq: the struct virtqueue we're talking about.
  43  *      len: the length written into the buffer
  44  *      Returns NULL or the "data" token handed to add_buf.
  45  * @disable_cb: disable callbacks
  46  *      vq: the struct virtqueue we're talking about.
  47  *      Note that this is not necessarily synchronous, hence unreliable and only
  48  *      useful as an optimization.
  49  * @enable_cb: restart callbacks after disable_cb.
  50  *      vq: the struct virtqueue we're talking about.
  51  *      This re-enables callbacks; it returns "false" if there are pending
  52  *      buffers in the queue, to detect a possible race between the driver
  53  *      checking for more work, and enabling callbacks.
  54  * @detach_unused_buf: detach first unused buffer
  55  *      vq: the struct virtqueue we're talking about.
  56  *      Returns NULL or the "data" token handed to add_buf
  57  *
  58  * Locking rules are straightforward: the driver is responsible for
  59  * locking.  No two operations may be invoked simultaneously, with the exception
  60  * of @disable_cb.
  61  *
  62  * All operations can be called in any context.
  63  */
  64 struct virtqueue_ops {
  65         int (*add_buf)(struct virtqueue *vq,
  66                        struct scatterlist sg[],
  67                        unsigned int out_num,
  68                        unsigned int in_num,
  69                        void *data);
  70
  71         void (*kick)(struct virtqueue *vq);
  72
  73         void *(*get_buf)(struct virtqueue *vq, unsigned int *len);
  74
  75         void (*disable_cb)(struct virtqueue *vq);
  76         bool (*enable_cb)(struct virtqueue *vq);
  77         void *(*detach_unused_buf)(struct virtqueue *vq);
  78 };
  79
  80 static inline int virtqueue_add_buf(struct virtqueue *vq,
  81                                     struct scatterlist sg[],
  82                                     unsigned int out_num,
  83                                     unsigned int in_num,
  84                                     void *data)
  85 {
  86         return vq->vq_ops->add_buf(vq, sg, out_num, in_num, data);
  87 }
  88
  89 static inline int void virtqueue_kick(struct virtqueue *vq)
  90 {
  91         return vq->vq_ops->kick(vq);
  92 }
  93
  94 static inline void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len)
  95 {
  96         return vq->vq_ops->get_buf(vq, len);
  97 }
  98
  99 static inline void virtqueue_disable_cb(struct virtqueue *vq)
 100 {
 101         vq->vq_ops->disable_cb(vq);
 102 }
 103
 104 static inline bool virtqueue_enable_cb(struct virtqueue *vq)
 105 {
 106         return vq->vq_ops->enable_cb(vq);
 107 }
 108
 109 static inline void *virtqueue_detach_unused_buf(struct virtqueue *vq)
 110 {
 111         return vq->vq_ops->detach_unused_buf(vq);
 112 }
 113
 114 /**
 115  * virtio_device - representation of a device using virtio
 116  * @index: unique position on the virtio bus
 117  * @dev: underlying device.
 118  * @id: the device type identification (used to match it with a driver).
 119  * @config: the configuration ops for this device.
 120  * @vqs: the list of virtqueues for this device.
 121  * @features: the features supported by both driver and device.
 122  * @priv: private pointer for the driver's use.
 123  */
 124 struct virtio_device {
 125         int index;
 126         struct device dev;
 127         struct virtio_device_id id;
 128         struct virtio_config_ops *config;
 129         struct list_head vqs;
 130         /* Note that this is a Linux set_bit-style bitmap. */
 131         unsigned long features[1];
 132         void *priv;
 133 };
 134
 135 #define dev_to_virtio(dev) container_of(dev, struct virtio_device, dev)
 136 int register_virtio_device(struct virtio_device *dev);
 137 void unregister_virtio_device(struct virtio_device *dev);
 138
 139 /**
 140  * virtio_driver - operations for a virtio I/O driver
 141  * @driver: underlying device driver (populate name and owner).
 142  * @id_table: the ids serviced by this driver.
 143  * @feature_table: an array of feature numbers supported by this device.
 144  * @feature_table_size: number of entries in the feature table array.
 145  * @probe: the function to call when a device is found.  Returns 0 or -errno.
 146  * @remove: the function when a device is removed.
 147  * @config_changed: optional function to call when the device configuration
 148  *    changes; may be called in interrupt context.
 149  */
 150 struct virtio_driver {
 151         struct device_driver driver;
 152         const struct virtio_device_id *id_table;
 153         const unsigned int *feature_table;
 154         unsigned int feature_table_size;
 155         int (*probe)(struct virtio_device *dev);
 156         void (*remove)(struct virtio_device *dev);
 157         void (*config_changed)(struct virtio_device *dev);
 158 };
 159
 160 int register_virtio_driver(struct virtio_driver *drv);
 161 void unregister_virtio_driver(struct virtio_driver *drv);
 162 #endif /* _LINUX_VIRTIO_H */