• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 #ifndef _UAPI_LINUX_VIRTIO_NET_H
2 #define _UAPI_LINUX_VIRTIO_NET_H
3 /* This header is BSD licensed so anyone can use the definitions to implement
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. */
28 #include <linux/types.h>
29 #include <linux/virtio_ids.h>
30 #include <linux/virtio_config.h>
31 #include <linux/virtio_types.h>
32 #include <linux/if_ether.h>
33 
34 /* The feature bitmap for virtio net */
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 */
37 #define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2 /* Dynamic offload configuration. */
38 #define VIRTIO_NET_F_MTU	3	/* Initial MTU advice */
39 #define VIRTIO_NET_F_MAC	5	/* Host has given MAC address. */
40 #define VIRTIO_NET_F_GUEST_TSO4	7	/* Guest can handle TSOv4 in. */
41 #define VIRTIO_NET_F_GUEST_TSO6	8	/* Guest can handle TSOv6 in. */
42 #define VIRTIO_NET_F_GUEST_ECN	9	/* Guest can handle TSO[6] w/ ECN in. */
43 #define VIRTIO_NET_F_GUEST_UFO	10	/* Guest can handle UFO in. */
44 #define VIRTIO_NET_F_HOST_TSO4	11	/* Host can handle TSOv4 in. */
45 #define VIRTIO_NET_F_HOST_TSO6	12	/* Host can handle TSOv6 in. */
46 #define VIRTIO_NET_F_HOST_ECN	13	/* Host can handle TSO[6] w/ ECN in. */
47 #define VIRTIO_NET_F_HOST_UFO	14	/* Host can handle UFO in. */
48 #define VIRTIO_NET_F_MRG_RXBUF	15	/* Host can merge receive buffers. */
49 #define VIRTIO_NET_F_STATUS	16	/* virtio_net_config.status available */
50 #define VIRTIO_NET_F_CTRL_VQ	17	/* Control channel available */
51 #define VIRTIO_NET_F_CTRL_RX	18	/* Control channel RX mode support */
52 #define VIRTIO_NET_F_CTRL_VLAN	19	/* Control channel VLAN filtering */
53 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20	/* Extra RX mode control support */
54 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21	/* Guest can announce device on the
55 					 * network */
56 #define VIRTIO_NET_F_MQ	22	/* Device supports Receive Flow
57 					 * Steering */
58 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23	/* Set MAC address */
59 
60 #ifndef VIRTIO_NET_NO_LEGACY
61 #define VIRTIO_NET_F_GSO	6	/* Host handles pkts w/ any GSO type */
62 #endif /* VIRTIO_NET_NO_LEGACY */
63 
64 #define VIRTIO_NET_S_LINK_UP	1	/* Link is up */
65 #define VIRTIO_NET_S_ANNOUNCE	2	/* Announcement is needed */
66 
67 struct virtio_net_config {
68 	/* The config defining mac address (if VIRTIO_NET_F_MAC) */
69 	__u8 mac[ETH_ALEN];
70 	/* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
71 	__u16 status;
72 	/* Maximum number of each of transmit and receive queues;
73 	 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
74 	 * Legal values are between 1 and 0x8000
75 	 */
76 	__u16 max_virtqueue_pairs;
77 	/* Default maximum transmit unit advice */
78 	__u16 mtu;
79 } __attribute__((packed));
80 
81 /*
82  * This header comes first in the scatter-gather list.  If you don't
83  * specify GSO or CSUM features, you can simply ignore the header.
84  *
85  * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf,
86  * only flattened.
87  */
88 struct virtio_net_hdr_v1 {
89 #define VIRTIO_NET_HDR_F_NEEDS_CSUM	1	/* Use csum_start, csum_offset */
90 #define VIRTIO_NET_HDR_F_DATA_VALID	2	/* Csum is valid */
91 	__u8 flags;
92 #define VIRTIO_NET_HDR_GSO_NONE		0	/* Not a GSO frame */
93 #define VIRTIO_NET_HDR_GSO_TCPV4	1	/* GSO frame, IPv4 TCP (TSO) */
94 #define VIRTIO_NET_HDR_GSO_UDP		3	/* GSO frame, IPv4 UDP (UFO) */
95 #define VIRTIO_NET_HDR_GSO_TCPV6	4	/* GSO frame, IPv6 TCP */
96 #define VIRTIO_NET_HDR_GSO_ECN		0x80	/* TCP has ECN set */
97 	__u8 gso_type;
98 	__virtio16 hdr_len;	/* Ethernet + IP + tcp/udp hdrs */
99 	__virtio16 gso_size;	/* Bytes to append to hdr_len per frame */
100 	__virtio16 csum_start;	/* Position to start checksumming from */
101 	__virtio16 csum_offset;	/* Offset after that to place checksum */
102 	__virtio16 num_buffers;	/* Number of merged rx buffers */
103 };
104 
105 #ifndef VIRTIO_NET_NO_LEGACY
106 /* This header comes first in the scatter-gather list.
107  * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must
108  * be the first element of the scatter-gather list.  If you don't
109  * specify GSO or CSUM features, you can simply ignore the header. */
110 struct virtio_net_hdr {
111 	/* See VIRTIO_NET_HDR_F_* */
112 	__u8 flags;
113 	/* See VIRTIO_NET_HDR_GSO_* */
114 	__u8 gso_type;
115 	__virtio16 hdr_len;		/* Ethernet + IP + tcp/udp hdrs */
116 	__virtio16 gso_size;		/* Bytes to append to hdr_len per frame */
117 	__virtio16 csum_start;	/* Position to start checksumming from */
118 	__virtio16 csum_offset;	/* Offset after that to place checksum */
119 };
120 
121 /* This is the version of the header to use when the MRG_RXBUF
122  * feature has been negotiated. */
123 struct virtio_net_hdr_mrg_rxbuf {
124 	struct virtio_net_hdr hdr;
125 	__virtio16 num_buffers;	/* Number of merged rx buffers */
126 };
127 #endif /* ...VIRTIO_NET_NO_LEGACY */
128 
129 /*
130  * Control virtqueue data structures
131  *
132  * The control virtqueue expects a header in the first sg entry
133  * and an ack/status response in the last entry.  Data for the
134  * command goes in between.
135  */
136 struct virtio_net_ctrl_hdr {
137 	__u8 class;
138 	__u8 cmd;
139 } __attribute__((packed));
140 
141 typedef __u8 virtio_net_ctrl_ack;
142 
143 #define VIRTIO_NET_OK     0
144 #define VIRTIO_NET_ERR    1
145 
146 /*
147  * Control the RX mode, ie. promisucous, allmulti, etc...
148  * All commands require an "out" sg entry containing a 1 byte
149  * state value, zero = disable, non-zero = enable.  Commands
150  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
151  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
152  */
153 #define VIRTIO_NET_CTRL_RX    0
154  #define VIRTIO_NET_CTRL_RX_PROMISC      0
155  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
156  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
157  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
158  #define VIRTIO_NET_CTRL_RX_NOUNI        4
159  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
160 
161 /*
162  * Control the MAC
163  *
164  * The MAC filter table is managed by the hypervisor, the guest should
165  * assume the size is infinite.  Filtering should be considered
166  * non-perfect, ie. based on hypervisor resources, the guest may
167  * received packets from sources not specified in the filter list.
168  *
169  * In addition to the class/cmd header, the TABLE_SET command requires
170  * two out scatterlists.  Each contains a 4 byte count of entries followed
171  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
172  * first sg list contains unicast addresses, the second is for multicast.
173  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
174  * is available.
175  *
176  * The ADDR_SET command requests one out scatterlist, it contains a
177  * 6 bytes MAC address. This functionality is present if the
178  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
179  */
180 struct virtio_net_ctrl_mac {
181 	__virtio32 entries;
182 	__u8 macs[][ETH_ALEN];
183 } __attribute__((packed));
184 
185 #define VIRTIO_NET_CTRL_MAC    1
186  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
187  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
188 
189 /*
190  * Control VLAN filtering
191  *
192  * The VLAN filter table is controlled via a simple ADD/DEL interface.
193  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
194  * opposite of add.  Both commands expect an out entry containing a 2
195  * byte VLAN ID.  VLAN filterting is available with the
196  * VIRTIO_NET_F_CTRL_VLAN feature bit.
197  */
198 #define VIRTIO_NET_CTRL_VLAN       2
199  #define VIRTIO_NET_CTRL_VLAN_ADD             0
200  #define VIRTIO_NET_CTRL_VLAN_DEL             1
201 
202 /*
203  * Control link announce acknowledgement
204  *
205  * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
206  * driver has recevied the notification; device would clear the
207  * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
208  * this command.
209  */
210 #define VIRTIO_NET_CTRL_ANNOUNCE       3
211  #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0
212 
213 /*
214  * Control Receive Flow Steering
215  *
216  * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
217  * enables Receive Flow Steering, specifying the number of the transmit and
218  * receive queues that will be used. After the command is consumed and acked by
219  * the device, the device will not steer new packets on receive virtqueues
220  * other than specified nor read from transmit virtqueues other than specified.
221  * Accordingly, driver should not transmit new packets  on virtqueues other than
222  * specified.
223  */
224 struct virtio_net_ctrl_mq {
225 	__virtio16 virtqueue_pairs;
226 };
227 
228 #define VIRTIO_NET_CTRL_MQ   4
229  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
230  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
231  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
232 
233 /*
234  * Control network offloads
235  *
236  * Reconfigures the network offloads that Guest can handle.
237  *
238  * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
239  *
240  * Command data format matches the feature bit mask exactly.
241  *
242  * See VIRTIO_NET_F_GUEST_* for the list of offloads
243  * that can be enabled/disabled.
244  */
245 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS   5
246 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET        0
247 
248 #endif /* _UAPI_LINUX_VIRTIO_NET_H */
249