iPXE
virtio-net.h
Go to the documentation of this file.
00001 #ifndef _VIRTIO_NET_H_
00002 # define _VIRTIO_NET_H_
00003 
00004 /* The feature bitmap for virtio net */
00005 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
00006 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
00007 #define VIRTIO_NET_F_MTU        3       /* Initial MTU advice */
00008 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
00009 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
00010 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
00011 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
00012 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
00013 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
00014 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
00015 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
00016 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
00017 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
00018 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Driver can merge receive buffers. */
00019 #define VIRTIO_NET_F_STATUS     16      /* Configuration status field is available. */
00020 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel is available. */
00021 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support. */
00022 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering. */
00023 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Driver can send gratuitous packets. */
00024 
00025 struct virtio_net_config
00026 {
00027    /* The config defining mac address (if VIRTIO_NET_F_MAC) */
00028    u8 mac[6];
00029    /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
00030    u16 status;
00031    /* Maximum number of each of transmit and receive queues;
00032     * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ.
00033     * Legal values are between 1 and 0x8000
00034     */
00035    u16 max_virtqueue_pairs;
00036    /* Default maximum transmit unit advice */
00037    u16 mtu;
00038 } __attribute__((packed));
00039 
00040 /* This is the first element of the scatter-gather list.  If you don't
00041  * specify GSO or CSUM features, you can simply ignore the header. */
00042 
00043 struct virtio_net_hdr
00044 {
00045 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       // Use csum_start, csum_offset
00046    uint8_t flags;
00047 #define VIRTIO_NET_HDR_GSO_NONE         0       // Not a GSO frame
00048 #define VIRTIO_NET_HDR_GSO_TCPV4        1       // GSO frame, IPv4 TCP (TSO)
00049 /* FIXME: Do we need this?  If they said they can handle ECN, do they care? */
00050 #define VIRTIO_NET_HDR_GSO_TCPV4_ECN    2       // GSO frame, IPv4 TCP w/ ECN
00051 #define VIRTIO_NET_HDR_GSO_UDP          3       // GSO frame, IPv4 UDP (UFO)
00052 #define VIRTIO_NET_HDR_GSO_TCPV6        4       // GSO frame, IPv6 TCP
00053 #define VIRTIO_NET_HDR_GSO_ECN          0x80    // TCP has ECN set
00054    uint8_t gso_type;
00055    uint16_t hdr_len;
00056    uint16_t gso_size;
00057    uint16_t csum_start;
00058    uint16_t csum_offset;
00059 };
00060 
00061 /* Virtio 1.0 version of the first element of the scatter-gather list. */
00062 struct virtio_net_hdr_modern
00063 {
00064    struct virtio_net_hdr legacy;
00065 
00066    /* Used only if VIRTIO_NET_F_MRG_RXBUF: */
00067    uint16_t num_buffers;
00068 };
00069 
00070 #endif /* _VIRTIO_NET_H_ */