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