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