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