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