Linux Audio

Check our new training course

Loading...
v3.15
   1/*
   2 *
   3 * Copyright (c) 2011, Microsoft Corporation.
   4 *
   5 * This program is free software; you can redistribute it and/or modify it
   6 * under the terms and conditions of the GNU General Public License,
   7 * version 2, as published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope it will be useful, but WITHOUT
  10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12 * more details.
  13 *
  14 * You should have received a copy of the GNU General Public License along with
  15 * this program; if not, see <http://www.gnu.org/licenses/>.
  16 *
  17 * Authors:
  18 *   Haiyang Zhang <haiyangz@microsoft.com>
  19 *   Hank Janssen  <hjanssen@microsoft.com>
  20 *   K. Y. Srinivasan <kys@microsoft.com>
  21 *
  22 */
  23
  24#ifndef _HYPERV_NET_H
  25#define _HYPERV_NET_H
  26
  27#include <linux/list.h>
  28#include <linux/hyperv.h>
  29#include <linux/rndis.h>
  30
  31/* Fwd declaration */
  32struct hv_netvsc_packet;
  33struct ndis_tcp_ip_checksum_info;
  34
  35/* Represent the xfer page packet which contains 1 or more netvsc packet */
  36struct xferpage_packet {
  37	struct list_head list_ent;
  38	u32 status;
  39
  40	/* # of netvsc packets this xfer packet contains */
  41	u32 count;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  42};
  43
 
 
 
  44/*
  45 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
  46 * within the RNDIS
 
 
 
  47 */
  48struct hv_netvsc_packet {
  49	/* Bookkeeping stuff */
  50	struct list_head list_ent;
  51	u32 status;
  52
  53	struct hv_device *device;
  54	bool is_data_pkt;
  55	u16 vlan_tci;
  56
  57	/*
  58	 * Valid only for receives when we break a xfer page packet
  59	 * into multiple netvsc packets
  60	 */
  61	struct xferpage_packet *xfer_page_pkt;
  62
  63	union {
  64		struct {
  65			u64 recv_completion_tid;
  66			void *recv_completion_ctx;
  67			void (*recv_completion)(void *context);
  68		} recv;
  69		struct {
  70			u64 send_completion_tid;
  71			void *send_completion_ctx;
  72			void (*send_completion)(void *context);
  73		} send;
  74	} completion;
  75
  76	/* This points to the memory after page_buf */
  77	struct rndis_message *rndis_msg;
  78
  79	u32 total_data_buflen;
  80	/* Points to the send/receive buffer where the ethernet frame is */
  81	void *data;
  82	u32 page_buf_cnt;
  83	struct hv_page_buffer page_buf[0];
  84};
  85
  86struct netvsc_device_info {
  87	unsigned char mac_adr[ETH_ALEN];
  88	bool link_state;	/* 0 - link up, 1 - link down */
  89	int  ring_size;
 
 
  90};
  91
  92enum rndis_device_state {
  93	RNDIS_DEV_UNINITIALIZED = 0,
  94	RNDIS_DEV_INITIALIZING,
  95	RNDIS_DEV_INITIALIZED,
  96	RNDIS_DEV_DATAINITIALIZED,
  97};
  98
  99struct rndis_device {
 100	struct netvsc_device *net_dev;
 101
 102	enum rndis_device_state state;
 103	bool link_state;
 104	atomic_t new_req_id;
 105
 106	spinlock_t request_lock;
 107	struct list_head req_list;
 108
 109	unsigned char hw_mac_adr[ETH_ALEN];
 110};
 111
 112
 113/* Interface */
 
 
 114int netvsc_device_add(struct hv_device *device, void *additional_info);
 115int netvsc_device_remove(struct hv_device *device);
 116int netvsc_send(struct hv_device *device,
 117		struct hv_netvsc_packet *packet);
 
 
 
 118void netvsc_linkstatus_callback(struct hv_device *device_obj,
 119				unsigned int status);
 120int netvsc_recv_callback(struct hv_device *device_obj,
 121			struct hv_netvsc_packet *packet,
 122			struct ndis_tcp_ip_checksum_info *csum_info);
 123int rndis_filter_open(struct hv_device *dev);
 124int rndis_filter_close(struct hv_device *dev);
 
 
 
 
 125int rndis_filter_device_add(struct hv_device *dev,
 126			void *additional_info);
 127void rndis_filter_device_remove(struct hv_device *dev);
 128int rndis_filter_receive(struct hv_device *dev,
 129			struct hv_netvsc_packet *pkt);
 
 
 130
 131int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
 132int rndis_filter_set_device_mac(struct hv_device *hdev, char *mac);
 133
 
 134
 135#define NVSP_INVALID_PROTOCOL_VERSION	((u32)0xFFFFFFFF)
 136
 137#define NVSP_PROTOCOL_VERSION_1		2
 138#define NVSP_PROTOCOL_VERSION_2		0x30002
 139#define NVSP_PROTOCOL_VERSION_4		0x40000
 140#define NVSP_PROTOCOL_VERSION_5		0x50000
 141
 142enum {
 143	NVSP_MSG_TYPE_NONE = 0,
 144
 145	/* Init Messages */
 146	NVSP_MSG_TYPE_INIT			= 1,
 147	NVSP_MSG_TYPE_INIT_COMPLETE		= 2,
 148
 149	NVSP_VERSION_MSG_START			= 100,
 150
 151	/* Version 1 Messages */
 152	NVSP_MSG1_TYPE_SEND_NDIS_VER		= NVSP_VERSION_MSG_START,
 153
 154	NVSP_MSG1_TYPE_SEND_RECV_BUF,
 155	NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
 156	NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
 157
 158	NVSP_MSG1_TYPE_SEND_SEND_BUF,
 159	NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
 160	NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
 161
 162	NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
 163	NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
 164
 165	/* Version 2 messages */
 166	NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
 167	NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
 168	NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
 169
 170	NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
 171
 172	NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
 173	NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
 174
 175	NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
 176
 177	NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
 178	NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
 179
 180	NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
 181	NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
 182
 183	NVSP_MSG2_TYPE_ALLOC_RXBUF,
 184	NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
 185
 186	NVSP_MSG2_TYPE_FREE_RXBUF,
 187
 188	NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
 189	NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
 190
 191	NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
 192
 193	NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
 194	NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 195
 196	NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 197
 198	/* Version 4 messages */
 199	NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
 200	NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
 201	NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 202
 203	NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 204
 205	/* Version 5 messages */
 206	NVSP_MSG5_TYPE_OID_QUERY_EX,
 207	NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
 208	NVSP_MSG5_TYPE_SUBCHANNEL,
 209	NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 210
 211	NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 212};
 213
 214enum {
 215	NVSP_STAT_NONE = 0,
 216	NVSP_STAT_SUCCESS,
 217	NVSP_STAT_FAIL,
 218	NVSP_STAT_PROTOCOL_TOO_NEW,
 219	NVSP_STAT_PROTOCOL_TOO_OLD,
 220	NVSP_STAT_INVALID_RNDIS_PKT,
 221	NVSP_STAT_BUSY,
 222	NVSP_STAT_PROTOCOL_UNSUPPORTED,
 223	NVSP_STAT_MAX,
 224};
 225
 226struct nvsp_message_header {
 227	u32 msg_type;
 228};
 229
 230/* Init Messages */
 231
 232/*
 233 * This message is used by the VSC to initialize the channel after the channels
 234 * has been opened. This message should never include anything other then
 235 * versioning (i.e. this message will be the same for ever).
 236 */
 237struct nvsp_message_init {
 238	u32 min_protocol_ver;
 239	u32 max_protocol_ver;
 240} __packed;
 241
 242/*
 243 * This message is used by the VSP to complete the initialization of the
 244 * channel. This message should never include anything other then versioning
 245 * (i.e. this message will be the same for ever).
 246 */
 247struct nvsp_message_init_complete {
 248	u32 negotiated_protocol_ver;
 249	u32 max_mdl_chain_len;
 250	u32 status;
 251} __packed;
 252
 253union nvsp_message_init_uber {
 254	struct nvsp_message_init init;
 255	struct nvsp_message_init_complete init_complete;
 256} __packed;
 257
 258/* Version 1 Messages */
 259
 260/*
 261 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
 262 * can use this information when handling OIDs sent by the VSC.
 263 */
 264struct nvsp_1_message_send_ndis_version {
 265	u32 ndis_major_ver;
 266	u32 ndis_minor_ver;
 267} __packed;
 268
 269/*
 270 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
 271 * can then use the receive buffer to send data to the VSC.
 272 */
 273struct nvsp_1_message_send_receive_buffer {
 274	u32 gpadl_handle;
 275	u16 id;
 276} __packed;
 277
 278struct nvsp_1_receive_buffer_section {
 279	u32 offset;
 280	u32 sub_alloc_size;
 281	u32 num_sub_allocs;
 282	u32 end_offset;
 283} __packed;
 284
 285/*
 286 * This message is used by the VSP to acknowledge a receive buffer send by the
 287 * VSC. This message must be sent by the VSP before the VSP uses the receive
 288 * buffer.
 289 */
 290struct nvsp_1_message_send_receive_buffer_complete {
 291	u32 status;
 292	u32 num_sections;
 293
 294	/*
 295	 * The receive buffer is split into two parts, a large suballocation
 296	 * section and a small suballocation section. These sections are then
 297	 * suballocated by a certain size.
 298	 */
 299
 300	/*
 301	 * For example, the following break up of the receive buffer has 6
 302	 * large suballocations and 10 small suballocations.
 303	 */
 304
 305	/*
 306	 * |            Large Section          |  |   Small Section   |
 307	 * ------------------------------------------------------------
 308	 * |     |     |     |     |     |     |  | | | | | | | | | | |
 309	 * |                                      |
 310	 *  LargeOffset                            SmallOffset
 311	 */
 312
 313	struct nvsp_1_receive_buffer_section sections[1];
 314} __packed;
 315
 316/*
 317 * This message is sent by the VSC to revoke the receive buffer.  After the VSP
 318 * completes this transaction, the vsp should never use the receive buffer
 319 * again.
 320 */
 321struct nvsp_1_message_revoke_receive_buffer {
 322	u16 id;
 323};
 324
 325/*
 326 * This message is used by the VSC to send a send buffer to the VSP. The VSC
 327 * can then use the send buffer to send data to the VSP.
 328 */
 329struct nvsp_1_message_send_send_buffer {
 330	u32 gpadl_handle;
 331	u16 id;
 332} __packed;
 333
 334/*
 335 * This message is used by the VSP to acknowledge a send buffer sent by the
 336 * VSC. This message must be sent by the VSP before the VSP uses the sent
 337 * buffer.
 338 */
 339struct nvsp_1_message_send_send_buffer_complete {
 340	u32 status;
 341
 342	/*
 343	 * The VSC gets to choose the size of the send buffer and the VSP gets
 344	 * to choose the sections size of the buffer.  This was done to enable
 345	 * dynamic reconfigurations when the cost of GPA-direct buffers
 346	 * decreases.
 347	 */
 348	u32 section_size;
 349} __packed;
 350
 351/*
 352 * This message is sent by the VSC to revoke the send buffer.  After the VSP
 353 * completes this transaction, the vsp should never use the send buffer again.
 354 */
 355struct nvsp_1_message_revoke_send_buffer {
 356	u16 id;
 357};
 358
 359/*
 360 * This message is used by both the VSP and the VSC to send a RNDIS message to
 361 * the opposite channel endpoint.
 362 */
 363struct nvsp_1_message_send_rndis_packet {
 364	/*
 365	 * This field is specified by RNIDS. They assume there's two different
 366	 * channels of communication. However, the Network VSP only has one.
 367	 * Therefore, the channel travels with the RNDIS packet.
 368	 */
 369	u32 channel_type;
 370
 371	/*
 372	 * This field is used to send part or all of the data through a send
 373	 * buffer. This values specifies an index into the send buffer. If the
 374	 * index is 0xFFFFFFFF, then the send buffer is not being used and all
 375	 * of the data was sent through other VMBus mechanisms.
 376	 */
 377	u32 send_buf_section_index;
 378	u32 send_buf_section_size;
 379} __packed;
 380
 381/*
 382 * This message is used by both the VSP and the VSC to complete a RNDIS message
 383 * to the opposite channel endpoint. At this point, the initiator of this
 384 * message cannot use any resources associated with the original RNDIS packet.
 385 */
 386struct nvsp_1_message_send_rndis_packet_complete {
 387	u32 status;
 388};
 389
 390union nvsp_1_message_uber {
 391	struct nvsp_1_message_send_ndis_version send_ndis_ver;
 392
 393	struct nvsp_1_message_send_receive_buffer send_recv_buf;
 394	struct nvsp_1_message_send_receive_buffer_complete
 395						send_recv_buf_complete;
 396	struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
 397
 398	struct nvsp_1_message_send_send_buffer send_send_buf;
 399	struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
 400	struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
 401
 402	struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
 403	struct nvsp_1_message_send_rndis_packet_complete
 404						send_rndis_pkt_complete;
 405} __packed;
 406
 407
 408/*
 409 * Network VSP protocol version 2 messages:
 410 */
 411struct nvsp_2_vsc_capability {
 412	union {
 413		u64 data;
 414		struct {
 415			u64 vmq:1;
 416			u64 chimney:1;
 417			u64 sriov:1;
 418			u64 ieee8021q:1;
 419			u64 correlation_id:1;
 
 420		};
 421	};
 422} __packed;
 423
 424struct nvsp_2_send_ndis_config {
 425	u32 mtu;
 426	u32 reserved;
 427	struct nvsp_2_vsc_capability capability;
 428} __packed;
 429
 430/* Allocate receive buffer */
 431struct nvsp_2_alloc_rxbuf {
 432	/* Allocation ID to match the allocation request and response */
 433	u32 alloc_id;
 434
 435	/* Length of the VM shared memory receive buffer that needs to
 436	 * be allocated
 437	 */
 438	u32 len;
 439} __packed;
 440
 441/* Allocate receive buffer complete */
 442struct nvsp_2_alloc_rxbuf_comp {
 443	/* The NDIS_STATUS code for buffer allocation */
 444	u32 status;
 445
 446	u32 alloc_id;
 447
 448	/* GPADL handle for the allocated receive buffer */
 449	u32 gpadl_handle;
 450
 451	/* Receive buffer ID */
 452	u64 recv_buf_id;
 453} __packed;
 454
 455struct nvsp_2_free_rxbuf {
 456	u64 recv_buf_id;
 457} __packed;
 458
 459union nvsp_2_message_uber {
 460	struct nvsp_2_send_ndis_config send_ndis_config;
 461	struct nvsp_2_alloc_rxbuf alloc_rxbuf;
 462	struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
 463	struct nvsp_2_free_rxbuf free_rxbuf;
 464} __packed;
 465
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 466enum nvsp_subchannel_operation {
 467	NVSP_SUBCHANNEL_NONE = 0,
 468	NVSP_SUBCHANNEL_ALLOCATE,
 469	NVSP_SUBCHANNEL_MAX
 470};
 471
 472struct nvsp_5_subchannel_request {
 473	u32 op;
 474	u32 num_subchannels;
 475} __packed;
 476
 477struct nvsp_5_subchannel_complete {
 478	u32 status;
 479	u32 num_subchannels; /* Actual number of subchannels allocated */
 480} __packed;
 481
 482struct nvsp_5_send_indirect_table {
 483	/* The number of entries in the send indirection table */
 484	u32 count;
 485
 486	/* The offset of the send indireciton table from top of this struct.
 487	 * The send indirection table tells which channel to put the send
 488	 * traffic on. Each entry is a channel number.
 489	 */
 490	u32 offset;
 491} __packed;
 492
 493union nvsp_5_message_uber {
 494	struct nvsp_5_subchannel_request subchn_req;
 495	struct nvsp_5_subchannel_complete subchn_comp;
 496	struct nvsp_5_send_indirect_table send_table;
 497} __packed;
 498
 499union nvsp_all_messages {
 500	union nvsp_message_init_uber init_msg;
 501	union nvsp_1_message_uber v1_msg;
 502	union nvsp_2_message_uber v2_msg;
 
 503	union nvsp_5_message_uber v5_msg;
 504} __packed;
 505
 506/* ALL Messages */
 507struct nvsp_message {
 508	struct nvsp_message_header hdr;
 509	union nvsp_all_messages msg;
 510} __packed;
 511
 512
 513#define NETVSC_MTU 65536
 
 514
 515#define NETVSC_RECEIVE_BUFFER_SIZE		(1024*1024*16)	/* 16MB */
 516#define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY	(1024*1024*15)  /* 15MB */
 
 
 
 517
 518#define NETVSC_RECEIVE_BUFFER_ID		0xcafe
 
 519
 520/* Preallocated receive packets */
 521#define NETVSC_RECEIVE_PACKETLIST_COUNT		256
 522
 523#define NETVSC_PACKET_SIZE                      2048
 
 524
 525/* Per netvsc channel-specific */
 526struct netvsc_device {
 527	struct hv_device *dev;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 528
 
 
 
 
 
 
 
 
 
 
 
 529	u32 nvsp_version;
 530
 531	atomic_t num_outstanding_sends;
 532	wait_queue_head_t wait_drain;
 533	bool start_remove;
 534	bool destroy;
 535	/*
 536	 * List of free preallocated hv_netvsc_packet to represent receive
 537	 * packet
 538	 */
 539	struct list_head recv_pkt_list;
 540	spinlock_t recv_pkt_list_lock;
 541
 542	/* Receive buffer allocated by us but manages by NetVSP */
 543	void *recv_buf;
 544	u32 recv_buf_size;
 545	u32 recv_buf_gpadl_handle;
 546	u32 recv_section_cnt;
 547	struct nvsp_1_receive_buffer_section *recv_section;
 548
 
 
 
 
 
 
 
 
 
 549	/* Used for NetVSP initialization protocol */
 550	struct completion channel_init_wait;
 551	struct nvsp_message channel_init_pkt;
 552
 553	struct nvsp_message revoke_packet;
 554	/* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
 555
 556	struct net_device *ndev;
 
 
 
 
 
 
 557
 558	/* Holds rndis device info */
 559	void *extension;
 560	/* The recive buffer for this device */
 561	unsigned char cb_buffer[NETVSC_PACKET_SIZE];
 562};
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 563
 564/* NdisInitialize message */
 565struct rndis_initialize_request {
 566	u32 req_id;
 567	u32 major_ver;
 568	u32 minor_ver;
 569	u32 max_xfer_size;
 570};
 571
 572/* Response to NdisInitialize */
 573struct rndis_initialize_complete {
 574	u32 req_id;
 575	u32 status;
 576	u32 major_ver;
 577	u32 minor_ver;
 578	u32 dev_flags;
 579	u32 medium;
 580	u32 max_pkt_per_msg;
 581	u32 max_xfer_size;
 582	u32 pkt_alignment_factor;
 583	u32 af_list_offset;
 584	u32 af_list_size;
 585};
 586
 587/* Call manager devices only: Information about an address family */
 588/* supported by the device is appended to the response to NdisInitialize. */
 589struct rndis_co_address_family {
 590	u32 address_family;
 591	u32 major_ver;
 592	u32 minor_ver;
 593};
 594
 595/* NdisHalt message */
 596struct rndis_halt_request {
 597	u32 req_id;
 598};
 599
 600/* NdisQueryRequest message */
 601struct rndis_query_request {
 602	u32 req_id;
 603	u32 oid;
 604	u32 info_buflen;
 605	u32 info_buf_offset;
 606	u32 dev_vc_handle;
 607};
 608
 609/* Response to NdisQueryRequest */
 610struct rndis_query_complete {
 611	u32 req_id;
 612	u32 status;
 613	u32 info_buflen;
 614	u32 info_buf_offset;
 615};
 616
 617/* NdisSetRequest message */
 618struct rndis_set_request {
 619	u32 req_id;
 620	u32 oid;
 621	u32 info_buflen;
 622	u32 info_buf_offset;
 623	u32 dev_vc_handle;
 624};
 625
 626/* Response to NdisSetRequest */
 627struct rndis_set_complete {
 628	u32 req_id;
 629	u32 status;
 630};
 631
 632/* NdisReset message */
 633struct rndis_reset_request {
 634	u32 reserved;
 635};
 636
 637/* Response to NdisReset */
 638struct rndis_reset_complete {
 639	u32 status;
 640	u32 addressing_reset;
 641};
 642
 643/* NdisMIndicateStatus message */
 644struct rndis_indicate_status {
 645	u32 status;
 646	u32 status_buflen;
 647	u32 status_buf_offset;
 648};
 649
 650/* Diagnostic information passed as the status buffer in */
 651/* struct rndis_indicate_status messages signifying error conditions. */
 652struct rndis_diagnostic_info {
 653	u32 diag_status;
 654	u32 error_offset;
 655};
 656
 657/* NdisKeepAlive message */
 658struct rndis_keepalive_request {
 659	u32 req_id;
 660};
 661
 662/* Response to NdisKeepAlive */
 663struct rndis_keepalive_complete {
 664	u32 req_id;
 665	u32 status;
 666};
 667
 668/*
 669 * Data message. All Offset fields contain byte offsets from the beginning of
 670 * struct rndis_packet. All Length fields are in bytes.  VcHandle is set
 671 * to 0 for connectionless data, otherwise it contains the VC handle.
 672 */
 673struct rndis_packet {
 674	u32 data_offset;
 675	u32 data_len;
 676	u32 oob_data_offset;
 677	u32 oob_data_len;
 678	u32 num_oob_data_elements;
 679	u32 per_pkt_info_offset;
 680	u32 per_pkt_info_len;
 681	u32 vc_handle;
 682	u32 reserved;
 683};
 684
 685/* Optional Out of Band data associated with a Data message. */
 686struct rndis_oobd {
 687	u32 size;
 688	u32 type;
 689	u32 class_info_offset;
 690};
 691
 692/* Packet extension field contents associated with a Data message. */
 693struct rndis_per_packet_info {
 694	u32 size;
 695	u32 type;
 696	u32 ppi_offset;
 697};
 698
 699enum ndis_per_pkt_info_type {
 700	TCPIP_CHKSUM_PKTINFO,
 701	IPSEC_PKTINFO,
 702	TCP_LARGESEND_PKTINFO,
 703	CLASSIFICATION_HANDLE_PKTINFO,
 704	NDIS_RESERVED,
 705	SG_LIST_PKTINFO,
 706	IEEE_8021Q_INFO,
 707	ORIGINAL_PKTINFO,
 708	PACKET_CANCEL_ID,
 
 709	ORIGINAL_NET_BUFLIST,
 710	CACHED_NET_BUFLIST,
 711	SHORT_PKT_PADINFO,
 712	MAX_PER_PKT_INFO
 713};
 714
 715struct ndis_pkt_8021q_info {
 716	union {
 717		struct {
 718			u32 pri:3; /* User Priority */
 719			u32 cfi:1; /* Canonical Format ID */
 720			u32 vlanid:12; /* VLAN ID */
 721			u32 reserved:16;
 722		};
 723		u32 value;
 724	};
 725};
 726
 727struct ndis_oject_header {
 728	u8 type;
 729	u8 revision;
 730	u16 size;
 731};
 732
 733#define NDIS_OBJECT_TYPE_DEFAULT	0x80
 734#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
 735#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
 736#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
 737#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED  2
 738#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED  2
 739#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
 740#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
 741#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
 742#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
 743#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
 744#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
 745
 746#define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE	1
 747#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4	0
 748#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6	1
 749
 750#define VERSION_4_OFFLOAD_SIZE			22
 751/*
 752 * New offload OIDs for NDIS 6
 753 */
 754#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
 755#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C		/* set only */
 756#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
 757#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
 758#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
 759#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
 760
 761struct ndis_offload_params {
 762	struct ndis_oject_header header;
 763	u8 ip_v4_csum;
 764	u8 tcp_ip_v4_csum;
 765	u8 udp_ip_v4_csum;
 766	u8 tcp_ip_v6_csum;
 767	u8 udp_ip_v6_csum;
 768	u8 lso_v1;
 769	u8 ip_sec_v1;
 770	u8 lso_v2_ipv4;
 771	u8 lso_v2_ipv6;
 772	u8 tcp_connection_ip_v4;
 773	u8 tcp_connection_ip_v6;
 774	u32 flags;
 775	u8 ip_sec_v2;
 776	u8 ip_sec_v2_ip_v4;
 777	struct {
 778		u8 rsc_ip_v4;
 779		u8 rsc_ip_v6;
 780	};
 781	struct {
 782		u8 encapsulated_packet_task_offload;
 783		u8 encapsulation_types;
 784	};
 785};
 786
 787struct ndis_tcp_ip_checksum_info {
 788	union {
 789		struct {
 790			u32 is_ipv4:1;
 791			u32 is_ipv6:1;
 792			u32 tcp_checksum:1;
 793			u32 udp_checksum:1;
 794			u32 ip_header_checksum:1;
 795			u32 reserved:11;
 796			u32 tcp_header_offset:10;
 797		} transmit;
 798		struct {
 799			u32 tcp_checksum_failed:1;
 800			u32 udp_checksum_failed:1;
 801			u32 ip_checksum_failed:1;
 802			u32 tcp_checksum_succeeded:1;
 803			u32 udp_checksum_succeeded:1;
 804			u32 ip_checksum_succeeded:1;
 805			u32 loopback:1;
 806			u32 tcp_checksum_value_invalid:1;
 807			u32 ip_checksum_value_invalid:1;
 808		} receive;
 809		u32  value;
 810	};
 811};
 812
 813struct ndis_tcp_lso_info {
 814	union {
 815		struct {
 816			u32 unused:30;
 817			u32 type:1;
 818			u32 reserved2:1;
 819		} transmit;
 820		struct {
 821			u32 mss:20;
 822			u32 tcp_header_offset:10;
 823			u32 type:1;
 824			u32 reserved2:1;
 825		} lso_v1_transmit;
 826		struct {
 827			u32 tcp_payload:30;
 828			u32 type:1;
 829			u32 reserved2:1;
 830		} lso_v1_transmit_complete;
 831		struct {
 832			u32 mss:20;
 833			u32 tcp_header_offset:10;
 834			u32 type:1;
 835			u32 ip_version:1;
 836		} lso_v2_transmit;
 837		struct {
 838			u32 reserved:30;
 839			u32 type:1;
 840			u32 reserved2:1;
 841		} lso_v2_transmit_complete;
 842		u32  value;
 843	};
 844};
 845
 846#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
 847		sizeof(struct ndis_pkt_8021q_info))
 848
 849#define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
 850		sizeof(struct ndis_tcp_ip_checksum_info))
 851
 852#define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
 853		sizeof(struct ndis_tcp_lso_info))
 854
 
 
 
 
 
 
 
 855/* Format of Information buffer passed in a SetRequest for the OID */
 856/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
 857struct rndis_config_parameter_info {
 858	u32 parameter_name_offset;
 859	u32 parameter_name_length;
 860	u32 parameter_type;
 861	u32 parameter_value_offset;
 862	u32 parameter_value_length;
 863};
 864
 865/* Values for ParameterType in struct rndis_config_parameter_info */
 866#define RNDIS_CONFIG_PARAM_TYPE_INTEGER     0
 867#define RNDIS_CONFIG_PARAM_TYPE_STRING      2
 868
 869/* CONDIS Miniport messages for connection oriented devices */
 870/* that do not implement a call manager. */
 871
 872/* CoNdisMiniportCreateVc message */
 873struct rcondis_mp_create_vc {
 874	u32 req_id;
 875	u32 ndis_vc_handle;
 876};
 877
 878/* Response to CoNdisMiniportCreateVc */
 879struct rcondis_mp_create_vc_complete {
 880	u32 req_id;
 881	u32 dev_vc_handle;
 882	u32 status;
 883};
 884
 885/* CoNdisMiniportDeleteVc message */
 886struct rcondis_mp_delete_vc {
 887	u32 req_id;
 888	u32 dev_vc_handle;
 889};
 890
 891/* Response to CoNdisMiniportDeleteVc */
 892struct rcondis_mp_delete_vc_complete {
 893	u32 req_id;
 894	u32 status;
 895};
 896
 897/* CoNdisMiniportQueryRequest message */
 898struct rcondis_mp_query_request {
 899	u32 req_id;
 900	u32 request_type;
 901	u32 oid;
 902	u32 dev_vc_handle;
 903	u32 info_buflen;
 904	u32 info_buf_offset;
 905};
 906
 907/* CoNdisMiniportSetRequest message */
 908struct rcondis_mp_set_request {
 909	u32 req_id;
 910	u32 request_type;
 911	u32 oid;
 912	u32 dev_vc_handle;
 913	u32 info_buflen;
 914	u32 info_buf_offset;
 915};
 916
 917/* CoNdisIndicateStatus message */
 918struct rcondis_indicate_status {
 919	u32 ndis_vc_handle;
 920	u32 status;
 921	u32 status_buflen;
 922	u32 status_buf_offset;
 923};
 924
 925/* CONDIS Call/VC parameters */
 926struct rcondis_specific_parameters {
 927	u32 parameter_type;
 928	u32 parameter_length;
 929	u32 parameter_lffset;
 930};
 931
 932struct rcondis_media_parameters {
 933	u32 flags;
 934	u32 reserved1;
 935	u32 reserved2;
 936	struct rcondis_specific_parameters media_specific;
 937};
 938
 939struct rndis_flowspec {
 940	u32 token_rate;
 941	u32 token_bucket_size;
 942	u32 peak_bandwidth;
 943	u32 latency;
 944	u32 delay_variation;
 945	u32 service_type;
 946	u32 max_sdu_size;
 947	u32 minimum_policed_size;
 948};
 949
 950struct rcondis_call_manager_parameters {
 951	struct rndis_flowspec transmit;
 952	struct rndis_flowspec receive;
 953	struct rcondis_specific_parameters call_mgr_specific;
 954};
 955
 956/* CoNdisMiniportActivateVc message */
 957struct rcondis_mp_activate_vc_request {
 958	u32 req_id;
 959	u32 flags;
 960	u32 dev_vc_handle;
 961	u32 media_params_offset;
 962	u32 media_params_length;
 963	u32 call_mgr_params_offset;
 964	u32 call_mgr_params_length;
 965};
 966
 967/* Response to CoNdisMiniportActivateVc */
 968struct rcondis_mp_activate_vc_complete {
 969	u32 req_id;
 970	u32 status;
 971};
 972
 973/* CoNdisMiniportDeactivateVc message */
 974struct rcondis_mp_deactivate_vc_request {
 975	u32 req_id;
 976	u32 flags;
 977	u32 dev_vc_handle;
 978};
 979
 980/* Response to CoNdisMiniportDeactivateVc */
 981struct rcondis_mp_deactivate_vc_complete {
 982	u32 req_id;
 983	u32 status;
 984};
 985
 986
 987/* union with all of the RNDIS messages */
 988union rndis_message_container {
 989	struct rndis_packet pkt;
 990	struct rndis_initialize_request init_req;
 991	struct rndis_halt_request halt_req;
 992	struct rndis_query_request query_req;
 993	struct rndis_set_request set_req;
 994	struct rndis_reset_request reset_req;
 995	struct rndis_keepalive_request keep_alive_req;
 996	struct rndis_indicate_status indicate_status;
 997	struct rndis_initialize_complete init_complete;
 998	struct rndis_query_complete query_complete;
 999	struct rndis_set_complete set_complete;
1000	struct rndis_reset_complete reset_complete;
1001	struct rndis_keepalive_complete keep_alive_complete;
1002	struct rcondis_mp_create_vc co_miniport_create_vc;
1003	struct rcondis_mp_delete_vc co_miniport_delete_vc;
1004	struct rcondis_indicate_status co_indicate_status;
1005	struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1006	struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1007	struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1008	struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1009	struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1010	struct rcondis_mp_deactivate_vc_complete
1011		co_miniport_deactivate_vc_complete;
1012};
1013
1014/* Remote NDIS message format */
1015struct rndis_message {
1016	u32 ndis_msg_type;
1017
1018	/* Total length of this message, from the beginning */
1019	/* of the sruct rndis_message, in bytes. */
1020	u32 msg_len;
1021
1022	/* Actual message */
1023	union rndis_message_container msg;
1024};
1025
1026
1027/* Handy macros */
1028
1029/* get the size of an RNDIS message. Pass in the message type, */
1030/* struct rndis_set_request, struct rndis_packet for example */
1031#define RNDIS_MESSAGE_SIZE(msg)				\
1032	(sizeof(msg) + (sizeof(struct rndis_message) -	\
1033	 sizeof(union rndis_message_container)))
1034
1035/* get pointer to info buffer with message pointer */
1036#define MESSAGE_TO_INFO_BUFFER(msg)				\
1037	(((unsigned char *)(msg)) + msg->info_buf_offset)
1038
1039/* get pointer to status buffer with message pointer */
1040#define MESSAGE_TO_STATUS_BUFFER(msg)			\
1041	(((unsigned char *)(msg)) + msg->status_buf_offset)
1042
1043/* get pointer to OOBD buffer with message pointer */
1044#define MESSAGE_TO_OOBD_BUFFER(msg)				\
1045	(((unsigned char *)(msg)) + msg->oob_data_offset)
1046
1047/* get pointer to data buffer with message pointer */
1048#define MESSAGE_TO_DATA_BUFFER(msg)				\
1049	(((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1050
1051/* get pointer to contained message from NDIS_MESSAGE pointer */
1052#define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg)		\
1053	((void *) &rndis_msg->msg)
1054
1055/* get pointer to contained message from NDIS_MESSAGE pointer */
1056#define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg)	\
1057	((void *) rndis_msg)
1058
1059
1060#define __struct_bcount(x)
1061
1062
1063
1064#define RNDIS_HEADER_SIZE	(sizeof(struct rndis_message) - \
1065				 sizeof(union rndis_message_container))
1066
 
 
1067#define NDIS_PACKET_TYPE_DIRECTED	0x00000001
1068#define NDIS_PACKET_TYPE_MULTICAST	0x00000002
1069#define NDIS_PACKET_TYPE_ALL_MULTICAST	0x00000004
1070#define NDIS_PACKET_TYPE_BROADCAST	0x00000008
1071#define NDIS_PACKET_TYPE_SOURCE_ROUTING	0x00000010
1072#define NDIS_PACKET_TYPE_PROMISCUOUS	0x00000020
1073#define NDIS_PACKET_TYPE_SMT		0x00000040
1074#define NDIS_PACKET_TYPE_ALL_LOCAL	0x00000080
1075#define NDIS_PACKET_TYPE_GROUP		0x00000100
1076#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL	0x00000200
1077#define NDIS_PACKET_TYPE_FUNCTIONAL	0x00000400
1078#define NDIS_PACKET_TYPE_MAC_FRAME	0x00000800
1079
1080#define INFO_IPV4       2
1081#define INFO_IPV6       4
1082#define INFO_TCP        2
1083#define INFO_UDP        4
1084
1085#define TRANSPORT_INFO_NOT_IP   0
1086#define TRANSPORT_INFO_IPV4_TCP ((INFO_IPV4 << 16) | INFO_TCP)
1087#define TRANSPORT_INFO_IPV4_UDP ((INFO_IPV4 << 16) | INFO_UDP)
1088#define TRANSPORT_INFO_IPV6_TCP ((INFO_IPV6 << 16) | INFO_TCP)
1089#define TRANSPORT_INFO_IPV6_UDP ((INFO_IPV6 << 16) | INFO_UDP)
1090
1091
1092#endif /* _HYPERV_NET_H */
v4.10.11
   1/*
   2 *
   3 * Copyright (c) 2011, Microsoft Corporation.
   4 *
   5 * This program is free software; you can redistribute it and/or modify it
   6 * under the terms and conditions of the GNU General Public License,
   7 * version 2, as published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope it will be useful, but WITHOUT
  10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12 * more details.
  13 *
  14 * You should have received a copy of the GNU General Public License along with
  15 * this program; if not, see <http://www.gnu.org/licenses/>.
  16 *
  17 * Authors:
  18 *   Haiyang Zhang <haiyangz@microsoft.com>
  19 *   Hank Janssen  <hjanssen@microsoft.com>
  20 *   K. Y. Srinivasan <kys@microsoft.com>
  21 *
  22 */
  23
  24#ifndef _HYPERV_NET_H
  25#define _HYPERV_NET_H
  26
  27#include <linux/list.h>
  28#include <linux/hyperv.h>
  29#include <linux/rndis.h>
  30
  31/* RSS related */
  32#define OID_GEN_RECEIVE_SCALE_CAPABILITIES 0x00010203  /* query only */
  33#define OID_GEN_RECEIVE_SCALE_PARAMETERS 0x00010204  /* query and set */
  34
  35#define NDIS_OBJECT_TYPE_RSS_CAPABILITIES 0x88
  36#define NDIS_OBJECT_TYPE_RSS_PARAMETERS 0x89
 
 
  37
  38#define NDIS_RECEIVE_SCALE_CAPABILITIES_REVISION_2 2
  39#define NDIS_RECEIVE_SCALE_PARAMETERS_REVISION_2 2
  40
  41struct ndis_obj_header {
  42	u8 type;
  43	u8 rev;
  44	u16 size;
  45} __packed;
  46
  47/* ndis_recv_scale_cap/cap_flag */
  48#define NDIS_RSS_CAPS_MESSAGE_SIGNALED_INTERRUPTS 0x01000000
  49#define NDIS_RSS_CAPS_CLASSIFICATION_AT_ISR       0x02000000
  50#define NDIS_RSS_CAPS_CLASSIFICATION_AT_DPC       0x04000000
  51#define NDIS_RSS_CAPS_USING_MSI_X                 0x08000000
  52#define NDIS_RSS_CAPS_RSS_AVAILABLE_ON_PORTS      0x10000000
  53#define NDIS_RSS_CAPS_SUPPORTS_MSI_X              0x20000000
  54#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV4          0x00000100
  55#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6          0x00000200
  56#define NDIS_RSS_CAPS_HASH_TYPE_TCP_IPV6_EX       0x00000400
  57
  58struct ndis_recv_scale_cap { /* NDIS_RECEIVE_SCALE_CAPABILITIES */
  59	struct ndis_obj_header hdr;
  60	u32 cap_flag;
  61	u32 num_int_msg;
  62	u32 num_recv_que;
  63	u16 num_indirect_tabent;
  64} __packed;
  65
  66
  67/* ndis_recv_scale_param flags */
  68#define NDIS_RSS_PARAM_FLAG_BASE_CPU_UNCHANGED     0x0001
  69#define NDIS_RSS_PARAM_FLAG_HASH_INFO_UNCHANGED    0x0002
  70#define NDIS_RSS_PARAM_FLAG_ITABLE_UNCHANGED       0x0004
  71#define NDIS_RSS_PARAM_FLAG_HASH_KEY_UNCHANGED     0x0008
  72#define NDIS_RSS_PARAM_FLAG_DISABLE_RSS            0x0010
  73
  74/* Hash info bits */
  75#define NDIS_HASH_FUNC_TOEPLITZ 0x00000001
  76#define NDIS_HASH_IPV4          0x00000100
  77#define NDIS_HASH_TCP_IPV4      0x00000200
  78#define NDIS_HASH_IPV6          0x00000400
  79#define NDIS_HASH_IPV6_EX       0x00000800
  80#define NDIS_HASH_TCP_IPV6      0x00001000
  81#define NDIS_HASH_TCP_IPV6_EX   0x00002000
  82
  83#define NDIS_RSS_INDIRECTION_TABLE_MAX_SIZE_REVISION_2 (128 * 4)
  84#define NDIS_RSS_HASH_SECRET_KEY_MAX_SIZE_REVISION_2   40
  85
  86#define ITAB_NUM 128
  87
  88struct ndis_recv_scale_param { /* NDIS_RECEIVE_SCALE_PARAMETERS */
  89	struct ndis_obj_header hdr;
  90
  91	/* Qualifies the rest of the information */
  92	u16 flag;
  93
  94	/* The base CPU number to do receive processing. not used */
  95	u16 base_cpu_number;
  96
  97	/* This describes the hash function and type being enabled */
  98	u32 hashinfo;
  99
 100	/* The size of indirection table array */
 101	u16 indirect_tabsize;
 102
 103	/* The offset of the indirection table from the beginning of this
 104	 * structure
 105	 */
 106	u32 indirect_taboffset;
 107
 108	/* The size of the hash secret key */
 109	u16 hashkey_size;
 110
 111	/* The offset of the secret key from the beginning of this structure */
 112	u32 kashkey_offset;
 113
 114	u32 processor_masks_offset;
 115	u32 num_processor_masks;
 116	u32 processor_masks_entry_size;
 117};
 118
 119/* Fwd declaration */
 120struct ndis_tcp_ip_checksum_info;
 121
 122/*
 123 * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
 124 * within the RNDIS
 125 *
 126 * The size of this structure is less than 48 bytes and we can now
 127 * place this structure in the skb->cb field.
 128 */
 129struct hv_netvsc_packet {
 130	/* Bookkeeping stuff */
 131	u8 cp_partial; /* partial copy into send buffer */
 
 132
 133	u8 rmsg_size; /* RNDIS header and PPI size */
 134	u8 rmsg_pgcnt; /* page count of RNDIS header and PPI */
 135	u8 page_buf_cnt;
 136
 137	u16 q_idx;
 138	u32 send_buf_index;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 139
 140	u32 total_data_buflen;
 
 
 
 
 141};
 142
 143struct netvsc_device_info {
 144	unsigned char mac_adr[ETH_ALEN];
 145	bool link_state;	/* 0 - link up, 1 - link down */
 146	int  ring_size;
 147	u32  max_num_vrss_chns;
 148	u32  num_chn;
 149};
 150
 151enum rndis_device_state {
 152	RNDIS_DEV_UNINITIALIZED = 0,
 153	RNDIS_DEV_INITIALIZING,
 154	RNDIS_DEV_INITIALIZED,
 155	RNDIS_DEV_DATAINITIALIZED,
 156};
 157
 158struct rndis_device {
 159	struct net_device *ndev;
 160
 161	enum rndis_device_state state;
 162	bool link_state;
 163	atomic_t new_req_id;
 164
 165	spinlock_t request_lock;
 166	struct list_head req_list;
 167
 168	unsigned char hw_mac_adr[ETH_ALEN];
 169};
 170
 171
 172/* Interface */
 173struct rndis_message;
 174struct netvsc_device;
 175int netvsc_device_add(struct hv_device *device, void *additional_info);
 176void netvsc_device_remove(struct hv_device *device);
 177int netvsc_send(struct hv_device *device,
 178		struct hv_netvsc_packet *packet,
 179		struct rndis_message *rndis_msg,
 180		struct hv_page_buffer **page_buffer,
 181		struct sk_buff *skb);
 182void netvsc_linkstatus_callback(struct hv_device *device_obj,
 183				struct rndis_message *resp);
 184int netvsc_recv_callback(struct hv_device *device_obj,
 185			struct hv_netvsc_packet *packet,
 186			void **data,
 187			struct ndis_tcp_ip_checksum_info *csum_info,
 188			struct vmbus_channel *channel,
 189			u16 vlan_tci);
 190void netvsc_channel_cb(void *context);
 191int rndis_filter_open(struct netvsc_device *nvdev);
 192int rndis_filter_close(struct netvsc_device *nvdev);
 193int rndis_filter_device_add(struct hv_device *dev,
 194			void *additional_info);
 195void rndis_filter_device_remove(struct hv_device *dev);
 196int rndis_filter_receive(struct hv_device *dev,
 197			struct hv_netvsc_packet *pkt,
 198			void **data,
 199			struct vmbus_channel *channel);
 200
 201int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
 202int rndis_filter_set_device_mac(struct net_device *ndev, char *mac);
 203
 204void netvsc_switch_datapath(struct net_device *nv_dev, bool vf);
 205
 206#define NVSP_INVALID_PROTOCOL_VERSION	((u32)0xFFFFFFFF)
 207
 208#define NVSP_PROTOCOL_VERSION_1		2
 209#define NVSP_PROTOCOL_VERSION_2		0x30002
 210#define NVSP_PROTOCOL_VERSION_4		0x40000
 211#define NVSP_PROTOCOL_VERSION_5		0x50000
 212
 213enum {
 214	NVSP_MSG_TYPE_NONE = 0,
 215
 216	/* Init Messages */
 217	NVSP_MSG_TYPE_INIT			= 1,
 218	NVSP_MSG_TYPE_INIT_COMPLETE		= 2,
 219
 220	NVSP_VERSION_MSG_START			= 100,
 221
 222	/* Version 1 Messages */
 223	NVSP_MSG1_TYPE_SEND_NDIS_VER		= NVSP_VERSION_MSG_START,
 224
 225	NVSP_MSG1_TYPE_SEND_RECV_BUF,
 226	NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
 227	NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
 228
 229	NVSP_MSG1_TYPE_SEND_SEND_BUF,
 230	NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
 231	NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
 232
 233	NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
 234	NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
 235
 236	/* Version 2 messages */
 237	NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
 238	NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
 239	NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
 240
 241	NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
 242
 243	NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
 244	NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
 245
 246	NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
 247
 248	NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
 249	NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
 250
 251	NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
 252	NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
 253
 254	NVSP_MSG2_TYPE_ALLOC_RXBUF,
 255	NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
 256
 257	NVSP_MSG2_TYPE_FREE_RXBUF,
 258
 259	NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
 260	NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
 261
 262	NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
 263
 264	NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
 265	NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 266
 267	NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 268
 269	/* Version 4 messages */
 270	NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
 271	NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
 272	NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 273
 274	NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 275
 276	/* Version 5 messages */
 277	NVSP_MSG5_TYPE_OID_QUERY_EX,
 278	NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
 279	NVSP_MSG5_TYPE_SUBCHANNEL,
 280	NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 281
 282	NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 283};
 284
 285enum {
 286	NVSP_STAT_NONE = 0,
 287	NVSP_STAT_SUCCESS,
 288	NVSP_STAT_FAIL,
 289	NVSP_STAT_PROTOCOL_TOO_NEW,
 290	NVSP_STAT_PROTOCOL_TOO_OLD,
 291	NVSP_STAT_INVALID_RNDIS_PKT,
 292	NVSP_STAT_BUSY,
 293	NVSP_STAT_PROTOCOL_UNSUPPORTED,
 294	NVSP_STAT_MAX,
 295};
 296
 297struct nvsp_message_header {
 298	u32 msg_type;
 299};
 300
 301/* Init Messages */
 302
 303/*
 304 * This message is used by the VSC to initialize the channel after the channels
 305 * has been opened. This message should never include anything other then
 306 * versioning (i.e. this message will be the same for ever).
 307 */
 308struct nvsp_message_init {
 309	u32 min_protocol_ver;
 310	u32 max_protocol_ver;
 311} __packed;
 312
 313/*
 314 * This message is used by the VSP to complete the initialization of the
 315 * channel. This message should never include anything other then versioning
 316 * (i.e. this message will be the same for ever).
 317 */
 318struct nvsp_message_init_complete {
 319	u32 negotiated_protocol_ver;
 320	u32 max_mdl_chain_len;
 321	u32 status;
 322} __packed;
 323
 324union nvsp_message_init_uber {
 325	struct nvsp_message_init init;
 326	struct nvsp_message_init_complete init_complete;
 327} __packed;
 328
 329/* Version 1 Messages */
 330
 331/*
 332 * This message is used by the VSC to send the NDIS version to the VSP. The VSP
 333 * can use this information when handling OIDs sent by the VSC.
 334 */
 335struct nvsp_1_message_send_ndis_version {
 336	u32 ndis_major_ver;
 337	u32 ndis_minor_ver;
 338} __packed;
 339
 340/*
 341 * This message is used by the VSC to send a receive buffer to the VSP. The VSP
 342 * can then use the receive buffer to send data to the VSC.
 343 */
 344struct nvsp_1_message_send_receive_buffer {
 345	u32 gpadl_handle;
 346	u16 id;
 347} __packed;
 348
 349struct nvsp_1_receive_buffer_section {
 350	u32 offset;
 351	u32 sub_alloc_size;
 352	u32 num_sub_allocs;
 353	u32 end_offset;
 354} __packed;
 355
 356/*
 357 * This message is used by the VSP to acknowledge a receive buffer send by the
 358 * VSC. This message must be sent by the VSP before the VSP uses the receive
 359 * buffer.
 360 */
 361struct nvsp_1_message_send_receive_buffer_complete {
 362	u32 status;
 363	u32 num_sections;
 364
 365	/*
 366	 * The receive buffer is split into two parts, a large suballocation
 367	 * section and a small suballocation section. These sections are then
 368	 * suballocated by a certain size.
 369	 */
 370
 371	/*
 372	 * For example, the following break up of the receive buffer has 6
 373	 * large suballocations and 10 small suballocations.
 374	 */
 375
 376	/*
 377	 * |            Large Section          |  |   Small Section   |
 378	 * ------------------------------------------------------------
 379	 * |     |     |     |     |     |     |  | | | | | | | | | | |
 380	 * |                                      |
 381	 *  LargeOffset                            SmallOffset
 382	 */
 383
 384	struct nvsp_1_receive_buffer_section sections[1];
 385} __packed;
 386
 387/*
 388 * This message is sent by the VSC to revoke the receive buffer.  After the VSP
 389 * completes this transaction, the vsp should never use the receive buffer
 390 * again.
 391 */
 392struct nvsp_1_message_revoke_receive_buffer {
 393	u16 id;
 394};
 395
 396/*
 397 * This message is used by the VSC to send a send buffer to the VSP. The VSC
 398 * can then use the send buffer to send data to the VSP.
 399 */
 400struct nvsp_1_message_send_send_buffer {
 401	u32 gpadl_handle;
 402	u16 id;
 403} __packed;
 404
 405/*
 406 * This message is used by the VSP to acknowledge a send buffer sent by the
 407 * VSC. This message must be sent by the VSP before the VSP uses the sent
 408 * buffer.
 409 */
 410struct nvsp_1_message_send_send_buffer_complete {
 411	u32 status;
 412
 413	/*
 414	 * The VSC gets to choose the size of the send buffer and the VSP gets
 415	 * to choose the sections size of the buffer.  This was done to enable
 416	 * dynamic reconfigurations when the cost of GPA-direct buffers
 417	 * decreases.
 418	 */
 419	u32 section_size;
 420} __packed;
 421
 422/*
 423 * This message is sent by the VSC to revoke the send buffer.  After the VSP
 424 * completes this transaction, the vsp should never use the send buffer again.
 425 */
 426struct nvsp_1_message_revoke_send_buffer {
 427	u16 id;
 428};
 429
 430/*
 431 * This message is used by both the VSP and the VSC to send a RNDIS message to
 432 * the opposite channel endpoint.
 433 */
 434struct nvsp_1_message_send_rndis_packet {
 435	/*
 436	 * This field is specified by RNDIS. They assume there's two different
 437	 * channels of communication. However, the Network VSP only has one.
 438	 * Therefore, the channel travels with the RNDIS packet.
 439	 */
 440	u32 channel_type;
 441
 442	/*
 443	 * This field is used to send part or all of the data through a send
 444	 * buffer. This values specifies an index into the send buffer. If the
 445	 * index is 0xFFFFFFFF, then the send buffer is not being used and all
 446	 * of the data was sent through other VMBus mechanisms.
 447	 */
 448	u32 send_buf_section_index;
 449	u32 send_buf_section_size;
 450} __packed;
 451
 452/*
 453 * This message is used by both the VSP and the VSC to complete a RNDIS message
 454 * to the opposite channel endpoint. At this point, the initiator of this
 455 * message cannot use any resources associated with the original RNDIS packet.
 456 */
 457struct nvsp_1_message_send_rndis_packet_complete {
 458	u32 status;
 459};
 460
 461union nvsp_1_message_uber {
 462	struct nvsp_1_message_send_ndis_version send_ndis_ver;
 463
 464	struct nvsp_1_message_send_receive_buffer send_recv_buf;
 465	struct nvsp_1_message_send_receive_buffer_complete
 466						send_recv_buf_complete;
 467	struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
 468
 469	struct nvsp_1_message_send_send_buffer send_send_buf;
 470	struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
 471	struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
 472
 473	struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
 474	struct nvsp_1_message_send_rndis_packet_complete
 475						send_rndis_pkt_complete;
 476} __packed;
 477
 478
 479/*
 480 * Network VSP protocol version 2 messages:
 481 */
 482struct nvsp_2_vsc_capability {
 483	union {
 484		u64 data;
 485		struct {
 486			u64 vmq:1;
 487			u64 chimney:1;
 488			u64 sriov:1;
 489			u64 ieee8021q:1;
 490			u64 correlation_id:1;
 491			u64 teaming:1;
 492		};
 493	};
 494} __packed;
 495
 496struct nvsp_2_send_ndis_config {
 497	u32 mtu;
 498	u32 reserved;
 499	struct nvsp_2_vsc_capability capability;
 500} __packed;
 501
 502/* Allocate receive buffer */
 503struct nvsp_2_alloc_rxbuf {
 504	/* Allocation ID to match the allocation request and response */
 505	u32 alloc_id;
 506
 507	/* Length of the VM shared memory receive buffer that needs to
 508	 * be allocated
 509	 */
 510	u32 len;
 511} __packed;
 512
 513/* Allocate receive buffer complete */
 514struct nvsp_2_alloc_rxbuf_comp {
 515	/* The NDIS_STATUS code for buffer allocation */
 516	u32 status;
 517
 518	u32 alloc_id;
 519
 520	/* GPADL handle for the allocated receive buffer */
 521	u32 gpadl_handle;
 522
 523	/* Receive buffer ID */
 524	u64 recv_buf_id;
 525} __packed;
 526
 527struct nvsp_2_free_rxbuf {
 528	u64 recv_buf_id;
 529} __packed;
 530
 531union nvsp_2_message_uber {
 532	struct nvsp_2_send_ndis_config send_ndis_config;
 533	struct nvsp_2_alloc_rxbuf alloc_rxbuf;
 534	struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
 535	struct nvsp_2_free_rxbuf free_rxbuf;
 536} __packed;
 537
 538struct nvsp_4_send_vf_association {
 539	/* 1: allocated, serial number is valid. 0: not allocated */
 540	u32 allocated;
 541
 542	/* Serial number of the VF to team with */
 543	u32 serial;
 544} __packed;
 545
 546enum nvsp_vm_datapath {
 547	NVSP_DATAPATH_SYNTHETIC = 0,
 548	NVSP_DATAPATH_VF,
 549	NVSP_DATAPATH_MAX
 550};
 551
 552struct nvsp_4_sw_datapath {
 553	u32 active_datapath; /* active data path in VM */
 554} __packed;
 555
 556union nvsp_4_message_uber {
 557	struct nvsp_4_send_vf_association vf_assoc;
 558	struct nvsp_4_sw_datapath active_dp;
 559} __packed;
 560
 561enum nvsp_subchannel_operation {
 562	NVSP_SUBCHANNEL_NONE = 0,
 563	NVSP_SUBCHANNEL_ALLOCATE,
 564	NVSP_SUBCHANNEL_MAX
 565};
 566
 567struct nvsp_5_subchannel_request {
 568	u32 op;
 569	u32 num_subchannels;
 570} __packed;
 571
 572struct nvsp_5_subchannel_complete {
 573	u32 status;
 574	u32 num_subchannels; /* Actual number of subchannels allocated */
 575} __packed;
 576
 577struct nvsp_5_send_indirect_table {
 578	/* The number of entries in the send indirection table */
 579	u32 count;
 580
 581	/* The offset of the send indirection table from top of this struct.
 582	 * The send indirection table tells which channel to put the send
 583	 * traffic on. Each entry is a channel number.
 584	 */
 585	u32 offset;
 586} __packed;
 587
 588union nvsp_5_message_uber {
 589	struct nvsp_5_subchannel_request subchn_req;
 590	struct nvsp_5_subchannel_complete subchn_comp;
 591	struct nvsp_5_send_indirect_table send_table;
 592} __packed;
 593
 594union nvsp_all_messages {
 595	union nvsp_message_init_uber init_msg;
 596	union nvsp_1_message_uber v1_msg;
 597	union nvsp_2_message_uber v2_msg;
 598	union nvsp_4_message_uber v4_msg;
 599	union nvsp_5_message_uber v5_msg;
 600} __packed;
 601
 602/* ALL Messages */
 603struct nvsp_message {
 604	struct nvsp_message_header hdr;
 605	union nvsp_all_messages msg;
 606} __packed;
 607
 608
 609#define NETVSC_MTU 65535
 610#define NETVSC_MTU_MIN ETH_MIN_MTU
 611
 612#define NETVSC_RECEIVE_BUFFER_SIZE		(1024*1024*16)	/* 16MB */
 613#define NETVSC_RECEIVE_BUFFER_SIZE_LEGACY	(1024*1024*15)  /* 15MB */
 614#define NETVSC_SEND_BUFFER_SIZE			(1024 * 1024 * 15)   /* 15MB */
 615#define NETVSC_INVALID_INDEX			-1
 616
 617
 618#define NETVSC_RECEIVE_BUFFER_ID		0xcafe
 619#define NETVSC_SEND_BUFFER_ID			0
 620
 621#define NETVSC_PACKET_SIZE                      4096
 
 622
 623#define VRSS_SEND_TAB_SIZE 16
 624#define VRSS_CHANNEL_MAX 64
 625
 626#define RNDIS_MAX_PKT_DEFAULT 8
 627#define RNDIS_PKT_ALIGN_DEFAULT 8
 628
 629struct multi_send_data {
 630	struct sk_buff *skb; /* skb containing the pkt */
 631	struct hv_netvsc_packet *pkt; /* netvsc pkt pending */
 632	u32 count; /* counter of batched packets */
 633};
 634
 635struct recv_comp_data {
 636	u64 tid; /* transaction id */
 637	u32 status;
 638};
 639
 640/* Netvsc Receive Slots Max */
 641#define NETVSC_RECVSLOT_MAX (NETVSC_RECEIVE_BUFFER_SIZE / ETH_DATA_LEN + 1)
 642
 643struct multi_recv_comp {
 644	void *buf; /* queued receive completions */
 645	u32 first; /* first data entry */
 646	u32 next; /* next entry for writing */
 647};
 648
 649struct netvsc_stats {
 650	u64 packets;
 651	u64 bytes;
 652	u64 broadcast;
 653	u64 multicast;
 654	struct u64_stats_sync syncp;
 655};
 656
 657struct netvsc_ethtool_stats {
 658	unsigned long tx_scattered;
 659	unsigned long tx_no_memory;
 660	unsigned long tx_no_space;
 661	unsigned long tx_too_big;
 662	unsigned long tx_busy;
 663};
 664
 665struct netvsc_reconfig {
 666	struct list_head list;
 667	u32 event;
 668};
 669
 670/* The context of the netvsc device  */
 671struct net_device_context {
 672	/* point back to our device context */
 673	struct hv_device *device_ctx;
 674	/* netvsc_device */
 675	struct netvsc_device *nvdev;
 676	/* reconfigure work */
 677	struct delayed_work dwork;
 678	/* last reconfig time */
 679	unsigned long last_reconfig;
 680	/* reconfig events */
 681	struct list_head reconfig_events;
 682	/* list protection */
 683	spinlock_t lock;
 684
 685	struct work_struct work;
 686	u32 msg_enable; /* debug level */
 687
 688	struct netvsc_stats __percpu *tx_stats;
 689	struct netvsc_stats __percpu *rx_stats;
 690
 691	/* Ethtool settings */
 692	u8 duplex;
 693	u32 speed;
 694	struct netvsc_ethtool_stats eth_stats;
 695
 696	/* the device is going away */
 697	bool start_remove;
 698
 699	/* State to manage the associated VF interface. */
 700	struct net_device __rcu *vf_netdev;
 701
 702	/* 1: allocated, serial number is valid. 0: not allocated */
 703	u32 vf_alloc;
 704	/* Serial number of the VF to team with */
 705	u32 vf_serial;
 706};
 707
 708/* Per netvsc device */
 709struct netvsc_device {
 710	u32 nvsp_version;
 711
 712	atomic_t num_outstanding_sends;
 713	wait_queue_head_t wait_drain;
 
 714	bool destroy;
 
 
 
 
 
 
 715
 716	/* Receive buffer allocated by us but manages by NetVSP */
 717	void *recv_buf;
 718	u32 recv_buf_size;
 719	u32 recv_buf_gpadl_handle;
 720	u32 recv_section_cnt;
 721	struct nvsp_1_receive_buffer_section *recv_section;
 722
 723	/* Send buffer allocated by us */
 724	void *send_buf;
 725	u32 send_buf_size;
 726	u32 send_buf_gpadl_handle;
 727	u32 send_section_cnt;
 728	u32 send_section_size;
 729	unsigned long *send_section_map;
 730	int map_words;
 731
 732	/* Used for NetVSP initialization protocol */
 733	struct completion channel_init_wait;
 734	struct nvsp_message channel_init_pkt;
 735
 736	struct nvsp_message revoke_packet;
 
 737
 738	struct vmbus_channel *chn_table[VRSS_CHANNEL_MAX];
 739	u32 send_table[VRSS_SEND_TAB_SIZE];
 740	u32 max_chn;
 741	u32 num_chn;
 742	spinlock_t sc_lock; /* Protects num_sc_offered variable */
 743	u32 num_sc_offered;
 744	atomic_t queue_sends[VRSS_CHANNEL_MAX];
 745
 746	/* Holds rndis device info */
 747	void *extension;
 748
 749	int ring_size;
 750
 751	/* The primary channel callback buffer */
 752	unsigned char *cb_buffer;
 753	/* The sub channel callback buffer */
 754	unsigned char *sub_cb_buf;
 755
 756	struct multi_send_data msd[VRSS_CHANNEL_MAX];
 757	u32 max_pkt; /* max number of pkt in one send, e.g. 8 */
 758	u32 pkt_align; /* alignment bytes, e.g. 8 */
 759
 760	struct multi_recv_comp mrc[VRSS_CHANNEL_MAX];
 761	atomic_t num_outstanding_recvs;
 762
 763	atomic_t open_cnt;
 764};
 765
 766static inline struct netvsc_device *
 767net_device_to_netvsc_device(struct net_device *ndev)
 768{
 769	return ((struct net_device_context *)netdev_priv(ndev))->nvdev;
 770}
 771
 772static inline struct netvsc_device *
 773hv_device_to_netvsc_device(struct hv_device *device)
 774{
 775	return net_device_to_netvsc_device(hv_get_drvdata(device));
 776}
 777
 778/* NdisInitialize message */
 779struct rndis_initialize_request {
 780	u32 req_id;
 781	u32 major_ver;
 782	u32 minor_ver;
 783	u32 max_xfer_size;
 784};
 785
 786/* Response to NdisInitialize */
 787struct rndis_initialize_complete {
 788	u32 req_id;
 789	u32 status;
 790	u32 major_ver;
 791	u32 minor_ver;
 792	u32 dev_flags;
 793	u32 medium;
 794	u32 max_pkt_per_msg;
 795	u32 max_xfer_size;
 796	u32 pkt_alignment_factor;
 797	u32 af_list_offset;
 798	u32 af_list_size;
 799};
 800
 801/* Call manager devices only: Information about an address family */
 802/* supported by the device is appended to the response to NdisInitialize. */
 803struct rndis_co_address_family {
 804	u32 address_family;
 805	u32 major_ver;
 806	u32 minor_ver;
 807};
 808
 809/* NdisHalt message */
 810struct rndis_halt_request {
 811	u32 req_id;
 812};
 813
 814/* NdisQueryRequest message */
 815struct rndis_query_request {
 816	u32 req_id;
 817	u32 oid;
 818	u32 info_buflen;
 819	u32 info_buf_offset;
 820	u32 dev_vc_handle;
 821};
 822
 823/* Response to NdisQueryRequest */
 824struct rndis_query_complete {
 825	u32 req_id;
 826	u32 status;
 827	u32 info_buflen;
 828	u32 info_buf_offset;
 829};
 830
 831/* NdisSetRequest message */
 832struct rndis_set_request {
 833	u32 req_id;
 834	u32 oid;
 835	u32 info_buflen;
 836	u32 info_buf_offset;
 837	u32 dev_vc_handle;
 838};
 839
 840/* Response to NdisSetRequest */
 841struct rndis_set_complete {
 842	u32 req_id;
 843	u32 status;
 844};
 845
 846/* NdisReset message */
 847struct rndis_reset_request {
 848	u32 reserved;
 849};
 850
 851/* Response to NdisReset */
 852struct rndis_reset_complete {
 853	u32 status;
 854	u32 addressing_reset;
 855};
 856
 857/* NdisMIndicateStatus message */
 858struct rndis_indicate_status {
 859	u32 status;
 860	u32 status_buflen;
 861	u32 status_buf_offset;
 862};
 863
 864/* Diagnostic information passed as the status buffer in */
 865/* struct rndis_indicate_status messages signifying error conditions. */
 866struct rndis_diagnostic_info {
 867	u32 diag_status;
 868	u32 error_offset;
 869};
 870
 871/* NdisKeepAlive message */
 872struct rndis_keepalive_request {
 873	u32 req_id;
 874};
 875
 876/* Response to NdisKeepAlive */
 877struct rndis_keepalive_complete {
 878	u32 req_id;
 879	u32 status;
 880};
 881
 882/*
 883 * Data message. All Offset fields contain byte offsets from the beginning of
 884 * struct rndis_packet. All Length fields are in bytes.  VcHandle is set
 885 * to 0 for connectionless data, otherwise it contains the VC handle.
 886 */
 887struct rndis_packet {
 888	u32 data_offset;
 889	u32 data_len;
 890	u32 oob_data_offset;
 891	u32 oob_data_len;
 892	u32 num_oob_data_elements;
 893	u32 per_pkt_info_offset;
 894	u32 per_pkt_info_len;
 895	u32 vc_handle;
 896	u32 reserved;
 897};
 898
 899/* Optional Out of Band data associated with a Data message. */
 900struct rndis_oobd {
 901	u32 size;
 902	u32 type;
 903	u32 class_info_offset;
 904};
 905
 906/* Packet extension field contents associated with a Data message. */
 907struct rndis_per_packet_info {
 908	u32 size;
 909	u32 type;
 910	u32 ppi_offset;
 911};
 912
 913enum ndis_per_pkt_info_type {
 914	TCPIP_CHKSUM_PKTINFO,
 915	IPSEC_PKTINFO,
 916	TCP_LARGESEND_PKTINFO,
 917	CLASSIFICATION_HANDLE_PKTINFO,
 918	NDIS_RESERVED,
 919	SG_LIST_PKTINFO,
 920	IEEE_8021Q_INFO,
 921	ORIGINAL_PKTINFO,
 922	PACKET_CANCEL_ID,
 923	NBL_HASH_VALUE = PACKET_CANCEL_ID,
 924	ORIGINAL_NET_BUFLIST,
 925	CACHED_NET_BUFLIST,
 926	SHORT_PKT_PADINFO,
 927	MAX_PER_PKT_INFO
 928};
 929
 930struct ndis_pkt_8021q_info {
 931	union {
 932		struct {
 933			u32 pri:3; /* User Priority */
 934			u32 cfi:1; /* Canonical Format ID */
 935			u32 vlanid:12; /* VLAN ID */
 936			u32 reserved:16;
 937		};
 938		u32 value;
 939	};
 940};
 941
 942struct ndis_oject_header {
 943	u8 type;
 944	u8 revision;
 945	u16 size;
 946};
 947
 948#define NDIS_OBJECT_TYPE_DEFAULT	0x80
 949#define NDIS_OFFLOAD_PARAMETERS_REVISION_3 3
 950#define NDIS_OFFLOAD_PARAMETERS_NO_CHANGE 0
 951#define NDIS_OFFLOAD_PARAMETERS_LSOV2_DISABLED 1
 952#define NDIS_OFFLOAD_PARAMETERS_LSOV2_ENABLED  2
 953#define NDIS_OFFLOAD_PARAMETERS_LSOV1_ENABLED  2
 954#define NDIS_OFFLOAD_PARAMETERS_RSC_DISABLED 1
 955#define NDIS_OFFLOAD_PARAMETERS_RSC_ENABLED 2
 956#define NDIS_OFFLOAD_PARAMETERS_TX_RX_DISABLED 1
 957#define NDIS_OFFLOAD_PARAMETERS_TX_ENABLED_RX_DISABLED 2
 958#define NDIS_OFFLOAD_PARAMETERS_RX_ENABLED_TX_DISABLED 3
 959#define NDIS_OFFLOAD_PARAMETERS_TX_RX_ENABLED 4
 960
 961#define NDIS_TCP_LARGE_SEND_OFFLOAD_V2_TYPE	1
 962#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV4	0
 963#define NDIS_TCP_LARGE_SEND_OFFLOAD_IPV6	1
 964
 965#define VERSION_4_OFFLOAD_SIZE			22
 966/*
 967 * New offload OIDs for NDIS 6
 968 */
 969#define OID_TCP_OFFLOAD_CURRENT_CONFIG 0xFC01020B /* query only */
 970#define OID_TCP_OFFLOAD_PARAMETERS 0xFC01020C		/* set only */
 971#define OID_TCP_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020D/* query only */
 972#define OID_TCP_CONNECTION_OFFLOAD_CURRENT_CONFIG 0xFC01020E /* query only */
 973#define OID_TCP_CONNECTION_OFFLOAD_HARDWARE_CAPABILITIES 0xFC01020F /* query */
 974#define OID_OFFLOAD_ENCAPSULATION 0x0101010A /* set/query */
 975
 976struct ndis_offload_params {
 977	struct ndis_oject_header header;
 978	u8 ip_v4_csum;
 979	u8 tcp_ip_v4_csum;
 980	u8 udp_ip_v4_csum;
 981	u8 tcp_ip_v6_csum;
 982	u8 udp_ip_v6_csum;
 983	u8 lso_v1;
 984	u8 ip_sec_v1;
 985	u8 lso_v2_ipv4;
 986	u8 lso_v2_ipv6;
 987	u8 tcp_connection_ip_v4;
 988	u8 tcp_connection_ip_v6;
 989	u32 flags;
 990	u8 ip_sec_v2;
 991	u8 ip_sec_v2_ip_v4;
 992	struct {
 993		u8 rsc_ip_v4;
 994		u8 rsc_ip_v6;
 995	};
 996	struct {
 997		u8 encapsulated_packet_task_offload;
 998		u8 encapsulation_types;
 999	};
1000};
1001
1002struct ndis_tcp_ip_checksum_info {
1003	union {
1004		struct {
1005			u32 is_ipv4:1;
1006			u32 is_ipv6:1;
1007			u32 tcp_checksum:1;
1008			u32 udp_checksum:1;
1009			u32 ip_header_checksum:1;
1010			u32 reserved:11;
1011			u32 tcp_header_offset:10;
1012		} transmit;
1013		struct {
1014			u32 tcp_checksum_failed:1;
1015			u32 udp_checksum_failed:1;
1016			u32 ip_checksum_failed:1;
1017			u32 tcp_checksum_succeeded:1;
1018			u32 udp_checksum_succeeded:1;
1019			u32 ip_checksum_succeeded:1;
1020			u32 loopback:1;
1021			u32 tcp_checksum_value_invalid:1;
1022			u32 ip_checksum_value_invalid:1;
1023		} receive;
1024		u32  value;
1025	};
1026};
1027
1028struct ndis_tcp_lso_info {
1029	union {
1030		struct {
1031			u32 unused:30;
1032			u32 type:1;
1033			u32 reserved2:1;
1034		} transmit;
1035		struct {
1036			u32 mss:20;
1037			u32 tcp_header_offset:10;
1038			u32 type:1;
1039			u32 reserved2:1;
1040		} lso_v1_transmit;
1041		struct {
1042			u32 tcp_payload:30;
1043			u32 type:1;
1044			u32 reserved2:1;
1045		} lso_v1_transmit_complete;
1046		struct {
1047			u32 mss:20;
1048			u32 tcp_header_offset:10;
1049			u32 type:1;
1050			u32 ip_version:1;
1051		} lso_v2_transmit;
1052		struct {
1053			u32 reserved:30;
1054			u32 type:1;
1055			u32 reserved2:1;
1056		} lso_v2_transmit_complete;
1057		u32  value;
1058	};
1059};
1060
1061#define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1062		sizeof(struct ndis_pkt_8021q_info))
1063
1064#define NDIS_CSUM_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1065		sizeof(struct ndis_tcp_ip_checksum_info))
1066
1067#define NDIS_LSO_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1068		sizeof(struct ndis_tcp_lso_info))
1069
1070#define NDIS_HASH_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
1071		sizeof(u32))
1072
1073/* Total size of all PPI data */
1074#define NDIS_ALL_PPI_SIZE (NDIS_VLAN_PPI_SIZE + NDIS_CSUM_PPI_SIZE + \
1075			   NDIS_LSO_PPI_SIZE + NDIS_HASH_PPI_SIZE)
1076
1077/* Format of Information buffer passed in a SetRequest for the OID */
1078/* OID_GEN_RNDIS_CONFIG_PARAMETER. */
1079struct rndis_config_parameter_info {
1080	u32 parameter_name_offset;
1081	u32 parameter_name_length;
1082	u32 parameter_type;
1083	u32 parameter_value_offset;
1084	u32 parameter_value_length;
1085};
1086
1087/* Values for ParameterType in struct rndis_config_parameter_info */
1088#define RNDIS_CONFIG_PARAM_TYPE_INTEGER     0
1089#define RNDIS_CONFIG_PARAM_TYPE_STRING      2
1090
1091/* CONDIS Miniport messages for connection oriented devices */
1092/* that do not implement a call manager. */
1093
1094/* CoNdisMiniportCreateVc message */
1095struct rcondis_mp_create_vc {
1096	u32 req_id;
1097	u32 ndis_vc_handle;
1098};
1099
1100/* Response to CoNdisMiniportCreateVc */
1101struct rcondis_mp_create_vc_complete {
1102	u32 req_id;
1103	u32 dev_vc_handle;
1104	u32 status;
1105};
1106
1107/* CoNdisMiniportDeleteVc message */
1108struct rcondis_mp_delete_vc {
1109	u32 req_id;
1110	u32 dev_vc_handle;
1111};
1112
1113/* Response to CoNdisMiniportDeleteVc */
1114struct rcondis_mp_delete_vc_complete {
1115	u32 req_id;
1116	u32 status;
1117};
1118
1119/* CoNdisMiniportQueryRequest message */
1120struct rcondis_mp_query_request {
1121	u32 req_id;
1122	u32 request_type;
1123	u32 oid;
1124	u32 dev_vc_handle;
1125	u32 info_buflen;
1126	u32 info_buf_offset;
1127};
1128
1129/* CoNdisMiniportSetRequest message */
1130struct rcondis_mp_set_request {
1131	u32 req_id;
1132	u32 request_type;
1133	u32 oid;
1134	u32 dev_vc_handle;
1135	u32 info_buflen;
1136	u32 info_buf_offset;
1137};
1138
1139/* CoNdisIndicateStatus message */
1140struct rcondis_indicate_status {
1141	u32 ndis_vc_handle;
1142	u32 status;
1143	u32 status_buflen;
1144	u32 status_buf_offset;
1145};
1146
1147/* CONDIS Call/VC parameters */
1148struct rcondis_specific_parameters {
1149	u32 parameter_type;
1150	u32 parameter_length;
1151	u32 parameter_lffset;
1152};
1153
1154struct rcondis_media_parameters {
1155	u32 flags;
1156	u32 reserved1;
1157	u32 reserved2;
1158	struct rcondis_specific_parameters media_specific;
1159};
1160
1161struct rndis_flowspec {
1162	u32 token_rate;
1163	u32 token_bucket_size;
1164	u32 peak_bandwidth;
1165	u32 latency;
1166	u32 delay_variation;
1167	u32 service_type;
1168	u32 max_sdu_size;
1169	u32 minimum_policed_size;
1170};
1171
1172struct rcondis_call_manager_parameters {
1173	struct rndis_flowspec transmit;
1174	struct rndis_flowspec receive;
1175	struct rcondis_specific_parameters call_mgr_specific;
1176};
1177
1178/* CoNdisMiniportActivateVc message */
1179struct rcondis_mp_activate_vc_request {
1180	u32 req_id;
1181	u32 flags;
1182	u32 dev_vc_handle;
1183	u32 media_params_offset;
1184	u32 media_params_length;
1185	u32 call_mgr_params_offset;
1186	u32 call_mgr_params_length;
1187};
1188
1189/* Response to CoNdisMiniportActivateVc */
1190struct rcondis_mp_activate_vc_complete {
1191	u32 req_id;
1192	u32 status;
1193};
1194
1195/* CoNdisMiniportDeactivateVc message */
1196struct rcondis_mp_deactivate_vc_request {
1197	u32 req_id;
1198	u32 flags;
1199	u32 dev_vc_handle;
1200};
1201
1202/* Response to CoNdisMiniportDeactivateVc */
1203struct rcondis_mp_deactivate_vc_complete {
1204	u32 req_id;
1205	u32 status;
1206};
1207
1208
1209/* union with all of the RNDIS messages */
1210union rndis_message_container {
1211	struct rndis_packet pkt;
1212	struct rndis_initialize_request init_req;
1213	struct rndis_halt_request halt_req;
1214	struct rndis_query_request query_req;
1215	struct rndis_set_request set_req;
1216	struct rndis_reset_request reset_req;
1217	struct rndis_keepalive_request keep_alive_req;
1218	struct rndis_indicate_status indicate_status;
1219	struct rndis_initialize_complete init_complete;
1220	struct rndis_query_complete query_complete;
1221	struct rndis_set_complete set_complete;
1222	struct rndis_reset_complete reset_complete;
1223	struct rndis_keepalive_complete keep_alive_complete;
1224	struct rcondis_mp_create_vc co_miniport_create_vc;
1225	struct rcondis_mp_delete_vc co_miniport_delete_vc;
1226	struct rcondis_indicate_status co_indicate_status;
1227	struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
1228	struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
1229	struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
1230	struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
1231	struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
1232	struct rcondis_mp_deactivate_vc_complete
1233		co_miniport_deactivate_vc_complete;
1234};
1235
1236/* Remote NDIS message format */
1237struct rndis_message {
1238	u32 ndis_msg_type;
1239
1240	/* Total length of this message, from the beginning */
1241	/* of the struct rndis_message, in bytes. */
1242	u32 msg_len;
1243
1244	/* Actual message */
1245	union rndis_message_container msg;
1246};
1247
1248
1249/* Handy macros */
1250
1251/* get the size of an RNDIS message. Pass in the message type, */
1252/* struct rndis_set_request, struct rndis_packet for example */
1253#define RNDIS_MESSAGE_SIZE(msg)				\
1254	(sizeof(msg) + (sizeof(struct rndis_message) -	\
1255	 sizeof(union rndis_message_container)))
1256
1257/* get pointer to info buffer with message pointer */
1258#define MESSAGE_TO_INFO_BUFFER(msg)				\
1259	(((unsigned char *)(msg)) + msg->info_buf_offset)
1260
1261/* get pointer to status buffer with message pointer */
1262#define MESSAGE_TO_STATUS_BUFFER(msg)			\
1263	(((unsigned char *)(msg)) + msg->status_buf_offset)
1264
1265/* get pointer to OOBD buffer with message pointer */
1266#define MESSAGE_TO_OOBD_BUFFER(msg)				\
1267	(((unsigned char *)(msg)) + msg->oob_data_offset)
1268
1269/* get pointer to data buffer with message pointer */
1270#define MESSAGE_TO_DATA_BUFFER(msg)				\
1271	(((unsigned char *)(msg)) + msg->per_pkt_info_offset)
1272
1273/* get pointer to contained message from NDIS_MESSAGE pointer */
1274#define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg)		\
1275	((void *) &rndis_msg->msg)
1276
1277/* get pointer to contained message from NDIS_MESSAGE pointer */
1278#define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg)	\
1279	((void *) rndis_msg)
1280
1281
1282#define __struct_bcount(x)
1283
1284
1285
1286#define RNDIS_HEADER_SIZE	(sizeof(struct rndis_message) - \
1287				 sizeof(union rndis_message_container))
1288
1289#define RNDIS_AND_PPI_SIZE (sizeof(struct rndis_message) + NDIS_ALL_PPI_SIZE)
1290
1291#define NDIS_PACKET_TYPE_DIRECTED	0x00000001
1292#define NDIS_PACKET_TYPE_MULTICAST	0x00000002
1293#define NDIS_PACKET_TYPE_ALL_MULTICAST	0x00000004
1294#define NDIS_PACKET_TYPE_BROADCAST	0x00000008
1295#define NDIS_PACKET_TYPE_SOURCE_ROUTING	0x00000010
1296#define NDIS_PACKET_TYPE_PROMISCUOUS	0x00000020
1297#define NDIS_PACKET_TYPE_SMT		0x00000040
1298#define NDIS_PACKET_TYPE_ALL_LOCAL	0x00000080
1299#define NDIS_PACKET_TYPE_GROUP		0x00000100
1300#define NDIS_PACKET_TYPE_ALL_FUNCTIONAL	0x00000200
1301#define NDIS_PACKET_TYPE_FUNCTIONAL	0x00000400
1302#define NDIS_PACKET_TYPE_MAC_FRAME	0x00000800
1303
1304#define INFO_IPV4       2
1305#define INFO_IPV6       4
1306#define INFO_TCP        2
1307#define INFO_UDP        4
1308
1309#define TRANSPORT_INFO_NOT_IP   0
1310#define TRANSPORT_INFO_IPV4_TCP ((INFO_IPV4 << 16) | INFO_TCP)
1311#define TRANSPORT_INFO_IPV4_UDP ((INFO_IPV4 << 16) | INFO_UDP)
1312#define TRANSPORT_INFO_IPV6_TCP ((INFO_IPV6 << 16) | INFO_TCP)
1313#define TRANSPORT_INFO_IPV6_UDP ((INFO_IPV6 << 16) | INFO_UDP)
 
1314
1315#endif /* _HYPERV_NET_H */