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