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
20 /* from Linux's linux/virtio_config.h */
22 /* Status byte for guest to report progress, and synchronize features. */
23 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
24 #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
25 /* We have found a driver for the device. */
26 #define VIRTIO_CONFIG_S_DRIVER 2
27 /* Driver has used its parts of the config, and is happy */
28 #define VIRTIO_CONFIG_S_DRIVER_OK 4
29 /* We've given up on this device. */
30 #define VIRTIO_CONFIG_S_FAILED 0x80
32 /* We notify when the ring is completely used, even if the guest is supressing
34 #define VIRTIO_F_NOTIFY_ON_EMPTY 24
35 /* We support indirect buffer descriptors */
36 #define VIRTIO_RING_F_INDIRECT_DESC 28
37 /* A guest should never accept this. It implies negotiation is broken. */
38 #define VIRTIO_F_BAD_FEATURE 30
40 /* from Linux's linux/virtio_ring.h */
42 /* This marks a buffer as continuing via the next field. */
43 #define VRING_DESC_F_NEXT 1
44 /* This marks a buffer as write-only (otherwise read-only). */
45 #define VRING_DESC_F_WRITE 2
46 /* This means the buffer contains a list of buffer descriptors. */
47 #define VRING_DESC_F_INDIRECT 4
49 /* This means don't notify other side when buffer added. */
50 #define VRING_USED_F_NO_NOTIFY 1
51 /* This means don't interrupt guest when buffer consumed. */
52 #define VRING_AVAIL_F_NO_INTERRUPT 1
56 static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
59 return (addr + align - 1) & ~(align - 1);
62 typedef struct VirtQueue VirtQueue;
63 typedef struct VirtIODevice VirtIODevice;
65 #define VIRTQUEUE_MAX_SIZE 1024
67 typedef struct VirtQueueElement
72 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
73 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
74 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
78 void (*notify)(void * opaque, uint16_t vector);
81 #define VIRTIO_PCI_QUEUE_MAX 16
83 #define VIRTIO_NO_VECTOR 0xffff
94 uint16_t config_vector;
96 uint32_t (*get_features)(VirtIODevice *vdev);
97 uint32_t (*bad_features)(VirtIODevice *vdev);
98 void (*set_features)(VirtIODevice *vdev, uint32_t val);
99 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
100 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
101 void (*reset)(VirtIODevice *vdev);
103 const VirtIOBindings *binding;
104 void *binding_opaque;
108 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
109 void (*handle_output)(VirtIODevice *,
112 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
114 void virtqueue_flush(VirtQueue *vq, unsigned int count);
115 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
116 unsigned int len, unsigned int idx);
118 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
119 int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
121 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
123 void virtio_save(VirtIODevice *vdev, QEMUFile *f);
125 int virtio_load(VirtIODevice *vdev, QEMUFile *f);
127 void virtio_cleanup(VirtIODevice *vdev);
129 void virtio_notify_config(VirtIODevice *vdev);
131 void virtio_queue_set_notification(VirtQueue *vq, int enable);
133 int virtio_queue_ready(VirtQueue *vq);
135 int virtio_queue_empty(VirtQueue *vq);
137 /* Host binding interface. */
139 VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
140 size_t config_size, size_t struct_size);
141 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
142 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
143 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
144 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
145 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
146 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
147 void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
148 target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
149 int virtio_queue_get_num(VirtIODevice *vdev, int n);
150 void virtio_queue_notify(VirtIODevice *vdev, int n);
151 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
152 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
153 void virtio_reset(void *opaque);
154 void virtio_update_irq(VirtIODevice *vdev);
156 void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
160 VirtIODevice *virtio_blk_init(DeviceState *dev);
161 VirtIODevice *virtio_net_init(DeviceState *dev);
162 VirtIODevice *virtio_console_init(DeviceState *dev);
163 VirtIODevice *virtio_balloon_init(DeviceState *dev);