blob: 6f550e15a41ccfb8af74e8f975e2d07aeb88f865 [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];
K. Y. Srinivasan78001df2011-05-12 19:35:04 -0700149 int ring_size;
Andrew Schwartzmeyer8ebdcc52015-08-11 17:14:31 -0700150 u32 num_chn;
stephen hemminger8b532792017-08-09 17:46:11 -0700151 u32 send_sections;
152 u32 recv_sections;
Alex Ng0ab09be2017-09-20 11:17:35 -0700153 u32 send_section_size;
154 u32 recv_section_size;
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700155};
156
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800157enum rndis_device_state {
158 RNDIS_DEV_UNINITIALIZED = 0,
159 RNDIS_DEV_INITIALIZING,
160 RNDIS_DEV_INITIALIZED,
161 RNDIS_DEV_DATAINITIALIZED,
162};
163
stephen hemminger962f3fe2017-01-24 13:06:02 -0800164#define NETVSC_HASH_KEYLEN 40
165
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800166struct rndis_device {
Vitaly Kuznetsov3d541ac2016-05-13 13:55:22 +0200167 struct net_device *ndev;
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800168
169 enum rndis_device_state state;
Haiyang Zhangdedb4592017-06-21 16:40:46 -0700170
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800171 atomic_t new_req_id;
172
173 spinlock_t request_lock;
174 struct list_head req_list;
175
stephen hemminger4f19c0d2017-06-07 15:53:49 -0700176 struct work_struct mcast_work;
177
Haiyang Zhangdedb4592017-06-21 16:40:46 -0700178 bool link_state; /* 0 - link up, 1 - link down */
179
stephen hemminger962f3fe2017-01-24 13:06:02 -0800180 u8 hw_mac_adr[ETH_ALEN];
181 u8 rss_key[NETVSC_HASH_KEYLEN];
stephen hemmingerff4a4412017-01-24 13:06:04 -0800182 u16 ind_table[ITAB_NUM];
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800183};
184
185
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700186/* Interface */
KY Srinivasan24476762015-12-01 16:43:06 -0800187struct rndis_message;
Vitaly Kuznetsov2f5fa6c2016-06-03 17:51:00 +0200188struct netvsc_device;
stephen hemminger2a926f72017-07-19 11:53:17 -0700189struct net_device_context;
190
stephen hemminger9749fed2017-07-19 11:53:16 -0700191struct netvsc_device *netvsc_device_add(struct hv_device *device,
192 const struct netvsc_device_info *info);
stephen hemminger7426b1a2017-07-28 08:59:45 -0700193int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
Stephen Hemmingere08f3ea2016-08-23 12:17:50 -0700194void netvsc_device_remove(struct hv_device *device);
stephen hemminger2a926f72017-07-19 11:53:17 -0700195int netvsc_send(struct net_device_context *ndc,
KY Srinivasan24476762015-12-01 16:43:06 -0800196 struct hv_netvsc_packet *packet,
KY Srinivasana9f2e2d2015-12-01 16:43:13 -0800197 struct rndis_message *rndis_msg,
stephen hemminger02b6de02017-07-28 08:59:44 -0700198 struct hv_page_buffer *page_buffer,
KY Srinivasan3a3d9a02015-12-01 16:43:14 -0800199 struct sk_buff *skb);
K. Y. Srinivasan90ef1172011-05-12 19:34:50 -0700200void netvsc_linkstatus_callback(struct hv_device *device_obj,
Haiyang Zhang3a494e72014-06-19 18:34:36 -0700201 struct rndis_message *resp);
stephen hemmingerdc54a082017-01-24 13:06:08 -0800202int netvsc_recv_callback(struct net_device *net,
203 struct vmbus_channel *channel,
204 void *data, u32 len,
205 const struct ndis_tcp_ip_checksum_info *csum_info,
206 const struct ndis_pkt_8021q_info *vlan);
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700207void netvsc_channel_cb(void *context);
stephen hemminger15a863b2017-02-27 10:26:49 -0800208int netvsc_poll(struct napi_struct *napi, int budget);
Stephen Hemminger8195b132017-09-06 13:53:05 -0700209
210void rndis_set_subchannel(struct work_struct *w);
stephen hemmingerea383bf2017-07-19 11:53:15 -0700211bool rndis_filter_opened(const struct netvsc_device *nvdev);
Vitaly Kuznetsov2f5fa6c2016-06-03 17:51:00 +0200212int rndis_filter_open(struct netvsc_device *nvdev);
213int rndis_filter_close(struct netvsc_device *nvdev);
stephen hemminger9749fed2017-07-19 11:53:16 -0700214struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
215 struct netvsc_device_info *info);
stephen hemminger4f19c0d2017-06-07 15:53:49 -0700216void rndis_filter_update(struct netvsc_device *nvdev);
stephen hemminger2289f0a2017-01-24 13:06:10 -0800217void rndis_filter_device_remove(struct hv_device *dev,
218 struct netvsc_device *nvdev);
stephen hemminger962f3fe2017-01-24 13:06:02 -0800219int rndis_filter_set_rss_param(struct rndis_device *rdev,
Haiyang Zhang715e2ec2017-09-01 14:30:04 -0700220 const u8 *key);
stephen hemmingerdc54a082017-01-24 13:06:08 -0800221int rndis_filter_receive(struct net_device *ndev,
222 struct netvsc_device *net_dev,
223 struct hv_device *dev,
224 struct vmbus_channel *channel,
225 void *data, u32 buflen);
K. Y. Srinivasan41308862011-05-12 19:34:38 -0700226
stephen hemminger867047c2017-07-28 08:59:42 -0700227int rndis_filter_set_device_mac(struct netvsc_device *ndev,
228 const char *mac);
Haiyang Zhangd426b2e2011-11-30 07:19:08 -0800229
Vitaly Kuznetsov0a1275c2016-05-13 13:55:23 +0200230void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
KY Srinivasan84bf9ce2016-04-14 16:31:54 -0700231
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700232#define NVSP_INVALID_PROTOCOL_VERSION ((u32)0xFFFFFFFF)
233
234#define NVSP_PROTOCOL_VERSION_1 2
Haiyang Zhangf157e782011-12-15 13:45:16 -0800235#define NVSP_PROTOCOL_VERSION_2 0x30002
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800236#define NVSP_PROTOCOL_VERSION_4 0x40000
237#define NVSP_PROTOCOL_VERSION_5 0x50000
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700238
239enum {
240 NVSP_MSG_TYPE_NONE = 0,
241
242 /* Init Messages */
243 NVSP_MSG_TYPE_INIT = 1,
244 NVSP_MSG_TYPE_INIT_COMPLETE = 2,
245
246 NVSP_VERSION_MSG_START = 100,
247
248 /* Version 1 Messages */
249 NVSP_MSG1_TYPE_SEND_NDIS_VER = NVSP_VERSION_MSG_START,
250
251 NVSP_MSG1_TYPE_SEND_RECV_BUF,
252 NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
253 NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
254
255 NVSP_MSG1_TYPE_SEND_SEND_BUF,
256 NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
257 NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
258
259 NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
260 NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
261
Haiyang Zhangf157e782011-12-15 13:45:16 -0800262 /* Version 2 messages */
263 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
264 NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
265 NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
266
267 NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
268
269 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
270 NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
271
272 NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
273
274 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
275 NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
276
277 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
278 NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
279
280 NVSP_MSG2_TYPE_ALLOC_RXBUF,
281 NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
282
283 NVSP_MSG2_TYPE_FREE_RXBUF,
284
285 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
286 NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
287
288 NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
289
290 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
291 NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800292
293 NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
294
295 /* Version 4 messages */
296 NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
297 NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
298 NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
299
300 NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
301
302 /* Version 5 messages */
303 NVSP_MSG5_TYPE_OID_QUERY_EX,
304 NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
305 NVSP_MSG5_TYPE_SUBCHANNEL,
306 NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
307
308 NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700309};
310
311enum {
312 NVSP_STAT_NONE = 0,
313 NVSP_STAT_SUCCESS,
314 NVSP_STAT_FAIL,
315 NVSP_STAT_PROTOCOL_TOO_NEW,
316 NVSP_STAT_PROTOCOL_TOO_OLD,
317 NVSP_STAT_INVALID_RNDIS_PKT,
318 NVSP_STAT_BUSY,
Haiyang Zhangf157e782011-12-15 13:45:16 -0800319 NVSP_STAT_PROTOCOL_UNSUPPORTED,
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700320 NVSP_STAT_MAX,
321};
322
323struct nvsp_message_header {
324 u32 msg_type;
325};
326
327/* Init Messages */
328
329/*
330 * This message is used by the VSC to initialize the channel after the channels
331 * has been opened. This message should never include anything other then
332 * versioning (i.e. this message will be the same for ever).
333 */
334struct nvsp_message_init {
335 u32 min_protocol_ver;
336 u32 max_protocol_ver;
337} __packed;
338
339/*
340 * This message is used by the VSP to complete the initialization of the
341 * channel. This message should never include anything other then versioning
342 * (i.e. this message will be the same for ever).
343 */
344struct nvsp_message_init_complete {
345 u32 negotiated_protocol_ver;
346 u32 max_mdl_chain_len;
347 u32 status;
348} __packed;
349
350union nvsp_message_init_uber {
351 struct nvsp_message_init init;
352 struct nvsp_message_init_complete init_complete;
353} __packed;
354
355/* Version 1 Messages */
356
357/*
358 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
359 * can use this information when handling OIDs sent by the VSC.
360 */
361struct nvsp_1_message_send_ndis_version {
362 u32 ndis_major_ver;
363 u32 ndis_minor_ver;
364} __packed;
365
366/*
367 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
368 * can then use the receive buffer to send data to the VSC.
369 */
370struct nvsp_1_message_send_receive_buffer {
371 u32 gpadl_handle;
372 u16 id;
373} __packed;
374
375struct nvsp_1_receive_buffer_section {
376 u32 offset;
377 u32 sub_alloc_size;
378 u32 num_sub_allocs;
379 u32 end_offset;
380} __packed;
381
382/*
383 * This message is used by the VSP to acknowledge a receive buffer send by the
384 * VSC. This message must be sent by the VSP before the VSP uses the receive
385 * buffer.
386 */
387struct nvsp_1_message_send_receive_buffer_complete {
388 u32 status;
389 u32 num_sections;
390
391 /*
392 * The receive buffer is split into two parts, a large suballocation
393 * section and a small suballocation section. These sections are then
394 * suballocated by a certain size.
395 */
396
397 /*
398 * For example, the following break up of the receive buffer has 6
399 * large suballocations and 10 small suballocations.
400 */
401
402 /*
403 * | Large Section | | Small Section |
404 * ------------------------------------------------------------
405 * | | | | | | | | | | | | | | | | | |
406 * | |
407 * LargeOffset SmallOffset
408 */
409
410 struct nvsp_1_receive_buffer_section sections[1];
411} __packed;
412
413/*
414 * This message is sent by the VSC to revoke the receive buffer. After the VSP
415 * completes this transaction, the vsp should never use the receive buffer
416 * again.
417 */
418struct nvsp_1_message_revoke_receive_buffer {
419 u16 id;
420};
421
422/*
423 * This message is used by the VSC to send a send buffer to the VSP. The VSC
424 * can then use the send buffer to send data to the VSP.
425 */
426struct nvsp_1_message_send_send_buffer {
427 u32 gpadl_handle;
428 u16 id;
429} __packed;
430
431/*
432 * This message is used by the VSP to acknowledge a send buffer sent by the
433 * VSC. This message must be sent by the VSP before the VSP uses the sent
434 * buffer.
435 */
436struct nvsp_1_message_send_send_buffer_complete {
437 u32 status;
438
439 /*
440 * The VSC gets to choose the size of the send buffer and the VSP gets
441 * to choose the sections size of the buffer. This was done to enable
442 * dynamic reconfigurations when the cost of GPA-direct buffers
443 * decreases.
444 */
445 u32 section_size;
446} __packed;
447
448/*
449 * This message is sent by the VSC to revoke the send buffer. After the VSP
450 * completes this transaction, the vsp should never use the send buffer again.
451 */
452struct nvsp_1_message_revoke_send_buffer {
453 u16 id;
454};
455
456/*
457 * This message is used by both the VSP and the VSC to send a RNDIS message to
458 * the opposite channel endpoint.
459 */
460struct nvsp_1_message_send_rndis_packet {
461 /*
Stephen Hemmingerc6a77ff2016-09-23 17:08:17 -0700462 * This field is specified by RNDIS. They assume there's two different
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700463 * channels of communication. However, the Network VSP only has one.
464 * Therefore, the channel travels with the RNDIS packet.
465 */
466 u32 channel_type;
467
468 /*
469 * This field is used to send part or all of the data through a send
470 * buffer. This values specifies an index into the send buffer. If the
471 * index is 0xFFFFFFFF, then the send buffer is not being used and all
472 * of the data was sent through other VMBus mechanisms.
473 */
474 u32 send_buf_section_index;
475 u32 send_buf_section_size;
476} __packed;
477
478/*
479 * This message is used by both the VSP and the VSC to complete a RNDIS message
480 * to the opposite channel endpoint. At this point, the initiator of this
481 * message cannot use any resources associated with the original RNDIS packet.
482 */
483struct nvsp_1_message_send_rndis_packet_complete {
484 u32 status;
485};
486
487union nvsp_1_message_uber {
488 struct nvsp_1_message_send_ndis_version send_ndis_ver;
489
490 struct nvsp_1_message_send_receive_buffer send_recv_buf;
491 struct nvsp_1_message_send_receive_buffer_complete
492 send_recv_buf_complete;
493 struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
494
495 struct nvsp_1_message_send_send_buffer send_send_buf;
496 struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
497 struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
498
499 struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
500 struct nvsp_1_message_send_rndis_packet_complete
501 send_rndis_pkt_complete;
502} __packed;
503
Haiyang Zhangf157e782011-12-15 13:45:16 -0800504
505/*
506 * Network VSP protocol version 2 messages:
507 */
508struct nvsp_2_vsc_capability {
509 union {
510 u64 data;
511 struct {
512 u64 vmq:1;
513 u64 chimney:1;
514 u64 sriov:1;
515 u64 ieee8021q:1;
516 u64 correlation_id:1;
Haiyang Zhang7f5d5af2016-08-04 10:42:15 -0700517 u64 teaming:1;
Haiyang Zhangf157e782011-12-15 13:45:16 -0800518 };
519 };
520} __packed;
521
522struct nvsp_2_send_ndis_config {
523 u32 mtu;
524 u32 reserved;
525 struct nvsp_2_vsc_capability capability;
526} __packed;
527
528/* Allocate receive buffer */
529struct nvsp_2_alloc_rxbuf {
530 /* Allocation ID to match the allocation request and response */
531 u32 alloc_id;
532
533 /* Length of the VM shared memory receive buffer that needs to
534 * be allocated
535 */
536 u32 len;
537} __packed;
538
539/* Allocate receive buffer complete */
540struct nvsp_2_alloc_rxbuf_comp {
541 /* The NDIS_STATUS code for buffer allocation */
542 u32 status;
543
544 u32 alloc_id;
545
546 /* GPADL handle for the allocated receive buffer */
547 u32 gpadl_handle;
548
549 /* Receive buffer ID */
550 u64 recv_buf_id;
551} __packed;
552
553struct nvsp_2_free_rxbuf {
554 u64 recv_buf_id;
555} __packed;
556
557union nvsp_2_message_uber {
558 struct nvsp_2_send_ndis_config send_ndis_config;
559 struct nvsp_2_alloc_rxbuf alloc_rxbuf;
560 struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
561 struct nvsp_2_free_rxbuf free_rxbuf;
562} __packed;
563
Haiyang Zhang71790a22015-07-24 10:08:40 -0700564struct nvsp_4_send_vf_association {
565 /* 1: allocated, serial number is valid. 0: not allocated */
566 u32 allocated;
567
568 /* Serial number of the VF to team with */
569 u32 serial;
570} __packed;
571
572enum nvsp_vm_datapath {
573 NVSP_DATAPATH_SYNTHETIC = 0,
574 NVSP_DATAPATH_VF,
575 NVSP_DATAPATH_MAX
576};
577
578struct nvsp_4_sw_datapath {
579 u32 active_datapath; /* active data path in VM */
580} __packed;
581
582union nvsp_4_message_uber {
583 struct nvsp_4_send_vf_association vf_assoc;
584 struct nvsp_4_sw_datapath active_dp;
585} __packed;
586
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800587enum nvsp_subchannel_operation {
588 NVSP_SUBCHANNEL_NONE = 0,
589 NVSP_SUBCHANNEL_ALLOCATE,
590 NVSP_SUBCHANNEL_MAX
591};
592
593struct nvsp_5_subchannel_request {
594 u32 op;
595 u32 num_subchannels;
596} __packed;
597
598struct nvsp_5_subchannel_complete {
599 u32 status;
600 u32 num_subchannels; /* Actual number of subchannels allocated */
601} __packed;
602
603struct nvsp_5_send_indirect_table {
604 /* The number of entries in the send indirection table */
605 u32 count;
606
Stephen Hemmingerc6a77ff2016-09-23 17:08:17 -0700607 /* The offset of the send indirection table from top of this struct.
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800608 * The send indirection table tells which channel to put the send
609 * traffic on. Each entry is a channel number.
610 */
611 u32 offset;
612} __packed;
613
614union nvsp_5_message_uber {
615 struct nvsp_5_subchannel_request subchn_req;
616 struct nvsp_5_subchannel_complete subchn_comp;
617 struct nvsp_5_send_indirect_table send_table;
618} __packed;
619
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700620union nvsp_all_messages {
621 union nvsp_message_init_uber init_msg;
622 union nvsp_1_message_uber v1_msg;
Haiyang Zhangf157e782011-12-15 13:45:16 -0800623 union nvsp_2_message_uber v2_msg;
Haiyang Zhang71790a22015-07-24 10:08:40 -0700624 union nvsp_4_message_uber v4_msg;
Haiyang Zhanga1eabb02014-02-19 15:49:45 -0800625 union nvsp_5_message_uber v5_msg;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700626} __packed;
627
628/* ALL Messages */
629struct nvsp_message {
630 struct nvsp_message_header hdr;
631 union nvsp_all_messages msg;
632} __packed;
633
634
Jarod Wilsond0c2c992016-10-20 13:55:21 -0400635#define NETVSC_MTU 65535
636#define NETVSC_MTU_MIN ETH_MIN_MTU
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700637
Haiyang Zhangb679ef72014-01-27 15:03:42 -0800638#define NETVSC_RECEIVE_BUFFER_SIZE (1024*1024*16) /* 16MB */
Haiyang Zhang99d30162014-03-09 16:10:59 -0700639#define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY (1024*1024*15) /* 15MB */
KY Srinivasanbe136ed2014-08-06 11:11:00 -0700640#define NETVSC_SEND_BUFFER_SIZE (1024 * 1024 * 15) /* 15MB */
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700641#define NETVSC_INVALID_INDEX -1
642
stephen hemminger8b532792017-08-09 17:46:11 -0700643#define NETVSC_SEND_SECTION_SIZE 6144
644#define NETVSC_RECV_SECTION_SIZE 1728
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700645
646#define NETVSC_RECEIVE_BUFFER_ID 0xcafe
Haiyang Zhangc51ed182014-12-19 18:25:18 -0800647#define NETVSC_SEND_BUFFER_ID 0
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700648
Haiyang Zhang8db91f62017-04-12 11:35:05 -0700649#define VRSS_SEND_TAB_SIZE 16 /* must be power of 2 */
Haiyang Zhang9efc2f72016-03-23 09:43:10 -0700650#define VRSS_CHANNEL_MAX 64
stephen hemminger2b018882017-01-24 13:06:03 -0800651#define VRSS_CHANNEL_DEFAULT 8
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700652
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700653#define RNDIS_MAX_PKT_DEFAULT 8
654#define RNDIS_PKT_ALIGN_DEFAULT 8
655
656struct multi_send_data {
Haiyang Zhangc85e4922016-01-25 09:49:31 -0800657 struct sk_buff *skb; /* skb containing the pkt */
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700658 struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
659 u32 count; /* counter of batched packets */
660};
661
Haiyang Zhangc0b558e2016-08-19 14:47:09 -0700662struct recv_comp_data {
663 u64 tid; /* transaction id */
664 u32 status;
665};
666
Haiyang Zhangc0b558e2016-08-19 14:47:09 -0700667struct multi_recv_comp {
stephen hemminger7426b1a2017-07-28 08:59:45 -0700668 struct recv_comp_data *slots;
669 u32 first; /* first data entry */
670 u32 next; /* next entry for writing */
Haiyang Zhangc0b558e2016-08-19 14:47:09 -0700671};
672
sixiao@microsoft.com7eafd9b2015-05-14 01:00:25 -0700673struct netvsc_stats {
674 u64 packets;
675 u64 bytes;
Stephen Hemmingerf7ad75b2016-09-22 16:56:35 -0700676 u64 broadcast;
677 u64 multicast;
sixiao@microsoft.com4b02b582015-05-15 02:33:03 -0700678 struct u64_stats_sync syncp;
sixiao@microsoft.com7eafd9b2015-05-14 01:00:25 -0700679};
680
Stephen Hemminger4323b472016-08-23 12:17:57 -0700681struct netvsc_ethtool_stats {
682 unsigned long tx_scattered;
683 unsigned long tx_no_memory;
684 unsigned long tx_no_space;
685 unsigned long tx_too_big;
686 unsigned long tx_busy;
stephen hemmingercad5c192017-08-09 17:46:12 -0700687 unsigned long tx_send_full;
688 unsigned long rx_comp_busy;
Simon Xiao09af87d2017-09-29 11:39:46 -0700689 unsigned long stop_queue;
690 unsigned long wake_queue;
Stephen Hemminger4323b472016-08-23 12:17:57 -0700691};
692
stephen hemminger0c195562017-08-01 19:58:53 -0700693struct netvsc_vf_pcpu_stats {
694 u64 rx_packets;
695 u64 rx_bytes;
696 u64 tx_packets;
697 u64 tx_bytes;
698 struct u64_stats_sync syncp;
699 u32 tx_dropped;
700};
701
Vitaly Kuznetsov27a70af2015-11-27 11:39:55 +0100702struct netvsc_reconfig {
703 struct list_head list;
704 u32 event;
705};
706
Simon Xiao3f300ff2015-04-28 01:05:17 -0700707/* The context of the netvsc device */
708struct net_device_context {
709 /* point back to our device context */
710 struct hv_device *device_ctx;
Vitaly Kuznetsov3d541ac2016-05-13 13:55:22 +0200711 /* netvsc_device */
stephen hemminger545a8e72017-03-22 14:51:00 -0700712 struct netvsc_device __rcu *nvdev;
Vitaly Kuznetsov27a70af2015-11-27 11:39:55 +0100713 /* reconfigure work */
Simon Xiao3f300ff2015-04-28 01:05:17 -0700714 struct delayed_work dwork;
Vitaly Kuznetsov27a70af2015-11-27 11:39:55 +0100715 /* last reconfig time */
716 unsigned long last_reconfig;
717 /* reconfig events */
718 struct list_head reconfig_events;
719 /* list protection */
720 spinlock_t lock;
721
Simon Xiao3f300ff2015-04-28 01:05:17 -0700722 u32 msg_enable; /* debug level */
sixiao@microsoft.com7eafd9b2015-05-14 01:00:25 -0700723
stephen hemminger23312a32017-01-24 13:05:59 -0800724 u32 tx_checksum_mask;
sixiao@microsoft.com49eb9382016-02-25 15:24:08 -0800725
stephen hemminger7ce10122017-03-09 14:58:29 -0800726 u32 tx_send_table[VRSS_SEND_TAB_SIZE];
727
sixiao@microsoft.com49eb9382016-02-25 15:24:08 -0800728 /* Ethtool settings */
Haiyang Zhang4823eb22017-08-21 19:22:39 -0700729 bool udp4_l4_hash;
730 bool udp6_l4_hash;
sixiao@microsoft.com49eb9382016-02-25 15:24:08 -0800731 u8 duplex;
732 u32 speed;
Stephen Hemminger4323b472016-08-23 12:17:57 -0700733 struct netvsc_ethtool_stats eth_stats;
Vitaly Kuznetsovf580aec2016-05-13 13:55:20 +0200734
Vitaly Kuznetsovf9a7da92016-08-15 17:48:39 +0200735 /* State to manage the associated VF interface. */
Stephen Hemmingerf207c102016-09-22 16:56:33 -0700736 struct net_device __rcu *vf_netdev;
stephen hemminger0c195562017-08-01 19:58:53 -0700737 struct netvsc_vf_pcpu_stats __percpu *vf_stats;
stephen hemminger6123c662017-08-09 17:46:03 -0700738 struct delayed_work vf_takeover;
Stephen Hemminger9cbcc422016-09-22 16:56:34 -0700739
Vitaly Kuznetsovf9a7da92016-08-15 17:48:39 +0200740 /* 1: allocated, serial number is valid. 0: not allocated */
741 u32 vf_alloc;
742 /* Serial number of the VF to team with */
743 u32 vf_serial;
Simon Xiao3f300ff2015-04-28 01:05:17 -0700744};
745
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800746/* Per channel data */
747struct netvsc_channel {
748 struct vmbus_channel *channel;
stephen hemminger35fbbcc2017-07-19 11:53:18 -0700749 struct netvsc_device *net_device;
stephen hemmingerf4f1c232017-03-22 14:50:57 -0700750 const struct vmpacket_descriptor *desc;
stephen hemminger15a863b2017-02-27 10:26:49 -0800751 struct napi_struct napi;
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800752 struct multi_send_data msd;
753 struct multi_recv_comp mrc;
754 atomic_t queue_sends;
Simon Xiao6c80f3f2017-01-24 13:06:13 -0800755
756 struct netvsc_stats tx_stats;
757 struct netvsc_stats rx_stats;
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800758};
759
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700760/* Per netvsc device */
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700761struct netvsc_device {
Haiyang Zhangf157e782011-12-15 13:45:16 -0800762 u32 nvsp_version;
763
Haiyang Zhangdc5cd892012-06-04 06:42:38 +0000764 wait_queue_head_t wait_drain;
K. Y. Srinivasanc38b9c72011-08-27 11:31:12 -0700765 bool destroy;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700766
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700767 /* Receive buffer allocated by us but manages by NetVSP */
768 void *recv_buf;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700769 u32 recv_buf_gpadl_handle;
770 u32 recv_section_cnt;
stephen hemminger8b532792017-08-09 17:46:11 -0700771 u32 recv_section_size;
stephen hemminger7426b1a2017-07-28 08:59:45 -0700772 u32 recv_completion_cnt;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700773
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700774 /* Send buffer allocated by us */
775 void *send_buf;
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700776 u32 send_buf_gpadl_handle;
777 u32 send_section_cnt;
778 u32 send_section_size;
779 unsigned long *send_section_map;
KY Srinivasanc25aaf82014-04-30 10:14:31 -0700780
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700781 /* Used for NetVSP initialization protocol */
782 struct completion channel_init_wait;
783 struct nvsp_message channel_init_pkt;
784
785 struct nvsp_message revoke_packet;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700786
Andrew Schwartzmeyer59995372015-02-26 16:27:14 -0800787 u32 max_chn;
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700788 u32 num_chn;
stephen hemminger43c7bd12017-03-22 14:51:02 -0700789
stephen hemminger732e4982017-08-03 17:13:54 -0700790 atomic_t open_chn;
Stephen Hemminger8195b132017-09-06 13:53:05 -0700791 struct work_struct subchan_work;
stephen hemminger732e4982017-08-03 17:13:54 -0700792 wait_queue_head_t subchan_open;
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700793
stephen hemminger2d05b562017-06-08 16:21:20 -0700794 struct rndis_device *extension;
Haiyang Zhang5b54dac2014-04-21 10:20:28 -0700795
796 int ring_size;
797
Haiyang Zhang7c3877f2015-03-26 09:03:37 -0700798 u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
799 u32 pkt_align; /* alignment bytes, e.g. 8 */
Simon Xiao3f300ff2015-04-28 01:05:17 -0700800
KY Srinivasan84bf9ce2016-04-14 16:31:54 -0700801 atomic_t open_cnt;
stephen hemmingerb8b835a2017-01-24 13:06:07 -0800802
803 struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
stephen hemminger545a8e72017-03-22 14:51:00 -0700804
805 struct rcu_head rcu;
K. Y. Srinivasan52584902011-05-12 19:34:39 -0700806};
807
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700808/* NdisInitialize message */
809struct rndis_initialize_request {
810 u32 req_id;
811 u32 major_ver;
812 u32 minor_ver;
813 u32 max_xfer_size;
814};
815
816/* Response to NdisInitialize */
817struct rndis_initialize_complete {
818 u32 req_id;
819 u32 status;
820 u32 major_ver;
821 u32 minor_ver;
822 u32 dev_flags;
823 u32 medium;
824 u32 max_pkt_per_msg;
825 u32 max_xfer_size;
826 u32 pkt_alignment_factor;
827 u32 af_list_offset;
828 u32 af_list_size;
829};
830
831/* Call manager devices only: Information about an address family */
832/* supported by the device is appended to the response to NdisInitialize. */
833struct rndis_co_address_family {
834 u32 address_family;
835 u32 major_ver;
836 u32 minor_ver;
837};
838
839/* NdisHalt message */
840struct rndis_halt_request {
841 u32 req_id;
842};
843
844/* NdisQueryRequest message */
845struct rndis_query_request {
846 u32 req_id;
847 u32 oid;
848 u32 info_buflen;
849 u32 info_buf_offset;
850 u32 dev_vc_handle;
851};
852
853/* Response to NdisQueryRequest */
854struct rndis_query_complete {
855 u32 req_id;
856 u32 status;
857 u32 info_buflen;
858 u32 info_buf_offset;
859};
860
861/* NdisSetRequest message */
862struct rndis_set_request {
863 u32 req_id;
864 u32 oid;
865 u32 info_buflen;
866 u32 info_buf_offset;
867 u32 dev_vc_handle;
868};
869
870/* Response to NdisSetRequest */
871struct rndis_set_complete {
872 u32 req_id;
873 u32 status;
874};
875
876/* NdisReset message */
877struct rndis_reset_request {
878 u32 reserved;
879};
880
881/* Response to NdisReset */
882struct rndis_reset_complete {
883 u32 status;
884 u32 addressing_reset;
885};
886
887/* NdisMIndicateStatus message */
888struct rndis_indicate_status {
889 u32 status;
890 u32 status_buflen;
891 u32 status_buf_offset;
892};
893
894/* Diagnostic information passed as the status buffer in */
895/* struct rndis_indicate_status messages signifying error conditions. */
896struct rndis_diagnostic_info {
897 u32 diag_status;
898 u32 error_offset;
899};
900
901/* NdisKeepAlive message */
902struct rndis_keepalive_request {
903 u32 req_id;
904};
905
906/* Response to NdisKeepAlive */
907struct rndis_keepalive_complete {
908 u32 req_id;
909 u32 status;
910};
911
912/*
913 * Data message. All Offset fields contain byte offsets from the beginning of
914 * struct rndis_packet. All Length fields are in bytes. VcHandle is set
915 * to 0 for connectionless data, otherwise it contains the VC handle.
916 */
917struct rndis_packet {
918 u32 data_offset;
919 u32 data_len;
920 u32 oob_data_offset;
921 u32 oob_data_len;
922 u32 num_oob_data_elements;
923 u32 per_pkt_info_offset;
924 u32 per_pkt_info_len;
925 u32 vc_handle;
926 u32 reserved;
927};
928
929/* Optional Out of Band data associated with a Data message. */
930struct rndis_oobd {
931 u32 size;
932 u32 type;
933 u32 class_info_offset;
934};
935
936/* Packet extension field contents associated with a Data message. */
937struct rndis_per_packet_info {
938 u32 size;
939 u32 type;
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000940 u32 ppi_offset;
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -0700941};
942
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000943enum ndis_per_pkt_info_type {
944 TCPIP_CHKSUM_PKTINFO,
945 IPSEC_PKTINFO,
946 TCP_LARGESEND_PKTINFO,
947 CLASSIFICATION_HANDLE_PKTINFO,
948 NDIS_RESERVED,
949 SG_LIST_PKTINFO,
950 IEEE_8021Q_INFO,
951 ORIGINAL_PKTINFO,
952 PACKET_CANCEL_ID,
Haiyang Zhang307f0992014-05-21 12:55:39 -0700953 NBL_HASH_VALUE = PACKET_CANCEL_ID,
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +0000954 ORIGINAL_NET_BUFLIST,
955 CACHED_NET_BUFLIST,
956 SHORT_PKT_PADINFO,
957 MAX_PER_PKT_INFO
958};
959
960struct ndis_pkt_8021q_info {
961 union {
962 struct {
963 u32 pri:3; /* User Priority */
964 u32 cfi:1; /* Canonical Format ID */
965 u32 vlanid:12; /* VLAN ID */
966 u32 reserved:16;
967 };
968 u32 value;
969 };
970};
971
stephen hemminger23312a32017-01-24 13:05:59 -0800972struct ndis_object_header {
KY Srinivasan4a0e70a2014-03-08 19:23:15 -0800973 u8 type;
974 u8 revision;
975 u16 size;
976};
977
978#define NDIS_OBJECT_TYPE_DEFAULT 0x80
979#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
stephen hemminger23312a32017-01-24 13:05:59 -0800980#define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
981#define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
982
KY Srinivasan4a0e70a2014-03-08 19:23:15 -0800983#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
984#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
985#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED 2
986#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED 2
987#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
988#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
989#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
990#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
991#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
992#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
993
KY Srinivasan77bf5482014-03-08 19:23:18 -0800994#define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE 1
995#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4 0
996#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6 1
997
KY Srinivasanaf9893a2014-04-09 15:00:47 -0700998#define VERSION_4_OFFLOAD_SIZE 22
KY Srinivasan4a0e70a2014-03-08 19:23:15 -0800999/*
1000 * New offload OIDs for NDIS 6
1001 */
1002#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1003#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C /* set only */
1004#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1005#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1006#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1007#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1008
stephen hemminger23312a32017-01-24 13:05:59 -08001009/*
1010 * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1011 * ndis_type: NDIS_OBJTYPE_OFFLOAD
1012 */
1013
1014#define NDIS_OFFLOAD_ENCAP_NONE 0x0000
1015#define NDIS_OFFLOAD_ENCAP_NULL 0x0001
1016#define NDIS_OFFLOAD_ENCAP_8023 0x0002
1017#define NDIS_OFFLOAD_ENCAP_8023PQ 0x0004
1018#define NDIS_OFFLOAD_ENCAP_8023PQ_OOB 0x0008
1019#define NDIS_OFFLOAD_ENCAP_RFC1483 0x0010
1020
1021struct ndis_csum_offload {
1022 u32 ip4_txenc;
1023 u32 ip4_txcsum;
1024#define NDIS_TXCSUM_CAP_IP4OPT 0x001
1025#define NDIS_TXCSUM_CAP_TCP4OPT 0x004
1026#define NDIS_TXCSUM_CAP_TCP4 0x010
1027#define NDIS_TXCSUM_CAP_UDP4 0x040
1028#define NDIS_TXCSUM_CAP_IP4 0x100
1029
1030#define NDIS_TXCSUM_ALL_TCP4 (NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1031
1032 u32 ip4_rxenc;
1033 u32 ip4_rxcsum;
1034#define NDIS_RXCSUM_CAP_IP4OPT 0x001
1035#define NDIS_RXCSUM_CAP_TCP4OPT 0x004
1036#define NDIS_RXCSUM_CAP_TCP4 0x010
1037#define NDIS_RXCSUM_CAP_UDP4 0x040
1038#define NDIS_RXCSUM_CAP_IP4 0x100
1039 u32 ip6_txenc;
1040 u32 ip6_txcsum;
1041#define NDIS_TXCSUM_CAP_IP6EXT 0x001
1042#define NDIS_TXCSUM_CAP_TCP6OPT 0x004
1043#define NDIS_TXCSUM_CAP_TCP6 0x010
1044#define NDIS_TXCSUM_CAP_UDP6 0x040
1045 u32 ip6_rxenc;
1046 u32 ip6_rxcsum;
1047#define NDIS_RXCSUM_CAP_IP6EXT 0x001
1048#define NDIS_RXCSUM_CAP_TCP6OPT 0x004
1049#define NDIS_RXCSUM_CAP_TCP6 0x010
1050#define NDIS_RXCSUM_CAP_UDP6 0x040
1051
1052#define NDIS_TXCSUM_ALL_TCP6 (NDIS_TXCSUM_CAP_TCP6 | \
1053 NDIS_TXCSUM_CAP_TCP6OPT | \
1054 NDIS_TXCSUM_CAP_IP6EXT)
1055};
1056
1057struct ndis_lsov1_offload {
1058 u32 encap;
1059 u32 maxsize;
1060 u32 minsegs;
1061 u32 opts;
1062};
1063
1064struct ndis_ipsecv1_offload {
1065 u32 encap;
1066 u32 ah_esp;
1067 u32 xport_tun;
1068 u32 ip4_opts;
1069 u32 flags;
1070 u32 ip4_ah;
1071 u32 ip4_esp;
1072};
1073
1074struct ndis_lsov2_offload {
1075 u32 ip4_encap;
1076 u32 ip4_maxsz;
1077 u32 ip4_minsg;
1078 u32 ip6_encap;
1079 u32 ip6_maxsz;
1080 u32 ip6_minsg;
1081 u32 ip6_opts;
1082#define NDIS_LSOV2_CAP_IP6EXT 0x001
1083#define NDIS_LSOV2_CAP_TCP6OPT 0x004
1084
1085#define NDIS_LSOV2_CAP_IP6 (NDIS_LSOV2_CAP_IP6EXT | \
1086 NDIS_LSOV2_CAP_TCP6OPT)
1087};
1088
1089struct ndis_ipsecv2_offload {
1090 u32 encap;
1091 u16 ip6;
1092 u16 ip4opt;
1093 u16 ip6ext;
1094 u16 ah;
1095 u16 esp;
1096 u16 ah_esp;
1097 u16 xport;
1098 u16 tun;
1099 u16 xport_tun;
1100 u16 lso;
1101 u16 extseq;
1102 u32 udp_esp;
1103 u32 auth;
1104 u32 crypto;
1105 u32 sa_caps;
1106};
1107
1108struct ndis_rsc_offload {
1109 u16 ip4;
1110 u16 ip6;
1111};
1112
1113struct ndis_encap_offload {
1114 u32 flags;
1115 u32 maxhdr;
1116};
1117
1118struct ndis_offload {
1119 struct ndis_object_header header;
1120 struct ndis_csum_offload csum;
1121 struct ndis_lsov1_offload lsov1;
1122 struct ndis_ipsecv1_offload ipsecv1;
1123 struct ndis_lsov2_offload lsov2;
1124 u32 flags;
1125 /* NDIS >= 6.1 */
1126 struct ndis_ipsecv2_offload ipsecv2;
1127 /* NDIS >= 6.30 */
1128 struct ndis_rsc_offload rsc;
1129 struct ndis_encap_offload encap_gre;
1130};
1131
1132#define NDIS_OFFLOAD_SIZE sizeof(struct ndis_offload)
1133#define NDIS_OFFLOAD_SIZE_6_0 offsetof(struct ndis_offload, ipsecv2)
1134#define NDIS_OFFLOAD_SIZE_6_1 offsetof(struct ndis_offload, rsc)
1135
KY Srinivasan4a0e70a2014-03-08 19:23:15 -08001136struct ndis_offload_params {
stephen hemminger23312a32017-01-24 13:05:59 -08001137 struct ndis_object_header header;
KY Srinivasan4a0e70a2014-03-08 19:23:15 -08001138 u8 ip_v4_csum;
1139 u8 tcp_ip_v4_csum;
1140 u8 udp_ip_v4_csum;
1141 u8 tcp_ip_v6_csum;
1142 u8 udp_ip_v6_csum;
1143 u8 lso_v1;
1144 u8 ip_sec_v1;
1145 u8 lso_v2_ipv4;
1146 u8 lso_v2_ipv6;
1147 u8 tcp_connection_ip_v4;
1148 u8 tcp_connection_ip_v6;
1149 u32 flags;
1150 u8 ip_sec_v2;
1151 u8 ip_sec_v2_ip_v4;
1152 struct {
1153 u8 rsc_ip_v4;
1154 u8 rsc_ip_v6;
1155 };
1156 struct {
1157 u8 encapsulated_packet_task_offload;
1158 u8 encapsulation_types;
1159 };
1160};
1161
KY Srinivasane3d605e2014-03-08 19:23:16 -08001162struct ndis_tcp_ip_checksum_info {
1163 union {
1164 struct {
1165 u32 is_ipv4:1;
1166 u32 is_ipv6:1;
1167 u32 tcp_checksum:1;
1168 u32 udp_checksum:1;
1169 u32 ip_header_checksum:1;
1170 u32 reserved:11;
1171 u32 tcp_header_offset:10;
1172 } transmit;
1173 struct {
1174 u32 tcp_checksum_failed:1;
1175 u32 udp_checksum_failed:1;
1176 u32 ip_checksum_failed:1;
1177 u32 tcp_checksum_succeeded:1;
1178 u32 udp_checksum_succeeded:1;
1179 u32 ip_checksum_succeeded:1;
1180 u32 loopback:1;
1181 u32 tcp_checksum_value_invalid:1;
1182 u32 ip_checksum_value_invalid:1;
1183 } receive;
1184 u32 value;
1185 };
1186};
1187
KY Srinivasan77bf5482014-03-08 19:23:18 -08001188struct ndis_tcp_lso_info {
1189 union {
1190 struct {
1191 u32 unused:30;
1192 u32 type:1;
1193 u32 reserved2:1;
1194 } transmit;
1195 struct {
1196 u32 mss:20;
1197 u32 tcp_header_offset:10;
1198 u32 type:1;
1199 u32 reserved2:1;
1200 } lso_v1_transmit;
1201 struct {
1202 u32 tcp_payload:30;
1203 u32 type:1;
1204 u32 reserved2:1;
1205 } lso_v1_transmit_complete;
1206 struct {
1207 u32 mss:20;
1208 u32 tcp_header_offset:10;
1209 u32 type:1;
1210 u32 ip_version:1;
1211 } lso_v2_transmit;
1212 struct {
1213 u32 reserved:30;
1214 u32 type:1;
1215 u32 reserved2:1;
1216 } lso_v2_transmit_complete;
1217 u32 value;
1218 };
1219};
1220
Haiyang Zhang1f5f3a72012-03-12 10:20:50 +00001221#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1222 sizeof(struct ndis_pkt_8021q_info))
1223
KY Srinivasane3d605e2014-03-08 19:23:16 -08001224#define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1225 sizeof(struct ndis_tcp_ip_checksum_info))
1226
KY Srinivasan77bf5482014-03-08 19:23:18 -08001227#define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1228 sizeof(struct ndis_tcp_lso_info))
1229
Haiyang Zhang307f0992014-05-21 12:55:39 -07001230#define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1231 sizeof(u32))
1232
Haiyang Zhang72151422015-04-06 15:22:53 -07001233/* Total size of all PPI data */
1234#define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1235 NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1236
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -07001237/* Format of Information buffer passed in a SetRequest for the OID */
1238/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1239struct rndis_config_parameter_info {
1240 u32 parameter_name_offset;
1241 u32 parameter_name_length;
1242 u32 parameter_type;
1243 u32 parameter_value_offset;
1244 u32 parameter_value_length;
1245};
1246
1247/* Values for ParameterType in struct rndis_config_parameter_info */
1248#define RNDIS_CONFIG_PARAM_TYPE_INTEGER 0
1249#define RNDIS_CONFIG_PARAM_TYPE_STRING 2
1250
1251/* CONDIS Miniport messages for connection oriented devices */
1252/* that do not implement a call manager. */
1253
1254/* CoNdisMiniportCreateVc message */
1255struct rcondis_mp_create_vc {
1256 u32 req_id;
1257 u32 ndis_vc_handle;
1258};
1259
1260/* Response to CoNdisMiniportCreateVc */
1261struct rcondis_mp_create_vc_complete {
1262 u32 req_id;
1263 u32 dev_vc_handle;
1264 u32 status;
1265};
1266
1267/* CoNdisMiniportDeleteVc message */
1268struct rcondis_mp_delete_vc {
1269 u32 req_id;
1270 u32 dev_vc_handle;
1271};
1272
1273/* Response to CoNdisMiniportDeleteVc */
1274struct rcondis_mp_delete_vc_complete {
1275 u32 req_id;
1276 u32 status;
1277};
1278
1279/* CoNdisMiniportQueryRequest message */
1280struct rcondis_mp_query_request {
1281 u32 req_id;
1282 u32 request_type;
1283 u32 oid;
1284 u32 dev_vc_handle;
1285 u32 info_buflen;
1286 u32 info_buf_offset;
1287};
1288
1289/* CoNdisMiniportSetRequest message */
1290struct rcondis_mp_set_request {
1291 u32 req_id;
1292 u32 request_type;
1293 u32 oid;
1294 u32 dev_vc_handle;
1295 u32 info_buflen;
1296 u32 info_buf_offset;
1297};
1298
1299/* CoNdisIndicateStatus message */
1300struct rcondis_indicate_status {
1301 u32 ndis_vc_handle;
1302 u32 status;
1303 u32 status_buflen;
1304 u32 status_buf_offset;
1305};
1306
1307/* CONDIS Call/VC parameters */
1308struct rcondis_specific_parameters {
1309 u32 parameter_type;
1310 u32 parameter_length;
1311 u32 parameter_lffset;
1312};
1313
1314struct rcondis_media_parameters {
1315 u32 flags;
1316 u32 reserved1;
1317 u32 reserved2;
1318 struct rcondis_specific_parameters media_specific;
1319};
1320
1321struct rndis_flowspec {
1322 u32 token_rate;
1323 u32 token_bucket_size;
1324 u32 peak_bandwidth;
1325 u32 latency;
1326 u32 delay_variation;
1327 u32 service_type;
1328 u32 max_sdu_size;
1329 u32 minimum_policed_size;
1330};
1331
1332struct rcondis_call_manager_parameters {
1333 struct rndis_flowspec transmit;
1334 struct rndis_flowspec receive;
1335 struct rcondis_specific_parameters call_mgr_specific;
1336};
1337
1338/* CoNdisMiniportActivateVc message */
1339struct rcondis_mp_activate_vc_request {
1340 u32 req_id;
1341 u32 flags;
1342 u32 dev_vc_handle;
1343 u32 media_params_offset;
1344 u32 media_params_length;
1345 u32 call_mgr_params_offset;
1346 u32 call_mgr_params_length;
1347};
1348
1349/* Response to CoNdisMiniportActivateVc */
1350struct rcondis_mp_activate_vc_complete {
1351 u32 req_id;
1352 u32 status;
1353};
1354
1355/* CoNdisMiniportDeactivateVc message */
1356struct rcondis_mp_deactivate_vc_request {
1357 u32 req_id;
1358 u32 flags;
1359 u32 dev_vc_handle;
1360};
1361
1362/* Response to CoNdisMiniportDeactivateVc */
1363struct rcondis_mp_deactivate_vc_complete {
1364 u32 req_id;
1365 u32 status;
1366};
1367
1368
1369/* union with all of the RNDIS messages */
1370union rndis_message_container {
1371 struct rndis_packet pkt;
1372 struct rndis_initialize_request init_req;
1373 struct rndis_halt_request halt_req;
1374 struct rndis_query_request query_req;
1375 struct rndis_set_request set_req;
1376 struct rndis_reset_request reset_req;
1377 struct rndis_keepalive_request keep_alive_req;
1378 struct rndis_indicate_status indicate_status;
1379 struct rndis_initialize_complete init_complete;
1380 struct rndis_query_complete query_complete;
1381 struct rndis_set_complete set_complete;
1382 struct rndis_reset_complete reset_complete;
1383 struct rndis_keepalive_complete keep_alive_complete;
1384 struct rcondis_mp_create_vc co_miniport_create_vc;
1385 struct rcondis_mp_delete_vc co_miniport_delete_vc;
1386 struct rcondis_indicate_status co_indicate_status;
1387 struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1388 struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1389 struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1390 struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1391 struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1392 struct rcondis_mp_deactivate_vc_complete
1393 co_miniport_deactivate_vc_complete;
1394};
1395
1396/* Remote NDIS message format */
1397struct rndis_message {
1398 u32 ndis_msg_type;
1399
1400 /* Total length of this message, from the beginning */
Stephen Hemmingerc6a77ff2016-09-23 17:08:17 -07001401 /* of the struct rndis_message, in bytes. */
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -07001402 u32 msg_len;
1403
1404 /* Actual message */
1405 union rndis_message_container msg;
1406};
1407
K. Y. Srinivasan9dbfd152011-05-12 19:35:00 -07001408
K. Y. Srinivasan4a5cea32011-05-12 19:34:40 -07001409/* Handy macros */
1410
1411/* get the size of an RNDIS message. Pass in the message type, */
1412/* struct rndis_set_request, struct rndis_packet for example */
1413#define RNDIS_MESSAGE_SIZE(msg) \
1414 (sizeof(msg) + (sizeof(struct rndis_message) - \
1415 sizeof(union rndis_message_container)))
1416
1417/* get pointer to info buffer with message pointer */
1418#define MESSAGE_TO_INFO_BUFFER(msg) \
1419 (((unsigned char *)(msg)) + msg->info_buf_offset)
1420
1421/* get pointer to status buffer with message pointer */
1422#define MESSAGE_TO_STATUS_BUFFER(msg) \
1423 (((unsigned char *)(msg)) + msg->status_buf_offset)
1424
1425/* get pointer to OOBD buffer with message pointer */
1426#define MESSAGE_TO_OOBD_BUFFER(msg) \
1427 (((unsigned char *)(msg)) + msg->oob_data_offset)
1428
1429/* get pointer to data buffer with message pointer */
1430#define MESSAGE_TO_DATA_BUFFER(msg) \
1431 (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1432
1433/* get pointer to contained message from NDIS_MESSAGE pointer */
1434#define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg) \
1435 ((void *) &rndis_msg->msg)
1436
1437/* get pointer to contained message from NDIS_MESSAGE pointer */
1438#define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
1439 ((void *) rndis_msg)
1440
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001441
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001442
1443#define RNDIS_HEADER_SIZE (sizeof(struct rndis_message) - \
1444 sizeof(union rndis_message_container))
1445
Haiyang Zhang72151422015-04-06 15:22:53 -07001446#define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1447
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001448#define NDIS_PACKET_TYPE_DIRECTED 0x00000001
1449#define NDIS_PACKET_TYPE_MULTICAST 0x00000002
1450#define NDIS_PACKET_TYPE_ALL_MULTICAST 0x00000004
1451#define NDIS_PACKET_TYPE_BROADCAST 0x00000008
1452#define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
1453#define NDIS_PACKET_TYPE_PROMISCUOUS 0x00000020
1454#define NDIS_PACKET_TYPE_SMT 0x00000040
1455#define NDIS_PACKET_TYPE_ALL_LOCAL 0x00000080
1456#define NDIS_PACKET_TYPE_GROUP 0x00000100
1457#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
1458#define NDIS_PACKET_TYPE_FUNCTIONAL 0x00000400
1459#define NDIS_PACKET_TYPE_MAC_FRAME 0x00000800
1460
KY Srinivasan08cd04b2014-03-08 19:23:17 -08001461#define TRANSPORT_INFO_NOT_IP 0
stephen hemminger23312a32017-01-24 13:05:59 -08001462#define TRANSPORT_INFO_IPV4_TCP 0x01
1463#define TRANSPORT_INFO_IPV4_UDP 0x02
1464#define TRANSPORT_INFO_IPV6_TCP 0x10
1465#define TRANSPORT_INFO_IPV6_UDP 0x20
K. Y. Srinivasan299d09252011-05-12 19:34:41 -07001466
K. Y. Srinivasan5ca72522011-05-12 19:34:37 -07001467#endif /* _HYPERV_NET_H */