]> Git Repo - qemu.git/blame - hw/virtio.h
projects / qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
tap: safe sndbuf default
[qemu.git] / hw / virtio.h
CommitLineData
967f97fa
AL		 1/*
2 * Virtio Support
3 *
4 * Copyright IBM, Corp. 2007
5 *
6 * Authors:
7 * Anthony Liguori <[email protected]>
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"
97b15621 18#include "net.h"
53c25cea 19#include "qdev.h"
d176c495 20#include "sysemu.h"
428c149b 21#include "block_int.h"
1cbdabe2 22#include "event_notifier.h"
9f107513
AL		 23#ifdef CONFIG_LINUX
24#include "9p.h"
25#endif
967f97fa
AL		 26
27/* from Linux's linux/virtio_config.h */
28
29/* Status byte for guest to report progress, and synchronize features. */
30/* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */
31#define VIRTIO_CONFIG_S_ACKNOWLEDGE 1
32/* We have found a driver for the device. */
33#define VIRTIO_CONFIG_S_DRIVER 2
34/* Driver has used its parts of the config, and is happy */
35#define VIRTIO_CONFIG_S_DRIVER_OK 4
36/* We've given up on this device. */
37#define VIRTIO_CONFIG_S_FAILED 0x80
38
6d74ca5a
MT		 39/* Some virtio feature bits (currently bits 28 through 31) are reserved for the
40 * transport being used (eg. virtio_ring), the rest are per-device feature bits. */
41#define VIRTIO_TRANSPORT_F_START 28
42#define VIRTIO_TRANSPORT_F_END 32
43
d89c682f 44/* We notify when the ring is completely used, even if the guest is suppressing
967f97fa
AL		 45 * callbacks */
46#define VIRTIO_F_NOTIFY_ON_EMPTY 24
efeea6d0
MM		 47/* We support indirect buffer descriptors */
48#define VIRTIO_RING_F_INDIRECT_DESC 28
8eca6b1b
AL		 49/* A guest should never accept this. It implies negotiation is broken. */
50#define VIRTIO_F_BAD_FEATURE 30
967f97fa
AL		 51
52/* from Linux's linux/virtio_ring.h */
53
54/* This marks a buffer as continuing via the next field. */
55#define VRING_DESC_F_NEXT 1
56/* This marks a buffer as write-only (otherwise read-only). */
57#define VRING_DESC_F_WRITE 2
efeea6d0
MM		 58/* This means the buffer contains a list of buffer descriptors. */
59#define VRING_DESC_F_INDIRECT 4
967f97fa
AL		 60
61/* This means don't notify other side when buffer added. */
62#define VRING_USED_F_NO_NOTIFY 1
63/* This means don't interrupt guest when buffer consumed. */
64#define VRING_AVAIL_F_NO_INTERRUPT 1
65
66struct VirtQueue;
67
c227f099 68static inline target_phys_addr_t vring_align(target_phys_addr_t addr,
f46f15bc
AL		 69 unsigned long align)
70{
71 return (addr + align - 1) & ~(align - 1);
72}
73
967f97fa 74typedef struct VirtQueue VirtQueue;
967f97fa
AL		 75
76#define VIRTQUEUE_MAX_SIZE 1024
77
78typedef struct VirtQueueElement
79{
80 unsigned int index;
81 unsigned int out_num;
82 unsigned int in_num;
c227f099 83 target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE];
42fb2e07 84 target_phys_addr_t out_addr[VIRTQUEUE_MAX_SIZE];
967f97fa
AL		 85 struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
86 struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
87} VirtQueueElement;
88
53c25cea 89typedef struct {
7055e687 90 void (*notify)(void * opaque, uint16_t vector);
ff24bd58
MT		 91 void (*save_config)(void * opaque, QEMUFile *f);
92 void (*save_queue)(void * opaque, int n, QEMUFile *f);
93 int (*load_config)(void * opaque, QEMUFile *f);
94 int (*load_queue)(void * opaque, int n, QEMUFile *f);
6d74ca5a 95 unsigned (*get_features)(void * opaque);
54dd9321 96 int (*set_guest_notifiers)(void * opaque, bool assigned);
1cbdabe2 97 int (*set_host_notifier)(void * opaque, int n, bool assigned);
85cf2a8d 98 void (*vmstate_change)(void * opaque, bool running);
53c25cea
PB		 99} VirtIOBindings;
100
bb61564c 101#define VIRTIO_PCI_QUEUE_MAX 64
967f97fa 102
7055e687
MT		 103#define VIRTIO_NO_VECTOR 0xffff
104
967f97fa
AL		 105struct VirtIODevice
106{
967f97fa 107 const char *name;
967f97fa
AL		 108 uint8_t status;
109 uint8_t isr;
110 uint16_t queue_sel;
704a76fc 111 uint32_t guest_features;
967f97fa
AL		 112 size_t config_len;
113 void *config;
7055e687
MT		 114 uint16_t config_vector;
115 int nvectors;
8172539d 116 uint32_t (*get_features)(VirtIODevice *vdev, uint32_t requested_features);
8eca6b1b 117 uint32_t (*bad_features)(VirtIODevice *vdev);
967f97fa
AL		 118 void (*set_features)(VirtIODevice *vdev, uint32_t val);
119 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
120 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
121 void (*reset)(VirtIODevice *vdev);
3e607cb5 122 void (*set_status)(VirtIODevice *vdev, uint8_t val);
967f97fa 123 VirtQueue *vq;
53c25cea
PB		 124 const VirtIOBindings *binding;
125 void *binding_opaque;
126 uint16_t device_id;
85cf2a8d
MT		 127 bool vm_running;
128 VMChangeStateEntry *vmstate;
967f97fa
AL		 129};
130
3e607cb5
MT		 131static inline void virtio_set_status(VirtIODevice *vdev, uint8_t val)
132{
133 if (vdev->set_status) {
134 vdev->set_status(vdev, val);
135 }
136 vdev->status = val;
137}
138
967f97fa
AL		 139VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
140 void (*handle_output)(VirtIODevice *,
141 VirtQueue *));
142
143void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
144 unsigned int len);
145void virtqueue_flush(VirtQueue *vq, unsigned int count);
146void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
147 unsigned int len, unsigned int idx);
148
42fb2e07
KW		 149void virtqueue_map_sg(struct iovec *sg, target_phys_addr_t *addr,
150 size_t num_sg, int is_write);
967f97fa
AL		 151int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
152int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes);
153
154void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
155
156void virtio_save(VirtIODevice *vdev, QEMUFile *f);
157
7055e687 158int virtio_load(VirtIODevice *vdev, QEMUFile *f);
967f97fa 159
b946a153
AL		 160void virtio_cleanup(VirtIODevice *vdev);
161
967f97fa
AL		 162void virtio_notify_config(VirtIODevice *vdev);
163
164void virtio_queue_set_notification(VirtQueue *vq, int enable);
165
166int virtio_queue_ready(VirtQueue *vq);
167
168int virtio_queue_empty(VirtQueue *vq);
169
53c25cea
PB		 170/* Host binding interface. */
171
172VirtIODevice *virtio_common_init(const char *name, uint16_t device_id,
173 size_t config_size, size_t struct_size);
174uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
175uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
176uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
177void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
178void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
179void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
c227f099
AL		 180void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr);
181target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n);
53c25cea
PB		 182int virtio_queue_get_num(VirtIODevice *vdev, int n);
183void virtio_queue_notify(VirtIODevice *vdev, int n);
7055e687
MT		 184uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
185void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
53c25cea
PB		 186void virtio_reset(void *opaque);
187void virtio_update_irq(VirtIODevice *vdev);
188
189void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding,
190 void *opaque);
191
192/* Base devices. */
428c149b 193VirtIODevice *virtio_blk_init(DeviceState *dev, BlockConf *conf);
f0c07c7c
AW		 194struct virtio_net_conf;
195VirtIODevice *virtio_net_init(DeviceState *dev, NICConf *conf,
196 struct virtio_net_conf *net);
98b19252 197VirtIODevice *virtio_serial_init(DeviceState *dev, uint32_t max_nr_ports);
53c25cea 198VirtIODevice *virtio_balloon_init(DeviceState *dev);
9f107513
AL		 199#ifdef CONFIG_LINUX
200VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf);
201#endif
202
53c25cea 203
97b15621 204void virtio_net_exit(VirtIODevice *vdev);
9d0d3138 205void virtio_blk_exit(VirtIODevice *vdev);
8b53a865 206void virtio_serial_exit(VirtIODevice *vdev);
97b15621 207
8172539d
MT		 208#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
209 DEFINE_PROP_BIT("indirect_desc", _state, _field, \
210 VIRTIO_RING_F_INDIRECT_DESC, true)
211
1cbdabe2
MT		 212target_phys_addr_t virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
213target_phys_addr_t virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
214target_phys_addr_t virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
215target_phys_addr_t virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
216target_phys_addr_t virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
217target_phys_addr_t virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
218target_phys_addr_t virtio_queue_get_used_size(VirtIODevice *vdev, int n);
219target_phys_addr_t virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
220uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
221void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
222VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
223EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
224EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
25db9ebe 225void virtio_queue_notify_vq(VirtQueue *vq);
1cbdabe2 226void virtio_irq(VirtQueue *vq);
967f97fa 227#endif
Empty description
This page took 0.432268 seconds and 4 git commands to generate.