xref: /openbmc/linux/drivers/net/hyperv/hyperv_net.h (revision 715f23b6)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  *
4  * Copyright (c) 2011, Microsoft Corporation.
5  *
6  * Authors:
7  *   Haiyang Zhang <haiyangz@microsoft.com>
8  *   Hank Janssen  <hjanssen@microsoft.com>
9  *   K. Y. Srinivasan <kys@microsoft.com>
10  */
11 
12 #ifndef _HYPERV_NET_H
13 #define _HYPERV_NET_H
14 
15 #include <linux/list.h>
16 #include <linux/hyperv.h>
17 #include <linux/rndis.h>
18 
19 /* RSS related */
20 #define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203  /* query only */
21 #define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204  /* query and set */
22 
23 #define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88
24 #define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89
25 #define NDIS_OBJECT_TYPE_OFFLOAD	0xa7
26 
27 #define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
28 #define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
29 
30 struct ndis_obj_header {
31 	u8 type;
32 	u8 rev;
33 	u16 size;
34 } __packed;
35 
36 /* ndis_recv_scale_cap/cap_flag */
37 #define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
38 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR       0x02000000
39 #define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC       0x04000000
40 #define NDIS_RSS_CAPS_USING_MSI_X                 0x08000000
41 #define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS      0x10000000
42 #define NDIS_RSS_CAPS_SUPPORTS_MSI_X              0x20000000
43 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4          0x00000100
44 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6          0x00000200
45 #define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX       0x00000400
46 
47 struct ndis_recv_scale_cap { /* NDIS_RECEIVE_SCALE_CAPABILITIES */
48 	struct ndis_obj_header hdr;
49 	u32 cap_flag;
50 	u32 num_int_msg;
51 	u32 num_recv_que;
52 	u16 num_indirect_tabent;
53 } __packed;
54 
55 
56 /* ndis_recv_scale_param flags */
57 #define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED     0x0001
58 #define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED    0x0002
59 #define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED       0x0004
60 #define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED     0x0008
61 #define NDIS_RSS_PARAM_FLAG_DISABLE_RSS            0x0010
62 
63 /* Hash info bits */
64 #define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
65 #define NDIS_HASH_IPV4          0x00000100
66 #define NDIS_HASH_TCP_IPV4      0x00000200
67 #define NDIS_HASH_IPV6          0x00000400
68 #define NDIS_HASH_IPV6_EX       0x00000800
69 #define NDIS_HASH_TCP_IPV6      0x00001000
70 #define NDIS_HASH_TCP_IPV6_EX   0x00002000
71 
72 #define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
73 #define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2   40
74 
75 #define ITAB_NUM 128
76 
77 struct ndis_recv_scale_param { /* NDIS_RECEIVE_SCALE_PARAMETERS */
78 	struct ndis_obj_header hdr;
79 
80 	/* Qualifies the rest of the information */
81 	u16 flag;
82 
83 	/* The base CPU number to do receive processing. not used */
84 	u16 base_cpu_number;
85 
86 	/* This describes the hash function and type being enabled */
87 	u32 hashinfo;
88 
89 	/* The size of indirection table array */
90 	u16 indirect_tabsize;
91 
92 	/* The offset of the indirection table from the beginning of this
93 	 * structure
94 	 */
95 	u32 indirect_taboffset;
96 
97 	/* The size of the hash secret key */
98 	u16 hashkey_size;
99 
100 	/* The offset of the secret key from the beginning of this structure */
101 	u32 hashkey_offset;
102 
103 	u32 processor_masks_offset;
104 	u32 num_processor_masks;
105 	u32 processor_masks_entry_size;
106 };
107 
108 /* Fwd declaration */
109 struct ndis_tcp_ip_checksum_info;
110 struct ndis_pkt_8021q_info;
111 
112 /*
113  * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
114  * within the RNDIS
115  *
116  * The size of this structure is less than 48 bytes and we can now
117  * place this structure in the skb->cb field.
118  */
119 struct hv_netvsc_packet {
120 	/* Bookkeeping stuff */
121 	u8 cp_partial; /* partial copy into send buffer */
122 
123 	u8 rmsg_size; /* RNDIS header and PPI size */
124 	u8 rmsg_pgcnt; /* page count of RNDIS header and PPI */
125 	u8 page_buf_cnt;
126 
127 	u16 q_idx;
128 	u16 total_packets;
129 
130 	u32 total_bytes;
131 	u32 send_buf_index;
132 	u32 total_data_buflen;
133 };
134 
135 #define NETVSC_HASH_KEYLEN 40
136 
137 struct netvsc_device_info {
138 	unsigned char mac_adr[ETH_ALEN];
139 	u32  num_chn;
140 	u32  send_sections;
141 	u32  recv_sections;
142 	u32  send_section_size;
143 	u32  recv_section_size;
144 
145 	u8 rss_key[NETVSC_HASH_KEYLEN];
146 };
147 
148 enum rndis_device_state {
149 	RNDIS_DEV_UNINITIALIZED = 0,
150 	RNDIS_DEV_INITIALIZING,
151 	RNDIS_DEV_INITIALIZED,
152 	RNDIS_DEV_DATAINITIALIZED,
153 };
154 
155 struct rndis_device {
156 	struct net_device *ndev;
157 
158 	enum rndis_device_state state;
159 
160 	atomic_t new_req_id;
161 
162 	spinlock_t request_lock;
163 	struct list_head req_list;
164 
165 	struct work_struct mcast_work;
166 	u32 filter;
167 
168 	bool link_state;        /* 0 - link up, 1 - link down */
169 
170 	u8 hw_mac_adr[ETH_ALEN];
171 	u8 rss_key[NETVSC_HASH_KEYLEN];
172 };
173 
174 
175 /* Interface */
176 struct rndis_message;
177 struct ndis_offload_params;
178 struct netvsc_device;
179 struct netvsc_channel;
180 struct net_device_context;
181 
182 extern u32 netvsc_ring_bytes;
183 
184 struct netvsc_device *netvsc_device_add(struct hv_device *device,
185 					const struct netvsc_device_info *info);
186 int netvsc_alloc_recv_comp_ring(struct netvsc_device *net_device, u32 q_idx);
187 void netvsc_device_remove(struct hv_device *device);
188 int netvsc_send(struct net_device *net,
189 		struct hv_netvsc_packet *packet,
190 		struct rndis_message *rndis_msg,
191 		struct hv_page_buffer *page_buffer,
192 		struct sk_buff *skb);
193 void netvsc_linkstatus_callback(struct net_device *net,
194 				struct rndis_message *resp);
195 int netvsc_recv_callback(struct net_device *net,
196 			 struct netvsc_device *nvdev,
197 			 struct netvsc_channel *nvchan);
198 void netvsc_channel_cb(void *context);
199 int netvsc_poll(struct napi_struct *napi, int budget);
200 
201 int rndis_set_subchannel(struct net_device *ndev,
202 			 struct netvsc_device *nvdev,
203 			 struct netvsc_device_info *dev_info);
204 int rndis_filter_open(struct netvsc_device *nvdev);
205 int rndis_filter_close(struct netvsc_device *nvdev);
206 struct netvsc_device *rndis_filter_device_add(struct hv_device *dev,
207 					      struct netvsc_device_info *info);
208 void rndis_filter_update(struct netvsc_device *nvdev);
209 void rndis_filter_device_remove(struct hv_device *dev,
210 				struct netvsc_device *nvdev);
211 int rndis_filter_set_rss_param(struct rndis_device *rdev,
212 			       const u8 *key);
213 int rndis_filter_set_offload_params(struct net_device *ndev,
214 				    struct netvsc_device *nvdev,
215 				    struct ndis_offload_params *req_offloads);
216 int rndis_filter_receive(struct net_device *ndev,
217 			 struct netvsc_device *net_dev,
218 			 struct netvsc_channel *nvchan,
219 			 void *data, u32 buflen);
220 
221 int rndis_filter_set_device_mac(struct netvsc_device *ndev,
222 				const char *mac);
223 
224 void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
225 
226 #define NVSP_INVALID_PROTOCOL_VERSION	((u32)0xFFFFFFFF)
227 
228 #define NVSP_PROTOCOL_VERSION_1		2
229 #define NVSP_PROTOCOL_VERSION_2		0x30002
230 #define NVSP_PROTOCOL_VERSION_4		0x40000
231 #define NVSP_PROTOCOL_VERSION_5		0x50000
232 #define NVSP_PROTOCOL_VERSION_6		0x60000
233 #define NVSP_PROTOCOL_VERSION_61	0x60001
234 
235 enum {
236 	NVSP_MSG_TYPE_NONE = 0,
237 
238 	/* Init Messages */
239 	NVSP_MSG_TYPE_INIT			= 1,
240 	NVSP_MSG_TYPE_INIT_COMPLETE		= 2,
241 
242 	NVSP_VERSION_MSG_START			= 100,
243 
244 	/* Version 1 Messages */
245 	NVSP_MSG1_TYPE_SEND_NDIS_VER		= NVSP_VERSION_MSG_START,
246 
247 	NVSP_MSG1_TYPE_SEND_RECV_BUF,
248 	NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
249 	NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
250 
251 	NVSP_MSG1_TYPE_SEND_SEND_BUF,
252 	NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
253 	NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
254 
255 	NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
256 	NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
257 
258 	/* Version 2 messages */
259 	NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
260 	NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
261 	NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
262 
263 	NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
264 
265 	NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
266 	NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
267 
268 	NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
269 
270 	NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
271 	NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
272 
273 	NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
274 	NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
275 
276 	NVSP_MSG2_TYPE_ALLOC_RXBUF,
277 	NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
278 
279 	NVSP_MSG2_TYPE_FREE_RXBUF,
280 
281 	NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
282 	NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
283 
284 	NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
285 
286 	NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
287 	NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
288 
289 	NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
290 
291 	/* Version 4 messages */
292 	NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
293 	NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
294 	NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
295 
296 	NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
297 
298 	/* Version 5 messages */
299 	NVSP_MSG5_TYPE_OID_QUERY_EX,
300 	NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
301 	NVSP_MSG5_TYPE_SUBCHANNEL,
302 	NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
303 
304 	NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
305 
306 	/* Version 6 messages */
307 	NVSP_MSG6_TYPE_PD_API,
308 	NVSP_MSG6_TYPE_PD_POST_BATCH,
309 
310 	NVSP_MSG6_MAX = NVSP_MSG6_TYPE_PD_POST_BATCH
311 };
312 
313 enum {
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,
321 	NVSP_STAT_PROTOCOL_UNSUPPORTED,
322 	NVSP_STAT_MAX,
323 };
324 
325 struct 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  */
336 struct 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  */
346 struct nvsp_message_init_complete {
347 	u32 negotiated_protocol_ver;
348 	u32 max_mdl_chain_len;
349 	u32 status;
350 } __packed;
351 
352 union 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  */
363 struct 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  */
372 struct nvsp_1_message_send_receive_buffer {
373 	u32 gpadl_handle;
374 	u16 id;
375 } __packed;
376 
377 struct 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  */
389 struct 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  */
420 struct 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  */
428 struct 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  */
438 struct 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  */
454 struct 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  */
462 struct nvsp_1_message_send_rndis_packet {
463 	/*
464 	 * This field is specified by RNDIS. They assume there's two different
465 	 * 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  */
485 struct nvsp_1_message_send_rndis_packet_complete {
486 	u32 status;
487 };
488 
489 union 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 
506 
507 /*
508  * Network VSP protocol version 2 messages:
509  */
510 struct 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;
519 			u64 teaming:1;
520 			u64 vsubnetid:1;
521 			u64 rsc:1;
522 		};
523 	};
524 } __packed;
525 
526 struct nvsp_2_send_ndis_config {
527 	u32 mtu;
528 	u32 reserved;
529 	struct nvsp_2_vsc_capability capability;
530 } __packed;
531 
532 /* Allocate receive buffer */
533 struct nvsp_2_alloc_rxbuf {
534 	/* Allocation ID to match the allocation request and response */
535 	u32 alloc_id;
536 
537 	/* Length of the VM shared memory receive buffer that needs to
538 	 * be allocated
539 	 */
540 	u32 len;
541 } __packed;
542 
543 /* Allocate receive buffer complete */
544 struct nvsp_2_alloc_rxbuf_comp {
545 	/* The NDIS_STATUS code for buffer allocation */
546 	u32 status;
547 
548 	u32 alloc_id;
549 
550 	/* GPADL handle for the allocated receive buffer */
551 	u32 gpadl_handle;
552 
553 	/* Receive buffer ID */
554 	u64 recv_buf_id;
555 } __packed;
556 
557 struct nvsp_2_free_rxbuf {
558 	u64 recv_buf_id;
559 } __packed;
560 
561 union nvsp_2_message_uber {
562 	struct nvsp_2_send_ndis_config send_ndis_config;
563 	struct nvsp_2_alloc_rxbuf alloc_rxbuf;
564 	struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
565 	struct nvsp_2_free_rxbuf free_rxbuf;
566 } __packed;
567 
568 struct nvsp_4_send_vf_association {
569 	/* 1: allocated, serial number is valid. 0: not allocated */
570 	u32 allocated;
571 
572 	/* Serial number of the VF to team with */
573 	u32 serial;
574 } __packed;
575 
576 enum nvsp_vm_datapath {
577 	NVSP_DATAPATH_SYNTHETIC = 0,
578 	NVSP_DATAPATH_VF,
579 	NVSP_DATAPATH_MAX
580 };
581 
582 struct nvsp_4_sw_datapath {
583 	u32 active_datapath; /* active data path in VM */
584 } __packed;
585 
586 union nvsp_4_message_uber {
587 	struct nvsp_4_send_vf_association vf_assoc;
588 	struct nvsp_4_sw_datapath active_dp;
589 } __packed;
590 
591 enum nvsp_subchannel_operation {
592 	NVSP_SUBCHANNEL_NONE = 0,
593 	NVSP_SUBCHANNEL_ALLOCATE,
594 	NVSP_SUBCHANNEL_MAX
595 };
596 
597 struct nvsp_5_subchannel_request {
598 	u32 op;
599 	u32 num_subchannels;
600 } __packed;
601 
602 struct nvsp_5_subchannel_complete {
603 	u32 status;
604 	u32 num_subchannels; /* Actual number of subchannels allocated */
605 } __packed;
606 
607 struct nvsp_5_send_indirect_table {
608 	/* The number of entries in the send indirection table */
609 	u32 count;
610 
611 	/* The offset of the send indirection table from the beginning of
612 	 * struct nvsp_message.
613 	 * The send indirection table tells which channel to put the send
614 	 * traffic on. Each entry is a channel number.
615 	 */
616 	u32 offset;
617 } __packed;
618 
619 union nvsp_5_message_uber {
620 	struct nvsp_5_subchannel_request subchn_req;
621 	struct nvsp_5_subchannel_complete subchn_comp;
622 	struct nvsp_5_send_indirect_table send_table;
623 } __packed;
624 
625 enum nvsp_6_pd_api_op {
626 	PD_API_OP_CONFIG = 1,
627 	PD_API_OP_SW_DATAPATH, /* Switch Datapath */
628 	PD_API_OP_OPEN_PROVIDER,
629 	PD_API_OP_CLOSE_PROVIDER,
630 	PD_API_OP_CREATE_QUEUE,
631 	PD_API_OP_FLUSH_QUEUE,
632 	PD_API_OP_FREE_QUEUE,
633 	PD_API_OP_ALLOC_COM_BUF, /* Allocate Common Buffer */
634 	PD_API_OP_FREE_COM_BUF, /* Free Common Buffer */
635 	PD_API_OP_MAX
636 };
637 
638 struct grp_affinity {
639 	u64 mask;
640 	u16 grp;
641 	u16 reserved[3];
642 } __packed;
643 
644 struct nvsp_6_pd_api_req {
645 	u32 op;
646 
647 	union {
648 		/* MMIO information is sent from the VM to VSP */
649 		struct __packed {
650 			u64 mmio_pa; /* MMIO Physical Address */
651 			u32 mmio_len;
652 
653 			/* Number of PD queues a VM can support */
654 			u16 num_subchn;
655 		} config;
656 
657 		/* Switch Datapath */
658 		struct __packed {
659 			/* Host Datapath Is PacketDirect */
660 			u8 host_dpath_is_pd;
661 
662 			/* Guest PacketDirect Is Enabled */
663 			u8 guest_pd_enabled;
664 		} sw_dpath;
665 
666 		/* Open Provider*/
667 		struct __packed {
668 			u32 prov_id; /* Provider id */
669 			u32 flag;
670 		} open_prov;
671 
672 		/* Close Provider */
673 		struct __packed {
674 			u32 prov_id;
675 		} cls_prov;
676 
677 		/* Create Queue*/
678 		struct __packed {
679 			u32 prov_id;
680 			u16 q_id;
681 			u16 q_size;
682 			u8 is_recv_q;
683 			u8 is_rss_q;
684 			u32 recv_data_len;
685 			struct grp_affinity affy;
686 		} cr_q;
687 
688 		/* Delete Queue*/
689 		struct __packed {
690 			u32 prov_id;
691 			u16 q_id;
692 		} del_q;
693 
694 		/* Flush Queue */
695 		struct __packed {
696 			u32 prov_id;
697 			u16 q_id;
698 		} flush_q;
699 
700 		/* Allocate Common Buffer */
701 		struct __packed {
702 			u32 len;
703 			u32 pf_node; /* Preferred Node */
704 			u16 region_id;
705 		} alloc_com_buf;
706 
707 		/* Free Common Buffer */
708 		struct __packed {
709 			u32 len;
710 			u64 pa; /* Physical Address */
711 			u32 pf_node; /* Preferred Node */
712 			u16 region_id;
713 			u8 cache_type;
714 		} free_com_buf;
715 	} __packed;
716 } __packed;
717 
718 struct nvsp_6_pd_api_comp {
719 	u32 op;
720 	u32 status;
721 
722 	union {
723 		struct __packed {
724 			/* actual number of PD queues allocated to the VM */
725 			u16 num_pd_q;
726 
727 			/* Num Receive Rss PD Queues */
728 			u8 num_rss_q;
729 
730 			u8 is_supported; /* Is supported by VSP */
731 			u8 is_enabled; /* Is enabled by VSP */
732 		} config;
733 
734 		/* Open Provider */
735 		struct __packed {
736 			u32 prov_id;
737 		} open_prov;
738 
739 		/* Create Queue */
740 		struct __packed {
741 			u32 prov_id;
742 			u16 q_id;
743 			u16 q_size;
744 			u32 recv_data_len;
745 			struct grp_affinity affy;
746 		} cr_q;
747 
748 		/* Allocate Common Buffer */
749 		struct __packed {
750 			u64 pa; /* Physical Address */
751 			u32 len;
752 			u32 pf_node; /* Preferred Node */
753 			u16 region_id;
754 			u8 cache_type;
755 		} alloc_com_buf;
756 	} __packed;
757 } __packed;
758 
759 struct nvsp_6_pd_buf {
760 	u32 region_offset;
761 	u16 region_id;
762 	u16 is_partial:1;
763 	u16 reserved:15;
764 } __packed;
765 
766 struct nvsp_6_pd_batch_msg {
767 	struct nvsp_message_header hdr;
768 	u16 count;
769 	u16 guest2host:1;
770 	u16 is_recv:1;
771 	u16 reserved:14;
772 	struct nvsp_6_pd_buf pd_buf[0];
773 } __packed;
774 
775 union nvsp_6_message_uber {
776 	struct nvsp_6_pd_api_req pd_req;
777 	struct nvsp_6_pd_api_comp pd_comp;
778 } __packed;
779 
780 union nvsp_all_messages {
781 	union nvsp_message_init_uber init_msg;
782 	union nvsp_1_message_uber v1_msg;
783 	union nvsp_2_message_uber v2_msg;
784 	union nvsp_4_message_uber v4_msg;
785 	union nvsp_5_message_uber v5_msg;
786 	union nvsp_6_message_uber v6_msg;
787 } __packed;
788 
789 /* ALL Messages */
790 struct nvsp_message {
791 	struct nvsp_message_header hdr;
792 	union nvsp_all_messages msg;
793 } __packed;
794 
795 
796 #define NETVSC_MTU 65535
797 #define NETVSC_MTU_MIN ETH_MIN_MTU
798 
799 /* Max buffer sizes allowed by a host */
800 #define NETVSC_RECEIVE_BUFFER_SIZE		(1024 * 1024 * 31) /* 31MB */
801 #define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY	(1024 * 1024 * 15) /* 15MB */
802 #define NETVSC_RECEIVE_BUFFER_DEFAULT		(1024 * 1024 * 16)
803 
804 #define NETVSC_SEND_BUFFER_SIZE			(1024 * 1024 * 15)  /* 15MB */
805 #define NETVSC_SEND_BUFFER_DEFAULT		(1024 * 1024)
806 
807 #define NETVSC_INVALID_INDEX			-1
808 
809 #define NETVSC_SEND_SECTION_SIZE		6144
810 #define NETVSC_RECV_SECTION_SIZE		1728
811 
812 /* Default size of TX buf: 1MB, RX buf: 16MB */
813 #define NETVSC_MIN_TX_SECTIONS	10
814 #define NETVSC_DEFAULT_TX	(NETVSC_SEND_BUFFER_DEFAULT \
815 				 / NETVSC_SEND_SECTION_SIZE)
816 #define NETVSC_MIN_RX_SECTIONS	10
817 #define NETVSC_DEFAULT_RX	(NETVSC_RECEIVE_BUFFER_DEFAULT \
818 				 / NETVSC_RECV_SECTION_SIZE)
819 
820 #define NETVSC_RECEIVE_BUFFER_ID		0xcafe
821 #define NETVSC_SEND_BUFFER_ID			0
822 
823 #define NETVSC_SUPPORTED_HW_FEATURES (NETIF_F_RXCSUM | NETIF_F_IP_CSUM | \
824 				      NETIF_F_TSO | NETIF_F_IPV6_CSUM | \
825 				      NETIF_F_TSO6 | NETIF_F_LRO | \
826 				      NETIF_F_SG | NETIF_F_RXHASH)
827 
828 #define VRSS_SEND_TAB_SIZE 16  /* must be power of 2 */
829 #define VRSS_CHANNEL_MAX 64
830 #define VRSS_CHANNEL_DEFAULT 8
831 
832 #define RNDIS_MAX_PKT_DEFAULT 8
833 #define RNDIS_PKT_ALIGN_DEFAULT 8
834 
835 struct multi_send_data {
836 	struct sk_buff *skb; /* skb containing the pkt */
837 	struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
838 	u32 count; /* counter of batched packets */
839 };
840 
841 struct recv_comp_data {
842 	u64 tid; /* transaction id */
843 	u32 status;
844 };
845 
846 struct multi_recv_comp {
847 	struct recv_comp_data *slots;
848 	u32 first;	/* first data entry */
849 	u32 next;	/* next entry for writing */
850 };
851 
852 #define NVSP_RSC_MAX 562 /* Max #RSC frags in a vmbus xfer page pkt */
853 
854 struct nvsc_rsc {
855 	const struct ndis_pkt_8021q_info *vlan;
856 	const struct ndis_tcp_ip_checksum_info *csum_info;
857 	const u32 *hash_info;
858 	u8 is_last; /* last RNDIS msg in a vmtransfer_page */
859 	u32 cnt; /* #fragments in an RSC packet */
860 	u32 pktlen; /* Full packet length */
861 	void *data[NVSP_RSC_MAX];
862 	u32 len[NVSP_RSC_MAX];
863 };
864 
865 struct netvsc_stats {
866 	u64 packets;
867 	u64 bytes;
868 	u64 broadcast;
869 	u64 multicast;
870 	struct u64_stats_sync syncp;
871 };
872 
873 struct netvsc_ethtool_stats {
874 	unsigned long tx_scattered;
875 	unsigned long tx_no_memory;
876 	unsigned long tx_no_space;
877 	unsigned long tx_too_big;
878 	unsigned long tx_busy;
879 	unsigned long tx_send_full;
880 	unsigned long rx_comp_busy;
881 	unsigned long rx_no_memory;
882 	unsigned long stop_queue;
883 	unsigned long wake_queue;
884 };
885 
886 struct netvsc_ethtool_pcpu_stats {
887 	u64     rx_packets;
888 	u64     rx_bytes;
889 	u64     tx_packets;
890 	u64     tx_bytes;
891 	u64     vf_rx_packets;
892 	u64     vf_rx_bytes;
893 	u64     vf_tx_packets;
894 	u64     vf_tx_bytes;
895 };
896 
897 struct netvsc_vf_pcpu_stats {
898 	u64     rx_packets;
899 	u64     rx_bytes;
900 	u64     tx_packets;
901 	u64     tx_bytes;
902 	struct u64_stats_sync   syncp;
903 	u32	tx_dropped;
904 };
905 
906 struct netvsc_reconfig {
907 	struct list_head list;
908 	u32 event;
909 };
910 
911 /* L4 hash bits for different protocols */
912 #define HV_TCP4_L4HASH 1
913 #define HV_TCP6_L4HASH 2
914 #define HV_UDP4_L4HASH 4
915 #define HV_UDP6_L4HASH 8
916 #define HV_DEFAULT_L4HASH (HV_TCP4_L4HASH | HV_TCP6_L4HASH | HV_UDP4_L4HASH | \
917 			   HV_UDP6_L4HASH)
918 
919 /* The context of the netvsc device  */
920 struct net_device_context {
921 	/* point back to our device context */
922 	struct hv_device *device_ctx;
923 	/* netvsc_device */
924 	struct netvsc_device __rcu *nvdev;
925 	/* list of netvsc net_devices */
926 	struct list_head list;
927 	/* reconfigure work */
928 	struct delayed_work dwork;
929 	/* last reconfig time */
930 	unsigned long last_reconfig;
931 	/* reconfig events */
932 	struct list_head reconfig_events;
933 	/* list protection */
934 	spinlock_t lock;
935 
936 	u32 msg_enable; /* debug level */
937 
938 	u32 tx_checksum_mask;
939 
940 	u32 tx_table[VRSS_SEND_TAB_SIZE];
941 
942 	u16 rx_table[ITAB_NUM];
943 
944 	/* Ethtool settings */
945 	u8 duplex;
946 	u32 speed;
947 	u32 l4_hash; /* L4 hash settings */
948 	struct netvsc_ethtool_stats eth_stats;
949 
950 	/* State to manage the associated VF interface. */
951 	struct net_device __rcu *vf_netdev;
952 	struct netvsc_vf_pcpu_stats __percpu *vf_stats;
953 	struct delayed_work vf_takeover;
954 
955 	/* 1: allocated, serial number is valid. 0: not allocated */
956 	u32 vf_alloc;
957 	/* Serial number of the VF to team with */
958 	u32 vf_serial;
959 
960 	/* Used to temporarily save the config info across hibernation */
961 	struct netvsc_device_info *saved_netvsc_dev_info;
962 };
963 
964 /* Per channel data */
965 struct netvsc_channel {
966 	struct vmbus_channel *channel;
967 	struct netvsc_device *net_device;
968 	const struct vmpacket_descriptor *desc;
969 	struct napi_struct napi;
970 	struct multi_send_data msd;
971 	struct multi_recv_comp mrc;
972 	atomic_t queue_sends;
973 	struct nvsc_rsc rsc;
974 
975 	struct netvsc_stats tx_stats;
976 	struct netvsc_stats rx_stats;
977 };
978 
979 /* Per netvsc device */
980 struct netvsc_device {
981 	u32 nvsp_version;
982 
983 	wait_queue_head_t wait_drain;
984 	bool destroy;
985 	bool tx_disable; /* if true, do not wake up queue again */
986 
987 	/* Receive buffer allocated by us but manages by NetVSP */
988 	void *recv_buf;
989 	u32 recv_buf_size; /* allocated bytes */
990 	u32 recv_buf_gpadl_handle;
991 	u32 recv_section_cnt;
992 	u32 recv_section_size;
993 	u32 recv_completion_cnt;
994 
995 	/* Send buffer allocated by us */
996 	void *send_buf;
997 	u32 send_buf_gpadl_handle;
998 	u32 send_section_cnt;
999 	u32 send_section_size;
1000 	unsigned long *send_section_map;
1001 
1002 	/* Used for NetVSP initialization protocol */
1003 	struct completion channel_init_wait;
1004 	struct nvsp_message channel_init_pkt;
1005 
1006 	struct nvsp_message revoke_packet;
1007 
1008 	u32 max_chn;
1009 	u32 num_chn;
1010 
1011 	atomic_t open_chn;
1012 	struct work_struct subchan_work;
1013 	wait_queue_head_t subchan_open;
1014 
1015 	struct rndis_device *extension;
1016 
1017 	u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
1018 	u32 pkt_align; /* alignment bytes, e.g. 8 */
1019 
1020 	struct netvsc_channel chan_table[VRSS_CHANNEL_MAX];
1021 
1022 	struct rcu_head rcu;
1023 };
1024 
1025 /* NdisInitialize message */
1026 struct rndis_initialize_request {
1027 	u32 req_id;
1028 	u32 major_ver;
1029 	u32 minor_ver;
1030 	u32 max_xfer_size;
1031 };
1032 
1033 /* Response to NdisInitialize */
1034 struct rndis_initialize_complete {
1035 	u32 req_id;
1036 	u32 status;
1037 	u32 major_ver;
1038 	u32 minor_ver;
1039 	u32 dev_flags;
1040 	u32 medium;
1041 	u32 max_pkt_per_msg;
1042 	u32 max_xfer_size;
1043 	u32 pkt_alignment_factor;
1044 	u32 af_list_offset;
1045 	u32 af_list_size;
1046 };
1047 
1048 /* Call manager devices only: Information about an address family */
1049 /* supported by the device is appended to the response to NdisInitialize. */
1050 struct rndis_co_address_family {
1051 	u32 address_family;
1052 	u32 major_ver;
1053 	u32 minor_ver;
1054 };
1055 
1056 /* NdisHalt message */
1057 struct rndis_halt_request {
1058 	u32 req_id;
1059 };
1060 
1061 /* NdisQueryRequest message */
1062 struct rndis_query_request {
1063 	u32 req_id;
1064 	u32 oid;
1065 	u32 info_buflen;
1066 	u32 info_buf_offset;
1067 	u32 dev_vc_handle;
1068 };
1069 
1070 /* Response to NdisQueryRequest */
1071 struct rndis_query_complete {
1072 	u32 req_id;
1073 	u32 status;
1074 	u32 info_buflen;
1075 	u32 info_buf_offset;
1076 };
1077 
1078 /* NdisSetRequest message */
1079 struct rndis_set_request {
1080 	u32 req_id;
1081 	u32 oid;
1082 	u32 info_buflen;
1083 	u32 info_buf_offset;
1084 	u32 dev_vc_handle;
1085 };
1086 
1087 /* Response to NdisSetRequest */
1088 struct rndis_set_complete {
1089 	u32 req_id;
1090 	u32 status;
1091 };
1092 
1093 /* NdisReset message */
1094 struct rndis_reset_request {
1095 	u32 reserved;
1096 };
1097 
1098 /* Response to NdisReset */
1099 struct rndis_reset_complete {
1100 	u32 status;
1101 	u32 addressing_reset;
1102 };
1103 
1104 /* NdisMIndicateStatus message */
1105 struct rndis_indicate_status {
1106 	u32 status;
1107 	u32 status_buflen;
1108 	u32 status_buf_offset;
1109 };
1110 
1111 /* Diagnostic information passed as the status buffer in */
1112 /* struct rndis_indicate_status messages signifying error conditions. */
1113 struct rndis_diagnostic_info {
1114 	u32 diag_status;
1115 	u32 error_offset;
1116 };
1117 
1118 /* NdisKeepAlive message */
1119 struct rndis_keepalive_request {
1120 	u32 req_id;
1121 };
1122 
1123 /* Response to NdisKeepAlive */
1124 struct rndis_keepalive_complete {
1125 	u32 req_id;
1126 	u32 status;
1127 };
1128 
1129 /*
1130  * Data message. All Offset fields contain byte offsets from the beginning of
1131  * struct rndis_packet. All Length fields are in bytes.  VcHandle is set
1132  * to 0 for connectionless data, otherwise it contains the VC handle.
1133  */
1134 struct rndis_packet {
1135 	u32 data_offset;
1136 	u32 data_len;
1137 	u32 oob_data_offset;
1138 	u32 oob_data_len;
1139 	u32 num_oob_data_elements;
1140 	u32 per_pkt_info_offset;
1141 	u32 per_pkt_info_len;
1142 	u32 vc_handle;
1143 	u32 reserved;
1144 };
1145 
1146 /* Optional Out of Band data associated with a Data message. */
1147 struct rndis_oobd {
1148 	u32 size;
1149 	u32 type;
1150 	u32 class_info_offset;
1151 };
1152 
1153 /* Packet extension field contents associated with a Data message. */
1154 struct rndis_per_packet_info {
1155 	u32 size;
1156 	u32 type:31;
1157 	u32 internal:1;
1158 	u32 ppi_offset;
1159 };
1160 
1161 enum ndis_per_pkt_info_type {
1162 	TCPIP_CHKSUM_PKTINFO,
1163 	IPSEC_PKTINFO,
1164 	TCP_LARGESEND_PKTINFO,
1165 	CLASSIFICATION_HANDLE_PKTINFO,
1166 	NDIS_RESERVED,
1167 	SG_LIST_PKTINFO,
1168 	IEEE_8021Q_INFO,
1169 	ORIGINAL_PKTINFO,
1170 	PACKET_CANCEL_ID,
1171 	NBL_HASH_VALUE = PACKET_CANCEL_ID,
1172 	ORIGINAL_NET_BUFLIST,
1173 	CACHED_NET_BUFLIST,
1174 	SHORT_PKT_PADINFO,
1175 	MAX_PER_PKT_INFO
1176 };
1177 
1178 enum rndis_per_pkt_info_interal_type {
1179 	RNDIS_PKTINFO_ID = 1,
1180 	/* Add more members here */
1181 
1182 	RNDIS_PKTINFO_MAX
1183 };
1184 
1185 #define RNDIS_PKTINFO_SUBALLOC BIT(0)
1186 #define RNDIS_PKTINFO_1ST_FRAG BIT(1)
1187 #define RNDIS_PKTINFO_LAST_FRAG BIT(2)
1188 
1189 #define RNDIS_PKTINFO_ID_V1 1
1190 
1191 struct rndis_pktinfo_id {
1192 	u8 ver;
1193 	u8 flag;
1194 	u16 pkt_id;
1195 };
1196 
1197 struct ndis_pkt_8021q_info {
1198 	union {
1199 		struct {
1200 			u32 pri:3; /* User Priority */
1201 			u32 cfi:1; /* Canonical Format ID */
1202 			u32 vlanid:12; /* VLAN ID */
1203 			u32 reserved:16;
1204 		};
1205 		u32 value;
1206 	};
1207 };
1208 
1209 struct ndis_object_header {
1210 	u8 type;
1211 	u8 revision;
1212 	u16 size;
1213 };
1214 
1215 #define NDIS_OBJECT_TYPE_DEFAULT	0x80
1216 #define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
1217 #define NDIS_OFFLOAD_PARAMETERS_REVISION_2 2
1218 #define NDIS_OFFLOAD_PARAMETERS_REVISION_1 1
1219 
1220 #define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
1221 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
1222 #define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED  2
1223 #define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED  2
1224 #define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
1225 #define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
1226 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
1227 #define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
1228 #define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
1229 #define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
1230 
1231 #define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE	1
1232 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4	0
1233 #define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6	1
1234 
1235 #define VERSION_4_OFFLOAD_SIZE			22
1236 /*
1237  * New offload OIDs for NDIS 6
1238  */
1239 #define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
1240 #define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C		/* set only */
1241 #define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
1242 #define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
1243 #define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
1244 #define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
1245 
1246 /*
1247  * OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES
1248  * ndis_type: NDIS_OBJTYPE_OFFLOAD
1249  */
1250 
1251 #define	NDIS_OFFLOAD_ENCAP_NONE		0x0000
1252 #define	NDIS_OFFLOAD_ENCAP_NULL		0x0001
1253 #define	NDIS_OFFLOAD_ENCAP_8023		0x0002
1254 #define	NDIS_OFFLOAD_ENCAP_8023PQ	0x0004
1255 #define	NDIS_OFFLOAD_ENCAP_8023PQ_OOB	0x0008
1256 #define	NDIS_OFFLOAD_ENCAP_RFC1483	0x0010
1257 
1258 struct ndis_csum_offload {
1259 	u32	ip4_txenc;
1260 	u32	ip4_txcsum;
1261 #define	NDIS_TXCSUM_CAP_IP4OPT		0x001
1262 #define	NDIS_TXCSUM_CAP_TCP4OPT		0x004
1263 #define	NDIS_TXCSUM_CAP_TCP4		0x010
1264 #define	NDIS_TXCSUM_CAP_UDP4		0x040
1265 #define	NDIS_TXCSUM_CAP_IP4		0x100
1266 
1267 #define NDIS_TXCSUM_ALL_TCP4	(NDIS_TXCSUM_CAP_TCP4 | NDIS_TXCSUM_CAP_TCP4OPT)
1268 
1269 	u32	ip4_rxenc;
1270 	u32	ip4_rxcsum;
1271 #define	NDIS_RXCSUM_CAP_IP4OPT		0x001
1272 #define	NDIS_RXCSUM_CAP_TCP4OPT		0x004
1273 #define	NDIS_RXCSUM_CAP_TCP4		0x010
1274 #define	NDIS_RXCSUM_CAP_UDP4		0x040
1275 #define	NDIS_RXCSUM_CAP_IP4		0x100
1276 	u32	ip6_txenc;
1277 	u32	ip6_txcsum;
1278 #define	NDIS_TXCSUM_CAP_IP6EXT		0x001
1279 #define	NDIS_TXCSUM_CAP_TCP6OPT		0x004
1280 #define	NDIS_TXCSUM_CAP_TCP6		0x010
1281 #define	NDIS_TXCSUM_CAP_UDP6		0x040
1282 	u32	ip6_rxenc;
1283 	u32	ip6_rxcsum;
1284 #define	NDIS_RXCSUM_CAP_IP6EXT		0x001
1285 #define	NDIS_RXCSUM_CAP_TCP6OPT		0x004
1286 #define	NDIS_RXCSUM_CAP_TCP6		0x010
1287 #define	NDIS_RXCSUM_CAP_UDP6		0x040
1288 
1289 #define NDIS_TXCSUM_ALL_TCP6	(NDIS_TXCSUM_CAP_TCP6 |		\
1290 				 NDIS_TXCSUM_CAP_TCP6OPT |	\
1291 				 NDIS_TXCSUM_CAP_IP6EXT)
1292 };
1293 
1294 struct ndis_lsov1_offload {
1295 	u32	encap;
1296 	u32	maxsize;
1297 	u32	minsegs;
1298 	u32	opts;
1299 };
1300 
1301 struct ndis_ipsecv1_offload {
1302 	u32	encap;
1303 	u32	ah_esp;
1304 	u32	xport_tun;
1305 	u32	ip4_opts;
1306 	u32	flags;
1307 	u32	ip4_ah;
1308 	u32	ip4_esp;
1309 };
1310 
1311 struct ndis_lsov2_offload {
1312 	u32	ip4_encap;
1313 	u32	ip4_maxsz;
1314 	u32	ip4_minsg;
1315 	u32	ip6_encap;
1316 	u32	ip6_maxsz;
1317 	u32	ip6_minsg;
1318 	u32	ip6_opts;
1319 #define	NDIS_LSOV2_CAP_IP6EXT		0x001
1320 #define	NDIS_LSOV2_CAP_TCP6OPT		0x004
1321 
1322 #define NDIS_LSOV2_CAP_IP6		(NDIS_LSOV2_CAP_IP6EXT | \
1323 					 NDIS_LSOV2_CAP_TCP6OPT)
1324 };
1325 
1326 struct ndis_ipsecv2_offload {
1327 	u32	encap;
1328 	u8	ip6;
1329 	u8	ip4opt;
1330 	u8	ip6ext;
1331 	u8	ah;
1332 	u8	esp;
1333 	u8	ah_esp;
1334 	u8	xport;
1335 	u8	tun;
1336 	u8	xport_tun;
1337 	u8	lso;
1338 	u8	extseq;
1339 	u32	udp_esp;
1340 	u32	auth;
1341 	u32	crypto;
1342 	u32	sa_caps;
1343 };
1344 
1345 struct ndis_rsc_offload {
1346 	u8	ip4;
1347 	u8	ip6;
1348 };
1349 
1350 struct ndis_encap_offload {
1351 	u32	flags;
1352 	u32	maxhdr;
1353 };
1354 
1355 struct ndis_offload {
1356 	struct ndis_object_header	header;
1357 	struct ndis_csum_offload	csum;
1358 	struct ndis_lsov1_offload	lsov1;
1359 	struct ndis_ipsecv1_offload	ipsecv1;
1360 	struct ndis_lsov2_offload	lsov2;
1361 	u32				flags;
1362 	/* NDIS >= 6.1 */
1363 	struct ndis_ipsecv2_offload	ipsecv2;
1364 	/* NDIS >= 6.30 */
1365 	struct ndis_rsc_offload		rsc;
1366 	struct ndis_encap_offload	encap_gre;
1367 };
1368 
1369 #define	NDIS_OFFLOAD_SIZE		sizeof(struct ndis_offload)
1370 #define	NDIS_OFFLOAD_SIZE_6_0		offsetof(struct ndis_offload, ipsecv2)
1371 #define	NDIS_OFFLOAD_SIZE_6_1		offsetof(struct ndis_offload, rsc)
1372 
1373 struct ndis_offload_params {
1374 	struct ndis_object_header header;
1375 	u8 ip_v4_csum;
1376 	u8 tcp_ip_v4_csum;
1377 	u8 udp_ip_v4_csum;
1378 	u8 tcp_ip_v6_csum;
1379 	u8 udp_ip_v6_csum;
1380 	u8 lso_v1;
1381 	u8 ip_sec_v1;
1382 	u8 lso_v2_ipv4;
1383 	u8 lso_v2_ipv6;
1384 	u8 tcp_connection_ip_v4;
1385 	u8 tcp_connection_ip_v6;
1386 	u32 flags;
1387 	u8 ip_sec_v2;
1388 	u8 ip_sec_v2_ip_v4;
1389 	struct {
1390 		u8 rsc_ip_v4;
1391 		u8 rsc_ip_v6;
1392 	};
1393 	struct {
1394 		u8 encapsulated_packet_task_offload;
1395 		u8 encapsulation_types;
1396 	};
1397 };
1398 
1399 struct ndis_tcp_ip_checksum_info {
1400 	union {
1401 		struct {
1402 			u32 is_ipv4:1;
1403 			u32 is_ipv6:1;
1404 			u32 tcp_checksum:1;
1405 			u32 udp_checksum:1;
1406 			u32 ip_header_checksum:1;
1407 			u32 reserved:11;
1408 			u32 tcp_header_offset:10;
1409 		} transmit;
1410 		struct {
1411 			u32 tcp_checksum_failed:1;
1412 			u32 udp_checksum_failed:1;
1413 			u32 ip_checksum_failed:1;
1414 			u32 tcp_checksum_succeeded:1;
1415 			u32 udp_checksum_succeeded:1;
1416 			u32 ip_checksum_succeeded:1;
1417 			u32 loopback:1;
1418 			u32 tcp_checksum_value_invalid:1;
1419 			u32 ip_checksum_value_invalid:1;
1420 		} receive;
1421 		u32  value;
1422 	};
1423 };
1424 
1425 struct ndis_tcp_lso_info {
1426 	union {
1427 		struct {
1428 			u32 unused:30;
1429 			u32 type:1;
1430 			u32 reserved2:1;
1431 		} transmit;
1432 		struct {
1433 			u32 mss:20;
1434 			u32 tcp_header_offset:10;
1435 			u32 type:1;
1436 			u32 reserved2:1;
1437 		} lso_v1_transmit;
1438 		struct {
1439 			u32 tcp_payload:30;
1440 			u32 type:1;
1441 			u32 reserved2:1;
1442 		} lso_v1_transmit_complete;
1443 		struct {
1444 			u32 mss:20;
1445 			u32 tcp_header_offset:10;
1446 			u32 type:1;
1447 			u32 ip_version:1;
1448 		} lso_v2_transmit;
1449 		struct {
1450 			u32 reserved:30;
1451 			u32 type:1;
1452 			u32 reserved2:1;
1453 		} lso_v2_transmit_complete;
1454 		u32  value;
1455 	};
1456 };
1457 
1458 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1459 		sizeof(struct ndis_pkt_8021q_info))
1460 
1461 #define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1462 		sizeof(struct ndis_tcp_ip_checksum_info))
1463 
1464 #define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1465 		sizeof(struct ndis_tcp_lso_info))
1466 
1467 #define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1468 		sizeof(u32))
1469 
1470 /* Total size of all PPI data */
1471 #define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1472 			   NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1473 
1474 /* Format of Information buffer passed in a SetRequest for the OID */
1475 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1476 struct rndis_config_parameter_info {
1477 	u32 parameter_name_offset;
1478 	u32 parameter_name_length;
1479 	u32 parameter_type;
1480 	u32 parameter_value_offset;
1481 	u32 parameter_value_length;
1482 };
1483 
1484 /* Values for ParameterType in struct rndis_config_parameter_info */
1485 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER     0
1486 #define RNDIS_CONFIG_PARAM_TYPE_STRING      2
1487 
1488 /* CONDIS Miniport messages for connection oriented devices */
1489 /* that do not implement a call manager. */
1490 
1491 /* CoNdisMiniportCreateVc message */
1492 struct rcondis_mp_create_vc {
1493 	u32 req_id;
1494 	u32 ndis_vc_handle;
1495 };
1496 
1497 /* Response to CoNdisMiniportCreateVc */
1498 struct rcondis_mp_create_vc_complete {
1499 	u32 req_id;
1500 	u32 dev_vc_handle;
1501 	u32 status;
1502 };
1503 
1504 /* CoNdisMiniportDeleteVc message */
1505 struct rcondis_mp_delete_vc {
1506 	u32 req_id;
1507 	u32 dev_vc_handle;
1508 };
1509 
1510 /* Response to CoNdisMiniportDeleteVc */
1511 struct rcondis_mp_delete_vc_complete {
1512 	u32 req_id;
1513 	u32 status;
1514 };
1515 
1516 /* CoNdisMiniportQueryRequest message */
1517 struct rcondis_mp_query_request {
1518 	u32 req_id;
1519 	u32 request_type;
1520 	u32 oid;
1521 	u32 dev_vc_handle;
1522 	u32 info_buflen;
1523 	u32 info_buf_offset;
1524 };
1525 
1526 /* CoNdisMiniportSetRequest message */
1527 struct rcondis_mp_set_request {
1528 	u32 req_id;
1529 	u32 request_type;
1530 	u32 oid;
1531 	u32 dev_vc_handle;
1532 	u32 info_buflen;
1533 	u32 info_buf_offset;
1534 };
1535 
1536 /* CoNdisIndicateStatus message */
1537 struct rcondis_indicate_status {
1538 	u32 ndis_vc_handle;
1539 	u32 status;
1540 	u32 status_buflen;
1541 	u32 status_buf_offset;
1542 };
1543 
1544 /* CONDIS Call/VC parameters */
1545 struct rcondis_specific_parameters {
1546 	u32 parameter_type;
1547 	u32 parameter_length;
1548 	u32 parameter_lffset;
1549 };
1550 
1551 struct rcondis_media_parameters {
1552 	u32 flags;
1553 	u32 reserved1;
1554 	u32 reserved2;
1555 	struct rcondis_specific_parameters media_specific;
1556 };
1557 
1558 struct rndis_flowspec {
1559 	u32 token_rate;
1560 	u32 token_bucket_size;
1561 	u32 peak_bandwidth;
1562 	u32 latency;
1563 	u32 delay_variation;
1564 	u32 service_type;
1565 	u32 max_sdu_size;
1566 	u32 minimum_policed_size;
1567 };
1568 
1569 struct rcondis_call_manager_parameters {
1570 	struct rndis_flowspec transmit;
1571 	struct rndis_flowspec receive;
1572 	struct rcondis_specific_parameters call_mgr_specific;
1573 };
1574 
1575 /* CoNdisMiniportActivateVc message */
1576 struct rcondis_mp_activate_vc_request {
1577 	u32 req_id;
1578 	u32 flags;
1579 	u32 dev_vc_handle;
1580 	u32 media_params_offset;
1581 	u32 media_params_length;
1582 	u32 call_mgr_params_offset;
1583 	u32 call_mgr_params_length;
1584 };
1585 
1586 /* Response to CoNdisMiniportActivateVc */
1587 struct rcondis_mp_activate_vc_complete {
1588 	u32 req_id;
1589 	u32 status;
1590 };
1591 
1592 /* CoNdisMiniportDeactivateVc message */
1593 struct rcondis_mp_deactivate_vc_request {
1594 	u32 req_id;
1595 	u32 flags;
1596 	u32 dev_vc_handle;
1597 };
1598 
1599 /* Response to CoNdisMiniportDeactivateVc */
1600 struct rcondis_mp_deactivate_vc_complete {
1601 	u32 req_id;
1602 	u32 status;
1603 };
1604 
1605 
1606 /* union with all of the RNDIS messages */
1607 union rndis_message_container {
1608 	struct rndis_packet pkt;
1609 	struct rndis_initialize_request init_req;
1610 	struct rndis_halt_request halt_req;
1611 	struct rndis_query_request query_req;
1612 	struct rndis_set_request set_req;
1613 	struct rndis_reset_request reset_req;
1614 	struct rndis_keepalive_request keep_alive_req;
1615 	struct rndis_indicate_status indicate_status;
1616 	struct rndis_initialize_complete init_complete;
1617 	struct rndis_query_complete query_complete;
1618 	struct rndis_set_complete set_complete;
1619 	struct rndis_reset_complete reset_complete;
1620 	struct rndis_keepalive_complete keep_alive_complete;
1621 	struct rcondis_mp_create_vc co_miniport_create_vc;
1622 	struct rcondis_mp_delete_vc co_miniport_delete_vc;
1623 	struct rcondis_indicate_status co_indicate_status;
1624 	struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1625 	struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1626 	struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1627 	struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1628 	struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1629 	struct rcondis_mp_deactivate_vc_complete
1630 		co_miniport_deactivate_vc_complete;
1631 };
1632 
1633 /* Remote NDIS message format */
1634 struct rndis_message {
1635 	u32 ndis_msg_type;
1636 
1637 	/* Total length of this message, from the beginning */
1638 	/* of the struct rndis_message, in bytes. */
1639 	u32 msg_len;
1640 
1641 	/* Actual message */
1642 	union rndis_message_container msg;
1643 };
1644 
1645 
1646 /* Handy macros */
1647 
1648 /* get the size of an RNDIS message. Pass in the message type, */
1649 /* struct rndis_set_request, struct rndis_packet for example */
1650 #define RNDIS_MESSAGE_SIZE(msg)				\
1651 	(sizeof(msg) + (sizeof(struct rndis_message) -	\
1652 	 sizeof(union rndis_message_container)))
1653 
1654 #define RNDIS_HEADER_SIZE	(sizeof(struct rndis_message) - \
1655 				 sizeof(union rndis_message_container))
1656 
1657 #define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1658 
1659 #define NDIS_PACKET_TYPE_DIRECTED	0x00000001
1660 #define NDIS_PACKET_TYPE_MULTICAST	0x00000002
1661 #define NDIS_PACKET_TYPE_ALL_MULTICAST	0x00000004
1662 #define NDIS_PACKET_TYPE_BROADCAST	0x00000008
1663 #define NDIS_PACKET_TYPE_SOURCE_ROUTING	0x00000010
1664 #define NDIS_PACKET_TYPE_PROMISCUOUS	0x00000020
1665 #define NDIS_PACKET_TYPE_SMT		0x00000040
1666 #define NDIS_PACKET_TYPE_ALL_LOCAL	0x00000080
1667 #define NDIS_PACKET_TYPE_GROUP		0x00000100
1668 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL	0x00000200
1669 #define NDIS_PACKET_TYPE_FUNCTIONAL	0x00000400
1670 #define NDIS_PACKET_TYPE_MAC_FRAME	0x00000800
1671 
1672 #define TRANSPORT_INFO_NOT_IP   0
1673 #define TRANSPORT_INFO_IPV4_TCP 0x01
1674 #define TRANSPORT_INFO_IPV4_UDP 0x02
1675 #define TRANSPORT_INFO_IPV6_TCP 0x10
1676 #define TRANSPORT_INFO_IPV6_UDP 0x20
1677 
1678 #endif /* _HYPERV_NET_H */
1679