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 #include "standard-headers/linux/virtio_config.h" 23 #include "standard-headers/linux/virtio_ring.h" 24 25 /* A guest should never accept this. It implies negotiation is broken. */ 26 #define VIRTIO_F_BAD_FEATURE 30 27 28 struct VirtQueue; 29 30 static inline hwaddr vring_align(hwaddr addr, 31 unsigned long align) 32 { 33 return (addr + align - 1) & ~(align - 1); 34 } 35 36 typedef struct VirtQueue VirtQueue; 37 38 #define VIRTQUEUE_MAX_SIZE 1024 39 40 typedef struct VirtQueueElement 41 { 42 unsigned int index; 43 unsigned int out_num; 44 unsigned int in_num; 45 hwaddr in_addr[VIRTQUEUE_MAX_SIZE]; 46 hwaddr out_addr[VIRTQUEUE_MAX_SIZE]; 47 struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; 48 struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; 49 } VirtQueueElement; 50 51 #define VIRTIO_PCI_QUEUE_MAX 64 52 53 #define VIRTIO_NO_VECTOR 0xffff 54 55 #define TYPE_VIRTIO_DEVICE "virtio-device" 56 #define VIRTIO_DEVICE_GET_CLASS(obj) \ 57 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE) 58 #define VIRTIO_DEVICE_CLASS(klass) \ 59 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE) 60 #define VIRTIO_DEVICE(obj) \ 61 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE) 62 63 enum virtio_device_endian { 64 VIRTIO_DEVICE_ENDIAN_UNKNOWN, 65 VIRTIO_DEVICE_ENDIAN_LITTLE, 66 VIRTIO_DEVICE_ENDIAN_BIG, 67 }; 68 69 struct VirtIODevice 70 { 71 DeviceState parent_obj; 72 const char *name; 73 uint8_t status; 74 uint8_t isr; 75 uint16_t queue_sel; 76 uint32_t guest_features; 77 size_t config_len; 78 void *config; 79 uint16_t config_vector; 80 int nvectors; 81 VirtQueue *vq; 82 uint16_t device_id; 83 bool vm_running; 84 VMChangeStateEntry *vmstate; 85 char *bus_name; 86 uint8_t device_endian; 87 QLIST_HEAD(, VirtQueue) *vector_queues; 88 }; 89 90 typedef struct VirtioDeviceClass { 91 /*< private >*/ 92 DeviceClass parent; 93 /*< public >*/ 94 95 /* This is what a VirtioDevice must implement */ 96 DeviceRealize realize; 97 DeviceUnrealize unrealize; 98 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features); 99 uint32_t (*bad_features)(VirtIODevice *vdev); 100 void (*set_features)(VirtIODevice *vdev, uint32_t val); 101 void (*get_config)(VirtIODevice *vdev, uint8_t *config); 102 void (*set_config)(VirtIODevice *vdev, const uint8_t *config); 103 void (*reset)(VirtIODevice *vdev); 104 void (*set_status)(VirtIODevice *vdev, uint8_t val); 105 /* Test and clear event pending status. 106 * Should be called after unmask to avoid losing events. 107 * If backend does not support masking, 108 * must check in frontend instead. 109 */ 110 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); 111 /* Mask/unmask events from this vq. Any events reported 112 * while masked will become pending. 113 * If backend does not support masking, 114 * must mask in frontend instead. 115 */ 116 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); 117 void (*save)(VirtIODevice *vdev, QEMUFile *f); 118 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id); 119 } VirtioDeviceClass; 120 121 void virtio_instance_init_common(Object *proxy_obj, void *data, 122 size_t vdev_size, const char *vdev_name); 123 124 void virtio_init(VirtIODevice *vdev, const char *name, 125 uint16_t device_id, size_t config_size); 126 void virtio_cleanup(VirtIODevice *vdev); 127 128 /* Set the child bus name. */ 129 void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); 130 131 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, 132 void (*handle_output)(VirtIODevice *, 133 VirtQueue *)); 134 135 void virtio_del_queue(VirtIODevice *vdev, int n); 136 137 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, 138 unsigned int len); 139 void virtqueue_flush(VirtQueue *vq, unsigned int count); 140 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, 141 unsigned int len, unsigned int idx); 142 143 void virtqueue_map_sg(struct iovec *sg, hwaddr *addr, 144 size_t num_sg, int is_write); 145 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem); 146 int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, 147 unsigned int out_bytes); 148 void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, 149 unsigned int *out_bytes, 150 unsigned max_in_bytes, unsigned max_out_bytes); 151 152 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); 153 154 void virtio_save(VirtIODevice *vdev, QEMUFile *f); 155 156 int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); 157 158 void virtio_notify_config(VirtIODevice *vdev); 159 160 void virtio_queue_set_notification(VirtQueue *vq, int enable); 161 162 int virtio_queue_ready(VirtQueue *vq); 163 164 int virtio_queue_empty(VirtQueue *vq); 165 166 /* Host binding interface. */ 167 168 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); 169 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); 170 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); 171 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); 172 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); 173 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); 174 void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); 175 hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); 176 void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); 177 int virtio_queue_get_num(VirtIODevice *vdev, int n); 178 void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); 179 void virtio_queue_notify(VirtIODevice *vdev, int n); 180 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); 181 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); 182 void virtio_set_status(VirtIODevice *vdev, uint8_t val); 183 void virtio_reset(void *opaque); 184 void virtio_update_irq(VirtIODevice *vdev); 185 int virtio_set_features(VirtIODevice *vdev, uint32_t val); 186 187 /* Base devices. */ 188 typedef struct VirtIOBlkConf VirtIOBlkConf; 189 struct virtio_net_conf; 190 typedef struct virtio_serial_conf virtio_serial_conf; 191 typedef struct VirtIOSCSIConf VirtIOSCSIConf; 192 typedef struct VirtIORNGConf VirtIORNGConf; 193 194 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ 195 DEFINE_PROP_BIT("indirect_desc", _state, _field, \ 196 VIRTIO_RING_F_INDIRECT_DESC, true), \ 197 DEFINE_PROP_BIT("event_idx", _state, _field, \ 198 VIRTIO_RING_F_EVENT_IDX, true) 199 200 hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); 201 hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); 202 hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); 203 hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); 204 hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); 205 hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); 206 hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); 207 hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n); 208 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); 209 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); 210 void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); 211 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); 212 uint16_t virtio_get_queue_index(VirtQueue *vq); 213 int virtio_queue_get_id(VirtQueue *vq); 214 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); 215 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, 216 bool with_irqfd); 217 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); 218 void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, 219 bool set_handler); 220 void virtio_queue_notify_vq(VirtQueue *vq); 221 void virtio_irq(VirtQueue *vq); 222 VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); 223 VirtQueue *virtio_vector_next_queue(VirtQueue *vq); 224 225 static inline void virtio_add_feature(uint32_t *features, unsigned int fbit) 226 { 227 assert(fbit < 32); 228 *features |= (1 << fbit); 229 } 230 231 static inline void virtio_clear_feature(uint32_t *features, unsigned int fbit) 232 { 233 assert(fbit < 32); 234 *features &= ~(1 << fbit); 235 } 236 237 static inline bool __virtio_has_feature(uint32_t features, unsigned int fbit) 238 { 239 assert(fbit < 32); 240 return !!(features & (1 << fbit)); 241 } 242 243 static inline bool virtio_has_feature(VirtIODevice *vdev, unsigned int fbit) 244 { 245 return __virtio_has_feature(vdev->guest_features, fbit); 246 } 247 248 static inline bool virtio_is_big_endian(VirtIODevice *vdev) 249 { 250 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN); 251 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG; 252 } 253 #endif 254