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