include/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 #include <linux/types.h>
   6 #include <linux/virtio_config.h>
   7
   8 /* The ID for virtio_net */
   9 #define VIRTIO_ID_NET   1
  10
  11 /* The feature bitmap for virtio net */
  12 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  13 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  14 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  15 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
  16 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  17 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  18 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  19 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  20 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  21 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  22 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  23 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  24 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  25 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  26 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  27 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  28
  29 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  30
  31 struct virtio_net_config
  32 {
  33         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
  34         __u8 mac[6];
  35         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
  36         __u16 status;
  37 } __attribute__((packed));
  38
  39 /* This is the first element of the scatter-gather list.  If you don't
  40  * specify GSO or CSUM features, you can simply ignore the header. */
  41 struct virtio_net_hdr
  42 {
  43 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       // Use csum_start, csum_offset
  44         __u8 flags;
  45 #define VIRTIO_NET_HDR_GSO_NONE         0       // Not a GSO frame
  46 #define VIRTIO_NET_HDR_GSO_TCPV4        1       // GSO frame, IPv4 TCP (TSO)
  47 #define VIRTIO_NET_HDR_GSO_UDP          3       // GSO frame, IPv4 UDP (UFO)
  48 #define VIRTIO_NET_HDR_GSO_TCPV6        4       // GSO frame, IPv6 TCP
  49 #define VIRTIO_NET_HDR_GSO_ECN          0x80    // TCP has ECN set
  50         __u8 gso_type;
  51         __u16 hdr_len;          /* Ethernet + IP + tcp/udp hdrs */
  52         __u16 gso_size;         /* Bytes to append to hdr_len per frame */
  53         __u16 csum_start;       /* Position to start checksumming from */
  54         __u16 csum_offset;      /* Offset after that to place checksum */
  55 };
  56
  57 /* This is the version of the header to use when the MRG_RXBUF
  58  * feature has been negotiated. */
  59 struct virtio_net_hdr_mrg_rxbuf {
  60         struct virtio_net_hdr hdr;
  61         __u16 num_buffers;      /* Number of merged rx buffers */
  62 };
  63
  64 /*
  65  * Control virtqueue data structures
  66  *
  67  * The control virtqueue expects a header in the first sg entry
  68  * and an ack/status response in the last entry.  Data for the
  69  * command goes in between.
  70  */
  71 struct virtio_net_ctrl_hdr {
  72         __u8 class;
  73         __u8 cmd;
  74 } __attribute__((packed));
  75
  76 typedef __u8 virtio_net_ctrl_ack;
  77
  78 #define VIRTIO_NET_OK     0
  79 #define VIRTIO_NET_ERR    1
  80
  81 /*
  82  * Control the RX mode, ie. promisucous and allmulti.  PROMISC and
  83  * ALLMULTI commands require an "out" sg entry containing a 1 byte
  84  * state value, zero = disable, non-zero = enable.  These commands
  85  * are supported with the VIRTIO_NET_F_CTRL_RX feature.
  86  */
  87 #define VIRTIO_NET_CTRL_RX    0
  88  #define VIRTIO_NET_CTRL_RX_PROMISC      0
  89  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
  90
  91 #endif /* _LINUX_VIRTIO_NET_H */