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 version of the synthetic interrupt controller. */
53 #define HV_SYNIC_VERSION (1)
55 /* Define the expected SynIC version. */
56 #define HV_SYNIC_VERSION_1 (0x1)
58 /* Define synthetic interrupt controller message constants. */
59 #define HV_MESSAGE_SIZE (256)
60 #define HV_MESSAGE_PAYLOAD_BYTE_COUNT (240)
61 #define HV_MESSAGE_PAYLOAD_QWORD_COUNT (30)
62 #define HV_ANY_VP (0xFFFFFFFF)
64 /* Define synthetic interrupt controller flag constants. */
65 #define HV_EVENT_FLAGS_COUNT (256 * 8)
66 #define HV_EVENT_FLAGS_BYTE_COUNT (256)
67 #define HV_EVENT_FLAGS_DWORD_COUNT (256 / sizeof(u32))
69 /* Define hypervisor message types. */
70 enum hv_message_type {
71 HVMSG_NONE = 0x00000000,
73 /* Memory access messages. */
74 HVMSG_UNMAPPED_GPA = 0x80000000,
75 HVMSG_GPA_INTERCEPT = 0x80000001,
77 /* Timer notification messages. */
78 HVMSG_TIMER_EXPIRED = 0x80000010,
81 HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
82 HVMSG_UNRECOVERABLE_EXCEPTION = 0x80000021,
83 HVMSG_UNSUPPORTED_FEATURE = 0x80000022,
85 /* Trace buffer complete messages. */
86 HVMSG_EVENTLOG_BUFFERCOMPLETE = 0x80000040,
88 /* Platform-specific processor intercept messages. */
89 HVMSG_X64_IOPORT_INTERCEPT = 0x80010000,
90 HVMSG_X64_MSR_INTERCEPT = 0x80010001,
91 HVMSG_X64_CPUID_INTERCEPT = 0x80010002,
92 HVMSG_X64_EXCEPTION_INTERCEPT = 0x80010003,
93 HVMSG_X64_APIC_EOI = 0x80010004,
94 HVMSG_X64_LEGACY_FP_ERROR = 0x80010005
97 /* Define the number of synthetic interrupt sources. */
98 #define HV_SYNIC_SINT_COUNT (16)
99 #define HV_SYNIC_STIMER_COUNT (4)
101 /* Define invalid partition identifier. */
102 #define HV_PARTITION_ID_INVALID ((u64)0x0)
104 /* Define port identifier type. */
113 /* Define port type. */
120 /* Define port information structure. */
121 struct hv_port_info {
122 enum hv_port_type port_type;
133 u16 base_flag_bumber;
144 struct hv_connection_info {
145 enum hv_port_type port_type;
150 } message_connection_info;
153 } event_connection_info;
156 } monitor_connection_info;
160 /* Define synthetic interrupt controller message flags. */
161 union hv_message_flags {
169 /* Define synthetic interrupt controller message header. */
170 struct hv_message_header {
171 enum hv_message_type message_type;
173 union hv_message_flags message_flags;
177 union hv_port_id port;
181 /* Define timer message payload structure. */
182 struct hv_timer_message_payload {
185 u64 expiration_time; /* When the timer expired */
186 u64 delivery_time; /* When the message was delivered */
189 /* Define synthetic interrupt controller message format. */
191 struct hv_message_header header;
193 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
197 /* Define the number of message buffers associated with each port. */
198 #define HV_PORT_MESSAGE_BUFFER_COUNT (16)
200 /* Define the synthetic interrupt message page layout. */
201 struct hv_message_page {
202 struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
205 /* Define the synthetic interrupt controller event flags format. */
206 union hv_synic_event_flags {
207 u8 flags8[HV_EVENT_FLAGS_BYTE_COUNT];
208 u32 flags32[HV_EVENT_FLAGS_DWORD_COUNT];
211 /* Define the synthetic interrupt flags page layout. */
212 struct hv_synic_event_flags_page {
213 union hv_synic_event_flags sintevent_flags[HV_SYNIC_SINT_COUNT];
216 /* Define SynIC control register. */
217 union hv_synic_scontrol {
225 /* Define synthetic interrupt source. */
226 union hv_synic_sint {
237 /* Define the format of the SIMP register */
238 union hv_synic_simp {
243 u64 base_simp_gpa:52;
247 /* Define the format of the SIEFP register */
248 union hv_synic_siefp {
253 u64 base_siefp_gpa:52;
257 /* Definitions for the monitored notification facility */
258 union hv_monitor_trigger_group {
266 struct hv_monitor_parameter {
267 union hv_connection_id connectionid;
272 union hv_monitor_trigger_state {
281 /* struct hv_monitor_page Layout */
282 /* ------------------------------------------------------ */
283 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */
284 /* | 8 | TriggerGroup[0] | */
285 /* | 10 | TriggerGroup[1] | */
286 /* | 18 | TriggerGroup[2] | */
287 /* | 20 | TriggerGroup[3] | */
288 /* | 28 | Rsvd2[0] | */
289 /* | 30 | Rsvd2[1] | */
290 /* | 38 | Rsvd2[2] | */
291 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */
293 /* | 240 | Latency[0][0..3] | */
294 /* | 340 | Rsvz3[0] | */
295 /* | 440 | Parameter[0][0] | */
296 /* | 448 | Parameter[0][1] | */
298 /* | 840 | Rsvd4[0] | */
299 /* ------------------------------------------------------ */
300 struct hv_monitor_page {
301 union hv_monitor_trigger_state trigger_state;
304 union hv_monitor_trigger_group trigger_group[4];
307 s32 next_checktime[4][32];
312 struct hv_monitor_parameter parameter[4][32];
317 /* Declare the various hypercall operations. */
319 HVCALL_POST_MESSAGE = 0x005c,
320 HVCALL_SIGNAL_EVENT = 0x005d,
323 /* Definition of the hv_post_message hypercall input structure. */
324 struct hv_input_post_message {
325 union hv_connection_id connectionid;
327 enum hv_message_type message_type;
329 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
333 * Versioning definitions used for guests reporting themselves to the
334 * hypervisor, and visa versa.
337 /* Version info reported by guest OS's */
338 enum hv_guest_os_vendor {
339 HVGUESTOS_VENDOR_MICROSOFT = 0x0001
342 enum hv_guest_os_microsoft_ids {
343 HVGUESTOS_MICROSOFT_UNDEFINED = 0x00,
344 HVGUESTOS_MICROSOFT_MSDOS = 0x01,
345 HVGUESTOS_MICROSOFT_WINDOWS3X = 0x02,
346 HVGUESTOS_MICROSOFT_WINDOWS9X = 0x03,
347 HVGUESTOS_MICROSOFT_WINDOWSNT = 0x04,
348 HVGUESTOS_MICROSOFT_WINDOWSCE = 0x05
352 * Declare the MSR used to identify the guest OS.
354 #define HV_X64_MSR_GUEST_OS_ID 0x40000000
356 union hv_x64_msr_guest_os_id_contents {
360 u64 service_version:8; /* Service Pack, etc. */
363 u64 os_id:8; /* enum hv_guest_os_microsoft_ids (if Vendor=MS) */
364 u64 vendor_id:16; /* enum hv_guest_os_vendor */
369 * Declare the MSR used to setup pages used to communicate with the hypervisor.
371 #define HV_X64_MSR_HYPERCALL 0x40000001
373 union hv_x64_msr_hypercall_contents {
378 u64 guest_physical_address:52;
384 VMBUS_MESSAGE_CONNECTION_ID = 1,
385 VMBUS_MESSAGE_PORT_ID = 1,
386 VMBUS_EVENT_CONNECTION_ID = 2,
387 VMBUS_EVENT_PORT_ID = 2,
388 VMBUS_MONITOR_CONNECTION_ID = 3,
389 VMBUS_MONITOR_PORT_ID = 3,
390 VMBUS_MESSAGE_SINT = 2,
395 #define HV_PRESENT_BIT 0x80000000
398 * The guest OS needs to register the guest ID with the hypervisor.
399 * The guest ID is a 64 bit entity and the structure of this ID is
400 * specified in the Hyper-V specification:
402 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
404 * While the current guideline does not specify how Linux guest ID(s)
405 * need to be generated, our plan is to publish the guidelines for
406 * Linux and other guest operating systems that currently are hosted
407 * on Hyper-V. The implementation here conforms to this yet
408 * unpublished guidelines.
412 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
413 * 62:56 - Os Type; Linux is 0x100
414 * 55:48 - Distro specific identification
415 * 47:16 - Linux kernel version number
416 * 15:0 - Distro specific identification
421 #define HV_LINUX_VENDOR_ID 0x8100
424 * Generate the guest ID based on the guideline described above.
427 static inline __u64 generate_guest_id(__u8 d_info1, __u32 kernel_version,
432 guest_id = (((__u64)HV_LINUX_VENDOR_ID) << 48);
433 guest_id |= (((__u64)(d_info1)) << 48);
434 guest_id |= (((__u64)(kernel_version)) << 16);
435 guest_id |= ((__u64)(d_info2));
441 #define HV_CPU_POWER_MANAGEMENT (1 << 0)
442 #define HV_RECOMMENDATIONS_MAX 4
445 #define HV_CAPS_MAX 8
448 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64)
451 /* Service definitions */
453 #define HV_SERVICE_PARENT_PORT (0)
454 #define HV_SERVICE_PARENT_CONNECTION (0)
456 #define HV_SERVICE_CONNECT_RESPONSE_SUCCESS (0)
457 #define HV_SERVICE_CONNECT_RESPONSE_INVALID_PARAMETER (1)
458 #define HV_SERVICE_CONNECT_RESPONSE_UNKNOWN_SERVICE (2)
459 #define HV_SERVICE_CONNECT_RESPONSE_CONNECTION_REJECTED (3)
461 #define HV_SERVICE_CONNECT_REQUEST_MESSAGE_ID (1)
462 #define HV_SERVICE_CONNECT_RESPONSE_MESSAGE_ID (2)
463 #define HV_SERVICE_DISCONNECT_REQUEST_MESSAGE_ID (3)
464 #define HV_SERVICE_DISCONNECT_RESPONSE_MESSAGE_ID (4)
465 #define HV_SERVICE_MAX_MESSAGE_ID (4)
467 #define HV_SERVICE_PROTOCOL_VERSION (0x0010)
468 #define HV_CONNECT_PAYLOAD_BYTE_COUNT 64
470 /* #define VMBUS_REVISION_NUMBER 6 */
472 /* Our local vmbus's port and connection id. Anything >0 is fine */
473 /* #define VMBUS_PORT_ID 11 */
475 /* 628180B8-308D-4c5e-B7DB-1BEB62E62EF4 */
476 static const uuid_le VMBUS_SERVICE_ID = {
478 0xb8, 0x80, 0x81, 0x62, 0x8d, 0x30, 0x5e, 0x4c,
479 0xb7, 0xdb, 0x1b, 0xeb, 0x62, 0xe6, 0x2e, 0xf4
486 /* We only support running on top of Hyper-V
487 * So at this point this really can only contain the Hyper-V ID
491 void *hypercall_page;
493 bool synic_initialized;
495 void *synic_message_page[NR_CPUS];
496 void *synic_event_page[NR_CPUS];
498 * Hypervisor's notion of virtual processor ID is different from
499 * Linux' notion of CPU ID. This information can only be retrieved
500 * in the context of the calling CPU. Setup a map for easy access
501 * to this information:
503 * vp_index[a] is the Hyper-V's processor ID corresponding to
506 u32 vp_index[NR_CPUS];
508 * Starting with win8, we can take channel interrupts on any CPU;
509 * we will manage the tasklet that handles events on a per CPU
512 struct tasklet_struct *event_dpc[NR_CPUS];
515 extern struct hv_context hv_context;
520 extern int hv_init(void);
522 extern void hv_cleanup(void);
524 extern int hv_post_message(union hv_connection_id connection_id,
525 enum hv_message_type message_type,
526 void *payload, size_t payload_size);
528 extern u16 hv_signal_event(void *con_id);
530 extern int hv_synic_alloc(void);
532 extern void hv_synic_free(void);
534 extern void hv_synic_init(void *irqarg);
536 extern void hv_synic_cleanup(void *arg);
539 * Host version information.
541 extern unsigned int host_info_eax;
542 extern unsigned int host_info_ebx;
543 extern unsigned int host_info_ecx;
544 extern unsigned int host_info_edx;
549 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, void *buffer,
552 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info);
554 int hv_ringbuffer_write(struct hv_ring_buffer_info *ring_info,
555 struct scatterlist *sglist,
556 u32 sgcount, bool *signal);
558 int hv_ringbuffer_peek(struct hv_ring_buffer_info *ring_info, void *buffer,
561 int hv_ringbuffer_read(struct hv_ring_buffer_info *ring_info,
564 u32 offset, bool *signal);
567 void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info,
568 struct hv_ring_buffer_debug_info *debug_info);
570 void hv_begin_read(struct hv_ring_buffer_info *rbi);
572 u32 hv_end_read(struct hv_ring_buffer_info *rbi);
575 * Maximum channels is determined by the size of the interrupt page
576 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt
577 * and the other is receive endpoint interrupt
579 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */
581 /* The value here must be in multiple of 32 */
582 /* TODO: Need to make this configurable */
583 #define MAX_NUM_CHANNELS_SUPPORTED 256
586 enum vmbus_connect_state {
593 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT
595 struct vmbus_connection {
596 enum vmbus_connect_state conn_state;
598 atomic_t next_gpadl_handle;
601 * Represents channel interrupts. Each bit position represents a
602 * channel. When a channel sends an interrupt via VMBUS, it finds its
603 * bit in the sendInterruptPage, set it and calls Hv to generate a port
604 * event. The other end receives the port event and parse the
605 * recvInterruptPage to see which bit is set
612 * 2 pages - 1st page for parent->child notification and 2nd
613 * is child->parent notification
616 struct list_head chn_msg_list;
617 spinlock_t channelmsg_lock;
619 /* List of channels */
620 struct list_head chn_list;
621 spinlock_t channel_lock;
623 struct workqueue_struct *work_queue;
627 struct vmbus_msginfo {
628 /* Bookkeeping stuff */
629 struct list_head msglist_entry;
631 /* The message itself */
632 unsigned char msg[0];
636 extern struct vmbus_connection vmbus_connection;
638 /* General vmbus interface */
640 struct hv_device *vmbus_device_create(uuid_le *type,
642 struct vmbus_channel *channel);
644 int vmbus_device_register(struct hv_device *child_device_obj);
645 void vmbus_device_unregister(struct hv_device *device_obj);
648 /* VmbusChildDeviceDestroy( */
649 /* struct hv_device *); */
651 struct vmbus_channel *relid2channel(u32 relid);
653 void vmbus_free_channels(void);
655 /* Connection interface */
657 int vmbus_connect(void);
659 int vmbus_post_msg(void *buffer, size_t buflen);
661 int vmbus_set_event(struct vmbus_channel *channel);
663 void vmbus_on_event(unsigned long data);
666 #endif /* _HYPERV_VMBUS_H */