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/if_ether.h> 32 33 /* The feature bitmap for virtio net */ 34 #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */ 35 #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */ 36 #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ 37 #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ 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 57 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 58 #define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */ 59 60 struct virtio_net_config { 61 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 62 __u8 mac[6]; 63 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 64 __u16 status; 65 /* Maximum number of each of transmit and receive queues; 66 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ. 67 * Legal values are between 1 and 0x8000 68 */ 69 __u16 max_virtqueue_pairs; 70 } __attribute__((packed)); 71 72 /* This is the first element of the scatter-gather list. If you don't 73 * specify GSO or CSUM features, you can simply ignore the header. */ 74 struct virtio_net_hdr { 75 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset 76 #define VIRTIO_NET_HDR_F_DATA_VALID 2 // Csum is valid 77 __u8 flags; 78 #define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame 79 #define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO) 80 #define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO) 81 #define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP 82 #define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set 83 __u8 gso_type; 84 __u16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 85 __u16 gso_size; /* Bytes to append to hdr_len per frame */ 86 __u16 csum_start; /* Position to start checksumming from */ 87 __u16 csum_offset; /* Offset after that to place checksum */ 88 }; 89 90 /* This is the version of the header to use when the MRG_RXBUF 91 * feature has been negotiated. */ 92 struct virtio_net_hdr_mrg_rxbuf { 93 struct virtio_net_hdr hdr; 94 __u16 num_buffers; /* Number of merged rx buffers */ 95 }; 96 97 /* 98 * Control virtqueue data structures 99 * 100 * The control virtqueue expects a header in the first sg entry 101 * and an ack/status response in the last entry. Data for the 102 * command goes in between. 103 */ 104 struct virtio_net_ctrl_hdr { 105 __u8 class; 106 __u8 cmd; 107 } __attribute__((packed)); 108 109 typedef __u8 virtio_net_ctrl_ack; 110 111 #define VIRTIO_NET_OK 0 112 #define VIRTIO_NET_ERR 1 113 114 /* 115 * Control the RX mode, ie. promisucous, allmulti, etc... 116 * All commands require an "out" sg entry containing a 1 byte 117 * state value, zero = disable, non-zero = enable. Commands 118 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 119 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 120 */ 121 #define VIRTIO_NET_CTRL_RX 0 122 #define VIRTIO_NET_CTRL_RX_PROMISC 0 123 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 124 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 125 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 126 #define VIRTIO_NET_CTRL_RX_NOUNI 4 127 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 128 129 /* 130 * Control the MAC filter table. 131 * 132 * The MAC filter table is managed by the hypervisor, the guest should 133 * assume the size is infinite. Filtering should be considered 134 * non-perfect, ie. based on hypervisor resources, the guest may 135 * received packets from sources not specified in the filter list. 136 * 137 * In addition to the class/cmd header, the TABLE_SET command requires 138 * two out scatterlists. Each contains a 4 byte count of entries followed 139 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 140 * first sg list contains unicast addresses, the second is for multicast. 141 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 142 * is available. 143 */ 144 struct virtio_net_ctrl_mac { 145 __u32 entries; 146 __u8 macs[][ETH_ALEN]; 147 } __attribute__((packed)); 148 149 #define VIRTIO_NET_CTRL_MAC 1 150 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 151 152 /* 153 * Control VLAN filtering 154 * 155 * The VLAN filter table is controlled via a simple ADD/DEL interface. 156 * VLAN IDs not added may be filterd by the hypervisor. Del is the 157 * opposite of add. Both commands expect an out entry containing a 2 158 * byte VLAN ID. VLAN filterting is available with the 159 * VIRTIO_NET_F_CTRL_VLAN feature bit. 160 */ 161 #define VIRTIO_NET_CTRL_VLAN 2 162 #define VIRTIO_NET_CTRL_VLAN_ADD 0 163 #define VIRTIO_NET_CTRL_VLAN_DEL 1 164 165 /* 166 * Control link announce acknowledgement 167 * 168 * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that 169 * driver has recevied the notification; device would clear the 170 * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives 171 * this command. 172 */ 173 #define VIRTIO_NET_CTRL_ANNOUNCE 3 174 #define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0 175 176 /* 177 * Control Receive Flow Steering 178 * 179 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 180 * enables Receive Flow Steering, specifying the number of the transmit and 181 * receive queues that will be used. After the command is consumed and acked by 182 * the device, the device will not steer new packets on receive virtqueues 183 * other than specified nor read from transmit virtqueues other than specified. 184 * Accordingly, driver should not transmit new packets on virtqueues other than 185 * specified. 186 */ 187 struct virtio_net_ctrl_mq { 188 u16 virtqueue_pairs; 189 }; 190 191 #define VIRTIO_NET_CTRL_MQ 4 192 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 193 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 194 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 195 196 #endif /* _LINUX_VIRTIO_NET_H */ 197