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