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