drivers/net/hyperv/hyperv_net.h

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