]> git.proxmox.com Git - qemu.git/blame - hw/virtio.h
projects / qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge remote branch 'mst/for_anthony' into staging
[qemu.git] / hw / virtio.h
CommitLineData
967f97fa
AL		 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
967f97fa 17#include "hw.h"
97b15621 18#include "net.h"
53c25cea 19#include "qdev.h"
d176c495 20#include "sysemu.h"
428c149b 21#include "block_int.h"
1cbdabe2 22#include "event_notifier.h"
9f107513
AL		 23#ifdef CONFIG_LINUX
24#include "9p.h"
25#endif
967f97fa
AL		 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
6d74ca5a
MT		 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
d89c682f 44/* We notify when the ring is completely used, even if the guest is suppressing
967f97fa
AL		 45 * callbacks */
46#define VIRTIO_F_NOTIFY_ON_EMPTY 24
efeea6d0
MM		 47/* We support indirect buffer descriptors */
48#define VIRTIO_RING_F_INDIRECT_DESC 28
8eca6b1b
AL		 49/* A guest should never accept this. It implies negotiation is broken. */
50#define VIRTIO_F_BAD_FEATURE 30
967f97fa
AL		 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
efeea6d0
MM		 58/* This means the buffer contains a list of buffer descriptors. */
59#define VRING_DESC_F_INDIRECT 4
967f97fa
AL		 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
66struct VirtQueue;
67
c227f099 68static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
f46f15bc
AL		 69 unsigned long align)
70{
71 return (addr + align - 1) & ~(align - 1);
72}
73
967f97fa 74typedef struct VirtQueue VirtQueue;
967f97fa
AL		 75
76#define VIRTQUEUE_MAX_SIZE 1024
77
78typedef struct VirtQueueElement
79{
80 unsigned int index;
81 unsigned int out_num;
82 unsigned int in_num;
c227f099 83 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
42fb2e07 84 target_phys_addr_t out_addr[VIRTQUEUE_MAX_SIZE];
967f97fa
AL		 85 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
86 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
87} VirtQueueElement;
88
53c25cea 89typedef struct {
7055e687 90 void (*notify)(void * opaque, uint16_t vector);
ff24bd58
MT		 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);
6d74ca5a 95 unsigned (*get_features)(void * opaque);
54dd9321 96 int (*set_guest_notifiers)(void * opaque, bool assigned);
1cbdabe2 97 int (*set_host_notifier)(void * opaque, int n, bool assigned);
53c25cea
PB		 98} VirtIOBindings;
99
bb61564c 100#define VIRTIO_PCI_QUEUE_MAX 64
967f97fa 101
7055e687
MT		 102#define VIRTIO_NO_VECTOR 0xffff
103
967f97fa
AL		 104struct VirtIODevice
105{
967f97fa 106 const char *name;
967f97fa
AL		 107 uint8_t status;
108 uint8_t isr;
109 uint16_t queue_sel;
704a76fc 110 uint32_t guest_features;
967f97fa
AL		 111 size_t config_len;
112 void *config;
7055e687
MT		 113 uint16_t config_vector;
114 int nvectors;
8172539d 115 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
8eca6b1b 116 uint32_t (*bad_features)(VirtIODevice *vdev);
967f97fa
AL		 117 void (*set_features)(VirtIODevice *vdev, uint32_t val);
118 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
119 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
120 void (*reset)(VirtIODevice *vdev);
3e607cb5 121 void (*set_status)(VirtIODevice *vdev, uint8_t val);
967f97fa 122 VirtQueue *vq;
53c25cea
PB		 123 const VirtIOBindings *binding;
124 void *binding_opaque;
125 uint16_t device_id;
967f97fa
AL		 126};
127
3e607cb5
MT		 128static inline void virtio_set_status(VirtIODevice *vdev, uint8_t val)
129{
130 if (vdev->set_status) {
131 vdev->set_status(vdev, val);
132 }
133 vdev->status = val;
134}
135
967f97fa
AL		 136VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
137 void (*handle_output)(VirtIODevice *,
138 VirtQueue *));
139
140void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
141 unsigned int len);
142void virtqueue_flush(VirtQueue *vq, unsigned int count);
143void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
144 unsigned int len, unsigned int idx);
145
42fb2e07
KW		 146void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr,
147 size_t num_sg, int is_write);
967f97fa
AL		 148int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
149int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
150
151void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
152
153void virtio_save(VirtIODevice *vdev, QEMUFile *f);
154
7055e687 155int virtio_load(VirtIODevice *vdev, QEMUFile *f);
967f97fa 156
b946a153
AL		 157void virtio_cleanup(VirtIODevice *vdev);
158
967f97fa
AL		 159void virtio_notify_config(VirtIODevice *vdev);
160
161void virtio_queue_set_notification(VirtQueue *vq, int enable);
162
163int virtio_queue_ready(VirtQueue *vq);
164
165int virtio_queue_empty(VirtQueue *vq);
166
53c25cea
PB		 167/* Host binding interface. */
168
169VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
170 size_t config_size, size_t struct_size);
171uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
172uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
173uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
174void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
175void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
176void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
c227f099
AL		 177void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
178target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
53c25cea
PB		 179int virtio_queue_get_num(VirtIODevice *vdev, int n);
180void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687
MT		 181uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
182void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
53c25cea
PB		 183void virtio_reset(void *opaque);
184void virtio_update_irq(VirtIODevice *vdev);
185
186void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
187 void *opaque);
188
189/* Base devices. */
428c149b 190VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf);
f0c07c7c
AW		 191struct virtio_net_conf;
192VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
193 struct virtio_net_conf *net);
98b19252 194VirtIODevice *virtio_serial_init(DeviceState *dev, uint32_t max_nr_ports);
53c25cea 195VirtIODevice *virtio_balloon_init(DeviceState *dev);
9f107513
AL		 196#ifdef CONFIG_LINUX
197VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf);
198#endif
199
53c25cea 200
97b15621 201void virtio_net_exit(VirtIODevice *vdev);
9d0d3138 202void virtio_blk_exit(VirtIODevice *vdev);
8b53a865 203void virtio_serial_exit(VirtIODevice *vdev);
97b15621 204
8172539d
MT		 205#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
206 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
207 VIRTIO_RING_F_INDIRECT_DESC, true)
208
1cbdabe2
MT		 209target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
210target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
211target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
212target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
213target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
214target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
215target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
216target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
217uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
218void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
219VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
220EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
221EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
222void virtio_irq(VirtQueue *vq);
967f97fa 223#endif
Qemu copy for testing