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