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