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