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