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