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 33 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 34 35 struct virtio_net_config { 36 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 37 uint8_t mac[ETHER_ADDR_LEN]; 38 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 39 uint16_t status; 40 } __packed; 41 42 /* 43 * This is the first element of the scatter-gather list. If you don't 44 * specify GSO or CSUM features, you can simply ignore the header. 45 */ 46 struct virtio_net_hdr { 47 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start,csum_offset*/ 48 uint8_t flags; 49 #define VIRTIO_NET_HDR_GSO_NONE 0 /* Not a GSO frame */ 50 #define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */ 51 #define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */ 52 #define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */ 53 #define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */ 54 uint8_t gso_type; 55 uint16_t hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 56 uint16_t gso_size; /* Bytes to append to hdr_len per frame */ 57 uint16_t csum_start; /* Position to start checksumming from */ 58 uint16_t csum_offset; /* Offset after that to place checksum */ 59 }; 60 61 /* 62 * This is the version of the header to use when the MRG_RXBUF 63 * feature has been negotiated. 64 */ 65 struct virtio_net_hdr_mrg_rxbuf { 66 struct virtio_net_hdr hdr; 67 uint16_t num_buffers; /* Number of merged rx buffers */ 68 }; 69 70 /* 71 * Control virtqueue data structures 72 * 73 * The control virtqueue expects a header in the first sg entry 74 * and an ack/status response in the last entry. Data for the 75 * command goes in between. 76 */ 77 struct virtio_net_ctrl_hdr { 78 uint8_t class; 79 uint8_t cmd; 80 } __packed; 81 82 typedef uint8_t virtio_net_ctrl_ack; 83 84 #define VIRTIO_NET_OK 0 85 #define VIRTIO_NET_ERR 1 86 87 /* 88 * Control the RX mode, ie. promiscuous, allmulti, etc... 89 * All commands require an "out" sg entry containing a 1 byte 90 * state value, zero = disable, non-zero = enable. Commands 91 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 92 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 93 */ 94 #define VIRTIO_NET_CTRL_RX 0 95 #define VIRTIO_NET_CTRL_RX_PROMISC 0 96 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 97 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 98 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 99 #define VIRTIO_NET_CTRL_RX_NOUNI 4 100 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 101 102 /* 103 * Control the MAC filter table. 104 * 105 * The MAC filter table is managed by the hypervisor, the guest should 106 * assume the size is infinite. Filtering should be considered 107 * non-perfect, ie. based on hypervisor resources, the guest may 108 * received packets from sources not specified in the filter list. 109 * 110 * In addition to the class/cmd header, the TABLE_SET command requires 111 * two out scatterlists. Each contains a 4 byte count of entries followed 112 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 113 * first sg list contains unicast addresses, the second is for multicast. 114 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 115 * is available. 116 */ 117 struct virtio_net_ctrl_mac { 118 uint32_t entries; 119 uint8_t macs[][ETHER_ADDR_LEN]; 120 } __packed; 121 122 #define VIRTIO_NET_CTRL_MAC 1 123 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 124 125 /* 126 * Control VLAN filtering 127 * 128 * The VLAN filter table is controlled via a simple ADD/DEL interface. 129 * VLAN IDs not added may be filtered by the hypervisor. Del is the 130 * opposite of add. Both commands expect an out entry containing a 2 131 * byte VLAN ID. VLAN filtering is available with the 132 * VIRTIO_NET_F_CTRL_VLAN feature bit. 133 */ 134 #define VIRTIO_NET_CTRL_VLAN 2 135 #define VIRTIO_NET_CTRL_VLAN_ADD 0 136 #define VIRTIO_NET_CTRL_VLAN_DEL 1 137 138 #endif /* _VIRTIO_NET_H */ 139