[net-next-2.6.git] / include / 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. */
#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_S_LINK_UP	1	/* Link is up */

struct virtio_net_config {
	/* The config defining mac address (if VIRTIO_NET_F_MAC) */
	__u8 mac[6];
	/* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
	__u16 status;
} __attribute__((packed));

/* This is 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
	__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 filter table.
 *
 * 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.
 */
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

/*
 * 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

#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 RR	3	/* This header is BSD licensed so anyone can use the definitions to implement
674bfc23 RR	4	* compatible drivers/servers. */
9a0e0ac2	5	#include <linux/types.h>
e95646c3	6	#include <linux/virtio_ids.h>
296f96fc	7	#include <linux/virtio_config.h>
c047fcd2	8	#include <linux/if_ether.h>
296f96fc	9
a586d4f6	10	/* The feature bitmap for virtio net */
5539ae96 RR	11	#define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
5539ae96 RR	12	#define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
34a48579	13	#define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
5539ae96 RR	14	#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
	15	#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
	16	#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
	17	#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
	18	#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
	19	#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
	20	#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
	21	#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
	22	#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
3f2c31d9	23	#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
9f4d26d0	24	#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
2a41f71d	25	#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
2af7698e	26	#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
0bde9569	27	#define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */
e79f07e2	28	#define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */
9f4d26d0 MM	29
9f4d26d0 MM	30	#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
296f96fc	31
1842f23c	32	struct virtio_net_config {
a586d4f6 RR	33	/* The config defining mac address (if VIRTIO_NET_F_MAC) */
a586d4f6 RR	34	__u8 mac[6];
9f4d26d0 MM	35	/* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
9f4d26d0 MM	36	__u16 status;
a586d4f6	37	} __attribute__((packed));
296f96fc RR	38
	39	/* This is the first element of the scatter-gather list. If you don't
	40	* specify GSO or CSUM features, you can simply ignore the header. */
1842f23c	41	struct virtio_net_hdr {
296f96fc	42	#define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset
50c8ea80	43	__u8 flags;
296f96fc RR	44	#define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame
296f96fc RR	45	#define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO)
296f96fc RR	46	#define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO)
296f96fc RR	47	#define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP
34a48579	48	#define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set
50c8ea80 RR	49	__u8 gso_type;
50c8ea80 RR	50	__u16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */
2506ece0	51	__u16 gso_size; /* Bytes to append to hdr_len per frame */
50c8ea80 RR	52	__u16 csum_start; /* Position to start checksumming from */
50c8ea80 RR	53	__u16 csum_offset; /* Offset after that to place checksum */
296f96fc	54	};
3f2c31d9 MM	55
	56	/* This is the version of the header to use when the MRG_RXBUF
	57	* feature has been negotiated. */
	58	struct virtio_net_hdr_mrg_rxbuf {
	59	struct virtio_net_hdr hdr;
	60	__u16 num_buffers; /* Number of merged rx buffers */
	61	};
	62
2a41f71d AW	63	/*
	64	* Control virtqueue data structures
	65	*
	66	* The control virtqueue expects a header in the first sg entry
	67	* and an ack/status response in the last entry. Data for the
	68	* command goes in between.
	69	*/
	70	struct virtio_net_ctrl_hdr {
	71	__u8 class;
	72	__u8 cmd;
	73	} __attribute__((packed));
	74
	75	typedef __u8 virtio_net_ctrl_ack;
	76
	77	#define VIRTIO_NET_OK 0
	78	#define VIRTIO_NET_ERR 1
	79
2af7698e	80	/*
e79f07e2 AW	81	* Control the RX mode, ie. promisucous, allmulti, etc...
	82	* All commands require an "out" sg entry containing a 1 byte
	83	* state value, zero = disable, non-zero = enable. Commands
	84	* 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
	85	* Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
2af7698e AW	86	*/
	87	#define VIRTIO_NET_CTRL_RX 0
	88	#define VIRTIO_NET_CTRL_RX_PROMISC 0
	89	#define VIRTIO_NET_CTRL_RX_ALLMULTI 1
e79f07e2 AW	90	#define VIRTIO_NET_CTRL_RX_ALLUNI 2
	91	#define VIRTIO_NET_CTRL_RX_NOMULTI 3
	92	#define VIRTIO_NET_CTRL_RX_NOUNI 4
	93	#define VIRTIO_NET_CTRL_RX_NOBCAST 5
2af7698e	94
f565a7c2 AW	95	/*
	96	* Control the MAC filter table.
	97	*
	98	* The MAC filter table is managed by the hypervisor, the guest should
	99	* assume the size is infinite. Filtering should be considered
	100	* non-perfect, ie. based on hypervisor resources, the guest may
	101	* received packets from sources not specified in the filter list.
	102	*
	103	* In addition to the class/cmd header, the TABLE_SET command requires
	104	* two out scatterlists. Each contains a 4 byte count of entries followed
	105	* by a concatenated byte stream of the ETH_ALEN MAC addresses. The
	106	* first sg list contains unicast addresses, the second is for multicast.
	107	* This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
	108	* is available.
	109	*/
	110	struct virtio_net_ctrl_mac {
	111	__u32 entries;
	112	__u8 macs[][ETH_ALEN];
	113	} __attribute__((packed));
	114
	115	#define VIRTIO_NET_CTRL_MAC 1
	116	#define VIRTIO_NET_CTRL_MAC_TABLE_SET 0
	117
0bde9569 AW	118	/*
	119	* Control VLAN filtering
	120	*
	121	* The VLAN filter table is controlled via a simple ADD/DEL interface.
	122	* VLAN IDs not added may be filterd by the hypervisor. Del is the
	123	* opposite of add. Both commands expect an out entry containing a 2
	124	* byte VLAN ID. VLAN filterting is available with the
	125	* VIRTIO_NET_F_CTRL_VLAN feature bit.
	126	*/
	127	#define VIRTIO_NET_CTRL_VLAN 2
	128	#define VIRTIO_NET_CTRL_VLAN_ADD 0
	129	#define VIRTIO_NET_CTRL_VLAN_DEL 1
	130
296f96fc	131	#endif /* _LINUX_VIRTIO_NET_H */