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