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 /* Fwd declaration */
  32 struct hv_netvsc_packet;
  33
  34 /* Represent the xfer page packet which contains 1 or more netvsc packet */
  35 struct xferpage_packet {
  36         struct list_head list_ent;
  37         u32 status;
  38
  39         /* # of netvsc packets this xfer packet contains */
  40         u32 count;
  41 };
  42
  43 /*
  44  * Represent netvsc packet which contains 1 RNDIS and 1 ethernet frame
  45  * within the RNDIS
  46  */
  47 struct hv_netvsc_packet {
  48         /* Bookkeeping stuff */
  49         struct list_head list_ent;
  50         u32 status;
  51
  52         struct hv_device *device;
  53         bool is_data_pkt;
  54         u16 vlan_tci;
  55
  56         /*
  57          * Valid only for receives when we break a xfer page packet
  58          * into multiple netvsc packets
  59          */
  60         struct xferpage_packet *xfer_page_pkt;
  61
  62         union {
  63                 struct {
  64                         u64 recv_completion_tid;
  65                         void *recv_completion_ctx;
  66                         void (*recv_completion)(void *context);
  67                 } recv;
  68                 struct {
  69                         u64 send_completion_tid;
  70                         void *send_completion_ctx;
  71                         void (*send_completion)(void *context);
  72                 } send;
  73         } completion;
  74
  75         /* This points to the memory after page_buf */
  76         void *extension;
  77
  78         u32 total_data_buflen;
  79         /* Points to the send/receive buffer where the ethernet frame is */
  80         void *data;
  81         u32 page_buf_cnt;
  82         struct hv_page_buffer page_buf[0];
  83 };
  84
  85 struct netvsc_device_info {
  86         unsigned char mac_adr[ETH_ALEN];
  87         bool link_state;        /* 0 - link up, 1 - link down */
  88         int  ring_size;
  89 };
  90
  91 enum rndis_device_state {
  92         RNDIS_DEV_UNINITIALIZED = 0,
  93         RNDIS_DEV_INITIALIZING,
  94         RNDIS_DEV_INITIALIZED,
  95         RNDIS_DEV_DATAINITIALIZED,
  96 };
  97
  98 struct rndis_device {
  99         struct netvsc_device *net_dev;
 100
 101         enum rndis_device_state state;
 102         bool link_state;
 103         atomic_t new_req_id;
 104
 105         spinlock_t request_lock;
 106         struct list_head req_list;
 107
 108         unsigned char hw_mac_adr[ETH_ALEN];
 109 };
 110
 111
 112 /* Interface */
 113 int netvsc_device_add(struct hv_device *device, void *additional_info);
 114 int netvsc_device_remove(struct hv_device *device);
 115 int netvsc_send(struct hv_device *device,
 116                 struct hv_netvsc_packet *packet);
 117 void netvsc_linkstatus_callback(struct hv_device *device_obj,
 118                                 unsigned int status);
 119 int netvsc_recv_callback(struct hv_device *device_obj,
 120                         struct hv_netvsc_packet *packet);
 121 int rndis_filter_open(struct hv_device *dev);
 122 int rndis_filter_close(struct hv_device *dev);
 123 int rndis_filter_device_add(struct hv_device *dev,
 124                         void *additional_info);
 125 void rndis_filter_device_remove(struct hv_device *dev);
 126 int rndis_filter_receive(struct hv_device *dev,
 127                         struct hv_netvsc_packet *pkt);
 128
 129
 130
 131 int rndis_filter_send(struct hv_device *dev,
 132                         struct hv_netvsc_packet *pkt);
 133
 134 int rndis_filter_set_packet_filter(struct rndis_device *dev, u32 new_filter);
 135 int rndis_filter_set_device_mac(struct hv_device *hdev, char *mac);
 136
 137
 138 #define NVSP_INVALID_PROTOCOL_VERSION   ((u32)0xFFFFFFFF)
 139
 140 #define NVSP_PROTOCOL_VERSION_1         2
 141 #define NVSP_PROTOCOL_VERSION_2         0x30002
 142 #define NVSP_PROTOCOL_VERSION_4         0x40000
 143 #define NVSP_PROTOCOL_VERSION_5         0x50000
 144
 145 enum {
 146         NVSP_MSG_TYPE_NONE = 0,
 147
 148         /* Init Messages */
 149         NVSP_MSG_TYPE_INIT                      = 1,
 150         NVSP_MSG_TYPE_INIT_COMPLETE             = 2,
 151
 152         NVSP_VERSION_MSG_START                  = 100,
 153
 154         /* Version 1 Messages */
 155         NVSP_MSG1_TYPE_SEND_NDIS_VER            = NVSP_VERSION_MSG_START,
 156
 157         NVSP_MSG1_TYPE_SEND_RECV_BUF,
 158         NVSP_MSG1_TYPE_SEND_RECV_BUF_COMPLETE,
 159         NVSP_MSG1_TYPE_REVOKE_RECV_BUF,
 160
 161         NVSP_MSG1_TYPE_SEND_SEND_BUF,
 162         NVSP_MSG1_TYPE_SEND_SEND_BUF_COMPLETE,
 163         NVSP_MSG1_TYPE_REVOKE_SEND_BUF,
 164
 165         NVSP_MSG1_TYPE_SEND_RNDIS_PKT,
 166         NVSP_MSG1_TYPE_SEND_RNDIS_PKT_COMPLETE,
 167
 168         /* Version 2 messages */
 169         NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF,
 170         NVSP_MSG2_TYPE_SEND_CHIMNEY_DELEGATED_BUF_COMP,
 171         NVSP_MSG2_TYPE_REVOKE_CHIMNEY_DELEGATED_BUF,
 172
 173         NVSP_MSG2_TYPE_RESUME_CHIMNEY_RX_INDICATION,
 174
 175         NVSP_MSG2_TYPE_TERMINATE_CHIMNEY,
 176         NVSP_MSG2_TYPE_TERMINATE_CHIMNEY_COMP,
 177
 178         NVSP_MSG2_TYPE_INDICATE_CHIMNEY_EVENT,
 179
 180         NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT,
 181         NVSP_MSG2_TYPE_SEND_CHIMNEY_PKT_COMP,
 182
 183         NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ,
 184         NVSP_MSG2_TYPE_POST_CHIMNEY_RECV_REQ_COMP,
 185
 186         NVSP_MSG2_TYPE_ALLOC_RXBUF,
 187         NVSP_MSG2_TYPE_ALLOC_RXBUF_COMP,
 188
 189         NVSP_MSG2_TYPE_FREE_RXBUF,
 190
 191         NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT,
 192         NVSP_MSG2_TYPE_SEND_VMQ_RNDIS_PKT_COMP,
 193
 194         NVSP_MSG2_TYPE_SEND_NDIS_CONFIG,
 195
 196         NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE,
 197         NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 198
 199         NVSP_MSG2_MAX = NVSP_MSG2_TYPE_ALLOC_CHIMNEY_HANDLE_COMP,
 200
 201         /* Version 4 messages */
 202         NVSP_MSG4_TYPE_SEND_VF_ASSOCIATION,
 203         NVSP_MSG4_TYPE_SWITCH_DATA_PATH,
 204         NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 205
 206         NVSP_MSG4_MAX = NVSP_MSG4_TYPE_UPLINK_CONNECT_STATE_DEPRECATED,
 207
 208         /* Version 5 messages */
 209         NVSP_MSG5_TYPE_OID_QUERY_EX,
 210         NVSP_MSG5_TYPE_OID_QUERY_EX_COMP,
 211         NVSP_MSG5_TYPE_SUBCHANNEL,
 212         NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 213
 214         NVSP_MSG5_MAX = NVSP_MSG5_TYPE_SEND_INDIRECTION_TABLE,
 215 };
 216
 217 enum {
 218         NVSP_STAT_NONE = 0,
 219         NVSP_STAT_SUCCESS,
 220         NVSP_STAT_FAIL,
 221         NVSP_STAT_PROTOCOL_TOO_NEW,
 222         NVSP_STAT_PROTOCOL_TOO_OLD,
 223         NVSP_STAT_INVALID_RNDIS_PKT,
 224         NVSP_STAT_BUSY,
 225         NVSP_STAT_PROTOCOL_UNSUPPORTED,
 226         NVSP_STAT_MAX,
 227 };
 228
 229 struct nvsp_message_header {
 230         u32 msg_type;
 231 };
 232
 233 /* Init Messages */
 234
 235 /*
 236  * This message is used by the VSC to initialize the channel after the channels
 237  * has been opened. This message should never include anything other then
 238  * versioning (i.e. this message will be the same for ever).
 239  */
 240 struct nvsp_message_init {
 241         u32 min_protocol_ver;
 242         u32 max_protocol_ver;
 243 } __packed;
 244
 245 /*
 246  * This message is used by the VSP to complete the initialization of the
 247  * channel. This message should never include anything other then versioning
 248  * (i.e. this message will be the same for ever).
 249  */
 250 struct nvsp_message_init_complete {
 251         u32 negotiated_protocol_ver;
 252         u32 max_mdl_chain_len;
 253         u32 status;
 254 } __packed;
 255
 256 union nvsp_message_init_uber {
 257         struct nvsp_message_init init;
 258         struct nvsp_message_init_complete init_complete;
 259 } __packed;
 260
 261 /* Version 1 Messages */
 262
 263 /*
 264  * This message is used by the VSC to send the NDIS version to the VSP. The VSP
 265  * can use this information when handling OIDs sent by the VSC.
 266  */
 267 struct nvsp_1_message_send_ndis_version {
 268         u32 ndis_major_ver;
 269         u32 ndis_minor_ver;
 270 } __packed;
 271
 272 /*
 273  * This message is used by the VSC to send a receive buffer to the VSP. The VSP
 274  * can then use the receive buffer to send data to the VSC.
 275  */
 276 struct nvsp_1_message_send_receive_buffer {
 277         u32 gpadl_handle;
 278         u16 id;
 279 } __packed;
 280
 281 struct nvsp_1_receive_buffer_section {
 282         u32 offset;
 283         u32 sub_alloc_size;
 284         u32 num_sub_allocs;
 285         u32 end_offset;
 286 } __packed;
 287
 288 /*
 289  * This message is used by the VSP to acknowledge a receive buffer send by the
 290  * VSC. This message must be sent by the VSP before the VSP uses the receive
 291  * buffer.
 292  */
 293 struct nvsp_1_message_send_receive_buffer_complete {
 294         u32 status;
 295         u32 num_sections;
 296
 297         /*
 298          * The receive buffer is split into two parts, a large suballocation
 299          * section and a small suballocation section. These sections are then
 300          * suballocated by a certain size.
 301          */
 302
 303         /*
 304          * For example, the following break up of the receive buffer has 6
 305          * large suballocations and 10 small suballocations.
 306          */
 307
 308         /*
 309          * |            Large Section          |  |   Small Section   |
 310          * ------------------------------------------------------------
 311          * |     |     |     |     |     |     |  | | | | | | | | | | |
 312          * |                                      |
 313          *  LargeOffset                            SmallOffset
 314          */
 315
 316         struct nvsp_1_receive_buffer_section sections[1];
 317 } __packed;
 318
 319 /*
 320  * This message is sent by the VSC to revoke the receive buffer.  After the VSP
 321  * completes this transaction, the vsp should never use the receive buffer
 322  * again.
 323  */
 324 struct nvsp_1_message_revoke_receive_buffer {
 325         u16 id;
 326 };
 327
 328 /*
 329  * This message is used by the VSC to send a send buffer to the VSP. The VSC
 330  * can then use the send buffer to send data to the VSP.
 331  */
 332 struct nvsp_1_message_send_send_buffer {
 333         u32 gpadl_handle;
 334         u16 id;
 335 } __packed;
 336
 337 /*
 338  * This message is used by the VSP to acknowledge a send buffer sent by the
 339  * VSC. This message must be sent by the VSP before the VSP uses the sent
 340  * buffer.
 341  */
 342 struct nvsp_1_message_send_send_buffer_complete {
 343         u32 status;
 344
 345         /*
 346          * The VSC gets to choose the size of the send buffer and the VSP gets
 347          * to choose the sections size of the buffer.  This was done to enable
 348          * dynamic reconfigurations when the cost of GPA-direct buffers
 349          * decreases.
 350          */
 351         u32 section_size;
 352 } __packed;
 353
 354 /*
 355  * This message is sent by the VSC to revoke the send buffer.  After the VSP
 356  * completes this transaction, the vsp should never use the send buffer again.
 357  */
 358 struct nvsp_1_message_revoke_send_buffer {
 359         u16 id;
 360 };
 361
 362 /*
 363  * This message is used by both the VSP and the VSC to send a RNDIS message to
 364  * the opposite channel endpoint.
 365  */
 366 struct nvsp_1_message_send_rndis_packet {
 367         /*
 368          * This field is specified by RNIDS. They assume there's two different
 369          * channels of communication. However, the Network VSP only has one.
 370          * Therefore, the channel travels with the RNDIS packet.
 371          */
 372         u32 channel_type;
 373
 374         /*
 375          * This field is used to send part or all of the data through a send
 376          * buffer. This values specifies an index into the send buffer. If the
 377          * index is 0xFFFFFFFF, then the send buffer is not being used and all
 378          * of the data was sent through other VMBus mechanisms.
 379          */
 380         u32 send_buf_section_index;
 381         u32 send_buf_section_size;
 382 } __packed;
 383
 384 /*
 385  * This message is used by both the VSP and the VSC to complete a RNDIS message
 386  * to the opposite channel endpoint. At this point, the initiator of this
 387  * message cannot use any resources associated with the original RNDIS packet.
 388  */
 389 struct nvsp_1_message_send_rndis_packet_complete {
 390         u32 status;
 391 };
 392
 393 union nvsp_1_message_uber {
 394         struct nvsp_1_message_send_ndis_version send_ndis_ver;
 395
 396         struct nvsp_1_message_send_receive_buffer send_recv_buf;
 397         struct nvsp_1_message_send_receive_buffer_complete
 398                                                 send_recv_buf_complete;
 399         struct nvsp_1_message_revoke_receive_buffer revoke_recv_buf;
 400
 401         struct nvsp_1_message_send_send_buffer send_send_buf;
 402         struct nvsp_1_message_send_send_buffer_complete send_send_buf_complete;
 403         struct nvsp_1_message_revoke_send_buffer revoke_send_buf;
 404
 405         struct nvsp_1_message_send_rndis_packet send_rndis_pkt;
 406         struct nvsp_1_message_send_rndis_packet_complete
 407                                                 send_rndis_pkt_complete;
 408 } __packed;
 409
 410
 411 /*
 412  * Network VSP protocol version 2 messages:
 413  */
 414 struct nvsp_2_vsc_capability {
 415         union {
 416                 u64 data;
 417                 struct {
 418                         u64 vmq:1;
 419                         u64 chimney:1;
 420                         u64 sriov:1;
 421                         u64 ieee8021q:1;
 422                         u64 correlation_id:1;
 423                 };
 424         };
 425 } __packed;
 426
 427 struct nvsp_2_send_ndis_config {
 428         u32 mtu;
 429         u32 reserved;
 430         struct nvsp_2_vsc_capability capability;
 431 } __packed;
 432
 433 /* Allocate receive buffer */
 434 struct nvsp_2_alloc_rxbuf {
 435         /* Allocation ID to match the allocation request and response */
 436         u32 alloc_id;
 437
 438         /* Length of the VM shared memory receive buffer that needs to
 439          * be allocated
 440          */
 441         u32 len;
 442 } __packed;
 443
 444 /* Allocate receive buffer complete */
 445 struct nvsp_2_alloc_rxbuf_comp {
 446         /* The NDIS_STATUS code for buffer allocation */
 447         u32 status;
 448
 449         u32 alloc_id;
 450
 451         /* GPADL handle for the allocated receive buffer */
 452         u32 gpadl_handle;
 453
 454         /* Receive buffer ID */
 455         u64 recv_buf_id;
 456 } __packed;
 457
 458 struct nvsp_2_free_rxbuf {
 459         u64 recv_buf_id;
 460 } __packed;
 461
 462 union nvsp_2_message_uber {
 463         struct nvsp_2_send_ndis_config send_ndis_config;
 464         struct nvsp_2_alloc_rxbuf alloc_rxbuf;
 465         struct nvsp_2_alloc_rxbuf_comp alloc_rxbuf_comp;
 466         struct nvsp_2_free_rxbuf free_rxbuf;
 467 } __packed;
 468
 469 enum nvsp_subchannel_operation {
 470         NVSP_SUBCHANNEL_NONE = 0,
 471         NVSP_SUBCHANNEL_ALLOCATE,
 472         NVSP_SUBCHANNEL_MAX
 473 };
 474
 475 struct nvsp_5_subchannel_request {
 476         u32 op;
 477         u32 num_subchannels;
 478 } __packed;
 479
 480 struct nvsp_5_subchannel_complete {
 481         u32 status;
 482         u32 num_subchannels; /* Actual number of subchannels allocated */
 483 } __packed;
 484
 485 struct nvsp_5_send_indirect_table {
 486         /* The number of entries in the send indirection table */
 487         u32 count;
 488
 489         /* The offset of the send indireciton table from top of this struct.
 490          * The send indirection table tells which channel to put the send
 491          * traffic on. Each entry is a channel number.
 492          */
 493         u32 offset;
 494 } __packed;
 495
 496 union nvsp_5_message_uber {
 497         struct nvsp_5_subchannel_request subchn_req;
 498         struct nvsp_5_subchannel_complete subchn_comp;
 499         struct nvsp_5_send_indirect_table send_table;
 500 } __packed;
 501
 502 union nvsp_all_messages {
 503         union nvsp_message_init_uber init_msg;
 504         union nvsp_1_message_uber v1_msg;
 505         union nvsp_2_message_uber v2_msg;
 506         union nvsp_5_message_uber v5_msg;
 507 } __packed;
 508
 509 /* ALL Messages */
 510 struct nvsp_message {
 511         struct nvsp_message_header hdr;
 512         union nvsp_all_messages msg;
 513 } __packed;
 514
 515
 516 #define NETVSC_MTU 65536
 517
 518 #define NETVSC_RECEIVE_BUFFER_SIZE              (1024*1024*16)  /* 16MB */
 519
 520 #define NETVSC_RECEIVE_BUFFER_ID                0xcafe
 521
 522 /* Preallocated receive packets */
 523 #define NETVSC_RECEIVE_PACKETLIST_COUNT         256
 524
 525 #define NETVSC_PACKET_SIZE                      2048
 526
 527 /* Per netvsc channel-specific */
 528 struct netvsc_device {
 529         struct hv_device *dev;
 530
 531         u32 nvsp_version;
 532
 533         atomic_t num_outstanding_sends;
 534         wait_queue_head_t wait_drain;
 535         bool start_remove;
 536         bool destroy;
 537         /*
 538          * List of free preallocated hv_netvsc_packet to represent receive
 539          * packet
 540          */
 541         struct list_head recv_pkt_list;
 542         spinlock_t recv_pkt_list_lock;
 543
 544         /* Receive buffer allocated by us but manages by NetVSP */
 545         void *recv_buf;
 546         u32 recv_buf_size;
 547         u32 recv_buf_gpadl_handle;
 548         u32 recv_section_cnt;
 549         struct nvsp_1_receive_buffer_section *recv_section;
 550
 551         /* Used for NetVSP initialization protocol */
 552         struct completion channel_init_wait;
 553         struct nvsp_message channel_init_pkt;
 554
 555         struct nvsp_message revoke_packet;
 556         /* unsigned char HwMacAddr[HW_MACADDR_LEN]; */
 557
 558         struct net_device *ndev;
 559
 560         /* Holds rndis device info */
 561         void *extension;
 562         /* The recive buffer for this device */
 563         unsigned char cb_buffer[NETVSC_PACKET_SIZE];
 564 };
 565
 566 /* NdisInitialize message */
 567 struct rndis_initialize_request {
 568         u32 req_id;
 569         u32 major_ver;
 570         u32 minor_ver;
 571         u32 max_xfer_size;
 572 };
 573
 574 /* Response to NdisInitialize */
 575 struct rndis_initialize_complete {
 576         u32 req_id;
 577         u32 status;
 578         u32 major_ver;
 579         u32 minor_ver;
 580         u32 dev_flags;
 581         u32 medium;
 582         u32 max_pkt_per_msg;
 583         u32 max_xfer_size;
 584         u32 pkt_alignment_factor;
 585         u32 af_list_offset;
 586         u32 af_list_size;
 587 };
 588
 589 /* Call manager devices only: Information about an address family */
 590 /* supported by the device is appended to the response to NdisInitialize. */
 591 struct rndis_co_address_family {
 592         u32 address_family;
 593         u32 major_ver;
 594         u32 minor_ver;
 595 };
 596
 597 /* NdisHalt message */
 598 struct rndis_halt_request {
 599         u32 req_id;
 600 };
 601
 602 /* NdisQueryRequest message */
 603 struct rndis_query_request {
 604         u32 req_id;
 605         u32 oid;
 606         u32 info_buflen;
 607         u32 info_buf_offset;
 608         u32 dev_vc_handle;
 609 };
 610
 611 /* Response to NdisQueryRequest */
 612 struct rndis_query_complete {
 613         u32 req_id;
 614         u32 status;
 615         u32 info_buflen;
 616         u32 info_buf_offset;
 617 };
 618
 619 /* NdisSetRequest message */
 620 struct rndis_set_request {
 621         u32 req_id;
 622         u32 oid;
 623         u32 info_buflen;
 624         u32 info_buf_offset;
 625         u32 dev_vc_handle;
 626 };
 627
 628 /* Response to NdisSetRequest */
 629 struct rndis_set_complete {
 630         u32 req_id;
 631         u32 status;
 632 };
 633
 634 /* NdisReset message */
 635 struct rndis_reset_request {
 636         u32 reserved;
 637 };
 638
 639 /* Response to NdisReset */
 640 struct rndis_reset_complete {
 641         u32 status;
 642         u32 addressing_reset;
 643 };
 644
 645 /* NdisMIndicateStatus message */
 646 struct rndis_indicate_status {
 647         u32 status;
 648         u32 status_buflen;
 649         u32 status_buf_offset;
 650 };
 651
 652 /* Diagnostic information passed as the status buffer in */
 653 /* struct rndis_indicate_status messages signifying error conditions. */
 654 struct rndis_diagnostic_info {
 655         u32 diag_status;
 656         u32 error_offset;
 657 };
 658
 659 /* NdisKeepAlive message */
 660 struct rndis_keepalive_request {
 661         u32 req_id;
 662 };
 663
 664 /* Response to NdisKeepAlive */
 665 struct rndis_keepalive_complete {
 666         u32 req_id;
 667         u32 status;
 668 };
 669
 670 /*
 671  * Data message. All Offset fields contain byte offsets from the beginning of
 672  * struct rndis_packet. All Length fields are in bytes.  VcHandle is set
 673  * to 0 for connectionless data, otherwise it contains the VC handle.
 674  */
 675 struct rndis_packet {
 676         u32 data_offset;
 677         u32 data_len;
 678         u32 oob_data_offset;
 679         u32 oob_data_len;
 680         u32 num_oob_data_elements;
 681         u32 per_pkt_info_offset;
 682         u32 per_pkt_info_len;
 683         u32 vc_handle;
 684         u32 reserved;
 685 };
 686
 687 /* Optional Out of Band data associated with a Data message. */
 688 struct rndis_oobd {
 689         u32 size;
 690         u32 type;
 691         u32 class_info_offset;
 692 };
 693
 694 /* Packet extension field contents associated with a Data message. */
 695 struct rndis_per_packet_info {
 696         u32 size;
 697         u32 type;
 698         u32 ppi_offset;
 699 };
 700
 701 enum ndis_per_pkt_info_type {
 702         TCPIP_CHKSUM_PKTINFO,
 703         IPSEC_PKTINFO,
 704         TCP_LARGESEND_PKTINFO,
 705         CLASSIFICATION_HANDLE_PKTINFO,
 706         NDIS_RESERVED,
 707         SG_LIST_PKTINFO,
 708         IEEE_8021Q_INFO,
 709         ORIGINAL_PKTINFO,
 710         PACKET_CANCEL_ID,
 711         ORIGINAL_NET_BUFLIST,
 712         CACHED_NET_BUFLIST,
 713         SHORT_PKT_PADINFO,
 714         MAX_PER_PKT_INFO
 715 };
 716
 717 struct ndis_pkt_8021q_info {
 718         union {
 719                 struct {
 720                         u32 pri:3; /* User Priority */
 721                         u32 cfi:1; /* Canonical Format ID */
 722                         u32 vlanid:12; /* VLAN ID */
 723                         u32 reserved:16;
 724                 };
 725                 u32 value;
 726         };
 727 };
 728
 729 #define NDIS_VLAN_PPI_SIZE (sizeof(struct rndis_per_packet_info) + \
 730                 sizeof(struct ndis_pkt_8021q_info))
 731
 732 /* Format of Information buffer passed in a SetRequest for the OID */
 733 /* OID_GEN_RNDIS_CONFIG_PARAMETER. */
 734 struct rndis_config_parameter_info {
 735         u32 parameter_name_offset;
 736         u32 parameter_name_length;
 737         u32 parameter_type;
 738         u32 parameter_value_offset;
 739         u32 parameter_value_length;
 740 };
 741
 742 /* Values for ParameterType in struct rndis_config_parameter_info */
 743 #define RNDIS_CONFIG_PARAM_TYPE_INTEGER     0
 744 #define RNDIS_CONFIG_PARAM_TYPE_STRING      2
 745
 746 /* CONDIS Miniport messages for connection oriented devices */
 747 /* that do not implement a call manager. */
 748
 749 /* CoNdisMiniportCreateVc message */
 750 struct rcondis_mp_create_vc {
 751         u32 req_id;
 752         u32 ndis_vc_handle;
 753 };
 754
 755 /* Response to CoNdisMiniportCreateVc */
 756 struct rcondis_mp_create_vc_complete {
 757         u32 req_id;
 758         u32 dev_vc_handle;
 759         u32 status;
 760 };
 761
 762 /* CoNdisMiniportDeleteVc message */
 763 struct rcondis_mp_delete_vc {
 764         u32 req_id;
 765         u32 dev_vc_handle;
 766 };
 767
 768 /* Response to CoNdisMiniportDeleteVc */
 769 struct rcondis_mp_delete_vc_complete {
 770         u32 req_id;
 771         u32 status;
 772 };
 773
 774 /* CoNdisMiniportQueryRequest message */
 775 struct rcondis_mp_query_request {
 776         u32 req_id;
 777         u32 request_type;
 778         u32 oid;
 779         u32 dev_vc_handle;
 780         u32 info_buflen;
 781         u32 info_buf_offset;
 782 };
 783
 784 /* CoNdisMiniportSetRequest message */
 785 struct rcondis_mp_set_request {
 786         u32 req_id;
 787         u32 request_type;
 788         u32 oid;
 789         u32 dev_vc_handle;
 790         u32 info_buflen;
 791         u32 info_buf_offset;
 792 };
 793
 794 /* CoNdisIndicateStatus message */
 795 struct rcondis_indicate_status {
 796         u32 ndis_vc_handle;
 797         u32 status;
 798         u32 status_buflen;
 799         u32 status_buf_offset;
 800 };
 801
 802 /* CONDIS Call/VC parameters */
 803 struct rcondis_specific_parameters {
 804         u32 parameter_type;
 805         u32 parameter_length;
 806         u32 parameter_lffset;
 807 };
 808
 809 struct rcondis_media_parameters {
 810         u32 flags;
 811         u32 reserved1;
 812         u32 reserved2;
 813         struct rcondis_specific_parameters media_specific;
 814 };
 815
 816 struct rndis_flowspec {
 817         u32 token_rate;
 818         u32 token_bucket_size;
 819         u32 peak_bandwidth;
 820         u32 latency;
 821         u32 delay_variation;
 822         u32 service_type;
 823         u32 max_sdu_size;
 824         u32 minimum_policed_size;
 825 };
 826
 827 struct rcondis_call_manager_parameters {
 828         struct rndis_flowspec transmit;
 829         struct rndis_flowspec receive;
 830         struct rcondis_specific_parameters call_mgr_specific;
 831 };
 832
 833 /* CoNdisMiniportActivateVc message */
 834 struct rcondis_mp_activate_vc_request {
 835         u32 req_id;
 836         u32 flags;
 837         u32 dev_vc_handle;
 838         u32 media_params_offset;
 839         u32 media_params_length;
 840         u32 call_mgr_params_offset;
 841         u32 call_mgr_params_length;
 842 };
 843
 844 /* Response to CoNdisMiniportActivateVc */
 845 struct rcondis_mp_activate_vc_complete {
 846         u32 req_id;
 847         u32 status;
 848 };
 849
 850 /* CoNdisMiniportDeactivateVc message */
 851 struct rcondis_mp_deactivate_vc_request {
 852         u32 req_id;
 853         u32 flags;
 854         u32 dev_vc_handle;
 855 };
 856
 857 /* Response to CoNdisMiniportDeactivateVc */
 858 struct rcondis_mp_deactivate_vc_complete {
 859         u32 req_id;
 860         u32 status;
 861 };
 862
 863
 864 /* union with all of the RNDIS messages */
 865 union rndis_message_container {
 866         struct rndis_packet pkt;
 867         struct rndis_initialize_request init_req;
 868         struct rndis_halt_request halt_req;
 869         struct rndis_query_request query_req;
 870         struct rndis_set_request set_req;
 871         struct rndis_reset_request reset_req;
 872         struct rndis_keepalive_request keep_alive_req;
 873         struct rndis_indicate_status indicate_status;
 874         struct rndis_initialize_complete init_complete;
 875         struct rndis_query_complete query_complete;
 876         struct rndis_set_complete set_complete;
 877         struct rndis_reset_complete reset_complete;
 878         struct rndis_keepalive_complete keep_alive_complete;
 879         struct rcondis_mp_create_vc co_miniport_create_vc;
 880         struct rcondis_mp_delete_vc co_miniport_delete_vc;
 881         struct rcondis_indicate_status co_indicate_status;
 882         struct rcondis_mp_activate_vc_request co_miniport_activate_vc;
 883         struct rcondis_mp_deactivate_vc_request co_miniport_deactivate_vc;
 884         struct rcondis_mp_create_vc_complete co_miniport_create_vc_complete;
 885         struct rcondis_mp_delete_vc_complete co_miniport_delete_vc_complete;
 886         struct rcondis_mp_activate_vc_complete co_miniport_activate_vc_complete;
 887         struct rcondis_mp_deactivate_vc_complete
 888                 co_miniport_deactivate_vc_complete;
 889 };
 890
 891 /* Remote NDIS message format */
 892 struct rndis_message {
 893         u32 ndis_msg_type;
 894
 895         /* Total length of this message, from the beginning */
 896         /* of the sruct rndis_message, in bytes. */
 897         u32 msg_len;
 898
 899         /* Actual message */
 900         union rndis_message_container msg;
 901 };
 902
 903
 904 /* Handy macros */
 905
 906 /* get the size of an RNDIS message. Pass in the message type, */
 907 /* struct rndis_set_request, struct rndis_packet for example */
 908 #define RNDIS_MESSAGE_SIZE(msg)                         \
 909         (sizeof(msg) + (sizeof(struct rndis_message) -  \
 910          sizeof(union rndis_message_container)))
 911
 912 /* get pointer to info buffer with message pointer */
 913 #define MESSAGE_TO_INFO_BUFFER(msg)                             \
 914         (((unsigned char *)(msg)) + msg->info_buf_offset)
 915
 916 /* get pointer to status buffer with message pointer */
 917 #define MESSAGE_TO_STATUS_BUFFER(msg)                   \
 918         (((unsigned char *)(msg)) + msg->status_buf_offset)
 919
 920 /* get pointer to OOBD buffer with message pointer */
 921 #define MESSAGE_TO_OOBD_BUFFER(msg)                             \
 922         (((unsigned char *)(msg)) + msg->oob_data_offset)
 923
 924 /* get pointer to data buffer with message pointer */
 925 #define MESSAGE_TO_DATA_BUFFER(msg)                             \
 926         (((unsigned char *)(msg)) + msg->per_pkt_info_offset)
 927
 928 /* get pointer to contained message from NDIS_MESSAGE pointer */
 929 #define RNDIS_MESSAGE_PTR_TO_MESSAGE_PTR(rndis_msg)             \
 930         ((void *) &rndis_msg->msg)
 931
 932 /* get pointer to contained message from NDIS_MESSAGE pointer */
 933 #define RNDIS_MESSAGE_RAW_PTR_TO_MESSAGE_PTR(rndis_msg) \
 934         ((void *) rndis_msg)
 935
 936
 937 #define __struct_bcount(x)
 938
 939
 940
 941 #define RNDIS_HEADER_SIZE       (sizeof(struct rndis_message) - \
 942                                  sizeof(union rndis_message_container))
 943
 944 #define NDIS_PACKET_TYPE_DIRECTED       0x00000001
 945 #define NDIS_PACKET_TYPE_MULTICAST      0x00000002
 946 #define NDIS_PACKET_TYPE_ALL_MULTICAST  0x00000004
 947 #define NDIS_PACKET_TYPE_BROADCAST      0x00000008
 948 #define NDIS_PACKET_TYPE_SOURCE_ROUTING 0x00000010
 949 #define NDIS_PACKET_TYPE_PROMISCUOUS    0x00000020
 950 #define NDIS_PACKET_TYPE_SMT            0x00000040
 951 #define NDIS_PACKET_TYPE_ALL_LOCAL      0x00000080
 952 #define NDIS_PACKET_TYPE_GROUP          0x00000100
 953 #define NDIS_PACKET_TYPE_ALL_FUNCTIONAL 0x00000200
 954 #define NDIS_PACKET_TYPE_FUNCTIONAL     0x00000400
 955 #define NDIS_PACKET_TYPE_MAC_FRAME      0x00000800
 956
 957
 958
 959 #endif /* _HYPERV_NET_H */