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 <linux/types.h>
  29
  30 /*
  31  * An implementation of HyperV key value pair (KVP) functionality for Linux.
  32  *
  33  *
  34  * Copyright (C) 2010, Novell, Inc.
  35  * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
  36  *
  37  */
  38
  39 /*
  40  * Maximum value size - used for both key names and value data, and includes
  41  * any applicable NULL terminators.
  42  *
  43  * Note:  This limit is somewhat arbitrary, but falls easily within what is
  44  * supported for all native guests (back to Win 2000) and what is reasonable
  45  * for the IC KVP exchange functionality.  Note that Windows Me/98/95 are
  46  * limited to 255 character key names.
  47  *
  48  * MSDN recommends not storing data values larger than 2048 bytes in the
  49  * registry.
  50  *
  51  * Note:  This value is used in defining the KVP exchange message - this value
  52  * cannot be modified without affecting the message size and compatibility.
  53  */
  54
  55 /*
  56  * bytes, including any null terminators
  57  */
  58 #define HV_KVP_EXCHANGE_MAX_VALUE_SIZE          (2048)
  59
  60
  61 /*
  62  * Maximum key size - the registry limit for the length of an entry name
  63  * is 256 characters, including the null terminator
  64  */
  65
  66 #define HV_KVP_EXCHANGE_MAX_KEY_SIZE            (512)
  67
  68 /*
  69  * In Linux, we implement the KVP functionality in two components:
  70  * 1) The kernel component which is packaged as part of the hv_utils driver
  71  * is responsible for communicating with the host and responsible for
  72  * implementing the host/guest protocol. 2) A user level daemon that is
  73  * responsible for data gathering.
  74  *
  75  * Host/Guest Protocol: The host iterates over an index and expects the guest
  76  * to assign a key name to the index and also return the value corresponding to
  77  * the key. The host will have atmost one KVP transaction outstanding at any
  78  * given point in time. The host side iteration stops when the guest returns
  79  * an error. Microsoft has specified the following mapping of key names to
  80  * host specified index:
  81  *
  82  *      Index           Key Name
  83  *      0               FullyQualifiedDomainName
  84  *      1               IntegrationServicesVersion
  85  *      2               NetworkAddressIPv4
  86  *      3               NetworkAddressIPv6
  87  *      4               OSBuildNumber
  88  *      5               OSName
  89  *      6               OSMajorVersion
  90  *      7               OSMinorVersion
  91  *      8               OSVersion
  92  *      9               ProcessorArchitecture
  93  *
  94  * The Windows host expects the Key Name and Key Value to be encoded in utf16.
  95  *
  96  * Guest Kernel/KVP Daemon Protocol: As noted earlier, we implement all of the
  97  * data gathering functionality in a user mode daemon. The user level daemon
  98  * is also responsible for binding the key name to the index as well. The
  99  * kernel and user-level daemon communicate using a connector channel.
 100  *
 101  * The user mode component first registers with the
 102  * the kernel component. Subsequently, the kernel component requests, data
 103  * for the specified keys. In response to this message the user mode component
 104  * fills in the value corresponding to the specified key. We overload the
 105  * sequence field in the cn_msg header to define our KVP message types.
 106  *
 107  *
 108  * The kernel component simply acts as a conduit for communication between the
 109  * Windows host and the user-level daemon. The kernel component passes up the
 110  * index received from the Host to the user-level daemon. If the index is
 111  * valid (supported), the corresponding key as well as its
 112  * value (both are strings) is returned. If the index is invalid
 113  * (not supported), a NULL key string is returned.
 114  */
 115
 116
 117 /*
 118  * Registry value types.
 119  */
 120
 121 #define REG_SZ 1
 122 #define REG_U32 4
 123 #define REG_U64 8
 124
 125 /*
 126  * As we look at expanding the KVP functionality to include
 127  * IP injection functionality, we need to maintain binary
 128  * compatibility with older daemons.
 129  *
 130  * The KVP opcodes are defined by the host and it was unfortunate
 131  * that I chose to treat the registration operation as part of the
 132  * KVP operations defined by the host.
 133  * Here is the level of compatibility
 134  * (between the user level daemon and the kernel KVP driver) that we
 135  * will implement:
 136  *
 137  * An older daemon will always be supported on a newer driver.
 138  * A given user level daemon will require a minimal version of the
 139  * kernel driver.
 140  * If we cannot handle the version differences, we will fail gracefully
 141  * (this can happen when we have a user level daemon that is more
 142  * advanced than the KVP driver.
 143  *
 144  * We will use values used in this handshake for determining if we have
 145  * workable user level daemon and the kernel driver. We begin by taking the
 146  * registration opcode out of the KVP opcode namespace. We will however,
 147  * maintain compatibility with the existing user-level daemon code.
 148  */
 149
 150 /*
 151  * Daemon code not supporting IP injection (legacy daemon).
 152  */
 153
 154 #define KVP_OP_REGISTER 4
 155
 156 /*
 157  * Daemon code supporting IP injection.
 158  * The KVP opcode field is used to communicate the
 159  * registration information; so define a namespace that
 160  * will be distinct from the host defined KVP opcode.
 161  */
 162
 163 #define KVP_OP_REGISTER1 100
 164
 165 enum hv_kvp_exchg_op {
 166         KVP_OP_GET = 0,
 167         KVP_OP_SET,
 168         KVP_OP_DELETE,
 169         KVP_OP_ENUMERATE,
 170         KVP_OP_GET_IP_INFO,
 171         KVP_OP_SET_IP_INFO,
 172         KVP_OP_COUNT /* Number of operations, must be last. */
 173 };
 174
 175 enum hv_kvp_exchg_pool {
 176         KVP_POOL_EXTERNAL = 0,
 177         KVP_POOL_GUEST,
 178         KVP_POOL_AUTO,
 179         KVP_POOL_AUTO_EXTERNAL,
 180         KVP_POOL_AUTO_INTERNAL,
 181         KVP_POOL_COUNT /* Number of pools, must be last. */
 182 };
 183
 184 /*
 185  * Some Hyper-V status codes.
 186  */
 187
 188 #define HV_S_OK                         0x00000000
 189 #define HV_E_FAIL                       0x80004005
 190 #define HV_S_CONT                       0x80070103
 191 #define HV_ERROR_NOT_SUPPORTED          0x80070032
 192 #define HV_ERROR_MACHINE_LOCKED         0x800704F7
 193 #define HV_ERROR_DEVICE_NOT_CONNECTED   0x8007048F
 194 #define HV_INVALIDARG                   0x80070057
 195 #define HV_GUID_NOTFOUND                0x80041002
 196
 197 #define ADDR_FAMILY_NONE        0x00
 198 #define ADDR_FAMILY_IPV4        0x01
 199 #define ADDR_FAMILY_IPV6        0x02
 200
 201 #define MAX_ADAPTER_ID_SIZE     128
 202 #define MAX_IP_ADDR_SIZE        1024
 203 #define MAX_GATEWAY_SIZE        512
 204
 205
 206 struct hv_kvp_ipaddr_value {
 207         __u16   adapter_id[MAX_ADAPTER_ID_SIZE];
 208         __u8    addr_family;
 209         __u8    dhcp_enabled;
 210         __u16   ip_addr[MAX_IP_ADDR_SIZE];
 211         __u16   sub_net[MAX_IP_ADDR_SIZE];
 212         __u16   gate_way[MAX_GATEWAY_SIZE];
 213         __u16   dns_addr[MAX_IP_ADDR_SIZE];
 214 } __attribute__((packed));
 215
 216
 217 struct hv_kvp_hdr {
 218         __u8 operation;
 219         __u8 pool;
 220         __u16 pad;
 221 } __attribute__((packed));
 222
 223 struct hv_kvp_exchg_msg_value {
 224         __u32 value_type;
 225         __u32 key_size;
 226         __u32 value_size;
 227         __u8 key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
 228         union {
 229                 __u8 value[HV_KVP_EXCHANGE_MAX_VALUE_SIZE];
 230                 __u32 value_u32;
 231                 __u64 value_u64;
 232         };
 233 } __attribute__((packed));
 234
 235 struct hv_kvp_msg_enumerate {
 236         __u32 index;
 237         struct hv_kvp_exchg_msg_value data;
 238 } __attribute__((packed));
 239
 240 struct hv_kvp_msg_get {
 241         struct hv_kvp_exchg_msg_value data;
 242 };
 243
 244 struct hv_kvp_msg_set {
 245         struct hv_kvp_exchg_msg_value data;
 246 };
 247
 248 struct hv_kvp_msg_delete {
 249         __u32 key_size;
 250         __u8 key[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
 251 };
 252
 253 struct hv_kvp_register {
 254         __u8 version[HV_KVP_EXCHANGE_MAX_KEY_SIZE];
 255 };
 256
 257 struct hv_kvp_msg {
 258         union {
 259                 struct hv_kvp_hdr       kvp_hdr;
 260                 int error;
 261         };
 262         union {
 263                 struct hv_kvp_msg_get           kvp_get;
 264                 struct hv_kvp_msg_set           kvp_set;
 265                 struct hv_kvp_msg_delete        kvp_delete;
 266                 struct hv_kvp_msg_enumerate     kvp_enum_data;
 267                 struct hv_kvp_ipaddr_value      kvp_ip_val;
 268                 struct hv_kvp_register          kvp_register;
 269         } body;
 270 } __attribute__((packed));
 271
 272 struct hv_kvp_ip_msg {
 273         __u8 operation;
 274         __u8 pool;
 275         struct hv_kvp_ipaddr_value      kvp_ip_val;
 276 } __attribute__((packed));
 277
 278 #ifdef __KERNEL__
 279 #include <linux/scatterlist.h>
 280 #include <linux/list.h>
 281 #include <linux/uuid.h>
 282 #include <linux/timer.h>
 283 #include <linux/workqueue.h>
 284 #include <linux/completion.h>
 285 #include <linux/device.h>
 286 #include <linux/mod_devicetable.h>
 287
 288
 289 #define MAX_PAGE_BUFFER_COUNT                           19
 290 #define MAX_MULTIPAGE_BUFFER_COUNT                      32 /* 128K */
 291
 292 #pragma pack(push, 1)
 293
 294 /* Single-page buffer */
 295 struct hv_page_buffer {
 296         u32 len;
 297         u32 offset;
 298         u64 pfn;
 299 };
 300
 301 /* Multiple-page buffer */
 302 struct hv_multipage_buffer {
 303         /* Length and Offset determines the # of pfns in the array */
 304         u32 len;
 305         u32 offset;
 306         u64 pfn_array[MAX_MULTIPAGE_BUFFER_COUNT];
 307 };
 308
 309 /* 0x18 includes the proprietary packet header */
 310 #define MAX_PAGE_BUFFER_PACKET          (0x18 +                 \
 311                                         (sizeof(struct hv_page_buffer) * \
 312                                          MAX_PAGE_BUFFER_COUNT))
 313 #define MAX_MULTIPAGE_BUFFER_PACKET     (0x18 +                 \
 314                                          sizeof(struct hv_multipage_buffer))
 315
 316
 317 #pragma pack(pop)
 318
 319 struct hv_ring_buffer {
 320         /* Offset in bytes from the start of ring data below */
 321         u32 write_index;
 322
 323         /* Offset in bytes from the start of ring data below */
 324         u32 read_index;
 325
 326         u32 interrupt_mask;
 327
 328         /*
 329          * Win8 uses some of the reserved bits to implement
 330          * interrupt driven flow management. On the send side
 331          * we can request that the receiver interrupt the sender
 332          * when the ring transitions from being full to being able
 333          * to handle a message of size "pending_send_sz".
 334          *
 335          * Add necessary state for this enhancement.
 336          */
 337         u32 pending_send_sz;
 338
 339         u32 reserved1[12];
 340
 341         union {
 342                 struct {
 343                         u32 feat_pending_send_sz:1;
 344                 };
 345                 u32 value;
 346         } feature_bits;
 347
 348         /* Pad it to PAGE_SIZE so that data starts on page boundary */
 349         u8      reserved2[4028];
 350
 351         /*
 352          * Ring data starts here + RingDataStartOffset
 353          * !!! DO NOT place any fields below this !!!
 354          */
 355         u8 buffer[0];
 356 } __packed;
 357
 358 struct hv_ring_buffer_info {
 359         struct hv_ring_buffer *ring_buffer;
 360         u32 ring_size;                  /* Include the shared header */
 361         spinlock_t ring_lock;
 362
 363         u32 ring_datasize;              /* < ring_size */
 364         u32 ring_data_startoffset;
 365 };
 366
 367 struct hv_ring_buffer_debug_info {
 368         u32 current_interrupt_mask;
 369         u32 current_read_index;
 370         u32 current_write_index;
 371         u32 bytes_avail_toread;
 372         u32 bytes_avail_towrite;
 373 };
 374
 375
 376 /*
 377  *
 378  * hv_get_ringbuffer_availbytes()
 379  *
 380  * Get number of bytes available to read and to write to
 381  * for the specified ring buffer
 382  */
 383 static inline void
 384 hv_get_ringbuffer_availbytes(struct hv_ring_buffer_info *rbi,
 385                           u32 *read, u32 *write)
 386 {
 387         u32 read_loc, write_loc, dsize;
 388
 389         smp_read_barrier_depends();
 390
 391         /* Capture the read/write indices before they changed */
 392         read_loc = rbi->ring_buffer->read_index;
 393         write_loc = rbi->ring_buffer->write_index;
 394         dsize = rbi->ring_datasize;
 395
 396         *write = write_loc >= read_loc ? dsize - (write_loc - read_loc) :
 397                 read_loc - write_loc;
 398         *read = dsize - *write;
 399 }
 400
 401
 402 /*
 403  * We use the same version numbering for all Hyper-V modules.
 404  *
 405  * Definition of versioning is as follows;
 406  *
 407  *      Major Number    Changes for these scenarios;
 408  *                      1.      When a new version of Windows Hyper-V
 409  *                              is released.
 410  *                      2.      A Major change has occurred in the
 411  *                              Linux IC's.
 412  *                      (For example the merge for the first time
 413  *                      into the kernel) Every time the Major Number
 414  *                      changes, the Revision number is reset to 0.
 415  *      Minor Number    Changes when new functionality is added
 416  *                      to the Linux IC's that is not a bug fix.
 417  *
 418  * 3.1 - Added completed hv_utils driver. Shutdown/Heartbeat/Timesync
 419  */
 420 #define HV_DRV_VERSION           "3.1"
 421
 422 /*
 423  * VMBUS version is 32 bit entity broken up into
 424  * two 16 bit quantities: major_number. minor_number.
 425  *
 426  * 0 . 13 (Windows Server 2008)
 427  * 1 . 1  (Windows 7)
 428  * 2 . 4  (Windows 8)
 429  */
 430
 431 #define VERSION_WS2008  ((0 << 16) | (13))
 432 #define VERSION_WIN7    ((1 << 16) | (1))
 433 #define VERSION_WIN8    ((2 << 16) | (4))
 434
 435 #define VERSION_INVAL -1
 436
 437
 438 /* Make maximum size of pipe payload of 16K */
 439 #define MAX_PIPE_DATA_PAYLOAD           (sizeof(u8) * 16384)
 440
 441 /* Define PipeMode values. */
 442 #define VMBUS_PIPE_TYPE_BYTE            0x00000000
 443 #define VMBUS_PIPE_TYPE_MESSAGE         0x00000004
 444
 445 /* The size of the user defined data buffer for non-pipe offers. */
 446 #define MAX_USER_DEFINED_BYTES          120
 447
 448 /* The size of the user defined data buffer for pipe offers. */
 449 #define MAX_PIPE_USER_DEFINED_BYTES     116
 450
 451 /*
 452  * At the center of the Channel Management library is the Channel Offer. This
 453  * struct contains the fundamental information about an offer.
 454  */
 455 struct vmbus_channel_offer {
 456         uuid_le if_type;
 457         uuid_le if_instance;
 458
 459         /*
 460          * These two fields are not currently used.
 461          */
 462         u64 reserved1;
 463         u64 reserved2;
 464
 465         u16 chn_flags;
 466         u16 mmio_megabytes;             /* in bytes * 1024 * 1024 */
 467
 468         union {
 469                 /* Non-pipes: The user has MAX_USER_DEFINED_BYTES bytes. */
 470                 struct {
 471                         unsigned char user_def[MAX_USER_DEFINED_BYTES];
 472                 } std;
 473
 474                 /*
 475                  * Pipes:
 476                  * The following sructure is an integrated pipe protocol, which
 477                  * is implemented on top of standard user-defined data. Pipe
 478                  * clients have MAX_PIPE_USER_DEFINED_BYTES left for their own
 479                  * use.
 480                  */
 481                 struct {
 482                         u32  pipe_mode;
 483                         unsigned char user_def[MAX_PIPE_USER_DEFINED_BYTES];
 484                 } pipe;
 485         } u;
 486         /*
 487          * The sub_channel_index is defined in win8.
 488          */
 489         u16 sub_channel_index;
 490         u16 reserved3;
 491 } __packed;
 492
 493 /* Server Flags */
 494 #define VMBUS_CHANNEL_ENUMERATE_DEVICE_INTERFACE        1
 495 #define VMBUS_CHANNEL_SERVER_SUPPORTS_TRANSFER_PAGES    2
 496 #define VMBUS_CHANNEL_SERVER_SUPPORTS_GPADLS            4
 497 #define VMBUS_CHANNEL_NAMED_PIPE_MODE                   0x10
 498 #define VMBUS_CHANNEL_LOOPBACK_OFFER                    0x100
 499 #define VMBUS_CHANNEL_PARENT_OFFER                      0x200
 500 #define VMBUS_CHANNEL_REQUEST_MONITORED_NOTIFICATION    0x400
 501
 502 struct vmpacket_descriptor {
 503         u16 type;
 504         u16 offset8;
 505         u16 len8;
 506         u16 flags;
 507         u64 trans_id;
 508 } __packed;
 509
 510 struct vmpacket_header {
 511         u32 prev_pkt_start_offset;
 512         struct vmpacket_descriptor descriptor;
 513 } __packed;
 514
 515 struct vmtransfer_page_range {
 516         u32 byte_count;
 517         u32 byte_offset;
 518 } __packed;
 519
 520 struct vmtransfer_page_packet_header {
 521         struct vmpacket_descriptor d;
 522         u16 xfer_pageset_id;
 523         u8  sender_owns_set;
 524         u8 reserved;
 525         u32 range_cnt;
 526         struct vmtransfer_page_range ranges[1];
 527 } __packed;
 528
 529 struct vmgpadl_packet_header {
 530         struct vmpacket_descriptor d;
 531         u32 gpadl;
 532         u32 reserved;
 533 } __packed;
 534
 535 struct vmadd_remove_transfer_page_set {
 536         struct vmpacket_descriptor d;
 537         u32 gpadl;
 538         u16 xfer_pageset_id;
 539         u16 reserved;
 540 } __packed;
 541
 542 /*
 543  * This structure defines a range in guest physical space that can be made to
 544  * look virtually contiguous.
 545  */
 546 struct gpa_range {
 547         u32 byte_count;
 548         u32 byte_offset;
 549         u64 pfn_array[0];
 550 };
 551
 552 /*
 553  * This is the format for an Establish Gpadl packet, which contains a handle by
 554  * which this GPADL will be known and a set of GPA ranges associated with it.
 555  * This can be converted to a MDL by the guest OS.  If there are multiple GPA
 556  * ranges, then the resulting MDL will be "chained," representing multiple VA
 557  * ranges.
 558  */
 559 struct vmestablish_gpadl {
 560         struct vmpacket_descriptor d;
 561         u32 gpadl;
 562         u32 range_cnt;
 563         struct gpa_range range[1];
 564 } __packed;
 565
 566 /*
 567  * This is the format for a Teardown Gpadl packet, which indicates that the
 568  * GPADL handle in the Establish Gpadl packet will never be referenced again.
 569  */
 570 struct vmteardown_gpadl {
 571         struct vmpacket_descriptor d;
 572         u32 gpadl;
 573         u32 reserved;   /* for alignment to a 8-byte boundary */
 574 } __packed;
 575
 576 /*
 577  * This is the format for a GPA-Direct packet, which contains a set of GPA
 578  * ranges, in addition to commands and/or data.
 579  */
 580 struct vmdata_gpa_direct {
 581         struct vmpacket_descriptor d;
 582         u32 reserved;
 583         u32 range_cnt;
 584         struct gpa_range range[1];
 585 } __packed;
 586
 587 /* This is the format for a Additional Data Packet. */
 588 struct vmadditional_data {
 589         struct vmpacket_descriptor d;
 590         u64 total_bytes;
 591         u32 offset;
 592         u32 byte_cnt;
 593         unsigned char data[1];
 594 } __packed;
 595
 596 union vmpacket_largest_possible_header {
 597         struct vmpacket_descriptor simple_hdr;
 598         struct vmtransfer_page_packet_header xfer_page_hdr;
 599         struct vmgpadl_packet_header gpadl_hdr;
 600         struct vmadd_remove_transfer_page_set add_rm_xfer_page_hdr;
 601         struct vmestablish_gpadl establish_gpadl_hdr;
 602         struct vmteardown_gpadl teardown_gpadl_hdr;
 603         struct vmdata_gpa_direct data_gpa_direct_hdr;
 604 };
 605
 606 #define VMPACKET_DATA_START_ADDRESS(__packet)   \
 607         (void *)(((unsigned char *)__packet) +  \
 608          ((struct vmpacket_descriptor)__packet)->offset8 * 8)
 609
 610 #define VMPACKET_DATA_LENGTH(__packet)          \
 611         ((((struct vmpacket_descriptor)__packet)->len8 -        \
 612           ((struct vmpacket_descriptor)__packet)->offset8) * 8)
 613
 614 #define VMPACKET_TRANSFER_MODE(__packet)        \
 615         (((struct IMPACT)__packet)->type)
 616
 617 enum vmbus_packet_type {
 618         VM_PKT_INVALID                          = 0x0,
 619         VM_PKT_SYNCH                            = 0x1,
 620         VM_PKT_ADD_XFER_PAGESET                 = 0x2,
 621         VM_PKT_RM_XFER_PAGESET                  = 0x3,
 622         VM_PKT_ESTABLISH_GPADL                  = 0x4,
 623         VM_PKT_TEARDOWN_GPADL                   = 0x5,
 624         VM_PKT_DATA_INBAND                      = 0x6,
 625         VM_PKT_DATA_USING_XFER_PAGES            = 0x7,
 626         VM_PKT_DATA_USING_GPADL                 = 0x8,
 627         VM_PKT_DATA_USING_GPA_DIRECT            = 0x9,
 628         VM_PKT_CANCEL_REQUEST                   = 0xa,
 629         VM_PKT_COMP                             = 0xb,
 630         VM_PKT_DATA_USING_ADDITIONAL_PKT        = 0xc,
 631         VM_PKT_ADDITIONAL_DATA                  = 0xd
 632 };
 633
 634 #define VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED     1
 635
 636
 637 /* Version 1 messages */
 638 enum vmbus_channel_message_type {
 639         CHANNELMSG_INVALID                      =  0,
 640         CHANNELMSG_OFFERCHANNEL         =  1,
 641         CHANNELMSG_RESCIND_CHANNELOFFER =  2,
 642         CHANNELMSG_REQUESTOFFERS                =  3,
 643         CHANNELMSG_ALLOFFERS_DELIVERED  =  4,
 644         CHANNELMSG_OPENCHANNEL          =  5,
 645         CHANNELMSG_OPENCHANNEL_RESULT           =  6,
 646         CHANNELMSG_CLOSECHANNEL         =  7,
 647         CHANNELMSG_GPADL_HEADER         =  8,
 648         CHANNELMSG_GPADL_BODY                   =  9,
 649         CHANNELMSG_GPADL_CREATED                = 10,
 650         CHANNELMSG_GPADL_TEARDOWN               = 11,
 651         CHANNELMSG_GPADL_TORNDOWN               = 12,
 652         CHANNELMSG_RELID_RELEASED               = 13,
 653         CHANNELMSG_INITIATE_CONTACT             = 14,
 654         CHANNELMSG_VERSION_RESPONSE             = 15,
 655         CHANNELMSG_UNLOAD                       = 16,
 656 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
 657         CHANNELMSG_VIEWRANGE_ADD                = 17,
 658         CHANNELMSG_VIEWRANGE_REMOVE             = 18,
 659 #endif
 660         CHANNELMSG_COUNT
 661 };
 662
 663 struct vmbus_channel_message_header {
 664         enum vmbus_channel_message_type msgtype;
 665         u32 padding;
 666 } __packed;
 667
 668 /* Query VMBus Version parameters */
 669 struct vmbus_channel_query_vmbus_version {
 670         struct vmbus_channel_message_header header;
 671         u32 version;
 672 } __packed;
 673
 674 /* VMBus Version Supported parameters */
 675 struct vmbus_channel_version_supported {
 676         struct vmbus_channel_message_header header;
 677         u8 version_supported;
 678 } __packed;
 679
 680 /* Offer Channel parameters */
 681 struct vmbus_channel_offer_channel {
 682         struct vmbus_channel_message_header header;
 683         struct vmbus_channel_offer offer;
 684         u32 child_relid;
 685         u8 monitorid;
 686         /*
 687          * win7 and beyond splits this field into a bit field.
 688          */
 689         u8 monitor_allocated:1;
 690         u8 reserved:7;
 691         /*
 692          * These are new fields added in win7 and later.
 693          * Do not access these fields without checking the
 694          * negotiated protocol.
 695          *
 696          * If "is_dedicated_interrupt" is set, we must not set the
 697          * associated bit in the channel bitmap while sending the
 698          * interrupt to the host.
 699          *
 700          * connection_id is to be used in signaling the host.
 701          */
 702         u16 is_dedicated_interrupt:1;
 703         u16 reserved1:15;
 704         u32 connection_id;
 705 } __packed;
 706
 707 /* Rescind Offer parameters */
 708 struct vmbus_channel_rescind_offer {
 709         struct vmbus_channel_message_header header;
 710         u32 child_relid;
 711 } __packed;
 712
 713 /*
 714  * Request Offer -- no parameters, SynIC message contains the partition ID
 715  * Set Snoop -- no parameters, SynIC message contains the partition ID
 716  * Clear Snoop -- no parameters, SynIC message contains the partition ID
 717  * All Offers Delivered -- no parameters, SynIC message contains the partition
 718  *                         ID
 719  * Flush Client -- no parameters, SynIC message contains the partition ID
 720  */
 721
 722 /* Open Channel parameters */
 723 struct vmbus_channel_open_channel {
 724         struct vmbus_channel_message_header header;
 725
 726         /* Identifies the specific VMBus channel that is being opened. */
 727         u32 child_relid;
 728
 729         /* ID making a particular open request at a channel offer unique. */
 730         u32 openid;
 731
 732         /* GPADL for the channel's ring buffer. */
 733         u32 ringbuffer_gpadlhandle;
 734
 735         /* GPADL for the channel's server context save area. */
 736         u32 server_contextarea_gpadlhandle;
 737
 738         /*
 739         * The upstream ring buffer begins at offset zero in the memory
 740         * described by RingBufferGpadlHandle. The downstream ring buffer
 741         * follows it at this offset (in pages).
 742         */
 743         u32 downstream_ringbuffer_pageoffset;
 744
 745         /* User-specific data to be passed along to the server endpoint. */
 746         unsigned char userdata[MAX_USER_DEFINED_BYTES];
 747 } __packed;
 748
 749 /* Open Channel Result parameters */
 750 struct vmbus_channel_open_result {
 751         struct vmbus_channel_message_header header;
 752         u32 child_relid;
 753         u32 openid;
 754         u32 status;
 755 } __packed;
 756
 757 /* Close channel parameters; */
 758 struct vmbus_channel_close_channel {
 759         struct vmbus_channel_message_header header;
 760         u32 child_relid;
 761 } __packed;
 762
 763 /* Channel Message GPADL */
 764 #define GPADL_TYPE_RING_BUFFER          1
 765 #define GPADL_TYPE_SERVER_SAVE_AREA     2
 766 #define GPADL_TYPE_TRANSACTION          8
 767
 768 /*
 769  * The number of PFNs in a GPADL message is defined by the number of
 770  * pages that would be spanned by ByteCount and ByteOffset.  If the
 771  * implied number of PFNs won't fit in this packet, there will be a
 772  * follow-up packet that contains more.
 773  */
 774 struct vmbus_channel_gpadl_header {
 775         struct vmbus_channel_message_header header;
 776         u32 child_relid;
 777         u32 gpadl;
 778         u16 range_buflen;
 779         u16 rangecount;
 780         struct gpa_range range[0];
 781 } __packed;
 782
 783 /* This is the followup packet that contains more PFNs. */
 784 struct vmbus_channel_gpadl_body {
 785         struct vmbus_channel_message_header header;
 786         u32 msgnumber;
 787         u32 gpadl;
 788         u64 pfn[0];
 789 } __packed;
 790
 791 struct vmbus_channel_gpadl_created {
 792         struct vmbus_channel_message_header header;
 793         u32 child_relid;
 794         u32 gpadl;
 795         u32 creation_status;
 796 } __packed;
 797
 798 struct vmbus_channel_gpadl_teardown {
 799         struct vmbus_channel_message_header header;
 800         u32 child_relid;
 801         u32 gpadl;
 802 } __packed;
 803
 804 struct vmbus_channel_gpadl_torndown {
 805         struct vmbus_channel_message_header header;
 806         u32 gpadl;
 807 } __packed;
 808
 809 #ifdef VMBUS_FEATURE_PARENT_OR_PEER_MEMORY_MAPPED_INTO_A_CHILD
 810 struct vmbus_channel_view_range_add {
 811         struct vmbus_channel_message_header header;
 812         PHYSICAL_ADDRESS viewrange_base;
 813         u64 viewrange_length;
 814         u32 child_relid;
 815 } __packed;
 816
 817 struct vmbus_channel_view_range_remove {
 818         struct vmbus_channel_message_header header;
 819         PHYSICAL_ADDRESS viewrange_base;
 820         u32 child_relid;
 821 } __packed;
 822 #endif
 823
 824 struct vmbus_channel_relid_released {
 825         struct vmbus_channel_message_header header;
 826         u32 child_relid;
 827 } __packed;
 828
 829 struct vmbus_channel_initiate_contact {
 830         struct vmbus_channel_message_header header;
 831         u32 vmbus_version_requested;
 832         u32 padding2;
 833         u64 interrupt_page;
 834         u64 monitor_page1;
 835         u64 monitor_page2;
 836 } __packed;
 837
 838 struct vmbus_channel_version_response {
 839         struct vmbus_channel_message_header header;
 840         u8 version_supported;
 841 } __packed;
 842
 843 enum vmbus_channel_state {
 844         CHANNEL_OFFER_STATE,
 845         CHANNEL_OPENING_STATE,
 846         CHANNEL_OPEN_STATE,
 847 };
 848
 849 struct vmbus_channel_debug_info {
 850         u32 relid;
 851         enum vmbus_channel_state state;
 852         uuid_le interfacetype;
 853         uuid_le interface_instance;
 854         u32 monitorid;
 855         u32 servermonitor_pending;
 856         u32 servermonitor_latency;
 857         u32 servermonitor_connectionid;
 858         u32 clientmonitor_pending;
 859         u32 clientmonitor_latency;
 860         u32 clientmonitor_connectionid;
 861
 862         struct hv_ring_buffer_debug_info inbound;
 863         struct hv_ring_buffer_debug_info outbound;
 864 };
 865
 866 /*
 867  * Represents each channel msg on the vmbus connection This is a
 868  * variable-size data structure depending on the msg type itself
 869  */
 870 struct vmbus_channel_msginfo {
 871         /* Bookkeeping stuff */
 872         struct list_head msglistentry;
 873
 874         /* So far, this is only used to handle gpadl body message */
 875         struct list_head submsglist;
 876
 877         /* Synchronize the request/response if needed */
 878         struct completion  waitevent;
 879         union {
 880                 struct vmbus_channel_version_supported version_supported;
 881                 struct vmbus_channel_open_result open_result;
 882                 struct vmbus_channel_gpadl_torndown gpadl_torndown;
 883                 struct vmbus_channel_gpadl_created gpadl_created;
 884                 struct vmbus_channel_version_response version_response;
 885         } response;
 886
 887         u32 msgsize;
 888         /*
 889          * The channel message that goes out on the "wire".
 890          * It will contain at minimum the VMBUS_CHANNEL_MESSAGE_HEADER header
 891          */
 892         unsigned char msg[0];
 893 };
 894
 895 struct vmbus_close_msg {
 896         struct vmbus_channel_msginfo info;
 897         struct vmbus_channel_close_channel msg;
 898 };
 899
 900 struct vmbus_channel {
 901         struct list_head listentry;
 902
 903         struct hv_device *device_obj;
 904
 905         struct work_struct work;
 906
 907         enum vmbus_channel_state state;
 908
 909         struct vmbus_channel_offer_channel offermsg;
 910         /*
 911          * These are based on the OfferMsg.MonitorId.
 912          * Save it here for easy access.
 913          */
 914         u8 monitor_grp;
 915         u8 monitor_bit;
 916
 917         u32 ringbuffer_gpadlhandle;
 918
 919         /* Allocated memory for ring buffer */
 920         void *ringbuffer_pages;
 921         u32 ringbuffer_pagecount;
 922         struct hv_ring_buffer_info outbound;    /* send to parent */
 923         struct hv_ring_buffer_info inbound;     /* receive from parent */
 924         spinlock_t inbound_lock;
 925         struct workqueue_struct *controlwq;
 926
 927         struct vmbus_close_msg close_msg;
 928
 929         /* Channel callback are invoked in this workqueue context */
 930         /* HANDLE dataWorkQueue; */
 931
 932         void (*onchannel_callback)(void *context);
 933         void *channel_callback_context;
 934
 935         /*
 936          * A channel can be marked for efficient (batched)
 937          * reading:
 938          * If batched_reading is set to "true", we read until the
 939          * channel is empty and hold off interrupts from the host
 940          * during the entire read process.
 941          * If batched_reading is set to "false", the client is not
 942          * going to perform batched reading.
 943          *
 944          * By default we will enable batched reading; specific
 945          * drivers that don't want this behavior can turn it off.
 946          */
 947
 948         bool batched_reading;
 949 };
 950
 951 static inline void set_channel_read_state(struct vmbus_channel *c, bool state)
 952 {
 953         c->batched_reading = state;
 954 }
 955
 956 void vmbus_onmessage(void *context);
 957
 958 int vmbus_request_offers(void);
 959
 960 /* The format must be the same as struct vmdata_gpa_direct */
 961 struct vmbus_channel_packet_page_buffer {
 962         u16 type;
 963         u16 dataoffset8;
 964         u16 length8;
 965         u16 flags;
 966         u64 transactionid;
 967         u32 reserved;
 968         u32 rangecount;
 969         struct hv_page_buffer range[MAX_PAGE_BUFFER_COUNT];
 970 } __packed;
 971
 972 /* The format must be the same as struct vmdata_gpa_direct */
 973 struct vmbus_channel_packet_multipage_buffer {
 974         u16 type;
 975         u16 dataoffset8;
 976         u16 length8;
 977         u16 flags;
 978         u64 transactionid;
 979         u32 reserved;
 980         u32 rangecount;         /* Always 1 in this case */
 981         struct hv_multipage_buffer range;
 982 } __packed;
 983
 984
 985 extern int vmbus_open(struct vmbus_channel *channel,
 986                             u32 send_ringbuffersize,
 987                             u32 recv_ringbuffersize,
 988                             void *userdata,
 989                             u32 userdatalen,
 990                             void(*onchannel_callback)(void *context),
 991                             void *context);
 992
 993 extern void vmbus_close(struct vmbus_channel *channel);
 994
 995 extern int vmbus_sendpacket(struct vmbus_channel *channel,
 996                                   const void *buffer,
 997                                   u32 bufferLen,
 998                                   u64 requestid,
 999                                   enum vmbus_packet_type type,
1000                                   u32 flags);
1001
1002 extern int vmbus_sendpacket_pagebuffer(struct vmbus_channel *channel,
1003                                             struct hv_page_buffer pagebuffers[],
1004                                             u32 pagecount,
1005                                             void *buffer,
1006                                             u32 bufferlen,
1007                                             u64 requestid);
1008
1009 extern int vmbus_sendpacket_multipagebuffer(struct vmbus_channel *channel,
1010                                         struct hv_multipage_buffer *mpb,
1011                                         void *buffer,
1012                                         u32 bufferlen,
1013                                         u64 requestid);
1014
1015 extern int vmbus_establish_gpadl(struct vmbus_channel *channel,
1016                                       void *kbuffer,
1017                                       u32 size,
1018                                       u32 *gpadl_handle);
1019
1020 extern int vmbus_teardown_gpadl(struct vmbus_channel *channel,
1021                                      u32 gpadl_handle);
1022
1023 extern int vmbus_recvpacket(struct vmbus_channel *channel,
1024                                   void *buffer,
1025                                   u32 bufferlen,
1026                                   u32 *buffer_actual_len,
1027                                   u64 *requestid);
1028
1029 extern int vmbus_recvpacket_raw(struct vmbus_channel *channel,
1030                                      void *buffer,
1031                                      u32 bufferlen,
1032                                      u32 *buffer_actual_len,
1033                                      u64 *requestid);
1034
1035
1036 extern void vmbus_get_debug_info(struct vmbus_channel *channel,
1037                                      struct vmbus_channel_debug_info *debug);
1038
1039 extern void vmbus_ontimer(unsigned long data);
1040
1041 struct hv_dev_port_info {
1042         u32 int_mask;
1043         u32 read_idx;
1044         u32 write_idx;
1045         u32 bytes_avail_toread;
1046         u32 bytes_avail_towrite;
1047 };
1048
1049 /* Base driver object */
1050 struct hv_driver {
1051         const char *name;
1052
1053         /* the device type supported by this driver */
1054         uuid_le dev_type;
1055         const struct hv_vmbus_device_id *id_table;
1056
1057         struct device_driver driver;
1058
1059         int (*probe)(struct hv_device *, const struct hv_vmbus_device_id *);
1060         int (*remove)(struct hv_device *);
1061         void (*shutdown)(struct hv_device *);
1062
1063 };
1064
1065 /* Base device object */
1066 struct hv_device {
1067         /* the device type id of this device */
1068         uuid_le dev_type;
1069
1070         /* the device instance id of this device */
1071         uuid_le dev_instance;
1072
1073         struct device device;
1074
1075         struct vmbus_channel *channel;
1076 };
1077
1078
1079 static inline struct hv_device *device_to_hv_device(struct device *d)
1080 {
1081         return container_of(d, struct hv_device, device);
1082 }
1083
1084 static inline struct hv_driver *drv_to_hv_drv(struct device_driver *d)
1085 {
1086         return container_of(d, struct hv_driver, driver);
1087 }
1088
1089 static inline void hv_set_drvdata(struct hv_device *dev, void *data)
1090 {
1091         dev_set_drvdata(&dev->device, data);
1092 }
1093
1094 static inline void *hv_get_drvdata(struct hv_device *dev)
1095 {
1096         return dev_get_drvdata(&dev->device);
1097 }
1098
1099 /* Vmbus interface */
1100 #define vmbus_driver_register(driver)   \
1101         __vmbus_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
1102 int __must_check __vmbus_driver_register(struct hv_driver *hv_driver,
1103                                          struct module *owner,
1104                                          const char *mod_name);
1105 void vmbus_driver_unregister(struct hv_driver *hv_driver);
1106
1107 /**
1108  * VMBUS_DEVICE - macro used to describe a specific hyperv vmbus device
1109  *
1110  * This macro is used to create a struct hv_vmbus_device_id that matches a
1111  * specific device.
1112  */
1113 #define VMBUS_DEVICE(g0, g1, g2, g3, g4, g5, g6, g7,    \
1114                      g8, g9, ga, gb, gc, gd, ge, gf)    \
1115         .guid = { g0, g1, g2, g3, g4, g5, g6, g7,       \
1116                   g8, g9, ga, gb, gc, gd, ge, gf },
1117
1118 /*
1119  * Common header for Hyper-V ICs
1120  */
1121
1122 #define ICMSGTYPE_NEGOTIATE             0
1123 #define ICMSGTYPE_HEARTBEAT             1
1124 #define ICMSGTYPE_KVPEXCHANGE           2
1125 #define ICMSGTYPE_SHUTDOWN              3
1126 #define ICMSGTYPE_TIMESYNC              4
1127 #define ICMSGTYPE_VSS                   5
1128
1129 #define ICMSGHDRFLAG_TRANSACTION        1
1130 #define ICMSGHDRFLAG_REQUEST            2
1131 #define ICMSGHDRFLAG_RESPONSE           4
1132
1133
1134 /*
1135  * While we want to handle util services as regular devices,
1136  * there is only one instance of each of these services; so
1137  * we statically allocate the service specific state.
1138  */
1139
1140 struct hv_util_service {
1141         u8 *recv_buffer;
1142         void (*util_cb)(void *);
1143         int (*util_init)(struct hv_util_service *);
1144         void (*util_deinit)(void);
1145 };
1146
1147 struct vmbuspipe_hdr {
1148         u32 flags;
1149         u32 msgsize;
1150 } __packed;
1151
1152 struct ic_version {
1153         u16 major;
1154         u16 minor;
1155 } __packed;
1156
1157 struct icmsg_hdr {
1158         struct ic_version icverframe;
1159         u16 icmsgtype;
1160         struct ic_version icvermsg;
1161         u16 icmsgsize;
1162         u32 status;
1163         u8 ictransaction_id;
1164         u8 icflags;
1165         u8 reserved[2];
1166 } __packed;
1167
1168 struct icmsg_negotiate {
1169         u16 icframe_vercnt;
1170         u16 icmsg_vercnt;
1171         u32 reserved;
1172         struct ic_version icversion_data[1]; /* any size array */
1173 } __packed;
1174
1175 struct shutdown_msg_data {
1176         u32 reason_code;
1177         u32 timeout_seconds;
1178         u32 flags;
1179         u8  display_message[2048];
1180 } __packed;
1181
1182 struct heartbeat_msg_data {
1183         u64 seq_num;
1184         u32 reserved[8];
1185 } __packed;
1186
1187 /* Time Sync IC defs */
1188 #define ICTIMESYNCFLAG_PROBE    0
1189 #define ICTIMESYNCFLAG_SYNC     1
1190 #define ICTIMESYNCFLAG_SAMPLE   2
1191
1192 #ifdef __x86_64__
1193 #define WLTIMEDELTA     116444736000000000L     /* in 100ns unit */
1194 #else
1195 #define WLTIMEDELTA     116444736000000000LL
1196 #endif
1197
1198 struct ictimesync_data {
1199         u64 parenttime;
1200         u64 childtime;
1201         u64 roundtriptime;
1202         u8 flags;
1203 } __packed;
1204
1205 struct hyperv_service_callback {
1206         u8 msg_type;
1207         char *log_msg;
1208         uuid_le data;
1209         struct vmbus_channel *channel;
1210         void (*callback) (void *context);
1211 };
1212
1213 #define MAX_SRV_VER     0x7ffffff
1214 extern void vmbus_prep_negotiate_resp(struct icmsg_hdr *,
1215                                         struct icmsg_negotiate *, u8 *, int,
1216                                         int);
1217
1218 int hv_kvp_init(struct hv_util_service *);
1219 void hv_kvp_deinit(void);
1220 void hv_kvp_onchannelcallback(void *);
1221
1222 /*
1223  * Negotiated version with the Host.
1224  */
1225
1226 extern __u32 vmbus_proto_version;
1227
1228 #endif /* __KERNEL__ */
1229 #endif /* _HYPERV_H */