include/uapi/linux/virtio_net.h

   1 #ifndef _UAPI_LINUX_VIRTIO_NET_H
   2 #define _UAPI_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/virtio_types.h>
  32 #include <linux/if_ether.h>
  33
  34 /* The feature bitmap for virtio net */
  35 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  36 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  37 #define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2 /* Dynamic offload configuration. */
  38 #define VIRTIO_NET_F_MTU        3       /* Initial MTU advice */
  39 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  40 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  41 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  42 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  43 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  44 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  45 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  46 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  47 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  48 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  49 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  50 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  51 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  52 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
  53 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
  54 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the
  55                                          * network */
  56 #define VIRTIO_NET_F_MQ 22      /* Device supports Receive Flow
  57                                          * Steering */
  58 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
  59
  60 #define VIRTIO_NET_F_SPEED_DUPLEX 63    /* Device set linkspeed and duplex */
  61
  62 #ifndef VIRTIO_NET_NO_LEGACY
  63 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
  64 #endif /* VIRTIO_NET_NO_LEGACY */
  65
  66 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  67 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
  68
  69 struct virtio_net_config {
  70         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
  71         __u8 mac[ETH_ALEN];
  72         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
  73         __u16 status;
  74         /* Maximum number of each of transmit and receive queues;
  75          * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
  76          * Legal values are between 1 and 0x8000
  77          */
  78         __u16 max_virtqueue_pairs;
  79         /* Default maximum transmit unit advice */
  80         __u16 mtu;
  81         /*
  82          * speed, in units of 1Mb. All values 0 to INT_MAX are legal.
  83          * Any other value stands for unknown.
  84          */
  85         __u32 speed;
  86         /*
  87          * 0x00 - half duplex
  88          * 0x01 - full duplex
  89          * Any other value stands for unknown.
  90          */
  91         __u8 duplex;
  92 } __attribute__((packed));
  93
  94 /*
  95  * This header comes first in the scatter-gather list.  If you don't
  96  * specify GSO or CSUM features, you can simply ignore the header.
  97  *
  98  * This is bitwise-equivalent to the legacy struct virtio_net_hdr_mrg_rxbuf,
  99  * only flattened.
 100  */
 101 struct virtio_net_hdr_v1 {
 102 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       /* Use csum_start, csum_offset */
 103 #define VIRTIO_NET_HDR_F_DATA_VALID     2       /* Csum is valid */
 104         __u8 flags;
 105 #define VIRTIO_NET_HDR_GSO_NONE         0       /* Not a GSO frame */
 106 #define VIRTIO_NET_HDR_GSO_TCPV4        1       /* GSO frame, IPv4 TCP (TSO) */
 107 #define VIRTIO_NET_HDR_GSO_UDP          3       /* GSO frame, IPv4 UDP (UFO) */
 108 #define VIRTIO_NET_HDR_GSO_TCPV6        4       /* GSO frame, IPv6 TCP */
 109 #define VIRTIO_NET_HDR_GSO_ECN          0x80    /* TCP has ECN set */
 110         __u8 gso_type;
 111         __virtio16 hdr_len;     /* Ethernet + IP + tcp/udp hdrs */
 112         __virtio16 gso_size;    /* Bytes to append to hdr_len per frame */
 113         __virtio16 csum_start;  /* Position to start checksumming from */
 114         __virtio16 csum_offset; /* Offset after that to place checksum */
 115         __virtio16 num_buffers; /* Number of merged rx buffers */
 116 };
 117
 118 #ifndef VIRTIO_NET_NO_LEGACY
 119 /* This header comes first in the scatter-gather list.
 120  * For legacy virtio, if VIRTIO_F_ANY_LAYOUT is not negotiated, it must
 121  * be the first element of the scatter-gather list.  If you don't
 122  * specify GSO or CSUM features, you can simply ignore the header. */
 123 struct virtio_net_hdr {
 124         /* See VIRTIO_NET_HDR_F_* */
 125         __u8 flags;
 126         /* See VIRTIO_NET_HDR_GSO_* */
 127         __u8 gso_type;
 128         __virtio16 hdr_len;             /* Ethernet + IP + tcp/udp hdrs */
 129         __virtio16 gso_size;            /* Bytes to append to hdr_len per frame */
 130         __virtio16 csum_start;  /* Position to start checksumming from */
 131         __virtio16 csum_offset; /* Offset after that to place checksum */
 132 };
 133
 134 /* This is the version of the header to use when the MRG_RXBUF
 135  * feature has been negotiated. */
 136 struct virtio_net_hdr_mrg_rxbuf {
 137         struct virtio_net_hdr hdr;
 138         __virtio16 num_buffers; /* Number of merged rx buffers */
 139 };
 140 #endif /* ...VIRTIO_NET_NO_LEGACY */
 141
 142 /*
 143  * Control virtqueue data structures
 144  *
 145  * The control virtqueue expects a header in the first sg entry
 146  * and an ack/status response in the last entry.  Data for the
 147  * command goes in between.
 148  */
 149 struct virtio_net_ctrl_hdr {
 150         __u8 class;
 151         __u8 cmd;
 152 } __attribute__((packed));
 153
 154 typedef __u8 virtio_net_ctrl_ack;
 155
 156 #define VIRTIO_NET_OK     0
 157 #define VIRTIO_NET_ERR    1
 158
 159 /*
 160  * Control the RX mode, ie. promisucous, allmulti, etc...
 161  * All commands require an "out" sg entry containing a 1 byte
 162  * state value, zero = disable, non-zero = enable.  Commands
 163  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
 164  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
 165  */
 166 #define VIRTIO_NET_CTRL_RX    0
 167  #define VIRTIO_NET_CTRL_RX_PROMISC      0
 168  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
 169  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
 170  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
 171  #define VIRTIO_NET_CTRL_RX_NOUNI        4
 172  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
 173
 174 /*
 175  * Control the MAC
 176  *
 177  * The MAC filter table is managed by the hypervisor, the guest should
 178  * assume the size is infinite.  Filtering should be considered
 179  * non-perfect, ie. based on hypervisor resources, the guest may
 180  * received packets from sources not specified in the filter list.
 181  *
 182  * In addition to the class/cmd header, the TABLE_SET command requires
 183  * two out scatterlists.  Each contains a 4 byte count of entries followed
 184  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
 185  * first sg list contains unicast addresses, the second is for multicast.
 186  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
 187  * is available.
 188  *
 189  * The ADDR_SET command requests one out scatterlist, it contains a
 190  * 6 bytes MAC address. This functionality is present if the
 191  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
 192  */
 193 struct virtio_net_ctrl_mac {
 194         __virtio32 entries;
 195         __u8 macs[][ETH_ALEN];
 196 } __attribute__((packed));
 197
 198 #define VIRTIO_NET_CTRL_MAC    1
 199  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
 200  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
 201
 202 /*
 203  * Control VLAN filtering
 204  *
 205  * The VLAN filter table is controlled via a simple ADD/DEL interface.
 206  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
 207  * opposite of add.  Both commands expect an out entry containing a 2
 208  * byte VLAN ID.  VLAN filterting is available with the
 209  * VIRTIO_NET_F_CTRL_VLAN feature bit.
 210  */
 211 #define VIRTIO_NET_CTRL_VLAN       2
 212  #define VIRTIO_NET_CTRL_VLAN_ADD             0
 213  #define VIRTIO_NET_CTRL_VLAN_DEL             1
 214
 215 /*
 216  * Control link announce acknowledgement
 217  *
 218  * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that
 219  * driver has recevied the notification; device would clear the
 220  * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives
 221  * this command.
 222  */
 223 #define VIRTIO_NET_CTRL_ANNOUNCE       3
 224  #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0
 225
 226 /*
 227  * Control Receive Flow Steering
 228  *
 229  * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
 230  * enables Receive Flow Steering, specifying the number of the transmit and
 231  * receive queues that will be used. After the command is consumed and acked by
 232  * the device, the device will not steer new packets on receive virtqueues
 233  * other than specified nor read from transmit virtqueues other than specified.
 234  * Accordingly, driver should not transmit new packets  on virtqueues other than
 235  * specified.
 236  */
 237 struct virtio_net_ctrl_mq {
 238         __virtio16 virtqueue_pairs;
 239 };
 240
 241 #define VIRTIO_NET_CTRL_MQ   4
 242  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
 243  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
 244  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
 245
 246 /*
 247  * Control network offloads
 248  *
 249  * Reconfigures the network offloads that Guest can handle.
 250  *
 251  * Available with the VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
 252  *
 253  * Command data format matches the feature bit mask exactly.
 254  *
 255  * See VIRTIO_NET_F_GUEST_* for the list of offloads
 256  * that can be enabled/disabled.
 257  */
 258 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS   5
 259 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET        0
 260
 261 #endif /* _UAPI_LINUX_VIRTIO_NET_H */