hyperv_net.h

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