3 * Copyright (c) 2011, Microsoft Corporation.
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.
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
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.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
21 * K. Y. Srinivasan <kys@microsoft.com>
25 #ifndef _HYPERV_VMBUS_H
26 #define _HYPERV_VMBUS_H
28 #include <linux/list.h>
29 #include <asm/sync_bitops.h>
30 #include <linux/atomic.h>
31 #include <linux/hyperv.h>
34 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
35 * is set by CPUID(HVCPUID_VERSION_FEATURES).
37 enum hv_cpuid_function {
38 HVCPUID_VERSION_FEATURES = 0x00000001,
39 HVCPUID_VENDOR_MAXFUNCTION = 0x40000000,
40 HVCPUID_INTERFACE = 0x40000001,
43 * The remaining functions depend on the value of
46 HVCPUID_VERSION = 0x40000002,
47 HVCPUID_FEATURES = 0x40000003,
48 HVCPUID_ENLIGHTENMENT_INFO = 0x40000004,
49 HVCPUID_IMPLEMENTATION_LIMITS = 0x40000005,
52 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE 0x400
54 #define HV_X64_MSR_CRASH_P0 0x40000100
55 #define HV_X64_MSR_CRASH_P1 0x40000101
56 #define HV_X64_MSR_CRASH_P2 0x40000102
57 #define HV_X64_MSR_CRASH_P3 0x40000103
58 #define HV_X64_MSR_CRASH_P4 0x40000104
59 #define HV_X64_MSR_CRASH_CTL 0x40000105
61 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
63 /* Define version of the synthetic interrupt controller. */
64 #define HV_SYNIC_VERSION (1)
66 /* Define synthetic interrupt controller message constants. */
67 #define HV_MESSAGE_SIZE (256)
68 #define HV_MESSAGE_PAYLOAD_BYTE_COUNT (240)
69 #define HV_MESSAGE_PAYLOAD_QWORD_COUNT (30)
70 #define HV_ANY_VP (0xFFFFFFFF)
72 /* Define synthetic interrupt controller flag constants. */
73 #define HV_EVENT_FLAGS_COUNT (256 * 8)
74 #define HV_EVENT_FLAGS_BYTE_COUNT (256)
75 #define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
77 /* Define hypervisor message types. */
78 enum hv_message_type {
79 HVMSG_NONE = 0x00000000,
81 /* Memory access messages. */
82 HVMSG_UNMAPPED_GPA = 0x80000000,
83 HVMSG_GPA_INTERCEPT = 0x80000001,
85 /* Timer notification messages. */
86 HVMSG_TIMER_EXPIRED = 0x80000010,
89 HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
90 HVMSG_UNRECOVERABLE_EXCEPTION = 0x80000021,
91 HVMSG_UNSUPPORTED_FEATURE = 0x80000022,
93 /* Trace buffer complete messages. */
94 HVMSG_EVENTLOG_BUFFERCOMPLETE = 0x80000040,
96 /* Platform-specific processor intercept messages. */
97 HVMSG_X64_IOPORT_INTERCEPT = 0x80010000,
98 HVMSG_X64_MSR_INTERCEPT = 0x80010001,
99 HVMSG_X64_CPUID_INTERCEPT = 0x80010002,
100 HVMSG_X64_EXCEPTION_INTERCEPT = 0x80010003,
101 HVMSG_X64_APIC_EOI = 0x80010004,
102 HVMSG_X64_LEGACY_FP_ERROR = 0x80010005
105 #define HV_SYNIC_STIMER_COUNT (4)
107 /* Define invalid partition identifier. */
108 #define HV_PARTITION_ID_INVALID ((u64)0x0)
110 /* Define port identifier type. */
119 /* Define port type. */
126 /* Define port information structure. */
127 struct hv_port_info {
128 enum hv_port_type port_type;
139 u16 base_flag_number;
150 struct hv_connection_info {
151 enum hv_port_type port_type;
156 } message_connection_info;
159 } event_connection_info;
162 } monitor_connection_info;
166 /* Define synthetic interrupt controller message flags. */
167 union hv_message_flags {
175 /* Define synthetic interrupt controller message header. */
176 struct hv_message_header {
177 enum hv_message_type message_type;
179 union hv_message_flags message_flags;
183 union hv_port_id port;
188 * Timer configuration register.
190 union hv_timer_config {
204 /* Define timer message payload structure. */
205 struct hv_timer_message_payload {
208 u64 expiration_time; /* When the timer expired */
209 u64 delivery_time; /* When the message was delivered */
212 /* Define synthetic interrupt controller message format. */
214 struct hv_message_header header;
216 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
220 /* Define the number of message buffers associated with each port. */
221 #define HV_PORT_MESSAGE_BUFFER_COUNT (16)
223 /* Define the synthetic interrupt message page layout. */
224 struct hv_message_page {
225 struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
228 /* Define the synthetic interrupt controller event flags format. */
229 union hv_synic_event_flags {
230 u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
231 u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
234 /* Define the synthetic interrupt flags page layout. */
235 struct hv_synic_event_flags_page {
236 union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
239 /* Define SynIC control register. */
240 union hv_synic_scontrol {
248 /* Define synthetic interrupt source. */
249 union hv_synic_sint {
260 /* Define the format of the SIMP register */
261 union hv_synic_simp {
266 u64 base_simp_gpa:52;
270 /* Define the format of the SIEFP register */
271 union hv_synic_siefp {
276 u64 base_siefp_gpa:52;
280 /* Definitions for the monitored notification facility */
281 union hv_monitor_trigger_group {
289 struct hv_monitor_parameter {
290 union hv_connection_id connectionid;
295 union hv_monitor_trigger_state {
304 /* struct hv_monitor_page Layout */
305 /* ------------------------------------------------------ */
306 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
307 /* | 8 | TriggerGroup[0] | */
308 /* | 10 | TriggerGroup[1] | */
309 /* | 18 | TriggerGroup[2] | */
310 /* | 20 | TriggerGroup[3] | */
311 /* | 28 | Rsvd2[0] | */
312 /* | 30 | Rsvd2[1] | */
313 /* | 38 | Rsvd2[2] | */
314 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
316 /* | 240 | Latency[0][0..3] | */
317 /* | 340 | Rsvz3[0] | */
318 /* | 440 | Parameter[0][0] | */
319 /* | 448 | Parameter[0][1] | */
321 /* | 840 | Rsvd4[0] | */
322 /* ------------------------------------------------------ */
323 struct hv_monitor_page {
324 union hv_monitor_trigger_state trigger_state;
327 union hv_monitor_trigger_group trigger_group[4];
330 s32 next_checktime[4][32];
335 struct hv_monitor_parameter parameter[4][32];
340 /* Declare the various hypercall operations. */
342 HVCALL_POST_MESSAGE = 0x005c,
343 HVCALL_SIGNAL_EVENT = 0x005d,
346 /* Definition of the hv_post_message hypercall input structure. */
347 struct hv_input_post_message {
348 union hv_connection_id connectionid;
350 enum hv_message_type message_type;
352 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
356 * Versioning definitions used for guests reporting themselves to the
357 * hypervisor, and visa versa.
360 /* Version info reported by guest OS's */
361 enum hv_guest_os_vendor {
362 HVGUESTOS_VENDOR_MICROSOFT = 0x0001
365 enum hv_guest_os_microsoft_ids {
366 HVGUESTOS_MICROSOFT_UNDEFINED = 0x00,
367 HVGUESTOS_MICROSOFT_MSDOS = 0x01,
368 HVGUESTOS_MICROSOFT_WINDOWS3X = 0x02,
369 HVGUESTOS_MICROSOFT_WINDOWS9X = 0x03,
370 HVGUESTOS_MICROSOFT_WINDOWSNT = 0x04,
371 HVGUESTOS_MICROSOFT_WINDOWSCE = 0x05
375 * Declare the MSR used to identify the guest OS.
377 #define HV_X64_MSR_GUEST_OS_ID 0x40000000
379 union hv_x64_msr_guest_os_id_contents {
383 u64 service_version:8; /* Service Pack, etc. */
386 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
387 u64 vendor_id:16; /* enum hv_guest_os_vendor */
392 * Declare the MSR used to setup pages used to communicate with the hypervisor.
394 #define HV_X64_MSR_HYPERCALL 0x40000001
396 union hv_x64_msr_hypercall_contents {
401 u64 guest_physical_address:52;
407 VMBUS_MESSAGE_CONNECTION_ID = 1,
408 VMBUS_MESSAGE_PORT_ID = 1,
409 VMBUS_EVENT_CONNECTION_ID = 2,
410 VMBUS_EVENT_PORT_ID = 2,
411 VMBUS_MONITOR_CONNECTION_ID = 3,
412 VMBUS_MONITOR_PORT_ID = 3,
413 VMBUS_MESSAGE_SINT = 2,
418 #define HV_PRESENT_BIT 0x80000000
421 * The guest OS needs to register the guest ID with the hypervisor.
422 * The guest ID is a 64 bit entity and the structure of this ID is
423 * specified in the Hyper-V specification:
425 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
427 * While the current guideline does not specify how Linux guest ID(s)
428 * need to be generated, our plan is to publish the guidelines for
429 * Linux and other guest operating systems that currently are hosted
430 * on Hyper-V. The implementation here conforms to this yet
431 * unpublished guidelines.
435 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
436 * 62:56 - Os Type; Linux is 0x100
437 * 55:48 - Distro specific identification
438 * 47:16 - Linux kernel version number
439 * 15:0 - Distro specific identification
444 #define HV_LINUX_VENDOR_ID 0x8100
447 * Generate the guest ID based on the guideline described above.
450 static inline __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
455 guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
456 guest_id |= (((__u64)(d_info1)) << 48);
457 guest_id |= (((__u64)(kernel_version)) << 16);
458 guest_id |= ((__u64)(d_info2));
464 #define HV_CPU_POWER_MANAGEMENT (1 << 0)
465 #define HV_RECOMMENDATIONS_MAX 4
468 #define HV_CAPS_MAX 8
471 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
474 /* Service definitions */
476 #define HV_SERVICE_PARENT_PORT (0)
477 #define HV_SERVICE_PARENT_CONNECTION (0)
479 #define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
480 #define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
481 #define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
482 #define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
484 #define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
485 #define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
486 #define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
487 #define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
488 #define HV_SERVICE_MAX_MESSAGE_ID (4)
490 #define HV_SERVICE_PROTOCOL_VERSION (0x0010)
491 #define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
493 /* #define VMBUS_REVISION_NUMBER 6 */
495 /* Our local vmbus's port and connection id. Anything >0 is fine */
496 /* #define VMBUS_PORT_ID 11 */
498 /* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
499 static const uuid_le VMBUS_SERVICE_ID = {
501 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
502 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
509 /* We only support running on top of Hyper-V
510 * So at this point this really can only contain the Hyper-V ID
514 void *hypercall_page;
517 bool synic_initialized;
519 void *synic_message_page[NR_CPUS];
520 void *synic_event_page[NR_CPUS];
522 * Hypervisor's notion of virtual processor ID is different from
523 * Linux' notion of CPU ID. This information can only be retrieved
524 * in the context of the calling CPU. Setup a map for easy access
525 * to this information:
527 * vp_index[a] is the Hyper-V's processor ID corresponding to
530 u32 vp_index[NR_CPUS];
532 * Starting with win8, we can take channel interrupts on any CPU;
533 * we will manage the tasklet that handles events on a per CPU
536 struct tasklet_struct *event_dpc[NR_CPUS];
538 * To optimize the mapping of relid to channel, maintain
539 * per-cpu list of the channels based on their CPU affinity.
541 struct list_head percpu_list[NR_CPUS];
543 * buffer to post messages to the host.
545 void *post_msg_page[NR_CPUS];
547 * Support PV clockevent device.
549 struct clock_event_device *clk_evt[NR_CPUS];
551 * To manage allocations in a NUMA node.
552 * Array indexed by numa node ID.
554 struct cpumask *hv_numa_map;
557 extern struct hv_context hv_context;
559 struct ms_hyperv_tsc_page {
560 volatile u32 tsc_sequence;
562 volatile u64 tsc_scale;
563 volatile s64 tsc_offset;
567 struct hv_ring_buffer_debug_info {
568 u32 current_interrupt_mask;
569 u32 current_read_index;
570 u32 current_write_index;
571 u32 bytes_avail_toread;
572 u32 bytes_avail_towrite;
577 extern int hv_init(void);
579 extern void hv_cleanup(void);
581 extern int hv_post_message(union hv_connection_id connection_id,
582 enum hv_message_type message_type,
583 void *payload, size_t payload_size);
585 extern u16 hv_signal_event(void *con_id);
587 extern int hv_synic_alloc(void);
589 extern void hv_synic_free(void);
591 extern void hv_synic_init(void *irqarg);
593 extern void hv_synic_cleanup(void *arg);
595 extern void hv_synic_clockevents_cleanup(void);
598 * Host version information.
600 extern unsigned int host_info_eax;
601 extern unsigned int host_info_ebx;
602 extern unsigned int host_info_ecx;
603 extern unsigned int host_info_edx;
608 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, void *buffer,
611 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
613 int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
614 struct kvec *kv_list,
615 u32 kv_count, bool *signal);
617 int hv_ringbuffer_peek(struct hv_ring_buffer_info *ring_info, void *buffer,
620 int hv_ringbuffer_read(struct hv_ring_buffer_info *ring_info,
623 u32 offset, bool *signal);
626 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
627 struct hv_ring_buffer_debug_info *debug_info);
629 void hv_begin_read(struct hv_ring_buffer_info *rbi);
631 u32 hv_end_read(struct hv_ring_buffer_info *rbi);
634 * Maximum channels is determined by the size of the interrupt page
635 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
636 * and the other is receive endpoint interrupt
638 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
640 /* The value here must be in multiple of 32 */
641 /* TODO: Need to make this configurable */
642 #define MAX_NUM_CHANNELS_SUPPORTED 256
645 enum vmbus_connect_state {
652 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
654 struct vmbus_connection {
655 enum vmbus_connect_state conn_state;
657 atomic_t next_gpadl_handle;
659 struct completion unload_event;
661 * Represents channel interrupts. Each bit position represents a
662 * channel. When a channel sends an interrupt via VMBUS, it finds its
663 * bit in the sendInterruptPage, set it and calls Hv to generate a port
664 * event. The other end receives the port event and parse the
665 * recvInterruptPage to see which bit is set
672 * 2 pages - 1st page for parent->child notification and 2nd
673 * is child->parent notification
675 struct hv_monitor_page *monitor_pages[2];
676 struct list_head chn_msg_list;
677 spinlock_t channelmsg_lock;
679 /* List of channels */
680 struct list_head chn_list;
681 spinlock_t channel_lock;
683 struct workqueue_struct *work_queue;
687 struct vmbus_msginfo {
688 /* Bookkeeping stuff */
689 struct list_head msglist_entry;
691 /* The message itself */
692 unsigned char msg[0];
696 extern struct vmbus_connection vmbus_connection;
698 enum vmbus_message_handler_type {
699 /* The related handler can sleep. */
702 /* The related handler must NOT sleep. */
703 VMHT_NON_BLOCKING = 1,
706 struct vmbus_channel_message_table_entry {
707 enum vmbus_channel_message_type message_type;
708 enum vmbus_message_handler_type handler_type;
709 void (*message_handler)(struct vmbus_channel_message_header *msg);
712 extern struct vmbus_channel_message_table_entry
713 channel_message_table[CHANNELMSG_COUNT];
715 /* General vmbus interface */
717 struct hv_device *vmbus_device_create(const uuid_le *type,
718 const uuid_le *instance,
719 struct vmbus_channel *channel);
721 int vmbus_device_register(struct hv_device *child_device_obj);
722 void vmbus_device_unregister(struct hv_device *device_obj);
725 /* VmbusChildDeviceDestroy( */
726 /* struct hv_device *); */
728 struct vmbus_channel *relid2channel(u32 relid);
730 void vmbus_free_channels(void);
732 /* Connection interface */
734 int vmbus_connect(void);
735 void vmbus_disconnect(void);
737 int vmbus_post_msg(void *buffer, size_t buflen);
739 int vmbus_set_event(struct vmbus_channel *channel);
741 void vmbus_on_event(unsigned long data);
743 int hv_kvp_init(struct hv_util_service *);
744 void hv_kvp_deinit(void);
745 void hv_kvp_onchannelcallback(void *);
747 int hv_vss_init(struct hv_util_service *);
748 void hv_vss_deinit(void);
749 void hv_vss_onchannelcallback(void *);
751 int hv_fcopy_init(struct hv_util_service *);
752 void hv_fcopy_deinit(void);
753 void hv_fcopy_onchannelcallback(void *);
754 void vmbus_initiate_unload(void);
756 static inline void hv_poll_channel(struct vmbus_channel *channel,
762 if (channel->target_cpu != smp_processor_id())
763 smp_call_function_single(channel->target_cpu,
769 enum hvutil_device_state {
770 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
771 HVUTIL_READY, /* userspace is registered */
772 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
773 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
774 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
775 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
778 #endif /* _HYPERV_VMBUS_H */