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