]>
Commit | Line | Data |
---|---|---|
967f97fa AL |
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 | ||
83c9f4ca | 17 | #include "hw/hw.h" |
1422e32d | 18 | #include "net/net.h" |
83c9f4ca | 19 | #include "hw/qdev.h" |
9c17d615 | 20 | #include "sysemu/sysemu.h" |
1de7afc9 | 21 | #include "qemu/event_notifier.h" |
e9600c6c MT |
22 | #include "standard-headers/linux/virtio_config.h" |
23 | #include "standard-headers/linux/virtio_ring.h" | |
967f97fa | 24 | |
8eca6b1b AL |
25 | /* A guest should never accept this. It implies negotiation is broken. */ |
26 | #define VIRTIO_F_BAD_FEATURE 30 | |
967f97fa | 27 | |
5f456073 MT |
28 | #define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) | \ |
29 | (0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | \ | |
30 | (0x1ULL << VIRTIO_F_ANY_LAYOUT)) | |
31 | ||
967f97fa AL |
32 | struct VirtQueue; |
33 | ||
a8170e5e | 34 | static inline hwaddr vring_align(hwaddr addr, |
f46f15bc AL |
35 | unsigned long align) |
36 | { | |
37 | return (addr + align - 1) & ~(align - 1); | |
38 | } | |
39 | ||
967f97fa | 40 | typedef struct VirtQueue VirtQueue; |
967f97fa AL |
41 | |
42 | #define VIRTQUEUE_MAX_SIZE 1024 | |
43 | ||
44 | typedef struct VirtQueueElement | |
45 | { | |
46 | unsigned int index; | |
47 | unsigned int out_num; | |
48 | unsigned int in_num; | |
a8170e5e AK |
49 | hwaddr in_addr[VIRTQUEUE_MAX_SIZE]; |
50 | hwaddr out_addr[VIRTQUEUE_MAX_SIZE]; | |
967f97fa AL |
51 | struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; |
52 | struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; | |
53 | } VirtQueueElement; | |
54 | ||
b829c2a9 | 55 | #define VIRTIO_QUEUE_MAX 1024 |
967f97fa | 56 | |
7055e687 MT |
57 | #define VIRTIO_NO_VECTOR 0xffff |
58 | ||
8e05db92 FK |
59 | #define TYPE_VIRTIO_DEVICE "virtio-device" |
60 | #define VIRTIO_DEVICE_GET_CLASS(obj) \ | |
61 | OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE) | |
62 | #define VIRTIO_DEVICE_CLASS(klass) \ | |
63 | OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE) | |
64 | #define VIRTIO_DEVICE(obj) \ | |
65 | OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE) | |
66 | ||
616a6552 GK |
67 | enum virtio_device_endian { |
68 | VIRTIO_DEVICE_ENDIAN_UNKNOWN, | |
69 | VIRTIO_DEVICE_ENDIAN_LITTLE, | |
70 | VIRTIO_DEVICE_ENDIAN_BIG, | |
71 | }; | |
72 | ||
967f97fa AL |
73 | struct VirtIODevice |
74 | { | |
8e05db92 | 75 | DeviceState parent_obj; |
967f97fa | 76 | const char *name; |
967f97fa AL |
77 | uint8_t status; |
78 | uint8_t isr; | |
79 | uint16_t queue_sel; | |
019a3edb GH |
80 | uint64_t guest_features; |
81 | uint64_t host_features; | |
967f97fa AL |
82 | size_t config_len; |
83 | void *config; | |
7055e687 | 84 | uint16_t config_vector; |
b8f05908 | 85 | uint32_t generation; |
7055e687 | 86 | int nvectors; |
967f97fa | 87 | VirtQueue *vq; |
53c25cea | 88 | uint16_t device_id; |
85cf2a8d MT |
89 | bool vm_running; |
90 | VMChangeStateEntry *vmstate; | |
1034e9cf | 91 | char *bus_name; |
616a6552 | 92 | uint8_t device_endian; |
850d0070 | 93 | QLIST_HEAD(, VirtQueue) *vector_queues; |
967f97fa AL |
94 | }; |
95 | ||
8e05db92 | 96 | typedef struct VirtioDeviceClass { |
0ba94b6f | 97 | /*< private >*/ |
8e05db92 | 98 | DeviceClass parent; |
0ba94b6f | 99 | /*< public >*/ |
1d244b42 AF |
100 | |
101 | /* This is what a VirtioDevice must implement */ | |
1d244b42 | 102 | DeviceRealize realize; |
306ec6c3 | 103 | DeviceUnrealize unrealize; |
019a3edb GH |
104 | uint64_t (*get_features)(VirtIODevice *vdev, uint64_t requested_features); |
105 | uint64_t (*bad_features)(VirtIODevice *vdev); | |
d5aaa1b0 | 106 | void (*set_features)(VirtIODevice *vdev, uint64_t val); |
0b352fd6 | 107 | int (*validate_features)(VirtIODevice *vdev); |
8e05db92 FK |
108 | void (*get_config)(VirtIODevice *vdev, uint8_t *config); |
109 | void (*set_config)(VirtIODevice *vdev, const uint8_t *config); | |
110 | void (*reset)(VirtIODevice *vdev); | |
111 | void (*set_status)(VirtIODevice *vdev, uint8_t val); | |
6a87acf7 FK |
112 | /* Test and clear event pending status. |
113 | * Should be called after unmask to avoid losing events. | |
114 | * If backend does not support masking, | |
115 | * must check in frontend instead. | |
116 | */ | |
117 | bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); | |
118 | /* Mask/unmask events from this vq. Any events reported | |
119 | * while masked will become pending. | |
120 | * If backend does not support masking, | |
121 | * must mask in frontend instead. | |
122 | */ | |
123 | void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); | |
1b5fc0de GK |
124 | void (*save)(VirtIODevice *vdev, QEMUFile *f); |
125 | int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id); | |
8e05db92 FK |
126 | } VirtioDeviceClass; |
127 | ||
c8075caf GA |
128 | void virtio_instance_init_common(Object *proxy_obj, void *data, |
129 | size_t vdev_size, const char *vdev_name); | |
130 | ||
8e05db92 FK |
131 | void virtio_init(VirtIODevice *vdev, const char *name, |
132 | uint16_t device_id, size_t config_size); | |
6a1a8cc7 | 133 | void virtio_cleanup(VirtIODevice *vdev); |
8e05db92 | 134 | |
1034e9cf FK |
135 | /* Set the child bus name. */ |
136 | void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); | |
137 | ||
967f97fa AL |
138 | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, |
139 | void (*handle_output)(VirtIODevice *, | |
140 | VirtQueue *)); | |
141 | ||
f23fd811 JW |
142 | void virtio_del_queue(VirtIODevice *vdev, int n); |
143 | ||
967f97fa AL |
144 | void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, |
145 | unsigned int len); | |
146 | void virtqueue_flush(VirtQueue *vq, unsigned int count); | |
147 | void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, | |
148 | unsigned int len, unsigned int idx); | |
149 | ||
a8170e5e | 150 | void virtqueue_map_sg(struct iovec *sg, hwaddr *addr, |
42fb2e07 | 151 | size_t num_sg, int is_write); |
967f97fa | 152 | int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem); |
0d8d7690 AS |
153 | int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, |
154 | unsigned int out_bytes); | |
155 | void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, | |
e1f7b481 MT |
156 | unsigned int *out_bytes, |
157 | unsigned max_in_bytes, unsigned max_out_bytes); | |
967f97fa AL |
158 | |
159 | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); | |
160 | ||
161 | void virtio_save(VirtIODevice *vdev, QEMUFile *f); | |
162 | ||
1b5fc0de | 163 | int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); |
967f97fa AL |
164 | |
165 | void virtio_notify_config(VirtIODevice *vdev); | |
166 | ||
167 | void virtio_queue_set_notification(VirtQueue *vq, int enable); | |
168 | ||
169 | int virtio_queue_ready(VirtQueue *vq); | |
170 | ||
171 | int virtio_queue_empty(VirtQueue *vq); | |
172 | ||
53c25cea PB |
173 | /* Host binding interface. */ |
174 | ||
53c25cea PB |
175 | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); |
176 | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); | |
177 | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); | |
178 | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
179 | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
180 | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
adfb743c MT |
181 | uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr); |
182 | uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr); | |
183 | uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr); | |
184 | void virtio_config_modern_writeb(VirtIODevice *vdev, | |
185 | uint32_t addr, uint32_t data); | |
186 | void virtio_config_modern_writew(VirtIODevice *vdev, | |
187 | uint32_t addr, uint32_t data); | |
188 | void virtio_config_modern_writel(VirtIODevice *vdev, | |
189 | uint32_t addr, uint32_t data); | |
a8170e5e AK |
190 | void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); |
191 | hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); | |
e63c0ba1 | 192 | void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); |
53c25cea | 193 | int virtio_queue_get_num(VirtIODevice *vdev, int n); |
8ad176aa | 194 | int virtio_get_num_queues(VirtIODevice *vdev); |
ab223c95 CH |
195 | void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc, |
196 | hwaddr avail, hwaddr used); | |
197 | void virtio_queue_update_rings(VirtIODevice *vdev, int n); | |
6ce69d1c | 198 | void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); |
53c25cea | 199 | void virtio_queue_notify(VirtIODevice *vdev, int n); |
7055e687 MT |
200 | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); |
201 | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); | |
0b352fd6 | 202 | int virtio_set_status(VirtIODevice *vdev, uint8_t val); |
53c25cea PB |
203 | void virtio_reset(void *opaque); |
204 | void virtio_update_irq(VirtIODevice *vdev); | |
d5aaa1b0 | 205 | int virtio_set_features(VirtIODevice *vdev, uint64_t val); |
53c25cea | 206 | |
53c25cea | 207 | /* Base devices. */ |
12c5674b | 208 | typedef struct VirtIOBlkConf VirtIOBlkConf; |
f0c07c7c | 209 | struct virtio_net_conf; |
6b331efb | 210 | typedef struct virtio_serial_conf virtio_serial_conf; |
f73ddbad | 211 | typedef struct virtio_input_conf virtio_input_conf; |
973abc7f | 212 | typedef struct VirtIOSCSIConf VirtIOSCSIConf; |
16c915ba | 213 | typedef struct VirtIORNGConf VirtIORNGConf; |
97b15621 | 214 | |
8172539d | 215 | #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ |
019a3edb GH |
216 | DEFINE_PROP_BIT64("indirect_desc", _state, _field, \ |
217 | VIRTIO_RING_F_INDIRECT_DESC, true), \ | |
218 | DEFINE_PROP_BIT64("event_idx", _state, _field, \ | |
219 | VIRTIO_RING_F_EVENT_IDX, true), \ | |
220 | DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \ | |
09999a5f MT |
221 | VIRTIO_F_NOTIFY_ON_EMPTY, true), \ |
222 | DEFINE_PROP_BIT64("any_layout", _state, _field, \ | |
223 | VIRTIO_F_ANY_LAYOUT, true) | |
8172539d | 224 | |
a8170e5e AK |
225 | hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); |
226 | hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); | |
227 | hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); | |
228 | hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); | |
229 | hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); | |
230 | hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); | |
231 | hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); | |
232 | hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n); | |
1cbdabe2 MT |
233 | uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); |
234 | void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); | |
6793dfd1 | 235 | void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); |
1cbdabe2 | 236 | VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); |
e78a2b42 | 237 | uint16_t virtio_get_queue_index(VirtQueue *vq); |
c80decdb | 238 | int virtio_queue_get_id(VirtQueue *vq); |
1cbdabe2 | 239 | EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); |
15b2bd18 PB |
240 | void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, |
241 | bool with_irqfd); | |
1cbdabe2 | 242 | EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); |
26b9b5fe PB |
243 | void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, |
244 | bool set_handler); | |
25db9ebe | 245 | void virtio_queue_notify_vq(VirtQueue *vq); |
1cbdabe2 | 246 | void virtio_irq(VirtQueue *vq); |
e0d686bf JW |
247 | VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); |
248 | VirtQueue *virtio_vector_next_queue(VirtQueue *vq); | |
98ed8ecf | 249 | |
019a3edb | 250 | static inline void virtio_add_feature(uint64_t *features, unsigned int fbit) |
0cd09c3a | 251 | { |
019a3edb | 252 | assert(fbit < 64); |
d5aaa1b0 | 253 | *features |= (1ULL << fbit); |
0cd09c3a CH |
254 | } |
255 | ||
019a3edb | 256 | static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit) |
0cd09c3a | 257 | { |
019a3edb | 258 | assert(fbit < 64); |
d5aaa1b0 | 259 | *features &= ~(1ULL << fbit); |
0cd09c3a CH |
260 | } |
261 | ||
019a3edb | 262 | static inline bool __virtio_has_feature(uint64_t features, unsigned int fbit) |
ef546f12 | 263 | { |
019a3edb | 264 | assert(fbit < 64); |
d5aaa1b0 | 265 | return !!(features & (1ULL << fbit)); |
ef546f12 CH |
266 | } |
267 | ||
268 | static inline bool virtio_has_feature(VirtIODevice *vdev, unsigned int fbit) | |
269 | { | |
270 | return __virtio_has_feature(vdev->guest_features, fbit); | |
271 | } | |
272 | ||
616a6552 | 273 | static inline bool virtio_is_big_endian(VirtIODevice *vdev) |
98ed8ecf | 274 | { |
3c185597 CH |
275 | if (!virtio_has_feature(vdev, VIRTIO_F_VERSION_1)) { |
276 | assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN); | |
277 | return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG; | |
278 | } | |
279 | /* Devices conforming to VIRTIO 1.0 or later are always LE. */ | |
280 | return false; | |
98ed8ecf | 281 | } |
967f97fa | 282 | #endif |