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