[mirror_ubuntu-bionic-kernel.git] / include / uapi / linux / virtio_net.h

#ifndef _LINUX_VIRTIO_NET_H
#define _LINUX_VIRTIO_NET_H
/* This header is BSD licensed so anyone can use the definitions to implement
 * compatible drivers/servers.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of IBM nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE. */
#include <linux/types.h>
#include <linux/virtio_ids.h>
#include <linux/virtio_config.h>
#include <linux/if_ether.h>

/* The feature bitmap for virtio net */
#define VIRTIO_NET_F_CSUM	0	/* Host handles pkts w/ partial csum */
#define VIRTIO_NET_F_GUEST_CSUM	1	/* Guest handles pkts w/ partial csum */
#define VIRTIO_NET_F_MAC	5	/* Host has given MAC address. */
#define VIRTIO_NET_F_GSO	6	/* Host handles pkts w/ any GSO type */
#define VIRTIO_NET_F_GUEST_TSO4	7	/* Guest can handle TSOv4 in. */
#define VIRTIO_NET_F_GUEST_TSO6	8	/* Guest can handle TSOv6 in. */
#define VIRTIO_NET_F_GUEST_ECN	9	/* Guest can handle TSO[6] w/ ECN in. */
#define VIRTIO_NET_F_GUEST_UFO	10	/* Guest can handle UFO in. */
#define VIRTIO_NET_F_HOST_TSO4	11	/* Host can handle TSOv4 in. */
#define VIRTIO_NET_F_HOST_TSO6	12	/* Host can handle TSOv6 in. */
#define VIRTIO_NET_F_HOST_ECN	13	/* Host can handle TSO[6] w/ ECN in. */
#define VIRTIO_NET_F_HOST_UFO	14	/* Host can handle UFO in. */
#define VIRTIO_NET_F_MRG_RXBUF	15	/* Host can merge receive buffers. */
#define VIRTIO_NET_F_STATUS	16	/* virtio_net_config.status available */
#define VIRTIO_NET_F_CTRL_VQ	17	/* Control channel available */
#define VIRTIO_NET_F_CTRL_RX	18	/* Control channel RX mode support */
#define VIRTIO_NET_F_CTRL_VLAN	19	/* Control channel VLAN filtering */
#define VIRTIO_NET_F_CTRL_RX_EXTRA 20	/* Extra RX mode control support */
#define VIRTIO_NET_F_GUEST_ANNOUNCE 21	/* Guest can announce device on the
					 * network */
#define VIRTIO_NET_F_MQ	22	/* Device supports Receive Flow
					 * Steering */
#define VIRTIO_NET_F_CTRL_MAC_ADDR 23	/* Set MAC address */

#define VIRTIO_NET_S_LINK_UP	1	/* Link is up */
#define VIRTIO_NET_S_ANNOUNCE	2	/* Announcement is needed */

struct virtio_net_config {
	/* The config defining mac address (if VIRTIO_NET_F_MAC) */
	__u8 mac[ETH_ALEN];
	/* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
	__u16 status;
	/* Maximum number of each of transmit and receive queues;
	 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
	 * Legal values are between 1 and 0x8000
	 */
	__u16 max_virtqueue_pairs;
} __attribute__((packed));

/* This header comes first in the scatter-gather list.
 * If VIRTIO_F_ANY_LAYOUT is not negotiated, it must
 * be the first element of the scatter-gather list.  If you don't
 * specify GSO or CSUM features, you can simply ignore the header. */
struct virtio_net_hdr {
#define VIRTIO_NET_HDR_F_NEEDS_CSUM	1	// Use csum_start, csum_offset
#define VIRTIO_NET_HDR_F_DATA_VALID	2	// Csum is valid
	__u8 flags;
#define VIRTIO_NET_HDR_GSO_NONE		0	// Not a GSO frame
#define VIRTIO_NET_HDR_GSO_TCPV4	1	// GSO frame, IPv4 TCP (TSO)
#define VIRTIO_NET_HDR_GSO_UDP		3	// GSO frame, IPv4 UDP (UFO)
#define VIRTIO_NET_HDR_GSO_TCPV6	4	// GSO frame, IPv6 TCP
#define VIRTIO_NET_HDR_GSO_ECN		0x80	// TCP has ECN set
	__u8 gso_type;
	__u16 hdr_len;		/* Ethernet + IP + tcp/udp hdrs */
	__u16 gso_size;		/* Bytes to append to hdr_len per frame */
	__u16 csum_start;	/* Position to start checksumming from */
	__u16 csum_offset;	/* Offset after that to place checksum */
};

/* This is the version of the header to use when the MRG_RXBUF
 * feature has been negotiated. */
struct virtio_net_hdr_mrg_rxbuf {
	struct virtio_net_hdr hdr;
	__u16 num_buffers;	/* Number of merged rx buffers */
};

/*
 * Control virtqueue data structures
 *
 * The control virtqueue expects a header in the first sg entry
 * and an ack/status response in the last entry.  Data for the
 * command goes in between.
 */
struct virtio_net_ctrl_hdr {
	__u8 class;
	__u8 cmd;
} __attribute__((packed));

typedef __u8 virtio_net_ctrl_ack;

#define VIRTIO_NET_OK     0
#define VIRTIO_NET_ERR    1

/*
 * Control the RX mode, ie. promisucous, allmulti, etc...
 * All commands require an "out" sg entry containing a 1 byte
 * state value, zero = disable, non-zero = enable.  Commands
 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
 */
#define VIRTIO_NET_CTRL_RX    0
 #define VIRTIO_NET_CTRL_RX_PROMISC      0
 #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
 #define VIRTIO_NET_CTRL_RX_ALLUNI       2
 #define VIRTIO_NET_CTRL_RX_NOMULTI      3
 #define VIRTIO_NET_CTRL_RX_NOUNI        4
 #define VIRTIO_NET_CTRL_RX_NOBCAST      5

/*
 * Control the MAC
 *
 * The MAC filter table is managed by the hypervisor, the guest should
 * assume the size is infinite.  Filtering should be considered
 * non-perfect, ie. based on hypervisor resources, the guest may
 * received packets from sources not specified in the filter list.
 *
 * In addition to the class/cmd header, the TABLE_SET command requires
 * two out scatterlists.  Each contains a 4 byte count of entries followed
 * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
 * first sg list contains unicast addresses, the second is for multicast.
 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
 * is available.
 *
 * The ADDR_SET command requests one out scatterlist, it contains a
 * 6 bytes MAC address. This functionality is present if the
 * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
 */
struct virtio_net_ctrl_mac {
	__u32 entries;
	__u8 macs[][ETH_ALEN];
} __attribute__((packed));

#define VIRTIO_NET_CTRL_MAC    1
 #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
 #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1

/*
 * Control VLAN filtering
 *
 * The VLAN filter table is controlled via a simple ADD/DEL interface.
 * VLAN IDs not added may be filterd by the hypervisor.  Del is the
 * opposite of add.  Both commands expect an out entry containing a 2
 * byte VLAN ID.  VLAN filterting is available with the
 * VIRTIO_NET_F_CTRL_VLAN feature bit.
 */
#define VIRTIO_NET_CTRL_VLAN       2
 #define VIRTIO_NET_CTRL_VLAN_ADD             0
 #define VIRTIO_NET_CTRL_VLAN_DEL             1

/*
 * Control link announce acknowledgement
 *
 * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
 * driver has recevied the notification; device would clear the
 * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
 * this command.
 */
#define VIRTIO_NET_CTRL_ANNOUNCE       3
 #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0

/*
 * Control Receive Flow Steering
 *
 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
 * enables Receive Flow Steering, specifying the number of the transmit and
 * receive queues that will be used. After the command is consumed and acked by
 * the device, the device will not steer new packets on receive virtqueues
 * other than specified nor read from transmit virtqueues other than specified.
 * Accordingly, driver should not transmit new packets  on virtqueues other than
 * specified.
 */
struct virtio_net_ctrl_mq {
	__u16 virtqueue_pairs;
};

#define VIRTIO_NET_CTRL_MQ   4
 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000

#endif /* _LINUX_VIRTIO_NET_H */
Commit	Line	Data
296f96fc RR	1	#ifndef _LINUX_VIRTIO_NET_H
296f96fc RR	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>
c047fcd2	31	#include <linux/if_ether.h>
296f96fc	32
a586d4f6	33	/* The feature bitmap for virtio net */
5539ae96 RR	34	#define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
5539ae96 RR	35	#define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
34a48579	36	#define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
5539ae96 RR	37	#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
	38	#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
	39	#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
	40	#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
	41	#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
	42	#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
	43	#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
	44	#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
	45	#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
3f2c31d9	46	#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
9f4d26d0	47	#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
2a41f71d	48	#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
2af7698e	49	#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
0bde9569	50	#define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */
e79f07e2	51	#define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */
586d17c5 JW	52	#define VIRTIO_NET_F_GUEST_ANNOUNCE 21 /* Guest can announce device on the
586d17c5 JW	53	* network */
986a4f4d JW	54	#define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow
986a4f4d JW	55	* Steering */
7e58d5ae	56	#define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */
9f4d26d0 MM	57
9f4d26d0 MM	58	#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
586d17c5	59	#define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */
296f96fc	60
1842f23c	61	struct virtio_net_config {
a586d4f6	62	/* The config defining mac address (if VIRTIO_NET_F_MAC) */
e216975a	63	__u8 mac[ETH_ALEN];
9f4d26d0 MM	64	/* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
9f4d26d0 MM	65	__u16 status;
986a4f4d JW	66	/* Maximum number of each of transmit and receive queues;
	67	* see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
	68	* Legal values are between 1 and 0x8000
	69	*/
	70	__u16 max_virtqueue_pairs;
a586d4f6	71	} __attribute__((packed));
296f96fc	72
e7428e95 MT	73	/* This header comes first in the scatter-gather list.
	74	* If VIRTIO_F_ANY_LAYOUT is not negotiated, it must
	75	* be the first element of the scatter-gather list. If you don't
296f96fc	76	* specify GSO or CSUM features, you can simply ignore the header. */
1842f23c	77	struct virtio_net_hdr {
296f96fc	78	#define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset
10a8d94a	79	#define VIRTIO_NET_HDR_F_DATA_VALID 2 // Csum is valid
50c8ea80	80	__u8 flags;
296f96fc RR	81	#define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame
296f96fc RR	82	#define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO)
296f96fc RR	83	#define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO)
296f96fc RR	84	#define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP
34a48579	85	#define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set
50c8ea80 RR	86	__u8 gso_type;
50c8ea80 RR	87	__u16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */
2506ece0	88	__u16 gso_size; /* Bytes to append to hdr_len per frame */
50c8ea80 RR	89	__u16 csum_start; /* Position to start checksumming from */
50c8ea80 RR	90	__u16 csum_offset; /* Offset after that to place checksum */
296f96fc	91	};
3f2c31d9 MM	92
	93	/* This is the version of the header to use when the MRG_RXBUF
	94	* feature has been negotiated. */
	95	struct virtio_net_hdr_mrg_rxbuf {
	96	struct virtio_net_hdr hdr;
	97	__u16 num_buffers; /* Number of merged rx buffers */
	98	};
	99
2a41f71d AW	100	/*
	101	* Control virtqueue data structures
	102	*
	103	* The control virtqueue expects a header in the first sg entry
	104	* and an ack/status response in the last entry. Data for the
	105	* command goes in between.
	106	*/
	107	struct virtio_net_ctrl_hdr {
	108	__u8 class;
	109	__u8 cmd;
	110	} __attribute__((packed));
	111
	112	typedef __u8 virtio_net_ctrl_ack;
	113
	114	#define VIRTIO_NET_OK 0
	115	#define VIRTIO_NET_ERR 1
	116
2af7698e	117	/*
e79f07e2 AW	118	* Control the RX mode, ie. promisucous, allmulti, etc...
	119	* All commands require an "out" sg entry containing a 1 byte
	120	* state value, zero = disable, non-zero = enable. Commands
	121	* 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
	122	* Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
2af7698e AW	123	*/
	124	#define VIRTIO_NET_CTRL_RX 0
	125	#define VIRTIO_NET_CTRL_RX_PROMISC 0
	126	#define VIRTIO_NET_CTRL_RX_ALLMULTI 1
e79f07e2 AW	127	#define VIRTIO_NET_CTRL_RX_ALLUNI 2
	128	#define VIRTIO_NET_CTRL_RX_NOMULTI 3
	129	#define VIRTIO_NET_CTRL_RX_NOUNI 4
	130	#define VIRTIO_NET_CTRL_RX_NOBCAST 5
2af7698e	131
f565a7c2	132	/*
7e58d5ae	133	* Control the MAC
f565a7c2 AW	134	*
	135	* The MAC filter table is managed by the hypervisor, the guest should
	136	* assume the size is infinite. Filtering should be considered
	137	* non-perfect, ie. based on hypervisor resources, the guest may
	138	* received packets from sources not specified in the filter list.
	139	*
	140	* In addition to the class/cmd header, the TABLE_SET command requires
	141	* two out scatterlists. Each contains a 4 byte count of entries followed
	142	* by a concatenated byte stream of the ETH_ALEN MAC addresses. The
	143	* first sg list contains unicast addresses, the second is for multicast.
	144	* This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
	145	* is available.
7e58d5ae AK	146	*
	147	* The ADDR_SET command requests one out scatterlist, it contains a
	148	* 6 bytes MAC address. This functionality is present if the
	149	* VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
f565a7c2 AW	150	*/
	151	struct virtio_net_ctrl_mac {
	152	__u32 entries;
	153	__u8 macs[][ETH_ALEN];
	154	} __attribute__((packed));
	155
	156	#define VIRTIO_NET_CTRL_MAC 1
	157	#define VIRTIO_NET_CTRL_MAC_TABLE_SET 0
7e58d5ae	158	#define VIRTIO_NET_CTRL_MAC_ADDR_SET 1
f565a7c2	159
0bde9569 AW	160	/*
	161	* Control VLAN filtering
	162	*
	163	* The VLAN filter table is controlled via a simple ADD/DEL interface.
	164	* VLAN IDs not added may be filterd by the hypervisor. Del is the
	165	* opposite of add. Both commands expect an out entry containing a 2
	166	* byte VLAN ID. VLAN filterting is available with the
	167	* VIRTIO_NET_F_CTRL_VLAN feature bit.
	168	*/
	169	#define VIRTIO_NET_CTRL_VLAN 2
	170	#define VIRTIO_NET_CTRL_VLAN_ADD 0
	171	#define VIRTIO_NET_CTRL_VLAN_DEL 1
	172
586d17c5 JW	173	/*
	174	* Control link announce acknowledgement
	175	*
	176	* The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
	177	* driver has recevied the notification; device would clear the
	178	* VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
	179	* this command.
	180	*/
	181	#define VIRTIO_NET_CTRL_ANNOUNCE 3
	182	#define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0
	183
986a4f4d JW	184	/*
	185	* Control Receive Flow Steering
	186	*
	187	* The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
	188	* enables Receive Flow Steering, specifying the number of the transmit and
	189	* receive queues that will be used. After the command is consumed and acked by
	190	* the device, the device will not steer new packets on receive virtqueues
	191	* other than specified nor read from transmit virtqueues other than specified.
	192	* Accordingly, driver should not transmit new packets on virtqueues other than
	193	* specified.
	194	*/
	195	struct virtio_net_ctrl_mq {
77d21f23	196	__u16 virtqueue_pairs;
986a4f4d JW	197	};
	198
	199	#define VIRTIO_NET_CTRL_MQ 4
	200	#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
	201	#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
	202	#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
	203
296f96fc	204	#endif /* _LINUX_VIRTIO_NET_H */