[linux-2.6-block.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_config.h>

/* The ID for virtio_net */
#define VIRTIO_ID_NET	1

/* 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_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 and allmulti.  PROMISC and
 * ALLMULTI commands require an "out" sg entry containing a 1 byte
 * state value, zero = disable, non-zero = enable.  These commands
 * are supported with the VIRTIO_NET_F_CTRL_RX feature.
 */
#define VIRTIO_NET_CTRL_RX    0
 #define VIRTIO_NET_CTRL_RX_PROMISC      0
 #define VIRTIO_NET_CTRL_RX_ALLMULTI     1

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

#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>
296f96fc RR	6	#include <linux/virtio_config.h>
	7
	8	/* The ID for virtio_net */
	9	#define VIRTIO_ID_NET 1
	10
a586d4f6	11	/* The feature bitmap for virtio net */
5539ae96 RR	12	#define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
5539ae96 RR	13	#define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
34a48579	14	#define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
5539ae96 RR	15	#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
	16	#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
	17	#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
	18	#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
	19	#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
	20	#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
	21	#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
	22	#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
	23	#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
3f2c31d9	24	#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
9f4d26d0	25	#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
2a41f71d	26	#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
2af7698e	27	#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
9f4d26d0 MM	28
9f4d26d0 MM	29	#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
296f96fc	30
a586d4f6 RR	31	struct virtio_net_config
	32	{
	33	/* The config defining mac address (if VIRTIO_NET_F_MAC) */
	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. */
	41	struct virtio_net_hdr
	42	{
	43	#define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset
50c8ea80	44	__u8 flags;
296f96fc RR	45	#define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame
296f96fc RR	46	#define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO)
296f96fc RR	47	#define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO)
296f96fc RR	48	#define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP
34a48579	49	#define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set
50c8ea80 RR	50	__u8 gso_type;
50c8ea80 RR	51	__u16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */
2506ece0	52	__u16 gso_size; /* Bytes to append to hdr_len per frame */
50c8ea80 RR	53	__u16 csum_start; /* Position to start checksumming from */
50c8ea80 RR	54	__u16 csum_offset; /* Offset after that to place checksum */
296f96fc	55	};
3f2c31d9 MM	56
	57	/* This is the version of the header to use when the MRG_RXBUF
	58	* feature has been negotiated. */
	59	struct virtio_net_hdr_mrg_rxbuf {
	60	struct virtio_net_hdr hdr;
	61	__u16 num_buffers; /* Number of merged rx buffers */
	62	};
	63
2a41f71d AW	64	/*
	65	* Control virtqueue data structures
	66	*
	67	* The control virtqueue expects a header in the first sg entry
	68	* and an ack/status response in the last entry. Data for the
	69	* command goes in between.
	70	*/
	71	struct virtio_net_ctrl_hdr {
	72	__u8 class;
	73	__u8 cmd;
	74	} __attribute__((packed));
	75
	76	typedef __u8 virtio_net_ctrl_ack;
	77
	78	#define VIRTIO_NET_OK 0
	79	#define VIRTIO_NET_ERR 1
	80
2af7698e AW	81	/*
	82	* Control the RX mode, ie. promisucous and allmulti. PROMISC and
	83	* ALLMULTI commands require an "out" sg entry containing a 1 byte
	84	* state value, zero = disable, non-zero = enable. These commands
	85	* are supported with the VIRTIO_NET_F_CTRL_RX feature.
	86	*/
	87	#define VIRTIO_NET_CTRL_RX 0
	88	#define VIRTIO_NET_CTRL_RX_PROMISC 0
	89	#define VIRTIO_NET_CTRL_RX_ALLMULTI 1
	90
f565a7c2 AW	91	/*
	92	* Control the MAC filter table.
	93	*
	94	* The MAC filter table is managed by the hypervisor, the guest should
	95	* assume the size is infinite. Filtering should be considered
	96	* non-perfect, ie. based on hypervisor resources, the guest may
	97	* received packets from sources not specified in the filter list.
	98	*
	99	* In addition to the class/cmd header, the TABLE_SET command requires
	100	* two out scatterlists. Each contains a 4 byte count of entries followed
	101	* by a concatenated byte stream of the ETH_ALEN MAC addresses. The
	102	* first sg list contains unicast addresses, the second is for multicast.
	103	* This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
	104	* is available.
	105	*/
	106	struct virtio_net_ctrl_mac {
	107	__u32 entries;
	108	__u8 macs[][ETH_ALEN];
	109	} __attribute__((packed));
	110
	111	#define VIRTIO_NET_CTRL_MAC 1
	112	#define VIRTIO_NET_CTRL_MAC_TABLE_SET 0
	113
296f96fc	114	#endif /* _LINUX_VIRTIO_NET_H */