root / hw / virtio.h @ 1de7afc9
History | View | Annotate | Download (9.4 kB)
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/net.h" |
19 |
#include "qdev.h" |
20 |
#include "sysemu.h" |
21 |
#include "qemu/event_notifier.h" |
22 |
#ifdef CONFIG_LINUX
|
23 |
#include "9p.h" |
24 |
#endif
|
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 |
|
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 |
|
43 |
/* We notify when the ring is completely used, even if the guest is suppressing
|
44 |
* callbacks */
|
45 |
#define VIRTIO_F_NOTIFY_ON_EMPTY 24 |
46 |
/* We support indirect buffer descriptors */
|
47 |
#define VIRTIO_RING_F_INDIRECT_DESC 28 |
48 |
/* The Guest publishes the used index for which it expects an interrupt
|
49 |
* at the end of the avail ring. Host should ignore the avail->flags field. */
|
50 |
/* The Host publishes the avail index for which it expects a kick
|
51 |
* at the end of the used ring. Guest should ignore the used->flags field. */
|
52 |
#define VIRTIO_RING_F_EVENT_IDX 29 |
53 |
/* A guest should never accept this. It implies negotiation is broken. */
|
54 |
#define VIRTIO_F_BAD_FEATURE 30 |
55 |
|
56 |
/* from Linux's linux/virtio_ring.h */
|
57 |
|
58 |
/* This marks a buffer as continuing via the next field. */
|
59 |
#define VRING_DESC_F_NEXT 1 |
60 |
/* This marks a buffer as write-only (otherwise read-only). */
|
61 |
#define VRING_DESC_F_WRITE 2 |
62 |
/* This means the buffer contains a list of buffer descriptors. */
|
63 |
#define VRING_DESC_F_INDIRECT 4 |
64 |
|
65 |
/* This means don't notify other side when buffer added. */
|
66 |
#define VRING_USED_F_NO_NOTIFY 1 |
67 |
/* This means don't interrupt guest when buffer consumed. */
|
68 |
#define VRING_AVAIL_F_NO_INTERRUPT 1 |
69 |
|
70 |
struct VirtQueue;
|
71 |
|
72 |
static inline hwaddr vring_align(hwaddr addr, |
73 |
unsigned long align) |
74 |
{ |
75 |
return (addr + align - 1) & ~(align - 1); |
76 |
} |
77 |
|
78 |
typedef struct VirtQueue VirtQueue; |
79 |
|
80 |
#define VIRTQUEUE_MAX_SIZE 1024 |
81 |
|
82 |
typedef struct VirtQueueElement |
83 |
{ |
84 |
unsigned int index; |
85 |
unsigned int out_num; |
86 |
unsigned int in_num; |
87 |
hwaddr in_addr[VIRTQUEUE_MAX_SIZE]; |
88 |
hwaddr out_addr[VIRTQUEUE_MAX_SIZE]; |
89 |
struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
|
90 |
struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
|
91 |
} VirtQueueElement; |
92 |
|
93 |
typedef struct { |
94 |
void (*notify)(void * opaque, uint16_t vector); |
95 |
void (*save_config)(void * opaque, QEMUFile *f); |
96 |
void (*save_queue)(void * opaque, int n, QEMUFile *f); |
97 |
int (*load_config)(void * opaque, QEMUFile *f); |
98 |
int (*load_queue)(void * opaque, int n, QEMUFile *f); |
99 |
int (*load_done)(void * opaque, QEMUFile *f); |
100 |
unsigned (*get_features)(void * opaque); |
101 |
bool (*query_guest_notifiers)(void * opaque); |
102 |
int (*set_guest_notifiers)(void * opaque, bool assigned); |
103 |
int (*set_host_notifier)(void * opaque, int n, bool assigned); |
104 |
void (*vmstate_change)(void * opaque, bool running); |
105 |
} VirtIOBindings; |
106 |
|
107 |
#define VIRTIO_PCI_QUEUE_MAX 64 |
108 |
|
109 |
#define VIRTIO_NO_VECTOR 0xffff |
110 |
|
111 |
struct VirtIODevice
|
112 |
{ |
113 |
const char *name; |
114 |
uint8_t status; |
115 |
uint8_t isr; |
116 |
uint16_t queue_sel; |
117 |
uint32_t guest_features; |
118 |
size_t config_len; |
119 |
void *config;
|
120 |
uint16_t config_vector; |
121 |
int nvectors;
|
122 |
uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features); |
123 |
uint32_t (*bad_features)(VirtIODevice *vdev); |
124 |
void (*set_features)(VirtIODevice *vdev, uint32_t val);
|
125 |
void (*get_config)(VirtIODevice *vdev, uint8_t *config);
|
126 |
void (*set_config)(VirtIODevice *vdev, const uint8_t *config); |
127 |
void (*reset)(VirtIODevice *vdev);
|
128 |
void (*set_status)(VirtIODevice *vdev, uint8_t val);
|
129 |
VirtQueue *vq; |
130 |
const VirtIOBindings *binding;
|
131 |
void *binding_opaque;
|
132 |
uint16_t device_id; |
133 |
bool vm_running;
|
134 |
VMChangeStateEntry *vmstate; |
135 |
}; |
136 |
|
137 |
VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
|
138 |
void (*handle_output)(VirtIODevice *,
|
139 |
VirtQueue *)); |
140 |
|
141 |
void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, |
142 |
unsigned int len); |
143 |
void virtqueue_flush(VirtQueue *vq, unsigned int count); |
144 |
void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, |
145 |
unsigned int len, unsigned int idx); |
146 |
|
147 |
void virtqueue_map_sg(struct iovec *sg, hwaddr *addr, |
148 |
size_t num_sg, int is_write);
|
149 |
int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
|
150 |
int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, |
151 |
unsigned int out_bytes); |
152 |
void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, |
153 |
unsigned int *out_bytes, |
154 |
unsigned max_in_bytes, unsigned max_out_bytes); |
155 |
|
156 |
void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
|
157 |
|
158 |
void virtio_save(VirtIODevice *vdev, QEMUFile *f);
|
159 |
|
160 |
int virtio_load(VirtIODevice *vdev, QEMUFile *f);
|
161 |
|
162 |
void virtio_cleanup(VirtIODevice *vdev);
|
163 |
|
164 |
void virtio_notify_config(VirtIODevice *vdev);
|
165 |
|
166 |
void virtio_queue_set_notification(VirtQueue *vq, int enable); |
167 |
|
168 |
int virtio_queue_ready(VirtQueue *vq);
|
169 |
|
170 |
int virtio_queue_empty(VirtQueue *vq);
|
171 |
|
172 |
/* Host binding interface. */
|
173 |
|
174 |
VirtIODevice *virtio_common_init(const char *name, uint16_t device_id, |
175 |
size_t config_size, size_t struct_size); |
176 |
uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); |
177 |
uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); |
178 |
uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); |
179 |
void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
|
180 |
void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
|
181 |
void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
|
182 |
void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); |
183 |
hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
|
184 |
int virtio_queue_get_num(VirtIODevice *vdev, int n); |
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);
|
192 |
|
193 |
void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding, |
194 |
void *opaque);
|
195 |
|
196 |
/* Base devices. */
|
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); |
207 |
typedef struct VirtIORNGConf VirtIORNGConf; |
208 |
VirtIODevice *virtio_rng_init(DeviceState *dev, VirtIORNGConf *conf); |
209 |
#ifdef CONFIG_LINUX
|
210 |
VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf); |
211 |
#endif
|
212 |
|
213 |
|
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);
|
219 |
void virtio_rng_exit(VirtIODevice *vdev);
|
220 |
|
221 |
#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
|
222 |
DEFINE_PROP_BIT("indirect_desc", _state, _field, \
|
223 |
VIRTIO_RING_F_INDIRECT_DESC, true), \
|
224 |
DEFINE_PROP_BIT("event_idx", _state, _field, \
|
225 |
VIRTIO_RING_F_EVENT_IDX, true)
|
226 |
|
227 |
hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
|
228 |
hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
|
229 |
hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
|
230 |
hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
|
231 |
hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
|
232 |
hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
|
233 |
hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
|
234 |
hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
|
235 |
uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
|
236 |
void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); |
237 |
VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
|
238 |
int virtio_queue_get_id(VirtQueue *vq);
|
239 |
EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); |
240 |
void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, |
241 |
bool with_irqfd);
|
242 |
EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); |
243 |
void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, |
244 |
bool set_handler);
|
245 |
void virtio_queue_notify_vq(VirtQueue *vq);
|
246 |
void virtio_irq(VirtQueue *vq);
|
247 |
#endif
|