---

---

---

001: #ifndef _LINUX_VIRTIO_NET_H
002: #define _LINUX_VIRTIO_NET_H
003: /* This header is BSD licensed so anyone can use the definitions to implement
004:  * compatible drivers/servers.
005:  *
006:  * Redistribution and use in source and binary forms, with or without
007:  * modification, are permitted provided that the following conditions
008:  * are met:
009:  * 1. Redistributions of source code must retain the above copyright
010:  *    notice, this list of conditions and the following disclaimer.
011:  * 2. Redistributions in binary form must reproduce the above copyright
012:  *    notice, this list of conditions and the following disclaimer in the
013:  *    documentation and/or other materials provided with the distribution.
014:  * 3. Neither the name of IBM nor the names of its contributors
015:  *    may be used to endorse or promote products derived from this software
016:  *    without specific prior written permission.
017:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
018:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
020:  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
021:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
022:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
023:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
024:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
025:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
026:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
027:  * SUCH DAMAGE. */
028: #include <linux/types.h>
029: #include <linux/virtio_ids.h>
030: #include <linux/virtio_config.h>
031: #include <linux/if_ether.h>
032: 
033: /* The feature bitmap for virtio net */
034: #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
035: #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
036: #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
037: #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
038: #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
039: #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
040: #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
041: #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
042: #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
043: #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
044: #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
045: #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
046: #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
047: #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
048: #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
049: #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
050: #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
051: #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
052: 
053: #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
054: 
055: struct virtio_net_config {
056:         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
057:         __u8 mac[6];
058:         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
059:         __u16 status;
060: } __attribute__((packed));
061: 
062: /* This is the first element of the scatter-gather list.  If you don't
063:  * specify GSO or CSUM features, you can simply ignore the header. */
064: struct virtio_net_hdr {
065: #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       // Use csum_start, csum_offset
066: #define VIRTIO_NET_HDR_F_DATA_VALID     2       // Csum is valid
067:         __u8 flags;
068: #define VIRTIO_NET_HDR_GSO_NONE         0       // Not a GSO frame
069: #define VIRTIO_NET_HDR_GSO_TCPV4        1       // GSO frame, IPv4 TCP (TSO)
070: #define VIRTIO_NET_HDR_GSO_UDP          3       // GSO frame, IPv4 UDP (UFO)
071: #define VIRTIO_NET_HDR_GSO_TCPV6        4       // GSO frame, IPv6 TCP
072: #define VIRTIO_NET_HDR_GSO_ECN          0x80    // TCP has ECN set
073:         __u8 gso_type;
074:         __u16 hdr_len;          /* Ethernet + IP + tcp/udp hdrs */
075:         __u16 gso_size;         /* Bytes to append to hdr_len per frame */
076:         __u16 csum_start;       /* Position to start checksumming from */
077:         __u16 csum_offset;      /* Offset after that to place checksum */
078: };
079: 
080: /* This is the version of the header to use when the MRG_RXBUF
081:  * feature has been negotiated. */
082: struct virtio_net_hdr_mrg_rxbuf {
083:         struct virtio_net_hdr hdr;
084:         __u16 num_buffers;      /* Number of merged rx buffers */
085: };
086: 
087: /*
088:  * Control virtqueue data structures
089:  *
090:  * The control virtqueue expects a header in the first sg entry
091:  * and an ack/status response in the last entry.  Data for the
092:  * command goes in between.
093:  */
094: struct virtio_net_ctrl_hdr {
095:         __u8 class;
096:         __u8 cmd;
097: } __attribute__((packed));
098: 
099: typedef __u8 virtio_net_ctrl_ack;
100: 
101: #define VIRTIO_NET_OK     0
102: #define VIRTIO_NET_ERR    1
103: 
104: /*
105:  * Control the RX mode, ie. promisucous, allmulti, etc...
106:  * All commands require an "out" sg entry containing a 1 byte
107:  * state value, zero = disable, non-zero = enable.  Commands
108:  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
109:  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
110:  */
111: #define VIRTIO_NET_CTRL_RX    0
112:  #define VIRTIO_NET_CTRL_RX_PROMISC      0
113:  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
114:  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
115:  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
116:  #define VIRTIO_NET_CTRL_RX_NOUNI        4
117:  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
118: 
119: /*
120:  * Control the MAC filter table.
121:  *
122:  * The MAC filter table is managed by the hypervisor, the guest should
123:  * assume the size is infinite.  Filtering should be considered
124:  * non-perfect, ie. based on hypervisor resources, the guest may
125:  * received packets from sources not specified in the filter list.
126:  *
127:  * In addition to the class/cmd header, the TABLE_SET command requires
128:  * two out scatterlists.  Each contains a 4 byte count of entries followed
129:  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
130:  * first sg list contains unicast addresses, the second is for multicast.
131:  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
132:  * is available.
133:  */
134: struct virtio_net_ctrl_mac {
135:         __u32 entries;
136:         __u8 macs[][ETH_ALEN];
137: } __attribute__((packed));
138: 
139: #define VIRTIO_NET_CTRL_MAC    1
140:  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
141: 
142: /*
143:  * Control VLAN filtering
144:  *
145:  * The VLAN filter table is controlled via a simple ADD/DEL interface.
146:  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
147:  * opposite of add.  Both commands expect an out entry containing a 2
148:  * byte VLAN ID.  VLAN filterting is available with the
149:  * VIRTIO_NET_F_CTRL_VLAN feature bit.
150:  */
151: #define VIRTIO_NET_CTRL_VLAN       2
152:  #define VIRTIO_NET_CTRL_VLAN_ADD             0
153:  #define VIRTIO_NET_CTRL_VLAN_DEL             1
154: 
155: #endif /* _LINUX_VIRTIO_NET_H */
156: 

---

---

---