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