]> git.proxmox.com Git - mirror_qemu.git/blame - hw/virtio.h
projects / mirror_qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
misc: move include files to include/qemu/
[mirror_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"
1422e32d 18#include "net/net.h"
53c25cea 19#include "qdev.h"
d176c495 20#include "sysemu.h"
1de7afc9 21#include "qemu/event_notifier.h"
9f107513
AL		 22#ifdef CONFIG_LINUX
23#include "9p.h"
24#endif
967f97fa
AL		 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
6d74ca5a
MT		 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
d89c682f 43/* We notify when the ring is completely used, even if the guest is suppressing
967f97fa
AL		 44 * callbacks */
45#define VIRTIO_F_NOTIFY_ON_EMPTY 24
efeea6d0
MM		 46/* We support indirect buffer descriptors */
47#define VIRTIO_RING_F_INDIRECT_DESC 28
bcbabae8
MT		 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
8eca6b1b
AL		 53/* A guest should never accept this. It implies negotiation is broken. */
54#define VIRTIO_F_BAD_FEATURE 30
967f97fa
AL		 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
efeea6d0
MM		 62/* This means the buffer contains a list of buffer descriptors. */
63#define VRING_DESC_F_INDIRECT 4
967f97fa
AL		 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
70struct VirtQueue;
71
a8170e5e 72static inline hwaddr vring_align(hwaddr addr,
f46f15bc
AL		 73 unsigned long align)
74{
75 return (addr + align - 1) & ~(align - 1);
76}
77
967f97fa 78typedef struct VirtQueue VirtQueue;
967f97fa
AL		 79
80#define VIRTQUEUE_MAX_SIZE 1024
81
82typedef struct VirtQueueElement
83{
84 unsigned int index;
85 unsigned int out_num;
86 unsigned int in_num;
a8170e5e
AK		 87 hwaddr in_addr[VIRTQUEUE_MAX_SIZE];
88 hwaddr out_addr[VIRTQUEUE_MAX_SIZE];
967f97fa
AL		 89 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
90 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
91} VirtQueueElement;
92
53c25cea 93typedef struct {
7055e687 94 void (*notify)(void * opaque, uint16_t vector);
ff24bd58
MT		 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);
89c473fd 99 int (*load_done)(void * opaque, QEMUFile *f);
6d74ca5a 100 unsigned (*get_features)(void * opaque);
5430a28f 101 bool (*query_guest_notifiers)(void * opaque);
54dd9321 102 int (*set_guest_notifiers)(void * opaque, bool assigned);
1cbdabe2 103 int (*set_host_notifier)(void * opaque, int n, bool assigned);
85cf2a8d 104 void (*vmstate_change)(void * opaque, bool running);
53c25cea
PB		 105} VirtIOBindings;
106
bb61564c 107#define VIRTIO_PCI_QUEUE_MAX 64
967f97fa 108
7055e687
MT		 109#define VIRTIO_NO_VECTOR 0xffff
110
967f97fa
AL		 111struct VirtIODevice
112{
967f97fa 113 const char *name;
967f97fa
AL		 114 uint8_t status;
115 uint8_t isr;
116 uint16_t queue_sel;
704a76fc 117 uint32_t guest_features;
967f97fa
AL		 118 size_t config_len;
119 void *config;
7055e687
MT		 120 uint16_t config_vector;
121 int nvectors;
8172539d 122 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
8eca6b1b 123 uint32_t (*bad_features)(VirtIODevice *vdev);
967f97fa
AL		 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);
3e607cb5 128 void (*set_status)(VirtIODevice *vdev, uint8_t val);
967f97fa 129 VirtQueue *vq;
53c25cea
PB		 130 const VirtIOBindings *binding;
131 void *binding_opaque;
132 uint16_t device_id;
85cf2a8d
MT		 133 bool vm_running;
134 VMChangeStateEntry *vmstate;
967f97fa
AL		 135};
136
967f97fa
AL		 137VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
138 void (*handle_output)(VirtIODevice *,
139 VirtQueue *));
140
141void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
142 unsigned int len);
143void virtqueue_flush(VirtQueue *vq, unsigned int count);
144void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
145 unsigned int len, unsigned int idx);
146
a8170e5e 147void virtqueue_map_sg(struct iovec *sg, hwaddr *addr,
42fb2e07 148 size_t num_sg, int is_write);
967f97fa 149int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
0d8d7690
AS		 150int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
151 unsigned int out_bytes);
152void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
e1f7b481
MT		 153 unsigned int *out_bytes,
154 unsigned max_in_bytes, unsigned max_out_bytes);
967f97fa
AL		 155
156void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
157
158void virtio_save(VirtIODevice *vdev, QEMUFile *f);
159
7055e687 160int virtio_load(VirtIODevice *vdev, QEMUFile *f);
967f97fa 161
b946a153
AL		 162void virtio_cleanup(VirtIODevice *vdev);
163
967f97fa
AL		 164void virtio_notify_config(VirtIODevice *vdev);
165
166void virtio_queue_set_notification(VirtQueue *vq, int enable);
167
168int virtio_queue_ready(VirtQueue *vq);
169
170int virtio_queue_empty(VirtQueue *vq);
171
53c25cea
PB		 172/* Host binding interface. */
173
174VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
175 size_t config_size, size_t struct_size);
176uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
177uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
178uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
179void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
180void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
181void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
a8170e5e
AK		 182void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
183hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
53c25cea
PB		 184int virtio_queue_get_num(VirtIODevice *vdev, int n);
185void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687
MT		 186uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
187void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
4e1837f8 188void virtio_set_status(VirtIODevice *vdev, uint8_t val);
53c25cea
PB		 189void virtio_reset(void *opaque);
190void virtio_update_irq(VirtIODevice *vdev);
ad0c9332 191int virtio_set_features(VirtIODevice *vdev, uint32_t val);
53c25cea
PB		 192
193void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
194 void *opaque);
195
196/* Base devices. */
12c5674b
PB		 197typedef struct VirtIOBlkConf VirtIOBlkConf;
198VirtIODevice *virtio_blk_init(DeviceState *dev, VirtIOBlkConf *blk);
f0c07c7c
AW		 199struct virtio_net_conf;
200VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
201 struct virtio_net_conf *net);
6b331efb
AS		 202typedef struct virtio_serial_conf virtio_serial_conf;
203VirtIODevice *virtio_serial_init(DeviceState *dev, virtio_serial_conf *serial);
53c25cea 204VirtIODevice *virtio_balloon_init(DeviceState *dev);
973abc7f
SH		 205typedef struct VirtIOSCSIConf VirtIOSCSIConf;
206VirtIODevice *virtio_scsi_init(DeviceState *dev, VirtIOSCSIConf *conf);
16c915ba
AS		 207typedef struct VirtIORNGConf VirtIORNGConf;
208VirtIODevice *virtio_rng_init(DeviceState *dev, VirtIORNGConf *conf);
9f107513
AL		 209#ifdef CONFIG_LINUX
210VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf);
211#endif
212
53c25cea 213
97b15621 214void virtio_net_exit(VirtIODevice *vdev);
9d0d3138 215void virtio_blk_exit(VirtIODevice *vdev);
8b53a865 216void virtio_serial_exit(VirtIODevice *vdev);
855d7e25 217void virtio_balloon_exit(VirtIODevice *vdev);
973abc7f 218void virtio_scsi_exit(VirtIODevice *vdev);
16c915ba 219void virtio_rng_exit(VirtIODevice *vdev);
97b15621 220
8172539d
MT		 221#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
222 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
bcbabae8
MT		 223 VIRTIO_RING_F_INDIRECT_DESC, true), \
224 DEFINE_PROP_BIT("event_idx", _state, _field, \
225 VIRTIO_RING_F_EVENT_IDX, true)
8172539d 226
a8170e5e
AK		 227hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
228hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
229hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
230hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
231hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
232hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
233hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
234hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
1cbdabe2
MT		 235uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
236void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
237VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
c80decdb 238int virtio_queue_get_id(VirtQueue *vq);
1cbdabe2 239EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
15b2bd18
PB		 240void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
241 bool with_irqfd);
1cbdabe2 242EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
26b9b5fe
PB		 243void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
244 bool set_handler);
25db9ebe 245void virtio_queue_notify_vq(VirtQueue *vq);
1cbdabe2 246void virtio_irq(VirtQueue *vq);
967f97fa 247#endif
QEMU mirror