include/uapi/linux/virtio_net.h

   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  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of IBM nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE. */
  28 #include <linux/types.h>
  29 #include <linux/virtio_ids.h>
  30 #include <linux/virtio_config.h>
  31 #include <linux/if_ether.h>
  32
  33 /* The feature bitmap for virtio net */
  34 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  35 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  36 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  37 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
  38 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  39 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  40 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  41 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  42 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  43 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  44 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  45 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  46 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  47 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  48 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  49 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  50 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
  51 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
  52 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the
  53                                          * network */
  54 #define VIRTIO_NET_F_MQ 22      /* Device supports Receive Flow
  55                                          * Steering */
  56 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
  57
  58 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  59 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
  60
  61 struct virtio_net_config {
  62         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
  63         __u8 mac[ETH_ALEN];
  64         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
  65         __u16 status;
  66         /* Maximum number of each of transmit and receive queues;
  67          * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
  68          * Legal values are between 1 and 0x8000
  69          */
  70         __u16 max_virtqueue_pairs;
  71 } __attribute__((packed));
  72
  73 /* This header comes first in the scatter-gather list.
  74  * If VIRTIO_F_ANY_LAYOUT is not negotiated, it must
  75  * be the first element of the scatter-gather list.  If you don't
  76  * specify GSO or CSUM features, you can simply ignore the header. */
  77 struct virtio_net_hdr {
  78 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       // Use csum_start, csum_offset
  79 #define VIRTIO_NET_HDR_F_DATA_VALID     2       // Csum is valid
  80         __u8 flags;
  81 #define VIRTIO_NET_HDR_GSO_NONE         0       // Not a GSO frame
  82 #define VIRTIO_NET_HDR_GSO_TCPV4        1       // GSO frame, IPv4 TCP (TSO)
  83 #define VIRTIO_NET_HDR_GSO_UDP          3       // GSO frame, IPv4 UDP (UFO)
  84 #define VIRTIO_NET_HDR_GSO_TCPV6        4       // GSO frame, IPv6 TCP
  85 #define VIRTIO_NET_HDR_GSO_ECN          0x80    // TCP has ECN set
  86         __u8 gso_type;
  87         __u16 hdr_len;          /* Ethernet + IP + tcp/udp hdrs */
  88         __u16 gso_size;         /* Bytes to append to hdr_len per frame */
  89         __u16 csum_start;       /* Position to start checksumming from */
  90         __u16 csum_offset;      /* Offset after that to place checksum */
  91 };
  92
  93 /* This is the version of the header to use when the MRG_RXBUF
  94  * feature has been negotiated. */
  95 struct virtio_net_hdr_mrg_rxbuf {
  96         struct virtio_net_hdr hdr;
  97         __u16 num_buffers;      /* Number of merged rx buffers */
  98 };
  99
 100 /*
 101  * Control virtqueue data structures
 102  *
 103  * The control virtqueue expects a header in the first sg entry
 104  * and an ack/status response in the last entry.  Data for the
 105  * command goes in between.
 106  */
 107 struct virtio_net_ctrl_hdr {
 108         __u8 class;
 109         __u8 cmd;
 110 } __attribute__((packed));
 111
 112 typedef __u8 virtio_net_ctrl_ack;
 113
 114 #define VIRTIO_NET_OK     0
 115 #define VIRTIO_NET_ERR    1
 116
 117 /*
 118  * Control the RX mode, ie. promisucous, allmulti, etc...
 119  * All commands require an "out" sg entry containing a 1 byte
 120  * state value, zero = disable, non-zero = enable.  Commands
 121  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
 122  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
 123  */
 124 #define VIRTIO_NET_CTRL_RX    0
 125  #define VIRTIO_NET_CTRL_RX_PROMISC      0
 126  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
 127  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
 128  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
 129  #define VIRTIO_NET_CTRL_RX_NOUNI        4
 130  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
 131
 132 /*
 133  * Control the MAC
 134  *
 135  * The MAC filter table is managed by the hypervisor, the guest should
 136  * assume the size is infinite.  Filtering should be considered
 137  * non-perfect, ie. based on hypervisor resources, the guest may
 138  * received packets from sources not specified in the filter list.
 139  *
 140  * In addition to the class/cmd header, the TABLE_SET command requires
 141  * two out scatterlists.  Each contains a 4 byte count of entries followed
 142  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
 143  * first sg list contains unicast addresses, the second is for multicast.
 144  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
 145  * is available.
 146  *
 147  * The ADDR_SET command requests one out scatterlist, it contains a
 148  * 6 bytes MAC address. This functionality is present if the
 149  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
 150  */
 151 struct virtio_net_ctrl_mac {
 152         __u32 entries;
 153         __u8 macs[][ETH_ALEN];
 154 } __attribute__((packed));
 155
 156 #define VIRTIO_NET_CTRL_MAC    1
 157  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
 158  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
 159
 160 /*
 161  * Control VLAN filtering
 162  *
 163  * The VLAN filter table is controlled via a simple ADD/DEL interface.
 164  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
 165  * opposite of add.  Both commands expect an out entry containing a 2
 166  * byte VLAN ID.  VLAN filterting is available with the
 167  * VIRTIO_NET_F_CTRL_VLAN feature bit.
 168  */
 169 #define VIRTIO_NET_CTRL_VLAN       2
 170  #define VIRTIO_NET_CTRL_VLAN_ADD             0
 171  #define VIRTIO_NET_CTRL_VLAN_DEL             1
 172
 173 /*
 174  * Control link announce acknowledgement
 175  *
 176  * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
 177  * driver has recevied the notification; device would clear the
 178  * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
 179  * this command.
 180  */
 181 #define VIRTIO_NET_CTRL_ANNOUNCE       3
 182  #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0
 183
 184 /*
 185  * Control Receive Flow Steering
 186  *
 187  * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
 188  * enables Receive Flow Steering, specifying the number of the transmit and
 189  * receive queues that will be used. After the command is consumed and acked by
 190  * the device, the device will not steer new packets on receive virtqueues
 191  * other than specified nor read from transmit virtqueues other than specified.
 192  * Accordingly, driver should not transmit new packets  on virtqueues other than
 193  * specified.
 194  */
 195 struct virtio_net_ctrl_mq {
 196         __u16 virtqueue_pairs;
 197 };
 198
 199 #define VIRTIO_NET_CTRL_MQ   4
 200  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
 201  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
 202  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
 203
 204 #endif /* _LINUX_VIRTIO_NET_H */