blob: 15ad910768f6e84c54d5ee10aeccfa7e65176ac1 [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
Stefan Weild89c6822009-09-24 17:53:10 +020034/* We notify when the ring is completely used, even if the guest is suppressing
aliguori967f97f2008-12-04 19:38:57 +000035 * callbacks */
36#define VIRTIO_F_NOTIFY_ON_EMPTY 24
Mark McLoughlinefeea6d2009-06-17 11:38:28 +010037/* We support indirect buffer descriptors */
38#define VIRTIO_RING_F_INDIRECT_DESC 28
aliguori8eca6b12009-04-05 17:40:08 +000039/* A guest should never accept this. It implies negotiation is broken. */
40#define VIRTIO_F_BAD_FEATURE 30
aliguori967f97f2008-12-04 19:38:57 +000041
42/* from Linux's linux/virtio_ring.h */
43
44/* This marks a buffer as continuing via the next field. */
45#define VRING_DESC_F_NEXT 1
46/* This marks a buffer as write-only (otherwise read-only). */
47#define VRING_DESC_F_WRITE 2
Mark McLoughlinefeea6d2009-06-17 11:38:28 +010048/* This means the buffer contains a list of buffer descriptors. */
49#define VRING_DESC_F_INDIRECT 4
aliguori967f97f2008-12-04 19:38:57 +000050
51/* This means don't notify other side when buffer added. */
52#define VRING_USED_F_NO_NOTIFY 1
53/* This means don't interrupt guest when buffer consumed. */
54#define VRING_AVAIL_F_NO_INTERRUPT 1
55
56struct VirtQueue;
57
Anthony Liguoric227f092009-10-01 16:12:16 -050058static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
aliguorif46f15b2008-12-04 19:58:45 +000059 unsigned long align)
60{
61 return (addr + align - 1) & ~(align - 1);
62}
63
aliguori967f97f2008-12-04 19:38:57 +000064typedef struct VirtQueue VirtQueue;
65typedef struct VirtIODevice VirtIODevice;
66
67#define VIRTQUEUE_MAX_SIZE 1024
68
69typedef struct VirtQueueElement
70{
71 unsigned int index;
72 unsigned int out_num;
73 unsigned int in_num;
Anthony Liguoric227f092009-10-01 16:12:16 -050074 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
aliguori967f97f2008-12-04 19:38:57 +000075 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
76 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
77} VirtQueueElement;
78
Paul Brook53c25ce2009-05-18 14:51:59 +010079typedef struct {
Michael S. Tsirkin7055e682009-06-21 19:50:13 +030080 void (*notify)(void * opaque, uint16_t vector);
Michael S. Tsirkinff24bd52009-06-21 19:50:40 +030081 void (*save_config)(void * opaque, QEMUFile *f);
82 void (*save_queue)(void * opaque, int n, QEMUFile *f);
83 int (*load_config)(void * opaque, QEMUFile *f);
84 int (*load_queue)(void * opaque, int n, QEMUFile *f);
Paul Brook53c25ce2009-05-18 14:51:59 +010085} VirtIOBindings;
86
aliguori967f97f2008-12-04 19:38:57 +000087#define VIRTIO_PCI_QUEUE_MAX 16
88
Michael S. Tsirkin7055e682009-06-21 19:50:13 +030089#define VIRTIO_NO_VECTOR 0xffff
90
aliguori967f97f2008-12-04 19:38:57 +000091struct VirtIODevice
92{
aliguori967f97f2008-12-04 19:38:57 +000093 const char *name;
aliguori967f97f2008-12-04 19:38:57 +000094 uint8_t status;
95 uint8_t isr;
96 uint16_t queue_sel;
97 uint32_t features;
98 size_t config_len;
99 void *config;
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300100 uint16_t config_vector;
101 int nvectors;
aliguori967f97f2008-12-04 19:38:57 +0000102 uint32_t (*get_features)(VirtIODevice *vdev);
aliguori8eca6b12009-04-05 17:40:08 +0000103 uint32_t (*bad_features)(VirtIODevice *vdev);
aliguori967f97f2008-12-04 19:38:57 +0000104 void (*set_features)(VirtIODevice *vdev, uint32_t val);
105 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
106 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
107 void (*reset)(VirtIODevice *vdev);
108 VirtQueue *vq;
Paul Brook53c25ce2009-05-18 14:51:59 +0100109 const VirtIOBindings *binding;
110 void *binding_opaque;
111 uint16_t device_id;
aliguori967f97f2008-12-04 19:38:57 +0000112};
113
aliguori967f97f2008-12-04 19:38:57 +0000114VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
115 void (*handle_output)(VirtIODevice *,
116 VirtQueue *));
117
118void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
119 unsigned int len);
120void virtqueue_flush(VirtQueue *vq, unsigned int count);
121void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
122 unsigned int len, unsigned int idx);
123
124int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
125int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
126
127void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
128
129void virtio_save(VirtIODevice *vdev, QEMUFile *f);
130
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300131int virtio_load(VirtIODevice *vdev, QEMUFile *f);
aliguori967f97f2008-12-04 19:38:57 +0000132
aliguorib946a152009-04-17 17:11:08 +0000133void virtio_cleanup(VirtIODevice *vdev);
134
aliguori967f97f2008-12-04 19:38:57 +0000135void virtio_notify_config(VirtIODevice *vdev);
136
137void virtio_queue_set_notification(VirtQueue *vq, int enable);
138
139int virtio_queue_ready(VirtQueue *vq);
140
141int virtio_queue_empty(VirtQueue *vq);
142
Paul Brook53c25ce2009-05-18 14:51:59 +0100143/* Host binding interface. */
144
145VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
146 size_t config_size, size_t struct_size);
147uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
148uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
149uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
150void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
151void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
152void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
Anthony Liguoric227f092009-10-01 16:12:16 -0500153void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
154target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
Paul Brook53c25ce2009-05-18 14:51:59 +0100155int virtio_queue_get_num(VirtIODevice *vdev, int n);
156void virtio_queue_notify(VirtIODevice *vdev, int n);
Michael S. Tsirkin7055e682009-06-21 19:50:13 +0300157uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
158void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
Paul Brook53c25ce2009-05-18 14:51:59 +0100159void virtio_reset(void *opaque);
160void virtio_update_irq(VirtIODevice *vdev);
161
162void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
163 void *opaque);
164
165/* Base devices. */
Gerd Hoffmannd176c492009-07-31 12:25:41 +0200166VirtIODevice *virtio_blk_init(DeviceState *dev, DriveInfo *dinfo);
Gerd Hoffmann97b15622009-10-21 15:25:35 +0200167VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf);
Paul Brook53c25ce2009-05-18 14:51:59 +0100168VirtIODevice *virtio_console_init(DeviceState *dev);
169VirtIODevice *virtio_balloon_init(DeviceState *dev);
170
Gerd Hoffmann97b15622009-10-21 15:25:35 +0200171void virtio_net_exit(VirtIODevice *vdev);
172
aliguori967f97f2008-12-04 19:38:57 +0000173#endif