1 /* 2 * This header is BSD licensed so anyone can use the definitions to implement 3 * compatible drivers/servers. 4 * 5 * $FreeBSD$ 6 */ 7 8 #ifndef _VIRTIO_NET_H 9 #define _VIRTIO_NET_H 10 11 #include <sys/types.h> 12 13 /* The feature bitmap for virtio net */ 14 #define VIRTIO_NET_F_CSUM 0x00001 /* Host handles pkts w/ partial csum */ 15 #define VIRTIO_NET_F_GUEST_CSUM 0x00002 /* Guest handles pkts w/ partial csum*/ 16 #define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 0x00004 /* Guest can do dynamic 17 * offloads state configuration */ 18 #define VIRTIO_NET_F_MAC 0x00020 /* Host has given MAC address. */ 19 #define VIRTIO_NET_F_GSO 0x00040 /* Host handles pkts w/ any GSO type */ 20 #define VIRTIO_NET_F_GUEST_TSO4 0x00080 /* Guest can handle TSOv4 in. */ 21 #define VIRTIO_NET_F_GUEST_TSO6 0x00100 /* Guest can handle TSOv6 in. */ 22 #define VIRTIO_NET_F_GUEST_ECN 0x00200 /* Guest can handle TSO[6] w/ ECN in.*/ 23 #define VIRTIO_NET_F_GUEST_UFO 0x00400 /* Guest can handle UFO in. */ 24 #define VIRTIO_NET_F_HOST_TSO4 0x00800 /* Host can handle TSOv4 in. */ 25 #define VIRTIO_NET_F_HOST_TSO6 0x01000 /* Host can handle TSOv6 in. */ 26 #define VIRTIO_NET_F_HOST_ECN 0x02000 /* Host can handle TSO[6] w/ ECN in. */ 27 #define VIRTIO_NET_F_HOST_UFO 0x04000 /* Host can handle UFO in. */ 28 #define VIRTIO_NET_F_MRG_RXBUF 0x08000 /* Host can merge receive buffers. */ 29 #define VIRTIO_NET_F_STATUS 0x10000 /* virtio_net_config.status available*/ 30 #define VIRTIO_NET_F_CTRL_VQ 0x20000 /* Control channel available */ 31 #define VIRTIO_NET_F_CTRL_RX 0x40000 /* Control channel RX mode support */ 32 #define VIRTIO_NET_F_CTRL_VLAN 0x80000 /* Control channel VLAN filtering */ 33 #define VIRTIO_NET_F_CTRL_RX_EXTRA 0x100000 /* Extra RX mode control support */ 34 #define VIRTIO_NET_F_GUEST_ANNOUNCE 0x200000 /* Guest can announce device on the 35 * network */ 36 #define VIRTIO_NET_F_MQ 0x400000 /* Device supports Receive Flow 37 * Steering */ 38 #define VIRTIO_NET_F_CTRL_MAC_ADDR 0x800000 /* Set MAC address */ 39 40 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 41 #define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */ 42 43 struct virtio_net_config { 44 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 45 uint8_t mac[ETHER_ADDR_LEN]; 46 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 47 uint16_t status; 48 /* Maximum number of each of transmit and receive queues; 49 * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ. 50 * Legal values are between 1 and 0x8000 51 */ 52 uint16_t max_virtqueue_pairs; 53 } __packed; 54 55 /* 56 * This is the first element of the scatter-gather list. If you don't 57 * specify GSO or CSUM features, you can simply ignore the header. 58 */ 59 struct virtio_net_hdr { 60 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start,csum_offset*/ 61 uint8_t flags; 62 #define VIRTIO_NET_HDR_GSO_NONE 0 /* Not a GSO frame */ 63 #define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */ 64 #define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */ 65 #define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */ 66 #define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */ 67 uint8_t gso_type; 68 uint16_t hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 69 uint16_t gso_size; /* Bytes to append to hdr_len per frame */ 70 uint16_t csum_start; /* Position to start checksumming from */ 71 uint16_t csum_offset; /* Offset after that to place checksum */ 72 }; 73 74 /* 75 * This is the version of the header to use when the MRG_RXBUF 76 * feature has been negotiated. 77 */ 78 struct virtio_net_hdr_mrg_rxbuf { 79 struct virtio_net_hdr hdr; 80 uint16_t num_buffers; /* Number of merged rx buffers */ 81 }; 82 83 /* 84 * Control virtqueue data structures 85 * 86 * The control virtqueue expects a header in the first sg entry 87 * and an ack/status response in the last entry. Data for the 88 * command goes in between. 89 */ 90 struct virtio_net_ctrl_hdr { 91 uint8_t class; 92 uint8_t cmd; 93 } __packed; 94 95 typedef uint8_t virtio_net_ctrl_ack; 96 97 #define VIRTIO_NET_OK 0 98 #define VIRTIO_NET_ERR 1 99 100 /* 101 * Control the RX mode, ie. promiscuous, allmulti, etc... 102 * All commands require an "out" sg entry containing a 1 byte 103 * state value, zero = disable, non-zero = enable. Commands 104 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 105 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 106 */ 107 #define VIRTIO_NET_CTRL_RX 0 108 #define VIRTIO_NET_CTRL_RX_PROMISC 0 109 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 110 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 111 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 112 #define VIRTIO_NET_CTRL_RX_NOUNI 4 113 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 114 115 /* 116 * Control the MAC filter table. 117 * 118 * The MAC filter table is managed by the hypervisor, the guest should 119 * assume the size is infinite. Filtering should be considered 120 * non-perfect, ie. based on hypervisor resources, the guest may 121 * received packets from sources not specified in the filter list. 122 * 123 * In addition to the class/cmd header, the TABLE_SET command requires 124 * two out scatterlists. Each contains a 4 byte count of entries followed 125 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 126 * first sg list contains unicast addresses, the second is for multicast. 127 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 128 * is available. 129 */ 130 struct virtio_net_ctrl_mac { 131 uint32_t entries; 132 uint8_t macs[][ETHER_ADDR_LEN]; 133 } __packed; 134 135 #define VIRTIO_NET_CTRL_MAC 1 136 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 137 #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1 138 139 /* 140 * Control VLAN filtering 141 * 142 * The VLAN filter table is controlled via a simple ADD/DEL interface. 143 * VLAN IDs not added may be filtered by the hypervisor. Del is the 144 * opposite of add. Both commands expect an out entry containing a 2 145 * byte VLAN ID. VLAN filtering is available with the 146 * VIRTIO_NET_F_CTRL_VLAN feature bit. 147 */ 148 #define VIRTIO_NET_CTRL_VLAN 2 149 #define VIRTIO_NET_CTRL_VLAN_ADD 0 150 #define VIRTIO_NET_CTRL_VLAN_DEL 1 151 152 /* 153 * Control link announce acknowledgement 154 * 155 * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that 156 * driver has recevied the notification; device would clear the 157 * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives 158 * this command. 159 */ 160 #define VIRTIO_NET_CTRL_ANNOUNCE 3 161 #define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0 162 163 /* 164 * Control Receive Flow Steering 165 * 166 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 167 * enables Receive Flow Steering, specifying the number of the transmit and 168 * receive queues that will be used. After the command is consumed and acked by 169 * the device, the device will not steer new packets on receive virtqueues 170 * other than specified nor read from transmit virtqueues other than specified. 171 * Accordingly, driver should not transmit new packets on virtqueues other than 172 * specified. 173 */ 174 struct virtio_net_ctrl_mq { 175 uint16_t virtqueue_pairs; 176 }; 177 178 #define VIRTIO_NET_CTRL_MQ 4 179 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 180 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 181 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 182 183 #endif /* _VIRTIO_NET_H */ 184