PPC: e500mc: add missing IVORs to bitmap
[qemu.git] / hw / virtio.h
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
17 #include "hw.h"
18 #include "net.h"
19 #include "qdev.h"
20 #include "sysemu.h"
21 #include "block.h"
22 #include "event_notifier.h"
23 #ifdef CONFIG_LINUX
24 #include "9p.h"
25 #endif
26
27 /* from Linux's linux/virtio_config.h */
28
29 /* Status byte for guest to report progress, and synchronize features. */
30 /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
31 #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
32 /* We have found a driver for the device. */
33 #define VIRTIO_CONFIG_S_DRIVER 2
34 /* Driver has used its parts of the config, and is happy */
35 #define VIRTIO_CONFIG_S_DRIVER_OK 4
36 /* We've given up on this device. */
37 #define VIRTIO_CONFIG_S_FAILED 0x80
38
39 /* Some virtio feature bits (currently bits 28 through 31) are reserved for the
40 * transport being used (eg. virtio_ring), the rest are per-device feature bits. */
41 #define VIRTIO_TRANSPORT_F_START 28
42 #define VIRTIO_TRANSPORT_F_END 32
43
44 /* We notify when the ring is completely used, even if the guest is suppressing
45 * callbacks */
46 #define VIRTIO_F_NOTIFY_ON_EMPTY 24
47 /* We support indirect buffer descriptors */
48 #define VIRTIO_RING_F_INDIRECT_DESC 28
49 /* The Guest publishes the used index for which it expects an interrupt
50 * at the end of the avail ring. Host should ignore the avail->flags field. */
51 /* The Host publishes the avail index for which it expects a kick
52 * at the end of the used ring. Guest should ignore the used->flags field. */
53 #define VIRTIO_RING_F_EVENT_IDX 29
54 /* A guest should never accept this. It implies negotiation is broken. */
55 #define VIRTIO_F_BAD_FEATURE 30
56
57 /* from Linux's linux/virtio_ring.h */
58
59 /* This marks a buffer as continuing via the next field. */
60 #define VRING_DESC_F_NEXT 1
61 /* This marks a buffer as write-only (otherwise read-only). */
62 #define VRING_DESC_F_WRITE 2
63 /* This means the buffer contains a list of buffer descriptors. */
64 #define VRING_DESC_F_INDIRECT 4
65
66 /* This means don't notify other side when buffer added. */
67 #define VRING_USED_F_NO_NOTIFY 1
68 /* This means don't interrupt guest when buffer consumed. */
69 #define VRING_AVAIL_F_NO_INTERRUPT 1
70
71 struct VirtQueue;
72
73 static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
74 unsigned long align)
75 {
76 return (addr + align - 1) & ~(align - 1);
77 }
78
79 typedef struct VirtQueue VirtQueue;
80
81 #define VIRTQUEUE_MAX_SIZE 1024
82
83 typedef struct VirtQueueElement
84 {
85 unsigned int index;
86 unsigned int out_num;
87 unsigned int in_num;
88 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
89 target_phys_addr_t out_addr[VIRTQUEUE_MAX_SIZE];
90 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
91 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
92 } VirtQueueElement;
93
94 typedef struct {
95 void (*notify)(void * opaque, uint16_t vector);
96 void (*save_config)(void * opaque, QEMUFile *f);
97 void (*save_queue)(void * opaque, int n, QEMUFile *f);
98 int (*load_config)(void * opaque, QEMUFile *f);
99 int (*load_queue)(void * opaque, int n, QEMUFile *f);
100 int (*load_done)(void * opaque, QEMUFile *f);
101 unsigned (*get_features)(void * opaque);
102 bool (*query_guest_notifiers)(void * opaque);
103 int (*set_guest_notifiers)(void * opaque, bool assigned);
104 int (*set_host_notifier)(void * opaque, int n, bool assigned);
105 void (*vmstate_change)(void * opaque, bool running);
106 } VirtIOBindings;
107
108 #define VIRTIO_PCI_QUEUE_MAX 64
109
110 #define VIRTIO_NO_VECTOR 0xffff
111
112 struct VirtIODevice
113 {
114 const char *name;
115 uint8_t status;
116 uint8_t isr;
117 uint16_t queue_sel;
118 uint32_t guest_features;
119 size_t config_len;
120 void *config;
121 uint16_t config_vector;
122 int nvectors;
123 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
124 uint32_t (*bad_features)(VirtIODevice *vdev);
125 void (*set_features)(VirtIODevice *vdev, uint32_t val);
126 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
127 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
128 void (*reset)(VirtIODevice *vdev);
129 void (*set_status)(VirtIODevice *vdev, uint8_t val);
130 VirtQueue *vq;
131 const VirtIOBindings *binding;
132 void *binding_opaque;
133 uint16_t device_id;
134 bool vm_running;
135 VMChangeStateEntry *vmstate;
136 };
137
138 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
139 void (*handle_output)(VirtIODevice *,
140 VirtQueue *));
141
142 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
143 unsigned int len);
144 void virtqueue_flush(VirtQueue *vq, unsigned int count);
145 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
146 unsigned int len, unsigned int idx);
147
148 void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr,
149 size_t num_sg, int is_write);
150 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
151 int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
152
153 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
154
155 void virtio_save(VirtIODevice *vdev, QEMUFile *f);
156
157 int virtio_load(VirtIODevice *vdev, QEMUFile *f);
158
159 void virtio_cleanup(VirtIODevice *vdev);
160
161 void virtio_notify_config(VirtIODevice *vdev);
162
163 void virtio_queue_set_notification(VirtQueue *vq, int enable);
164
165 int virtio_queue_ready(VirtQueue *vq);
166
167 int virtio_queue_empty(VirtQueue *vq);
168
169 /* Host binding interface. */
170
171 VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
172 size_t config_size, size_t struct_size);
173 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
174 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
175 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
176 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
177 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
178 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
179 void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
180 target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
181 int virtio_queue_get_num(VirtIODevice *vdev, int n);
182 void virtio_queue_notify(VirtIODevice *vdev, int n);
183 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
184 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
185 void virtio_set_status(VirtIODevice *vdev, uint8_t val);
186 void virtio_reset(void *opaque);
187 void virtio_update_irq(VirtIODevice *vdev);
188 int virtio_set_features(VirtIODevice *vdev, uint32_t val);
189
190 void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
191 void *opaque);
192
193 /* Base devices. */
194 VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf,
195 char **serial);
196 struct virtio_net_conf;
197 VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
198 struct virtio_net_conf *net);
199 typedef struct virtio_serial_conf virtio_serial_conf;
200 VirtIODevice *virtio_serial_init(DeviceState *dev, virtio_serial_conf *serial);
201 VirtIODevice *virtio_balloon_init(DeviceState *dev);
202 #ifdef CONFIG_LINUX
203 VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf);
204 #endif
205
206
207 void virtio_net_exit(VirtIODevice *vdev);
208 void virtio_blk_exit(VirtIODevice *vdev);
209 void virtio_serial_exit(VirtIODevice *vdev);
210 void virtio_balloon_exit(VirtIODevice *vdev);
211
212 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
213 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
214 VIRTIO_RING_F_INDIRECT_DESC, true), \
215 DEFINE_PROP_BIT("event_idx", _state, _field, \
216 VIRTIO_RING_F_EVENT_IDX, true)
217
218 target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
219 target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
220 target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
221 target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
222 target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
223 target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
224 target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
225 target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
226 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
227 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
228 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
229 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
230 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
231 void virtio_queue_notify_vq(VirtQueue *vq);
232 void virtio_irq(VirtQueue *vq);
233 #endif