1 /* 2 * Virtio Network Device 3 * 4 * Copyright IBM, Corp. 2007 5 * 6 * Authors: 7 * Anthony Liguori <aliguori@us.ibm.com> 8 * 9 * This work is licensed under the terms of the GNU GPL, version 2. See 10 * the COPYING file in the top-level directory. 11 * 12 */ 13 14 #ifndef _QEMU_VIRTIO_NET_H 15 #define _QEMU_VIRTIO_NET_H 16 17 #include "virtio.h" 18 #include "pci/pci.h" 19 20 #define ETH_ALEN 6 21 22 /* from Linux's virtio_net.h */ 23 24 /* The ID for virtio_net */ 25 #define VIRTIO_ID_NET 1 26 27 /* The feature bitmap for virtio net */ 28 #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */ 29 #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */ 30 #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ 31 #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ 32 #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ 33 #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ 34 #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ 35 #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ 36 #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ 37 #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ 38 #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ 39 #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ 40 #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ 41 #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ 42 #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ 43 #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ 44 #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ 45 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ 46 #define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow 47 * Steering */ 48 49 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */ 50 51 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ 52 53 #define TX_TIMER_INTERVAL 150000 /* 150 us */ 54 55 /* Limit the number of packets that can be sent via a single flush 56 * of the TX queue. This gives us a guaranteed exit condition and 57 * ensures fairness in the io path. 256 conveniently matches the 58 * length of the TX queue and shows a good balance of performance 59 * and latency. */ 60 #define TX_BURST 256 61 62 typedef struct virtio_net_conf 63 { 64 uint32_t txtimer; 65 int32_t txburst; 66 char *tx; 67 } virtio_net_conf; 68 69 /* Maximum packet size we can receive from tap device: header + 64k */ 70 #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10)) 71 72 struct virtio_net_config 73 { 74 /* The config defining mac address ($ETH_ALEN bytes) */ 75 uint8_t mac[ETH_ALEN]; 76 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ 77 uint16_t status; 78 /* Max virtqueue pairs supported by the device */ 79 uint16_t max_virtqueue_pairs; 80 } QEMU_PACKED; 81 82 /* 83 * Control virtqueue data structures 84 * 85 * The control virtqueue expects a header in the first sg entry 86 * and an ack/status response in the last entry. Data for the 87 * command goes in between. 88 */ 89 struct virtio_net_ctrl_hdr { 90 uint8_t class; 91 uint8_t cmd; 92 }; 93 94 typedef uint8_t virtio_net_ctrl_ack; 95 96 #define VIRTIO_NET_OK 0 97 #define VIRTIO_NET_ERR 1 98 99 /* 100 * Control the RX mode, ie. promisucous, allmulti, etc... 101 * All commands require an "out" sg entry containing a 1 byte 102 * state value, zero = disable, non-zero = enable. Commands 103 * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. 104 * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. 105 */ 106 #define VIRTIO_NET_CTRL_RX 0 107 #define VIRTIO_NET_CTRL_RX_PROMISC 0 108 #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 109 #define VIRTIO_NET_CTRL_RX_ALLUNI 2 110 #define VIRTIO_NET_CTRL_RX_NOMULTI 3 111 #define VIRTIO_NET_CTRL_RX_NOUNI 4 112 #define VIRTIO_NET_CTRL_RX_NOBCAST 5 113 114 /* 115 * Control the MAC 116 * 117 * The MAC filter table is managed by the hypervisor, the guest should 118 * assume the size is infinite. Filtering should be considered 119 * non-perfect, ie. based on hypervisor resources, the guest may 120 * received packets from sources not specified in the filter list. 121 * 122 * In addition to the class/cmd header, the TABLE_SET command requires 123 * two out scatterlists. Each contains a 4 byte count of entries followed 124 * by a concatenated byte stream of the ETH_ALEN MAC addresses. The 125 * first sg list contains unicast addresses, the second is for multicast. 126 * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature 127 * is available. 128 * 129 * The ADDR_SET command requests one out scatterlist, it contains a 130 * 6 bytes MAC address. This functionality is present if the 131 * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available. 132 */ 133 struct virtio_net_ctrl_mac { 134 uint32_t entries; 135 uint8_t macs[][ETH_ALEN]; 136 }; 137 #define VIRTIO_NET_CTRL_MAC 1 138 #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 139 #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1 140 141 /* 142 * Control VLAN filtering 143 * 144 * The VLAN filter table is controlled via a simple ADD/DEL interface. 145 * VLAN IDs not added may be filterd by the hypervisor. Del is the 146 * opposite of add. Both commands expect an out entry containing a 2 147 * byte VLAN ID. VLAN filterting is available with the 148 * VIRTIO_NET_F_CTRL_VLAN feature bit. 149 */ 150 #define VIRTIO_NET_CTRL_VLAN 2 151 #define VIRTIO_NET_CTRL_VLAN_ADD 0 152 #define VIRTIO_NET_CTRL_VLAN_DEL 1 153 154 /* 155 * Control Multiqueue 156 * 157 * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 158 * enables multiqueue, specifying the number of the transmit and 159 * receive queues that will be used. After the command is consumed and acked by 160 * the device, the device will not steer new packets on receive virtqueues 161 * other than specified nor read from transmit virtqueues other than specified. 162 * Accordingly, driver should not transmit new packets on virtqueues other than 163 * specified. 164 */ 165 struct virtio_net_ctrl_mq { 166 uint16_t virtqueue_pairs; 167 }; 168 169 #define VIRTIO_NET_CTRL_MQ 4 170 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 171 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 172 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 173 174 #define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \ 175 DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \ 176 DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \ 177 DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \ 178 DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \ 179 DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \ 180 DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \ 181 DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \ 182 DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \ 183 DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \ 184 DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \ 185 DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \ 186 DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \ 187 DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \ 188 DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \ 189 DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \ 190 DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \ 191 DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \ 192 DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true), \ 193 DEFINE_PROP_BIT("ctrl_mac_addr", _state, _field, VIRTIO_NET_F_CTRL_MAC_ADDR, true), \ 194 DEFINE_PROP_BIT("mq", _state, _field, VIRTIO_NET_F_MQ, true) 195 196 #endif 197