drivers/hv/hyperv_vmbus.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_VMBUS_H
  26 #define _HYPERV_VMBUS_H
  27
  28 #include <linux/list.h>
  29 #include <linux/bitops.h>
  30 #include <asm/sync_bitops.h>
  31 #include <linux/atomic.h>
  32 #include <linux/hyperv.h>
  33
  34 /*
  35  * Timeout for services such as KVP and fcopy.
  36  */
  37 #define HV_UTIL_TIMEOUT 30
  38
  39 /*
  40  * Timeout for guest-host handshake for services.
  41  */
  42 #define HV_UTIL_NEGO_TIMEOUT 60
  43
  44 /*
  45  * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
  46  * is set by CPUID(HVCPUID_VERSION_FEATURES).
  47  */
  48 enum hv_cpuid_function {
  49         HVCPUID_VERSION_FEATURES                = 0x00000001,
  50         HVCPUID_VENDOR_MAXFUNCTION              = 0x40000000,
  51         HVCPUID_INTERFACE                       = 0x40000001,
  52
  53         /*
  54          * The remaining functions depend on the value of
  55          * HVCPUID_INTERFACE
  56          */
  57         HVCPUID_VERSION                 = 0x40000002,
  58         HVCPUID_FEATURES                        = 0x40000003,
  59         HVCPUID_ENLIGHTENMENT_INFO      = 0x40000004,
  60         HVCPUID_IMPLEMENTATION_LIMITS           = 0x40000005,
  61 };
  62
  63 #define  HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE   0x400
  64
  65 #define HV_X64_MSR_CRASH_P0   0x40000100
  66 #define HV_X64_MSR_CRASH_P1   0x40000101
  67 #define HV_X64_MSR_CRASH_P2   0x40000102
  68 #define HV_X64_MSR_CRASH_P3   0x40000103
  69 #define HV_X64_MSR_CRASH_P4   0x40000104
  70 #define HV_X64_MSR_CRASH_CTL  0x40000105
  71
  72 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
  73
  74 /* Define version of the synthetic interrupt controller. */
  75 #define HV_SYNIC_VERSION                (1)
  76
  77 /* Define synthetic interrupt controller message constants. */
  78 #define HV_MESSAGE_SIZE                 (256)
  79 #define HV_MESSAGE_PAYLOAD_BYTE_COUNT   (240)
  80 #define HV_MESSAGE_PAYLOAD_QWORD_COUNT  (30)
  81 #define HV_ANY_VP                       (0xFFFFFFFF)
  82
  83 /* Define synthetic interrupt controller flag constants. */
  84 #define HV_EVENT_FLAGS_COUNT            (256 * 8)
  85 #define HV_EVENT_FLAGS_BYTE_COUNT       (256)
  86 #define HV_EVENT_FLAGS_DWORD_COUNT      (256 / sizeof(u32))
  87
  88 /* Define hypervisor message types. */
  89 enum hv_message_type {
  90         HVMSG_NONE                      = 0x00000000,
  91
  92         /* Memory access messages. */
  93         HVMSG_UNMAPPED_GPA              = 0x80000000,
  94         HVMSG_GPA_INTERCEPT             = 0x80000001,
  95
  96         /* Timer notification messages. */
  97         HVMSG_TIMER_EXPIRED                     = 0x80000010,
  98
  99         /* Error messages. */
 100         HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
 101         HVMSG_UNRECOVERABLE_EXCEPTION   = 0x80000021,
 102         HVMSG_UNSUPPORTED_FEATURE               = 0x80000022,
 103
 104         /* Trace buffer complete messages. */
 105         HVMSG_EVENTLOG_BUFFERCOMPLETE   = 0x80000040,
 106
 107         /* Platform-specific processor intercept messages. */
 108         HVMSG_X64_IOPORT_INTERCEPT              = 0x80010000,
 109         HVMSG_X64_MSR_INTERCEPT         = 0x80010001,
 110         HVMSG_X64_CPUID_INTERCEPT               = 0x80010002,
 111         HVMSG_X64_EXCEPTION_INTERCEPT   = 0x80010003,
 112         HVMSG_X64_APIC_EOI                      = 0x80010004,
 113         HVMSG_X64_LEGACY_FP_ERROR               = 0x80010005
 114 };
 115
 116 #define HV_SYNIC_STIMER_COUNT           (4)
 117
 118 /* Define invalid partition identifier. */
 119 #define HV_PARTITION_ID_INVALID         ((u64)0x0)
 120
 121 /* Define port identifier type. */
 122 union hv_port_id {
 123         u32 asu32;
 124         struct {
 125                 u32 id:24;
 126                 u32 reserved:8;
 127         } u ;
 128 };
 129
 130 /* Define port type. */
 131 enum hv_port_type {
 132         HVPORT_MSG      = 1,
 133         HVPORT_EVENT            = 2,
 134         HVPORT_MONITOR  = 3
 135 };
 136
 137 /* Define port information structure. */
 138 struct hv_port_info {
 139         enum hv_port_type port_type;
 140         u32 padding;
 141         union {
 142                 struct {
 143                         u32 target_sint;
 144                         u32 target_vp;
 145                         u64 rsvdz;
 146                 } message_port_info;
 147                 struct {
 148                         u32 target_sint;
 149                         u32 target_vp;
 150                         u16 base_flag_number;
 151                         u16 flag_count;
 152                         u32 rsvdz;
 153                 } event_port_info;
 154                 struct {
 155                         u64 monitor_address;
 156                         u64 rsvdz;
 157                 } monitor_port_info;
 158         };
 159 };
 160
 161 struct hv_connection_info {
 162         enum hv_port_type port_type;
 163         u32 padding;
 164         union {
 165                 struct {
 166                         u64 rsvdz;
 167                 } message_connection_info;
 168                 struct {
 169                         u64 rsvdz;
 170                 } event_connection_info;
 171                 struct {
 172                         u64 monitor_address;
 173                 } monitor_connection_info;
 174         };
 175 };
 176
 177 /* Define synthetic interrupt controller message flags. */
 178 union hv_message_flags {
 179         u8 asu8;
 180         struct {
 181                 u8 msg_pending:1;
 182                 u8 reserved:7;
 183         };
 184 };
 185
 186 /* Define synthetic interrupt controller message header. */
 187 struct hv_message_header {
 188         enum hv_message_type message_type;
 189         u8 payload_size;
 190         union hv_message_flags message_flags;
 191         u8 reserved[2];
 192         union {
 193                 u64 sender;
 194                 union hv_port_id port;
 195         };
 196 };
 197
 198 /*
 199  * Timer configuration register.
 200  */
 201 union hv_timer_config {
 202         u64 as_uint64;
 203         struct {
 204                 u64 enable:1;
 205                 u64 periodic:1;
 206                 u64 lazy:1;
 207                 u64 auto_enable:1;
 208                 u64 reserved_z0:12;
 209                 u64 sintx:4;
 210                 u64 reserved_z1:44;
 211         };
 212 };
 213
 214
 215 /* Define timer message payload structure. */
 216 struct hv_timer_message_payload {
 217         u32 timer_index;
 218         u32 reserved;
 219         u64 expiration_time;    /* When the timer expired */
 220         u64 delivery_time;      /* When the message was delivered */
 221 };
 222
 223 /* Define synthetic interrupt controller message format. */
 224 struct hv_message {
 225         struct hv_message_header header;
 226         union {
 227                 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
 228         } u ;
 229 };
 230
 231 /* Define the number of message buffers associated with each port. */
 232 #define HV_PORT_MESSAGE_BUFFER_COUNT    (16)
 233
 234 /* Define the synthetic interrupt message page layout. */
 235 struct hv_message_page {
 236         struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
 237 };
 238
 239 /* Define the synthetic interrupt controller event flags format. */
 240 union hv_synic_event_flags {
 241         u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
 242         u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
 243 };
 244
 245 /* Define the synthetic interrupt flags page layout. */
 246 struct hv_synic_event_flags_page {
 247         union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
 248 };
 249
 250 /* Define SynIC control register. */
 251 union hv_synic_scontrol {
 252         u64 as_uint64;
 253         struct {
 254                 u64 enable:1;
 255                 u64 reserved:63;
 256         };
 257 };
 258
 259 /* Define synthetic interrupt source. */
 260 union hv_synic_sint {
 261         u64 as_uint64;
 262         struct {
 263                 u64 vector:8;
 264                 u64 reserved1:8;
 265                 u64 masked:1;
 266                 u64 auto_eoi:1;
 267                 u64 reserved2:46;
 268         };
 269 };
 270
 271 /* Define the format of the SIMP register */
 272 union hv_synic_simp {
 273         u64 as_uint64;
 274         struct {
 275                 u64 simp_enabled:1;
 276                 u64 preserved:11;
 277                 u64 base_simp_gpa:52;
 278         };
 279 };
 280
 281 /* Define the format of the SIEFP register */
 282 union hv_synic_siefp {
 283         u64 as_uint64;
 284         struct {
 285                 u64 siefp_enabled:1;
 286                 u64 preserved:11;
 287                 u64 base_siefp_gpa:52;
 288         };
 289 };
 290
 291 /* Definitions for the monitored notification facility */
 292 union hv_monitor_trigger_group {
 293         u64 as_uint64;
 294         struct {
 295                 u32 pending;
 296                 u32 armed;
 297         };
 298 };
 299
 300 struct hv_monitor_parameter {
 301         union hv_connection_id connectionid;
 302         u16 flagnumber;
 303         u16 rsvdz;
 304 };
 305
 306 union hv_monitor_trigger_state {
 307         u32 asu32;
 308
 309         struct {
 310                 u32 group_enable:4;
 311                 u32 rsvdz:28;
 312         };
 313 };
 314
 315 /* struct hv_monitor_page Layout */
 316 /* ------------------------------------------------------ */
 317 /* | 0   | TriggerState (4 bytes) | Rsvd1 (4 bytes)     | */
 318 /* | 8   | TriggerGroup[0]                              | */
 319 /* | 10  | TriggerGroup[1]                              | */
 320 /* | 18  | TriggerGroup[2]                              | */
 321 /* | 20  | TriggerGroup[3]                              | */
 322 /* | 28  | Rsvd2[0]                                     | */
 323 /* | 30  | Rsvd2[1]                                     | */
 324 /* | 38  | Rsvd2[2]                                     | */
 325 /* | 40  | NextCheckTime[0][0]    | NextCheckTime[0][1] | */
 326 /* | ...                                                | */
 327 /* | 240 | Latency[0][0..3]                             | */
 328 /* | 340 | Rsvz3[0]                                     | */
 329 /* | 440 | Parameter[0][0]                              | */
 330 /* | 448 | Parameter[0][1]                              | */
 331 /* | ...                                                | */
 332 /* | 840 | Rsvd4[0]                                     | */
 333 /* ------------------------------------------------------ */
 334 struct hv_monitor_page {
 335         union hv_monitor_trigger_state trigger_state;
 336         u32 rsvdz1;
 337
 338         union hv_monitor_trigger_group trigger_group[4];
 339         u64 rsvdz2[3];
 340
 341         s32 next_checktime[4][32];
 342
 343         u16 latency[4][32];
 344         u64 rsvdz3[32];
 345
 346         struct hv_monitor_parameter parameter[4][32];
 347
 348         u8 rsvdz4[1984];
 349 };
 350
 351 /* Declare the various hypercall operations. */
 352 enum hv_call_code {
 353         HVCALL_POST_MESSAGE     = 0x005c,
 354         HVCALL_SIGNAL_EVENT     = 0x005d,
 355 };
 356
 357 /* Definition of the hv_post_message hypercall input structure. */
 358 struct hv_input_post_message {
 359         union hv_connection_id connectionid;
 360         u32 reserved;
 361         enum hv_message_type message_type;
 362         u32 payload_size;
 363         u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
 364 };
 365
 366 /*
 367  * Versioning definitions used for guests reporting themselves to the
 368  * hypervisor, and visa versa.
 369  */
 370
 371 /* Version info reported by guest OS's */
 372 enum hv_guest_os_vendor {
 373         HVGUESTOS_VENDOR_MICROSOFT      = 0x0001
 374 };
 375
 376 enum hv_guest_os_microsoft_ids {
 377         HVGUESTOS_MICROSOFT_UNDEFINED   = 0x00,
 378         HVGUESTOS_MICROSOFT_MSDOS               = 0x01,
 379         HVGUESTOS_MICROSOFT_WINDOWS3X   = 0x02,
 380         HVGUESTOS_MICROSOFT_WINDOWS9X   = 0x03,
 381         HVGUESTOS_MICROSOFT_WINDOWSNT   = 0x04,
 382         HVGUESTOS_MICROSOFT_WINDOWSCE   = 0x05
 383 };
 384
 385 /*
 386  * Declare the MSR used to identify the guest OS.
 387  */
 388 #define HV_X64_MSR_GUEST_OS_ID  0x40000000
 389
 390 union hv_x64_msr_guest_os_id_contents {
 391         u64 as_uint64;
 392         struct {
 393                 u64 build_number:16;
 394                 u64 service_version:8; /* Service Pack, etc. */
 395                 u64 minor_version:8;
 396                 u64 major_version:8;
 397                 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
 398                 u64 vendor_id:16; /* enum hv_guest_os_vendor */
 399         };
 400 };
 401
 402 /*
 403  * Declare the MSR used to setup pages used to communicate with the hypervisor.
 404  */
 405 #define HV_X64_MSR_HYPERCALL    0x40000001
 406
 407 union hv_x64_msr_hypercall_contents {
 408         u64 as_uint64;
 409         struct {
 410                 u64 enable:1;
 411                 u64 reserved:11;
 412                 u64 guest_physical_address:52;
 413         };
 414 };
 415
 416
 417 enum {
 418         VMBUS_MESSAGE_CONNECTION_ID     = 1,
 419         VMBUS_MESSAGE_PORT_ID           = 1,
 420         VMBUS_EVENT_CONNECTION_ID       = 2,
 421         VMBUS_EVENT_PORT_ID             = 2,
 422         VMBUS_MONITOR_CONNECTION_ID     = 3,
 423         VMBUS_MONITOR_PORT_ID           = 3,
 424         VMBUS_MESSAGE_SINT              = 2,
 425 };
 426
 427 /* #defines */
 428
 429 #define HV_PRESENT_BIT                  0x80000000
 430
 431 /*
 432  * The guest OS needs to register the guest ID with the hypervisor.
 433  * The guest ID is a 64 bit entity and the structure of this ID is
 434  * specified in the Hyper-V specification:
 435  *
 436  * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
 437  *
 438  * While the current guideline does not specify how Linux guest ID(s)
 439  * need to be generated, our plan is to publish the guidelines for
 440  * Linux and other guest operating systems that currently are hosted
 441  * on Hyper-V. The implementation here conforms to this yet
 442  * unpublished guidelines.
 443  *
 444  *
 445  * Bit(s)
 446  * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
 447  * 62:56 - Os Type; Linux is 0x100
 448  * 55:48 - Distro specific identification
 449  * 47:16 - Linux kernel version number
 450  * 15:0  - Distro specific identification
 451  *
 452  *
 453  */
 454
 455 #define HV_LINUX_VENDOR_ID              0x8100
 456
 457 /*
 458  * Generate the guest ID based on the guideline described above.
 459  */
 460
 461 static inline  __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
 462                                         __u16 d_info2)
 463 {
 464         __u64 guest_id = 0;
 465
 466         guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
 467         guest_id |= (((__u64)(d_info1)) << 48);
 468         guest_id |= (((__u64)(kernel_version)) << 16);
 469         guest_id |= ((__u64)(d_info2));
 470
 471         return guest_id;
 472 }
 473
 474
 475 #define HV_CPU_POWER_MANAGEMENT         (1 << 0)
 476 #define HV_RECOMMENDATIONS_MAX          4
 477
 478 #define HV_X64_MAX                      5
 479 #define HV_CAPS_MAX                     8
 480
 481
 482 #define HV_HYPERCALL_PARAM_ALIGN        sizeof(u64)
 483
 484
 485 /* Service definitions */
 486
 487 #define HV_SERVICE_PARENT_PORT                          (0)
 488 #define HV_SERVICE_PARENT_CONNECTION                    (0)
 489
 490 #define HV_SERVICE_CONNECT_RESPONSE_SUCCESS             (0)
 491 #define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER   (1)
 492 #define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE     (2)
 493 #define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
 494
 495 #define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID           (1)
 496 #define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID          (2)
 497 #define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID        (3)
 498 #define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID       (4)
 499 #define HV_SERVICE_MAX_MESSAGE_ID                               (4)
 500
 501 #define HV_SERVICE_PROTOCOL_VERSION (0x0010)
 502 #define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
 503
 504 /* #define VMBUS_REVISION_NUMBER        6 */
 505
 506 /* Our local vmbus's port and connection id. Anything >0 is fine */
 507 /* #define VMBUS_PORT_ID                11 */
 508
 509 /* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
 510 static const uuid_le VMBUS_SERVICE_ID = {
 511         .b = {
 512                 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
 513                 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
 514         },
 515 };
 516
 517
 518
 519 struct hv_context {
 520         /* We only support running on top of Hyper-V
 521         * So at this point this really can only contain the Hyper-V ID
 522         */
 523         u64 guestid;
 524
 525         void *hypercall_page;
 526         void *tsc_page;
 527
 528         bool synic_initialized;
 529
 530         void *synic_message_page[NR_CPUS];
 531         void *synic_event_page[NR_CPUS];
 532         /*
 533          * Hypervisor's notion of virtual processor ID is different from
 534          * Linux' notion of CPU ID. This information can only be retrieved
 535          * in the context of the calling CPU. Setup a map for easy access
 536          * to this information:
 537          *
 538          * vp_index[a] is the Hyper-V's processor ID corresponding to
 539          * Linux cpuid 'a'.
 540          */
 541         u32 vp_index[NR_CPUS];
 542         /*
 543          * Starting with win8, we can take channel interrupts on any CPU;
 544          * we will manage the tasklet that handles events on a per CPU
 545          * basis.
 546          */
 547         struct tasklet_struct *event_dpc[NR_CPUS];
 548         /*
 549          * To optimize the mapping of relid to channel, maintain
 550          * per-cpu list of the channels based on their CPU affinity.
 551          */
 552         struct list_head percpu_list[NR_CPUS];
 553         /*
 554          * buffer to post messages to the host.
 555          */
 556         void *post_msg_page[NR_CPUS];
 557         /*
 558          * Support PV clockevent device.
 559          */
 560         struct clock_event_device *clk_evt[NR_CPUS];
 561         /*
 562          * To manage allocations in a NUMA node.
 563          * Array indexed by numa node ID.
 564          */
 565         struct cpumask *hv_numa_map;
 566 };
 567
 568 extern struct hv_context hv_context;
 569
 570 struct ms_hyperv_tsc_page {
 571         volatile u32 tsc_sequence;
 572         u32 reserved1;
 573         volatile u64 tsc_scale;
 574         volatile s64 tsc_offset;
 575         u64 reserved2[509];
 576 };
 577
 578 struct hv_ring_buffer_debug_info {
 579         u32 current_interrupt_mask;
 580         u32 current_read_index;
 581         u32 current_write_index;
 582         u32 bytes_avail_toread;
 583         u32 bytes_avail_towrite;
 584 };
 585
 586 /* Hv Interface */
 587
 588 extern int hv_init(void);
 589
 590 extern void hv_cleanup(bool crash);
 591
 592 extern int hv_post_message(union hv_connection_id connection_id,
 593                          enum hv_message_type message_type,
 594                          void *payload, size_t payload_size);
 595
 596 extern u16 hv_signal_event(void *con_id);
 597
 598 extern int hv_synic_alloc(void);
 599
 600 extern void hv_synic_free(void);
 601
 602 extern void hv_synic_init(void *irqarg);
 603
 604 extern void hv_synic_cleanup(void *arg);
 605
 606 extern void hv_synic_clockevents_cleanup(void);
 607
 608 /*
 609  * Host version information.
 610  */
 611 extern unsigned int host_info_eax;
 612 extern unsigned int host_info_ebx;
 613 extern unsigned int host_info_ecx;
 614 extern unsigned int host_info_edx;
 615
 616 /* Interface */
 617
 618
 619 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, void *buffer,
 620                    u32 buflen);
 621
 622 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
 623
 624 int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
 625                     struct kvec *kv_list,
 626                     u32 kv_count, bool *signal);
 627
 628 int hv_ringbuffer_peek(struct hv_ring_buffer_info *ring_info, void *buffer,
 629                    u32 buflen);
 630
 631 int hv_ringbuffer_read(struct hv_ring_buffer_info *ring_info,
 632                    void *buffer,
 633                    u32 buflen,
 634                    u32 offset, bool *signal);
 635
 636
 637 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
 638                             struct hv_ring_buffer_debug_info *debug_info);
 639
 640 void hv_begin_read(struct hv_ring_buffer_info *rbi);
 641
 642 u32 hv_end_read(struct hv_ring_buffer_info *rbi);
 643
 644 /*
 645  * Maximum channels is determined by the size of the interrupt page
 646  * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
 647  * and the other is receive endpoint interrupt
 648  */
 649 #define MAX_NUM_CHANNELS        ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
 650
 651 /* The value here must be in multiple of 32 */
 652 /* TODO: Need to make this configurable */
 653 #define MAX_NUM_CHANNELS_SUPPORTED      256
 654
 655
 656 enum vmbus_connect_state {
 657         DISCONNECTED,
 658         CONNECTING,
 659         CONNECTED,
 660         DISCONNECTING
 661 };
 662
 663 #define MAX_SIZE_CHANNEL_MESSAGE        HV_MESSAGE_PAYLOAD_BYTE_COUNT
 664
 665 struct vmbus_connection {
 666         enum vmbus_connect_state conn_state;
 667
 668         atomic_t next_gpadl_handle;
 669
 670         struct completion  unload_event;
 671         /*
 672          * Represents channel interrupts. Each bit position represents a
 673          * channel.  When a channel sends an interrupt via VMBUS, it finds its
 674          * bit in the sendInterruptPage, set it and calls Hv to generate a port
 675          * event. The other end receives the port event and parse the
 676          * recvInterruptPage to see which bit is set
 677          */
 678         void *int_page;
 679         void *send_int_page;
 680         void *recv_int_page;
 681
 682         /*
 683          * 2 pages - 1st page for parent->child notification and 2nd
 684          * is child->parent notification
 685          */
 686         struct hv_monitor_page *monitor_pages[2];
 687         struct list_head chn_msg_list;
 688         spinlock_t channelmsg_lock;
 689
 690         /* List of channels */
 691         struct list_head chn_list;
 692         spinlock_t channel_lock;
 693
 694         struct workqueue_struct *work_queue;
 695 };
 696
 697
 698 struct vmbus_msginfo {
 699         /* Bookkeeping stuff */
 700         struct list_head msglist_entry;
 701
 702         /* The message itself */
 703         unsigned char msg[0];
 704 };
 705
 706
 707 extern struct vmbus_connection vmbus_connection;
 708
 709 enum vmbus_message_handler_type {
 710         /* The related handler can sleep. */
 711         VMHT_BLOCKING = 0,
 712
 713         /* The related handler must NOT sleep. */
 714         VMHT_NON_BLOCKING = 1,
 715 };
 716
 717 struct vmbus_channel_message_table_entry {
 718         enum vmbus_channel_message_type message_type;
 719         enum vmbus_message_handler_type handler_type;
 720         void (*message_handler)(struct vmbus_channel_message_header *msg);
 721 };
 722
 723 extern struct vmbus_channel_message_table_entry
 724         channel_message_table[CHANNELMSG_COUNT];
 725
 726 /* General vmbus interface */
 727
 728 struct hv_device *vmbus_device_create(const uuid_le *type,
 729                                       const uuid_le *instance,
 730                                       struct vmbus_channel *channel);
 731
 732 int vmbus_device_register(struct hv_device *child_device_obj);
 733 void vmbus_device_unregister(struct hv_device *device_obj);
 734
 735 /* static void */
 736 /* VmbusChildDeviceDestroy( */
 737 /* struct hv_device *); */
 738
 739 struct vmbus_channel *relid2channel(u32 relid);
 740
 741 void vmbus_free_channels(void);
 742
 743 /* Connection interface */
 744
 745 int vmbus_connect(void);
 746 void vmbus_disconnect(void);
 747
 748 int vmbus_post_msg(void *buffer, size_t buflen);
 749
 750 int vmbus_set_event(struct vmbus_channel *channel);
 751
 752 void vmbus_on_event(unsigned long data);
 753
 754 int hv_kvp_init(struct hv_util_service *);
 755 void hv_kvp_deinit(void);
 756 void hv_kvp_onchannelcallback(void *);
 757
 758 int hv_vss_init(struct hv_util_service *);
 759 void hv_vss_deinit(void);
 760 void hv_vss_onchannelcallback(void *);
 761
 762 int hv_fcopy_init(struct hv_util_service *);
 763 void hv_fcopy_deinit(void);
 764 void hv_fcopy_onchannelcallback(void *);
 765 void vmbus_initiate_unload(void);
 766
 767 static inline void hv_poll_channel(struct vmbus_channel *channel,
 768                                    void (*cb)(void *))
 769 {
 770         if (!channel)
 771                 return;
 772
 773         smp_call_function_single(channel->target_cpu, cb, channel, true);
 774 }
 775
 776 enum hvutil_device_state {
 777         HVUTIL_DEVICE_INIT = 0,  /* driver is loaded, waiting for userspace */
 778         HVUTIL_READY,            /* userspace is registered */
 779         HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
 780         HVUTIL_USERSPACE_REQ,    /* request to userspace was sent */
 781         HVUTIL_USERSPACE_RECV,   /* reply from userspace was received */
 782         HVUTIL_DEVICE_DYING,     /* driver unload is in progress */
 783 };
 784
 785 #endif /* _HYPERV_VMBUS_H */