Commit | Line | Data |
---|---|---|
296f96fc RR |
1 | #ifndef _LINUX_VIRTIO_NET_H |
2 | #define _LINUX_VIRTIO_NET_H | |
674bfc23 | 3 | /* This header is BSD licensed so anyone can use the definitions to implement |
a1b38387 RR |
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. */ | |
9a0e0ac2 | 28 | #include <linux/types.h> |
e95646c3 | 29 | #include <linux/virtio_ids.h> |
296f96fc | 30 | #include <linux/virtio_config.h> |
fdd819b2 | 31 | #include <linux/virtio_types.h> |
c047fcd2 | 32 | #include <linux/if_ether.h> |
296f96fc | 33 | |
a586d4f6 | 34 | /* The feature bitmap for virtio net */ |
5539ae96 RR |
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 */ | |
34a48579 | 37 | #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */ |
5539ae96 RR |
38 | #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */ |
39 | #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */ | |
40 | #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */ | |
41 | #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */ | |
42 | #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */ | |
43 | #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */ | |
44 | #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */ | |
45 | #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */ | |
46 | #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */ | |
3f2c31d9 | 47 | #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */ |
9f4d26d0 | 48 | #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */ |
2a41f71d | 49 | #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */ |
2af7698e | 50 | #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */ |
0bde9569 | 51 | #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */ |
e79f07e2 | 52 | #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */ |
586d17c5 JW |
53 | #define VIRTIO_NET_F_GUEST_ANNOUNCE 21 /* Guest can announce device on the |
54 | * network */ | |
986a4f4d JW |
55 | #define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow |
56 | * Steering */ | |
7e58d5ae | 57 | #define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */ |
9f4d26d0 MM |
58 | |
59 | #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */ | |
586d17c5 | 60 | #define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */ |
296f96fc | 61 | |
1842f23c | 62 | struct virtio_net_config { |
a586d4f6 | 63 | /* The config defining mac address (if VIRTIO_NET_F_MAC) */ |
e216975a | 64 | __u8 mac[ETH_ALEN]; |
9f4d26d0 MM |
65 | /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */ |
66 | __u16 status; | |
986a4f4d JW |
67 | /* Maximum number of each of transmit and receive queues; |
68 | * see VIRTIO_NET_F_MQ and VIRTIO_NET_CTRL_MQ. | |
69 | * Legal values are between 1 and 0x8000 | |
70 | */ | |
71 | __u16 max_virtqueue_pairs; | |
a586d4f6 | 72 | } __attribute__((packed)); |
296f96fc | 73 | |
e7428e95 MT |
74 | /* This header comes first in the scatter-gather list. |
75 | * If VIRTIO_F_ANY_LAYOUT is not negotiated, it must | |
76 | * be the first element of the scatter-gather list. If you don't | |
296f96fc | 77 | * specify GSO or CSUM features, you can simply ignore the header. */ |
1842f23c | 78 | struct virtio_net_hdr { |
296f96fc | 79 | #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 // Use csum_start, csum_offset |
10a8d94a | 80 | #define VIRTIO_NET_HDR_F_DATA_VALID 2 // Csum is valid |
50c8ea80 | 81 | __u8 flags; |
296f96fc RR |
82 | #define VIRTIO_NET_HDR_GSO_NONE 0 // Not a GSO frame |
83 | #define VIRTIO_NET_HDR_GSO_TCPV4 1 // GSO frame, IPv4 TCP (TSO) | |
296f96fc RR |
84 | #define VIRTIO_NET_HDR_GSO_UDP 3 // GSO frame, IPv4 UDP (UFO) |
85 | #define VIRTIO_NET_HDR_GSO_TCPV6 4 // GSO frame, IPv6 TCP | |
34a48579 | 86 | #define VIRTIO_NET_HDR_GSO_ECN 0x80 // TCP has ECN set |
50c8ea80 | 87 | __u8 gso_type; |
fdd819b2 MT |
88 | __virtio16 hdr_len; /* Ethernet + IP + tcp/udp hdrs */ |
89 | __virtio16 gso_size; /* Bytes to append to hdr_len per frame */ | |
90 | __virtio16 csum_start; /* Position to start checksumming from */ | |
91 | __virtio16 csum_offset; /* Offset after that to place checksum */ | |
296f96fc | 92 | }; |
3f2c31d9 MM |
93 | |
94 | /* This is the version of the header to use when the MRG_RXBUF | |
95 | * feature has been negotiated. */ | |
96 | struct virtio_net_hdr_mrg_rxbuf { | |
97 | struct virtio_net_hdr hdr; | |
fdd819b2 | 98 | __virtio16 num_buffers; /* Number of merged rx buffers */ |
3f2c31d9 MM |
99 | }; |
100 | ||
2a41f71d AW |
101 | /* |
102 | * Control virtqueue data structures | |
103 | * | |
104 | * The control virtqueue expects a header in the first sg entry | |
105 | * and an ack/status response in the last entry. Data for the | |
106 | * command goes in between. | |
107 | */ | |
108 | struct virtio_net_ctrl_hdr { | |
109 | __u8 class; | |
110 | __u8 cmd; | |
111 | } __attribute__((packed)); | |
112 | ||
113 | typedef __u8 virtio_net_ctrl_ack; | |
114 | ||
115 | #define VIRTIO_NET_OK 0 | |
116 | #define VIRTIO_NET_ERR 1 | |
117 | ||
2af7698e | 118 | /* |
e79f07e2 AW |
119 | * Control the RX mode, ie. promisucous, allmulti, etc... |
120 | * All commands require an "out" sg entry containing a 1 byte | |
121 | * state value, zero = disable, non-zero = enable. Commands | |
122 | * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature. | |
123 | * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA. | |
2af7698e AW |
124 | */ |
125 | #define VIRTIO_NET_CTRL_RX 0 | |
126 | #define VIRTIO_NET_CTRL_RX_PROMISC 0 | |
127 | #define VIRTIO_NET_CTRL_RX_ALLMULTI 1 | |
e79f07e2 AW |
128 | #define VIRTIO_NET_CTRL_RX_ALLUNI 2 |
129 | #define VIRTIO_NET_CTRL_RX_NOMULTI 3 | |
130 | #define VIRTIO_NET_CTRL_RX_NOUNI 4 | |
131 | #define VIRTIO_NET_CTRL_RX_NOBCAST 5 | |
2af7698e | 132 | |
f565a7c2 | 133 | /* |
7e58d5ae | 134 | * Control the MAC |
f565a7c2 AW |
135 | * |
136 | * The MAC filter table is managed by the hypervisor, the guest should | |
137 | * assume the size is infinite. Filtering should be considered | |
138 | * non-perfect, ie. based on hypervisor resources, the guest may | |
139 | * received packets from sources not specified in the filter list. | |
140 | * | |
141 | * In addition to the class/cmd header, the TABLE_SET command requires | |
142 | * two out scatterlists. Each contains a 4 byte count of entries followed | |
143 | * by a concatenated byte stream of the ETH_ALEN MAC addresses. The | |
144 | * first sg list contains unicast addresses, the second is for multicast. | |
145 | * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature | |
146 | * is available. | |
7e58d5ae AK |
147 | * |
148 | * The ADDR_SET command requests one out scatterlist, it contains a | |
149 | * 6 bytes MAC address. This functionality is present if the | |
150 | * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available. | |
f565a7c2 AW |
151 | */ |
152 | struct virtio_net_ctrl_mac { | |
fdd819b2 | 153 | __virtio32 entries; |
f565a7c2 AW |
154 | __u8 macs[][ETH_ALEN]; |
155 | } __attribute__((packed)); | |
156 | ||
157 | #define VIRTIO_NET_CTRL_MAC 1 | |
158 | #define VIRTIO_NET_CTRL_MAC_TABLE_SET 0 | |
7e58d5ae | 159 | #define VIRTIO_NET_CTRL_MAC_ADDR_SET 1 |
f565a7c2 | 160 | |
0bde9569 AW |
161 | /* |
162 | * Control VLAN filtering | |
163 | * | |
164 | * The VLAN filter table is controlled via a simple ADD/DEL interface. | |
165 | * VLAN IDs not added may be filterd by the hypervisor. Del is the | |
166 | * opposite of add. Both commands expect an out entry containing a 2 | |
167 | * byte VLAN ID. VLAN filterting is available with the | |
168 | * VIRTIO_NET_F_CTRL_VLAN feature bit. | |
169 | */ | |
170 | #define VIRTIO_NET_CTRL_VLAN 2 | |
171 | #define VIRTIO_NET_CTRL_VLAN_ADD 0 | |
172 | #define VIRTIO_NET_CTRL_VLAN_DEL 1 | |
173 | ||
586d17c5 JW |
174 | /* |
175 | * Control link announce acknowledgement | |
176 | * | |
177 | * The command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that | |
178 | * driver has recevied the notification; device would clear the | |
179 | * VIRTIO_NET_S_ANNOUNCE bit in the status field after it receives | |
180 | * this command. | |
181 | */ | |
182 | #define VIRTIO_NET_CTRL_ANNOUNCE 3 | |
183 | #define VIRTIO_NET_CTRL_ANNOUNCE_ACK 0 | |
184 | ||
986a4f4d JW |
185 | /* |
186 | * Control Receive Flow Steering | |
187 | * | |
188 | * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET | |
189 | * enables Receive Flow Steering, specifying the number of the transmit and | |
190 | * receive queues that will be used. After the command is consumed and acked by | |
191 | * the device, the device will not steer new packets on receive virtqueues | |
192 | * other than specified nor read from transmit virtqueues other than specified. | |
193 | * Accordingly, driver should not transmit new packets on virtqueues other than | |
194 | * specified. | |
195 | */ | |
196 | struct virtio_net_ctrl_mq { | |
fdd819b2 | 197 | __virtio16 virtqueue_pairs; |
986a4f4d JW |
198 | }; |
199 | ||
200 | #define VIRTIO_NET_CTRL_MQ 4 | |
201 | #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0 | |
202 | #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1 | |
203 | #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 | |
204 | ||
296f96fc | 205 | #endif /* _LINUX_VIRTIO_NET_H */ |