1 #ifndef _LINUX_VIRTIO_NET_H 2 #define _LINUX_VIRTIO_NET_H 3 /* This header is BSD licensed so anyone can use the definitions to implement 4 * compatible drivers/servers. */ 5 #include <linux/types.h> 6 #include <linux/virtio_ids.h> 7 #include <linux/virtio_config.h> 8 #include <linux/if_ether.h> 9 10 /* The feature bitmap for virtio net */ 11 #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */ 12 #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */ 13 #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ 14 #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ 15 #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ 16 #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ 17 #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ 18 #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ 19 #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ 20 #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ 21 #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ 22 #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ 23 #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ 24 #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ 25 #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ 26 #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ 27 #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ 28 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ 29 30 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 31 32 struct virtio_net_config { 33 /* The config defining mac address (if VIRTIO_NET_F_MAC) */ 34 __u8 mac[6]; 35 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 36 __u16 status; 37 } __attribute__((packed)); 38 39 /* This is the first element of the scatter-gather list. If you don't 40 * specify GSO or CSUM features, you can simply ignore the header. */ 41 struct virtio_net_hdr { 42 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset 43 __u8 flags; 44 #define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame 45 #define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO) 46 #define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO) 47 #define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP 48 #define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set 49 __u8 gso_type; 50 __u16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ 51 __u16 gso_size; /* Bytes to append to hdr_len per frame */ 52 __u16 csum_start; /* Position to start checksumming from */ 53 __u16 csum_offset; /* Offset after that to place checksum */ 54 }; 55 56 /* This is the version of the header to use when the MRG_RXBUF 57 * feature has been negotiated. */ 58 struct virtio_net_hdr_mrg_rxbuf { 59 struct virtio_net_hdr hdr; 60 __u16 num_buffers; /* Number of merged rx buffers */ 61 }; 62 63 /* 64 * Control virtqueue data structures 65 * 66 * The control virtqueue expects a header in the first sg entry 67 * and an ack/status response in the last entry. Data for the 68 * command goes in between. 69 */ 70 struct virtio_net_ctrl_hdr { 71 __u8 class; 72 __u8 cmd; 73 } __attribute__((packed)); 74 75 typedef __u8 virtio_net_ctrl_ack; 76 77 #define VIRTIO_NET_OK 0 78 #define VIRTIO_NET_ERR 1 79 80 /* 81 * Control the RX mode, ie. promisucous, allmulti, etc... 82 * All commands require an "out" sg entry containing a 1 byte 83 * state value, zero = disable, non-zero = enable. Commands 84 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 85 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 86 */ 87 #define VIRTIO_NET_CTRL_RX 0 88 #define VIRTIO_NET_CTRL_RX_PROMISC 0 89 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 90 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 91 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 92 #define VIRTIO_NET_CTRL_RX_NOUNI 4 93 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 94 95 /* 96 * Control the MAC filter table. 97 * 98 * The MAC filter table is managed by the hypervisor, the guest should 99 * assume the size is infinite. Filtering should be considered 100 * non-perfect, ie. based on hypervisor resources, the guest may 101 * received packets from sources not specified in the filter list. 102 * 103 * In addition to the class/cmd header, the TABLE_SET command requires 104 * two out scatterlists. Each contains a 4 byte count of entries followed 105 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 106 * first sg list contains unicast addresses, the second is for multicast. 107 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 108 * is available. 109 */ 110 struct virtio_net_ctrl_mac { 111 __u32 entries; 112 __u8 macs[][ETH_ALEN]; 113 } __attribute__((packed)); 114 115 #define VIRTIO_NET_CTRL_MAC 1 116 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 117 118 /* 119 * Control VLAN filtering 120 * 121 * The VLAN filter table is controlled via a simple ADD/DEL interface. 122 * VLAN IDs not added may be filterd by the hypervisor. Del is the 123 * opposite of add. Both commands expect an out entry containing a 2 124 * byte VLAN ID. VLAN filterting is available with the 125 * VIRTIO_NET_F_CTRL_VLAN feature bit. 126 */ 127 #define VIRTIO_NET_CTRL_VLAN 2 128 #define VIRTIO_NET_CTRL_VLAN_ADD 0 129 #define VIRTIO_NET_CTRL_VLAN_DEL 1 130 131 #endif /* _LINUX_VIRTIO_NET_H */ 132
