]> git.proxmox.com Git - mirror_qemu.git/blame - include/hw/virtio/virtio.h
projects / mirror_qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
virtio: add subsections to the migration stream
[mirror_qemu.git] / include / hw / virtio / virtio.h
CommitLineData
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"
7e6b14df 22#ifdef CONFIG_VIRTFS
0d09e41a 23#include "hw/virtio/virtio-9p.h"
9f107513 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
488f069b
MT		 46/* Can the device handle any descriptor layout? */
47#define VIRTIO_F_ANY_LAYOUT 27
efeea6d0
MM		 48/* We support indirect buffer descriptors */
49#define VIRTIO_RING_F_INDIRECT_DESC 28
bcbabae8
MT		 50/* The Guest publishes the used index for which it expects an interrupt
51 * at the end of the avail ring. Host should ignore the avail->flags field. */
52/* The Host publishes the avail index for which it expects a kick
53 * at the end of the used ring. Guest should ignore the used->flags field. */
54#define VIRTIO_RING_F_EVENT_IDX 29
8eca6b1b
AL		 55/* A guest should never accept this. It implies negotiation is broken. */
56#define VIRTIO_F_BAD_FEATURE 30
967f97fa
AL		 57
58/* from Linux's linux/virtio_ring.h */
59
60/* This marks a buffer as continuing via the next field. */
61#define VRING_DESC_F_NEXT 1
62/* This marks a buffer as write-only (otherwise read-only). */
63#define VRING_DESC_F_WRITE 2
efeea6d0
MM		 64/* This means the buffer contains a list of buffer descriptors. */
65#define VRING_DESC_F_INDIRECT 4
967f97fa
AL		 66
67/* This means don't notify other side when buffer added. */
68#define VRING_USED_F_NO_NOTIFY 1
69/* This means don't interrupt guest when buffer consumed. */
70#define VRING_AVAIL_F_NO_INTERRUPT 1
71
72struct VirtQueue;
73
a8170e5e 74static inline hwaddr vring_align(hwaddr addr,
f46f15bc
AL		 75 unsigned long align)
76{
77 return (addr + align - 1) & ~(align - 1);
78}
79
967f97fa 80typedef struct VirtQueue VirtQueue;
967f97fa
AL		 81
82#define VIRTQUEUE_MAX_SIZE 1024
83
84typedef struct VirtQueueElement
85{
86 unsigned int index;
87 unsigned int out_num;
88 unsigned int in_num;
a8170e5e
AK		 89 hwaddr in_addr[VIRTQUEUE_MAX_SIZE];
90 hwaddr out_addr[VIRTQUEUE_MAX_SIZE];
967f97fa
AL		 91 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
92 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
93} VirtQueueElement;
94
bb61564c 95#define VIRTIO_PCI_QUEUE_MAX 64
967f97fa 96
7055e687
MT		 97#define VIRTIO_NO_VECTOR 0xffff
98
8e05db92
FK		 99#define TYPE_VIRTIO_DEVICE "virtio-device"
100#define VIRTIO_DEVICE_GET_CLASS(obj) \
101 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
102#define VIRTIO_DEVICE_CLASS(klass) \
103 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
104#define VIRTIO_DEVICE(obj) \
105 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)
106
967f97fa
AL		 107struct VirtIODevice
108{
8e05db92 109 DeviceState parent_obj;
967f97fa 110 const char *name;
967f97fa
AL		 111 uint8_t status;
112 uint8_t isr;
113 uint16_t queue_sel;
704a76fc 114 uint32_t guest_features;
967f97fa
AL		 115 size_t config_len;
116 void *config;
7055e687
MT		 117 uint16_t config_vector;
118 int nvectors;
967f97fa 119 VirtQueue *vq;
53c25cea 120 uint16_t device_id;
85cf2a8d
MT		 121 bool vm_running;
122 VMChangeStateEntry *vmstate;
1034e9cf 123 char *bus_name;
967f97fa
AL		 124};
125
8e05db92 126typedef struct VirtioDeviceClass {
0ba94b6f 127 /*< private >*/
8e05db92 128 DeviceClass parent;
0ba94b6f 129 /*< public >*/
1d244b42
AF		 130
131 /* This is what a VirtioDevice must implement */
1d244b42 132 DeviceRealize realize;
306ec6c3 133 DeviceUnrealize unrealize;
8e05db92
FK		 134 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
135 uint32_t (*bad_features)(VirtIODevice *vdev);
136 void (*set_features)(VirtIODevice *vdev, uint32_t val);
137 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
138 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
139 void (*reset)(VirtIODevice *vdev);
140 void (*set_status)(VirtIODevice *vdev, uint8_t val);
6a87acf7
FK		 141 /* Test and clear event pending status.
142 * Should be called after unmask to avoid losing events.
143 * If backend does not support masking,
144 * must check in frontend instead.
145 */
146 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
147 /* Mask/unmask events from this vq. Any events reported
148 * while masked will become pending.
149 * If backend does not support masking,
150 * must mask in frontend instead.
151 */
152 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
1b5fc0de
GK		 153 void (*save)(VirtIODevice *vdev, QEMUFile *f);
154 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
8e05db92
FK		 155} VirtioDeviceClass;
156
157void virtio_init(VirtIODevice *vdev, const char *name,
158 uint16_t device_id, size_t config_size);
6a1a8cc7 159void virtio_cleanup(VirtIODevice *vdev);
8e05db92 160
1034e9cf
FK		 161/* Set the child bus name. */
162void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
163
967f97fa
AL		 164VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
165 void (*handle_output)(VirtIODevice *,
166 VirtQueue *));
167
f23fd811
JW		 168void virtio_del_queue(VirtIODevice *vdev, int n);
169
967f97fa
AL		 170void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
171 unsigned int len);
172void virtqueue_flush(VirtQueue *vq, unsigned int count);
173void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
174 unsigned int len, unsigned int idx);
175
a8170e5e 176void virtqueue_map_sg(struct iovec *sg, hwaddr *addr,
42fb2e07 177 size_t num_sg, int is_write);
967f97fa 178int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
0d8d7690
AS		 179int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
180 unsigned int out_bytes);
181void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
e1f7b481
MT		 182 unsigned int *out_bytes,
183 unsigned max_in_bytes, unsigned max_out_bytes);
967f97fa
AL		 184
185void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
186
187void virtio_save(VirtIODevice *vdev, QEMUFile *f);
188
1b5fc0de 189int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
967f97fa
AL		 190
191void virtio_notify_config(VirtIODevice *vdev);
192
193void virtio_queue_set_notification(VirtQueue *vq, int enable);
194
195int virtio_queue_ready(VirtQueue *vq);
196
197int virtio_queue_empty(VirtQueue *vq);
198
53c25cea
PB		 199/* Host binding interface. */
200
53c25cea
PB		 201uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
202uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
203uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
204void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
205void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
206void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
a8170e5e
AK		 207void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
208hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
e63c0ba1 209void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
53c25cea 210int virtio_queue_get_num(VirtIODevice *vdev, int n);
6ce69d1c 211void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
53c25cea 212void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687
MT		 213uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
214void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
4e1837f8 215void virtio_set_status(VirtIODevice *vdev, uint8_t val);
53c25cea
PB		 216void virtio_reset(void *opaque);
217void virtio_update_irq(VirtIODevice *vdev);
ad0c9332 218int virtio_set_features(VirtIODevice *vdev, uint32_t val);
53c25cea 219
53c25cea 220/* Base devices. */
12c5674b 221typedef struct VirtIOBlkConf VirtIOBlkConf;
f0c07c7c
AW		 222struct virtio_net_conf;
223VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
1e89ad5b
AL		 224 struct virtio_net_conf *net,
225 uint32_t host_features);
6b331efb 226typedef struct virtio_serial_conf virtio_serial_conf;
973abc7f 227typedef struct VirtIOSCSIConf VirtIOSCSIConf;
16c915ba 228typedef struct VirtIORNGConf VirtIORNGConf;
97b15621 229
8172539d
MT		 230#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
231 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
bcbabae8
MT		 232 VIRTIO_RING_F_INDIRECT_DESC, true), \
233 DEFINE_PROP_BIT("event_idx", _state, _field, \
234 VIRTIO_RING_F_EVENT_IDX, true)
8172539d 235
a8170e5e
AK		 236hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
237hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
238hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
239hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
240hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
241hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
242hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
243hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
1cbdabe2
MT		 244uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
245void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
6793dfd1 246void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
1cbdabe2 247VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
e78a2b42 248uint16_t virtio_get_queue_index(VirtQueue *vq);
c80decdb 249int virtio_queue_get_id(VirtQueue *vq);
1cbdabe2 250EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
15b2bd18
PB		 251void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
252 bool with_irqfd);
1cbdabe2 253EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
26b9b5fe
PB		 254void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
255 bool set_handler);
25db9ebe 256void virtio_queue_notify_vq(VirtQueue *vq);
1cbdabe2 257void virtio_irq(VirtQueue *vq);
967f97fa 258#endif
QEMU mirror