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