4 * Copyright IBM, Corp. 2007
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
14 #ifndef _QEMU_VIRTIO_H
15 #define _QEMU_VIRTIO_H
22 #include "event_notifier.h"
26 #define VIRTIO_ID_GL 6
28 /* from Linux's linux/virtio_config.h */
30 /* Status byte for guest to report progress, and synchronize features. */
31 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
32 #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
33 /* We have found a driver for the device. */
34 #define VIRTIO_CONFIG_S_DRIVER 2
35 /* Driver has used its parts of the config, and is happy */
36 #define VIRTIO_CONFIG_S_DRIVER_OK 4
37 /* We've given up on this device. */
38 #define VIRTIO_CONFIG_S_FAILED 0x80
40 /* Some virtio feature bits (currently bits 28 through 31) are reserved for the
41 * transport being used (eg. virtio_ring), the rest are per-device feature bits. */
42 #define VIRTIO_TRANSPORT_F_START 28
43 #define VIRTIO_TRANSPORT_F_END 32
45 /* We notify when the ring is completely used, even if the guest is suppressing
47 #define VIRTIO_F_NOTIFY_ON_EMPTY 24
48 /* We support indirect buffer descriptors */
49 #define VIRTIO_RING_F_INDIRECT_DESC 28
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
55 /* A guest should never accept this. It implies negotiation is broken. */
56 #define VIRTIO_F_BAD_FEATURE 30
58 /* from Linux's linux/virtio_ring.h */
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
64 /* This means the buffer contains a list of buffer descriptors. */
65 #define VRING_DESC_F_INDIRECT 4
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
74 static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
77 return (addr + align - 1) & ~(align - 1);
80 typedef struct VirtQueue VirtQueue;
82 #define VIRTQUEUE_MAX_SIZE 1024
84 typedef struct VirtQueueElement
89 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
90 target_phys_addr_t out_addr[VIRTQUEUE_MAX_SIZE];
91 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
92 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
96 void (*notify)(void * opaque, uint16_t vector);
97 void (*save_config)(void * opaque, QEMUFile *f);
98 void (*save_queue)(void * opaque, int n, QEMUFile *f);
99 int (*load_config)(void * opaque, QEMUFile *f);
100 int (*load_queue)(void * opaque, int n, QEMUFile *f);
101 int (*load_done)(void * opaque, QEMUFile *f);
102 unsigned (*get_features)(void * opaque);
103 bool (*query_guest_notifiers)(void * opaque);
104 int (*set_guest_notifiers)(void * opaque, bool assigned);
105 int (*set_host_notifier)(void * opaque, int n, bool assigned);
106 void (*vmstate_change)(void * opaque, bool running);
109 #define VIRTIO_PCI_QUEUE_MAX 64
111 #define VIRTIO_NO_VECTOR 0xffff
119 uint32_t guest_features;
122 uint16_t config_vector;
124 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
125 uint32_t (*bad_features)(VirtIODevice *vdev);
126 void (*set_features)(VirtIODevice *vdev, uint32_t val);
127 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
128 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
129 void (*reset)(VirtIODevice *vdev);
130 void (*set_status)(VirtIODevice *vdev, uint8_t val);
132 const VirtIOBindings *binding;
133 void *binding_opaque;
136 VMChangeStateEntry *vmstate;
139 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
140 void (*handle_output)(VirtIODevice *,
143 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
145 void virtqueue_flush(VirtQueue *vq, unsigned int count);
146 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
147 unsigned int len, unsigned int idx);
149 void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr,
150 size_t num_sg, int is_write);
151 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
152 int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
154 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
156 void virtio_save(VirtIODevice *vdev, QEMUFile *f);
158 int virtio_load(VirtIODevice *vdev, QEMUFile *f);
160 void virtio_cleanup(VirtIODevice *vdev);
162 void virtio_notify_config(VirtIODevice *vdev);
164 void virtio_queue_set_notification(VirtQueue *vq, int enable);
166 int virtio_queue_ready(VirtQueue *vq);
168 int virtio_queue_empty(VirtQueue *vq);
170 /* Host binding interface. */
172 VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
173 size_t config_size, size_t struct_size);
174 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
175 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
176 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
177 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
178 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
179 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
180 void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
181 target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
182 void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
183 int virtio_queue_get_num(VirtIODevice *vdev, int n);
184 void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
185 void virtio_queue_notify(VirtIODevice *vdev, int n);
186 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
187 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
188 void virtio_set_status(VirtIODevice *vdev, uint8_t val);
189 void virtio_reset(void *opaque);
190 void virtio_update_irq(VirtIODevice *vdev);
191 int virtio_set_features(VirtIODevice *vdev, uint32_t val);
193 void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
197 typedef struct VirtIOBlkConf VirtIOBlkConf;
198 VirtIODevice *virtio_blk_init(DeviceState *dev, VirtIOBlkConf *blk);
199 struct virtio_net_conf;
200 VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
201 struct virtio_net_conf *net);
202 typedef struct virtio_serial_conf virtio_serial_conf;
203 VirtIODevice *virtio_serial_init(DeviceState *dev, virtio_serial_conf *serial);
204 VirtIODevice *virtio_balloon_init(DeviceState *dev);
205 typedef struct VirtIOSCSIConf VirtIOSCSIConf;
206 VirtIODevice *virtio_scsi_init(DeviceState *dev, VirtIOSCSIConf *conf);
208 VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf);
210 #ifdef CONFIG_VIRTIO_GL
211 VirtIODevice *virtio_gl_init(DeviceState *dev);
214 void virtio_net_exit(VirtIODevice *vdev);
215 void virtio_blk_exit(VirtIODevice *vdev);
216 void virtio_serial_exit(VirtIODevice *vdev);
217 void virtio_balloon_exit(VirtIODevice *vdev);
218 void virtio_scsi_exit(VirtIODevice *vdev);
222 VirtIODevice *maru_virtio_touchscreen_init(DeviceState *dev);
223 void maru_virtio_touchscreen_exit(VirtIODevice *vdev);
227 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
228 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
229 VIRTIO_RING_F_INDIRECT_DESC, true), \
230 DEFINE_PROP_BIT("event_idx", _state, _field, \
231 VIRTIO_RING_F_EVENT_IDX, true)
233 target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
234 target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
235 target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
236 target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
237 target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
238 target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
239 target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
240 target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
241 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
242 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
243 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
244 int virtio_queue_get_id(VirtQueue *vq);
245 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
246 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
247 void virtio_queue_notify_vq(VirtQueue *vq);
248 void virtio_irq(VirtQueue *vq);