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