]>
Commit | Line | Data |
---|---|---|
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 | ||
967f97fa | 17 | #include "hw.h" |
53c25cea | 18 | #include "qdev.h" |
967f97fa AL |
19 | |
20 | /* from Linux's linux/virtio_config.h */ | |
21 | ||
22 | /* Status byte for guest to report progress, and synchronize features. */ | |
23 | /* We have seen device and processed generic fields (VIRTIO_CONFIG_F_VIRTIO) */ | |
24 | #define VIRTIO_CONFIG_S_ACKNOWLEDGE 1 | |
25 | /* We have found a driver for the device. */ | |
26 | #define VIRTIO_CONFIG_S_DRIVER 2 | |
27 | /* Driver has used its parts of the config, and is happy */ | |
28 | #define VIRTIO_CONFIG_S_DRIVER_OK 4 | |
29 | /* We've given up on this device. */ | |
30 | #define VIRTIO_CONFIG_S_FAILED 0x80 | |
31 | ||
32 | /* We notify when the ring is completely used, even if the guest is supressing | |
33 | * callbacks */ | |
34 | #define VIRTIO_F_NOTIFY_ON_EMPTY 24 | |
efeea6d0 MM |
35 | /* We support indirect buffer descriptors */ |
36 | #define VIRTIO_RING_F_INDIRECT_DESC 28 | |
8eca6b1b AL |
37 | /* A guest should never accept this. It implies negotiation is broken. */ |
38 | #define VIRTIO_F_BAD_FEATURE 30 | |
967f97fa AL |
39 | |
40 | /* from Linux's linux/virtio_ring.h */ | |
41 | ||
42 | /* This marks a buffer as continuing via the next field. */ | |
43 | #define VRING_DESC_F_NEXT 1 | |
44 | /* This marks a buffer as write-only (otherwise read-only). */ | |
45 | #define VRING_DESC_F_WRITE 2 | |
efeea6d0 MM |
46 | /* This means the buffer contains a list of buffer descriptors. */ |
47 | #define VRING_DESC_F_INDIRECT 4 | |
967f97fa AL |
48 | |
49 | /* This means don't notify other side when buffer added. */ | |
50 | #define VRING_USED_F_NO_NOTIFY 1 | |
51 | /* This means don't interrupt guest when buffer consumed. */ | |
52 | #define VRING_AVAIL_F_NO_INTERRUPT 1 | |
53 | ||
54 | struct VirtQueue; | |
55 | ||
f46f15bc AL |
56 | static inline target_phys_addr_t vring_align(target_phys_addr_t addr, |
57 | unsigned long align) | |
58 | { | |
59 | return (addr + align - 1) & ~(align - 1); | |
60 | } | |
61 | ||
967f97fa AL |
62 | typedef struct VirtQueue VirtQueue; |
63 | typedef struct VirtIODevice VirtIODevice; | |
64 | ||
65 | #define VIRTQUEUE_MAX_SIZE 1024 | |
66 | ||
67 | typedef struct VirtQueueElement | |
68 | { | |
69 | unsigned int index; | |
70 | unsigned int out_num; | |
71 | unsigned int in_num; | |
72 | target_phys_addr_t in_addr[VIRTQUEUE_MAX_SIZE]; | |
73 | struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; | |
74 | struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; | |
75 | } VirtQueueElement; | |
76 | ||
53c25cea | 77 | typedef struct { |
7055e687 | 78 | void (*notify)(void * opaque, uint16_t vector); |
ff24bd58 MT |
79 | void (*save_config)(void * opaque, QEMUFile *f); |
80 | void (*save_queue)(void * opaque, int n, QEMUFile *f); | |
81 | int (*load_config)(void * opaque, QEMUFile *f); | |
82 | int (*load_queue)(void * opaque, int n, QEMUFile *f); | |
53c25cea PB |
83 | } VirtIOBindings; |
84 | ||
967f97fa AL |
85 | #define VIRTIO_PCI_QUEUE_MAX 16 |
86 | ||
7055e687 MT |
87 | #define VIRTIO_NO_VECTOR 0xffff |
88 | ||
967f97fa AL |
89 | struct VirtIODevice |
90 | { | |
967f97fa | 91 | const char *name; |
967f97fa AL |
92 | uint8_t status; |
93 | uint8_t isr; | |
94 | uint16_t queue_sel; | |
95 | uint32_t features; | |
96 | size_t config_len; | |
97 | void *config; | |
7055e687 MT |
98 | uint16_t config_vector; |
99 | int nvectors; | |
967f97fa | 100 | uint32_t (*get_features)(VirtIODevice *vdev); |
8eca6b1b | 101 | uint32_t (*bad_features)(VirtIODevice *vdev); |
967f97fa AL |
102 | void (*set_features)(VirtIODevice *vdev, uint32_t val); |
103 | void (*get_config)(VirtIODevice *vdev, uint8_t *config); | |
104 | void (*set_config)(VirtIODevice *vdev, const uint8_t *config); | |
105 | void (*reset)(VirtIODevice *vdev); | |
106 | VirtQueue *vq; | |
53c25cea PB |
107 | const VirtIOBindings *binding; |
108 | void *binding_opaque; | |
109 | uint16_t device_id; | |
967f97fa AL |
110 | }; |
111 | ||
967f97fa AL |
112 | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, |
113 | void (*handle_output)(VirtIODevice *, | |
114 | VirtQueue *)); | |
115 | ||
116 | void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, | |
117 | unsigned int len); | |
118 | void virtqueue_flush(VirtQueue *vq, unsigned int count); | |
119 | void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, | |
120 | unsigned int len, unsigned int idx); | |
121 | ||
122 | int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem); | |
123 | int virtqueue_avail_bytes(VirtQueue *vq, int in_bytes, int out_bytes); | |
124 | ||
125 | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); | |
126 | ||
127 | void virtio_save(VirtIODevice *vdev, QEMUFile *f); | |
128 | ||
7055e687 | 129 | int virtio_load(VirtIODevice *vdev, QEMUFile *f); |
967f97fa | 130 | |
b946a153 AL |
131 | void virtio_cleanup(VirtIODevice *vdev); |
132 | ||
967f97fa AL |
133 | void virtio_notify_config(VirtIODevice *vdev); |
134 | ||
135 | void virtio_queue_set_notification(VirtQueue *vq, int enable); | |
136 | ||
137 | int virtio_queue_ready(VirtQueue *vq); | |
138 | ||
139 | int virtio_queue_empty(VirtQueue *vq); | |
140 | ||
53c25cea PB |
141 | /* Host binding interface. */ |
142 | ||
143 | VirtIODevice *virtio_common_init(const char *name, uint16_t device_id, | |
144 | size_t config_size, size_t struct_size); | |
145 | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); | |
146 | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); | |
147 | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); | |
148 | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
149 | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
150 | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
151 | void virtio_queue_set_addr(VirtIODevice *vdev, int n, target_phys_addr_t addr); | |
152 | target_phys_addr_t virtio_queue_get_addr(VirtIODevice *vdev, int n); | |
153 | int virtio_queue_get_num(VirtIODevice *vdev, int n); | |
154 | void virtio_queue_notify(VirtIODevice *vdev, int n); | |
7055e687 MT |
155 | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); |
156 | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); | |
53c25cea PB |
157 | void virtio_reset(void *opaque); |
158 | void virtio_update_irq(VirtIODevice *vdev); | |
159 | ||
160 | void virtio_bind_device(VirtIODevice *vdev, const VirtIOBindings *binding, | |
161 | void *opaque); | |
162 | ||
163 | /* Base devices. */ | |
164 | VirtIODevice *virtio_blk_init(DeviceState *dev); | |
165 | VirtIODevice *virtio_net_init(DeviceState *dev); | |
166 | VirtIODevice *virtio_console_init(DeviceState *dev); | |
167 | VirtIODevice *virtio_balloon_init(DeviceState *dev); | |
168 | ||
967f97fa | 169 | #endif |