blob: 35532a6f25ff847915f3495825d33ab93dccbc35 [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"
aliguori967f97f2008-12-04 19:38:57 +000021
22/* from Linux's linux/virtio_config.h */
23
24/* Status byte for guest to report progress, and synchronize features. */
25/* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
26#define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
27/* We have found a driver for the device. */
28#define VIRTIO_CONFIG_S_DRIVER 2
29/* Driver has used its parts of the config, and is happy */
30#define VIRTIO_CONFIG_S_DRIVER_OK 4
31/* We've given up on this device. */
32#define VIRTIO_CONFIG_S_FAILED 0x80
33
Michael S. Tsirkin6d74ca52009-12-08 20:07:48 +020034/* Some virtio feature bits (currently bits 28 through 31) are reserved for the
35 * transport being used (eg. virtio_ring), the rest are per-device feature bits. */
36#define VIRTIO_TRANSPORT_F_START 28
37#define VIRTIO_TRANSPORT_F_END 32
38
Stefan Weild89c6822009-09-24 17:53:10 +020039/* We notify when the ring is completely used, even if the guest is suppressing
aliguori967f97f2008-12-04 19:38:57 +000040 * callbacks */
41#define VIRTIO_F_NOTIFY_ON_EMPTY 24
Mark McLoughlinefeea6d2009-06-17 11:38:28 +010042/* We support indirect buffer descriptors */
43#define VIRTIO_RING_F_INDIRECT_DESC 28
aliguori8eca6b12009-04-05 17:40:08 +000044/* A guest should never accept this. It implies negotiation is broken. */
45#define VIRTIO_F_BAD_FEATURE 30
aliguori967f97f2008-12-04 19:38:57 +000046
47/* from Linux's linux/virtio_ring.h */
48
49/* This marks a buffer as continuing via the next field. */
50#define VRING_DESC_F_NEXT 1
51/* This marks a buffer as write-only (otherwise read-only). */
52#define VRING_DESC_F_WRITE 2
Mark McLoughlinefeea6d2009-06-17 11:38:28 +010053/* This means the buffer contains a list of buffer descriptors. */
54#define VRING_DESC_F_INDIRECT 4
aliguori967f97f2008-12-04 19:38:57 +000055
56/* This means don't notify other side when buffer added. */
57#define VRING_USED_F_NO_NOTIFY 1
58/* This means don't interrupt guest when buffer consumed. */
59#define VRING_AVAIL_F_NO_INTERRUPT 1
60
61struct VirtQueue;
62
Anthony Liguoric227f092009-10-01 16:12:16 -050063static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
aliguorif46f15b2008-12-04 19:58:45 +000064 unsigned long align)
65{
66 return (addr + align - 1) & ~(align - 1);
67}
68
aliguori967f97f2008-12-04 19:38:57 +000069typedef struct VirtQueue VirtQueue;
70typedef struct VirtIODevice VirtIODevice;
71
72#define VIRTQUEUE_MAX_SIZE 1024
73
74typedef struct VirtQueueElement
75{
76 unsigned int index;
77 unsigned int out_num;
78 unsigned int in_num;
Anthony Liguoric227f092009-10-01 16:12:16 -050079 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
aliguori967f97f2008-12-04 19:38:57 +000080 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
81 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
82} VirtQueueElement;
83
Paul Brook53c25ce2009-05-18 14:51:59 +010084typedef struct {
Michael S. Tsirkin7055e682009-06-21 19:50:13 +030085 void (*notify)(void * opaque, uint16_t vector);
Michael S. Tsirkinff24bd52009-06-21 19:50:40 +030086 void (*save_config)(void * opaque, QEMUFile *f);
87 void (*save_queue)(void * opaque, int n, QEMUFile *f);
88 int (*load_config)(void * opaque, QEMUFile *f);
89 int (*load_queue)(void * opaque, int n, QEMUFile *f);
Michael S. Tsirkin6d74ca52009-12-08 20:07:48 +020090 unsigned (*get_features)(void * opaque);
Paul Brook53c25ce2009-05-18 14:51:59 +010091} VirtIOBindings;
92
aliguori967f97f2008-12-04 19:38:57 +000093#define VIRTIO_PCI_QUEUE_MAX 16
94
Michael S. Tsirkin7055e682009-06-21 19:50:13 +030095#define VIRTIO_NO_VECTOR 0xffff
96
aliguori967f97f2008-12-04 19:38:57 +000097struct VirtIODevice
98{
aliguori967f97f2008-12-04 19:38:57 +000099 const char *name;
aliguori967f97f2008-12-04 19:38:57 +0000100 uint8_t status;
101 uint8_t isr;
102 uint16_t queue_sel;
103 uint32_t features;
104 size_t config_len;
105 void *config;
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300106 uint16_t config_vector;
107 int nvectors;
aliguori967f97f2008-12-04 19:38:57 +0000108 uint32_t (*get_features)(VirtIODevice *vdev);
aliguori8eca6b12009-04-05 17:40:08 +0000109 uint32_t (*bad_features)(VirtIODevice *vdev);
aliguori967f97f2008-12-04 19:38:57 +0000110 void (*set_features)(VirtIODevice *vdev, uint32_t val);
111 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
112 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
113 void (*reset)(VirtIODevice *vdev);
114 VirtQueue *vq;
Paul Brook53c25ce2009-05-18 14:51:59 +0100115 const VirtIOBindings *binding;
116 void *binding_opaque;
117 uint16_t device_id;
aliguori967f97f2008-12-04 19:38:57 +0000118};
119
aliguori967f97f2008-12-04 19:38:57 +0000120VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
121 void (*handle_output)(VirtIODevice *,
122 VirtQueue *));
123
124void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
125 unsigned int len);
126void virtqueue_flush(VirtQueue *vq, unsigned int count);
127void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
128 unsigned int len, unsigned int idx);
129
130int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
131int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
132
133void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
134
135void virtio_save(VirtIODevice *vdev, QEMUFile *f);
136
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300137int virtio_load(VirtIODevice *vdev, QEMUFile *f);
aliguori967f97f2008-12-04 19:38:57 +0000138
aliguorib946a152009-04-17 17:11:08 +0000139void virtio_cleanup(VirtIODevice *vdev);
140
aliguori967f97f2008-12-04 19:38:57 +0000141void virtio_notify_config(VirtIODevice *vdev);
142
143void virtio_queue_set_notification(VirtQueue *vq, int enable);
144
145int virtio_queue_ready(VirtQueue *vq);
146
147int virtio_queue_empty(VirtQueue *vq);
148
Paul Brook53c25ce2009-05-18 14:51:59 +0100149/* Host binding interface. */
150
151VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
152 size_t config_size, size_t struct_size);
153uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
154uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
155uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
156void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
157void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
158void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
Anthony Liguoric227f092009-10-01 16:12:16 -0500159void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
160target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
Paul Brook53c25ce2009-05-18 14:51:59 +0100161int virtio_queue_get_num(VirtIODevice *vdev, int n);
162void virtio_queue_notify(VirtIODevice *vdev, int n);
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300163uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
164void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
Paul Brook53c25ce2009-05-18 14:51:59 +0100165void virtio_reset(void *opaque);
166void virtio_update_irq(VirtIODevice *vdev);
167
168void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
169 void *opaque);
170
171/* Base devices. */
Gerd Hoffmannd176c492009-07-31 12:25:41 +0200172VirtIODevice *virtio_blk_init(DeviceState *dev, DriveInfo *dinfo);
Gerd Hoffmann97b15622009-10-21 15:25:35 +0200173VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf);
Paul Brook53c25ce2009-05-18 14:51:59 +0100174VirtIODevice *virtio_console_init(DeviceState *dev);
175VirtIODevice *virtio_balloon_init(DeviceState *dev);
176
Gerd Hoffmann97b15622009-10-21 15:25:35 +0200177void virtio_net_exit(VirtIODevice *vdev);
178
aliguori967f97f2008-12-04 19:38:57 +0000179#endif