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