1 /* SPDX-License-Identifier: GPL-2.0 */
4 * This file contains definitions from Hyper-V Hypervisor Top-Level Functional
5 * Specification (TLFS):
6 * https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/tlfs
9 #ifndef _ASM_GENERIC_HYPERV_TLFS_H
10 #define _ASM_GENERIC_HYPERV_TLFS_H
12 #include <linux/types.h>
13 #include <linux/bits.h>
14 #include <linux/time64.h>
17 * While not explicitly listed in the TLFS, Hyper-V always runs with a page size
18 * of 4096. These definitions are used when communicating with Hyper-V using
19 * guest physical pages and guest physical page addresses, since the guest page
20 * size may not be 4096 on all architectures.
22 #define HV_HYP_PAGE_SHIFT 12
23 #define HV_HYP_PAGE_SIZE BIT(HV_HYP_PAGE_SHIFT)
24 #define HV_HYP_PAGE_MASK (~(HV_HYP_PAGE_SIZE - 1))
27 * Hyper-V provides two categories of flags relevant to guest VMs. The
28 * "Features" category indicates specific functionality that is available
29 * to guests on this particular instance of Hyper-V. The "Features"
30 * are presented in four groups, each of which is 32 bits. The group A
31 * and B definitions are common across architectures and are listed here.
32 * However, not all flags are relevant on all architectures.
34 * Groups C and D vary across architectures and are listed in the
35 * architecture specific portion of hyperv-tlfs.h. Some of these flags exist
36 * on multiple architectures, but the bit positions are different so they
37 * cannot appear in the generic portion of hyperv-tlfs.h.
39 * The "Enlightenments" category provides recommendations on whether to use
40 * specific enlightenments that are available. The Enlighenments are a single
41 * group of 32 bits, but they vary across architectures and are listed in
42 * the architecture specific portion of hyperv-tlfs.h.
49 /* VP Runtime register available */
50 #define HV_MSR_VP_RUNTIME_AVAILABLE BIT(0)
51 /* Partition Reference Counter available*/
52 #define HV_MSR_TIME_REF_COUNT_AVAILABLE BIT(1)
53 /* Basic SynIC register available */
54 #define HV_MSR_SYNIC_AVAILABLE BIT(2)
55 /* Synthetic Timer registers available */
56 #define HV_MSR_SYNTIMER_AVAILABLE BIT(3)
57 /* Virtual APIC assist and VP assist page registers available */
58 #define HV_MSR_APIC_ACCESS_AVAILABLE BIT(4)
59 /* Hypercall and Guest OS ID registers available*/
60 #define HV_MSR_HYPERCALL_AVAILABLE BIT(5)
61 /* Access virtual processor index register available*/
62 #define HV_MSR_VP_INDEX_AVAILABLE BIT(6)
63 /* Virtual system reset register available*/
64 #define HV_MSR_RESET_AVAILABLE BIT(7)
65 /* Access statistics page registers available */
66 #define HV_MSR_STAT_PAGES_AVAILABLE BIT(8)
67 /* Partition reference TSC register is available */
68 #define HV_MSR_REFERENCE_TSC_AVAILABLE BIT(9)
69 /* Partition Guest IDLE register is available */
70 #define HV_MSR_GUEST_IDLE_AVAILABLE BIT(10)
71 /* Partition local APIC and TSC frequency registers available */
72 #define HV_ACCESS_FREQUENCY_MSRS BIT(11)
73 /* AccessReenlightenmentControls privilege */
74 #define HV_ACCESS_REENLIGHTENMENT BIT(13)
75 /* AccessTscInvariantControls privilege */
76 #define HV_ACCESS_TSC_INVARIANT BIT(15)
81 #define HV_CREATE_PARTITIONS BIT(0)
82 #define HV_ACCESS_PARTITION_ID BIT(1)
83 #define HV_ACCESS_MEMORY_POOL BIT(2)
84 #define HV_ADJUST_MESSAGE_BUFFERS BIT(3)
85 #define HV_POST_MESSAGES BIT(4)
86 #define HV_SIGNAL_EVENTS BIT(5)
87 #define HV_CREATE_PORT BIT(6)
88 #define HV_CONNECT_PORT BIT(7)
89 #define HV_ACCESS_STATS BIT(8)
90 #define HV_DEBUGGING BIT(11)
91 #define HV_CPU_MANAGEMENT BIT(12)
92 #define HV_ENABLE_EXTENDED_HYPERCALLS BIT(20)
93 #define HV_ISOLATION BIT(22)
98 struct ms_hyperv_tsc_page {
99 volatile u32 tsc_sequence;
101 volatile u64 tsc_scale;
102 volatile s64 tsc_offset;
105 union hv_reference_tsc_msr {
115 * The guest OS needs to register the guest ID with the hypervisor.
116 * The guest ID is a 64 bit entity and the structure of this ID is
117 * specified in the Hyper-V specification:
119 * msdn.microsoft.com/en-us/library/windows/hardware/ff542653%28v=vs.85%29.aspx
121 * While the current guideline does not specify how Linux guest ID(s)
122 * need to be generated, our plan is to publish the guidelines for
123 * Linux and other guest operating systems that currently are hosted
124 * on Hyper-V. The implementation here conforms to this yet
125 * unpublished guidelines.
129 * 63 - Indicates if the OS is Open Source or not; 1 is Open Source
130 * 62:56 - Os Type; Linux is 0x100
131 * 55:48 - Distro specific identification
132 * 47:16 - Linux kernel version number
133 * 15:0 - Distro specific identification
138 #define HV_LINUX_VENDOR_ID 0x8100
141 * Crash notification flags.
143 #define HV_CRASH_CTL_CRASH_NOTIFY_MSG BIT_ULL(62)
144 #define HV_CRASH_CTL_CRASH_NOTIFY BIT_ULL(63)
146 /* Declare the various hypercall operations. */
147 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE 0x0002
148 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_LIST 0x0003
149 #define HVCALL_ENABLE_VP_VTL 0x000f
150 #define HVCALL_NOTIFY_LONG_SPIN_WAIT 0x0008
151 #define HVCALL_SEND_IPI 0x000b
152 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE_EX 0x0013
153 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_LIST_EX 0x0014
154 #define HVCALL_SEND_IPI_EX 0x0015
155 #define HVCALL_GET_PARTITION_ID 0x0046
156 #define HVCALL_DEPOSIT_MEMORY 0x0048
157 #define HVCALL_CREATE_VP 0x004e
158 #define HVCALL_GET_VP_REGISTERS 0x0050
159 #define HVCALL_SET_VP_REGISTERS 0x0051
160 #define HVCALL_POST_MESSAGE 0x005c
161 #define HVCALL_SIGNAL_EVENT 0x005d
162 #define HVCALL_POST_DEBUG_DATA 0x0069
163 #define HVCALL_RETRIEVE_DEBUG_DATA 0x006a
164 #define HVCALL_RESET_DEBUG_SESSION 0x006b
165 #define HVCALL_ADD_LOGICAL_PROCESSOR 0x0076
166 #define HVCALL_MAP_DEVICE_INTERRUPT 0x007c
167 #define HVCALL_UNMAP_DEVICE_INTERRUPT 0x007d
168 #define HVCALL_RETARGET_INTERRUPT 0x007e
169 #define HVCALL_START_VP 0x0099
170 #define HVCALL_GET_VP_ID_FROM_APIC_ID 0x009a
171 #define HVCALL_FLUSH_GUEST_PHYSICAL_ADDRESS_SPACE 0x00af
172 #define HVCALL_FLUSH_GUEST_PHYSICAL_ADDRESS_LIST 0x00b0
173 #define HVCALL_MODIFY_SPARSE_GPA_PAGE_HOST_VISIBILITY 0x00db
174 #define HVCALL_MMIO_READ 0x0106
175 #define HVCALL_MMIO_WRITE 0x0107
177 /* Extended hypercalls */
178 #define HV_EXT_CALL_QUERY_CAPABILITIES 0x8001
179 #define HV_EXT_CALL_MEMORY_HEAT_HINT 0x8003
181 #define HV_FLUSH_ALL_PROCESSORS BIT(0)
182 #define HV_FLUSH_ALL_VIRTUAL_ADDRESS_SPACES BIT(1)
183 #define HV_FLUSH_NON_GLOBAL_MAPPINGS_ONLY BIT(2)
184 #define HV_FLUSH_USE_EXTENDED_RANGE_FORMAT BIT(3)
186 /* Extended capability bits */
187 #define HV_EXT_CAPABILITY_MEMORY_COLD_DISCARD_HINT BIT(8)
189 enum HV_GENERIC_SET_FORMAT {
190 HV_GENERIC_SET_SPARSE_4K,
194 #define HV_PARTITION_ID_SELF ((u64)-1)
195 #define HV_VP_INDEX_SELF ((u32)-2)
197 #define HV_HYPERCALL_RESULT_MASK GENMASK_ULL(15, 0)
198 #define HV_HYPERCALL_FAST_BIT BIT(16)
199 #define HV_HYPERCALL_VARHEAD_OFFSET 17
200 #define HV_HYPERCALL_VARHEAD_MASK GENMASK_ULL(26, 17)
201 #define HV_HYPERCALL_RSVD0_MASK GENMASK_ULL(31, 27)
202 #define HV_HYPERCALL_NESTED BIT_ULL(31)
203 #define HV_HYPERCALL_REP_COMP_OFFSET 32
204 #define HV_HYPERCALL_REP_COMP_1 BIT_ULL(32)
205 #define HV_HYPERCALL_REP_COMP_MASK GENMASK_ULL(43, 32)
206 #define HV_HYPERCALL_RSVD1_MASK GENMASK_ULL(47, 44)
207 #define HV_HYPERCALL_REP_START_OFFSET 48
208 #define HV_HYPERCALL_REP_START_MASK GENMASK_ULL(59, 48)
209 #define HV_HYPERCALL_RSVD2_MASK GENMASK_ULL(63, 60)
210 #define HV_HYPERCALL_RSVD_MASK (HV_HYPERCALL_RSVD0_MASK | \
211 HV_HYPERCALL_RSVD1_MASK | \
212 HV_HYPERCALL_RSVD2_MASK)
214 /* hypercall status code */
215 #define HV_STATUS_SUCCESS 0
216 #define HV_STATUS_INVALID_HYPERCALL_CODE 2
217 #define HV_STATUS_INVALID_HYPERCALL_INPUT 3
218 #define HV_STATUS_INVALID_ALIGNMENT 4
219 #define HV_STATUS_INVALID_PARAMETER 5
220 #define HV_STATUS_ACCESS_DENIED 6
221 #define HV_STATUS_OPERATION_DENIED 8
222 #define HV_STATUS_INSUFFICIENT_MEMORY 11
223 #define HV_STATUS_INVALID_PORT_ID 17
224 #define HV_STATUS_INVALID_CONNECTION_ID 18
225 #define HV_STATUS_INSUFFICIENT_BUFFERS 19
226 #define HV_STATUS_TIME_OUT 120
227 #define HV_STATUS_VTL_ALREADY_ENABLED 134
230 * The Hyper-V TimeRefCount register and the TSC
231 * page provide a guest VM clock with 100ns tick rate
233 #define HV_CLOCK_HZ (NSEC_PER_SEC/100)
235 /* Define the number of synthetic interrupt sources. */
236 #define HV_SYNIC_SINT_COUNT (16)
237 /* Define the expected SynIC version. */
238 #define HV_SYNIC_VERSION_1 (0x1)
239 /* Valid SynIC vectors are 16-255. */
240 #define HV_SYNIC_FIRST_VALID_VECTOR (16)
242 #define HV_SYNIC_CONTROL_ENABLE (1ULL << 0)
243 #define HV_SYNIC_SIMP_ENABLE (1ULL << 0)
244 #define HV_SYNIC_SIEFP_ENABLE (1ULL << 0)
245 #define HV_SYNIC_SINT_MASKED (1ULL << 16)
246 #define HV_SYNIC_SINT_AUTO_EOI (1ULL << 17)
247 #define HV_SYNIC_SINT_VECTOR_MASK (0xFF)
249 #define HV_SYNIC_STIMER_COUNT (4)
251 /* Define synthetic interrupt controller message constants. */
252 #define HV_MESSAGE_SIZE (256)
253 #define HV_MESSAGE_PAYLOAD_BYTE_COUNT (240)
254 #define HV_MESSAGE_PAYLOAD_QWORD_COUNT (30)
257 * Define hypervisor message types. Some of the message types
258 * are x86/x64 specific, but there's no good way to separate
259 * them out into the arch-specific version of hyperv-tlfs.h
260 * because C doesn't provide a way to extend enum types.
261 * Keeping them all in the arch neutral hyperv-tlfs.h seems
262 * the least messy compromise.
264 enum hv_message_type {
265 HVMSG_NONE = 0x00000000,
267 /* Memory access messages. */
268 HVMSG_UNMAPPED_GPA = 0x80000000,
269 HVMSG_GPA_INTERCEPT = 0x80000001,
271 /* Timer notification messages. */
272 HVMSG_TIMER_EXPIRED = 0x80000010,
274 /* Error messages. */
275 HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
276 HVMSG_UNRECOVERABLE_EXCEPTION = 0x80000021,
277 HVMSG_UNSUPPORTED_FEATURE = 0x80000022,
279 /* Trace buffer complete messages. */
280 HVMSG_EVENTLOG_BUFFERCOMPLETE = 0x80000040,
282 /* Platform-specific processor intercept messages. */
283 HVMSG_X64_IOPORT_INTERCEPT = 0x80010000,
284 HVMSG_X64_MSR_INTERCEPT = 0x80010001,
285 HVMSG_X64_CPUID_INTERCEPT = 0x80010002,
286 HVMSG_X64_EXCEPTION_INTERCEPT = 0x80010003,
287 HVMSG_X64_APIC_EOI = 0x80010004,
288 HVMSG_X64_LEGACY_FP_ERROR = 0x80010005
291 /* Define synthetic interrupt controller message flags. */
292 union hv_message_flags {
300 /* Define port identifier type. */
309 /* Define synthetic interrupt controller message header. */
310 struct hv_message_header {
313 union hv_message_flags message_flags;
317 union hv_port_id port;
321 /* Define synthetic interrupt controller message format. */
323 struct hv_message_header header;
325 __u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
329 /* Define the synthetic interrupt message page layout. */
330 struct hv_message_page {
331 struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
334 /* Define timer message payload structure. */
335 struct hv_timer_message_payload {
338 __u64 expiration_time; /* When the timer expired */
339 __u64 delivery_time; /* When the message was delivered */
343 /* Define synthetic interrupt controller flag constants. */
344 #define HV_EVENT_FLAGS_COUNT (256 * 8)
345 #define HV_EVENT_FLAGS_LONG_COUNT (256 / sizeof(unsigned long))
348 * Synthetic timer configuration.
350 union hv_stimer_config {
366 /* Define the synthetic interrupt controller event flags format. */
367 union hv_synic_event_flags {
368 unsigned long flags[HV_EVENT_FLAGS_LONG_COUNT];
371 /* Define SynIC control register. */
372 union hv_synic_scontrol {
380 /* Define synthetic interrupt source. */
381 union hv_synic_sint {
393 /* Define the format of the SIMP register */
394 union hv_synic_simp {
399 u64 base_simp_gpa:52;
403 /* Define the format of the SIEFP register */
404 union hv_synic_siefp {
409 u64 base_siefp_gpa:52;
419 /* The maximum number of sparse vCPU banks which can be encoded by 'struct hv_vpset' */
420 #define HV_MAX_SPARSE_VCPU_BANKS (64)
421 /* The number of vCPUs in one sparse bank */
422 #define HV_VCPUS_PER_SPARSE_BANK (64)
424 /* HvCallSendSyntheticClusterIpi hypercall */
431 /* HvCallSendSyntheticClusterIpiEx hypercall */
432 struct hv_send_ipi_ex {
435 struct hv_vpset vp_set;
438 /* HvFlushGuestPhysicalAddressSpace hypercalls */
439 struct hv_guest_mapping_flush {
445 * HV_MAX_FLUSH_PAGES = "additional_pages" + 1. It's limited
446 * by the bitwidth of "additional_pages" in union hv_gpa_page_range.
448 #define HV_MAX_FLUSH_PAGES (2048)
449 #define HV_GPA_PAGE_RANGE_PAGE_SIZE_2MB 0
450 #define HV_GPA_PAGE_RANGE_PAGE_SIZE_1GB 1
452 /* HvFlushGuestPhysicalAddressList, HvExtCallMemoryHeatHint hypercall */
453 union hv_gpa_page_range {
456 u64 additional_pages:11;
464 u64 base_large_pfn:43;
469 * All input flush parameters should be in single page. The max flush
470 * count is equal with how many entries of union hv_gpa_page_range can
471 * be populated into the input parameter page.
473 #define HV_MAX_FLUSH_REP_COUNT ((HV_HYP_PAGE_SIZE - 2 * sizeof(u64)) / \
474 sizeof(union hv_gpa_page_range))
476 struct hv_guest_mapping_flush_list {
479 union hv_gpa_page_range gpa_list[HV_MAX_FLUSH_REP_COUNT];
482 /* HvFlushVirtualAddressSpace, HvFlushVirtualAddressList hypercalls */
483 struct hv_tlb_flush {
490 /* HvFlushVirtualAddressSpaceEx, HvFlushVirtualAddressListEx hypercalls */
491 struct hv_tlb_flush_ex {
494 struct hv_vpset hv_vp_set;
498 /* HvGetPartitionId hypercall (output only) */
499 struct hv_get_partition_id {
503 /* HvDepositMemory hypercall */
504 struct hv_deposit_memory {
509 struct hv_proximity_domain_flags {
510 u32 proximity_preferred : 1;
512 u32 proximity_info_valid : 1;
515 /* Not a union in windows but useful for zeroing */
516 union hv_proximity_domain_info {
519 struct hv_proximity_domain_flags flags;
524 struct hv_lp_startup_status {
534 /* HvAddLogicalProcessor hypercall */
535 struct hv_add_logical_processor_in {
538 union hv_proximity_domain_info proximity_domain_info;
542 struct hv_add_logical_processor_out {
543 struct hv_lp_startup_status startup_status;
550 HvSubnodeAmdNode = 2,
553 HvSubnodeInvalid = -1
556 /* HvCreateVp hypercall */
557 struct hv_create_vp {
563 union hv_proximity_domain_info proximity_domain_info;
567 enum hv_interrupt_source {
568 HV_INTERRUPT_SOURCE_MSI = 1, /* MSI and MSI-X */
569 HV_INTERRUPT_SOURCE_IOAPIC,
572 union hv_ioapic_rte {
578 u32 destination_mode:1;
579 u32 delivery_status:1;
580 u32 interrupt_polarity:1;
583 u32 interrupt_mask:1;
587 u32 destination_id:8;
596 struct hv_interrupt_entry {
600 union hv_msi_entry msi_entry;
601 union hv_ioapic_rte ioapic_rte;
606 * flags for hv_device_interrupt_target.flags
608 #define HV_DEVICE_INTERRUPT_TARGET_MULTICAST 1
609 #define HV_DEVICE_INTERRUPT_TARGET_PROCESSOR_SET 2
611 struct hv_device_interrupt_target {
616 struct hv_vpset vp_set;
620 struct hv_retarget_device_interrupt {
621 u64 partition_id; /* use "self" */
623 struct hv_interrupt_entry int_entry;
625 struct hv_device_interrupt_target int_target;
626 } __packed __aligned(8);
629 /* HvGetVpRegisters hypercall input with variable size reg name list*/
630 struct hv_get_vp_registers_input {
644 /* HvGetVpRegisters returns an array of these output elements */
645 struct hv_get_vp_registers_output {
660 /* HvSetVpRegisters hypercall with variable size reg name/value list*/
661 struct hv_set_vp_registers_input {
677 enum hv_device_type {
678 HV_DEVICE_TYPE_LOGICAL = 0,
679 HV_DEVICE_TYPE_PCI = 1,
680 HV_DEVICE_TYPE_IOAPIC = 2,
681 HV_DEVICE_TYPE_ACPI = 3,
684 typedef u16 hv_pci_rid;
685 typedef u16 hv_pci_segment;
686 typedef u64 hv_logical_device_id;
697 union hv_pci_bus_range {
714 /* HV_DEVICE_TYPE_LOGICAL */
720 /* HV_DEVICE_TYPE_PCI */
724 union hv_pci_bdf bdf;
727 hv_pci_segment segment;
728 union hv_pci_bus_range shadow_bus_range;
730 u16 phantom_function_bits:2;
737 /* HV_DEVICE_TYPE_IOAPIC */
748 /* HV_DEVICE_TYPE_ACPI */
750 u32 input_mapping_base;
751 u32 input_mapping_count:30;
756 enum hv_interrupt_trigger_mode {
757 HV_INTERRUPT_TRIGGER_MODE_EDGE = 0,
758 HV_INTERRUPT_TRIGGER_MODE_LEVEL = 1,
761 struct hv_device_interrupt_descriptor {
766 struct hv_device_interrupt_target target;
769 struct hv_input_map_device_interrupt {
773 struct hv_interrupt_entry logical_interrupt_entry;
774 struct hv_device_interrupt_descriptor interrupt_descriptor;
777 struct hv_output_map_device_interrupt {
778 struct hv_interrupt_entry interrupt_entry;
781 struct hv_input_unmap_device_interrupt {
784 struct hv_interrupt_entry interrupt_entry;
787 #define HV_SOURCE_SHADOW_NONE 0x0
788 #define HV_SOURCE_SHADOW_BRIDGE_BUS_RANGE 0x1
791 * The whole argument should fit in a page to be able to pass to the hypervisor
794 #define HV_MEMORY_HINT_MAX_GPA_PAGE_RANGES \
795 ((HV_HYP_PAGE_SIZE - sizeof(struct hv_memory_hint)) / \
796 sizeof(union hv_gpa_page_range))
798 /* HvExtCallMemoryHeatHint hypercall */
799 #define HV_EXT_MEMORY_HEAT_HINT_TYPE_COLD_DISCARD 2
800 struct hv_memory_hint {
803 union hv_gpa_page_range ranges[];
806 /* Data structures for HVCALL_MMIO_READ and HVCALL_MMIO_WRITE */
807 #define HV_HYPERCALL_MMIO_MAX_DATA_LENGTH 64
809 struct hv_mmio_read_input {
815 struct hv_mmio_read_output {
816 u8 data[HV_HYPERCALL_MMIO_MAX_DATA_LENGTH];
819 struct hv_mmio_write_input {
823 u8 data[HV_HYPERCALL_MMIO_MAX_DATA_LENGTH];