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