Merge branch 'upstream-merge'
[qemu-kvm/markmc.git] / hw / virtio.h
blob15ad910768f6e84c54d5ee10aeccfa7e65176ac1
1 /*
2 * Virtio Support
4 * Copyright IBM, Corp. 2007
6 * Authors:
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
17 #include "hw.h"
18 #include "net.h"
19 #include "qdev.h"
20 #include "sysemu.h"
22 /* from Linux's linux/virtio_config.h */
24 /* Status byte for guest to report progress, and synchronize features. */
25 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
26 #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
27 /* We have found a driver for the device. */
28 #define VIRTIO_CONFIG_S_DRIVER 2
29 /* Driver has used its parts of the config, and is happy */
30 #define VIRTIO_CONFIG_S_DRIVER_OK 4
31 /* We've given up on this device. */
32 #define VIRTIO_CONFIG_S_FAILED 0x80
34 /* We notify when the ring is completely used, even if the guest is suppressing
35 * callbacks */
36 #define VIRTIO_F_NOTIFY_ON_EMPTY 24
37 /* We support indirect buffer descriptors */
38 #define VIRTIO_RING_F_INDIRECT_DESC 28
39 /* A guest should never accept this. It implies negotiation is broken. */
40 #define VIRTIO_F_BAD_FEATURE 30
42 /* from Linux's linux/virtio_ring.h */
44 /* This marks a buffer as continuing via the next field. */
45 #define VRING_DESC_F_NEXT 1
46 /* This marks a buffer as write-only (otherwise read-only). */
47 #define VRING_DESC_F_WRITE 2
48 /* This means the buffer contains a list of buffer descriptors. */
49 #define VRING_DESC_F_INDIRECT 4
51 /* This means don't notify other side when buffer added. */
52 #define VRING_USED_F_NO_NOTIFY 1
53 /* This means don't interrupt guest when buffer consumed. */
54 #define VRING_AVAIL_F_NO_INTERRUPT 1
56 struct VirtQueue;
58 static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
59 unsigned long align)
61 return (addr + align - 1) & ~(align - 1);
64 typedef struct VirtQueue VirtQueue;
65 typedef struct VirtIODevice VirtIODevice;
67 #define VIRTQUEUE_MAX_SIZE 1024
69 typedef struct VirtQueueElement
71 unsigned int index;
72 unsigned int out_num;
73 unsigned int in_num;
74 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
75 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
76 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
77 } VirtQueueElement;
79 typedef struct {
80 void (*notify)(void * opaque, uint16_t vector);
81 void (*save_config)(void * opaque, QEMUFile *f);
82 void (*save_queue)(void * opaque, int n, QEMUFile *f);
83 int (*load_config)(void * opaque, QEMUFile *f);
84 int (*load_queue)(void * opaque, int n, QEMUFile *f);
85 } VirtIOBindings;
87 #define VIRTIO_PCI_QUEUE_MAX 16
89 #define VIRTIO_NO_VECTOR 0xffff
91 struct VirtIODevice
93 const char *name;
94 uint8_t status;
95 uint8_t isr;
96 uint16_t queue_sel;
97 uint32_t features;
98 size_t config_len;
99 void *config;
100 uint16_t config_vector;
101 int nvectors;
102 uint32_t (*get_features)(VirtIODevice *vdev);
103 uint32_t (*bad_features)(VirtIODevice *vdev);
104 void (*set_features)(VirtIODevice *vdev, uint32_t val);
105 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
106 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
107 void (*reset)(VirtIODevice *vdev);
108 VirtQueue *vq;
109 const VirtIOBindings *binding;
110 void *binding_opaque;
111 uint16_t device_id;
114 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
115 void (*handle_output)(VirtIODevice *,
116 VirtQueue *));
118 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
119 unsigned int len);
120 void virtqueue_flush(VirtQueue *vq, unsigned int count);
121 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
122 unsigned int len, unsigned int idx);
124 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
125 int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
127 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
129 void virtio_save(VirtIODevice *vdev, QEMUFile *f);
131 int virtio_load(VirtIODevice *vdev, QEMUFile *f);
133 void virtio_cleanup(VirtIODevice *vdev);
135 void virtio_notify_config(VirtIODevice *vdev);
137 void virtio_queue_set_notification(VirtQueue *vq, int enable);
139 int virtio_queue_ready(VirtQueue *vq);
141 int virtio_queue_empty(VirtQueue *vq);
143 /* Host binding interface. */
145 VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
146 size_t config_size, size_t struct_size);
147 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
148 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
149 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
150 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
151 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
152 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
153 void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
154 target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
155 int virtio_queue_get_num(VirtIODevice *vdev, int n);
156 void virtio_queue_notify(VirtIODevice *vdev, int n);
157 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
158 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
159 void virtio_reset(void *opaque);
160 void virtio_update_irq(VirtIODevice *vdev);
162 void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
163 void *opaque);
165 /* Base devices. */
166 VirtIODevice *virtio_blk_init(DeviceState *dev, DriveInfo *dinfo);
167 VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf);
168 VirtIODevice *virtio_console_init(DeviceState *dev);
169 VirtIODevice *virtio_balloon_init(DeviceState *dev);
171 void virtio_net_exit(VirtIODevice *vdev);
173 #endif