blob: d3eb714ccaff6af6bb28ac137c415826e5549719 [file] [log] [blame]
aliguori967f97f2008-12-04 19:38:57 +00001/*
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
aliguori967f97f2008-12-04 19:38:57 +000017#include "hw.h"
Gerd Hoffmann97b15622009-10-21 15:25:35 +020018#include "net.h"
Paul Brook53c25ce2009-05-18 14:51:59 +010019#include "qdev.h"
Gerd Hoffmannd176c492009-07-31 12:25:41 +020020#include "sysemu.h"
Christoph Hellwig428c1492010-02-10 23:37:09 +010021#include "block_int.h"
Michael S. Tsirkin1cbdabe2010-03-17 13:08:02 +020022#include "event_notifier.h"
aliguori967f97f2008-12-04 19:38:57 +000023
24/* from Linux's linux/virtio_config.h */
25
26/* Status byte for guest to report progress, and synchronize features. */
27/* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
28#define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
29/* We have found a driver for the device. */
30#define VIRTIO_CONFIG_S_DRIVER 2
31/* Driver has used its parts of the config, and is happy */
32#define VIRTIO_CONFIG_S_DRIVER_OK 4
33/* We've given up on this device. */
34#define VIRTIO_CONFIG_S_FAILED 0x80
35
Michael S. Tsirkin6d74ca52009-12-08 20:07:48 +020036/* Some virtio feature bits (currently bits 28 through 31) are reserved for the
37 * transport being used (eg. virtio_ring), the rest are per-device feature bits. */
38#define VIRTIO_TRANSPORT_F_START 28
39#define VIRTIO_TRANSPORT_F_END 32
40
Stefan Weild89c6822009-09-24 17:53:10 +020041/* We notify when the ring is completely used, even if the guest is suppressing
aliguori967f97f2008-12-04 19:38:57 +000042 * callbacks */
43#define VIRTIO_F_NOTIFY_ON_EMPTY 24
Mark McLoughlinefeea6d2009-06-17 11:38:28 +010044/* We support indirect buffer descriptors */
45#define VIRTIO_RING_F_INDIRECT_DESC 28
aliguori8eca6b12009-04-05 17:40:08 +000046/* A guest should never accept this. It implies negotiation is broken. */
47#define VIRTIO_F_BAD_FEATURE 30
aliguori967f97f2008-12-04 19:38:57 +000048
49/* from Linux's linux/virtio_ring.h */
50
51/* This marks a buffer as continuing via the next field. */
52#define VRING_DESC_F_NEXT 1
53/* This marks a buffer as write-only (otherwise read-only). */
54#define VRING_DESC_F_WRITE 2
Mark McLoughlinefeea6d2009-06-17 11:38:28 +010055/* This means the buffer contains a list of buffer descriptors. */
56#define VRING_DESC_F_INDIRECT 4
aliguori967f97f2008-12-04 19:38:57 +000057
58/* This means don't notify other side when buffer added. */
59#define VRING_USED_F_NO_NOTIFY 1
60/* This means don't interrupt guest when buffer consumed. */
61#define VRING_AVAIL_F_NO_INTERRUPT 1
62
63struct VirtQueue;
64
Anthony Liguoric227f092009-10-01 16:12:16 -050065static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
aliguorif46f15b2008-12-04 19:58:45 +000066 unsigned long align)
67{
68 return (addr + align - 1) & ~(align - 1);
69}
70
aliguori967f97f2008-12-04 19:38:57 +000071typedef struct VirtQueue VirtQueue;
72typedef struct VirtIODevice VirtIODevice;
73
74#define VIRTQUEUE_MAX_SIZE 1024
75
76typedef struct VirtQueueElement
77{
78 unsigned int index;
79 unsigned int out_num;
80 unsigned int in_num;
Anthony Liguoric227f092009-10-01 16:12:16 -050081 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
aliguori967f97f2008-12-04 19:38:57 +000082 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
83 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
84} VirtQueueElement;
85
Paul Brook53c25ce2009-05-18 14:51:59 +010086typedef struct {
Michael S. Tsirkin7055e682009-06-21 19:50:13 +030087 void (*notify)(void * opaque, uint16_t vector);
Michael S. Tsirkinff24bd52009-06-21 19:50:40 +030088 void (*save_config)(void * opaque, QEMUFile *f);
89 void (*save_queue)(void * opaque, int n, QEMUFile *f);
90 int (*load_config)(void * opaque, QEMUFile *f);
91 int (*load_queue)(void * opaque, int n, QEMUFile *f);
Michael S. Tsirkin6d74ca52009-12-08 20:07:48 +020092 unsigned (*get_features)(void * opaque);
Michael S. Tsirkin1cbdabe2010-03-17 13:08:02 +020093 int (*set_guest_notifier)(void * opaque, int n, bool assigned);
94 int (*set_host_notifier)(void * opaque, int n, bool assigned);
Paul Brook53c25ce2009-05-18 14:51:59 +010095} VirtIOBindings;
96
Amit Shahbb615642010-01-20 00:36:51 +053097#define VIRTIO_PCI_QUEUE_MAX 64
aliguori967f97f2008-12-04 19:38:57 +000098
Michael S. Tsirkin7055e682009-06-21 19:50:13 +030099#define VIRTIO_NO_VECTOR 0xffff
100
aliguori967f97f2008-12-04 19:38:57 +0000101struct VirtIODevice
102{
aliguori967f97f2008-12-04 19:38:57 +0000103 const char *name;
aliguori967f97f2008-12-04 19:38:57 +0000104 uint8_t status;
105 uint8_t isr;
106 uint16_t queue_sel;
Michael S. Tsirkin704a76f2010-01-10 13:52:47 +0200107 uint32_t guest_features;
aliguori967f97f2008-12-04 19:38:57 +0000108 size_t config_len;
109 void *config;
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300110 uint16_t config_vector;
111 int nvectors;
Michael S. Tsirkin81725392010-01-10 13:52:53 +0200112 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
aliguori8eca6b12009-04-05 17:40:08 +0000113 uint32_t (*bad_features)(VirtIODevice *vdev);
aliguori967f97f2008-12-04 19:38:57 +0000114 void (*set_features)(VirtIODevice *vdev, uint32_t val);
115 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
116 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
117 void (*reset)(VirtIODevice *vdev);
Michael S. Tsirkin3e607cb2010-03-17 13:08:05 +0200118 void (*set_status)(VirtIODevice *vdev, uint8_t val);
aliguori967f97f2008-12-04 19:38:57 +0000119 VirtQueue *vq;
Paul Brook53c25ce2009-05-18 14:51:59 +0100120 const VirtIOBindings *binding;
121 void *binding_opaque;
122 uint16_t device_id;
aliguori967f97f2008-12-04 19:38:57 +0000123};
124
Michael S. Tsirkin3e607cb2010-03-17 13:08:05 +0200125static inline void virtio_set_status(VirtIODevice *vdev, uint8_t val)
126{
127 if (vdev->set_status) {
128 vdev->set_status(vdev, val);
129 }
130 vdev->status = val;
131}
132
aliguori967f97f2008-12-04 19:38:57 +0000133VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
134 void (*handle_output)(VirtIODevice *,
135 VirtQueue *));
136
137void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
138 unsigned int len);
139void virtqueue_flush(VirtQueue *vq, unsigned int count);
140void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
141 unsigned int len, unsigned int idx);
142
143int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
144int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
145
146void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
147
148void virtio_save(VirtIODevice *vdev, QEMUFile *f);
149
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300150int virtio_load(VirtIODevice *vdev, QEMUFile *f);
aliguori967f97f2008-12-04 19:38:57 +0000151
aliguorib946a152009-04-17 17:11:08 +0000152void virtio_cleanup(VirtIODevice *vdev);
153
aliguori967f97f2008-12-04 19:38:57 +0000154void virtio_notify_config(VirtIODevice *vdev);
155
156void virtio_queue_set_notification(VirtQueue *vq, int enable);
157
158int virtio_queue_ready(VirtQueue *vq);
159
160int virtio_queue_empty(VirtQueue *vq);
161
Paul Brook53c25ce2009-05-18 14:51:59 +0100162/* Host binding interface. */
163
164VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
165 size_t config_size, size_t struct_size);
166uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
167uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
168uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
169void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
170void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
171void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
Anthony Liguoric227f092009-10-01 16:12:16 -0500172void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
173target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
Paul Brook53c25ce2009-05-18 14:51:59 +0100174int virtio_queue_get_num(VirtIODevice *vdev, int n);
175void virtio_queue_notify(VirtIODevice *vdev, int n);
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300176uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
177void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
Paul Brook53c25ce2009-05-18 14:51:59 +0100178void virtio_reset(void *opaque);
179void virtio_update_irq(VirtIODevice *vdev);
180
181void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
182 void *opaque);
183
184/* Base devices. */
Christoph Hellwig428c1492010-02-10 23:37:09 +0100185VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf);
Gerd Hoffmann97b15622009-10-21 15:25:35 +0200186VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf);
Amit Shah98b19252010-01-20 00:36:52 +0530187VirtIODevice *virtio_serial_init(DeviceState *dev, uint32_t max_nr_ports);
Paul Brook53c25ce2009-05-18 14:51:59 +0100188VirtIODevice *virtio_balloon_init(DeviceState *dev);
189
Gerd Hoffmann97b15622009-10-21 15:25:35 +0200190void virtio_net_exit(VirtIODevice *vdev);
191
Michael S. Tsirkin81725392010-01-10 13:52:53 +0200192#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
193 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
194 VIRTIO_RING_F_INDIRECT_DESC, true)
195
Michael S. Tsirkin1cbdabe2010-03-17 13:08:02 +0200196target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
197target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
198target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
199target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
200target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
201target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
202target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
203target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
204uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
205void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
206VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
207EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
208EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
209void virtio_irq(VirtQueue *vq);
aliguori967f97f2008-12-04 19:38:57 +0000210#endif