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