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