aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 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 | |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 17 | #include "hw.h" |
Gerd Hoffmann | 97b1562 | 2009-10-21 15:25:35 +0200 | [diff] [blame] | 18 | #include "net.h" |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 19 | #include "qdev.h" |
Gerd Hoffmann | d176c49 | 2009-07-31 12:25:41 +0200 | [diff] [blame] | 20 | #include "sysemu.h" |
Christoph Hellwig | 428c149 | 2010-02-10 23:37:09 +0100 | [diff] [blame] | 21 | #include "block_int.h" |
Michael S. Tsirkin | 1cbdabe | 2010-03-17 13:08:02 +0200 | [diff] [blame] | 22 | #include "event_notifier.h" |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 23 | |
| 24 | /* from Linux's linux/virtio_config.h */ |
| 25 | |
| 26 | /* Status byte for guest to report progress, and synchronize features. */ |
| 27 | /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */ |
| 28 | #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1 |
| 29 | /* We have found a driver for the device. */ |
| 30 | #define VIRTIO_CONFIG_S_DRIVER 2 |
| 31 | /* Driver has used its parts of the config, and is happy */ |
| 32 | #define VIRTIO_CONFIG_S_DRIVER_OK 4 |
| 33 | /* We've given up on this device. */ |
| 34 | #define VIRTIO_CONFIG_S_FAILED 0x80 |
| 35 | |
Michael S. Tsirkin | 6d74ca5 | 2009-12-08 20:07:48 +0200 | [diff] [blame] | 36 | /* Some virtio feature bits (currently bits 28 through 31) are reserved for the |
| 37 | * transport being used (eg. virtio_ring), the rest are per-device feature bits. */ |
| 38 | #define VIRTIO_TRANSPORT_F_START 28 |
| 39 | #define VIRTIO_TRANSPORT_F_END 32 |
| 40 | |
Stefan Weil | d89c682 | 2009-09-24 17:53:10 +0200 | [diff] [blame] | 41 | /* We notify when the ring is completely used, even if the guest is suppressing |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 42 | * callbacks */ |
| 43 | #define VIRTIO_F_NOTIFY_ON_EMPTY 24 |
Mark McLoughlin | efeea6d | 2009-06-17 11:38:28 +0100 | [diff] [blame] | 44 | /* We support indirect buffer descriptors */ |
| 45 | #define VIRTIO_RING_F_INDIRECT_DESC 28 |
aliguori | 8eca6b1 | 2009-04-05 17:40:08 +0000 | [diff] [blame] | 46 | /* A guest should never accept this. It implies negotiation is broken. */ |
| 47 | #define VIRTIO_F_BAD_FEATURE 30 |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 48 | |
| 49 | /* from Linux's linux/virtio_ring.h */ |
| 50 | |
| 51 | /* This marks a buffer as continuing via the next field. */ |
| 52 | #define VRING_DESC_F_NEXT 1 |
| 53 | /* This marks a buffer as write-only (otherwise read-only). */ |
| 54 | #define VRING_DESC_F_WRITE 2 |
Mark McLoughlin | efeea6d | 2009-06-17 11:38:28 +0100 | [diff] [blame] | 55 | /* This means the buffer contains a list of buffer descriptors. */ |
| 56 | #define VRING_DESC_F_INDIRECT 4 |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 57 | |
| 58 | /* This means don't notify other side when buffer added. */ |
| 59 | #define VRING_USED_F_NO_NOTIFY 1 |
| 60 | /* This means don't interrupt guest when buffer consumed. */ |
| 61 | #define VRING_AVAIL_F_NO_INTERRUPT 1 |
| 62 | |
| 63 | struct VirtQueue; |
| 64 | |
Anthony Liguori | c227f09 | 2009-10-01 16:12:16 -0500 | [diff] [blame] | 65 | static inline target_phys_addr_t vring_align(target_phys_addr_t addr, |
aliguori | f46f15b | 2008-12-04 19:58:45 +0000 | [diff] [blame] | 66 | unsigned long align) |
| 67 | { |
| 68 | return (addr + align - 1) & ~(align - 1); |
| 69 | } |
| 70 | |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 71 | typedef struct VirtQueue VirtQueue; |
| 72 | typedef struct VirtIODevice VirtIODevice; |
| 73 | |
| 74 | #define VIRTQUEUE_MAX_SIZE 1024 |
| 75 | |
| 76 | typedef struct VirtQueueElement |
| 77 | { |
| 78 | unsigned int index; |
| 79 | unsigned int out_num; |
| 80 | unsigned int in_num; |
Anthony Liguori | c227f09 | 2009-10-01 16:12:16 -0500 | [diff] [blame] | 81 | target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE]; |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 82 | struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; |
| 83 | struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; |
| 84 | } VirtQueueElement; |
| 85 | |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 86 | typedef struct { |
Michael S. Tsirkin | 7055e68 | 2009-06-21 19:50:13 +0300 | [diff] [blame] | 87 | void (*notify)(void * opaque, uint16_t vector); |
Michael S. Tsirkin | ff24bd5 | 2009-06-21 19:50:40 +0300 | [diff] [blame] | 88 | void (*save_config)(void * opaque, QEMUFile *f); |
| 89 | void (*save_queue)(void * opaque, int n, QEMUFile *f); |
| 90 | int (*load_config)(void * opaque, QEMUFile *f); |
| 91 | int (*load_queue)(void * opaque, int n, QEMUFile *f); |
Michael S. Tsirkin | 6d74ca5 | 2009-12-08 20:07:48 +0200 | [diff] [blame] | 92 | unsigned (*get_features)(void * opaque); |
Michael S. Tsirkin | 1cbdabe | 2010-03-17 13:08:02 +0200 | [diff] [blame] | 93 | int (*set_guest_notifier)(void * opaque, int n, bool assigned); |
| 94 | int (*set_host_notifier)(void * opaque, int n, bool assigned); |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 95 | } VirtIOBindings; |
| 96 | |
Amit Shah | bb61564 | 2010-01-20 00:36:51 +0530 | [diff] [blame] | 97 | #define VIRTIO_PCI_QUEUE_MAX 64 |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 98 | |
Michael S. Tsirkin | 7055e68 | 2009-06-21 19:50:13 +0300 | [diff] [blame] | 99 | #define VIRTIO_NO_VECTOR 0xffff |
| 100 | |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 101 | struct VirtIODevice |
| 102 | { |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 103 | const char *name; |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 104 | uint8_t status; |
| 105 | uint8_t isr; |
| 106 | uint16_t queue_sel; |
Michael S. Tsirkin | 704a76f | 2010-01-10 13:52:47 +0200 | [diff] [blame] | 107 | uint32_t guest_features; |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 108 | size_t config_len; |
| 109 | void *config; |
Michael S. Tsirkin | 7055e68 | 2009-06-21 19:50:13 +0300 | [diff] [blame] | 110 | uint16_t config_vector; |
| 111 | int nvectors; |
Michael S. Tsirkin | 8172539 | 2010-01-10 13:52:53 +0200 | [diff] [blame] | 112 | uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features); |
aliguori | 8eca6b1 | 2009-04-05 17:40:08 +0000 | [diff] [blame] | 113 | uint32_t (*bad_features)(VirtIODevice *vdev); |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 114 | void (*set_features)(VirtIODevice *vdev, uint32_t val); |
| 115 | void (*get_config)(VirtIODevice *vdev, uint8_t *config); |
| 116 | void (*set_config)(VirtIODevice *vdev, const uint8_t *config); |
| 117 | void (*reset)(VirtIODevice *vdev); |
Michael S. Tsirkin | 3e607cb | 2010-03-17 13:08:05 +0200 | [diff] [blame^] | 118 | void (*set_status)(VirtIODevice *vdev, uint8_t val); |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 119 | VirtQueue *vq; |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 120 | const VirtIOBindings *binding; |
| 121 | void *binding_opaque; |
| 122 | uint16_t device_id; |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 123 | }; |
| 124 | |
Michael S. Tsirkin | 3e607cb | 2010-03-17 13:08:05 +0200 | [diff] [blame^] | 125 | static inline void virtio_set_status(VirtIODevice *vdev, uint8_t val) |
| 126 | { |
| 127 | if (vdev->set_status) { |
| 128 | vdev->set_status(vdev, val); |
| 129 | } |
| 130 | vdev->status = val; |
| 131 | } |
| 132 | |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 133 | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, |
| 134 | void (*handle_output)(VirtIODevice *, |
| 135 | VirtQueue *)); |
| 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 | int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem); |
| 144 | int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes); |
| 145 | |
| 146 | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); |
| 147 | |
| 148 | void virtio_save(VirtIODevice *vdev, QEMUFile *f); |
| 149 | |
Michael S. Tsirkin | 7055e68 | 2009-06-21 19:50:13 +0300 | [diff] [blame] | 150 | int virtio_load(VirtIODevice *vdev, QEMUFile *f); |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 151 | |
aliguori | b946a15 | 2009-04-17 17:11:08 +0000 | [diff] [blame] | 152 | void virtio_cleanup(VirtIODevice *vdev); |
| 153 | |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 154 | void virtio_notify_config(VirtIODevice *vdev); |
| 155 | |
| 156 | void virtio_queue_set_notification(VirtQueue *vq, int enable); |
| 157 | |
| 158 | int virtio_queue_ready(VirtQueue *vq); |
| 159 | |
| 160 | int virtio_queue_empty(VirtQueue *vq); |
| 161 | |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 162 | /* Host binding interface. */ |
| 163 | |
| 164 | VirtIODevice *virtio_common_init(const char *name, uint16_t device_id, |
| 165 | size_t config_size, size_t struct_size); |
| 166 | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); |
| 167 | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); |
| 168 | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); |
| 169 | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); |
| 170 | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); |
| 171 | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); |
Anthony Liguori | c227f09 | 2009-10-01 16:12:16 -0500 | [diff] [blame] | 172 | void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr); |
| 173 | target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n); |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 174 | int virtio_queue_get_num(VirtIODevice *vdev, int n); |
| 175 | void virtio_queue_notify(VirtIODevice *vdev, int n); |
Michael S. Tsirkin | 7055e68 | 2009-06-21 19:50:13 +0300 | [diff] [blame] | 176 | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); |
| 177 | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 178 | void virtio_reset(void *opaque); |
| 179 | void virtio_update_irq(VirtIODevice *vdev); |
| 180 | |
| 181 | void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding, |
| 182 | void *opaque); |
| 183 | |
| 184 | /* Base devices. */ |
Christoph Hellwig | 428c149 | 2010-02-10 23:37:09 +0100 | [diff] [blame] | 185 | VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf); |
Gerd Hoffmann | 97b1562 | 2009-10-21 15:25:35 +0200 | [diff] [blame] | 186 | VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf); |
Amit Shah | 98b1925 | 2010-01-20 00:36:52 +0530 | [diff] [blame] | 187 | VirtIODevice *virtio_serial_init(DeviceState *dev, uint32_t max_nr_ports); |
Paul Brook | 53c25ce | 2009-05-18 14:51:59 +0100 | [diff] [blame] | 188 | VirtIODevice *virtio_balloon_init(DeviceState *dev); |
| 189 | |
Gerd Hoffmann | 97b1562 | 2009-10-21 15:25:35 +0200 | [diff] [blame] | 190 | void virtio_net_exit(VirtIODevice *vdev); |
| 191 | |
Michael S. Tsirkin | 8172539 | 2010-01-10 13:52:53 +0200 | [diff] [blame] | 192 | #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ |
| 193 | DEFINE_PROP_BIT("indirect_desc", _state, _field, \ |
| 194 | VIRTIO_RING_F_INDIRECT_DESC, true) |
| 195 | |
Michael S. Tsirkin | 1cbdabe | 2010-03-17 13:08:02 +0200 | [diff] [blame] | 196 | target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); |
| 197 | target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); |
| 198 | target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n); |
| 199 | target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); |
| 200 | target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n); |
| 201 | target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n); |
| 202 | target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n); |
| 203 | target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n); |
| 204 | uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); |
| 205 | void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); |
| 206 | VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); |
| 207 | EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); |
| 208 | EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); |
| 209 | void virtio_irq(VirtQueue *vq); |
aliguori | 967f97f | 2008-12-04 19:38:57 +0000 | [diff] [blame] | 210 | #endif |