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/hw.h" 18 #include "net/net.h" 19 #include "hw/qdev.h" 20 #include "sysemu/sysemu.h" 21 #include "qemu/event_notifier.h" 22 #ifdef CONFIG_VIRTFS 23 #include "hw/virtio/virtio-9p.h" 24 #endif 25 26 /* from Linux's linux/virtio_config.h */ 27 28 /* Status byte for guest to report progress, and synchronize features. */ 29 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */ 30 #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1 31 /* We have found a driver for the device. */ 32 #define VIRTIO_CONFIG_S_DRIVER 2 33 /* Driver has used its parts of the config, and is happy */ 34 #define VIRTIO_CONFIG_S_DRIVER_OK 4 35 /* We've given up on this device. */ 36 #define VIRTIO_CONFIG_S_FAILED 0x80 37 38 /* Some virtio feature bits (currently bits 28 through 31) are reserved for the 39 * transport being used (eg. virtio_ring), the rest are per-device feature bits. */ 40 #define VIRTIO_TRANSPORT_F_START 28 41 #define VIRTIO_TRANSPORT_F_END 32 42 43 /* We notify when the ring is completely used, even if the guest is suppressing 44 * callbacks */ 45 #define VIRTIO_F_NOTIFY_ON_EMPTY 24 46 /* We support indirect buffer descriptors */ 47 #define VIRTIO_RING_F_INDIRECT_DESC 28 48 /* The Guest publishes the used index for which it expects an interrupt 49 * at the end of the avail ring. Host should ignore the avail->flags field. */ 50 /* The Host publishes the avail index for which it expects a kick 51 * at the end of the used ring. Guest should ignore the used->flags field. */ 52 #define VIRTIO_RING_F_EVENT_IDX 29 53 /* A guest should never accept this. It implies negotiation is broken. */ 54 #define VIRTIO_F_BAD_FEATURE 30 55 56 /* from Linux's linux/virtio_ring.h */ 57 58 /* This marks a buffer as continuing via the next field. */ 59 #define VRING_DESC_F_NEXT 1 60 /* This marks a buffer as write-only (otherwise read-only). */ 61 #define VRING_DESC_F_WRITE 2 62 /* This means the buffer contains a list of buffer descriptors. */ 63 #define VRING_DESC_F_INDIRECT 4 64 65 /* This means don't notify other side when buffer added. */ 66 #define VRING_USED_F_NO_NOTIFY 1 67 /* This means don't interrupt guest when buffer consumed. */ 68 #define VRING_AVAIL_F_NO_INTERRUPT 1 69 70 struct VirtQueue; 71 72 static inline hwaddr vring_align(hwaddr addr, 73 unsigned long align) 74 { 75 return (addr + align - 1) & ~(align - 1); 76 } 77 78 typedef struct VirtQueue VirtQueue; 79 80 #define VIRTQUEUE_MAX_SIZE 1024 81 82 typedef struct VirtQueueElement 83 { 84 unsigned int index; 85 unsigned int out_num; 86 unsigned int in_num; 87 hwaddr in_addr[VIRTQUEUE_MAX_SIZE]; 88 hwaddr out_addr[VIRTQUEUE_MAX_SIZE]; 89 struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; 90 struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; 91 } VirtQueueElement; 92 93 #define VIRTIO_PCI_QUEUE_MAX 64 94 95 #define VIRTIO_NO_VECTOR 0xffff 96 97 #define TYPE_VIRTIO_DEVICE "virtio-device" 98 #define VIRTIO_DEVICE_GET_CLASS(obj) \ 99 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE) 100 #define VIRTIO_DEVICE_CLASS(klass) \ 101 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE) 102 #define VIRTIO_DEVICE(obj) \ 103 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE) 104 105 struct VirtIODevice 106 { 107 DeviceState parent_obj; 108 const char *name; 109 uint8_t status; 110 uint8_t isr; 111 uint16_t queue_sel; 112 uint32_t guest_features; 113 size_t config_len; 114 void *config; 115 uint16_t config_vector; 116 int nvectors; 117 VirtQueue *vq; 118 uint16_t device_id; 119 bool vm_running; 120 VMChangeStateEntry *vmstate; 121 char *bus_name; 122 }; 123 124 typedef struct VirtioDeviceClass { 125 /* This is what a VirtioDevice must implement */ 126 DeviceClass parent; 127 int (*init)(VirtIODevice *vdev); 128 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features); 129 uint32_t (*bad_features)(VirtIODevice *vdev); 130 void (*set_features)(VirtIODevice *vdev, uint32_t val); 131 void (*get_config)(VirtIODevice *vdev, uint8_t *config); 132 void (*set_config)(VirtIODevice *vdev, const uint8_t *config); 133 void (*reset)(VirtIODevice *vdev); 134 void (*set_status)(VirtIODevice *vdev, uint8_t val); 135 /* Test and clear event pending status. 136 * Should be called after unmask to avoid losing events. 137 * If backend does not support masking, 138 * must check in frontend instead. 139 */ 140 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); 141 /* Mask/unmask events from this vq. Any events reported 142 * while masked will become pending. 143 * If backend does not support masking, 144 * must mask in frontend instead. 145 */ 146 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); 147 } VirtioDeviceClass; 148 149 void virtio_init(VirtIODevice *vdev, const char *name, 150 uint16_t device_id, size_t config_size); 151 void virtio_cleanup(VirtIODevice *vdev); 152 153 /* Set the child bus name. */ 154 void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); 155 156 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, 157 void (*handle_output)(VirtIODevice *, 158 VirtQueue *)); 159 160 void virtio_del_queue(VirtIODevice *vdev, int n); 161 162 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, 163 unsigned int len); 164 void virtqueue_flush(VirtQueue *vq, unsigned int count); 165 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, 166 unsigned int len, unsigned int idx); 167 168 void virtqueue_map_sg(struct iovec *sg, hwaddr *addr, 169 size_t num_sg, int is_write); 170 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem); 171 int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, 172 unsigned int out_bytes); 173 void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, 174 unsigned int *out_bytes, 175 unsigned max_in_bytes, unsigned max_out_bytes); 176 177 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); 178 179 void virtio_save(VirtIODevice *vdev, QEMUFile *f); 180 181 int virtio_load(VirtIODevice *vdev, QEMUFile *f); 182 183 void virtio_notify_config(VirtIODevice *vdev); 184 185 void virtio_queue_set_notification(VirtQueue *vq, int enable); 186 187 int virtio_queue_ready(VirtQueue *vq); 188 189 int virtio_queue_empty(VirtQueue *vq); 190 191 /* Host binding interface. */ 192 193 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); 194 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); 195 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); 196 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); 197 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); 198 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); 199 void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); 200 hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); 201 int virtio_queue_get_num(VirtIODevice *vdev, int n); 202 void virtio_queue_notify(VirtIODevice *vdev, int n); 203 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); 204 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); 205 void virtio_set_status(VirtIODevice *vdev, uint8_t val); 206 void virtio_reset(void *opaque); 207 void virtio_update_irq(VirtIODevice *vdev); 208 int virtio_set_features(VirtIODevice *vdev, uint32_t val); 209 210 /* Base devices. */ 211 typedef struct VirtIOBlkConf VirtIOBlkConf; 212 struct virtio_net_conf; 213 VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf, 214 struct virtio_net_conf *net, 215 uint32_t host_features); 216 typedef struct virtio_serial_conf virtio_serial_conf; 217 typedef struct VirtIOSCSIConf VirtIOSCSIConf; 218 typedef struct VirtIORNGConf VirtIORNGConf; 219 220 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ 221 DEFINE_PROP_BIT("indirect_desc", _state, _field, \ 222 VIRTIO_RING_F_INDIRECT_DESC, true), \ 223 DEFINE_PROP_BIT("event_idx", _state, _field, \ 224 VIRTIO_RING_F_EVENT_IDX, true) 225 226 hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); 227 hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); 228 hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); 229 hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); 230 hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); 231 hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); 232 hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); 233 hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n); 234 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); 235 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); 236 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); 237 uint16_t virtio_get_queue_index(VirtQueue *vq); 238 int virtio_queue_get_id(VirtQueue *vq); 239 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); 240 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, 241 bool with_irqfd); 242 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); 243 void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, 244 bool set_handler); 245 void virtio_queue_notify_vq(VirtQueue *vq); 246 void virtio_irq(VirtQueue *vq); 247 #endif 248