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 <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_MAC 5 /* Host has given MAC address. */ 38#define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ 39#define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ 40#define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ 41#define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ 42#define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ 43#define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ 44#define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ 45#define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ 46#define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ 47#define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ 48#define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ 49#define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ 50#define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ 51#define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ 52#define VIRTIO_NET_F_GUEST_ANNOUNCE 21 /* Guest can announce device on the 53 * network */ 54#define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow 55 * Steering */ 56#define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */ 57 58#ifndef VIRTIO_NET_NO_LEGACY 59#define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ 60#endif /* VIRTIO_NET_NO_LEGACY */ 61 62#define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 63#define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */ 64 65struct virtio_net_config { 66 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 67 __u8 mac[ETH_ALEN]; 68 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 69 __u16 status; 70 /* Maximum number of each of transmit and receive queues; 71 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ. 72 * Legal values are between 1 and 0x8000 73 */ 74 __u16 max_virtqueue_pairs; 75} __attribute__((packed)); 76 77/* 78 * This header comes first in the scatter-gather list. If you don't 79 * specify GSO or CSUM features, you can simply ignore the header. 80 * 81 * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf, 82 * only flattened. 83 */ 84struct virtio_net_hdr_v1 { 85#define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start, csum_offset */ 86#define VIRTIO_NET_HDR_F_DATA_VALID 2 /* Csum is valid */ 87 __u8 flags; 88#define VIRTIO_NET_HDR_GSO_NONE 0 /* Not a GSO frame */ 89#define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */ 90#define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */ 91#define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */ 92#define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */ 93 __u8 gso_type; 94 __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 95 __virtio16 gso_size; /* Bytes to append to hdr_len per frame */ 96 __virtio16 csum_start; /* Position to start checksumming from */ 97 __virtio16 csum_offset; /* Offset after that to place checksum */ 98 __virtio16 num_buffers; /* Number of merged rx buffers */ 99}; 100 101#ifndef VIRTIO_NET_NO_LEGACY 102/* This header comes first in the scatter-gather list. 103 * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must 104 * be the first element of the scatter-gather list. If you don't 105 * specify GSO or CSUM features, you can simply ignore the header. */ 106struct virtio_net_hdr { 107 /* See VIRTIO_NET_HDR_F_* */ 108 __u8 flags; 109 /* See VIRTIO_NET_HDR_GSO_* */ 110 __u8 gso_type; 111 __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 112 __virtio16 gso_size; /* Bytes to append to hdr_len per frame */ 113 __virtio16 csum_start; /* Position to start checksumming from */ 114 __virtio16 csum_offset; /* Offset after that to place checksum */ 115}; 116 117/* This is the version of the header to use when the MRG_RXBUF 118 * feature has been negotiated. */ 119struct virtio_net_hdr_mrg_rxbuf { 120 struct virtio_net_hdr hdr; 121 __virtio16 num_buffers; /* Number of merged rx buffers */ 122}; 123#endif /* ...VIRTIO_NET_NO_LEGACY */ 124 125/* 126 * Control virtqueue data structures 127 * 128 * The control virtqueue expects a header in the first sg entry 129 * and an ack/status response in the last entry. Data for the 130 * command goes in between. 131 */ 132struct virtio_net_ctrl_hdr { 133 __u8 class; 134 __u8 cmd; 135} __attribute__((packed)); 136 137typedef __u8 virtio_net_ctrl_ack; 138 139#define VIRTIO_NET_OK 0 140#define VIRTIO_NET_ERR 1 141 142/* 143 * Control the RX mode, ie. promisucous, allmulti, etc... 144 * All commands require an "out" sg entry containing a 1 byte 145 * state value, zero = disable, non-zero = enable. Commands 146 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 147 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 148 */ 149#define VIRTIO_NET_CTRL_RX 0 150 #define VIRTIO_NET_CTRL_RX_PROMISC 0 151 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 152 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 153 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 154 #define VIRTIO_NET_CTRL_RX_NOUNI 4 155 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 156 157/* 158 * Control the MAC 159 * 160 * The MAC filter table is managed by the hypervisor, the guest should 161 * assume the size is infinite. Filtering should be considered 162 * non-perfect, ie. based on hypervisor resources, the guest may 163 * received packets from sources not specified in the filter list. 164 * 165 * In addition to the class/cmd header, the TABLE_SET command requires 166 * two out scatterlists. Each contains a 4 byte count of entries followed 167 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 168 * first sg list contains unicast addresses, the second is for multicast. 169 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 170 * is available. 171 * 172 * The ADDR_SET command requests one out scatterlist, it contains a 173 * 6 bytes MAC address. This functionality is present if the 174 * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available. 175 */ 176struct virtio_net_ctrl_mac { 177 __virtio32 entries; 178 __u8 macs[][ETH_ALEN]; 179} __attribute__((packed)); 180 181#define VIRTIO_NET_CTRL_MAC 1 182 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 183 #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1 184 185/* 186 * Control VLAN filtering 187 * 188 * The VLAN filter table is controlled via a simple ADD/DEL interface. 189 * VLAN IDs not added may be filterd by the hypervisor. Del is the 190 * opposite of add. Both commands expect an out entry containing a 2 191 * byte VLAN ID. VLAN filterting is available with the 192 * VIRTIO_NET_F_CTRL_VLAN feature bit. 193 */ 194#define VIRTIO_NET_CTRL_VLAN 2 195 #define VIRTIO_NET_CTRL_VLAN_ADD 0 196 #define VIRTIO_NET_CTRL_VLAN_DEL 1 197 198/* 199 * Control link announce acknowledgement 200 * 201 * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that 202 * driver has recevied the notification; device would clear the 203 * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives 204 * this command. 205 */ 206#define VIRTIO_NET_CTRL_ANNOUNCE 3 207 #define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0 208 209/* 210 * Control Receive Flow Steering 211 * 212 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 213 * enables Receive Flow Steering, specifying the number of the transmit and 214 * receive queues that will be used. After the command is consumed and acked by 215 * the device, the device will not steer new packets on receive virtqueues 216 * other than specified nor read from transmit virtqueues other than specified. 217 * Accordingly, driver should not transmit new packets on virtqueues other than 218 * specified. 219 */ 220struct virtio_net_ctrl_mq { 221 __virtio16 virtqueue_pairs; 222}; 223 224#define VIRTIO_NET_CTRL_MQ 4 225 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 226 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 227 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 228 229#endif /* _LINUX_VIRTIO_NET_H */ 230