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 * Timeout for services such as KVP and fcopy.
36 #define HV_UTIL_TIMEOUT 30
39 * Timeout for guest-host handshake for services.
41 #define HV_UTIL_NEGO_TIMEOUT 55
44 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
45 * is set by CPUID(HVCPUID_VERSION_FEATURES).
47 enum hv_cpuid_function
{
48 HVCPUID_VERSION_FEATURES
= 0x00000001,
49 HVCPUID_VENDOR_MAXFUNCTION
= 0x40000000,
50 HVCPUID_INTERFACE
= 0x40000001,
53 * The remaining functions depend on the value of
56 HVCPUID_VERSION
= 0x40000002,
57 HVCPUID_FEATURES
= 0x40000003,
58 HVCPUID_ENLIGHTENMENT_INFO
= 0x40000004,
59 HVCPUID_IMPLEMENTATION_LIMITS
= 0x40000005,
62 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE 0x400
64 #define HV_X64_MSR_CRASH_P0 0x40000100
65 #define HV_X64_MSR_CRASH_P1 0x40000101
66 #define HV_X64_MSR_CRASH_P2 0x40000102
67 #define HV_X64_MSR_CRASH_P3 0x40000103
68 #define HV_X64_MSR_CRASH_P4 0x40000104
69 #define HV_X64_MSR_CRASH_CTL 0x40000105
71 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
73 /* Define version of the synthetic interrupt controller. */
74 #define HV_SYNIC_VERSION (1)
76 #define HV_ANY_VP (0xFFFFFFFF)
78 /* Define synthetic interrupt controller flag constants. */
79 #define HV_EVENT_FLAGS_COUNT (256 * 8)
80 #define HV_EVENT_FLAGS_BYTE_COUNT (256)
81 #define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
83 /* Define invalid partition identifier. */
84 #define HV_PARTITION_ID_INVALID ((u64)0x0)
86 /* Define port type. */
93 /* Define port information structure. */
95 enum hv_port_type port_type
;
106 u16 base_flag_number
;
117 struct hv_connection_info
{
118 enum hv_port_type port_type
;
123 } message_connection_info
;
126 } event_connection_info
;
129 } monitor_connection_info
;
134 * Timer configuration register.
136 union hv_timer_config
{
149 /* Define the number of message buffers associated with each port. */
150 #define HV_PORT_MESSAGE_BUFFER_COUNT (16)
152 /* Define the synthetic interrupt controller event flags format. */
153 union hv_synic_event_flags
{
154 u8 flags8
[HV_EVENT_FLAGS_BYTE_COUNT
];
155 u32 flags32
[HV_EVENT_FLAGS_DWORD_COUNT
];
158 /* Define the synthetic interrupt flags page layout. */
159 struct hv_synic_event_flags_page
{
160 union hv_synic_event_flags sintevent_flags
[HV_SYNIC_SINT_COUNT
];
163 /* Define SynIC control register. */
164 union hv_synic_scontrol
{
172 /* Define synthetic interrupt source. */
173 union hv_synic_sint
{
184 /* Define the format of the SIMP register */
185 union hv_synic_simp
{
190 u64 base_simp_gpa
:52;
194 /* Define the format of the SIEFP register */
195 union hv_synic_siefp
{
200 u64 base_siefp_gpa
:52;
204 /* Definitions for the monitored notification facility */
205 union hv_monitor_trigger_group
{
213 struct hv_monitor_parameter
{
214 union hv_connection_id connectionid
;
219 union hv_monitor_trigger_state
{
228 /* struct hv_monitor_page Layout */
229 /* ------------------------------------------------------ */
230 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
231 /* | 8 | TriggerGroup[0] | */
232 /* | 10 | TriggerGroup[1] | */
233 /* | 18 | TriggerGroup[2] | */
234 /* | 20 | TriggerGroup[3] | */
235 /* | 28 | Rsvd2[0] | */
236 /* | 30 | Rsvd2[1] | */
237 /* | 38 | Rsvd2[2] | */
238 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
240 /* | 240 | Latency[0][0..3] | */
241 /* | 340 | Rsvz3[0] | */
242 /* | 440 | Parameter[0][0] | */
243 /* | 448 | Parameter[0][1] | */
245 /* | 840 | Rsvd4[0] | */
246 /* ------------------------------------------------------ */
247 struct hv_monitor_page
{
248 union hv_monitor_trigger_state trigger_state
;
251 union hv_monitor_trigger_group trigger_group
[4];
254 s32 next_checktime
[4][32];
259 struct hv_monitor_parameter parameter
[4][32];
264 /* Definition of the hv_post_message hypercall input structure. */
265 struct hv_input_post_message
{
266 union hv_connection_id connectionid
;
270 u64 payload
[HV_MESSAGE_PAYLOAD_QWORD_COUNT
];
274 * Versioning definitions used for guests reporting themselves to the
275 * hypervisor, and visa versa.
278 /* Version info reported by guest OS's */
279 enum hv_guest_os_vendor
{
280 HVGUESTOS_VENDOR_MICROSOFT
= 0x0001
283 enum hv_guest_os_microsoft_ids
{
284 HVGUESTOS_MICROSOFT_UNDEFINED
= 0x00,
285 HVGUESTOS_MICROSOFT_MSDOS
= 0x01,
286 HVGUESTOS_MICROSOFT_WINDOWS3X
= 0x02,
287 HVGUESTOS_MICROSOFT_WINDOWS9X
= 0x03,
288 HVGUESTOS_MICROSOFT_WINDOWSNT
= 0x04,
289 HVGUESTOS_MICROSOFT_WINDOWSCE
= 0x05
293 * Declare the MSR used to identify the guest OS.
295 #define HV_X64_MSR_GUEST_OS_ID 0x40000000
297 union hv_x64_msr_guest_os_id_contents
{
301 u64 service_version
:8; /* Service Pack, etc. */
304 u64 os_id
:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
305 u64 vendor_id
:16; /* enum hv_guest_os_vendor */
310 * Declare the MSR used to setup pages used to communicate with the hypervisor.
312 #define HV_X64_MSR_HYPERCALL 0x40000001
314 union hv_x64_msr_hypercall_contents
{
319 u64 guest_physical_address
:52;
325 VMBUS_MESSAGE_CONNECTION_ID
= 1,
326 VMBUS_MESSAGE_PORT_ID
= 1,
327 VMBUS_EVENT_CONNECTION_ID
= 2,
328 VMBUS_EVENT_PORT_ID
= 2,
329 VMBUS_MONITOR_CONNECTION_ID
= 3,
330 VMBUS_MONITOR_PORT_ID
= 3,
331 VMBUS_MESSAGE_SINT
= 2,
336 #define HV_PRESENT_BIT 0x80000000
339 * The guest OS needs to register the guest ID with the hypervisor.
340 * The guest ID is a 64 bit entity and the structure of this ID is
341 * specified in the Hyper-V specification:
343 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
345 * While the current guideline does not specify how Linux guest ID(s)
346 * need to be generated, our plan is to publish the guidelines for
347 * Linux and other guest operating systems that currently are hosted
348 * on Hyper-V. The implementation here conforms to this yet
349 * unpublished guidelines.
353 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
354 * 62:56 - Os Type; Linux is 0x100
355 * 55:48 - Distro specific identification
356 * 47:16 - Linux kernel version number
357 * 15:0 - Distro specific identification
362 #define HV_LINUX_VENDOR_ID 0x8100
365 * Generate the guest ID based on the guideline described above.
368 static inline __u64
generate_guest_id(__u8 d_info1
, __u32 kernel_version
,
373 guest_id
= (((__u64
)HV_LINUX_VENDOR_ID
) << 48);
374 guest_id
|= (((__u64
)(d_info1
)) << 48);
375 guest_id
|= (((__u64
)(kernel_version
)) << 16);
376 guest_id
|= ((__u64
)(d_info2
));
382 #define HV_CPU_POWER_MANAGEMENT (1 << 0)
383 #define HV_RECOMMENDATIONS_MAX 4
386 #define HV_CAPS_MAX 8
389 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
392 /* Service definitions */
394 #define HV_SERVICE_PARENT_PORT (0)
395 #define HV_SERVICE_PARENT_CONNECTION (0)
397 #define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
398 #define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
399 #define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
400 #define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
402 #define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
403 #define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
404 #define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
405 #define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
406 #define HV_SERVICE_MAX_MESSAGE_ID (4)
408 #define HV_SERVICE_PROTOCOL_VERSION (0x0010)
409 #define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
411 /* #define VMBUS_REVISION_NUMBER 6 */
413 /* Our local vmbus's port and connection id. Anything >0 is fine */
414 /* #define VMBUS_PORT_ID 11 */
416 /* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
417 static const uuid_le VMBUS_SERVICE_ID
= {
419 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
420 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
427 /* We only support running on top of Hyper-V
428 * So at this point this really can only contain the Hyper-V ID
432 void *hypercall_page
;
435 bool synic_initialized
;
437 void *synic_message_page
[NR_CPUS
];
438 void *synic_event_page
[NR_CPUS
];
440 * Hypervisor's notion of virtual processor ID is different from
441 * Linux' notion of CPU ID. This information can only be retrieved
442 * in the context of the calling CPU. Setup a map for easy access
443 * to this information:
445 * vp_index[a] is the Hyper-V's processor ID corresponding to
448 u32 vp_index
[NR_CPUS
];
450 * Starting with win8, we can take channel interrupts on any CPU;
451 * we will manage the tasklet that handles events messages on a per CPU
454 struct tasklet_struct
*event_dpc
[NR_CPUS
];
455 struct tasklet_struct
*msg_dpc
[NR_CPUS
];
457 * To optimize the mapping of relid to channel, maintain
458 * per-cpu list of the channels based on their CPU affinity.
460 struct list_head percpu_list
[NR_CPUS
];
462 * buffer to post messages to the host.
464 void *post_msg_page
[NR_CPUS
];
466 * Support PV clockevent device.
468 struct clock_event_device
*clk_evt
[NR_CPUS
];
470 * To manage allocations in a NUMA node.
471 * Array indexed by numa node ID.
473 struct cpumask
*hv_numa_map
;
476 extern struct hv_context hv_context
;
478 struct ms_hyperv_tsc_page
{
479 volatile u32 tsc_sequence
;
481 volatile u64 tsc_scale
;
482 volatile s64 tsc_offset
;
486 struct hv_ring_buffer_debug_info
{
487 u32 current_interrupt_mask
;
488 u32 current_read_index
;
489 u32 current_write_index
;
490 u32 bytes_avail_toread
;
491 u32 bytes_avail_towrite
;
496 extern int hv_init(void);
498 extern void hv_cleanup(bool crash
);
500 extern int hv_post_message(union hv_connection_id connection_id
,
501 enum hv_message_type message_type
,
502 void *payload
, size_t payload_size
);
504 extern int hv_synic_alloc(void);
506 extern void hv_synic_free(void);
508 extern void hv_synic_init(void *irqarg
);
510 extern void hv_synic_cleanup(void *arg
);
512 extern void hv_synic_clockevents_cleanup(void);
515 * Host version information.
517 extern unsigned int host_info_eax
;
518 extern unsigned int host_info_ebx
;
519 extern unsigned int host_info_ecx
;
520 extern unsigned int host_info_edx
;
525 int hv_ringbuffer_init(struct hv_ring_buffer_info
*ring_info
,
526 struct page
*pages
, u32 pagecnt
);
528 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info
*ring_info
);
530 int hv_ringbuffer_write(struct vmbus_channel
*channel
,
531 struct kvec
*kv_list
,
532 u32 kv_count
, bool lock
,
535 int hv_ringbuffer_read(struct vmbus_channel
*channel
,
536 void *buffer
, u32 buflen
, u32
*buffer_actual_len
,
537 u64
*requestid
, bool raw
);
539 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info
*ring_info
,
540 struct hv_ring_buffer_debug_info
*debug_info
);
542 void hv_begin_read(struct hv_ring_buffer_info
*rbi
);
544 u32
hv_end_read(struct hv_ring_buffer_info
*rbi
);
547 * Maximum channels is determined by the size of the interrupt page
548 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
549 * and the other is receive endpoint interrupt
551 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
553 /* The value here must be in multiple of 32 */
554 /* TODO: Need to make this configurable */
555 #define MAX_NUM_CHANNELS_SUPPORTED 256
558 enum vmbus_connect_state
{
565 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
567 struct vmbus_connection
{
568 enum vmbus_connect_state conn_state
;
570 atomic_t next_gpadl_handle
;
572 struct completion unload_event
;
574 * Represents channel interrupts. Each bit position represents a
575 * channel. When a channel sends an interrupt via VMBUS, it finds its
576 * bit in the sendInterruptPage, set it and calls Hv to generate a port
577 * event. The other end receives the port event and parse the
578 * recvInterruptPage to see which bit is set
585 * 2 pages - 1st page for parent->child notification and 2nd
586 * is child->parent notification
588 struct hv_monitor_page
*monitor_pages
[2];
589 struct list_head chn_msg_list
;
590 spinlock_t channelmsg_lock
;
592 /* List of channels */
593 struct list_head chn_list
;
594 struct mutex channel_mutex
;
596 struct workqueue_struct
*work_queue
;
600 struct vmbus_msginfo
{
601 /* Bookkeeping stuff */
602 struct list_head msglist_entry
;
604 /* The message itself */
605 unsigned char msg
[0];
609 extern struct vmbus_connection vmbus_connection
;
611 enum vmbus_message_handler_type
{
612 /* The related handler can sleep. */
615 /* The related handler must NOT sleep. */
616 VMHT_NON_BLOCKING
= 1,
619 struct vmbus_channel_message_table_entry
{
620 enum vmbus_channel_message_type message_type
;
621 enum vmbus_message_handler_type handler_type
;
622 void (*message_handler
)(struct vmbus_channel_message_header
*msg
);
625 extern struct vmbus_channel_message_table_entry
626 channel_message_table
[CHANNELMSG_COUNT
];
628 /* Free the message slot and signal end-of-message if required */
629 static inline void vmbus_signal_eom(struct hv_message
*msg
, u32 old_msg_type
)
632 * On crash we're reading some other CPU's message page and we need
633 * to be careful: this other CPU may already had cleared the header
634 * and the host may already had delivered some other message there.
635 * In case we blindly write msg->header.message_type we're going
636 * to lose it. We can still lose a message of the same type but
637 * we count on the fact that there can only be one
638 * CHANNELMSG_UNLOAD_RESPONSE and we don't care about other messages
641 if (cmpxchg(&msg
->header
.message_type
, old_msg_type
,
642 HVMSG_NONE
) != old_msg_type
)
646 * Make sure the write to MessageType (ie set to
647 * HVMSG_NONE) happens before we read the
648 * MessagePending and EOMing. Otherwise, the EOMing
649 * will not deliver any more messages since there is
654 if (msg
->header
.message_flags
.msg_pending
) {
656 * This will cause message queue rescan to
657 * possibly deliver another msg from the
660 wrmsrl(HV_X64_MSR_EOM
, 0);
664 /* General vmbus interface */
666 struct hv_device
*vmbus_device_create(const uuid_le
*type
,
667 const uuid_le
*instance
,
668 struct vmbus_channel
*channel
);
670 int vmbus_device_register(struct hv_device
*child_device_obj
);
671 void vmbus_device_unregister(struct hv_device
*device_obj
);
674 /* VmbusChildDeviceDestroy( */
675 /* struct hv_device *); */
677 struct vmbus_channel
*relid2channel(u32 relid
);
679 void vmbus_free_channels(void);
681 /* Connection interface */
683 int vmbus_connect(void);
684 void vmbus_disconnect(void);
686 int vmbus_post_msg(void *buffer
, size_t buflen
);
688 void vmbus_on_event(unsigned long data
);
689 void vmbus_on_msg_dpc(unsigned long data
);
691 int hv_kvp_init(struct hv_util_service
*);
692 void hv_kvp_deinit(void);
693 void hv_kvp_onchannelcallback(void *);
695 int hv_vss_init(struct hv_util_service
*);
696 void hv_vss_deinit(void);
697 void hv_vss_onchannelcallback(void *);
699 int hv_fcopy_init(struct hv_util_service
*);
700 void hv_fcopy_deinit(void);
701 void hv_fcopy_onchannelcallback(void *);
702 void vmbus_initiate_unload(bool crash
);
704 static inline void hv_poll_channel(struct vmbus_channel
*channel
,
710 smp_call_function_single(channel
->target_cpu
, cb
, channel
, true);
713 enum hvutil_device_state
{
714 HVUTIL_DEVICE_INIT
= 0, /* driver is loaded, waiting for userspace */
715 HVUTIL_READY
, /* userspace is registered */
716 HVUTIL_HOSTMSG_RECEIVED
, /* message from the host was received */
717 HVUTIL_USERSPACE_REQ
, /* request to userspace was sent */
718 HVUTIL_USERSPACE_RECV
, /* reply from userspace was received */
719 HVUTIL_DEVICE_DYING
, /* driver unload is in progress */
722 #endif /* _HYPERV_VMBUS_H */