]>
Commit | Line | Data |
---|---|---|
967f97fa AL |
1 | /* |
2 | * Virtio Support | |
3 | * | |
4 | * Copyright IBM, Corp. 2007 | |
5 | * | |
6 | * Authors: | |
7 | * Anthony Liguori <[email protected]> | |
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 | ||
967f97fa | 17 | #include "hw.h" |
1422e32d | 18 | #include "net/net.h" |
53c25cea | 19 | #include "qdev.h" |
9c17d615 | 20 | #include "sysemu/sysemu.h" |
1de7afc9 | 21 | #include "qemu/event_notifier.h" |
9f107513 AL |
22 | #ifdef CONFIG_LINUX |
23 | #include "9p.h" | |
24 | #endif | |
967f97fa AL |
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 | ||
6d74ca5a MT |
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 | ||
d89c682f | 43 | /* We notify when the ring is completely used, even if the guest is suppressing |
967f97fa AL |
44 | * callbacks */ |
45 | #define VIRTIO_F_NOTIFY_ON_EMPTY 24 | |
efeea6d0 MM |
46 | /* We support indirect buffer descriptors */ |
47 | #define VIRTIO_RING_F_INDIRECT_DESC 28 | |
bcbabae8 MT |
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 | |
8eca6b1b AL |
53 | /* A guest should never accept this. It implies negotiation is broken. */ |
54 | #define VIRTIO_F_BAD_FEATURE 30 | |
967f97fa AL |
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 | |
efeea6d0 MM |
62 | /* This means the buffer contains a list of buffer descriptors. */ |
63 | #define VRING_DESC_F_INDIRECT 4 | |
967f97fa AL |
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 | ||
a8170e5e | 72 | static inline hwaddr vring_align(hwaddr addr, |
f46f15bc AL |
73 | unsigned long align) |
74 | { | |
75 | return (addr + align - 1) & ~(align - 1); | |
76 | } | |
77 | ||
967f97fa | 78 | typedef struct VirtQueue VirtQueue; |
967f97fa AL |
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; | |
a8170e5e AK |
87 | hwaddr in_addr[VIRTQUEUE_MAX_SIZE]; |
88 | hwaddr out_addr[VIRTQUEUE_MAX_SIZE]; | |
967f97fa AL |
89 | struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; |
90 | struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; | |
91 | } VirtQueueElement; | |
92 | ||
53c25cea | 93 | typedef struct { |
d2a0ccc6 MT |
94 | void (*notify)(DeviceState *d, uint16_t vector); |
95 | void (*save_config)(DeviceState *d, QEMUFile *f); | |
96 | void (*save_queue)(DeviceState *d, int n, QEMUFile *f); | |
97 | int (*load_config)(DeviceState *d, QEMUFile *f); | |
98 | int (*load_queue)(DeviceState *d, int n, QEMUFile *f); | |
99 | int (*load_done)(DeviceState *d, QEMUFile *f); | |
100 | unsigned (*get_features)(DeviceState *d); | |
101 | bool (*query_guest_notifiers)(DeviceState *d); | |
2d620f59 | 102 | int (*set_guest_notifiers)(DeviceState *d, int nvqs, bool assigned); |
d2a0ccc6 MT |
103 | int (*set_host_notifier)(DeviceState *d, int n, bool assigned); |
104 | void (*vmstate_change)(DeviceState *d, bool running); | |
53c25cea PB |
105 | } VirtIOBindings; |
106 | ||
bb61564c | 107 | #define VIRTIO_PCI_QUEUE_MAX 64 |
967f97fa | 108 | |
7055e687 MT |
109 | #define VIRTIO_NO_VECTOR 0xffff |
110 | ||
8e05db92 FK |
111 | #define TYPE_VIRTIO_DEVICE "virtio-device" |
112 | #define VIRTIO_DEVICE_GET_CLASS(obj) \ | |
113 | OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE) | |
114 | #define VIRTIO_DEVICE_CLASS(klass) \ | |
115 | OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE) | |
116 | #define VIRTIO_DEVICE(obj) \ | |
117 | OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE) | |
118 | ||
967f97fa AL |
119 | struct VirtIODevice |
120 | { | |
8e05db92 | 121 | DeviceState parent_obj; |
967f97fa | 122 | const char *name; |
967f97fa AL |
123 | uint8_t status; |
124 | uint8_t isr; | |
125 | uint16_t queue_sel; | |
704a76fc | 126 | uint32_t guest_features; |
967f97fa AL |
127 | size_t config_len; |
128 | void *config; | |
7055e687 MT |
129 | uint16_t config_vector; |
130 | int nvectors; | |
8e05db92 FK |
131 | /* |
132 | * Function pointers will be removed at the end of the series as they are in | |
133 | * VirtioDeviceClass. | |
134 | */ | |
8172539d | 135 | uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features); |
8eca6b1b | 136 | uint32_t (*bad_features)(VirtIODevice *vdev); |
967f97fa AL |
137 | void (*set_features)(VirtIODevice *vdev, uint32_t val); |
138 | void (*get_config)(VirtIODevice *vdev, uint8_t *config); | |
139 | void (*set_config)(VirtIODevice *vdev, const uint8_t *config); | |
140 | void (*reset)(VirtIODevice *vdev); | |
3e607cb5 | 141 | void (*set_status)(VirtIODevice *vdev, uint8_t val); |
f1d0f15a MT |
142 | /* Test and clear event pending status. |
143 | * Should be called after unmask to avoid losing events. | |
144 | * If backend does not support masking, | |
145 | * must check in frontend instead. | |
146 | */ | |
147 | bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); | |
148 | /* Mask/unmask events from this vq. Any events reported | |
149 | * while masked will become pending. | |
150 | * If backend does not support masking, | |
151 | * must mask in frontend instead. | |
152 | */ | |
153 | void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); | |
154 | ||
967f97fa | 155 | VirtQueue *vq; |
53c25cea | 156 | const VirtIOBindings *binding; |
d2a0ccc6 | 157 | DeviceState *binding_opaque; |
53c25cea | 158 | uint16_t device_id; |
85cf2a8d MT |
159 | bool vm_running; |
160 | VMChangeStateEntry *vmstate; | |
967f97fa AL |
161 | }; |
162 | ||
8e05db92 FK |
163 | typedef struct VirtioDeviceClass { |
164 | /* This is what a VirtioDevice must implement */ | |
165 | DeviceClass parent; | |
166 | int (*init)(VirtIODevice *vdev); | |
167 | uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features); | |
168 | uint32_t (*bad_features)(VirtIODevice *vdev); | |
169 | void (*set_features)(VirtIODevice *vdev, uint32_t val); | |
170 | void (*get_config)(VirtIODevice *vdev, uint8_t *config); | |
171 | void (*set_config)(VirtIODevice *vdev, const uint8_t *config); | |
172 | void (*reset)(VirtIODevice *vdev); | |
173 | void (*set_status)(VirtIODevice *vdev, uint8_t val); | |
174 | } VirtioDeviceClass; | |
175 | ||
176 | void virtio_init(VirtIODevice *vdev, const char *name, | |
177 | uint16_t device_id, size_t config_size); | |
178 | void virtio_common_cleanup(VirtIODevice *vdev); | |
179 | ||
967f97fa AL |
180 | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, |
181 | void (*handle_output)(VirtIODevice *, | |
182 | VirtQueue *)); | |
183 | ||
f23fd811 JW |
184 | void virtio_del_queue(VirtIODevice *vdev, int n); |
185 | ||
967f97fa AL |
186 | void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, |
187 | unsigned int len); | |
188 | void virtqueue_flush(VirtQueue *vq, unsigned int count); | |
189 | void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, | |
190 | unsigned int len, unsigned int idx); | |
191 | ||
a8170e5e | 192 | void virtqueue_map_sg(struct iovec *sg, hwaddr *addr, |
42fb2e07 | 193 | size_t num_sg, int is_write); |
967f97fa | 194 | int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem); |
0d8d7690 AS |
195 | int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, |
196 | unsigned int out_bytes); | |
197 | void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, | |
e1f7b481 MT |
198 | unsigned int *out_bytes, |
199 | unsigned max_in_bytes, unsigned max_out_bytes); | |
967f97fa AL |
200 | |
201 | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); | |
202 | ||
203 | void virtio_save(VirtIODevice *vdev, QEMUFile *f); | |
204 | ||
7055e687 | 205 | int virtio_load(VirtIODevice *vdev, QEMUFile *f); |
967f97fa | 206 | |
b946a153 AL |
207 | void virtio_cleanup(VirtIODevice *vdev); |
208 | ||
967f97fa AL |
209 | void virtio_notify_config(VirtIODevice *vdev); |
210 | ||
211 | void virtio_queue_set_notification(VirtQueue *vq, int enable); | |
212 | ||
213 | int virtio_queue_ready(VirtQueue *vq); | |
214 | ||
215 | int virtio_queue_empty(VirtQueue *vq); | |
216 | ||
53c25cea PB |
217 | /* Host binding interface. */ |
218 | ||
219 | VirtIODevice *virtio_common_init(const char *name, uint16_t device_id, | |
220 | size_t config_size, size_t struct_size); | |
221 | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); | |
222 | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); | |
223 | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); | |
224 | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
225 | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
226 | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
a8170e5e AK |
227 | void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); |
228 | hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); | |
53c25cea PB |
229 | int virtio_queue_get_num(VirtIODevice *vdev, int n); |
230 | void virtio_queue_notify(VirtIODevice *vdev, int n); | |
7055e687 MT |
231 | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); |
232 | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); | |
4e1837f8 | 233 | void virtio_set_status(VirtIODevice *vdev, uint8_t val); |
53c25cea PB |
234 | void virtio_reset(void *opaque); |
235 | void virtio_update_irq(VirtIODevice *vdev); | |
ad0c9332 | 236 | int virtio_set_features(VirtIODevice *vdev, uint32_t val); |
53c25cea PB |
237 | |
238 | void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding, | |
d2a0ccc6 | 239 | DeviceState *opaque); |
53c25cea PB |
240 | |
241 | /* Base devices. */ | |
12c5674b PB |
242 | typedef struct VirtIOBlkConf VirtIOBlkConf; |
243 | VirtIODevice *virtio_blk_init(DeviceState *dev, VirtIOBlkConf *blk); | |
f0c07c7c AW |
244 | struct virtio_net_conf; |
245 | VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf, | |
246 | struct virtio_net_conf *net); | |
6b331efb AS |
247 | typedef struct virtio_serial_conf virtio_serial_conf; |
248 | VirtIODevice *virtio_serial_init(DeviceState *dev, virtio_serial_conf *serial); | |
53c25cea | 249 | VirtIODevice *virtio_balloon_init(DeviceState *dev); |
973abc7f SH |
250 | typedef struct VirtIOSCSIConf VirtIOSCSIConf; |
251 | VirtIODevice *virtio_scsi_init(DeviceState *dev, VirtIOSCSIConf *conf); | |
16c915ba AS |
252 | typedef struct VirtIORNGConf VirtIORNGConf; |
253 | VirtIODevice *virtio_rng_init(DeviceState *dev, VirtIORNGConf *conf); | |
9f107513 AL |
254 | #ifdef CONFIG_LINUX |
255 | VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf); | |
256 | #endif | |
257 | ||
53c25cea | 258 | |
97b15621 | 259 | void virtio_net_exit(VirtIODevice *vdev); |
9d0d3138 | 260 | void virtio_blk_exit(VirtIODevice *vdev); |
8b53a865 | 261 | void virtio_serial_exit(VirtIODevice *vdev); |
855d7e25 | 262 | void virtio_balloon_exit(VirtIODevice *vdev); |
973abc7f | 263 | void virtio_scsi_exit(VirtIODevice *vdev); |
16c915ba | 264 | void virtio_rng_exit(VirtIODevice *vdev); |
97b15621 | 265 | |
8172539d MT |
266 | #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ |
267 | DEFINE_PROP_BIT("indirect_desc", _state, _field, \ | |
bcbabae8 MT |
268 | VIRTIO_RING_F_INDIRECT_DESC, true), \ |
269 | DEFINE_PROP_BIT("event_idx", _state, _field, \ | |
270 | VIRTIO_RING_F_EVENT_IDX, true) | |
8172539d | 271 | |
a8170e5e AK |
272 | hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); |
273 | hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); | |
274 | hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); | |
275 | hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); | |
276 | hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); | |
277 | hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); | |
278 | hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); | |
279 | hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n); | |
1cbdabe2 MT |
280 | uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); |
281 | void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); | |
282 | VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); | |
c80decdb | 283 | int virtio_queue_get_id(VirtQueue *vq); |
1cbdabe2 | 284 | EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); |
15b2bd18 PB |
285 | void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, |
286 | bool with_irqfd); | |
1cbdabe2 | 287 | EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); |
26b9b5fe PB |
288 | void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, |
289 | bool set_handler); | |
25db9ebe | 290 | void virtio_queue_notify_vq(VirtQueue *vq); |
1cbdabe2 | 291 | void virtio_irq(VirtQueue *vq); |
967f97fa | 292 | #endif |