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, write to the Free Software Foundation, Inc., 59 Temple 16 * Place - Suite 330, Boston, MA 02111-1307 USA. 17 * 18 * Authors: 19 * Haiyang Zhang <haiyangz@microsoft.com> 20 * Hank Janssen <hjanssen@microsoft.com> 21 * K. Y. Srinivasan <kys@microsoft.com> 22 * 23 */ 24 25 #ifndef _HYPERV_H 26 #define _HYPERV_H 27 28 #include <uapi/linux/hyperv.h> 29 30 #include <linux/types.h> 31 #include <linux/scatterlist.h> 32 #include <linux/list.h> 33 #include <linux/timer.h> 34 #include <linux/workqueue.h> 35 #include <linux/completion.h> 36 #include <linux/device.h> 37 #include <linux/mod_devicetable.h> 38 39 40 #define MAX_PAGE_BUFFER_COUNT 32 41 #define MAX_MULTIPAGE_BUFFER_COUNT 32 /* 128K */ 42 43 #pragma pack(push, 1) 44 45 /* Single-page buffer */ 46 struct hv_page_buffer { 47 u32 len; 48 u32 offset; 49 u64 pfn; 50 }; 51 52 /* Multiple-page buffer */ 53 struct hv_multipage_buffer { 54 /* Length and Offset determines the # of pfns in the array */ 55 u32 len; 56 u32 offset; 57 u64 pfn_array[MAX_MULTIPAGE_BUFFER_COUNT]; 58 }; 59 60 /* 61 * Multiple-page buffer array; the pfn array is variable size: 62 * The number of entries in the PFN array is determined by 63 * "len" and "offset". 64 */ 65 struct hv_mpb_array { 66 /* Length and Offset determines the # of pfns in the array */ 67 u32 len; 68 u32 offset; 69 u64 pfn_array[]; 70 }; 71 72 /* 0x18 includes the proprietary packet header */ 73 #define MAX_PAGE_BUFFER_PACKET (0x18 + \ 74 (sizeof(struct hv_page_buffer) * \ 75 MAX_PAGE_BUFFER_COUNT)) 76 #define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + \ 77 sizeof(struct hv_multipage_buffer)) 78 79 80 #pragma pack(pop) 81 82 struct hv_ring_buffer { 83 /* Offset in bytes from the start of ring data below */ 84 u32 write_index; 85 86 /* Offset in bytes from the start of ring data below */ 87 u32 read_index; 88 89 u32 interrupt_mask; 90 91 /* 92 * Win8 uses some of the reserved bits to implement 93 * interrupt driven flow management. On the send side 94 * we can request that the receiver interrupt the sender 95 * when the ring transitions from being full to being able 96 * to handle a message of size "pending_send_sz". 97 * 98 * Add necessary state for this enhancement. 99 */ 100 u32 pending_send_sz; 101 102 u32 reserved1[12]; 103 104 union { 105 struct { 106 u32 feat_pending_send_sz:1; 107 }; 108 u32 value; 109 } feature_bits; 110 111 /* Pad it to PAGE_SIZE so that data starts on page boundary */ 112 u8 reserved2[4028]; 113 114 /* 115 * Ring data starts here + RingDataStartOffset 116 * !!! DO NOT place any fields below this !!! 117 */ 118 u8 buffer[0]; 119 } __packed; 120 121 struct hv_ring_buffer_info { 122 struct hv_ring_buffer *ring_buffer; 123 u32 ring_size; /* Include the shared header */ 124 spinlock_t ring_lock; 125 126 u32 ring_datasize; /* < ring_size */ 127 u32 ring_data_startoffset; 128 }; 129 130 /* 131 * 132 * hv_get_ringbuffer_availbytes() 133 * 134 * Get number of bytes available to read and to write to 135 * for the specified ring buffer 136 */ 137 static inline void 138 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info *rbi, 139 u32 *read, u32 *write) 140 { 141 u32 read_loc, write_loc, dsize; 142 143 smp_read_barrier_depends(); 144 145 /* Capture the read/write indices before they changed */ 146 read_loc = rbi->ring_buffer->read_index; 147 write_loc = rbi->ring_buffer->write_index; 148 dsize = rbi->ring_datasize; 149 150 *write = write_loc >= read_loc ? dsize - (write_loc - read_loc) : 151 read_loc - write_loc; 152 *read = dsize - *write; 153 } 154 155 /* 156 * VMBUS version is 32 bit entity broken up into 157 * two 16 bit quantities: major_number. minor_number. 158 * 159 * 0 . 13 (Windows Server 2008) 160 * 1 . 1 (Windows 7) 161 * 2 . 4 (Windows 8) 162 * 3 . 0 (Windows 8 R2) 163 * 4 . 0 (Windows 10) 164 */ 165 166 #define VERSION_WS2008 ((0 << 16) | (13)) 167 #define VERSION_WIN7 ((1 << 16) | (1)) 168 #define VERSION_WIN8 ((2 << 16) | (4)) 169 #define VERSION_WIN8_1 ((3 << 16) | (0)) 170 #define VERSION_WIN10 ((4 << 16) | (0)) 171 172 #define VERSION_INVAL -1 173 174 #define VERSION_CURRENT VERSION_WIN10 175 176 /* Make maximum size of pipe payload of 16K */ 177 #define MAX_PIPE_DATA_PAYLOAD (sizeof(u8) * 16384) 178 179 /* Define PipeMode values. */ 180 #define VMBUS_PIPE_TYPE_BYTE 0x00000000 181 #define VMBUS_PIPE_TYPE_MESSAGE 0x00000004 182 183 /* The size of the user defined data buffer for non-pipe offers. */ 184 #define MAX_USER_DEFINED_BYTES 120 185 186 /* The size of the user defined data buffer for pipe offers. */ 187 #define MAX_PIPE_USER_DEFINED_BYTES 116 188 189 /* 190 * At the center of the Channel Management library is the Channel Offer. This 191 * struct contains the fundamental information about an offer. 192 */ 193 struct vmbus_channel_offer { 194 uuid_le if_type; 195 uuid_le if_instance; 196 197 /* 198 * These two fields are not currently used. 199 */ 200 u64 reserved1; 201 u64 reserved2; 202 203 u16 chn_flags; 204 u16 mmio_megabytes; /* in bytes * 1024 * 1024 */ 205 206 union { 207 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */ 208 struct { 209 unsigned char user_def[MAX_USER_DEFINED_BYTES]; 210 } std; 211 212 /* 213 * Pipes: 214 * The following sructure is an integrated pipe protocol, which 215 * is implemented on top of standard user-defined data. Pipe 216 * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own 217 * use. 218 */ 219 struct { 220 u32 pipe_mode; 221 unsigned char user_def[MAX_PIPE_USER_DEFINED_BYTES]; 222 } pipe; 223 } u; 224 /* 225 * The sub_channel_index is defined in win8. 226 */ 227 u16 sub_channel_index; 228 u16 reserved3; 229 } __packed; 230 231 /* Server Flags */ 232 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE 1 233 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES 2 234 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS 4 235 #define VMBUS_CHANNEL_NAMED_PIPE_MODE 0x10 236 #define VMBUS_CHANNEL_LOOPBACK_OFFER 0x100 237 #define VMBUS_CHANNEL_PARENT_OFFER 0x200 238 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION 0x400 239 240 struct vmpacket_descriptor { 241 u16 type; 242 u16 offset8; 243 u16 len8; 244 u16 flags; 245 u64 trans_id; 246 } __packed; 247 248 struct vmpacket_header { 249 u32 prev_pkt_start_offset; 250 struct vmpacket_descriptor descriptor; 251 } __packed; 252 253 struct vmtransfer_page_range { 254 u32 byte_count; 255 u32 byte_offset; 256 } __packed; 257 258 struct vmtransfer_page_packet_header { 259 struct vmpacket_descriptor d; 260 u16 xfer_pageset_id; 261 u8 sender_owns_set; 262 u8 reserved; 263 u32 range_cnt; 264 struct vmtransfer_page_range ranges[1]; 265 } __packed; 266 267 struct vmgpadl_packet_header { 268 struct vmpacket_descriptor d; 269 u32 gpadl; 270 u32 reserved; 271 } __packed; 272 273 struct vmadd_remove_transfer_page_set { 274 struct vmpacket_descriptor d; 275 u32 gpadl; 276 u16 xfer_pageset_id; 277 u16 reserved; 278 } __packed; 279 280 /* 281 * This structure defines a range in guest physical space that can be made to 282 * look virtually contiguous. 283 */ 284 struct gpa_range { 285 u32 byte_count; 286 u32 byte_offset; 287 u64 pfn_array[0]; 288 }; 289 290 /* 291 * This is the format for an Establish Gpadl packet, which contains a handle by 292 * which this GPADL will be known and a set of GPA ranges associated with it. 293 * This can be converted to a MDL by the guest OS. If there are multiple GPA 294 * ranges, then the resulting MDL will be "chained," representing multiple VA 295 * ranges. 296 */ 297 struct vmestablish_gpadl { 298 struct vmpacket_descriptor d; 299 u32 gpadl; 300 u32 range_cnt; 301 struct gpa_range range[1]; 302 } __packed; 303 304 /* 305 * This is the format for a Teardown Gpadl packet, which indicates that the 306 * GPADL handle in the Establish Gpadl packet will never be referenced again. 307 */ 308 struct vmteardown_gpadl { 309 struct vmpacket_descriptor d; 310 u32 gpadl; 311 u32 reserved; /* for alignment to a 8-byte boundary */ 312 } __packed; 313 314 /* 315 * This is the format for a GPA-Direct packet, which contains a set of GPA 316 * ranges, in addition to commands and/or data. 317 */ 318 struct vmdata_gpa_direct { 319 struct vmpacket_descriptor d; 320 u32 reserved; 321 u32 range_cnt; 322 struct gpa_range range[1]; 323 } __packed; 324 325 /* This is the format for a Additional Data Packet. */ 326 struct vmadditional_data { 327 struct vmpacket_descriptor d; 328 u64 total_bytes; 329 u32 offset; 330 u32 byte_cnt; 331 unsigned char data[1]; 332 } __packed; 333 334 union vmpacket_largest_possible_header { 335 struct vmpacket_descriptor simple_hdr; 336 struct vmtransfer_page_packet_header xfer_page_hdr; 337 struct vmgpadl_packet_header gpadl_hdr; 338 struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr; 339 struct vmestablish_gpadl establish_gpadl_hdr; 340 struct vmteardown_gpadl teardown_gpadl_hdr; 341 struct vmdata_gpa_direct data_gpa_direct_hdr; 342 }; 343 344 #define VMPACKET_DATA_START_ADDRESS(__packet) \ 345 (void *)(((unsigned char *)__packet) + \ 346 ((struct vmpacket_descriptor)__packet)->offset8 * 8) 347 348 #define VMPACKET_DATA_LENGTH(__packet) \ 349 ((((struct vmpacket_descriptor)__packet)->len8 - \ 350 ((struct vmpacket_descriptor)__packet)->offset8) * 8) 351 352 #define VMPACKET_TRANSFER_MODE(__packet) \ 353 (((struct IMPACT)__packet)->type) 354 355 enum vmbus_packet_type { 356 VM_PKT_INVALID = 0x0, 357 VM_PKT_SYNCH = 0x1, 358 VM_PKT_ADD_XFER_PAGESET = 0x2, 359 VM_PKT_RM_XFER_PAGESET = 0x3, 360 VM_PKT_ESTABLISH_GPADL = 0x4, 361 VM_PKT_TEARDOWN_GPADL = 0x5, 362 VM_PKT_DATA_INBAND = 0x6, 363 VM_PKT_DATA_USING_XFER_PAGES = 0x7, 364 VM_PKT_DATA_USING_GPADL = 0x8, 365 VM_PKT_DATA_USING_GPA_DIRECT = 0x9, 366 VM_PKT_CANCEL_REQUEST = 0xa, 367 VM_PKT_COMP = 0xb, 368 VM_PKT_DATA_USING_ADDITIONAL_PKT = 0xc, 369 VM_PKT_ADDITIONAL_DATA = 0xd 370 }; 371 372 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED 1 373 374 375 /* Version 1 messages */ 376 enum vmbus_channel_message_type { 377 CHANNELMSG_INVALID = 0, 378 CHANNELMSG_OFFERCHANNEL = 1, 379 CHANNELMSG_RESCIND_CHANNELOFFER = 2, 380 CHANNELMSG_REQUESTOFFERS = 3, 381 CHANNELMSG_ALLOFFERS_DELIVERED = 4, 382 CHANNELMSG_OPENCHANNEL = 5, 383 CHANNELMSG_OPENCHANNEL_RESULT = 6, 384 CHANNELMSG_CLOSECHANNEL = 7, 385 CHANNELMSG_GPADL_HEADER = 8, 386 CHANNELMSG_GPADL_BODY = 9, 387 CHANNELMSG_GPADL_CREATED = 10, 388 CHANNELMSG_GPADL_TEARDOWN = 11, 389 CHANNELMSG_GPADL_TORNDOWN = 12, 390 CHANNELMSG_RELID_RELEASED = 13, 391 CHANNELMSG_INITIATE_CONTACT = 14, 392 CHANNELMSG_VERSION_RESPONSE = 15, 393 CHANNELMSG_UNLOAD = 16, 394 CHANNELMSG_UNLOAD_RESPONSE = 17, 395 CHANNELMSG_COUNT 396 }; 397 398 struct vmbus_channel_message_header { 399 enum vmbus_channel_message_type msgtype; 400 u32 padding; 401 } __packed; 402 403 /* Query VMBus Version parameters */ 404 struct vmbus_channel_query_vmbus_version { 405 struct vmbus_channel_message_header header; 406 u32 version; 407 } __packed; 408 409 /* VMBus Version Supported parameters */ 410 struct vmbus_channel_version_supported { 411 struct vmbus_channel_message_header header; 412 u8 version_supported; 413 } __packed; 414 415 /* Offer Channel parameters */ 416 struct vmbus_channel_offer_channel { 417 struct vmbus_channel_message_header header; 418 struct vmbus_channel_offer offer; 419 u32 child_relid; 420 u8 monitorid; 421 /* 422 * win7 and beyond splits this field into a bit field. 423 */ 424 u8 monitor_allocated:1; 425 u8 reserved:7; 426 /* 427 * These are new fields added in win7 and later. 428 * Do not access these fields without checking the 429 * negotiated protocol. 430 * 431 * If "is_dedicated_interrupt" is set, we must not set the 432 * associated bit in the channel bitmap while sending the 433 * interrupt to the host. 434 * 435 * connection_id is to be used in signaling the host. 436 */ 437 u16 is_dedicated_interrupt:1; 438 u16 reserved1:15; 439 u32 connection_id; 440 } __packed; 441 442 /* Rescind Offer parameters */ 443 struct vmbus_channel_rescind_offer { 444 struct vmbus_channel_message_header header; 445 u32 child_relid; 446 } __packed; 447 448 /* 449 * Request Offer -- no parameters, SynIC message contains the partition ID 450 * Set Snoop -- no parameters, SynIC message contains the partition ID 451 * Clear Snoop -- no parameters, SynIC message contains the partition ID 452 * All Offers Delivered -- no parameters, SynIC message contains the partition 453 * ID 454 * Flush Client -- no parameters, SynIC message contains the partition ID 455 */ 456 457 /* Open Channel parameters */ 458 struct vmbus_channel_open_channel { 459 struct vmbus_channel_message_header header; 460 461 /* Identifies the specific VMBus channel that is being opened. */ 462 u32 child_relid; 463 464 /* ID making a particular open request at a channel offer unique. */ 465 u32 openid; 466 467 /* GPADL for the channel's ring buffer. */ 468 u32 ringbuffer_gpadlhandle; 469 470 /* 471 * Starting with win8, this field will be used to specify 472 * the target virtual processor on which to deliver the interrupt for 473 * the host to guest communication. 474 * Prior to win8, incoming channel interrupts would only 475 * be delivered on cpu 0. Setting this value to 0 would 476 * preserve the earlier behavior. 477 */ 478 u32 target_vp; 479 480 /* 481 * The upstream ring buffer begins at offset zero in the memory 482 * described by RingBufferGpadlHandle. The downstream ring buffer 483 * follows it at this offset (in pages). 484 */ 485 u32 downstream_ringbuffer_pageoffset; 486 487 /* User-specific data to be passed along to the server endpoint. */ 488 unsigned char userdata[MAX_USER_DEFINED_BYTES]; 489 } __packed; 490 491 /* Open Channel Result parameters */ 492 struct vmbus_channel_open_result { 493 struct vmbus_channel_message_header header; 494 u32 child_relid; 495 u32 openid; 496 u32 status; 497 } __packed; 498 499 /* Close channel parameters; */ 500 struct vmbus_channel_close_channel { 501 struct vmbus_channel_message_header header; 502 u32 child_relid; 503 } __packed; 504 505 /* Channel Message GPADL */ 506 #define GPADL_TYPE_RING_BUFFER 1 507 #define GPADL_TYPE_SERVER_SAVE_AREA 2 508 #define GPADL_TYPE_TRANSACTION 8 509 510 /* 511 * The number of PFNs in a GPADL message is defined by the number of 512 * pages that would be spanned by ByteCount and ByteOffset. If the 513 * implied number of PFNs won't fit in this packet, there will be a 514 * follow-up packet that contains more. 515 */ 516 struct vmbus_channel_gpadl_header { 517 struct vmbus_channel_message_header header; 518 u32 child_relid; 519 u32 gpadl; 520 u16 range_buflen; 521 u16 rangecount; 522 struct gpa_range range[0]; 523 } __packed; 524 525 /* This is the followup packet that contains more PFNs. */ 526 struct vmbus_channel_gpadl_body { 527 struct vmbus_channel_message_header header; 528 u32 msgnumber; 529 u32 gpadl; 530 u64 pfn[0]; 531 } __packed; 532 533 struct vmbus_channel_gpadl_created { 534 struct vmbus_channel_message_header header; 535 u32 child_relid; 536 u32 gpadl; 537 u32 creation_status; 538 } __packed; 539 540 struct vmbus_channel_gpadl_teardown { 541 struct vmbus_channel_message_header header; 542 u32 child_relid; 543 u32 gpadl; 544 } __packed; 545 546 struct vmbus_channel_gpadl_torndown { 547 struct vmbus_channel_message_header header; 548 u32 gpadl; 549 } __packed; 550 551 struct vmbus_channel_relid_released { 552 struct vmbus_channel_message_header header; 553 u32 child_relid; 554 } __packed; 555 556 struct vmbus_channel_initiate_contact { 557 struct vmbus_channel_message_header header; 558 u32 vmbus_version_requested; 559 u32 target_vcpu; /* The VCPU the host should respond to */ 560 u64 interrupt_page; 561 u64 monitor_page1; 562 u64 monitor_page2; 563 } __packed; 564 565 struct vmbus_channel_version_response { 566 struct vmbus_channel_message_header header; 567 u8 version_supported; 568 } __packed; 569 570 enum vmbus_channel_state { 571 CHANNEL_OFFER_STATE, 572 CHANNEL_OPENING_STATE, 573 CHANNEL_OPEN_STATE, 574 CHANNEL_OPENED_STATE, 575 }; 576 577 /* 578 * Represents each channel msg on the vmbus connection This is a 579 * variable-size data structure depending on the msg type itself 580 */ 581 struct vmbus_channel_msginfo { 582 /* Bookkeeping stuff */ 583 struct list_head msglistentry; 584 585 /* So far, this is only used to handle gpadl body message */ 586 struct list_head submsglist; 587 588 /* Synchronize the request/response if needed */ 589 struct completion waitevent; 590 union { 591 struct vmbus_channel_version_supported version_supported; 592 struct vmbus_channel_open_result open_result; 593 struct vmbus_channel_gpadl_torndown gpadl_torndown; 594 struct vmbus_channel_gpadl_created gpadl_created; 595 struct vmbus_channel_version_response version_response; 596 } response; 597 598 u32 msgsize; 599 /* 600 * The channel message that goes out on the "wire". 601 * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header 602 */ 603 unsigned char msg[0]; 604 }; 605 606 struct vmbus_close_msg { 607 struct vmbus_channel_msginfo info; 608 struct vmbus_channel_close_channel msg; 609 }; 610 611 /* Define connection identifier type. */ 612 union hv_connection_id { 613 u32 asu32; 614 struct { 615 u32 id:24; 616 u32 reserved:8; 617 } u; 618 }; 619 620 /* Definition of the hv_signal_event hypercall input structure. */ 621 struct hv_input_signal_event { 622 union hv_connection_id connectionid; 623 u16 flag_number; 624 u16 rsvdz; 625 }; 626 627 struct hv_input_signal_event_buffer { 628 u64 align8; 629 struct hv_input_signal_event event; 630 }; 631 632 struct vmbus_channel { 633 /* Unique channel id */ 634 int id; 635 636 struct list_head listentry; 637 638 struct hv_device *device_obj; 639 640 enum vmbus_channel_state state; 641 642 struct vmbus_channel_offer_channel offermsg; 643 /* 644 * These are based on the OfferMsg.MonitorId. 645 * Save it here for easy access. 646 */ 647 u8 monitor_grp; 648 u8 monitor_bit; 649 650 bool rescind; /* got rescind msg */ 651 652 u32 ringbuffer_gpadlhandle; 653 654 /* Allocated memory for ring buffer */ 655 void *ringbuffer_pages; 656 u32 ringbuffer_pagecount; 657 struct hv_ring_buffer_info outbound; /* send to parent */ 658 struct hv_ring_buffer_info inbound; /* receive from parent */ 659 spinlock_t inbound_lock; 660 661 struct vmbus_close_msg close_msg; 662 663 /* Channel callback are invoked in this workqueue context */ 664 /* HANDLE dataWorkQueue; */ 665 666 void (*onchannel_callback)(void *context); 667 void *channel_callback_context; 668 669 /* 670 * A channel can be marked for efficient (batched) 671 * reading: 672 * If batched_reading is set to "true", we read until the 673 * channel is empty and hold off interrupts from the host 674 * during the entire read process. 675 * If batched_reading is set to "false", the client is not 676 * going to perform batched reading. 677 * 678 * By default we will enable batched reading; specific 679 * drivers that don't want this behavior can turn it off. 680 */ 681 682 bool batched_reading; 683 684 bool is_dedicated_interrupt; 685 struct hv_input_signal_event_buffer sig_buf; 686 struct hv_input_signal_event *sig_event; 687 688 /* 689 * Starting with win8, this field will be used to specify 690 * the target virtual processor on which to deliver the interrupt for 691 * the host to guest communication. 692 * Prior to win8, incoming channel interrupts would only 693 * be delivered on cpu 0. Setting this value to 0 would 694 * preserve the earlier behavior. 695 */ 696 u32 target_vp; 697 /* The corresponding CPUID in the guest */ 698 u32 target_cpu; 699 /* 700 * State to manage the CPU affiliation of channels. 701 */ 702 struct cpumask alloced_cpus_in_node; 703 int numa_node; 704 /* 705 * Support for sub-channels. For high performance devices, 706 * it will be useful to have multiple sub-channels to support 707 * a scalable communication infrastructure with the host. 708 * The support for sub-channels is implemented as an extention 709 * to the current infrastructure. 710 * The initial offer is considered the primary channel and this 711 * offer message will indicate if the host supports sub-channels. 712 * The guest is free to ask for sub-channels to be offerred and can 713 * open these sub-channels as a normal "primary" channel. However, 714 * all sub-channels will have the same type and instance guids as the 715 * primary channel. Requests sent on a given channel will result in a 716 * response on the same channel. 717 */ 718 719 /* 720 * Sub-channel creation callback. This callback will be called in 721 * process context when a sub-channel offer is received from the host. 722 * The guest can open the sub-channel in the context of this callback. 723 */ 724 void (*sc_creation_callback)(struct vmbus_channel *new_sc); 725 726 /* 727 * The spinlock to protect the structure. It is being used to protect 728 * test-and-set access to various attributes of the structure as well 729 * as all sc_list operations. 730 */ 731 spinlock_t lock; 732 /* 733 * All Sub-channels of a primary channel are linked here. 734 */ 735 struct list_head sc_list; 736 /* 737 * Current number of sub-channels. 738 */ 739 int num_sc; 740 /* 741 * Number of a sub-channel (position within sc_list) which is supposed 742 * to be used as the next outgoing channel. 743 */ 744 int next_oc; 745 /* 746 * The primary channel this sub-channel belongs to. 747 * This will be NULL for the primary channel. 748 */ 749 struct vmbus_channel *primary_channel; 750 /* 751 * Support per-channel state for use by vmbus drivers. 752 */ 753 void *per_channel_state; 754 /* 755 * To support per-cpu lookup mapping of relid to channel, 756 * link up channels based on their CPU affinity. 757 */ 758 struct list_head percpu_list; 759 }; 760 761 static inline void set_channel_read_state(struct vmbus_channel *c, bool state) 762 { 763 c->batched_reading = state; 764 } 765 766 static inline void set_per_channel_state(struct vmbus_channel *c, void *s) 767 { 768 c->per_channel_state = s; 769 } 770 771 static inline void *get_per_channel_state(struct vmbus_channel *c) 772 { 773 return c->per_channel_state; 774 } 775 776 void vmbus_onmessage(void *context); 777 778 int vmbus_request_offers(void); 779 780 /* 781 * APIs for managing sub-channels. 782 */ 783 784 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel, 785 void (*sc_cr_cb)(struct vmbus_channel *new_sc)); 786 787 /* 788 * Retrieve the (sub) channel on which to send an outgoing request. 789 * When a primary channel has multiple sub-channels, we choose a 790 * channel whose VCPU binding is closest to the VCPU on which 791 * this call is being made. 792 */ 793 struct vmbus_channel *vmbus_get_outgoing_channel(struct vmbus_channel *primary); 794 795 /* 796 * Check if sub-channels have already been offerred. This API will be useful 797 * when the driver is unloaded after establishing sub-channels. In this case, 798 * when the driver is re-loaded, the driver would have to check if the 799 * subchannels have already been established before attempting to request 800 * the creation of sub-channels. 801 * This function returns TRUE to indicate that subchannels have already been 802 * created. 803 * This function should be invoked after setting the callback function for 804 * sub-channel creation. 805 */ 806 bool vmbus_are_subchannels_present(struct vmbus_channel *primary); 807 808 /* The format must be the same as struct vmdata_gpa_direct */ 809 struct vmbus_channel_packet_page_buffer { 810 u16 type; 811 u16 dataoffset8; 812 u16 length8; 813 u16 flags; 814 u64 transactionid; 815 u32 reserved; 816 u32 rangecount; 817 struct hv_page_buffer range[MAX_PAGE_BUFFER_COUNT]; 818 } __packed; 819 820 /* The format must be the same as struct vmdata_gpa_direct */ 821 struct vmbus_channel_packet_multipage_buffer { 822 u16 type; 823 u16 dataoffset8; 824 u16 length8; 825 u16 flags; 826 u64 transactionid; 827 u32 reserved; 828 u32 rangecount; /* Always 1 in this case */ 829 struct hv_multipage_buffer range; 830 } __packed; 831 832 /* The format must be the same as struct vmdata_gpa_direct */ 833 struct vmbus_packet_mpb_array { 834 u16 type; 835 u16 dataoffset8; 836 u16 length8; 837 u16 flags; 838 u64 transactionid; 839 u32 reserved; 840 u32 rangecount; /* Always 1 in this case */ 841 struct hv_mpb_array range; 842 } __packed; 843 844 845 extern int vmbus_open(struct vmbus_channel *channel, 846 u32 send_ringbuffersize, 847 u32 recv_ringbuffersize, 848 void *userdata, 849 u32 userdatalen, 850 void(*onchannel_callback)(void *context), 851 void *context); 852 853 extern void vmbus_close(struct vmbus_channel *channel); 854 855 extern int vmbus_sendpacket(struct vmbus_channel *channel, 856 void *buffer, 857 u32 bufferLen, 858 u64 requestid, 859 enum vmbus_packet_type type, 860 u32 flags); 861 862 extern int vmbus_sendpacket_ctl(struct vmbus_channel *channel, 863 void *buffer, 864 u32 bufferLen, 865 u64 requestid, 866 enum vmbus_packet_type type, 867 u32 flags, 868 bool kick_q); 869 870 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel *channel, 871 struct hv_page_buffer pagebuffers[], 872 u32 pagecount, 873 void *buffer, 874 u32 bufferlen, 875 u64 requestid); 876 877 extern int vmbus_sendpacket_pagebuffer_ctl(struct vmbus_channel *channel, 878 struct hv_page_buffer pagebuffers[], 879 u32 pagecount, 880 void *buffer, 881 u32 bufferlen, 882 u64 requestid, 883 u32 flags, 884 bool kick_q); 885 886 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel *channel, 887 struct hv_multipage_buffer *mpb, 888 void *buffer, 889 u32 bufferlen, 890 u64 requestid); 891 892 extern int vmbus_sendpacket_mpb_desc(struct vmbus_channel *channel, 893 struct vmbus_packet_mpb_array *mpb, 894 u32 desc_size, 895 void *buffer, 896 u32 bufferlen, 897 u64 requestid); 898 899 extern int vmbus_establish_gpadl(struct vmbus_channel *channel, 900 void *kbuffer, 901 u32 size, 902 u32 *gpadl_handle); 903 904 extern int vmbus_teardown_gpadl(struct vmbus_channel *channel, 905 u32 gpadl_handle); 906 907 extern int vmbus_recvpacket(struct vmbus_channel *channel, 908 void *buffer, 909 u32 bufferlen, 910 u32 *buffer_actual_len, 911 u64 *requestid); 912 913 extern int vmbus_recvpacket_raw(struct vmbus_channel *channel, 914 void *buffer, 915 u32 bufferlen, 916 u32 *buffer_actual_len, 917 u64 *requestid); 918 919 920 extern void vmbus_ontimer(unsigned long data); 921 922 /* Base driver object */ 923 struct hv_driver { 924 const char *name; 925 926 /* the device type supported by this driver */ 927 uuid_le dev_type; 928 const struct hv_vmbus_device_id *id_table; 929 930 struct device_driver driver; 931 932 int (*probe)(struct hv_device *, const struct hv_vmbus_device_id *); 933 int (*remove)(struct hv_device *); 934 void (*shutdown)(struct hv_device *); 935 936 }; 937 938 /* Base device object */ 939 struct hv_device { 940 /* the device type id of this device */ 941 uuid_le dev_type; 942 943 /* the device instance id of this device */ 944 uuid_le dev_instance; 945 946 struct device device; 947 948 struct vmbus_channel *channel; 949 }; 950 951 952 static inline struct hv_device *device_to_hv_device(struct device *d) 953 { 954 return container_of(d, struct hv_device, device); 955 } 956 957 static inline struct hv_driver *drv_to_hv_drv(struct device_driver *d) 958 { 959 return container_of(d, struct hv_driver, driver); 960 } 961 962 static inline void hv_set_drvdata(struct hv_device *dev, void *data) 963 { 964 dev_set_drvdata(&dev->device, data); 965 } 966 967 static inline void *hv_get_drvdata(struct hv_device *dev) 968 { 969 return dev_get_drvdata(&dev->device); 970 } 971 972 /* Vmbus interface */ 973 #define vmbus_driver_register(driver) \ 974 __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME) 975 int __must_check __vmbus_driver_register(struct hv_driver *hv_driver, 976 struct module *owner, 977 const char *mod_name); 978 void vmbus_driver_unregister(struct hv_driver *hv_driver); 979 980 /** 981 * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device 982 * 983 * This macro is used to create a struct hv_vmbus_device_id that matches a 984 * specific device. 985 */ 986 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7, \ 987 g8, g9, ga, gb, gc, gd, ge, gf) \ 988 .guid = { g0, g1, g2, g3, g4, g5, g6, g7, \ 989 g8, g9, ga, gb, gc, gd, ge, gf }, 990 991 /* 992 * GUID definitions of various offer types - services offered to the guest. 993 */ 994 995 /* 996 * Network GUID 997 * {f8615163-df3e-46c5-913f-f2d2f965ed0e} 998 */ 999 #define HV_NIC_GUID \ 1000 .guid = { \ 1001 0x63, 0x51, 0x61, 0xf8, 0x3e, 0xdf, 0xc5, 0x46, \ 1002 0x91, 0x3f, 0xf2, 0xd2, 0xf9, 0x65, 0xed, 0x0e \ 1003 } 1004 1005 /* 1006 * IDE GUID 1007 * {32412632-86cb-44a2-9b5c-50d1417354f5} 1008 */ 1009 #define HV_IDE_GUID \ 1010 .guid = { \ 1011 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44, \ 1012 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5 \ 1013 } 1014 1015 /* 1016 * SCSI GUID 1017 * {ba6163d9-04a1-4d29-b605-72e2ffb1dc7f} 1018 */ 1019 #define HV_SCSI_GUID \ 1020 .guid = { \ 1021 0xd9, 0x63, 0x61, 0xba, 0xa1, 0x04, 0x29, 0x4d, \ 1022 0xb6, 0x05, 0x72, 0xe2, 0xff, 0xb1, 0xdc, 0x7f \ 1023 } 1024 1025 /* 1026 * Shutdown GUID 1027 * {0e0b6031-5213-4934-818b-38d90ced39db} 1028 */ 1029 #define HV_SHUTDOWN_GUID \ 1030 .guid = { \ 1031 0x31, 0x60, 0x0b, 0x0e, 0x13, 0x52, 0x34, 0x49, \ 1032 0x81, 0x8b, 0x38, 0xd9, 0x0c, 0xed, 0x39, 0xdb \ 1033 } 1034 1035 /* 1036 * Time Synch GUID 1037 * {9527E630-D0AE-497b-ADCE-E80AB0175CAF} 1038 */ 1039 #define HV_TS_GUID \ 1040 .guid = { \ 1041 0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49, \ 1042 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf \ 1043 } 1044 1045 /* 1046 * Heartbeat GUID 1047 * {57164f39-9115-4e78-ab55-382f3bd5422d} 1048 */ 1049 #define HV_HEART_BEAT_GUID \ 1050 .guid = { \ 1051 0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e, \ 1052 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d \ 1053 } 1054 1055 /* 1056 * KVP GUID 1057 * {a9a0f4e7-5a45-4d96-b827-8a841e8c03e6} 1058 */ 1059 #define HV_KVP_GUID \ 1060 .guid = { \ 1061 0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d, \ 1062 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6 \ 1063 } 1064 1065 /* 1066 * Dynamic memory GUID 1067 * {525074dc-8985-46e2-8057-a307dc18a502} 1068 */ 1069 #define HV_DM_GUID \ 1070 .guid = { \ 1071 0xdc, 0x74, 0x50, 0X52, 0x85, 0x89, 0xe2, 0x46, \ 1072 0x80, 0x57, 0xa3, 0x07, 0xdc, 0x18, 0xa5, 0x02 \ 1073 } 1074 1075 /* 1076 * Mouse GUID 1077 * {cfa8b69e-5b4a-4cc0-b98b-8ba1a1f3f95a} 1078 */ 1079 #define HV_MOUSE_GUID \ 1080 .guid = { \ 1081 0x9e, 0xb6, 0xa8, 0xcf, 0x4a, 0x5b, 0xc0, 0x4c, \ 1082 0xb9, 0x8b, 0x8b, 0xa1, 0xa1, 0xf3, 0xf9, 0x5a \ 1083 } 1084 1085 /* 1086 * VSS (Backup/Restore) GUID 1087 */ 1088 #define HV_VSS_GUID \ 1089 .guid = { \ 1090 0x29, 0x2e, 0xfa, 0x35, 0x23, 0xea, 0x36, 0x42, \ 1091 0x96, 0xae, 0x3a, 0x6e, 0xba, 0xcb, 0xa4, 0x40 \ 1092 } 1093 /* 1094 * Synthetic Video GUID 1095 * {DA0A7802-E377-4aac-8E77-0558EB1073F8} 1096 */ 1097 #define HV_SYNTHVID_GUID \ 1098 .guid = { \ 1099 0x02, 0x78, 0x0a, 0xda, 0x77, 0xe3, 0xac, 0x4a, \ 1100 0x8e, 0x77, 0x05, 0x58, 0xeb, 0x10, 0x73, 0xf8 \ 1101 } 1102 1103 /* 1104 * Synthetic FC GUID 1105 * {2f9bcc4a-0069-4af3-b76b-6fd0be528cda} 1106 */ 1107 #define HV_SYNTHFC_GUID \ 1108 .guid = { \ 1109 0x4A, 0xCC, 0x9B, 0x2F, 0x69, 0x00, 0xF3, 0x4A, \ 1110 0xB7, 0x6B, 0x6F, 0xD0, 0xBE, 0x52, 0x8C, 0xDA \ 1111 } 1112 1113 /* 1114 * Guest File Copy Service 1115 * {34D14BE3-DEE4-41c8-9AE7-6B174977C192} 1116 */ 1117 1118 #define HV_FCOPY_GUID \ 1119 .guid = { \ 1120 0xE3, 0x4B, 0xD1, 0x34, 0xE4, 0xDE, 0xC8, 0x41, \ 1121 0x9A, 0xE7, 0x6B, 0x17, 0x49, 0x77, 0xC1, 0x92 \ 1122 } 1123 1124 /* 1125 * NetworkDirect. This is the guest RDMA service. 1126 * {8c2eaf3d-32a7-4b09-ab99-bd1f1c86b501} 1127 */ 1128 #define HV_ND_GUID \ 1129 .guid = { \ 1130 0x3d, 0xaf, 0x2e, 0x8c, 0xa7, 0x32, 0x09, 0x4b, \ 1131 0xab, 0x99, 0xbd, 0x1f, 0x1c, 0x86, 0xb5, 0x01 \ 1132 } 1133 1134 /* 1135 * Common header for Hyper-V ICs 1136 */ 1137 1138 #define ICMSGTYPE_NEGOTIATE 0 1139 #define ICMSGTYPE_HEARTBEAT 1 1140 #define ICMSGTYPE_KVPEXCHANGE 2 1141 #define ICMSGTYPE_SHUTDOWN 3 1142 #define ICMSGTYPE_TIMESYNC 4 1143 #define ICMSGTYPE_VSS 5 1144 1145 #define ICMSGHDRFLAG_TRANSACTION 1 1146 #define ICMSGHDRFLAG_REQUEST 2 1147 #define ICMSGHDRFLAG_RESPONSE 4 1148 1149 1150 /* 1151 * While we want to handle util services as regular devices, 1152 * there is only one instance of each of these services; so 1153 * we statically allocate the service specific state. 1154 */ 1155 1156 struct hv_util_service { 1157 u8 *recv_buffer; 1158 void (*util_cb)(void *); 1159 int (*util_init)(struct hv_util_service *); 1160 void (*util_deinit)(void); 1161 }; 1162 1163 struct vmbuspipe_hdr { 1164 u32 flags; 1165 u32 msgsize; 1166 } __packed; 1167 1168 struct ic_version { 1169 u16 major; 1170 u16 minor; 1171 } __packed; 1172 1173 struct icmsg_hdr { 1174 struct ic_version icverframe; 1175 u16 icmsgtype; 1176 struct ic_version icvermsg; 1177 u16 icmsgsize; 1178 u32 status; 1179 u8 ictransaction_id; 1180 u8 icflags; 1181 u8 reserved[2]; 1182 } __packed; 1183 1184 struct icmsg_negotiate { 1185 u16 icframe_vercnt; 1186 u16 icmsg_vercnt; 1187 u32 reserved; 1188 struct ic_version icversion_data[1]; /* any size array */ 1189 } __packed; 1190 1191 struct shutdown_msg_data { 1192 u32 reason_code; 1193 u32 timeout_seconds; 1194 u32 flags; 1195 u8 display_message[2048]; 1196 } __packed; 1197 1198 struct heartbeat_msg_data { 1199 u64 seq_num; 1200 u32 reserved[8]; 1201 } __packed; 1202 1203 /* Time Sync IC defs */ 1204 #define ICTIMESYNCFLAG_PROBE 0 1205 #define ICTIMESYNCFLAG_SYNC 1 1206 #define ICTIMESYNCFLAG_SAMPLE 2 1207 1208 #ifdef __x86_64__ 1209 #define WLTIMEDELTA 116444736000000000L /* in 100ns unit */ 1210 #else 1211 #define WLTIMEDELTA 116444736000000000LL 1212 #endif 1213 1214 struct ictimesync_data { 1215 u64 parenttime; 1216 u64 childtime; 1217 u64 roundtriptime; 1218 u8 flags; 1219 } __packed; 1220 1221 struct hyperv_service_callback { 1222 u8 msg_type; 1223 char *log_msg; 1224 uuid_le data; 1225 struct vmbus_channel *channel; 1226 void (*callback) (void *context); 1227 }; 1228 1229 #define MAX_SRV_VER 0x7ffffff 1230 extern bool vmbus_prep_negotiate_resp(struct icmsg_hdr *, 1231 struct icmsg_negotiate *, u8 *, int, 1232 int); 1233 1234 void hv_process_channel_removal(struct vmbus_channel *channel, u32 relid); 1235 1236 extern struct resource hyperv_mmio; 1237 1238 /* 1239 * Negotiated version with the Host. 1240 */ 1241 1242 extern __u32 vmbus_proto_version; 1243 1244 #endif /* _HYPERV_H */ 1245