[qemu.git] / hw / virtio-net.h

/*
 * Virtio Network Device
 *
 * Copyright IBM, Corp. 2007
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2.  See
 * the COPYING file in the top-level directory.
 *
 */

#ifndef _QEMU_VIRTIO_NET_H
#define _QEMU_VIRTIO_NET_H

#include "virtio.h"
#include "pci/pci.h"

#define ETH_ALEN    6

/* from Linux's virtio_net.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_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 */

#define TX_TIMER_INTERVAL 150000 /* 150 us */

/* Limit the number of packets that can be sent via a single flush
 * of the TX queue.  This gives us a guaranteed exit condition and
 * ensures fairness in the io path.  256 conveniently matches the
 * length of the TX queue and shows a good balance of performance
 * and latency. */
#define TX_BURST 256

typedef struct virtio_net_conf
{
    uint32_t txtimer;
    int32_t txburst;
    char *tx;
} virtio_net_conf;

/* Maximum packet size we can receive from tap device: header + 64k */
#define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10))

struct virtio_net_config
{
    /* The config defining mac address ($ETH_ALEN bytes) */
    uint8_t mac[ETH_ALEN];
    /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
    uint16_t status;
} QEMU_PACKED;

/*
 * 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 {
    uint8_t class;
    uint8_t cmd;
};

typedef uint8_t 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_MODE    0
 #define VIRTIO_NET_CTRL_RX_MODE_PROMISC      0
 #define VIRTIO_NET_CTRL_RX_MODE_ALLMULTI     1
 #define VIRTIO_NET_CTRL_RX_MODE_ALLUNI       2
 #define VIRTIO_NET_CTRL_RX_MODE_NOMULTI      3
 #define VIRTIO_NET_CTRL_RX_MODE_NOUNI        4
 #define VIRTIO_NET_CTRL_RX_MODE_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 {
    uint32_t entries;
    uint8_t macs[][ETH_ALEN];
};
#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

#define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \
        DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \
        DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \
        DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \
        DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \
        DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \
        DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \
        DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \
        DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \
        DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \
        DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \
        DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \
        DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \
        DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \
        DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \
        DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \
        DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \
        DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \
        DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true)
#endif
Commit	Line	Data
fbe78f4f AL	1	/*
	2	* Virtio Network Device
	3	*
	4	* Copyright IBM, Corp. 2007
	5	*
	6	* Authors:
	7	* Anthony Liguori <aliguori@us.ibm.com>
	8	*
	9	* This work is licensed under the terms of the GNU GPL, version 2. See
	10	* the COPYING file in the top-level directory.
	11	*
	12	*/
	13
	14	#ifndef _QEMU_VIRTIO_NET_H
	15	#define _QEMU_VIRTIO_NET_H
	16
	17	#include "virtio.h"
a2cb15b0	18	#include "pci/pci.h"
fbe78f4f	19
79674068 AL	20	#define ETH_ALEN 6
79674068 AL	21
fbe78f4f AL	22	/* from Linux's virtio_net.h */
	23
	24	/* The ID for virtio_net */
	25	#define VIRTIO_ID_NET 1
	26
	27	/* The feature bitmap for virtio net */
	28	#define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
	29	#define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
	30	#define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
	31	#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
	32	#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
	33	#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
	34	#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
	35	#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
	36	#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
	37	#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
	38	#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
	39	#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
	40	#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
554c97dd	41	#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
3d11d36c	42	#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
002437cd	43	#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
f21c0ed9	44	#define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */
015cb166	45	#define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */
554c97dd AL	46
554c97dd AL	47	#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
fbe78f4f AL	48
	49	#define TX_TIMER_INTERVAL 150000 /* 150 us */
	50
e3f30488 AW	51	/* Limit the number of packets that can be sent via a single flush
	52	* of the TX queue. This gives us a guaranteed exit condition and
	53	* ensures fairness in the io path. 256 conveniently matches the
	54	* length of the TX queue and shows a good balance of performance
	55	* and latency. */
	56	#define TX_BURST 256
	57
f0c07c7c AW	58	typedef struct virtio_net_conf
	59	{
	60	uint32_t txtimer;
e3f30488	61	int32_t txburst;
a697a334	62	char *tx;
f0c07c7c AW	63	} virtio_net_conf;
f0c07c7c AW	64
fbe78f4f AL	65	/* Maximum packet size we can receive from tap device: header + 64k */
	66	#define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10))
	67
fbe78f4f AL	68	struct virtio_net_config
fbe78f4f AL	69	{
ebbeb789 AK	70	/* The config defining mac address ($ETH_ALEN bytes) */
ebbeb789 AK	71	uint8_t mac[ETH_ALEN];
554c97dd AL	72	/* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
554c97dd AL	73	uint16_t status;
541dc0d4	74	} QEMU_PACKED;
fbe78f4f	75
3d11d36c AL	76	/*
	77	* Control virtqueue data structures
	78	*
	79	* The control virtqueue expects a header in the first sg entry
	80	* and an ack/status response in the last entry. Data for the
	81	* command goes in between.
	82	*/
	83	struct virtio_net_ctrl_hdr {
	84	uint8_t class;
	85	uint8_t cmd;
	86	};
	87
	88	typedef uint8_t virtio_net_ctrl_ack;
	89
	90	#define VIRTIO_NET_OK 0
	91	#define VIRTIO_NET_ERR 1
	92
002437cd	93	/*
015cb166 AW	94	* Control the RX mode, ie. promisucous, allmulti, etc...
	95	* All commands require an "out" sg entry containing a 1 byte
	96	* state value, zero = disable, non-zero = enable. Commands
	97	* 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
	98	* Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
002437cd AL	99	*/
	100	#define VIRTIO_NET_CTRL_RX_MODE 0
	101	#define VIRTIO_NET_CTRL_RX_MODE_PROMISC 0
	102	#define VIRTIO_NET_CTRL_RX_MODE_ALLMULTI 1
015cb166 AW	103	#define VIRTIO_NET_CTRL_RX_MODE_ALLUNI 2
	104	#define VIRTIO_NET_CTRL_RX_MODE_NOMULTI 3
	105	#define VIRTIO_NET_CTRL_RX_MODE_NOUNI 4
	106	#define VIRTIO_NET_CTRL_RX_MODE_NOBCAST 5
002437cd	107
b6503ed9 AL	108	/*
	109	* Control the MAC filter table.
	110	*
	111	* The MAC filter table is managed by the hypervisor, the guest should
	112	* assume the size is infinite. Filtering should be considered
	113	* non-perfect, ie. based on hypervisor resources, the guest may
	114	* received packets from sources not specified in the filter list.
	115	*
	116	* In addition to the class/cmd header, the TABLE_SET command requires
	117	* two out scatterlists. Each contains a 4 byte count of entries followed
	118	* by a concatenated byte stream of the ETH_ALEN MAC addresses. The
	119	* first sg list contains unicast addresses, the second is for multicast.
	120	* This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
	121	* is available.
	122	*/
	123	struct virtio_net_ctrl_mac {
	124	uint32_t entries;
	125	uint8_t macs[][ETH_ALEN];
	126	};
	127	#define VIRTIO_NET_CTRL_MAC 1
	128	#define VIRTIO_NET_CTRL_MAC_TABLE_SET 0
	129
f21c0ed9 AL	130	/*
	131	* Control VLAN filtering
	132	*
	133	* The VLAN filter table is controlled via a simple ADD/DEL interface.
	134	* VLAN IDs not added may be filterd by the hypervisor. Del is the
	135	* opposite of add. Both commands expect an out entry containing a 2
	136	* byte VLAN ID. VLAN filterting is available with the
	137	* VIRTIO_NET_F_CTRL_VLAN feature bit.
	138	*/
	139	#define VIRTIO_NET_CTRL_VLAN 2
	140	#define VIRTIO_NET_CTRL_VLAN_ADD 0
	141	#define VIRTIO_NET_CTRL_VLAN_DEL 1
	142
8172539d MT	143	#define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \
	144	DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \
	145	DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \
	146	DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \
8172539d MT	147	DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \
	148	DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \
	149	DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \
	150	DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \
	151	DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \
	152	DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \
	153	DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \
	154	DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \
	155	DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \
	156	DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \
	157	DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \
	158	DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \
	159	DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \
	160	DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \
	161	DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true)
fbe78f4f	162	#endif