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.
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 * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
40 * is set by CPUID(HVCPUID_VERSION_FEATURES).
42 enum hv_cpuid_function {
43 HVCPUID_VERSION_FEATURES = 0x00000001,
44 HVCPUID_VENDOR_MAXFUNCTION = 0x40000000,
45 HVCPUID_INTERFACE = 0x40000001,
48 * The remaining functions depend on the value of
51 HVCPUID_VERSION = 0x40000002,
52 HVCPUID_FEATURES = 0x40000003,
53 HVCPUID_ENLIGHTENMENT_INFO = 0x40000004,
54 HVCPUID_IMPLEMENTATION_LIMITS = 0x40000005,
57 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE 0x400
59 #define HV_X64_MSR_CRASH_P0 0x40000100
60 #define HV_X64_MSR_CRASH_P1 0x40000101
61 #define HV_X64_MSR_CRASH_P2 0x40000102
62 #define HV_X64_MSR_CRASH_P3 0x40000103
63 #define HV_X64_MSR_CRASH_P4 0x40000104
64 #define HV_X64_MSR_CRASH_CTL 0x40000105
66 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
68 /* Define version of the synthetic interrupt controller. */
69 #define HV_SYNIC_VERSION (1)
71 #define HV_ANY_VP (0xFFFFFFFF)
73 /* Define synthetic interrupt controller flag constants. */
74 #define HV_EVENT_FLAGS_COUNT (256 * 8)
75 #define HV_EVENT_FLAGS_BYTE_COUNT (256)
76 #define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
78 /* Define invalid partition identifier. */
79 #define HV_PARTITION_ID_INVALID ((u64)0x0)
81 /* Define port type. */
88 /* Define port information structure. */
90 enum hv_port_type port_type;
101 u16 base_flag_number;
112 struct hv_connection_info {
113 enum hv_port_type port_type;
118 } message_connection_info;
121 } event_connection_info;
124 } monitor_connection_info;
129 * Timer configuration register.
131 union hv_timer_config {
144 /* Define the number of message buffers associated with each port. */
145 #define HV_PORT_MESSAGE_BUFFER_COUNT (16)
147 /* Define the synthetic interrupt controller event flags format. */
148 union hv_synic_event_flags {
149 u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
150 u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
153 /* Define the synthetic interrupt flags page layout. */
154 struct hv_synic_event_flags_page {
155 union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
158 /* Define SynIC control register. */
159 union hv_synic_scontrol {
167 /* Define synthetic interrupt source. */
168 union hv_synic_sint {
179 /* Define the format of the SIMP register */
180 union hv_synic_simp {
185 u64 base_simp_gpa:52;
189 /* Define the format of the SIEFP register */
190 union hv_synic_siefp {
195 u64 base_siefp_gpa:52;
199 /* Definitions for the monitored notification facility */
200 union hv_monitor_trigger_group {
208 struct hv_monitor_parameter {
209 union hv_connection_id connectionid;
214 union hv_monitor_trigger_state {
223 /* struct hv_monitor_page Layout */
224 /* ------------------------------------------------------ */
225 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
226 /* | 8 | TriggerGroup[0] | */
227 /* | 10 | TriggerGroup[1] | */
228 /* | 18 | TriggerGroup[2] | */
229 /* | 20 | TriggerGroup[3] | */
230 /* | 28 | Rsvd2[0] | */
231 /* | 30 | Rsvd2[1] | */
232 /* | 38 | Rsvd2[2] | */
233 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
235 /* | 240 | Latency[0][0..3] | */
236 /* | 340 | Rsvz3[0] | */
237 /* | 440 | Parameter[0][0] | */
238 /* | 448 | Parameter[0][1] | */
240 /* | 840 | Rsvd4[0] | */
241 /* ------------------------------------------------------ */
242 struct hv_monitor_page {
243 union hv_monitor_trigger_state trigger_state;
246 union hv_monitor_trigger_group trigger_group[4];
249 s32 next_checktime[4][32];
254 struct hv_monitor_parameter parameter[4][32];
259 /* Declare the various hypercall operations. */
261 HVCALL_POST_MESSAGE = 0x005c,
262 HVCALL_SIGNAL_EVENT = 0x005d,
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 on a per CPU
455 struct tasklet_struct *event_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(void);
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_signal_event(void *con_id);
506 extern int hv_synic_alloc(void);
508 extern void hv_synic_free(void);
510 extern void hv_synic_init(void *irqarg);
512 extern void hv_synic_cleanup(void *arg);
514 extern void hv_synic_clockevents_cleanup(void);
517 * Host version information.
519 extern unsigned int host_info_eax;
520 extern unsigned int host_info_ebx;
521 extern unsigned int host_info_ecx;
522 extern unsigned int host_info_edx;
527 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, void *buffer,
530 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
532 int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
533 struct kvec *kv_list,
534 u32 kv_count, bool *signal);
536 int hv_ringbuffer_read(struct hv_ring_buffer_info *inring_info,
537 void *buffer, u32 buflen, u32 *buffer_actual_len,
538 u64 *requestid, bool *signal, 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 /* General vmbus interface */
631 struct hv_device *vmbus_device_create(const uuid_le *type,
632 const uuid_le *instance,
633 struct vmbus_channel *channel);
635 int vmbus_device_register(struct hv_device *child_device_obj);
636 void vmbus_device_unregister(struct hv_device *device_obj);
639 /* VmbusChildDeviceDestroy( */
640 /* struct hv_device *); */
642 struct vmbus_channel *relid2channel(u32 relid);
644 void vmbus_free_channels(void);
646 /* Connection interface */
648 int vmbus_connect(void);
649 void vmbus_disconnect(void);
651 int vmbus_post_msg(void *buffer, size_t buflen);
653 int vmbus_set_event(struct vmbus_channel *channel);
655 void vmbus_on_event(unsigned long data);
657 int hv_kvp_init(struct hv_util_service *);
658 void hv_kvp_deinit(void);
659 void hv_kvp_onchannelcallback(void *);
661 int hv_vss_init(struct hv_util_service *);
662 void hv_vss_deinit(void);
663 void hv_vss_onchannelcallback(void *);
665 int hv_fcopy_init(struct hv_util_service *);
666 void hv_fcopy_deinit(void);
667 void hv_fcopy_onchannelcallback(void *);
668 void vmbus_initiate_unload(void);
670 static inline void hv_poll_channel(struct vmbus_channel *channel,
676 smp_call_function_single(channel->target_cpu, cb, channel, true);
679 enum hvutil_device_state {
680 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */
681 HVUTIL_READY, /* userspace is registered */
682 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */
683 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */
684 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */
685 HVUTIL_DEVICE_DYING, /* driver unload is in progress */
688 #endif /* _HYPERV_VMBUS_H */