Statistics
| Branch: | Revision:

root / hw / virtio.h @ 6b331efb

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
    unsigned (*get_features)(void * opaque);
96
    bool (*query_guest_notifiers)(void * opaque);
97
    int (*set_guest_notifiers)(void * opaque, bool assigned);
98
    int (*set_host_notifier)(void * opaque, int n, bool assigned);
99
    void (*vmstate_change)(void * opaque, bool running);
100
} VirtIOBindings;
101

    
102
#define VIRTIO_PCI_QUEUE_MAX 64
103

    
104
#define VIRTIO_NO_VECTOR 0xffff
105

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

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

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

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

    
150
void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr,
151
    size_t num_sg, int is_write);
152
int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
153
int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
154

    
155
void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
156

    
157
void virtio_save(VirtIODevice *vdev, QEMUFile *f);
158

    
159
int virtio_load(VirtIODevice *vdev, QEMUFile *f);
160

    
161
void virtio_cleanup(VirtIODevice *vdev);
162

    
163
void virtio_notify_config(VirtIODevice *vdev);
164

    
165
void virtio_queue_set_notification(VirtQueue *vq, int enable);
166

    
167
int virtio_queue_ready(VirtQueue *vq);
168

    
169
int virtio_queue_empty(VirtQueue *vq);
170

    
171
/* Host binding interface.  */
172

    
173
VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
174
                                 size_t config_size, size_t struct_size);
175
uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
176
uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
177
uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
178
void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
179
void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
180
void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
181
void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
182
target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
183
int virtio_queue_get_num(VirtIODevice *vdev, int n);
184
void virtio_queue_notify(VirtIODevice *vdev, int n);
185
uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
186
void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
187
void virtio_reset(void *opaque);
188
void virtio_update_irq(VirtIODevice *vdev);
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
struct virtio_net_conf;
196
VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
197
                              struct virtio_net_conf *net);
198
typedef struct virtio_serial_conf virtio_serial_conf;
199
VirtIODevice *virtio_serial_init(DeviceState *dev, virtio_serial_conf *serial);
200
VirtIODevice *virtio_balloon_init(DeviceState *dev);
201
#ifdef CONFIG_LINUX
202
VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf);
203
#endif
204

    
205

    
206
void virtio_net_exit(VirtIODevice *vdev);
207
void virtio_blk_exit(VirtIODevice *vdev);
208
void virtio_serial_exit(VirtIODevice *vdev);
209

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

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