1 /*- 2 * This header is BSD licensed so anyone can use the definitions to implement 3 * compatible drivers/servers. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of IBM nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _VIRTIO_NET_H 32 #define _VIRTIO_NET_H 33 34 #include <sys/types.h> 35 36 /* The feature bitmap for virtio net */ 37 #define VIRTIO_NET_F_CSUM 0x00001 /* Host handles pkts w/ partial csum */ 38 #define VIRTIO_NET_F_GUEST_CSUM 0x00002 /* Guest handles pkts w/ partial csum*/ 39 #define VIRTIO_NET_F_MAC 0x00020 /* Host has given MAC address. */ 40 #define VIRTIO_NET_F_GSO 0x00040 /* Host handles pkts w/ any GSO type */ 41 #define VIRTIO_NET_F_GUEST_TSO4 0x00080 /* Guest can handle TSOv4 in. */ 42 #define VIRTIO_NET_F_GUEST_TSO6 0x00100 /* Guest can handle TSOv6 in. */ 43 #define VIRTIO_NET_F_GUEST_ECN 0x00200 /* Guest can handle TSO[6] w/ ECN in.*/ 44 #define VIRTIO_NET_F_GUEST_UFO 0x00400 /* Guest can handle UFO in. */ 45 #define VIRTIO_NET_F_HOST_TSO4 0x00800 /* Host can handle TSOv4 in. */ 46 #define VIRTIO_NET_F_HOST_TSO6 0x01000 /* Host can handle TSOv6 in. */ 47 #define VIRTIO_NET_F_HOST_ECN 0x02000 /* Host can handle TSO[6] w/ ECN in. */ 48 #define VIRTIO_NET_F_HOST_UFO 0x04000 /* Host can handle UFO in. */ 49 #define VIRTIO_NET_F_MRG_RXBUF 0x08000 /* Host can merge receive buffers. */ 50 #define VIRTIO_NET_F_STATUS 0x10000 /* virtio_net_config.status available*/ 51 #define VIRTIO_NET_F_CTRL_VQ 0x20000 /* Control channel available */ 52 #define VIRTIO_NET_F_CTRL_RX 0x40000 /* Control channel RX mode support */ 53 #define VIRTIO_NET_F_CTRL_VLAN 0x80000 /* Control channel VLAN filtering */ 54 #define VIRTIO_NET_F_CTRL_RX_EXTRA 0x100000 /* Extra RX mode control support */ 55 56 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 57 58 struct virtio_net_config { 59 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 60 uint8_t mac[ETHER_ADDR_LEN]; 61 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 62 uint16_t status; 63 } __packed; 64 65 /* 66 * This is the first element of the scatter-gather list. If you don't 67 * specify GSO or CSUM features, you can simply ignore the header. 68 */ 69 struct virtio_net_hdr { 70 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start,csum_offset*/ 71 uint8_t flags; 72 #define VIRTIO_NET_HDR_GSO_NONE 0 /* Not a GSO frame */ 73 #define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */ 74 #define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */ 75 #define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */ 76 #define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */ 77 uint8_t gso_type; 78 uint16_t hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 79 uint16_t gso_size; /* Bytes to append to hdr_len per frame */ 80 uint16_t csum_start; /* Position to start checksumming from */ 81 uint16_t csum_offset; /* Offset after that to place checksum */ 82 }; 83 84 /* 85 * This is the version of the header to use when the MRG_RXBUF 86 * feature has been negotiated. 87 */ 88 struct virtio_net_hdr_mrg_rxbuf { 89 struct virtio_net_hdr hdr; 90 uint16_t num_buffers; /* Number of merged rx buffers */ 91 }; 92 93 /* 94 * Control virtqueue data structures 95 * 96 * The control virtqueue expects a header in the first sg entry 97 * and an ack/status response in the last entry. Data for the 98 * command goes in between. 99 */ 100 struct virtio_net_ctrl_hdr { 101 uint8_t class; 102 uint8_t cmd; 103 } __packed; 104 105 typedef uint8_t virtio_net_ctrl_ack; 106 107 #define VIRTIO_NET_OK 0 108 #define VIRTIO_NET_ERR 1 109 110 /* 111 * Control the RX mode, ie. promiscuous, allmulti, etc... 112 * All commands require an "out" sg entry containing a 1 byte 113 * state value, zero = disable, non-zero = enable. Commands 114 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 115 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 116 */ 117 #define VIRTIO_NET_CTRL_RX 0 118 #define VIRTIO_NET_CTRL_RX_PROMISC 0 119 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 120 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 121 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 122 #define VIRTIO_NET_CTRL_RX_NOUNI 4 123 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 124 125 /* 126 * Control the MAC filter table. 127 * 128 * The MAC filter table is managed by the hypervisor, the guest should 129 * assume the size is infinite. Filtering should be considered 130 * non-perfect, ie. based on hypervisor resources, the guest may 131 * received packets from sources not specified in the filter list. 132 * 133 * In addition to the class/cmd header, the TABLE_SET command requires 134 * two out scatterlists. Each contains a 4 byte count of entries followed 135 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 136 * first sg list contains unicast addresses, the second is for multicast. 137 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 138 * is available. 139 */ 140 struct virtio_net_ctrl_mac { 141 uint32_t entries; 142 uint8_t macs[][ETHER_ADDR_LEN]; 143 } __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 filtered by the hypervisor. Del is the 153 * opposite of add. Both commands expect an out entry containing a 2 154 * byte VLAN ID. VLAN filtering 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 #endif /* _VIRTIO_NET_H */ 162