Check that bus freq is not zero
[akaros.git] / user / vmm / include / vmm / virtio_net.h
1 #pragma once
2 /* This header is BSD licensed so anyone can use the definitions to implement
3  * compatible drivers/servers.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of IBM nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE. */
27 #include <linux/types.h>
28 #include <linux/virtio_ids.h>
29 #include <linux/virtio_config.h>
30 #include <linux/virtio_types.h>
31 #include <linux/if_ether.h>
32
33 /* The feature bitmap for virtio net */
34 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
35 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
36 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
37 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
38 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
39 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
40 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
41 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
42 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
43 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
44 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
45 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
46 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
47 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
48 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
49 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
50 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
51 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the
52                                          * network */
53 #define VIRTIO_NET_F_MQ 22      /* Device supports Receive Flow
54                                          * Steering */
55 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
56
57 #ifndef VIRTIO_NET_NO_LEGACY
58 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
59 #endif /* VIRTIO_NET_NO_LEGACY */
60
61 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
62 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
63
64 struct virtio_net_config {
65         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
66         __u8 mac[ETH_ALEN];
67         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
68         __u16 status;
69         /* Maximum number of each of transmit and receive queues;
70          * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
71          * Legal values are between 1 and 0x8000
72          */
73         __u16 max_virtqueue_pairs;
74 } __attribute__((packed));
75
76 /*
77  * This header comes first in the scatter-gather list.  If you don't
78  * specify GSO or CSUM features, you can simply ignore the header.
79  *
80  * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf,
81  * only flattened.
82  */
83 struct virtio_net_hdr_v1 {
84 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       /* Use csum_start, csum_offset */
85 #define VIRTIO_NET_HDR_F_DATA_VALID     2       /* Csum is valid */
86         __u8 flags;
87 #define VIRTIO_NET_HDR_GSO_NONE         0       /* Not a GSO frame */
88 #define VIRTIO_NET_HDR_GSO_TCPV4        1       /* GSO frame, IPv4 TCP (TSO) */
89 #define VIRTIO_NET_HDR_GSO_UDP          3       /* GSO frame, IPv4 UDP (UFO) */
90 #define VIRTIO_NET_HDR_GSO_TCPV6        4       /* GSO frame, IPv6 TCP */
91 #define VIRTIO_NET_HDR_GSO_ECN          0x80    /* TCP has ECN set */
92         __u8 gso_type;
93         __virtio16 hdr_len;     /* Ethernet + IP + tcp/udp hdrs */
94         __virtio16 gso_size;    /* Bytes to append to hdr_len per frame */
95         __virtio16 csum_start;  /* Position to start checksumming from */
96         __virtio16 csum_offset; /* Offset after that to place checksum */
97         __virtio16 num_buffers; /* Number of merged rx buffers */
98 };
99
100 #ifndef VIRTIO_NET_NO_LEGACY
101 /* This header comes first in the scatter-gather list.
102  * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must
103  * be the first element of the scatter-gather list.  If you don't
104  * specify GSO or CSUM features, you can simply ignore the header. */
105 struct virtio_net_hdr {
106         /* See VIRTIO_NET_HDR_F_* */
107         __u8 flags;
108         /* See VIRTIO_NET_HDR_GSO_* */
109         __u8 gso_type;
110         __virtio16 hdr_len;             /* Ethernet + IP + tcp/udp hdrs */
111         __virtio16 gso_size;            /* Bytes to append to hdr_len per frame */
112         __virtio16 csum_start;  /* Position to start checksumming from */
113         __virtio16 csum_offset; /* Offset after that to place checksum */
114 };
115
116 /* This is the version of the header to use when the MRG_RXBUF
117  * feature has been negotiated. */
118 struct virtio_net_hdr_mrg_rxbuf {
119         struct virtio_net_hdr hdr;
120         __virtio16 num_buffers; /* Number of merged rx buffers */
121 };
122 #endif /* ...VIRTIO_NET_NO_LEGACY */
123
124 /*
125  * Control virtqueue data structures
126  *
127  * The control virtqueue expects a header in the first sg entry
128  * and an ack/status response in the last entry.  Data for the
129  * command goes in between.
130  */
131 struct virtio_net_ctrl_hdr {
132         __u8 class;
133         __u8 cmd;
134 } __attribute__((packed));
135
136 typedef __u8 virtio_net_ctrl_ack;
137
138 #define VIRTIO_NET_OK     0
139 #define VIRTIO_NET_ERR    1
140
141 /*
142  * Control the RX mode, ie. promisucous, allmulti, etc...
143  * All commands require an "out" sg entry containing a 1 byte
144  * state value, zero = disable, non-zero = enable.  Commands
145  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
146  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
147  */
148 #define VIRTIO_NET_CTRL_RX    0
149  #define VIRTIO_NET_CTRL_RX_PROMISC      0
150  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
151  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
152  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
153  #define VIRTIO_NET_CTRL_RX_NOUNI        4
154  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
155
156 /*
157  * Control the MAC
158  *
159  * The MAC filter table is managed by the hypervisor, the guest should
160  * assume the size is infinite.  Filtering should be considered
161  * non-perfect, ie. based on hypervisor resources, the guest may
162  * received packets from sources not specified in the filter list.
163  *
164  * In addition to the class/cmd header, the TABLE_SET command requires
165  * two out scatterlists.  Each contains a 4 byte count of entries followed
166  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
167  * first sg list contains unicast addresses, the second is for multicast.
168  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
169  * is available.
170  *
171  * The ADDR_SET command requests one out scatterlist, it contains a
172  * 6 bytes MAC address. This functionality is present if the
173  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
174  */
175 struct virtio_net_ctrl_mac {
176         __virtio32 entries;
177         __u8 macs[][ETH_ALEN];
178 } __attribute__((packed));
179
180 #define VIRTIO_NET_CTRL_MAC    1
181  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
182  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
183
184 /*
185  * Control VLAN filtering
186  *
187  * The VLAN filter table is controlled via a simple ADD/DEL interface.
188  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
189  * opposite of add.  Both commands expect an out entry containing a 2
190  * byte VLAN ID.  VLAN filterting is available with the
191  * VIRTIO_NET_F_CTRL_VLAN feature bit.
192  */
193 #define VIRTIO_NET_CTRL_VLAN       2
194  #define VIRTIO_NET_CTRL_VLAN_ADD             0
195  #define VIRTIO_NET_CTRL_VLAN_DEL             1
196
197 /*
198  * Control link announce acknowledgement
199  *
200  * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
201  * driver has recevied the notification; device would clear the
202  * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
203  * this command.
204  */
205 #define VIRTIO_NET_CTRL_ANNOUNCE       3
206  #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0
207
208 /*
209  * Control Receive Flow Steering
210  *
211  * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
212  * enables Receive Flow Steering, specifying the number of the transmit and
213  * receive queues that will be used. After the command is consumed and acked by
214  * the device, the device will not steer new packets on receive virtqueues
215  * other than specified nor read from transmit virtqueues other than specified.
216  * Accordingly, driver should not transmit new packets  on virtqueues other than
217  * specified.
218  */
219 struct virtio_net_ctrl_mq {
220         __virtio16 virtqueue_pairs;
221 };
222
223 #define VIRTIO_NET_CTRL_MQ   4
224  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
225  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
226  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000