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 <linux/bitops.h>
30 #include <asm/sync_bitops.h>
31 #include <linux/atomic.h>
32 #include <linux/hyperv.h>
35 * Timeout for services such as KVP and fcopy.
37 #define HV_UTIL_TIMEOUT 30
40 * Timeout for guest-host handshake for services.
42 #define HV_UTIL_NEGO_TIMEOUT 60
45 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
46 * is set by CPUID(HVCPUID_VERSION_FEATURES).
48 enum hv_cpuid_function {
49 HVCPUID_VERSION_FEATURES = 0x00000001,
50 HVCPUID_VENDOR_MAXFUNCTION = 0x40000000,
51 HVCPUID_INTERFACE = 0x40000001,
54 * The remaining functions depend on the value of
57 HVCPUID_VERSION = 0x40000002,
58 HVCPUID_FEATURES = 0x40000003,
59 HVCPUID_ENLIGHTENMENT_INFO = 0x40000004,
60 HVCPUID_IMPLEMENTATION_LIMITS = 0x40000005,
63 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE 0x400
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
72 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
74 /* Define version of the synthetic interrupt controller. */
75 #define HV_SYNIC_VERSION (1)
77 #define HV_ANY_VP (0xFFFFFFFF)
79 /* Define synthetic interrupt controller flag constants. */
80 #define HV_EVENT_FLAGS_COUNT (256 * 8)
81 #define HV_EVENT_FLAGS_BYTE_COUNT (256)
82 #define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
84 /* Define invalid partition identifier. */
85 #define HV_PARTITION_ID_INVALID ((u64)0x0)
87 /* Define port type. */
94 /* Define port information structure. */
96 enum hv_port_type port_type;
107 u16 base_flag_number;
118 struct hv_connection_info {
119 enum hv_port_type port_type;
124 } message_connection_info;
127 } event_connection_info;
130 } monitor_connection_info;
135 * Timer configuration register.
137 union hv_timer_config {
150 /* Define the number of message buffers associated with each port. */
151 #define HV_PORT_MESSAGE_BUFFER_COUNT (16)
153 /* Define the synthetic interrupt controller event flags format. */
154 union hv_synic_event_flags {
155 u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
156 u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
159 /* Define the synthetic interrupt flags page layout. */
160 struct hv_synic_event_flags_page {
161 union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
164 /* Define SynIC control register. */
165 union hv_synic_scontrol {
173 /* Define synthetic interrupt source. */
174 union hv_synic_sint {
185 /* Define the format of the SIMP register */
186 union hv_synic_simp {
191 u64 base_simp_gpa:52;
195 /* Define the format of the SIEFP register */
196 union hv_synic_siefp {
201 u64 base_siefp_gpa:52;
205 /* Definitions for the monitored notification facility */
206 union hv_monitor_trigger_group {
214 struct hv_monitor_parameter {
215 union hv_connection_id connectionid;
220 union hv_monitor_trigger_state {
229 /* struct hv_monitor_page Layout */
230 /* ------------------------------------------------------ */
231 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
232 /* | 8 | TriggerGroup[0] | */
233 /* | 10 | TriggerGroup[1] | */
234 /* | 18 | TriggerGroup[2] | */
235 /* | 20 | TriggerGroup[3] | */
236 /* | 28 | Rsvd2[0] | */
237 /* | 30 | Rsvd2[1] | */
238 /* | 38 | Rsvd2[2] | */
239 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
241 /* | 240 | Latency[0][0..3] | */
242 /* | 340 | Rsvz3[0] | */
243 /* | 440 | Parameter[0][0] | */
244 /* | 448 | Parameter[0][1] | */
246 /* | 840 | Rsvd4[0] | */
247 /* ------------------------------------------------------ */
248 struct hv_monitor_page {
249 union hv_monitor_trigger_state trigger_state;
252 union hv_monitor_trigger_group trigger_group[4];
255 s32 next_checktime[4][32];
260 struct hv_monitor_parameter parameter[4][32];
265 /* Definition of the hv_post_message hypercall input structure. */
266 struct hv_input_post_message {
267 union hv_connection_id connectionid;
271 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
275 * Versioning definitions used for guests reporting themselves to the
276 * hypervisor, and visa versa.
279 /* Version info reported by guest OS's */
280 enum hv_guest_os_vendor {
281 HVGUESTOS_VENDOR_MICROSOFT = 0x0001
284 enum hv_guest_os_microsoft_ids {
285 HVGUESTOS_MICROSOFT_UNDEFINED = 0x00,
286 HVGUESTOS_MICROSOFT_MSDOS = 0x01,
287 HVGUESTOS_MICROSOFT_WINDOWS3X = 0x02,
288 HVGUESTOS_MICROSOFT_WINDOWS9X = 0x03,
289 HVGUESTOS_MICROSOFT_WINDOWSNT = 0x04,
290 HVGUESTOS_MICROSOFT_WINDOWSCE = 0x05
294 * Declare the MSR used to identify the guest OS.
296 #define HV_X64_MSR_GUEST_OS_ID 0x40000000
298 union hv_x64_msr_guest_os_id_contents {
302 u64 service_version:8; /* Service Pack, etc. */
305 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
306 u64 vendor_id:16; /* enum hv_guest_os_vendor */
311 * Declare the MSR used to setup pages used to communicate with the hypervisor.
313 #define HV_X64_MSR_HYPERCALL 0x40000001
315 union hv_x64_msr_hypercall_contents {
320 u64 guest_physical_address:52;
326 VMBUS_MESSAGE_CONNECTION_ID = 1,
327 VMBUS_MESSAGE_PORT_ID = 1,
328 VMBUS_EVENT_CONNECTION_ID = 2,
329 VMBUS_EVENT_PORT_ID = 2,
330 VMBUS_MONITOR_CONNECTION_ID = 3,
331 VMBUS_MONITOR_PORT_ID = 3,
332 VMBUS_MESSAGE_SINT = 2,
337 #define HV_PRESENT_BIT 0x80000000
340 * The guest OS needs to register the guest ID with the hypervisor.
341 * The guest ID is a 64 bit entity and the structure of this ID is
342 * specified in the Hyper-V specification:
344 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
346 * While the current guideline does not specify how Linux guest ID(s)
347 * need to be generated, our plan is to publish the guidelines for
348 * Linux and other guest operating systems that currently are hosted
349 * on Hyper-V. The implementation here conforms to this yet
350 * unpublished guidelines.
354 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
355 * 62:56 - Os Type; Linux is 0x100
356 * 55:48 - Distro specific identification
357 * 47:16 - Linux kernel version number
358 * 15:0 - Distro specific identification
363 #define HV_LINUX_VENDOR_ID 0x8100
366 * Generate the guest ID based on the guideline described above.
369 static inline __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
374 guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
375 guest_id |= (((__u64)(d_info1)) << 48);
376 guest_id |= (((__u64)(kernel_version)) << 16);
377 guest_id |= ((__u64)(d_info2));
383 #define HV_CPU_POWER_MANAGEMENT (1 << 0)
384 #define HV_RECOMMENDATIONS_MAX 4
387 #define HV_CAPS_MAX 8
390 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
393 /* Service definitions */
395 #define HV_SERVICE_PARENT_PORT (0)
396 #define HV_SERVICE_PARENT_CONNECTION (0)
398 #define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
399 #define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
400 #define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
401 #define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
403 #define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
404 #define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
405 #define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
406 #define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
407 #define HV_SERVICE_MAX_MESSAGE_ID (4)
409 #define HV_SERVICE_PROTOCOL_VERSION (0x0010)
410 #define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
412 /* #define VMBUS_REVISION_NUMBER 6 */
414 /* Our local vmbus's port and connection id. Anything >0 is fine */
415 /* #define VMBUS_PORT_ID 11 */
417 /* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
418 static const uuid_le VMBUS_SERVICE_ID = {
420 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
421 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
428 /* We only support running on top of Hyper-V
429 * So at this point this really can only contain the Hyper-V ID
433 void *hypercall_page;
436 bool synic_initialized;
438 void *synic_message_page[NR_CPUS];
439 void *synic_event_page[NR_CPUS];
441 * Hypervisor's notion of virtual processor ID is different from
442 * Linux' notion of CPU ID. This information can only be retrieved
443 * in the context of the calling CPU. Setup a map for easy access
444 * to this information:
446 * vp_index[a] is the Hyper-V's processor ID corresponding to
449 u32 vp_index[NR_CPUS];
451 * Starting with win8, we can take channel interrupts on any CPU;
452 * we will manage the tasklet that handles events messages on a per CPU
455 struct tasklet_struct *event_dpc[NR_CPUS];
456 struct tasklet_struct *msg_dpc[NR_CPUS];
458 * To optimize the mapping of relid to channel, maintain
459 * per-cpu list of the channels based on their CPU affinity.
461 struct list_head percpu_list[NR_CPUS];
463 * buffer to post messages to the host.
465 void *post_msg_page[NR_CPUS];
467 * Support PV clockevent device.
469 struct clock_event_device *clk_evt[NR_CPUS];
471 * To manage allocations in a NUMA node.
472 * Array indexed by numa node ID.
474 struct cpumask *hv_numa_map;
477 extern struct hv_context hv_context;
479 struct ms_hyperv_tsc_page {
480 volatile u32 tsc_sequence;
482 volatile u64 tsc_scale;
483 volatile s64 tsc_offset;
487 struct hv_ring_buffer_debug_info {
488 u32 current_interrupt_mask;
489 u32 current_read_index;
490 u32 current_write_index;
491 u32 bytes_avail_toread;
492 u32 bytes_avail_towrite;
497 extern int hv_init(void);
499 extern void hv_cleanup(bool crash);
501 extern int hv_post_message(union hv_connection_id connection_id,
502 enum hv_message_type message_type,
503 void *payload, size_t payload_size);
505 extern int hv_synic_alloc(void);
507 extern void hv_synic_free(void);
509 extern void hv_synic_init(void *irqarg);
511 extern void hv_synic_cleanup(void *arg);
513 extern void hv_synic_clockevents_cleanup(void);
516 * Host version information.
518 extern unsigned int host_info_eax;
519 extern unsigned int host_info_ebx;
520 extern unsigned int host_info_ecx;
521 extern unsigned int host_info_edx;
526 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info,
527 struct page *pages, u32 pagecnt);
529 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
531 int hv_ringbuffer_write(struct vmbus_channel *channel,
532 struct kvec *kv_list,
533 u32 kv_count, bool lock,
536 int hv_ringbuffer_read(struct vmbus_channel *channel,
537 void *buffer, u32 buflen, u32 *buffer_actual_len,
538 u64 *requestid, bool raw);
540 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
541 struct hv_ring_buffer_debug_info *debug_info);
543 void hv_begin_read(struct hv_ring_buffer_info *rbi);
545 u32 hv_end_read(struct hv_ring_buffer_info *rbi);
548 * Maximum channels is determined by the size of the interrupt page
549 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
550 * and the other is receive endpoint interrupt
552 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
554 /* The value here must be in multiple of 32 */
555 /* TODO: Need to make this configurable */
556 #define MAX_NUM_CHANNELS_SUPPORTED 256
559 enum vmbus_connect_state {
566 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
568 struct vmbus_connection {
569 enum vmbus_connect_state conn_state;
571 atomic_t next_gpadl_handle;
573 struct completion unload_event;
575 * Represents channel interrupts. Each bit position represents a
576 * channel. When a channel sends an interrupt via VMBUS, it finds its
577 * bit in the sendInterruptPage, set it and calls Hv to generate a port
578 * event. The other end receives the port event and parse the
579 * recvInterruptPage to see which bit is set
586 * 2 pages - 1st page for parent->child notification and 2nd
587 * is child->parent notification
589 struct hv_monitor_page *monitor_pages[2];
590 struct list_head chn_msg_list;
591 spinlock_t channelmsg_lock;
593 /* List of channels */
594 struct list_head chn_list;
595 struct mutex channel_mutex;
597 struct workqueue_struct *work_queue;
601 struct vmbus_msginfo {
602 /* Bookkeeping stuff */
603 struct list_head msglist_entry;
605 /* The message itself */
606 unsigned char msg[0];
610 extern struct vmbus_connection vmbus_connection;
612 enum vmbus_message_handler_type {
613 /* The related handler can sleep. */
616 /* The related handler must NOT sleep. */
617 VMHT_NON_BLOCKING = 1,
620 struct vmbus_channel_message_table_entry {
621 enum vmbus_channel_message_type message_type;
622 enum vmbus_message_handler_type handler_type;
623 void (*message_handler)(struct vmbus_channel_message_header *msg);
626 extern struct vmbus_channel_message_table_entry
627 channel_message_table[CHANNELMSG_COUNT];
629 /* Free the message slot and signal end-of-message if required */
630 static inline void vmbus_signal_eom(struct hv_message *msg, u32 old_msg_type)
633 * On crash we're reading some other CPU's message page and we need
634 * to be careful: this other CPU may already had cleared the header
635 * and the host may already had delivered some other message there.
636 * In case we blindly write msg->header.message_type we're going
637 * to lose it. We can still lose a message of the same type but
638 * we count on the fact that there can only be one
639 * CHANNELMSG_UNLOAD_RESPONSE and we don't care about other messages
642 if (cmpxchg(&msg->header.message_type, old_msg_type,
643 HVMSG_NONE) != old_msg_type)
647 * Make sure the write to MessageType (ie set to
648 * HVMSG_NONE) happens before we read the
649 * MessagePending and EOMing. Otherwise, the EOMing
650 * will not deliver any more messages since there is
655 if (msg->header.message_flags.msg_pending) {
657 * This will cause message queue rescan to
658 * possibly deliver another msg from the
661 wrmsrl(HV_X64_MSR_EOM, 0);
665 /* General vmbus interface */
667 struct hv_device *vmbus_device_create(const uuid_le *type,
668 const uuid_le *instance,
669 struct vmbus_channel *channel);
671 int vmbus_device_register(struct hv_device *child_device_obj);
672 void vmbus_device_unregister(struct hv_device *device_obj);
675 /* VmbusChildDeviceDestroy( */
676 /* struct hv_device *); */
678 struct vmbus_channel *relid2channel(u32 relid);
680 void vmbus_free_channels(void);
682 /* Connection interface */
684 int vmbus_connect(void);
685 void vmbus_disconnect(void);
687 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep);
689 void vmbus_on_event(unsigned long data);
690 void vmbus_on_msg_dpc(unsigned long data);
692 int hv_kvp_init(struct hv_util_service *);
693 void hv_kvp_deinit(void);
694 void hv_kvp_onchannelcallback(void *);
696 int hv_vss_init(struct hv_util_service *);
697 void hv_vss_deinit(void);
698 void hv_vss_onchannelcallback(void *);
700 int hv_fcopy_init(struct hv_util_service *);
701 void hv_fcopy_deinit(void);
702 void hv_fcopy_onchannelcallback(void *);
703 void vmbus_initiate_unload(bool crash);
705 static inline void hv_poll_channel(struct vmbus_channel *channel,
711 smp_call_function_single(channel->target_cpu, cb, channel, true);
714 enum hvutil_device_state {
715 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
716 HVUTIL_READY, /* userspace is registered */
717 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
718 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
719 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
720 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
723 #endif /* _HYPERV_VMBUS_H */