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