hw/virtio-net.h

   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 "net.h"
  19 #include "pci.h"
  20
  21 #define ETH_ALEN    6
  22
  23 /* from Linux's virtio_net.h */
  24
  25 /* The ID for virtio_net */
  26 #define VIRTIO_ID_NET   1
  27
  28 /* The feature bitmap for virtio net */
  29 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  30 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  31 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  32 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
  33 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  34 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  35 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  36 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  37 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  38 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  39 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  40 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  41 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  42 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  43 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  44 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  45 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
  46 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
  47
  48 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  49
  50 #define TX_TIMER_INTERVAL 150000 /* 150 us */
  51
  52 /* Maximum packet size we can receive from tap device: header + 64k */
  53 #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10))
  54
  55 struct virtio_net_config
  56 {
  57     /* The config defining mac address ($ETH_ALEN bytes) */
  58     uint8_t mac[ETH_ALEN];
  59     /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
  60     uint16_t status;
  61 } __attribute__((packed));
  62
  63 /* This is the first element of the scatter-gather list.  If you don't
  64  * specify GSO or CSUM features, you can simply ignore the header. */
  65 struct virtio_net_hdr
  66 {
  67 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       // Use csum_start, csum_offset
  68     uint8_t flags;
  69 #define VIRTIO_NET_HDR_GSO_NONE         0       // Not a GSO frame
  70 #define VIRTIO_NET_HDR_GSO_TCPV4        1       // GSO frame, IPv4 TCP (TSO)
  71 #define VIRTIO_NET_HDR_GSO_UDP          3       // GSO frame, IPv4 UDP (UFO)
  72 #define VIRTIO_NET_HDR_GSO_TCPV6        4       // GSO frame, IPv6 TCP
  73 #define VIRTIO_NET_HDR_GSO_ECN          0x80    // TCP has ECN set
  74     uint8_t gso_type;
  75     uint16_t hdr_len;
  76     uint16_t gso_size;
  77     uint16_t csum_start;
  78     uint16_t csum_offset;
  79 };
  80
  81 /* This is the version of the header to use when the MRG_RXBUF
  82  * feature has been negotiated. */
  83 struct virtio_net_hdr_mrg_rxbuf
  84 {
  85     struct virtio_net_hdr hdr;
  86     uint16_t num_buffers;   /* Number of merged rx buffers */
  87 };
  88
  89 /*
  90  * Control virtqueue data structures
  91  *
  92  * The control virtqueue expects a header in the first sg entry
  93  * and an ack/status response in the last entry.  Data for the
  94  * command goes in between.
  95  */
  96 struct virtio_net_ctrl_hdr {
  97     uint8_t class;
  98     uint8_t cmd;
  99 };
 100
 101 typedef uint8_t virtio_net_ctrl_ack;
 102
 103 #define VIRTIO_NET_OK     0
 104 #define VIRTIO_NET_ERR    1
 105
 106 /*
 107  * Control the RX mode, ie. promisucous, allmulti, etc...
 108  * All commands require an "out" sg entry containing a 1 byte
 109  * state value, zero = disable, non-zero = enable.  Commands
 110  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
 111  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
 112  */
 113 #define VIRTIO_NET_CTRL_RX_MODE    0
 114  #define VIRTIO_NET_CTRL_RX_MODE_PROMISC      0
 115  #define VIRTIO_NET_CTRL_RX_MODE_ALLMULTI     1
 116  #define VIRTIO_NET_CTRL_RX_MODE_ALLUNI       2
 117  #define VIRTIO_NET_CTRL_RX_MODE_NOMULTI      3
 118  #define VIRTIO_NET_CTRL_RX_MODE_NOUNI        4
 119  #define VIRTIO_NET_CTRL_RX_MODE_NOBCAST      5
 120
 121 /*
 122  * Control the MAC filter table.
 123  *
 124  * The MAC filter table is managed by the hypervisor, the guest should
 125  * assume the size is infinite.  Filtering should be considered
 126  * non-perfect, ie. based on hypervisor resources, the guest may
 127  * received packets from sources not specified in the filter list.
 128  *
 129  * In addition to the class/cmd header, the TABLE_SET command requires
 130  * two out scatterlists.  Each contains a 4 byte count of entries followed
 131  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
 132  * first sg list contains unicast addresses, the second is for multicast.
 133  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
 134  * is available.
 135  */
 136 struct virtio_net_ctrl_mac {
 137     uint32_t entries;
 138     uint8_t macs[][ETH_ALEN];
 139 };
 140 #define VIRTIO_NET_CTRL_MAC    1
 141  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
 142
 143 /*
 144  * Control VLAN filtering
 145  *
 146  * The VLAN filter table is controlled via a simple ADD/DEL interface.
 147  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
 148  * opposite of add.  Both commands expect an out entry containing a 2
 149  * byte VLAN ID.  VLAN filterting is available with the
 150  * VIRTIO_NET_F_CTRL_VLAN feature bit.
 151  */
 152 #define VIRTIO_NET_CTRL_VLAN       2
 153  #define VIRTIO_NET_CTRL_VLAN_ADD             0
 154  #define VIRTIO_NET_CTRL_VLAN_DEL             1
 155
 156 #define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \
 157         DEFINE_VIRTIO_COMMON_FEATURES(_state, _field), \
 158         DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \
 159         DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \
 160         DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \
 161         DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \
 162         DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \
 163         DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \
 164         DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \
 165         DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \
 166         DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \
 167         DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \
 168         DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \
 169         DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \
 170         DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \
 171         DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \
 172         DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \
 173         DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \
 174         DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true)
 175 #endif