blob: b090d90114ca22e9801cad7ff323cd239f4a1558 [file] [log] [blame]
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -07001/*
2 *
3 * Copyright (c) 2011, Microsoft Corporation.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along with
Jeff Kirsheradf8d3f2013-12-06 06:28:47 -080015 * this program; if not, see <http://www.gnu.org/licenses/>.
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -070016 *
17 * Authors:
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 * K. Y. Srinivasan <kys@microsoft.com>
21 *
22 */
23
24#ifndef _HYPERV_NET_H
25#define _HYPERV_NET_H
26
K. Y. Srinivasan8a079412011-05-12 19:34:42 -070027#include <linux/list.h>
Greg Kroah-Hartman46a97192011-10-04 12:29:52 -070028#include <linux/hyperv.h>
Linus Walleij75911572012-05-11 22:15:50 +000029#include <linux/rndis.h>
K. Y. Srinivasan41308862011-05-12 19:34:38 -070030
Haiyang Zhang5b54dac2014-04-21 10:20:28 -070031/* RSS related */
32#define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203 /* query only */
33#define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204 /* query and set */
34
35#define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88
36#define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89
stephen hemminger23312a32017-01-24 13:05:59 -080037#define NDIS_OBJECT_TYPE_OFFLOAD 0xa7
Haiyang Zhang5b54dac2014-04-21 10:20:28 -070038
39#define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
40#define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
41
42struct ndis_obj_header {
43 u8 type;
44 u8 rev;
45 u16 size;
46} __packed;
47
48/* ndis_recv_scale_cap/cap_flag */
49#define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
50#define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR 0x02000000
51#define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC 0x04000000
52#define NDIS_RSS_CAPS_USING_MSI_X 0x08000000
53#define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS 0x10000000
54#define NDIS_RSS_CAPS_SUPPORTS_MSI_X 0x20000000
55#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4 0x00000100
56#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6 0x00000200
57#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX 0x00000400
58
59struct ndis_recv_scale_cap { /* NDIS_RECEIVE_SCALE_CAPABILITIES */
60 struct ndis_obj_header hdr;
61 u32 cap_flag;
62 u32 num_int_msg;
63 u32 num_recv_que;
64 u16 num_indirect_tabent;
65} __packed;
66
67
68/* ndis_recv_scale_param flags */
69#define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED 0x0001
70#define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED 0x0002
71#define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED 0x0004
72#define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED 0x0008
73#define NDIS_RSS_PARAM_FLAG_DISABLE_RSS 0x0010
74
75/* Hash info bits */
76#define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
77#define NDIS_HASH_IPV4 0x00000100
78#define NDIS_HASH_TCP_IPV4 0x00000200
79#define NDIS_HASH_IPV6 0x00000400
80#define NDIS_HASH_IPV6_EX 0x00000800
81#define NDIS_HASH_TCP_IPV6 0x00001000
82#define NDIS_HASH_TCP_IPV6_EX 0x00002000
83
84#define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
85#define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2 40
86
87#define ITAB_NUM 128
Haiyang Zhang5b54dac2014-04-21 10:20:28 -070088
89struct ndis_recv_scale_param { /* NDIS_RECEIVE_SCALE_PARAMETERS */
90 struct ndis_obj_header hdr;
91
92 /* Qualifies the rest of the information */
93 u16 flag;
94
95 /* The base CPU number to do receive processing. not used */
96 u16 base_cpu_number;
97
98 /* This describes the hash function and type being enabled */
99 u32 hashinfo;
100
101 /* The size of indirection table array */
102 u16 indirect_tabsize;
103
104 /* The offset of the indirection table from the beginning of this
105 * structure
106 */
107 u32 indirect_taboffset;
108
109 /* The size of the hash secret key */
110 u16 hashkey_size;
111
112 /* The offset of the secret key from the beginning of this structure */
113 u32 kashkey_offset;
114
115 u32 processor_masks_offset;
116 u32 num_processor_masks;
117 u32 processor_masks_entry_size;
118};
119
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700120/* Fwd declaration */
KY Srinivasane3d605e2014-03-08 19:23:16 -0800121struct ndis_tcp_ip_checksum_info;
stephen hemmingerdc54a082017-01-24 13:06:08 -0800122struct ndis_pkt_8021q_info;
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700123
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700124/*
125 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
126 * within the RNDIS
KY Srinivasanc0eb4542015-12-01 16:43:10 -0800127 *
128 * The size of this structure is less than 48 bytes and we can now
129 * place this structure in the skb->cb field.
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700130 */
131struct hv_netvsc_packet {
132 /* Bookkeeping stuff */
KY Srinivasan22e9dd22015-12-01 16:43:03 -0800133 u8 cp_partial; /* partial copy into send buffer */
Haiyang Zhangaa0a34b2015-04-13 16:34:35 -0700134
KY Srinivasan934d2022015-12-01 16:43:04 -0800135 u8 rmsg_size; /* RNDIS header and PPI size */
136 u8 rmsg_pgcnt; /* page count of RNDIS header and PPI */
137 u8 page_buf_cnt;
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700138
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700139 u16 q_idx;
stephen hemminger793e3952017-01-24 13:06:12 -0800140 u16 total_packets;
KY Srinivasan934d2022015-12-01 16:43:04 -0800141
stephen hemminger793e3952017-01-24 13:06:12 -0800142 u32 total_bytes;
143 u32 send_buf_index;
KY Srinivasan934d2022015-12-01 16:43:04 -0800144 u32 total_data_buflen;
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700145};
146
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700147struct netvsc_device_info {
Jianjun Kong9a4c8312013-01-18 16:52:09 +0000148 unsigned char mac_adr[ETH_ALEN];
Andrew Schwartzmeyer8ebdcc52015-08-11 17:14:31 -0700149 u32 num_chn;
stephen hemminger8b532792017-08-09 17:46:11 -0700150 u32 send_sections;
151 u32 recv_sections;
Alex Ng0ab09be2017-09-20 11:17:35 -0700152 u32 send_section_size;
153 u32 recv_section_size;
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700154};
155
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800156enum rndis_device_state {
157 RNDIS_DEV_UNINITIALIZED = 0,
158 RNDIS_DEV_INITIALIZING,
159 RNDIS_DEV_INITIALIZED,
160 RNDIS_DEV_DATAINITIALIZED,
161};
162
stephen hemminger962f3fe2017-01-24 13:06:02 -0800163#define NETVSC_HASH_KEYLEN 40
164
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800165struct rndis_device {
Vitaly Kuznetsov3d541ac2016-05-13 13:55:22 +0200166 struct net_device *ndev;
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800167
168 enum rndis_device_state state;
Haiyang Zhangdedb4592017-06-21 16:40:46 -0700169
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800170 atomic_t new_req_id;
171
172 spinlock_t request_lock;
173 struct list_head req_list;
174
stephen hemminger4f19c0d2017-06-07 15:53:49 -0700175 struct work_struct mcast_work;
176
Haiyang Zhangdedb4592017-06-21 16:40:46 -0700177 bool link_state; /* 0 - link up, 1 - link down */
178
stephen hemminger962f3fe2017-01-24 13:06:02 -0800179 u8 hw_mac_adr[ETH_ALEN];
180 u8 rss_key[NETVSC_HASH_KEYLEN];
Haiyang Zhang473713002017-10-13 12:28:03 -0700181 u16 rx_table[ITAB_NUM];
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800182};
183
184
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700185/* Interface */
KY Srinivasan24476762015-12-01 16:43:06 -0800186struct rndis_message;
Vitaly Kuznetsov2f5fa6c2016-06-03 17:51:00 +0200187struct netvsc_device;
stephen hemminger2a926f72017-07-19 11:53:17 -0700188struct net_device_context;
189
Stephen Hemmingera7f99d02017-12-01 11:01:47 -0800190extern u32 netvsc_ring_bytes;
191extern struct reciprocal_value netvsc_ring_reciprocal;
192
stephen hemminger9749fed2017-07-19 11:53:16 -0700193struct netvsc_device *netvsc_device_add(struct hv_device *device,
194 const struct netvsc_device_info *info);
stephen hemminger7426b1a2017-07-28 08:59:45 -0700195int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
Stephen Hemmingere08f3ea2016-08-23 12:17:50 -0700196void netvsc_device_remove(struct hv_device *device);
stephen hemminger2a926f72017-07-19 11:53:17 -0700197int netvsc_send(struct net_device_context *ndc,
KY Srinivasan24476762015-12-01 16:43:06 -0800198 struct hv_netvsc_packet *packet,
KY Srinivasana9f2e2d2015-12-01 16:43:13 -0800199 struct rndis_message *rndis_msg,
stephen hemminger02b6de02017-07-28 08:59:44 -0700200 struct hv_page_buffer *page_buffer,
KY Srinivasan3a3d9a02015-12-01 16:43:14 -0800201 struct sk_buff *skb);
Stephen Hemminger79cf1ba2017-12-12 16:48:37 -0800202void netvsc_linkstatus_callback(struct net_device *net,
Haiyang Zhang3a494e72014-06-19 18:34:36 -0700203 struct rndis_message *resp);
stephen hemmingerdc54a082017-01-24 13:06:08 -0800204int netvsc_recv_callback(struct net_device *net,
Stephen Hemminger345ac082017-12-12 16:48:38 -0800205 struct netvsc_device *nvdev,
stephen hemmingerdc54a082017-01-24 13:06:08 -0800206 struct vmbus_channel *channel,
207 void *data, u32 len,
208 const struct ndis_tcp_ip_checksum_info *csum_info,
209 const struct ndis_pkt_8021q_info *vlan);
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700210void netvsc_channel_cb(void *context);
stephen hemminger15a863b2017-02-27 10:26:49 -0800211int netvsc_poll(struct napi_struct *napi, int budget);
Stephen Hemminger8195b132017-09-06 13:53:05 -0700212
213void rndis_set_subchannel(struct work_struct *w);
stephen hemmingerea383bf2017-07-19 11:53:15 -0700214bool rndis_filter_opened(const struct netvsc_device *nvdev);
Vitaly Kuznetsov2f5fa6c2016-06-03 17:51:00 +0200215int rndis_filter_open(struct netvsc_device *nvdev);
216int rndis_filter_close(struct netvsc_device *nvdev);
stephen hemminger9749fed2017-07-19 11:53:16 -0700217struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
218 struct netvsc_device_info *info);
stephen hemminger4f19c0d2017-06-07 15:53:49 -0700219void rndis_filter_update(struct netvsc_device *nvdev);
stephen hemminger2289f0a2017-01-24 13:06:10 -0800220void rndis_filter_device_remove(struct hv_device *dev,
221 struct netvsc_device *nvdev);
stephen hemminger962f3fe2017-01-24 13:06:02 -0800222int rndis_filter_set_rss_param(struct rndis_device *rdev,
Haiyang Zhang715e2ec2017-09-01 14:30:04 -0700223 const u8 *key);
stephen hemmingerdc54a082017-01-24 13:06:08 -0800224int rndis_filter_receive(struct net_device *ndev,
225 struct netvsc_device *net_dev,
stephen hemmingerdc54a082017-01-24 13:06:08 -0800226 struct vmbus_channel *channel,
227 void *data, u32 buflen);
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700228
stephen hemminger867047c2017-07-28 08:59:42 -0700229int rndis_filter_set_device_mac(struct netvsc_device *ndev,
230 const char *mac);
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800231
Vitaly Kuznetsov0a1275c2016-05-13 13:55:23 +0200232void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
KY Srinivasan84bf9ce2016-04-14 16:31:54 -0700233
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700234#define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
235
236#define NVSP_PROTOCOL_VERSION_1 2
Haiyang Zhangf157e782011-12-15 13:45:16 -0800237#define NVSP_PROTOCOL_VERSION_2 0x30002
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800238#define NVSP_PROTOCOL_VERSION_4 0x40000
239#define NVSP_PROTOCOL_VERSION_5 0x50000
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700240
241enum {
242 NVSP_MSG_TYPE_NONE = 0,
243
244 /* Init Messages */
245 NVSP_MSG_TYPE_INIT = 1,
246 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
247
248 NVSP_VERSION_MSG_START = 100,
249
250 /* Version 1 Messages */
251 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
252
253 NVSP_MSG1_TYPE_SEND_RECV_BUF,
254 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
255 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
256
257 NVSP_MSG1_TYPE_SEND_SEND_BUF,
258 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
259 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
260
261 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
262 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
263
Haiyang Zhangf157e782011-12-15 13:45:16 -0800264 /* Version 2 messages */
265 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
266 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
267 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
268
269 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
270
271 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
272 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
273
274 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
275
276 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
277 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
278
279 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
280 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
281
282 NVSP_MSG2_TYPE_ALLOC_RXBUF,
283 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
284
285 NVSP_MSG2_TYPE_FREE_RXBUF,
286
287 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
288 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
289
290 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
291
292 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
293 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800294
295 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
296
297 /* Version 4 messages */
298 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
299 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
300 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
301
302 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
303
304 /* Version 5 messages */
305 NVSP_MSG5_TYPE_OID_QUERY_EX,
306 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
307 NVSP_MSG5_TYPE_SUBCHANNEL,
308 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
309
310 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700311};
312
313enum {
314 NVSP_STAT_NONE = 0,
315 NVSP_STAT_SUCCESS,
316 NVSP_STAT_FAIL,
317 NVSP_STAT_PROTOCOL_TOO_NEW,
318 NVSP_STAT_PROTOCOL_TOO_OLD,
319 NVSP_STAT_INVALID_RNDIS_PKT,
320 NVSP_STAT_BUSY,
Haiyang Zhangf157e782011-12-15 13:45:16 -0800321 NVSP_STAT_PROTOCOL_UNSUPPORTED,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700322 NVSP_STAT_MAX,
323};
324
325struct nvsp_message_header {
326 u32 msg_type;
327};
328
329/* Init Messages */
330
331/*
332 * This message is used by the VSC to initialize the channel after the channels
333 * has been opened. This message should never include anything other then
334 * versioning (i.e. this message will be the same for ever).
335 */
336struct nvsp_message_init {
337 u32 min_protocol_ver;
338 u32 max_protocol_ver;
339} __packed;
340
341/*
342 * This message is used by the VSP to complete the initialization of the
343 * channel. This message should never include anything other then versioning
344 * (i.e. this message will be the same for ever).
345 */
346struct nvsp_message_init_complete {
347 u32 negotiated_protocol_ver;
348 u32 max_mdl_chain_len;
349 u32 status;
350} __packed;
351
352union nvsp_message_init_uber {
353 struct nvsp_message_init init;
354 struct nvsp_message_init_complete init_complete;
355} __packed;
356
357/* Version 1 Messages */
358
359/*
360 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
361 * can use this information when handling OIDs sent by the VSC.
362 */
363struct nvsp_1_message_send_ndis_version {
364 u32 ndis_major_ver;
365 u32 ndis_minor_ver;
366} __packed;
367
368/*
369 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
370 * can then use the receive buffer to send data to the VSC.
371 */
372struct nvsp_1_message_send_receive_buffer {
373 u32 gpadl_handle;
374 u16 id;
375} __packed;
376
377struct nvsp_1_receive_buffer_section {
378 u32 offset;
379 u32 sub_alloc_size;
380 u32 num_sub_allocs;
381 u32 end_offset;
382} __packed;
383
384/*
385 * This message is used by the VSP to acknowledge a receive buffer send by the
386 * VSC. This message must be sent by the VSP before the VSP uses the receive
387 * buffer.
388 */
389struct nvsp_1_message_send_receive_buffer_complete {
390 u32 status;
391 u32 num_sections;
392
393 /*
394 * The receive buffer is split into two parts, a large suballocation
395 * section and a small suballocation section. These sections are then
396 * suballocated by a certain size.
397 */
398
399 /*
400 * For example, the following break up of the receive buffer has 6
401 * large suballocations and 10 small suballocations.
402 */
403
404 /*
405 * | Large Section | | Small Section |
406 * ------------------------------------------------------------
407 * | | | | | | | | | | | | | | | | | |
408 * | |
409 * LargeOffset SmallOffset
410 */
411
412 struct nvsp_1_receive_buffer_section sections[1];
413} __packed;
414
415/*
416 * This message is sent by the VSC to revoke the receive buffer. After the VSP
417 * completes this transaction, the vsp should never use the receive buffer
418 * again.
419 */
420struct nvsp_1_message_revoke_receive_buffer {
421 u16 id;
422};
423
424/*
425 * This message is used by the VSC to send a send buffer to the VSP. The VSC
426 * can then use the send buffer to send data to the VSP.
427 */
428struct nvsp_1_message_send_send_buffer {
429 u32 gpadl_handle;
430 u16 id;
431} __packed;
432
433/*
434 * This message is used by the VSP to acknowledge a send buffer sent by the
435 * VSC. This message must be sent by the VSP before the VSP uses the sent
436 * buffer.
437 */
438struct nvsp_1_message_send_send_buffer_complete {
439 u32 status;
440
441 /*
442 * The VSC gets to choose the size of the send buffer and the VSP gets
443 * to choose the sections size of the buffer. This was done to enable
444 * dynamic reconfigurations when the cost of GPA-direct buffers
445 * decreases.
446 */
447 u32 section_size;
448} __packed;
449
450/*
451 * This message is sent by the VSC to revoke the send buffer. After the VSP
452 * completes this transaction, the vsp should never use the send buffer again.
453 */
454struct nvsp_1_message_revoke_send_buffer {
455 u16 id;
456};
457
458/*
459 * This message is used by both the VSP and the VSC to send a RNDIS message to
460 * the opposite channel endpoint.
461 */
462struct nvsp_1_message_send_rndis_packet {
463 /*
Stephen Hemmingerc6a77ff2016-09-23 17:08:17 -0700464 * This field is specified by RNDIS. They assume there's two different
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700465 * channels of communication. However, the Network VSP only has one.
466 * Therefore, the channel travels with the RNDIS packet.
467 */
468 u32 channel_type;
469
470 /*
471 * This field is used to send part or all of the data through a send
472 * buffer. This values specifies an index into the send buffer. If the
473 * index is 0xFFFFFFFF, then the send buffer is not being used and all
474 * of the data was sent through other VMBus mechanisms.
475 */
476 u32 send_buf_section_index;
477 u32 send_buf_section_size;
478} __packed;
479
480/*
481 * This message is used by both the VSP and the VSC to complete a RNDIS message
482 * to the opposite channel endpoint. At this point, the initiator of this
483 * message cannot use any resources associated with the original RNDIS packet.
484 */
485struct nvsp_1_message_send_rndis_packet_complete {
486 u32 status;
487};
488
489union nvsp_1_message_uber {
490 struct nvsp_1_message_send_ndis_version send_ndis_ver;
491
492 struct nvsp_1_message_send_receive_buffer send_recv_buf;
493 struct nvsp_1_message_send_receive_buffer_complete
494 send_recv_buf_complete;
495 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
496
497 struct nvsp_1_message_send_send_buffer send_send_buf;
498 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
499 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
500
501 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
502 struct nvsp_1_message_send_rndis_packet_complete
503 send_rndis_pkt_complete;
504} __packed;
505
Haiyang Zhangf157e782011-12-15 13:45:16 -0800506
507/*
508 * Network VSP protocol version 2 messages:
509 */
510struct nvsp_2_vsc_capability {
511 union {
512 u64 data;
513 struct {
514 u64 vmq:1;
515 u64 chimney:1;
516 u64 sriov:1;
517 u64 ieee8021q:1;
518 u64 correlation_id:1;
Haiyang Zhang7f5d5af2016-08-04 10:42:15 -0700519 u64 teaming:1;
Haiyang Zhangf157e782011-12-15 13:45:16 -0800520 };
521 };
522} __packed;
523
524struct nvsp_2_send_ndis_config {
525 u32 mtu;
526 u32 reserved;
527 struct nvsp_2_vsc_capability capability;
528} __packed;
529
530/* Allocate receive buffer */
531struct nvsp_2_alloc_rxbuf {
532 /* Allocation ID to match the allocation request and response */
533 u32 alloc_id;
534
535 /* Length of the VM shared memory receive buffer that needs to
536 * be allocated
537 */
538 u32 len;
539} __packed;
540
541/* Allocate receive buffer complete */
542struct nvsp_2_alloc_rxbuf_comp {
543 /* The NDIS_STATUS code for buffer allocation */
544 u32 status;
545
546 u32 alloc_id;
547
548 /* GPADL handle for the allocated receive buffer */
549 u32 gpadl_handle;
550
551 /* Receive buffer ID */
552 u64 recv_buf_id;
553} __packed;
554
555struct nvsp_2_free_rxbuf {
556 u64 recv_buf_id;
557} __packed;
558
559union nvsp_2_message_uber {
560 struct nvsp_2_send_ndis_config send_ndis_config;
561 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
562 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
563 struct nvsp_2_free_rxbuf free_rxbuf;
564} __packed;
565
Haiyang Zhang71790a22015-07-24 10:08:40 -0700566struct nvsp_4_send_vf_association {
567 /* 1: allocated, serial number is valid. 0: not allocated */
568 u32 allocated;
569
570 /* Serial number of the VF to team with */
571 u32 serial;
572} __packed;
573
574enum nvsp_vm_datapath {
575 NVSP_DATAPATH_SYNTHETIC = 0,
576 NVSP_DATAPATH_VF,
577 NVSP_DATAPATH_MAX
578};
579
580struct nvsp_4_sw_datapath {
581 u32 active_datapath; /* active data path in VM */
582} __packed;
583
584union nvsp_4_message_uber {
585 struct nvsp_4_send_vf_association vf_assoc;
586 struct nvsp_4_sw_datapath active_dp;
587} __packed;
588
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800589enum nvsp_subchannel_operation {
590 NVSP_SUBCHANNEL_NONE = 0,
591 NVSP_SUBCHANNEL_ALLOCATE,
592 NVSP_SUBCHANNEL_MAX
593};
594
595struct nvsp_5_subchannel_request {
596 u32 op;
597 u32 num_subchannels;
598} __packed;
599
600struct nvsp_5_subchannel_complete {
601 u32 status;
602 u32 num_subchannels; /* Actual number of subchannels allocated */
603} __packed;
604
605struct nvsp_5_send_indirect_table {
606 /* The number of entries in the send indirection table */
607 u32 count;
608
Stephen Hemmingerc6a77ff2016-09-23 17:08:17 -0700609 /* The offset of the send indirection table from top of this struct.
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800610 * The send indirection table tells which channel to put the send
611 * traffic on. Each entry is a channel number.
612 */
613 u32 offset;
614} __packed;
615
616union nvsp_5_message_uber {
617 struct nvsp_5_subchannel_request subchn_req;
618 struct nvsp_5_subchannel_complete subchn_comp;
619 struct nvsp_5_send_indirect_table send_table;
620} __packed;
621
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700622union nvsp_all_messages {
623 union nvsp_message_init_uber init_msg;
624 union nvsp_1_message_uber v1_msg;
Haiyang Zhangf157e782011-12-15 13:45:16 -0800625 union nvsp_2_message_uber v2_msg;
Haiyang Zhang71790a22015-07-24 10:08:40 -0700626 union nvsp_4_message_uber v4_msg;
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800627 union nvsp_5_message_uber v5_msg;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700628} __packed;
629
630/* ALL Messages */
631struct nvsp_message {
632 struct nvsp_message_header hdr;
633 union nvsp_all_messages msg;
634} __packed;
635
636
Jarod Wilsond0c2c992016-10-20 13:55:21 -0400637#define NETVSC_MTU 65535
638#define NETVSC_MTU_MIN ETH_MIN_MTU
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700639
Haiyang Zhang11b2b652017-12-11 08:56:57 -0800640/* Max buffer sizes allowed by a host */
641#define NETVSC_RECEIVE_BUFFER_SIZE (1024 * 1024 * 31) /* 31MB */
642#define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024 * 1024 * 15) /* 15MB */
Haiyang Zhang41f61db2017-12-11 08:56:58 -0800643#define NETVSC_RECEIVE_BUFFER_DEFAULT (1024 * 1024 * 16)
644
645#define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
646#define NETVSC_SEND_BUFFER_DEFAULT (1024 * 1024)
Haiyang Zhang11b2b652017-12-11 08:56:57 -0800647
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700648#define NETVSC_INVALID_INDEX -1
649
stephen hemminger8b532792017-08-09 17:46:11 -0700650#define NETVSC_SEND_SECTION_SIZE 6144
651#define NETVSC_RECV_SECTION_SIZE 1728
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700652
Haiyang Zhang41f61db2017-12-11 08:56:58 -0800653/* Default size of TX buf: 1MB, RX buf: 16MB */
654#define NETVSC_MIN_TX_SECTIONS 10
655#define NETVSC_DEFAULT_TX (NETVSC_SEND_BUFFER_DEFAULT \
656 / NETVSC_SEND_SECTION_SIZE)
657#define NETVSC_MIN_RX_SECTIONS 10
658#define NETVSC_DEFAULT_RX (NETVSC_RECEIVE_BUFFER_DEFAULT \
659 / NETVSC_RECV_SECTION_SIZE)
660
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700661#define NETVSC_RECEIVE_BUFFER_ID 0xcafe
Haiyang Zhangc51ed182014-12-19 18:25:18 -0800662#define NETVSC_SEND_BUFFER_ID 0
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700663
Vitaly Kuznetsovaefd80e2017-11-15 15:12:55 +0100664#define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
665 NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
666 NETIF_F_TSO6)
667
Haiyang Zhang8db91f62017-04-12 11:35:05 -0700668#define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
Haiyang Zhang9efc2f72016-03-23 09:43:10 -0700669#define VRSS_CHANNEL_MAX 64
stephen hemminger2b018882017-01-24 13:06:03 -0800670#define VRSS_CHANNEL_DEFAULT 8
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700671
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700672#define RNDIS_MAX_PKT_DEFAULT 8
673#define RNDIS_PKT_ALIGN_DEFAULT 8
674
675struct multi_send_data {
Haiyang Zhangc85e4922016-01-25 09:49:31 -0800676 struct sk_buff *skb; /* skb containing the pkt */
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700677 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
678 u32 count; /* counter of batched packets */
679};
680
Haiyang Zhangc0b558e2016-08-19 14:47:09 -0700681struct recv_comp_data {
682 u64 tid; /* transaction id */
683 u32 status;
684};
685
Haiyang Zhangc0b558e2016-08-19 14:47:09 -0700686struct multi_recv_comp {
stephen hemminger7426b1a2017-07-28 08:59:45 -0700687 struct recv_comp_data *slots;
688 u32 first; /* first data entry */
689 u32 next; /* next entry for writing */
Haiyang Zhangc0b558e2016-08-19 14:47:09 -0700690};
691
sixiao@microsoft.com7eafd9b2015-05-14 01:00:25 -0700692struct netvsc_stats {
693 u64 packets;
694 u64 bytes;
Stephen Hemmingerf7ad75b2016-09-22 16:56:35 -0700695 u64 broadcast;
696 u64 multicast;
sixiao@microsoft.com4b02b582015-05-15 02:33:03 -0700697 struct u64_stats_sync syncp;
sixiao@microsoft.com7eafd9b2015-05-14 01:00:25 -0700698};
699
Stephen Hemminger4323b472016-08-23 12:17:57 -0700700struct netvsc_ethtool_stats {
701 unsigned long tx_scattered;
702 unsigned long tx_no_memory;
703 unsigned long tx_no_space;
704 unsigned long tx_too_big;
705 unsigned long tx_busy;
stephen hemmingercad5c192017-08-09 17:46:12 -0700706 unsigned long tx_send_full;
707 unsigned long rx_comp_busy;
Stephen Hemmingerf61a9d62017-12-12 16:48:36 -0800708 unsigned long rx_no_memory;
Simon Xiao09af87d2017-09-29 11:39:46 -0700709 unsigned long stop_queue;
710 unsigned long wake_queue;
Stephen Hemminger4323b472016-08-23 12:17:57 -0700711};
712
stephen hemminger0c195562017-08-01 19:58:53 -0700713struct netvsc_vf_pcpu_stats {
714 u64 rx_packets;
715 u64 rx_bytes;
716 u64 tx_packets;
717 u64 tx_bytes;
718 struct u64_stats_sync syncp;
719 u32 tx_dropped;
720};
721
Vitaly Kuznetsov27a70af2015-11-27 11:39:55 +0100722struct netvsc_reconfig {
723 struct list_head list;
724 u32 event;
725};
726
Haiyang Zhang486e3982017-10-06 08:33:57 -0700727/* L4 hash bits for different protocols */
728#define HV_TCP4_L4HASH 1
729#define HV_TCP6_L4HASH 2
730#define HV_UDP4_L4HASH 4
731#define HV_UDP6_L4HASH 8
732#define HV_DEFAULT_L4HASH (HV_TCP4_L4HASH | HV_TCP6_L4HASH | HV_UDP4_L4HASH | \
733 HV_UDP6_L4HASH)
734
Simon Xiao3f300ff2015-04-28 01:05:17 -0700735/* The context of the netvsc device */
736struct net_device_context {
737 /* point back to our device context */
738 struct hv_device *device_ctx;
Vitaly Kuznetsov3d541ac2016-05-13 13:55:22 +0200739 /* netvsc_device */
stephen hemminger545a8e72017-03-22 14:51:00 -0700740 struct netvsc_device __rcu *nvdev;
Vitaly Kuznetsov27a70af2015-11-27 11:39:55 +0100741 /* reconfigure work */
Simon Xiao3f300ff2015-04-28 01:05:17 -0700742 struct delayed_work dwork;
Vitaly Kuznetsov27a70af2015-11-27 11:39:55 +0100743 /* last reconfig time */
744 unsigned long last_reconfig;
745 /* reconfig events */
746 struct list_head reconfig_events;
747 /* list protection */
748 spinlock_t lock;
749
Simon Xiao3f300ff2015-04-28 01:05:17 -0700750 u32 msg_enable; /* debug level */
sixiao@microsoft.com7eafd9b2015-05-14 01:00:25 -0700751
stephen hemminger23312a32017-01-24 13:05:59 -0800752 u32 tx_checksum_mask;
sixiao@microsoft.com49eb9382016-02-25 15:24:08 -0800753
Haiyang Zhang39e91cf2017-10-13 12:28:04 -0700754 u32 tx_table[VRSS_SEND_TAB_SIZE];
stephen hemminger7ce10122017-03-09 14:58:29 -0800755
sixiao@microsoft.com49eb9382016-02-25 15:24:08 -0800756 /* Ethtool settings */
757 u8 duplex;
758 u32 speed;
Haiyang Zhang486e3982017-10-06 08:33:57 -0700759 u32 l4_hash; /* L4 hash settings */
Stephen Hemminger4323b472016-08-23 12:17:57 -0700760 struct netvsc_ethtool_stats eth_stats;
Vitaly Kuznetsovf580aec2016-05-13 13:55:20 +0200761
Vitaly Kuznetsovf9a7da92016-08-15 17:48:39 +0200762 /* State to manage the associated VF interface. */
Stephen Hemmingerf207c102016-09-22 16:56:33 -0700763 struct net_device __rcu *vf_netdev;
stephen hemminger0c195562017-08-01 19:58:53 -0700764 struct netvsc_vf_pcpu_stats __percpu *vf_stats;
stephen hemminger6123c662017-08-09 17:46:03 -0700765 struct delayed_work vf_takeover;
Stephen Hemminger9cbcc422016-09-22 16:56:34 -0700766
Vitaly Kuznetsovf9a7da92016-08-15 17:48:39 +0200767 /* 1: allocated, serial number is valid. 0: not allocated */
768 u32 vf_alloc;
769 /* Serial number of the VF to team with */
770 u32 vf_serial;
Simon Xiao3f300ff2015-04-28 01:05:17 -0700771};
772
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800773/* Per channel data */
774struct netvsc_channel {
775 struct vmbus_channel *channel;
stephen hemminger35fbbcc2017-07-19 11:53:18 -0700776 struct netvsc_device *net_device;
stephen hemmingerf4f1c232017-03-22 14:50:57 -0700777 const struct vmpacket_descriptor *desc;
stephen hemminger15a863b2017-02-27 10:26:49 -0800778 struct napi_struct napi;
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800779 struct multi_send_data msd;
780 struct multi_recv_comp mrc;
781 atomic_t queue_sends;
Simon Xiao6c80f3f2017-01-24 13:06:13 -0800782
783 struct netvsc_stats tx_stats;
784 struct netvsc_stats rx_stats;
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800785};
786
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700787/* Per netvsc device */
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700788struct netvsc_device {
Haiyang Zhangf157e782011-12-15 13:45:16 -0800789 u32 nvsp_version;
790
Haiyang Zhangdc5cd892012-06-04 06:42:38 +0000791 wait_queue_head_t wait_drain;
K. Y. Srinivasanc38b9c72011-08-27 11:31:12 -0700792 bool destroy;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700793
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700794 /* Receive buffer allocated by us but manages by NetVSP */
795 void *recv_buf;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700796 u32 recv_buf_gpadl_handle;
797 u32 recv_section_cnt;
stephen hemminger8b532792017-08-09 17:46:11 -0700798 u32 recv_section_size;
stephen hemminger7426b1a2017-07-28 08:59:45 -0700799 u32 recv_completion_cnt;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700800
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700801 /* Send buffer allocated by us */
802 void *send_buf;
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700803 u32 send_buf_gpadl_handle;
804 u32 send_section_cnt;
805 u32 send_section_size;
806 unsigned long *send_section_map;
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700807
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700808 /* Used for NetVSP initialization protocol */
809 struct completion channel_init_wait;
810 struct nvsp_message channel_init_pkt;
811
812 struct nvsp_message revoke_packet;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700813
Andrew Schwartzmeyer59995372015-02-26 16:27:14 -0800814 u32 max_chn;
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700815 u32 num_chn;
stephen hemminger43c7bd12017-03-22 14:51:02 -0700816
stephen hemminger732e4982017-08-03 17:13:54 -0700817 atomic_t open_chn;
Stephen Hemminger8195b132017-09-06 13:53:05 -0700818 struct work_struct subchan_work;
stephen hemminger732e4982017-08-03 17:13:54 -0700819 wait_queue_head_t subchan_open;
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700820
stephen hemminger2d05b562017-06-08 16:21:20 -0700821 struct rndis_device *extension;
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700822
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700823 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
824 u32 pkt_align; /* alignment bytes, e.g. 8 */
Simon Xiao3f300ff2015-04-28 01:05:17 -0700825
KY Srinivasan84bf9ce2016-04-14 16:31:54 -0700826 atomic_t open_cnt;
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800827
828 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
stephen hemminger545a8e72017-03-22 14:51:00 -0700829
830 struct rcu_head rcu;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700831};
832
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700833/* NdisInitialize message */
834struct rndis_initialize_request {
835 u32 req_id;
836 u32 major_ver;
837 u32 minor_ver;
838 u32 max_xfer_size;
839};
840
841/* Response to NdisInitialize */
842struct rndis_initialize_complete {
843 u32 req_id;
844 u32 status;
845 u32 major_ver;
846 u32 minor_ver;
847 u32 dev_flags;
848 u32 medium;
849 u32 max_pkt_per_msg;
850 u32 max_xfer_size;
851 u32 pkt_alignment_factor;
852 u32 af_list_offset;
853 u32 af_list_size;
854};
855
856/* Call manager devices only: Information about an address family */
857/* supported by the device is appended to the response to NdisInitialize. */
858struct rndis_co_address_family {
859 u32 address_family;
860 u32 major_ver;
861 u32 minor_ver;
862};
863
864/* NdisHalt message */
865struct rndis_halt_request {
866 u32 req_id;
867};
868
869/* NdisQueryRequest message */
870struct rndis_query_request {
871 u32 req_id;
872 u32 oid;
873 u32 info_buflen;
874 u32 info_buf_offset;
875 u32 dev_vc_handle;
876};
877
878/* Response to NdisQueryRequest */
879struct rndis_query_complete {
880 u32 req_id;
881 u32 status;
882 u32 info_buflen;
883 u32 info_buf_offset;
884};
885
886/* NdisSetRequest message */
887struct rndis_set_request {
888 u32 req_id;
889 u32 oid;
890 u32 info_buflen;
891 u32 info_buf_offset;
892 u32 dev_vc_handle;
893};
894
895/* Response to NdisSetRequest */
896struct rndis_set_complete {
897 u32 req_id;
898 u32 status;
899};
900
901/* NdisReset message */
902struct rndis_reset_request {
903 u32 reserved;
904};
905
906/* Response to NdisReset */
907struct rndis_reset_complete {
908 u32 status;
909 u32 addressing_reset;
910};
911
912/* NdisMIndicateStatus message */
913struct rndis_indicate_status {
914 u32 status;
915 u32 status_buflen;
916 u32 status_buf_offset;
917};
918
919/* Diagnostic information passed as the status buffer in */
920/* struct rndis_indicate_status messages signifying error conditions. */
921struct rndis_diagnostic_info {
922 u32 diag_status;
923 u32 error_offset;
924};
925
926/* NdisKeepAlive message */
927struct rndis_keepalive_request {
928 u32 req_id;
929};
930
931/* Response to NdisKeepAlive */
932struct rndis_keepalive_complete {
933 u32 req_id;
934 u32 status;
935};
936
937/*
938 * Data message. All Offset fields contain byte offsets from the beginning of
939 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
940 * to 0 for connectionless data, otherwise it contains the VC handle.
941 */
942struct rndis_packet {
943 u32 data_offset;
944 u32 data_len;
945 u32 oob_data_offset;
946 u32 oob_data_len;
947 u32 num_oob_data_elements;
948 u32 per_pkt_info_offset;
949 u32 per_pkt_info_len;
950 u32 vc_handle;
951 u32 reserved;
952};
953
954/* Optional Out of Band data associated with a Data message. */
955struct rndis_oobd {
956 u32 size;
957 u32 type;
958 u32 class_info_offset;
959};
960
961/* Packet extension field contents associated with a Data message. */
962struct rndis_per_packet_info {
963 u32 size;
964 u32 type;
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000965 u32 ppi_offset;
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700966};
967
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000968enum ndis_per_pkt_info_type {
969 TCPIP_CHKSUM_PKTINFO,
970 IPSEC_PKTINFO,
971 TCP_LARGESEND_PKTINFO,
972 CLASSIFICATION_HANDLE_PKTINFO,
973 NDIS_RESERVED,
974 SG_LIST_PKTINFO,
975 IEEE_8021Q_INFO,
976 ORIGINAL_PKTINFO,
977 PACKET_CANCEL_ID,
Haiyang Zhang307f0992014-05-21 12:55:39 -0700978 NBL_HASH_VALUE = PACKET_CANCEL_ID,
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000979 ORIGINAL_NET_BUFLIST,
980 CACHED_NET_BUFLIST,
981 SHORT_PKT_PADINFO,
982 MAX_PER_PKT_INFO
983};
984
985struct ndis_pkt_8021q_info {
986 union {
987 struct {
988 u32 pri:3; /* User Priority */
989 u32 cfi:1; /* Canonical Format ID */
990 u32 vlanid:12; /* VLAN ID */
991 u32 reserved:16;
992 };
993 u32 value;
994 };
995};
996
stephen hemminger23312a32017-01-24 13:05:59 -0800997struct ndis_object_header {
KY Srinivasan4a0e70a2014-03-08 19:23:15 -0800998 u8 type;
999 u8 revision;
1000 u16 size;
1001};
1002
1003#define NDIS_OBJECT_TYPE_DEFAULT 0x80
1004#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
stephen hemminger23312a32017-01-24 13:05:59 -08001005#define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
1006#define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
1007
KY Srinivasan4a0e70a2014-03-08 19:23:15 -08001008#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
1009#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
1010#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
1011#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
1012#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
1013#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1014#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1015#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1016#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1017#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1018
KY Srinivasan77bf5482014-03-08 19:23:18 -08001019#define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
1020#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
1021#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
1022
KY Srinivasanaf9893a2014-04-09 15:00:47 -07001023#define VERSION_4_OFFLOAD_SIZE 22
KY Srinivasan4a0e70a2014-03-08 19:23:15 -08001024/*
1025 * New offload OIDs for NDIS 6
1026 */
1027#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1028#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1029#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1030#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1031#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1032#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1033
stephen hemminger23312a32017-01-24 13:05:59 -08001034/*
1035 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1036 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1037 */
1038
1039#define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1040#define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1041#define NDIS_OFFLOAD_ENCAP_8023 0x0002
1042#define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1043#define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1044#define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1045
1046struct ndis_csum_offload {
1047 u32 ip4_txenc;
1048 u32 ip4_txcsum;
1049#define NDIS_TXCSUM_CAP_IP4OPT 0x001
1050#define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1051#define NDIS_TXCSUM_CAP_TCP4 0x010
1052#define NDIS_TXCSUM_CAP_UDP4 0x040
1053#define NDIS_TXCSUM_CAP_IP4 0x100
1054
1055#define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1056
1057 u32 ip4_rxenc;
1058 u32 ip4_rxcsum;
1059#define NDIS_RXCSUM_CAP_IP4OPT 0x001
1060#define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1061#define NDIS_RXCSUM_CAP_TCP4 0x010
1062#define NDIS_RXCSUM_CAP_UDP4 0x040
1063#define NDIS_RXCSUM_CAP_IP4 0x100
1064 u32 ip6_txenc;
1065 u32 ip6_txcsum;
1066#define NDIS_TXCSUM_CAP_IP6EXT 0x001
1067#define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1068#define NDIS_TXCSUM_CAP_TCP6 0x010
1069#define NDIS_TXCSUM_CAP_UDP6 0x040
1070 u32 ip6_rxenc;
1071 u32 ip6_rxcsum;
1072#define NDIS_RXCSUM_CAP_IP6EXT 0x001
1073#define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1074#define NDIS_RXCSUM_CAP_TCP6 0x010
1075#define NDIS_RXCSUM_CAP_UDP6 0x040
1076
1077#define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1078 NDIS_TXCSUM_CAP_TCP6OPT | \
1079 NDIS_TXCSUM_CAP_IP6EXT)
1080};
1081
1082struct ndis_lsov1_offload {
1083 u32 encap;
1084 u32 maxsize;
1085 u32 minsegs;
1086 u32 opts;
1087};
1088
1089struct ndis_ipsecv1_offload {
1090 u32 encap;
1091 u32 ah_esp;
1092 u32 xport_tun;
1093 u32 ip4_opts;
1094 u32 flags;
1095 u32 ip4_ah;
1096 u32 ip4_esp;
1097};
1098
1099struct ndis_lsov2_offload {
1100 u32 ip4_encap;
1101 u32 ip4_maxsz;
1102 u32 ip4_minsg;
1103 u32 ip6_encap;
1104 u32 ip6_maxsz;
1105 u32 ip6_minsg;
1106 u32 ip6_opts;
1107#define NDIS_LSOV2_CAP_IP6EXT 0x001
1108#define NDIS_LSOV2_CAP_TCP6OPT 0x004
1109
1110#define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1111 NDIS_LSOV2_CAP_TCP6OPT)
1112};
1113
1114struct ndis_ipsecv2_offload {
1115 u32 encap;
1116 u16 ip6;
1117 u16 ip4opt;
1118 u16 ip6ext;
1119 u16 ah;
1120 u16 esp;
1121 u16 ah_esp;
1122 u16 xport;
1123 u16 tun;
1124 u16 xport_tun;
1125 u16 lso;
1126 u16 extseq;
1127 u32 udp_esp;
1128 u32 auth;
1129 u32 crypto;
1130 u32 sa_caps;
1131};
1132
1133struct ndis_rsc_offload {
1134 u16 ip4;
1135 u16 ip6;
1136};
1137
1138struct ndis_encap_offload {
1139 u32 flags;
1140 u32 maxhdr;
1141};
1142
1143struct ndis_offload {
1144 struct ndis_object_header header;
1145 struct ndis_csum_offload csum;
1146 struct ndis_lsov1_offload lsov1;
1147 struct ndis_ipsecv1_offload ipsecv1;
1148 struct ndis_lsov2_offload lsov2;
1149 u32 flags;
1150 /* NDIS >= 6.1 */
1151 struct ndis_ipsecv2_offload ipsecv2;
1152 /* NDIS >= 6.30 */
1153 struct ndis_rsc_offload rsc;
1154 struct ndis_encap_offload encap_gre;
1155};
1156
1157#define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1158#define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1159#define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1160
KY Srinivasan4a0e70a2014-03-08 19:23:15 -08001161struct ndis_offload_params {
stephen hemminger23312a32017-01-24 13:05:59 -08001162 struct ndis_object_header header;
KY Srinivasan4a0e70a2014-03-08 19:23:15 -08001163 u8 ip_v4_csum;
1164 u8 tcp_ip_v4_csum;
1165 u8 udp_ip_v4_csum;
1166 u8 tcp_ip_v6_csum;
1167 u8 udp_ip_v6_csum;
1168 u8 lso_v1;
1169 u8 ip_sec_v1;
1170 u8 lso_v2_ipv4;
1171 u8 lso_v2_ipv6;
1172 u8 tcp_connection_ip_v4;
1173 u8 tcp_connection_ip_v6;
1174 u32 flags;
1175 u8 ip_sec_v2;
1176 u8 ip_sec_v2_ip_v4;
1177 struct {
1178 u8 rsc_ip_v4;
1179 u8 rsc_ip_v6;
1180 };
1181 struct {
1182 u8 encapsulated_packet_task_offload;
1183 u8 encapsulation_types;
1184 };
1185};
1186
KY Srinivasane3d605e2014-03-08 19:23:16 -08001187struct ndis_tcp_ip_checksum_info {
1188 union {
1189 struct {
1190 u32 is_ipv4:1;
1191 u32 is_ipv6:1;
1192 u32 tcp_checksum:1;
1193 u32 udp_checksum:1;
1194 u32 ip_header_checksum:1;
1195 u32 reserved:11;
1196 u32 tcp_header_offset:10;
1197 } transmit;
1198 struct {
1199 u32 tcp_checksum_failed:1;
1200 u32 udp_checksum_failed:1;
1201 u32 ip_checksum_failed:1;
1202 u32 tcp_checksum_succeeded:1;
1203 u32 udp_checksum_succeeded:1;
1204 u32 ip_checksum_succeeded:1;
1205 u32 loopback:1;
1206 u32 tcp_checksum_value_invalid:1;
1207 u32 ip_checksum_value_invalid:1;
1208 } receive;
1209 u32 value;
1210 };
1211};
1212
KY Srinivasan77bf5482014-03-08 19:23:18 -08001213struct ndis_tcp_lso_info {
1214 union {
1215 struct {
1216 u32 unused:30;
1217 u32 type:1;
1218 u32 reserved2:1;
1219 } transmit;
1220 struct {
1221 u32 mss:20;
1222 u32 tcp_header_offset:10;
1223 u32 type:1;
1224 u32 reserved2:1;
1225 } lso_v1_transmit;
1226 struct {
1227 u32 tcp_payload:30;
1228 u32 type:1;
1229 u32 reserved2:1;
1230 } lso_v1_transmit_complete;
1231 struct {
1232 u32 mss:20;
1233 u32 tcp_header_offset:10;
1234 u32 type:1;
1235 u32 ip_version:1;
1236 } lso_v2_transmit;
1237 struct {
1238 u32 reserved:30;
1239 u32 type:1;
1240 u32 reserved2:1;
1241 } lso_v2_transmit_complete;
1242 u32 value;
1243 };
1244};
1245
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +00001246#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1247 sizeof(struct ndis_pkt_8021q_info))
1248
KY Srinivasane3d605e2014-03-08 19:23:16 -08001249#define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1250 sizeof(struct ndis_tcp_ip_checksum_info))
1251
KY Srinivasan77bf5482014-03-08 19:23:18 -08001252#define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1253 sizeof(struct ndis_tcp_lso_info))
1254
Haiyang Zhang307f0992014-05-21 12:55:39 -07001255#define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1256 sizeof(u32))
1257
Haiyang Zhang72151422015-04-06 15:22:53 -07001258/* Total size of all PPI data */
1259#define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1260 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1261
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -07001262/* Format of Information buffer passed in a SetRequest for the OID */
1263/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1264struct rndis_config_parameter_info {
1265 u32 parameter_name_offset;
1266 u32 parameter_name_length;
1267 u32 parameter_type;
1268 u32 parameter_value_offset;
1269 u32 parameter_value_length;
1270};
1271
1272/* Values for ParameterType in struct rndis_config_parameter_info */
1273#define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1274#define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1275
1276/* CONDIS Miniport messages for connection oriented devices */
1277/* that do not implement a call manager. */
1278
1279/* CoNdisMiniportCreateVc message */
1280struct rcondis_mp_create_vc {
1281 u32 req_id;
1282 u32 ndis_vc_handle;
1283};
1284
1285/* Response to CoNdisMiniportCreateVc */
1286struct rcondis_mp_create_vc_complete {
1287 u32 req_id;
1288 u32 dev_vc_handle;
1289 u32 status;
1290};
1291
1292/* CoNdisMiniportDeleteVc message */
1293struct rcondis_mp_delete_vc {
1294 u32 req_id;
1295 u32 dev_vc_handle;
1296};
1297
1298/* Response to CoNdisMiniportDeleteVc */
1299struct rcondis_mp_delete_vc_complete {
1300 u32 req_id;
1301 u32 status;
1302};
1303
1304/* CoNdisMiniportQueryRequest message */
1305struct rcondis_mp_query_request {
1306 u32 req_id;
1307 u32 request_type;
1308 u32 oid;
1309 u32 dev_vc_handle;
1310 u32 info_buflen;
1311 u32 info_buf_offset;
1312};
1313
1314/* CoNdisMiniportSetRequest message */
1315struct rcondis_mp_set_request {
1316 u32 req_id;
1317 u32 request_type;
1318 u32 oid;
1319 u32 dev_vc_handle;
1320 u32 info_buflen;
1321 u32 info_buf_offset;
1322};
1323
1324/* CoNdisIndicateStatus message */
1325struct rcondis_indicate_status {
1326 u32 ndis_vc_handle;
1327 u32 status;
1328 u32 status_buflen;
1329 u32 status_buf_offset;
1330};
1331
1332/* CONDIS Call/VC parameters */
1333struct rcondis_specific_parameters {
1334 u32 parameter_type;
1335 u32 parameter_length;
1336 u32 parameter_lffset;
1337};
1338
1339struct rcondis_media_parameters {
1340 u32 flags;
1341 u32 reserved1;
1342 u32 reserved2;
1343 struct rcondis_specific_parameters media_specific;
1344};
1345
1346struct rndis_flowspec {
1347 u32 token_rate;
1348 u32 token_bucket_size;
1349 u32 peak_bandwidth;
1350 u32 latency;
1351 u32 delay_variation;
1352 u32 service_type;
1353 u32 max_sdu_size;
1354 u32 minimum_policed_size;
1355};
1356
1357struct rcondis_call_manager_parameters {
1358 struct rndis_flowspec transmit;
1359 struct rndis_flowspec receive;
1360 struct rcondis_specific_parameters call_mgr_specific;
1361};
1362
1363/* CoNdisMiniportActivateVc message */
1364struct rcondis_mp_activate_vc_request {
1365 u32 req_id;
1366 u32 flags;
1367 u32 dev_vc_handle;
1368 u32 media_params_offset;
1369 u32 media_params_length;
1370 u32 call_mgr_params_offset;
1371 u32 call_mgr_params_length;
1372};
1373
1374/* Response to CoNdisMiniportActivateVc */
1375struct rcondis_mp_activate_vc_complete {
1376 u32 req_id;
1377 u32 status;
1378};
1379
1380/* CoNdisMiniportDeactivateVc message */
1381struct rcondis_mp_deactivate_vc_request {
1382 u32 req_id;
1383 u32 flags;
1384 u32 dev_vc_handle;
1385};
1386
1387/* Response to CoNdisMiniportDeactivateVc */
1388struct rcondis_mp_deactivate_vc_complete {
1389 u32 req_id;
1390 u32 status;
1391};
1392
1393
1394/* union with all of the RNDIS messages */
1395union rndis_message_container {
1396 struct rndis_packet pkt;
1397 struct rndis_initialize_request init_req;
1398 struct rndis_halt_request halt_req;
1399 struct rndis_query_request query_req;
1400 struct rndis_set_request set_req;
1401 struct rndis_reset_request reset_req;
1402 struct rndis_keepalive_request keep_alive_req;
1403 struct rndis_indicate_status indicate_status;
1404 struct rndis_initialize_complete init_complete;
1405 struct rndis_query_complete query_complete;
1406 struct rndis_set_complete set_complete;
1407 struct rndis_reset_complete reset_complete;
1408 struct rndis_keepalive_complete keep_alive_complete;
1409 struct rcondis_mp_create_vc co_miniport_create_vc;
1410 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1411 struct rcondis_indicate_status co_indicate_status;
1412 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1413 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1414 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1415 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1416 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1417 struct rcondis_mp_deactivate_vc_complete
1418 co_miniport_deactivate_vc_complete;
1419};
1420
1421/* Remote NDIS message format */
1422struct rndis_message {
1423 u32 ndis_msg_type;
1424
1425 /* Total length of this message, from the beginning */
Stephen Hemmingerc6a77ff2016-09-23 17:08:17 -07001426 /* of the struct rndis_message, in bytes. */
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -07001427 u32 msg_len;
1428
1429 /* Actual message */
1430 union rndis_message_container msg;
1431};
1432
K. Y. Srinivasan9dbfd152011-05-12 19:35:00 -07001433
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -07001434/* Handy macros */
1435
1436/* get the size of an RNDIS message. Pass in the message type, */
1437/* struct rndis_set_request, struct rndis_packet for example */
1438#define RNDIS_MESSAGE_SIZE(msg) \
1439 (sizeof(msg) + (sizeof(struct rndis_message) - \
1440 sizeof(union rndis_message_container)))
1441
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001442#define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1443 sizeof(union rndis_message_container))
1444
Haiyang Zhang72151422015-04-06 15:22:53 -07001445#define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1446
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001447#define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1448#define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1449#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1450#define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1451#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1452#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1453#define NDIS_PACKET_TYPE_SMT 0x00000040
1454#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1455#define NDIS_PACKET_TYPE_GROUP 0x00000100
1456#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1457#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1458#define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1459
KY Srinivasan08cd04b2014-03-08 19:23:17 -08001460#define TRANSPORT_INFO_NOT_IP 0
stephen hemminger23312a32017-01-24 13:05:59 -08001461#define TRANSPORT_INFO_IPV4_TCP 0x01
1462#define TRANSPORT_INFO_IPV4_UDP 0x02
1463#define TRANSPORT_INFO_IPV6_TCP 0x10
1464#define TRANSPORT_INFO_IPV6_UDP 0x20
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001465
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -07001466#endif /* _HYPERV_NET_H */