hw/virtio.h

   1 /*
   2  * Virtio Support
   3  *
   4  * Copyright IBM, Corp. 2007
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  */
  13
  14 #ifndef _QEMU_VIRTIO_H
  15 #define _QEMU_VIRTIO_H
  16
  17 #include "hw.h"
  18 #include "net.h"
  19 #include "qdev.h"
  20 #include "sysemu.h"
  21 #include "block_int.h"
  22 #include "event_notifier.h"
  23
  24 /* from Linux's linux/virtio_config.h */
  25
  26 /* Status byte for guest to report progress, and synchronize features. */
  27 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
  28 #define VIRTIO_CONFIG_S_ACKNOWLEDGE     1
  29 /* We have found a driver for the device. */
  30 #define VIRTIO_CONFIG_S_DRIVER          2
  31 /* Driver has used its parts of the config, and is happy */
  32 #define VIRTIO_CONFIG_S_DRIVER_OK       4
  33 /* We've given up on this device. */
  34 #define VIRTIO_CONFIG_S_FAILED          0x80
  35
  36 /* Some virtio feature bits (currently bits 28 through 31) are reserved for the
  37  * transport being used (eg. virtio_ring), the rest are per-device feature bits. */
  38 #define VIRTIO_TRANSPORT_F_START        28
  39 #define VIRTIO_TRANSPORT_F_END          32
  40
  41 /* We notify when the ring is completely used, even if the guest is suppressing
  42  * callbacks */
  43 #define VIRTIO_F_NOTIFY_ON_EMPTY        24
  44 /* We support indirect buffer descriptors */
  45 #define VIRTIO_RING_F_INDIRECT_DESC     28
  46 /* A guest should never accept this.  It implies negotiation is broken. */
  47 #define VIRTIO_F_BAD_FEATURE            30
  48
  49 /* from Linux's linux/virtio_ring.h */
  50
  51 /* This marks a buffer as continuing via the next field. */
  52 #define VRING_DESC_F_NEXT       1
  53 /* This marks a buffer as write-only (otherwise read-only). */
  54 #define VRING_DESC_F_WRITE      2
  55 /* This means the buffer contains a list of buffer descriptors. */
  56 #define VRING_DESC_F_INDIRECT  4
  57
  58 /* This means don't notify other side when buffer added. */
  59 #define VRING_USED_F_NO_NOTIFY  1
  60 /* This means don't interrupt guest when buffer consumed. */
  61 #define VRING_AVAIL_F_NO_INTERRUPT      1
  62
  63 struct VirtQueue;
  64
  65 static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
  66                                              unsigned long align)
  67 {
  68     return (addr + align - 1) & ~(align - 1);
  69 }
  70
  71 typedef struct VirtQueue VirtQueue;
  72 typedef struct VirtIODevice VirtIODevice;
  73
  74 #define VIRTQUEUE_MAX_SIZE 1024
  75
  76 typedef struct VirtQueueElement
  77 {
  78     unsigned int index;
  79     unsigned int out_num;
  80     unsigned int in_num;
  81     target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
  82     struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
  83     struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
  84 } VirtQueueElement;
  85
  86 typedef struct {
  87     void (*notify)(void * opaque, uint16_t vector);
  88     void (*save_config)(void * opaque, QEMUFile *f);
  89     void (*save_queue)(void * opaque, int n, QEMUFile *f);
  90     int (*load_config)(void * opaque, QEMUFile *f);
  91     int (*load_queue)(void * opaque, int n, QEMUFile *f);
  92     unsigned (*get_features)(void * opaque);
  93     int (*set_guest_notifier)(void * opaque, int n, bool assigned);
  94     int (*set_host_notifier)(void * opaque, int n, bool assigned);
  95 } VirtIOBindings;
  96
  97 #define VIRTIO_PCI_QUEUE_MAX 64
  98
  99 #define VIRTIO_NO_VECTOR 0xffff
 100
 101 struct VirtIODevice
 102 {
 103     const char *name;
 104     uint8_t status;
 105     uint8_t isr;
 106     uint16_t queue_sel;
 107     uint32_t guest_features;
 108     size_t config_len;
 109     void *config;
 110     uint16_t config_vector;
 111     int nvectors;
 112     uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
 113     uint32_t (*bad_features)(VirtIODevice *vdev);
 114     void (*set_features)(VirtIODevice *vdev, uint32_t val);
 115     void (*get_config)(VirtIODevice *vdev, uint8_t *config);
 116     void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
 117     void (*reset)(VirtIODevice *vdev);
 118     VirtQueue *vq;
 119     const VirtIOBindings *binding;
 120     void *binding_opaque;
 121     uint16_t device_id;
 122 };
 123
 124 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
 125                             void (*handle_output)(VirtIODevice *,
 126                                                   VirtQueue *));
 127
 128 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
 129                     unsigned int len);
 130 void virtqueue_flush(VirtQueue *vq, unsigned int count);
 131 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
 132                     unsigned int len, unsigned int idx);
 133
 134 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
 135 int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
 136
 137 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
 138
 139 void virtio_save(VirtIODevice *vdev, QEMUFile *f);
 140
 141 int virtio_load(VirtIODevice *vdev, QEMUFile *f);
 142
 143 void virtio_cleanup(VirtIODevice *vdev);
 144
 145 void virtio_notify_config(VirtIODevice *vdev);
 146
 147 void virtio_queue_set_notification(VirtQueue *vq, int enable);
 148
 149 int virtio_queue_ready(VirtQueue *vq);
 150
 151 int virtio_queue_empty(VirtQueue *vq);
 152
 153 /* Host binding interface.  */
 154
 155 VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
 156                                  size_t config_size, size_t struct_size);
 157 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
 158 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
 159 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
 160 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
 161 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
 162 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
 163 void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
 164 target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
 165 int virtio_queue_get_num(VirtIODevice *vdev, int n);
 166 void virtio_queue_notify(VirtIODevice *vdev, int n);
 167 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
 168 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
 169 void virtio_reset(void *opaque);
 170 void virtio_update_irq(VirtIODevice *vdev);
 171
 172 void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
 173                         void *opaque);
 174
 175 /* Base devices.  */
 176 VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf);
 177 VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf);
 178 VirtIODevice *virtio_serial_init(DeviceState *dev, uint32_t max_nr_ports);
 179 VirtIODevice *virtio_balloon_init(DeviceState *dev);
 180
 181 void virtio_net_exit(VirtIODevice *vdev);
 182
 183 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
 184         DEFINE_PROP_BIT("indirect_desc", _state, _field, \
 185                         VIRTIO_RING_F_INDIRECT_DESC, true)
 186
 187 target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
 188 target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
 189 target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
 190 target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
 191 target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
 192 target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
 193 target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
 194 target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
 195 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
 196 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
 197 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
 198 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
 199 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
 200 void virtio_irq(VirtQueue *vq);
 201 #endif