]>
Commit | Line | Data |
---|---|---|
fbe78f4f AL |
1 | /* |
2 | * Virtio Network Device | |
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_NET_H | |
15 | #define _QEMU_VIRTIO_NET_H | |
16 | ||
0d09e41a | 17 | #include "hw/virtio/virtio.h" |
83c9f4ca | 18 | #include "hw/pci/pci.h" |
fbe78f4f | 19 | |
17ec5a86 KF |
20 | #define TYPE_VIRTIO_NET "virtio-net-device" |
21 | #define VIRTIO_NET(obj) \ | |
22 | OBJECT_CHECK(VirtIONet, (obj), TYPE_VIRTIO_NET) | |
23 | ||
79674068 AL |
24 | #define ETH_ALEN 6 |
25 | ||
fbe78f4f AL |
26 | /* from Linux's virtio_net.h */ |
27 | ||
28 | /* The ID for virtio_net */ | |
29 | #define VIRTIO_ID_NET 1 | |
30 | ||
31 | /* The feature bitmap for virtio net */ | |
32 | #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */ | |
33 | #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */ | |
34 | #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ | |
35 | #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ | |
36 | #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ | |
37 | #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ | |
38 | #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ | |
39 | #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ | |
40 | #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ | |
41 | #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ | |
42 | #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ | |
43 | #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ | |
44 | #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ | |
554c97dd | 45 | #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ |
3d11d36c | 46 | #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ |
002437cd | 47 | #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ |
f21c0ed9 | 48 | #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ |
015cb166 | 49 | #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ |
fed699f9 JW |
50 | #define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow |
51 | * Steering */ | |
554c97dd | 52 | |
c1943a3f AK |
53 | #define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */ |
54 | ||
554c97dd | 55 | #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ |
fbe78f4f AL |
56 | |
57 | #define TX_TIMER_INTERVAL 150000 /* 150 us */ | |
58 | ||
e3f30488 AW |
59 | /* Limit the number of packets that can be sent via a single flush |
60 | * of the TX queue. This gives us a guaranteed exit condition and | |
61 | * ensures fairness in the io path. 256 conveniently matches the | |
62 | * length of the TX queue and shows a good balance of performance | |
63 | * and latency. */ | |
64 | #define TX_BURST 256 | |
65 | ||
f0c07c7c AW |
66 | typedef struct virtio_net_conf |
67 | { | |
68 | uint32_t txtimer; | |
e3f30488 | 69 | int32_t txburst; |
a697a334 | 70 | char *tx; |
f0c07c7c AW |
71 | } virtio_net_conf; |
72 | ||
fbe78f4f AL |
73 | /* Maximum packet size we can receive from tap device: header + 64k */ |
74 | #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10)) | |
75 | ||
fbe78f4f AL |
76 | struct virtio_net_config |
77 | { | |
ebbeb789 AK |
78 | /* The config defining mac address ($ETH_ALEN bytes) */ |
79 | uint8_t mac[ETH_ALEN]; | |
554c97dd AL |
80 | /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ |
81 | uint16_t status; | |
fed699f9 JW |
82 | /* Max virtqueue pairs supported by the device */ |
83 | uint16_t max_virtqueue_pairs; | |
541dc0d4 | 84 | } QEMU_PACKED; |
fbe78f4f | 85 | |
3d11d36c AL |
86 | /* |
87 | * Control virtqueue data structures | |
88 | * | |
89 | * The control virtqueue expects a header in the first sg entry | |
90 | * and an ack/status response in the last entry. Data for the | |
91 | * command goes in between. | |
92 | */ | |
93 | struct virtio_net_ctrl_hdr { | |
94 | uint8_t class; | |
95 | uint8_t cmd; | |
96 | }; | |
97 | ||
98 | typedef uint8_t virtio_net_ctrl_ack; | |
99 | ||
100 | #define VIRTIO_NET_OK 0 | |
101 | #define VIRTIO_NET_ERR 1 | |
102 | ||
002437cd | 103 | /* |
015cb166 AW |
104 | * Control the RX mode, ie. promisucous, allmulti, etc... |
105 | * All commands require an "out" sg entry containing a 1 byte | |
106 | * state value, zero = disable, non-zero = enable. Commands | |
107 | * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. | |
108 | * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. | |
002437cd | 109 | */ |
dd23454b AK |
110 | #define VIRTIO_NET_CTRL_RX 0 |
111 | #define VIRTIO_NET_CTRL_RX_PROMISC 0 | |
112 | #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 | |
113 | #define VIRTIO_NET_CTRL_RX_ALLUNI 2 | |
114 | #define VIRTIO_NET_CTRL_RX_NOMULTI 3 | |
115 | #define VIRTIO_NET_CTRL_RX_NOUNI 4 | |
116 | #define VIRTIO_NET_CTRL_RX_NOBCAST 5 | |
002437cd | 117 | |
b6503ed9 | 118 | /* |
c1943a3f | 119 | * Control the MAC |
b6503ed9 AL |
120 | * |
121 | * The MAC filter table is managed by the hypervisor, the guest should | |
122 | * assume the size is infinite. Filtering should be considered | |
123 | * non-perfect, ie. based on hypervisor resources, the guest may | |
124 | * received packets from sources not specified in the filter list. | |
125 | * | |
126 | * In addition to the class/cmd header, the TABLE_SET command requires | |
127 | * two out scatterlists. Each contains a 4 byte count of entries followed | |
128 | * by a concatenated byte stream of the ETH_ALEN MAC addresses. The | |
129 | * first sg list contains unicast addresses, the second is for multicast. | |
130 | * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature | |
131 | * is available. | |
c1943a3f AK |
132 | * |
133 | * The ADDR_SET command requests one out scatterlist, it contains a | |
134 | * 6 bytes MAC address. This functionality is present if the | |
135 | * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available. | |
b6503ed9 AL |
136 | */ |
137 | struct virtio_net_ctrl_mac { | |
138 | uint32_t entries; | |
139 | uint8_t macs[][ETH_ALEN]; | |
140 | }; | |
f1b24e84 KF |
141 | |
142 | typedef struct VirtIONetQueue { | |
143 | VirtQueue *rx_vq; | |
144 | VirtQueue *tx_vq; | |
145 | QEMUTimer *tx_timer; | |
146 | QEMUBH *tx_bh; | |
147 | int tx_waiting; | |
148 | struct { | |
149 | VirtQueueElement elem; | |
150 | ssize_t len; | |
151 | } async_tx; | |
152 | struct VirtIONet *n; | |
153 | } VirtIONetQueue; | |
154 | ||
155 | typedef struct VirtIONet { | |
17a0ca55 | 156 | VirtIODevice parent_obj; |
f1b24e84 KF |
157 | uint8_t mac[ETH_ALEN]; |
158 | uint16_t status; | |
159 | VirtIONetQueue *vqs; | |
160 | VirtQueue *ctrl_vq; | |
161 | NICState *nic; | |
162 | uint32_t tx_timeout; | |
163 | int32_t tx_burst; | |
164 | uint32_t has_vnet_hdr; | |
165 | size_t host_hdr_len; | |
166 | size_t guest_hdr_len; | |
167 | uint8_t has_ufo; | |
168 | int mergeable_rx_bufs; | |
169 | uint8_t promisc; | |
170 | uint8_t allmulti; | |
171 | uint8_t alluni; | |
172 | uint8_t nomulti; | |
173 | uint8_t nouni; | |
174 | uint8_t nobcast; | |
175 | uint8_t vhost_started; | |
176 | struct { | |
177 | int in_use; | |
178 | int first_multi; | |
179 | uint8_t multi_overflow; | |
180 | uint8_t uni_overflow; | |
181 | uint8_t *macs; | |
182 | } mac_table; | |
183 | uint32_t *vlans; | |
17ec5a86 KF |
184 | virtio_net_conf net_conf; |
185 | NICConf nic_conf; | |
f1b24e84 KF |
186 | DeviceState *qdev; |
187 | int multiqueue; | |
188 | uint16_t max_queues; | |
189 | uint16_t curr_queues; | |
190 | size_t config_size; | |
8a253ec2 KF |
191 | char *netclient_name; |
192 | char *netclient_type; | |
f1b24e84 KF |
193 | } VirtIONet; |
194 | ||
b6503ed9 AL |
195 | #define VIRTIO_NET_CTRL_MAC 1 |
196 | #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 | |
c1943a3f | 197 | #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1 |
b6503ed9 | 198 | |
f21c0ed9 AL |
199 | /* |
200 | * Control VLAN filtering | |
201 | * | |
202 | * The VLAN filter table is controlled via a simple ADD/DEL interface. | |
203 | * VLAN IDs not added may be filterd by the hypervisor. Del is the | |
204 | * opposite of add. Both commands expect an out entry containing a 2 | |
205 | * byte VLAN ID. VLAN filterting is available with the | |
206 | * VIRTIO_NET_F_CTRL_VLAN feature bit. | |
207 | */ | |
208 | #define VIRTIO_NET_CTRL_VLAN 2 | |
209 | #define VIRTIO_NET_CTRL_VLAN_ADD 0 | |
210 | #define VIRTIO_NET_CTRL_VLAN_DEL 1 | |
211 | ||
fed699f9 JW |
212 | /* |
213 | * Control Multiqueue | |
214 | * | |
215 | * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET | |
216 | * enables multiqueue, specifying the number of the transmit and | |
217 | * receive queues that will be used. After the command is consumed and acked by | |
218 | * the device, the device will not steer new packets on receive virtqueues | |
219 | * other than specified nor read from transmit virtqueues other than specified. | |
220 | * Accordingly, driver should not transmit new packets on virtqueues other than | |
221 | * specified. | |
222 | */ | |
223 | struct virtio_net_ctrl_mq { | |
224 | uint16_t virtqueue_pairs; | |
225 | }; | |
226 | ||
227 | #define VIRTIO_NET_CTRL_MQ 4 | |
228 | #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 | |
229 | #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 | |
230 | #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 | |
231 | ||
8172539d MT |
232 | #define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \ |
233 | DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \ | |
234 | DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \ | |
235 | DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \ | |
8172539d MT |
236 | DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \ |
237 | DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \ | |
238 | DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \ | |
239 | DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \ | |
240 | DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \ | |
241 | DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \ | |
242 | DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \ | |
243 | DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \ | |
244 | DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \ | |
245 | DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \ | |
246 | DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \ | |
247 | DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \ | |
248 | DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \ | |
249 | DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \ | |
c1943a3f | 250 | DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true), \ |
fed699f9 | 251 | DEFINE_PROP_BIT("ctrl_mac_addr", _state, _field, VIRTIO_NET_F_CTRL_MAC_ADDR, true), \ |
32ab06bc | 252 | DEFINE_PROP_BIT("mq", _state, _field, VIRTIO_NET_F_MQ, false) |
fed699f9 | 253 | |
17ec5a86 KF |
254 | #define DEFINE_VIRTIO_NET_PROPERTIES(_state, _field) \ |
255 | DEFINE_PROP_UINT32("x-txtimer", _state, _field.txtimer, TX_TIMER_INTERVAL),\ | |
256 | DEFINE_PROP_INT32("x-txburst", _state, _field.txburst, TX_BURST), \ | |
257 | DEFINE_PROP_STRING("tx", _state, _field.tx) | |
258 | ||
259 | void virtio_net_set_config_size(VirtIONet *n, uint32_t host_features); | |
8a253ec2 KF |
260 | void virtio_net_set_netclient_name(VirtIONet *n, const char *name, |
261 | const char *type); | |
17ec5a86 | 262 | |
fbe78f4f | 263 | #endif |