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