virtio_net: document VIRTIO_NET_CTRL_GUEST_OFFLOADS
[deliverable/linux.git] / include / uapi / linux / virtio_net.h
CommitLineData
296f96fc
RR
1#ifndef _LINUX_VIRTIO_NET_H
2#define _LINUX_VIRTIO_NET_H
674bfc23 3/* This header is BSD licensed so anyone can use the definitions to implement
a1b38387
RR
4 * compatible drivers/servers.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of IBM nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE. */
9a0e0ac2 28#include <linux/types.h>
e95646c3 29#include <linux/virtio_ids.h>
296f96fc 30#include <linux/virtio_config.h>
fdd819b2 31#include <linux/virtio_types.h>
c047fcd2 32#include <linux/if_ether.h>
296f96fc 33
a586d4f6 34/* The feature bitmap for virtio net */
5539ae96
RR
35#define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
36#define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
8b0a9d42 37#define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2 /* Dynamic offload configuration. */
34a48579 38#define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
5539ae96
RR
39#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
40#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
41#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
42#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
43#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
44#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
45#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
46#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
3f2c31d9 47#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
9f4d26d0 48#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
2a41f71d 49#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
2af7698e 50#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
0bde9569 51#define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */
e79f07e2 52#define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */
586d17c5
JW
53#define VIRTIO_NET_F_GUEST_ANNOUNCE 21 /* Guest can announce device on the
54 * network */
986a4f4d
JW
55#define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow
56 * Steering */
7e58d5ae 57#define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */
9f4d26d0 58
ed9ecb04
RR
59#ifndef VIRTIO_NET_NO_LEGACY
60#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
61#endif /* VIRTIO_NET_NO_LEGACY */
62
9f4d26d0 63#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
586d17c5 64#define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */
296f96fc 65
1842f23c 66struct virtio_net_config {
a586d4f6 67 /* The config defining mac address (if VIRTIO_NET_F_MAC) */
e216975a 68 __u8 mac[ETH_ALEN];
9f4d26d0
MM
69 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
70 __u16 status;
986a4f4d
JW
71 /* Maximum number of each of transmit and receive queues;
72 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
73 * Legal values are between 1 and 0x8000
74 */
75 __u16 max_virtqueue_pairs;
a586d4f6 76} __attribute__((packed));
296f96fc 77
ed9ecb04
RR
78/*
79 * This header comes first in the scatter-gather list. If you don't
80 * specify GSO or CSUM features, you can simply ignore the header.
81 *
e68c48f9
RR
82 * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf,
83 * only flattened.
ed9ecb04
RR
84 */
85struct virtio_net_hdr_v1 {
86#define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start, csum_offset */
87#define VIRTIO_NET_HDR_F_DATA_VALID 2 /* Csum is valid */
88 __u8 flags;
89#define VIRTIO_NET_HDR_GSO_NONE 0 /* Not a GSO frame */
90#define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */
91#define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */
92#define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */
93#define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */
94 __u8 gso_type;
95 __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */
96 __virtio16 gso_size; /* Bytes to append to hdr_len per frame */
97 __virtio16 csum_start; /* Position to start checksumming from */
98 __virtio16 csum_offset; /* Offset after that to place checksum */
99 __virtio16 num_buffers; /* Number of merged rx buffers */
100};
e68c48f9
RR
101
102#ifndef VIRTIO_NET_NO_LEGACY
103/* This header comes first in the scatter-gather list.
104 * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must
105 * be the first element of the scatter-gather list. If you don't
106 * specify GSO or CSUM features, you can simply ignore the header. */
107struct virtio_net_hdr {
108 /* See VIRTIO_NET_HDR_F_* */
109 __u8 flags;
110 /* See VIRTIO_NET_HDR_GSO_* */
111 __u8 gso_type;
112 __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */
113 __virtio16 gso_size; /* Bytes to append to hdr_len per frame */
114 __virtio16 csum_start; /* Position to start checksumming from */
115 __virtio16 csum_offset; /* Offset after that to place checksum */
116};
117
118/* This is the version of the header to use when the MRG_RXBUF
119 * feature has been negotiated. */
120struct virtio_net_hdr_mrg_rxbuf {
121 struct virtio_net_hdr hdr;
122 __virtio16 num_buffers; /* Number of merged rx buffers */
123};
ed9ecb04 124#endif /* ...VIRTIO_NET_NO_LEGACY */
3f2c31d9 125
2a41f71d
AW
126/*
127 * Control virtqueue data structures
128 *
129 * The control virtqueue expects a header in the first sg entry
130 * and an ack/status response in the last entry. Data for the
131 * command goes in between.
132 */
133struct virtio_net_ctrl_hdr {
134 __u8 class;
135 __u8 cmd;
136} __attribute__((packed));
137
138typedef __u8 virtio_net_ctrl_ack;
139
140#define VIRTIO_NET_OK 0
141#define VIRTIO_NET_ERR 1
142
2af7698e 143/*
e79f07e2
AW
144 * Control the RX mode, ie. promisucous, allmulti, etc...
145 * All commands require an "out" sg entry containing a 1 byte
146 * state value, zero = disable, non-zero = enable. Commands
147 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
148 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
2af7698e
AW
149 */
150#define VIRTIO_NET_CTRL_RX 0
151 #define VIRTIO_NET_CTRL_RX_PROMISC 0
152 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1
e79f07e2
AW
153 #define VIRTIO_NET_CTRL_RX_ALLUNI 2
154 #define VIRTIO_NET_CTRL_RX_NOMULTI 3
155 #define VIRTIO_NET_CTRL_RX_NOUNI 4
156 #define VIRTIO_NET_CTRL_RX_NOBCAST 5
2af7698e 157
f565a7c2 158/*
7e58d5ae 159 * Control the MAC
f565a7c2
AW
160 *
161 * The MAC filter table is managed by the hypervisor, the guest should
162 * assume the size is infinite. Filtering should be considered
163 * non-perfect, ie. based on hypervisor resources, the guest may
164 * received packets from sources not specified in the filter list.
165 *
166 * In addition to the class/cmd header, the TABLE_SET command requires
167 * two out scatterlists. Each contains a 4 byte count of entries followed
168 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The
169 * first sg list contains unicast addresses, the second is for multicast.
170 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
171 * is available.
7e58d5ae
AK
172 *
173 * The ADDR_SET command requests one out scatterlist, it contains a
174 * 6 bytes MAC address. This functionality is present if the
175 * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
f565a7c2
AW
176 */
177struct virtio_net_ctrl_mac {
fdd819b2 178 __virtio32 entries;
f565a7c2
AW
179 __u8 macs[][ETH_ALEN];
180} __attribute__((packed));
181
182#define VIRTIO_NET_CTRL_MAC 1
183 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0
7e58d5ae 184 #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1
f565a7c2 185
0bde9569
AW
186/*
187 * Control VLAN filtering
188 *
189 * The VLAN filter table is controlled via a simple ADD/DEL interface.
190 * VLAN IDs not added may be filterd by the hypervisor. Del is the
191 * opposite of add. Both commands expect an out entry containing a 2
192 * byte VLAN ID. VLAN filterting is available with the
193 * VIRTIO_NET_F_CTRL_VLAN feature bit.
194 */
195#define VIRTIO_NET_CTRL_VLAN 2
196 #define VIRTIO_NET_CTRL_VLAN_ADD 0
197 #define VIRTIO_NET_CTRL_VLAN_DEL 1
198
586d17c5
JW
199/*
200 * Control link announce acknowledgement
201 *
202 * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
203 * driver has recevied the notification; device would clear the
204 * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
205 * this command.
206 */
207#define VIRTIO_NET_CTRL_ANNOUNCE 3
208 #define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0
209
986a4f4d
JW
210/*
211 * Control Receive Flow Steering
212 *
213 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
214 * enables Receive Flow Steering, specifying the number of the transmit and
215 * receive queues that will be used. After the command is consumed and acked by
216 * the device, the device will not steer new packets on receive virtqueues
217 * other than specified nor read from transmit virtqueues other than specified.
218 * Accordingly, driver should not transmit new packets on virtqueues other than
219 * specified.
220 */
221struct virtio_net_ctrl_mq {
fdd819b2 222 __virtio16 virtqueue_pairs;
986a4f4d
JW
223};
224
225#define VIRTIO_NET_CTRL_MQ 4
226 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
227 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
228 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
229
8b0a9d42
MT
230/*
231 * Control network offloads
232 *
233 * Reconfigures the network offloads that Guest can handle.
234 *
235 * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
236 *
237 * Command data format matches the feature bit mask exactly.
238 *
239 * See VIRTIO_NET_F_GUEST_* for the list of offloads
240 * that can be enabled/disabled.
241 */
242#define VIRTIO_NET_CTRL_GUEST_OFFLOADS 5
243#define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET 0
244
296f96fc 245#endif /* _LINUX_VIRTIO_NET_H */
This page took 0.976522 seconds and 5 git commands to generate.