1 #ifndef _UAPI_LINUX_VIRTIO_NET_H 2 #define _UAPI_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 <linux/types.h> 29 #include <linux/virtio_ids.h> 30 #include <linux/virtio_config.h> 31 #include <linux/virtio_types.h> 32 #include <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 VIRTIO_NET_F_CTRL_RX_EXTRA 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 #define VIRTIO_NET_F_VQ_NOTF_COAL 52 /* Device supports virtqueue notification coalescing */ 60 #define VIRTIO_NET_F_NOTF_COAL 53 /* Device supports notifications coalescing */ 61 #define VIRTIO_NET_F_GUEST_USO4 54 /* Guest can handle USOv4 in. */ 62 #define VIRTIO_NET_F_GUEST_USO6 55 /* Guest can handle USOv6 in. */ 63 #define VIRTIO_NET_F_HOST_USO 56 /* Host can handle USO in. */ 64 #define VIRTIO_NET_F_HASH_REPORT 57 /* Supports hash report */ 65 #define VIRTIO_NET_F_GUEST_HDRLEN 59 /* Guest provides the exact hdr_len value. */ 66 #define VIRTIO_NET_F_RSS 60 /* Supports RSS RX steering */ 67 #define VIRTIO_NET_F_RSC_EXT 61 /* extended coalescing info */ 68 #define VIRTIO_NET_F_STANDBY 62 /* Act as standby for another device 69 * with the same MAC. 70 */ 71 #define VIRTIO_NET_F_SPEED_DUPLEX 63 /* Device set linkspeed and duplex */ 72 73 #ifndef VIRTIO_NET_NO_LEGACY 74 #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ 75 #endif /* VIRTIO_NET_NO_LEGACY */ 76 77 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 78 #define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */ 79 80 /* supported/enabled hash types */ 81 #define VIRTIO_NET_RSS_HASH_TYPE_IPv4 (1 << 0) 82 #define VIRTIO_NET_RSS_HASH_TYPE_TCPv4 (1 << 1) 83 #define VIRTIO_NET_RSS_HASH_TYPE_UDPv4 (1 << 2) 84 #define VIRTIO_NET_RSS_HASH_TYPE_IPv6 (1 << 3) 85 #define VIRTIO_NET_RSS_HASH_TYPE_TCPv6 (1 << 4) 86 #define VIRTIO_NET_RSS_HASH_TYPE_UDPv6 (1 << 5) 87 #define VIRTIO_NET_RSS_HASH_TYPE_IP_EX (1 << 6) 88 #define VIRTIO_NET_RSS_HASH_TYPE_TCP_EX (1 << 7) 89 #define VIRTIO_NET_RSS_HASH_TYPE_UDP_EX (1 << 8) 90 91 struct virtio_net_config { 92 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 93 __u8 mac[ETH_ALEN]; 94 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 95 __virtio16 status; 96 /* Maximum number of each of transmit and receive queues; 97 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ. 98 * Legal values are between 1 and 0x8000 99 */ 100 __virtio16 max_virtqueue_pairs; 101 /* Default maximum transmit unit advice */ 102 __virtio16 mtu; 103 /* 104 * speed, in units of 1Mb. All values 0 to INT_MAX are legal. 105 * Any other value stands for unknown. 106 */ 107 __le32 speed; 108 /* 109 * 0x00 - half duplex 110 * 0x01 - full duplex 111 * Any other value stands for unknown. 112 */ 113 __u8 duplex; 114 /* maximum size of RSS key */ 115 __u8 rss_max_key_size; 116 /* maximum number of indirection table entries */ 117 __le16 rss_max_indirection_table_length; 118 /* bitmask of supported VIRTIO_NET_RSS_HASH_ types */ 119 __le32 supported_hash_types; 120 } __attribute__((packed)); 121 122 /* 123 * This header comes first in the scatter-gather list. If you don't 124 * specify GSO or CSUM features, you can simply ignore the header. 125 * 126 * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf, 127 * only flattened. 128 */ 129 struct virtio_net_hdr_v1 { 130 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start, csum_offset */ 131 #define VIRTIO_NET_HDR_F_DATA_VALID 2 /* Csum is valid */ 132 #define VIRTIO_NET_HDR_F_RSC_INFO 4 /* rsc info in csum_ fields */ 133 __u8 flags; 134 #define VIRTIO_NET_HDR_GSO_NONE 0 /* Not a GSO frame */ 135 #define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */ 136 #define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */ 137 #define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */ 138 #define VIRTIO_NET_HDR_GSO_UDP_L4 5 /* GSO frame, IPv4& IPv6 UDP (USO) */ 139 #define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */ 140 __u8 gso_type; 141 __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 142 __virtio16 gso_size; /* Bytes to append to hdr_len per frame */ 143 union { 144 struct { 145 __virtio16 csum_start; 146 __virtio16 csum_offset; 147 }; 148 /* Checksum calculation */ 149 struct { 150 /* Position to start checksumming from */ 151 __virtio16 start; 152 /* Offset after that to place checksum */ 153 __virtio16 offset; 154 } csum; 155 /* Receive Segment Coalescing */ 156 struct { 157 /* Number of coalesced segments */ 158 __le16 segments; 159 /* Number of duplicated acks */ 160 __le16 dup_acks; 161 } rsc; 162 }; 163 __virtio16 num_buffers; /* Number of merged rx buffers */ 164 }; 165 166 struct virtio_net_hdr_v1_hash { 167 struct virtio_net_hdr_v1 hdr; 168 __le32 hash_value; 169 #define VIRTIO_NET_HASH_REPORT_NONE 0 170 #define VIRTIO_NET_HASH_REPORT_IPv4 1 171 #define VIRTIO_NET_HASH_REPORT_TCPv4 2 172 #define VIRTIO_NET_HASH_REPORT_UDPv4 3 173 #define VIRTIO_NET_HASH_REPORT_IPv6 4 174 #define VIRTIO_NET_HASH_REPORT_TCPv6 5 175 #define VIRTIO_NET_HASH_REPORT_UDPv6 6 176 #define VIRTIO_NET_HASH_REPORT_IPv6_EX 7 177 #define VIRTIO_NET_HASH_REPORT_TCPv6_EX 8 178 #define VIRTIO_NET_HASH_REPORT_UDPv6_EX 9 179 __le16 hash_report; 180 __le16 padding; 181 }; 182 183 #ifndef VIRTIO_NET_NO_LEGACY 184 /* This header comes first in the scatter-gather list. 185 * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must 186 * be the first element of the scatter-gather list. If you don't 187 * specify GSO or CSUM features, you can simply ignore the header. */ 188 struct virtio_net_hdr { 189 /* See VIRTIO_NET_HDR_F_* */ 190 __u8 flags; 191 /* See VIRTIO_NET_HDR_GSO_* */ 192 __u8 gso_type; 193 __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 194 __virtio16 gso_size; /* Bytes to append to hdr_len per frame */ 195 __virtio16 csum_start; /* Position to start checksumming from */ 196 __virtio16 csum_offset; /* Offset after that to place checksum */ 197 }; 198 199 /* This is the version of the header to use when the MRG_RXBUF 200 * feature has been negotiated. */ 201 struct virtio_net_hdr_mrg_rxbuf { 202 struct virtio_net_hdr hdr; 203 __virtio16 num_buffers; /* Number of merged rx buffers */ 204 }; 205 #endif /* ...VIRTIO_NET_NO_LEGACY */ 206 207 /* 208 * Control virtqueue data structures 209 * 210 * The control virtqueue expects a header in the first sg entry 211 * and an ack/status response in the last entry. Data for the 212 * command goes in between. 213 */ 214 struct virtio_net_ctrl_hdr { 215 __u8 class; 216 __u8 cmd; 217 } __attribute__((packed)); 218 219 typedef __u8 virtio_net_ctrl_ack; 220 221 #define VIRTIO_NET_OK 0 222 #define VIRTIO_NET_ERR 1 223 224 /* 225 * Control the RX mode, ie. promisucous, allmulti, etc... 226 * All commands require an "out" sg entry containing a 1 byte 227 * state value, zero = disable, non-zero = enable. Commands 228 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 229 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 230 */ 231 #define VIRTIO_NET_CTRL_RX 0 232 #define VIRTIO_NET_CTRL_RX_PROMISC 0 233 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 234 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 235 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 236 #define VIRTIO_NET_CTRL_RX_NOUNI 4 237 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 238 239 /* 240 * Control the MAC 241 * 242 * The MAC filter table is managed by the hypervisor, the guest should 243 * assume the size is infinite. Filtering should be considered 244 * non-perfect, ie. based on hypervisor resources, the guest may 245 * received packets from sources not specified in the filter list. 246 * 247 * In addition to the class/cmd header, the TABLE_SET command requires 248 * two out scatterlists. Each contains a 4 byte count of entries followed 249 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 250 * first sg list contains unicast addresses, the second is for multicast. 251 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 252 * is available. 253 * 254 * The ADDR_SET command requests one out scatterlist, it contains a 255 * 6 bytes MAC address. This functionality is present if the 256 * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available. 257 */ 258 struct virtio_net_ctrl_mac { 259 __virtio32 entries; 260 __u8 macs[][ETH_ALEN]; 261 } __attribute__((packed)); 262 263 #define VIRTIO_NET_CTRL_MAC 1 264 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 265 #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1 266 267 /* 268 * Control VLAN filtering 269 * 270 * The VLAN filter table is controlled via a simple ADD/DEL interface. 271 * VLAN IDs not added may be filterd by the hypervisor. Del is the 272 * opposite of add. Both commands expect an out entry containing a 2 273 * byte VLAN ID. VLAN filterting is available with the 274 * VIRTIO_NET_F_CTRL_VLAN feature bit. 275 */ 276 #define VIRTIO_NET_CTRL_VLAN 2 277 #define VIRTIO_NET_CTRL_VLAN_ADD 0 278 #define VIRTIO_NET_CTRL_VLAN_DEL 1 279 280 /* 281 * Control link announce acknowledgement 282 * 283 * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that 284 * driver has recevied the notification; device would clear the 285 * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives 286 * this command. 287 */ 288 #define VIRTIO_NET_CTRL_ANNOUNCE 3 289 #define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0 290 291 /* 292 * Control Receive Flow Steering 293 */ 294 #define VIRTIO_NET_CTRL_MQ 4 295 /* 296 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 297 * enables Receive Flow Steering, specifying the number of the transmit and 298 * receive queues that will be used. After the command is consumed and acked by 299 * the device, the device will not steer new packets on receive virtqueues 300 * other than specified nor read from transmit virtqueues other than specified. 301 * Accordingly, driver should not transmit new packets on virtqueues other than 302 * specified. 303 */ 304 struct virtio_net_ctrl_mq { 305 __virtio16 virtqueue_pairs; 306 }; 307 308 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 309 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 310 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 311 312 /* 313 * The command VIRTIO_NET_CTRL_MQ_RSS_CONFIG has the same effect as 314 * VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET does and additionally configures 315 * the receive steering to use a hash calculated for incoming packet 316 * to decide on receive virtqueue to place the packet. The command 317 * also provides parameters to calculate a hash and receive virtqueue. 318 */ 319 struct virtio_net_rss_config { 320 __le32 hash_types; 321 __le16 indirection_table_mask; 322 __le16 unclassified_queue; 323 __le16 indirection_table[1/* + indirection_table_mask */]; 324 __le16 max_tx_vq; 325 __u8 hash_key_length; 326 __u8 hash_key_data[/* hash_key_length */]; 327 }; 328 329 #define VIRTIO_NET_CTRL_MQ_RSS_CONFIG 1 330 331 /* 332 * The command VIRTIO_NET_CTRL_MQ_HASH_CONFIG requests the device 333 * to include in the virtio header of the packet the value of the 334 * calculated hash and the report type of hash. It also provides 335 * parameters for hash calculation. The command requires feature 336 * VIRTIO_NET_F_HASH_REPORT to be negotiated to extend the 337 * layout of virtio header as defined in virtio_net_hdr_v1_hash. 338 */ 339 struct virtio_net_hash_config { 340 __le32 hash_types; 341 /* for compatibility with virtio_net_rss_config */ 342 __le16 reserved[4]; 343 __u8 hash_key_length; 344 __u8 hash_key_data[/* hash_key_length */]; 345 }; 346 347 #define VIRTIO_NET_CTRL_MQ_HASH_CONFIG 2 348 349 /* 350 * Control network offloads 351 * 352 * Reconfigures the network offloads that Guest can handle. 353 * 354 * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit. 355 * 356 * Command data format matches the feature bit mask exactly. 357 * 358 * See VIRTIO_NET_F_GUEST_* for the list of offloads 359 * that can be enabled/disabled. 360 */ 361 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS 5 362 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET 0 363 364 /* 365 * Control notifications coalescing. 366 * 367 * Request the device to change the notifications coalescing parameters. 368 * 369 * Available with the VIRTIO_NET_F_NOTF_COAL feature bit. 370 */ 371 #define VIRTIO_NET_CTRL_NOTF_COAL 6 372 /* 373 * Set the tx-usecs/tx-max-packets parameters. 374 */ 375 struct virtio_net_ctrl_coal_tx { 376 /* Maximum number of packets to send before a TX notification */ 377 __le32 tx_max_packets; 378 /* Maximum number of usecs to delay a TX notification */ 379 __le32 tx_usecs; 380 }; 381 382 #define VIRTIO_NET_CTRL_NOTF_COAL_TX_SET 0 383 384 /* 385 * Set the rx-usecs/rx-max-packets parameters. 386 */ 387 struct virtio_net_ctrl_coal_rx { 388 /* Maximum number of packets to receive before a RX notification */ 389 __le32 rx_max_packets; 390 /* Maximum number of usecs to delay a RX notification */ 391 __le32 rx_usecs; 392 }; 393 394 #define VIRTIO_NET_CTRL_NOTF_COAL_RX_SET 1 395 #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 396 #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 397 398 struct virtio_net_ctrl_coal { 399 __le32 max_packets; 400 __le32 max_usecs; 401 }; 402 403 struct virtio_net_ctrl_coal_vq { 404 __le16 vqn; 405 __le16 reserved; 406 struct virtio_net_ctrl_coal coal; 407 }; 408 409 #endif /* _UAPI_LINUX_VIRTIO_NET_H */ 410