]> git.proxmox.com Git - mirror_qemu.git/blame - include/hw/virtio/virtio.h
projects / mirror_qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
virtio: feature bit manipulation helpers
[mirror_qemu.git] / include / hw / virtio / 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
83c9f4ca 17#include "hw/hw.h"
1422e32d 18#include "net/net.h"
83c9f4ca 19#include "hw/qdev.h"
9c17d615 20#include "sysemu/sysemu.h"
1de7afc9 21#include "qemu/event_notifier.h"
e9600c6c
MT		 22#include "standard-headers/linux/virtio_config.h"
23#include "standard-headers/linux/virtio_ring.h"
967f97fa 24
8eca6b1b
AL		 25/* A guest should never accept this. It implies negotiation is broken. */
26#define VIRTIO_F_BAD_FEATURE 30
967f97fa 27
967f97fa
AL		 28struct VirtQueue;
29
a8170e5e 30static inline hwaddr vring_align(hwaddr addr,
f46f15bc
AL		 31 unsigned long align)
32{
33 return (addr + align - 1) & ~(align - 1);
34}
35
967f97fa 36typedef struct VirtQueue VirtQueue;
967f97fa
AL		 37
38#define VIRTQUEUE_MAX_SIZE 1024
39
40typedef struct VirtQueueElement
41{
42 unsigned int index;
43 unsigned int out_num;
44 unsigned int in_num;
a8170e5e
AK		 45 hwaddr in_addr[VIRTQUEUE_MAX_SIZE];
46 hwaddr out_addr[VIRTQUEUE_MAX_SIZE];
967f97fa
AL		 47 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
48 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
49} VirtQueueElement;
50
bb61564c 51#define VIRTIO_PCI_QUEUE_MAX 64
967f97fa 52
7055e687
MT		 53#define VIRTIO_NO_VECTOR 0xffff
54
8e05db92
FK		 55#define TYPE_VIRTIO_DEVICE "virtio-device"
56#define VIRTIO_DEVICE_GET_CLASS(obj) \
57 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
58#define VIRTIO_DEVICE_CLASS(klass) \
59 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
60#define VIRTIO_DEVICE(obj) \
61 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)
62
616a6552
GK		 63enum virtio_device_endian {
64 VIRTIO_DEVICE_ENDIAN_UNKNOWN,
65 VIRTIO_DEVICE_ENDIAN_LITTLE,
66 VIRTIO_DEVICE_ENDIAN_BIG,
67};
68
967f97fa
AL		 69struct VirtIODevice
70{
8e05db92 71 DeviceState parent_obj;
967f97fa 72 const char *name;
967f97fa
AL		 73 uint8_t status;
74 uint8_t isr;
75 uint16_t queue_sel;
704a76fc 76 uint32_t guest_features;
967f97fa
AL		 77 size_t config_len;
78 void *config;
7055e687
MT		 79 uint16_t config_vector;
80 int nvectors;
967f97fa 81 VirtQueue *vq;
53c25cea 82 uint16_t device_id;
85cf2a8d
MT		 83 bool vm_running;
84 VMChangeStateEntry *vmstate;
1034e9cf 85 char *bus_name;
616a6552 86 uint8_t device_endian;
967f97fa
AL		 87};
88
8e05db92 89typedef struct VirtioDeviceClass {
0ba94b6f 90 /*< private >*/
8e05db92 91 DeviceClass parent;
0ba94b6f 92 /*< public >*/
1d244b42
AF		 93
94 /* This is what a VirtioDevice must implement */
1d244b42 95 DeviceRealize realize;
306ec6c3 96 DeviceUnrealize unrealize;
8e05db92
FK		 97 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
98 uint32_t (*bad_features)(VirtIODevice *vdev);
99 void (*set_features)(VirtIODevice *vdev, uint32_t val);
100 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
101 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
102 void (*reset)(VirtIODevice *vdev);
103 void (*set_status)(VirtIODevice *vdev, uint8_t val);
6a87acf7
FK		 104 /* Test and clear event pending status.
105 * Should be called after unmask to avoid losing events.
106 * If backend does not support masking,
107 * must check in frontend instead.
108 */
109 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
110 /* Mask/unmask events from this vq. Any events reported
111 * while masked will become pending.
112 * If backend does not support masking,
113 * must mask in frontend instead.
114 */
115 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
1b5fc0de
GK		 116 void (*save)(VirtIODevice *vdev, QEMUFile *f);
117 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
8e05db92
FK		 118} VirtioDeviceClass;
119
c8075caf
GA		 120void virtio_instance_init_common(Object *proxy_obj, void *data,
121 size_t vdev_size, const char *vdev_name);
122
8e05db92
FK		 123void virtio_init(VirtIODevice *vdev, const char *name,
124 uint16_t device_id, size_t config_size);
6a1a8cc7 125void virtio_cleanup(VirtIODevice *vdev);
8e05db92 126
1034e9cf
FK		 127/* Set the child bus name. */
128void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
129
967f97fa
AL		 130VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
131 void (*handle_output)(VirtIODevice *,
132 VirtQueue *));
133
f23fd811
JW		 134void virtio_del_queue(VirtIODevice *vdev, int n);
135
967f97fa
AL		 136void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
137 unsigned int len);
138void virtqueue_flush(VirtQueue *vq, unsigned int count);
139void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
140 unsigned int len, unsigned int idx);
141
a8170e5e 142void virtqueue_map_sg(struct iovec *sg, hwaddr *addr,
42fb2e07 143 size_t num_sg, int is_write);
967f97fa 144int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
0d8d7690
AS		 145int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
146 unsigned int out_bytes);
147void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
e1f7b481
MT		 148 unsigned int *out_bytes,
149 unsigned max_in_bytes, unsigned max_out_bytes);
967f97fa
AL		 150
151void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
152
153void virtio_save(VirtIODevice *vdev, QEMUFile *f);
154
1b5fc0de 155int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
967f97fa
AL		 156
157void virtio_notify_config(VirtIODevice *vdev);
158
159void virtio_queue_set_notification(VirtQueue *vq, int enable);
160
161int virtio_queue_ready(VirtQueue *vq);
162
163int virtio_queue_empty(VirtQueue *vq);
164
53c25cea
PB		 165/* Host binding interface. */
166
53c25cea
PB		 167uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
168uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
169uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
170void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
171void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
172void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
a8170e5e
AK		 173void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
174hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
e63c0ba1 175void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
53c25cea 176int virtio_queue_get_num(VirtIODevice *vdev, int n);
6ce69d1c 177void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
53c25cea 178void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687
MT		 179uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
180void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
4e1837f8 181void virtio_set_status(VirtIODevice *vdev, uint8_t val);
53c25cea
PB		 182void virtio_reset(void *opaque);
183void virtio_update_irq(VirtIODevice *vdev);
ad0c9332 184int virtio_set_features(VirtIODevice *vdev, uint32_t val);
53c25cea 185
53c25cea 186/* Base devices. */
12c5674b 187typedef struct VirtIOBlkConf VirtIOBlkConf;
f0c07c7c 188struct virtio_net_conf;
6b331efb 189typedef struct virtio_serial_conf virtio_serial_conf;
973abc7f 190typedef struct VirtIOSCSIConf VirtIOSCSIConf;
16c915ba 191typedef struct VirtIORNGConf VirtIORNGConf;
97b15621 192
8172539d
MT		 193#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
194 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
bcbabae8
MT		 195 VIRTIO_RING_F_INDIRECT_DESC, true), \
196 DEFINE_PROP_BIT("event_idx", _state, _field, \
197 VIRTIO_RING_F_EVENT_IDX, true)
8172539d 198
a8170e5e
AK		 199hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
200hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
201hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
202hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
203hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
204hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
205hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
206hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
1cbdabe2
MT		 207uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
208void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
6793dfd1 209void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
1cbdabe2 210VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
e78a2b42 211uint16_t virtio_get_queue_index(VirtQueue *vq);
c80decdb 212int virtio_queue_get_id(VirtQueue *vq);
1cbdabe2 213EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
15b2bd18
PB		 214void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
215 bool with_irqfd);
1cbdabe2 216EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
26b9b5fe
PB		 217void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
218 bool set_handler);
25db9ebe 219void virtio_queue_notify_vq(VirtQueue *vq);
1cbdabe2 220void virtio_irq(VirtQueue *vq);
98ed8ecf 221
0cd09c3a
CH		 222static inline void virtio_add_feature(uint32_t *features, unsigned int fbit)
223{
224 assert(fbit < 32);
225 *features |= (1 << fbit);
226}
227
228static inline void virtio_clear_feature(uint32_t *features, unsigned int fbit)
229{
230 assert(fbit < 32);
231 *features &= ~(1 << fbit);
232}
233
616a6552 234static inline bool virtio_is_big_endian(VirtIODevice *vdev)
98ed8ecf 235{
616a6552
GK		 236 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
237 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
98ed8ecf 238}
967f97fa 239#endif
QEMU mirror