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