Statistics
| Branch: | Revision:

root / hw / virtio.h @ 89c473fd

History | View | Annotate | Download (8.2 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.h"
19
#include "qdev.h"
20
#include "sysemu.h"
21
#include "block_int.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
/* A guest should never accept this.  It implies negotiation is broken. */
50
#define VIRTIO_F_BAD_FEATURE                30
51

    
52
/* from Linux's linux/virtio_ring.h */
53

    
54
/* This marks a buffer as continuing via the next field. */
55
#define VRING_DESC_F_NEXT       1
56
/* This marks a buffer as write-only (otherwise read-only). */
57
#define VRING_DESC_F_WRITE      2
58
/* This means the buffer contains a list of buffer descriptors. */
59
#define VRING_DESC_F_INDIRECT  4
60

    
61
/* This means don't notify other side when buffer added. */
62
#define VRING_USED_F_NO_NOTIFY  1
63
/* This means don't interrupt guest when buffer consumed. */
64
#define VRING_AVAIL_F_NO_INTERRUPT      1
65

    
66
struct VirtQueue;
67

    
68
static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
69
                                             unsigned long align)
70
{
71
    return (addr + align - 1) & ~(align - 1);
72
}
73

    
74
typedef struct VirtQueue VirtQueue;
75

    
76
#define VIRTQUEUE_MAX_SIZE 1024
77

    
78
typedef struct VirtQueueElement
79
{
80
    unsigned int index;
81
    unsigned int out_num;
82
    unsigned int in_num;
83
    target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
84
    target_phys_addr_t out_addr[VIRTQUEUE_MAX_SIZE];
85
    struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
86
    struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
87
} VirtQueueElement;
88

    
89
typedef struct {
90
    void (*notify)(void * opaque, uint16_t vector);
91
    void (*save_config)(void * opaque, QEMUFile *f);
92
    void (*save_queue)(void * opaque, int n, QEMUFile *f);
93
    int (*load_config)(void * opaque, QEMUFile *f);
94
    int (*load_queue)(void * opaque, int n, QEMUFile *f);
95
    int (*load_done)(void * opaque, QEMUFile *f);
96
    unsigned (*get_features)(void * opaque);
97
    bool (*query_guest_notifiers)(void * opaque);
98
    int (*set_guest_notifiers)(void * opaque, bool assigned);
99
    int (*set_host_notifier)(void * opaque, int n, bool assigned);
100
    void (*vmstate_change)(void * opaque, bool running);
101
} VirtIOBindings;
102

    
103
#define VIRTIO_PCI_QUEUE_MAX 64
104

    
105
#define VIRTIO_NO_VECTOR 0xffff
106

    
107
struct VirtIODevice
108
{
109
    const char *name;
110
    uint8_t status;
111
    uint8_t isr;
112
    uint16_t queue_sel;
113
    uint32_t guest_features;
114
    size_t config_len;
115
    void *config;
116
    uint16_t config_vector;
117
    int nvectors;
118
    uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
119
    uint32_t (*bad_features)(VirtIODevice *vdev);
120
    void (*set_features)(VirtIODevice *vdev, uint32_t val);
121
    void (*get_config)(VirtIODevice *vdev, uint8_t *config);
122
    void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
123
    void (*reset)(VirtIODevice *vdev);
124
    void (*set_status)(VirtIODevice *vdev, uint8_t val);
125
    VirtQueue *vq;
126
    const VirtIOBindings *binding;
127
    void *binding_opaque;
128
    uint16_t device_id;
129
    bool vm_running;
130
    VMChangeStateEntry *vmstate;
131
};
132

    
133
static inline void virtio_set_status(VirtIODevice *vdev, uint8_t val)
134
{
135
    if (vdev->set_status) {
136
        vdev->set_status(vdev, val);
137
    }
138
    vdev->status = val;
139
}
140

    
141
VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
142
                            void (*handle_output)(VirtIODevice *,
143
                                                  VirtQueue *));
144

    
145
void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
146
                    unsigned int len);
147
void virtqueue_flush(VirtQueue *vq, unsigned int count);
148
void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
149
                    unsigned int len, unsigned int idx);
150

    
151
void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr,
152
    size_t num_sg, int is_write);
153
int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
154
int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int 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, target_phys_addr_t addr);
183
target_phys_addr_t 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_reset(void *opaque);
189
void virtio_update_irq(VirtIODevice *vdev);
190

    
191
void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
192
                        void *opaque);
193

    
194
/* Base devices.  */
195
VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf);
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

    
211
#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
212
        DEFINE_PROP_BIT("indirect_desc", _state, _field, \
213
                        VIRTIO_RING_F_INDIRECT_DESC, true)
214

    
215
target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
216
target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
217
target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
218
target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
219
target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
220
target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
221
target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
222
target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
223
uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
224
void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
225
VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
226
EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
227
EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
228
void virtio_queue_notify_vq(VirtQueue *vq);
229
void virtio_irq(VirtQueue *vq);
230
#endif