vmm: Added more syscalls and helpers to linuxemu
[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 <stdint.h>
28 #include <vmm/virtio_ids.h>
29 #include <vmm/virtio_config.h>
30
31 /* The feature bitmap for virtio net */
32 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
33 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
34 #define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2 /* Dynamic offload configuration. */
35 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
36 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
37 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
38 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
39 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
40 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
41 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
42 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
43 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
44 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
45 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
46 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
47 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
48 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
49 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
50 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the
51                                          * network */
52 #define VIRTIO_NET_F_MQ 22      /* Device supports Receive Flow
53                                          * Steering */
54 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
55
56 #ifndef VIRTIO_NET_NO_LEGACY
57 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
58 #endif /* VIRTIO_NET_NO_LEGACY */
59
60 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
61 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
62
63 #ifndef ETH_ALEN
64 #define ETH_ALEN        6       /* Length of a MAC address (48 bits) */
65 #endif
66
67 struct virtio_net_config {
68         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
69         uint8_t mac[ETH_ALEN];
70         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
71         uint16_t status;
72         /* Maximum number of each of transmit and receive queues;
73          * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
74          * Legal values are between 1 and 0x8000
75          */
76         uint16_t max_virtqueue_pairs;
77 } __attribute__((packed));
78
79 /*
80  * This header comes first in the scatter-gather list.  If you don't
81  * specify GSO or CSUM features, you can simply ignore the header.
82  *
83  * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf,
84  * only flattened.
85  */
86 struct virtio_net_hdr_v1 {
87 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       /* Use csum_start, csum_offset */
88 #define VIRTIO_NET_HDR_F_DATA_VALID     2       /* Csum is valid */
89         uint8_t flags;
90 #define VIRTIO_NET_HDR_GSO_NONE         0       /* Not a GSO frame */
91 #define VIRTIO_NET_HDR_GSO_TCPV4        1       /* GSO frame, IPv4 TCP (TSO) */
92 #define VIRTIO_NET_HDR_GSO_UDP          3       /* GSO frame, IPv4 UDP (UFO) */
93 #define VIRTIO_NET_HDR_GSO_TCPV6        4       /* GSO frame, IPv6 TCP */
94 #define VIRTIO_NET_HDR_GSO_ECN          0x80    /* TCP has ECN set */
95         uint8_t gso_type;
96         uint16_t hdr_len;       /* Ethernet + IP + tcp/udp hdrs */
97         uint16_t gso_size;      /* Bytes to append to hdr_len per frame */
98         uint16_t csum_start;    /* Position to start checksumming from */
99         uint16_t csum_offset;   /* Offset after that to place checksum */
100         uint16_t num_buffers;   /* Number of merged rx buffers */
101 };
102
103 #ifndef VIRTIO_NET_NO_LEGACY
104 /* This header comes first in the scatter-gather list.
105  * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must
106  * be the first element of the scatter-gather list.  If you don't
107  * specify GSO or CSUM features, you can simply ignore the header. */
108 struct virtio_net_hdr {
109         /* See VIRTIO_NET_HDR_F_* */
110         uint8_t flags;
111         /* See VIRTIO_NET_HDR_GSO_* */
112         uint8_t gso_type;
113         uint16_t hdr_len;               /* Ethernet + IP + tcp/udp hdrs */
114         uint16_t gso_size;              /* Bytes to append to hdr_len per frame */
115         uint16_t csum_start;    /* Position to start checksumming from */
116         uint16_t csum_offset;   /* Offset after that to place checksum */
117 };
118
119 /* This is the version of the header to use when the MRG_RXBUF
120  * feature has been negotiated. */
121 struct virtio_net_hdr_mrg_rxbuf {
122         struct virtio_net_hdr hdr;
123         uint16_t num_buffers;   /* Number of merged rx buffers */
124 };
125 #endif /* ...VIRTIO_NET_NO_LEGACY */
126
127 /*
128  * Control virtqueue data structures
129  *
130  * The control virtqueue expects a header in the first sg entry
131  * and an ack/status response in the last entry.  Data for the
132  * command goes in between.
133  */
134 struct virtio_net_ctrl_hdr {
135         uint8_t class;
136         uint8_t cmd;
137 } __attribute__((packed));
138
139 typedef uint8_t virtio_net_ctrl_ack;
140
141 #define VIRTIO_NET_OK     0
142 #define VIRTIO_NET_ERR    1
143
144 /*
145  * Control the RX mode, ie. promisucous, allmulti, etc...
146  * All commands require an "out" sg entry containing a 1 byte
147  * state value, zero = disable, non-zero = enable.  Commands
148  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
149  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
150  */
151 #define VIRTIO_NET_CTRL_RX    0
152  #define VIRTIO_NET_CTRL_RX_PROMISC      0
153  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
154  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
155  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
156  #define VIRTIO_NET_CTRL_RX_NOUNI        4
157  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
158
159 /*
160  * Control the MAC
161  *
162  * The MAC filter table is managed by the hypervisor, the guest should
163  * assume the size is infinite.  Filtering should be considered
164  * non-perfect, ie. based on hypervisor resources, the guest may
165  * received packets from sources not specified in the filter list.
166  *
167  * In addition to the class/cmd header, the TABLE_SET command requires
168  * two out scatterlists.  Each contains a 4 byte count of entries followed
169  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
170  * first sg list contains unicast addresses, the second is for multicast.
171  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
172  * is available.
173  *
174  * The ADDR_SET command requests one out scatterlist, it contains a
175  * 6 bytes MAC address. This functionality is present if the
176  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
177  */
178 struct virtio_net_ctrl_mac {
179         uint32_t entries;
180         uint8_t macs[][ETH_ALEN];
181 } __attribute__((packed));
182
183 #define VIRTIO_NET_CTRL_MAC    1
184  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
185  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
186
187 /*
188  * Control VLAN filtering
189  *
190  * The VLAN filter table is controlled via a simple ADD/DEL interface.
191  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
192  * opposite of add.  Both commands expect an out entry containing a 2
193  * byte VLAN ID.  VLAN filterting is available with the
194  * VIRTIO_NET_F_CTRL_VLAN feature bit.
195  */
196 #define VIRTIO_NET_CTRL_VLAN       2
197  #define VIRTIO_NET_CTRL_VLAN_ADD             0
198  #define VIRTIO_NET_CTRL_VLAN_DEL             1
199
200 /*
201  * Control link announce acknowledgement
202  *
203  * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
204  * driver has recevied the notification; device would clear the
205  * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
206  * this command.
207  */
208 #define VIRTIO_NET_CTRL_ANNOUNCE       3
209  #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0
210
211 /*
212  * Control Receive Flow Steering
213  *
214  * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
215  * enables Receive Flow Steering, specifying the number of the transmit and
216  * receive queues that will be used. After the command is consumed and acked by
217  * the device, the device will not steer new packets on receive virtqueues
218  * other than specified nor read from transmit virtqueues other than specified.
219  * Accordingly, driver should not transmit new packets  on virtqueues other than
220  * specified.
221  */
222 struct virtio_net_ctrl_mq {
223         uint16_t virtqueue_pairs;
224 };
225
226 #define VIRTIO_NET_CTRL_MQ   4
227  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
228  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
229  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
230
231 /*
232  * Control network offloads
233  *
234  * Reconfigures the network offloads that Guest can handle.
235  *
236  * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
237  *
238  * Command data format matches the feature bit mask exactly.
239  *
240  * See VIRTIO_NET_F_GUEST_* for the list of offloads
241  * that can be enabled/disabled.
242  */
243 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS   5
244 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET        0
245
246 void virtio_net_set_mac(struct virtio_vq_dev *vqdev, uint8_t *guest_mac);
247 void *net_receiveq_fn(void *_vq);
248 void *net_transmitq_fn(void *_vq);