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