xref: /linux/include/hyperv/hvgdk_mini.h (revision 6802d8af47d1dccd9a74a1f708fb9129244ef843)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Type definitions for the Microsoft hypervisor.
4  */
5 #ifndef _HV_HVGDK_MINI_H
6 #define _HV_HVGDK_MINI_H
7 
8 #include <linux/types.h>
9 #include <linux/bits.h>
10 
11 struct hv_u128 {
12 	u64 low_part;
13 	u64 high_part;
14 } __packed;
15 
16 /* NOTE: when adding below, update hv_result_to_string() */
17 #define HV_STATUS_SUCCESS			    0x0
18 #define HV_STATUS_INVALID_HYPERCALL_CODE	    0x2
19 #define HV_STATUS_INVALID_HYPERCALL_INPUT	    0x3
20 #define HV_STATUS_INVALID_ALIGNMENT		    0x4
21 #define HV_STATUS_INVALID_PARAMETER		    0x5
22 #define HV_STATUS_ACCESS_DENIED			    0x6
23 #define HV_STATUS_INVALID_PARTITION_STATE	    0x7
24 #define HV_STATUS_OPERATION_DENIED		    0x8
25 #define HV_STATUS_UNKNOWN_PROPERTY		    0x9
26 #define HV_STATUS_PROPERTY_VALUE_OUT_OF_RANGE	    0xA
27 #define HV_STATUS_INSUFFICIENT_MEMORY		    0xB
28 #define HV_STATUS_INVALID_PARTITION_ID		    0xD
29 #define HV_STATUS_INVALID_VP_INDEX		    0xE
30 #define HV_STATUS_NOT_FOUND			    0x10
31 #define HV_STATUS_INVALID_PORT_ID		    0x11
32 #define HV_STATUS_INVALID_CONNECTION_ID		    0x12
33 #define HV_STATUS_INSUFFICIENT_BUFFERS		    0x13
34 #define HV_STATUS_NOT_ACKNOWLEDGED		    0x14
35 #define HV_STATUS_INVALID_VP_STATE		    0x15
36 #define HV_STATUS_NO_RESOURCES			    0x1D
37 #define HV_STATUS_PROCESSOR_FEATURE_NOT_SUPPORTED   0x20
38 #define HV_STATUS_INVALID_LP_INDEX		    0x41
39 #define HV_STATUS_INVALID_REGISTER_VALUE	    0x50
40 #define HV_STATUS_OPERATION_FAILED		    0x71
41 #define HV_STATUS_TIME_OUT			    0x78
42 #define HV_STATUS_CALL_PENDING			    0x79
43 #define HV_STATUS_VTL_ALREADY_ENABLED		    0x86
44 
45 /*
46  * The Hyper-V TimeRefCount register and the TSC
47  * page provide a guest VM clock with 100ns tick rate
48  */
49 #define HV_CLOCK_HZ (NSEC_PER_SEC / 100)
50 
51 #define HV_HYP_PAGE_SHIFT		12
52 #define HV_HYP_PAGE_SIZE		BIT(HV_HYP_PAGE_SHIFT)
53 #define HV_HYP_PAGE_MASK		(~(HV_HYP_PAGE_SIZE - 1))
54 #define HV_HYP_LARGE_PAGE_SHIFT		21
55 
56 #define HV_PARTITION_ID_INVALID		((u64)0)
57 #define HV_PARTITION_ID_SELF		((u64)-1)
58 
59 /* Hyper-V specific model specific registers (MSRs) */
60 
61 #if defined(CONFIG_X86)
62 /* HV_X64_SYNTHETIC_MSR */
63 #define HV_X64_MSR_GUEST_OS_ID			0x40000000
64 #define HV_X64_MSR_HYPERCALL			0x40000001
65 #define HV_X64_MSR_VP_INDEX			0x40000002
66 #define HV_X64_MSR_RESET			0x40000003
67 #define HV_X64_MSR_VP_RUNTIME			0x40000010
68 #define HV_X64_MSR_TIME_REF_COUNT		0x40000020
69 #define HV_X64_MSR_REFERENCE_TSC		0x40000021
70 #define HV_X64_MSR_TSC_FREQUENCY		0x40000022
71 #define HV_X64_MSR_APIC_FREQUENCY		0x40000023
72 
73 /* Define the virtual APIC registers */
74 #define HV_X64_MSR_EOI				0x40000070
75 #define HV_X64_MSR_ICR				0x40000071
76 #define HV_X64_MSR_TPR				0x40000072
77 #define HV_X64_MSR_VP_ASSIST_PAGE		0x40000073
78 
79 /* Define synthetic interrupt controller model specific registers. */
80 #define HV_X64_MSR_SCONTROL			0x40000080
81 #define HV_X64_MSR_SVERSION			0x40000081
82 #define HV_X64_MSR_SIEFP			0x40000082
83 #define HV_X64_MSR_SIMP				0x40000083
84 #define HV_X64_MSR_EOM				0x40000084
85 #define HV_X64_MSR_SIRBP			0x40000085
86 #define HV_X64_MSR_SINT0			0x40000090
87 #define HV_X64_MSR_SINT1			0x40000091
88 #define HV_X64_MSR_SINT2			0x40000092
89 #define HV_X64_MSR_SINT3			0x40000093
90 #define HV_X64_MSR_SINT4			0x40000094
91 #define HV_X64_MSR_SINT5			0x40000095
92 #define HV_X64_MSR_SINT6			0x40000096
93 #define HV_X64_MSR_SINT7			0x40000097
94 #define HV_X64_MSR_SINT8			0x40000098
95 #define HV_X64_MSR_SINT9			0x40000099
96 #define HV_X64_MSR_SINT10			0x4000009A
97 #define HV_X64_MSR_SINT11			0x4000009B
98 #define HV_X64_MSR_SINT12			0x4000009C
99 #define HV_X64_MSR_SINT13			0x4000009D
100 #define HV_X64_MSR_SINT14			0x4000009E
101 #define HV_X64_MSR_SINT15			0x4000009F
102 
103 /* Define synthetic interrupt controller model specific registers for nested hypervisor */
104 #define HV_X64_MSR_NESTED_SCONTROL		0x40001080
105 #define HV_X64_MSR_NESTED_SVERSION		0x40001081
106 #define HV_X64_MSR_NESTED_SIEFP			0x40001082
107 #define HV_X64_MSR_NESTED_SIMP			0x40001083
108 #define HV_X64_MSR_NESTED_EOM			0x40001084
109 #define HV_X64_MSR_NESTED_SINT0			0x40001090
110 
111 /*
112  * Synthetic Timer MSRs. Four timers per vcpu.
113  */
114 #define HV_X64_MSR_STIMER0_CONFIG		0x400000B0
115 #define HV_X64_MSR_STIMER0_COUNT		0x400000B1
116 #define HV_X64_MSR_STIMER1_CONFIG		0x400000B2
117 #define HV_X64_MSR_STIMER1_COUNT		0x400000B3
118 #define HV_X64_MSR_STIMER2_CONFIG		0x400000B4
119 #define HV_X64_MSR_STIMER2_COUNT		0x400000B5
120 #define HV_X64_MSR_STIMER3_CONFIG		0x400000B6
121 #define HV_X64_MSR_STIMER3_COUNT		0x400000B7
122 
123 /* Hyper-V guest idle MSR */
124 #define HV_X64_MSR_GUEST_IDLE			0x400000F0
125 
126 /* Hyper-V guest crash notification MSR's */
127 #define HV_X64_MSR_CRASH_P0			0x40000100
128 #define HV_X64_MSR_CRASH_P1			0x40000101
129 #define HV_X64_MSR_CRASH_P2			0x40000102
130 #define HV_X64_MSR_CRASH_P3			0x40000103
131 #define HV_X64_MSR_CRASH_P4			0x40000104
132 #define HV_X64_MSR_CRASH_CTL			0x40000105
133 
134 #define HV_X64_MSR_HYPERCALL_ENABLE		0x00000001
135 #define HV_X64_MSR_HYPERCALL_PAGE_ADDRESS_SHIFT	12
136 #define HV_X64_MSR_HYPERCALL_PAGE_ADDRESS_MASK	\
137 		(~((1ull << HV_X64_MSR_HYPERCALL_PAGE_ADDRESS_SHIFT) - 1))
138 
139 #define HV_X64_MSR_CRASH_PARAMS		\
140 		(1 + (HV_X64_MSR_CRASH_P4 - HV_X64_MSR_CRASH_P0))
141 
142 #define HV_IPI_LOW_VECTOR	 0x10
143 #define HV_IPI_HIGH_VECTOR	 0xff
144 
145 #define HV_X64_MSR_VP_ASSIST_PAGE_ENABLE	0x00000001
146 #define HV_X64_MSR_VP_ASSIST_PAGE_ADDRESS_SHIFT	12
147 #define HV_X64_MSR_VP_ASSIST_PAGE_ADDRESS_MASK	\
148 		(~((1ull << HV_X64_MSR_VP_ASSIST_PAGE_ADDRESS_SHIFT) - 1))
149 
150 /* Hyper-V Enlightened VMCS version mask in nested features CPUID */
151 #define HV_X64_ENLIGHTENED_VMCS_VERSION		0xff
152 
153 #define HV_X64_MSR_TSC_REFERENCE_ENABLE		0x00000001
154 #define HV_X64_MSR_TSC_REFERENCE_ADDRESS_SHIFT	12
155 
156 /* Number of XMM registers used in hypercall input/output */
157 #define HV_HYPERCALL_MAX_XMM_REGISTERS		6
158 
159 struct hv_reenlightenment_control {
160 	u64 vector : 8;
161 	u64 reserved1 : 8;
162 	u64 enabled : 1;
163 	u64 reserved2 : 15;
164 	u64 target_vp : 32;
165 }  __packed;
166 
167 struct hv_tsc_emulation_status {	 /* HV_TSC_EMULATION_STATUS */
168 	u64 inprogress : 1;
169 	u64 reserved : 63;
170 } __packed;
171 
172 struct hv_tsc_emulation_control {	 /* HV_TSC_INVARIANT_CONTROL */
173 	u64 enabled : 1;
174 	u64 reserved : 63;
175 } __packed;
176 
177 /* TSC emulation after migration */
178 #define HV_X64_MSR_REENLIGHTENMENT_CONTROL	0x40000106
179 #define HV_X64_MSR_TSC_EMULATION_CONTROL	0x40000107
180 #define HV_X64_MSR_TSC_EMULATION_STATUS		0x40000108
181 #define HV_X64_MSR_TSC_INVARIANT_CONTROL	0x40000118
182 #define HV_EXPOSE_INVARIANT_TSC		BIT_ULL(0)
183 
184 #endif /* CONFIG_X86 */
185 
186 struct hv_output_get_partition_id {
187 	u64 partition_id;
188 } __packed;
189 
190 /* HV_CRASH_CTL_REG_CONTENTS */
191 #define HV_CRASH_CTL_CRASH_NOTIFY_MSG		 BIT_ULL(62)
192 #define HV_CRASH_CTL_CRASH_NOTIFY		 BIT_ULL(63)
193 
194 union hv_reference_tsc_msr {
195 	u64 as_uint64;
196 	struct {
197 		u64 enable : 1;
198 		u64 reserved : 11;
199 		u64 pfn : 52;
200 	} __packed;
201 };
202 
203 /* The maximum number of sparse vCPU banks which can be encoded by 'struct hv_vpset' */
204 #define HV_MAX_SPARSE_VCPU_BANKS (64)
205 /* The number of vCPUs in one sparse bank */
206 #define HV_VCPUS_PER_SPARSE_BANK (64)
207 
208 /*
209  * Some of Hyper-V structs do not use hv_vpset where linux uses them.
210  *
211  * struct hv_vpset is usually used as part of hypercall input. The portion
212  * that counts as "fixed size input header" vs. "variable size input header"
213  * varies per hypercall. See comments at relevant hypercall call sites as to
214  * how the "valid_bank_mask" field should be accounted.
215  */
216 struct hv_vpset {	 /* HV_VP_SET */
217 	u64 format;
218 	u64 valid_bank_mask;
219 	u64 bank_contents[];
220 } __packed;
221 
222 /*
223  * Version info reported by hypervisor
224  * Changed to a union for convenience
225  */
226 union hv_hypervisor_version_info {
227 	struct {
228 		u32 build_number;
229 
230 		u32 minor_version : 16;
231 		u32 major_version : 16;
232 
233 		u32 service_pack;
234 
235 		u32 service_number : 24;
236 		u32 service_branch : 8;
237 	};
238 	struct {
239 		u32 eax;
240 		u32 ebx;
241 		u32 ecx;
242 		u32 edx;
243 	};
244 };
245 
246 /* HV_CPUID_FUNCTION */
247 #define HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS	0x40000000
248 #define HYPERV_CPUID_INTERFACE			0x40000001
249 #define HYPERV_CPUID_VERSION			0x40000002
250 #define HYPERV_CPUID_FEATURES			0x40000003
251 #define HYPERV_CPUID_ENLIGHTMENT_INFO		0x40000004
252 #define HYPERV_CPUID_IMPLEMENT_LIMITS		0x40000005
253 #define HYPERV_CPUID_CPU_MANAGEMENT_FEATURES	0x40000007
254 #define HYPERV_CPUID_NESTED_FEATURES		0x4000000A
255 #define HYPERV_CPUID_ISOLATION_CONFIG		0x4000000C
256 
257 #define HYPERV_CPUID_VIRT_STACK_INTERFACE	 0x40000081
258 #define HYPERV_VS_INTERFACE_EAX_SIGNATURE	 0x31235356  /* "VS#1" */
259 
260 #define HYPERV_CPUID_VIRT_STACK_PROPERTIES	 0x40000082
261 /* Support for the extended IOAPIC RTE format */
262 #define HYPERV_VS_PROPERTIES_EAX_EXTENDED_IOAPIC_RTE	 BIT(2)
263 #define HYPERV_VS_PROPERTIES_EAX_CONFIDENTIAL_VMBUS_AVAILABLE	 BIT(3)
264 
265 #define HYPERV_HYPERVISOR_PRESENT_BIT		 0x80000000
266 #define HYPERV_CPUID_MIN			 0x40000005
267 #define HYPERV_CPUID_MAX			 0x4000ffff
268 
269 /*
270  * HV_X64_HYPERVISOR_FEATURES (EAX), or
271  * HV_PARTITION_PRIVILEGE_MASK [31-0]
272  */
273 #define HV_MSR_VP_RUNTIME_AVAILABLE			BIT(0)
274 #define HV_MSR_TIME_REF_COUNT_AVAILABLE			BIT(1)
275 #define HV_MSR_SYNIC_AVAILABLE				BIT(2)
276 #define HV_MSR_SYNTIMER_AVAILABLE			BIT(3)
277 #define HV_MSR_APIC_ACCESS_AVAILABLE			BIT(4)
278 #define HV_MSR_HYPERCALL_AVAILABLE			BIT(5)
279 #define HV_MSR_VP_INDEX_AVAILABLE			BIT(6)
280 #define HV_MSR_RESET_AVAILABLE				BIT(7)
281 #define HV_MSR_STAT_PAGES_AVAILABLE			BIT(8)
282 #define HV_MSR_REFERENCE_TSC_AVAILABLE			BIT(9)
283 #define HV_MSR_GUEST_IDLE_AVAILABLE			BIT(10)
284 #define HV_ACCESS_FREQUENCY_MSRS			BIT(11)
285 #define HV_ACCESS_REENLIGHTENMENT			BIT(13)
286 #define HV_ACCESS_TSC_INVARIANT				BIT(15)
287 
288 /*
289  * HV_X64_HYPERVISOR_FEATURES (EBX), or
290  * HV_PARTITION_PRIVILEGE_MASK [63-32]
291  */
292 #define HV_CREATE_PARTITIONS				BIT(0)
293 #define HV_ACCESS_PARTITION_ID				BIT(1)
294 #define HV_ACCESS_MEMORY_POOL				BIT(2)
295 #define HV_ADJUST_MESSAGE_BUFFERS			BIT(3)
296 #define HV_POST_MESSAGES				BIT(4)
297 #define HV_SIGNAL_EVENTS				BIT(5)
298 #define HV_CREATE_PORT					BIT(6)
299 #define HV_CONNECT_PORT					BIT(7)
300 #define HV_ACCESS_STATS					BIT(8)
301 #define HV_DEBUGGING					BIT(11)
302 #define HV_CPU_MANAGEMENT				BIT(12)
303 #define HV_ENABLE_EXTENDED_HYPERCALLS			BIT(20)
304 #define HV_ISOLATION					BIT(22)
305 
306 #if defined(CONFIG_X86)
307 /* HV_X64_HYPERVISOR_FEATURES (EDX) */
308 #define HV_X64_MWAIT_AVAILABLE				BIT(0)
309 #define HV_X64_GUEST_DEBUGGING_AVAILABLE		BIT(1)
310 #define HV_X64_PERF_MONITOR_AVAILABLE			BIT(2)
311 #define HV_X64_CPU_DYNAMIC_PARTITIONING_AVAILABLE	BIT(3)
312 #define HV_X64_HYPERCALL_XMM_INPUT_AVAILABLE		BIT(4)
313 #define HV_X64_GUEST_IDLE_STATE_AVAILABLE		BIT(5)
314 #define HV_FEATURE_FREQUENCY_MSRS_AVAILABLE		BIT(8)
315 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE		BIT(10)
316 #define HV_FEATURE_DEBUG_MSRS_AVAILABLE			BIT(11)
317 #define HV_FEATURE_EXT_GVA_RANGES_FLUSH			BIT(14)
318 /*
319  * Support for returning hypercall output block via XMM
320  * registers is available
321  */
322 #define HV_X64_HYPERCALL_XMM_OUTPUT_AVAILABLE		BIT(15)
323 /* stimer Direct Mode is available */
324 #define HV_STIMER_DIRECT_MODE_AVAILABLE			BIT(19)
325 
326 /*
327  * Implementation recommendations. Indicates which behaviors the hypervisor
328  * recommends the OS implement for optimal performance.
329  * These are HYPERV_CPUID_ENLIGHTMENT_INFO.EAX bits.
330  */
331 /* HV_X64_ENLIGHTENMENT_INFORMATION */
332 #define HV_X64_AS_SWITCH_RECOMMENDED			BIT(0)
333 #define HV_X64_LOCAL_TLB_FLUSH_RECOMMENDED		BIT(1)
334 #define HV_X64_REMOTE_TLB_FLUSH_RECOMMENDED		BIT(2)
335 #define HV_X64_APIC_ACCESS_RECOMMENDED			BIT(3)
336 #define HV_X64_SYSTEM_RESET_RECOMMENDED			BIT(4)
337 #define HV_X64_RELAXED_TIMING_RECOMMENDED		BIT(5)
338 #define HV_DEPRECATING_AEOI_RECOMMENDED			BIT(9)
339 #define HV_X64_CLUSTER_IPI_RECOMMENDED			BIT(10)
340 #define HV_X64_EX_PROCESSOR_MASKS_RECOMMENDED		BIT(11)
341 #define HV_X64_HYPERV_NESTED				BIT(12)
342 #define HV_X64_ENLIGHTENED_VMCS_RECOMMENDED		BIT(14)
343 #define HV_X64_USE_MMIO_HYPERCALLS			BIT(21)
344 
345 /*
346  * CPU management features identification.
347  * These are HYPERV_CPUID_CPU_MANAGEMENT_FEATURES.EAX bits.
348  */
349 #define HV_X64_START_LOGICAL_PROCESSOR			BIT(0)
350 #define HV_X64_CREATE_ROOT_VIRTUAL_PROCESSOR		BIT(1)
351 #define HV_X64_PERFORMANCE_COUNTER_SYNC			BIT(2)
352 #define HV_X64_RESERVED_IDENTITY_BIT			BIT(31)
353 
354 /*
355  * Virtual processor will never share a physical core with another virtual
356  * processor, except for virtual processors that are reported as sibling SMT
357  * threads.
358  */
359 #define HV_X64_NO_NONARCH_CORESHARING			BIT(18)
360 
361 /* Nested features. These are HYPERV_CPUID_NESTED_FEATURES.EAX bits. */
362 #define HV_X64_NESTED_DIRECT_FLUSH			BIT(17)
363 #define HV_X64_NESTED_GUEST_MAPPING_FLUSH		BIT(18)
364 #define HV_X64_NESTED_MSR_BITMAP			BIT(19)
365 
366 /* Nested features #2. These are HYPERV_CPUID_NESTED_FEATURES.EBX bits. */
367 #define HV_X64_NESTED_EVMCS1_PERF_GLOBAL_CTRL		BIT(0)
368 
369 /*
370  * This is specific to AMD and specifies that enlightened TLB flush is
371  * supported. If guest opts in to this feature, ASID invalidations only
372  * flushes gva -> hpa mapping entries. To flush the TLB entries derived
373  * from NPT, hypercalls should be used (HvFlushGuestPhysicalAddressSpace
374  * or HvFlushGuestPhysicalAddressList).
375  */
376 #define HV_X64_NESTED_ENLIGHTENED_TLB			BIT(22)
377 
378 /* HYPERV_CPUID_ISOLATION_CONFIG.EAX bits. */
379 #define HV_PARAVISOR_PRESENT				BIT(0)
380 
381 /* HYPERV_CPUID_ISOLATION_CONFIG.EBX bits. */
382 #define HV_ISOLATION_TYPE				GENMASK(3, 0)
383 #define HV_SHARED_GPA_BOUNDARY_ACTIVE			BIT(5)
384 #define HV_SHARED_GPA_BOUNDARY_BITS			GENMASK(11, 6)
385 
386 /* HYPERV_CPUID_FEATURES.ECX bits. */
387 #define HV_VP_DISPATCH_INTERRUPT_INJECTION_AVAILABLE	BIT(9)
388 #define HV_VP_GHCB_ROOT_MAPPING_AVAILABLE		BIT(10)
389 
390 enum hv_isolation_type {
391 	HV_ISOLATION_TYPE_NONE	= 0,	/* HV_PARTITION_ISOLATION_TYPE_NONE */
392 	HV_ISOLATION_TYPE_VBS	= 1,
393 	HV_ISOLATION_TYPE_SNP	= 2,
394 	HV_ISOLATION_TYPE_TDX	= 3
395 };
396 
397 union hv_x64_msr_hypercall_contents {
398 	u64 as_uint64;
399 	struct {
400 		u64 enable : 1;
401 		u64 reserved : 11;
402 		u64 guest_physical_address : 52;
403 	} __packed;
404 };
405 #endif /* CONFIG_X86 */
406 
407 #if defined(CONFIG_ARM64)
408 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE	BIT(8)
409 #define HV_STIMER_DIRECT_MODE_AVAILABLE		BIT(13)
410 #endif /* CONFIG_ARM64 */
411 
412 #if defined(CONFIG_X86)
413 #define HV_MAXIMUM_PROCESSORS	    2048
414 #elif defined(CONFIG_ARM64) /* CONFIG_X86 */
415 #define HV_MAXIMUM_PROCESSORS	    320
416 #endif /* CONFIG_ARM64 */
417 
418 #define HV_MAX_VP_INDEX			(HV_MAXIMUM_PROCESSORS - 1)
419 #define HV_VP_INDEX_SELF		((u32)-2)
420 #define HV_ANY_VP			((u32)-1)
421 
422 union hv_vp_assist_msr_contents {	 /* HV_REGISTER_VP_ASSIST_PAGE */
423 	u64 as_uint64;
424 	struct {
425 		u64 enable : 1;
426 		u64 reserved : 11;
427 		u64 pfn : 52;
428 	} __packed;
429 };
430 
431 /* Declare the various hypercall operations. */
432 /* HV_CALL_CODE */
433 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE		0x0002
434 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_LIST		0x0003
435 #define HVCALL_NOTIFY_LONG_SPIN_WAIT			0x0008
436 #define HVCALL_SEND_IPI					0x000b
437 #define HVCALL_ENABLE_VP_VTL				0x000f
438 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE_EX		0x0013
439 #define HVCALL_FLUSH_VIRTUAL_ADDRESS_LIST_EX		0x0014
440 #define HVCALL_SEND_IPI_EX				0x0015
441 #define HVCALL_CREATE_PARTITION				0x0040
442 #define HVCALL_INITIALIZE_PARTITION			0x0041
443 #define HVCALL_FINALIZE_PARTITION			0x0042
444 #define HVCALL_DELETE_PARTITION				0x0043
445 #define HVCALL_GET_PARTITION_PROPERTY			0x0044
446 #define HVCALL_SET_PARTITION_PROPERTY			0x0045
447 #define HVCALL_GET_PARTITION_ID				0x0046
448 #define HVCALL_DEPOSIT_MEMORY				0x0048
449 #define HVCALL_WITHDRAW_MEMORY				0x0049
450 #define HVCALL_MAP_GPA_PAGES				0x004b
451 #define HVCALL_UNMAP_GPA_PAGES				0x004c
452 #define HVCALL_INSTALL_INTERCEPT			0x004d
453 #define HVCALL_CREATE_VP				0x004e
454 #define HVCALL_DELETE_VP				0x004f
455 #define HVCALL_GET_VP_REGISTERS				0x0050
456 #define HVCALL_SET_VP_REGISTERS				0x0051
457 #define HVCALL_TRANSLATE_VIRTUAL_ADDRESS		0x0052
458 #define HVCALL_CLEAR_VIRTUAL_INTERRUPT			0x0056
459 #define HVCALL_DELETE_PORT				0x0058
460 #define HVCALL_DISCONNECT_PORT				0x005b
461 #define HVCALL_POST_MESSAGE				0x005c
462 #define HVCALL_SIGNAL_EVENT				0x005d
463 #define HVCALL_POST_DEBUG_DATA				0x0069
464 #define HVCALL_RETRIEVE_DEBUG_DATA			0x006a
465 #define HVCALL_RESET_DEBUG_SESSION			0x006b
466 #define HVCALL_MAP_STATS_PAGE				0x006c
467 #define HVCALL_UNMAP_STATS_PAGE				0x006d
468 #define HVCALL_ADD_LOGICAL_PROCESSOR			0x0076
469 #define HVCALL_GET_SYSTEM_PROPERTY			0x007b
470 #define HVCALL_MAP_DEVICE_INTERRUPT			0x007c
471 #define HVCALL_UNMAP_DEVICE_INTERRUPT			0x007d
472 #define HVCALL_RETARGET_INTERRUPT			0x007e
473 #define HVCALL_NOTIFY_PORT_RING_EMPTY			0x008b
474 #define HVCALL_REGISTER_INTERCEPT_RESULT		0x0091
475 #define HVCALL_ASSERT_VIRTUAL_INTERRUPT			0x0094
476 #define HVCALL_CREATE_PORT				0x0095
477 #define HVCALL_CONNECT_PORT				0x0096
478 #define HVCALL_START_VP					0x0099
479 #define HVCALL_GET_VP_INDEX_FROM_APIC_ID			0x009a
480 #define HVCALL_FLUSH_GUEST_PHYSICAL_ADDRESS_SPACE	0x00af
481 #define HVCALL_FLUSH_GUEST_PHYSICAL_ADDRESS_LIST	0x00b0
482 #define HVCALL_SIGNAL_EVENT_DIRECT			0x00c0
483 #define HVCALL_POST_MESSAGE_DIRECT			0x00c1
484 #define HVCALL_DISPATCH_VP				0x00c2
485 #define HVCALL_GET_GPA_PAGES_ACCESS_STATES		0x00c9
486 #define HVCALL_ACQUIRE_SPARSE_SPA_PAGE_HOST_ACCESS	0x00d7
487 #define HVCALL_RELEASE_SPARSE_SPA_PAGE_HOST_ACCESS	0x00d8
488 #define HVCALL_MODIFY_SPARSE_GPA_PAGE_HOST_VISIBILITY	0x00db
489 #define HVCALL_MAP_VP_STATE_PAGE			0x00e1
490 #define HVCALL_UNMAP_VP_STATE_PAGE			0x00e2
491 #define HVCALL_GET_VP_STATE				0x00e3
492 #define HVCALL_SET_VP_STATE				0x00e4
493 #define HVCALL_GET_VP_CPUID_VALUES			0x00f4
494 #define HVCALL_MMIO_READ				0x0106
495 #define HVCALL_MMIO_WRITE				0x0107
496 
497 /* HV_HYPERCALL_INPUT */
498 #define HV_HYPERCALL_RESULT_MASK	GENMASK_ULL(15, 0)
499 #define HV_HYPERCALL_FAST_BIT		BIT(16)
500 #define HV_HYPERCALL_VARHEAD_OFFSET	17
501 #define HV_HYPERCALL_VARHEAD_MASK	GENMASK_ULL(26, 17)
502 #define HV_HYPERCALL_RSVD0_MASK		GENMASK_ULL(31, 27)
503 #define HV_HYPERCALL_NESTED		BIT_ULL(31)
504 #define HV_HYPERCALL_REP_COMP_OFFSET	32
505 #define HV_HYPERCALL_REP_COMP_1		BIT_ULL(32)
506 #define HV_HYPERCALL_REP_COMP_MASK	GENMASK_ULL(43, 32)
507 #define HV_HYPERCALL_RSVD1_MASK		GENMASK_ULL(47, 44)
508 #define HV_HYPERCALL_REP_START_OFFSET	48
509 #define HV_HYPERCALL_REP_START_MASK	GENMASK_ULL(59, 48)
510 #define HV_HYPERCALL_RSVD2_MASK		GENMASK_ULL(63, 60)
511 #define HV_HYPERCALL_RSVD_MASK		(HV_HYPERCALL_RSVD0_MASK | \
512 					 HV_HYPERCALL_RSVD1_MASK | \
513 					 HV_HYPERCALL_RSVD2_MASK)
514 
515 /* HvFlushGuestPhysicalAddressSpace hypercalls */
516 struct hv_guest_mapping_flush {
517 	u64 address_space;
518 	u64 flags;
519 } __packed;
520 
521 /*
522  *  HV_MAX_FLUSH_PAGES = "additional_pages" + 1. It's limited
523  *  by the bitwidth of "additional_pages" in union hv_gpa_page_range.
524  */
525 #define HV_MAX_FLUSH_PAGES (2048)
526 #define HV_GPA_PAGE_RANGE_PAGE_SIZE_2MB		0
527 #define HV_GPA_PAGE_RANGE_PAGE_SIZE_1GB		1
528 
529 #define HV_FLUSH_ALL_PROCESSORS			BIT(0)
530 #define HV_FLUSH_ALL_VIRTUAL_ADDRESS_SPACES	BIT(1)
531 #define HV_FLUSH_NON_GLOBAL_MAPPINGS_ONLY	BIT(2)
532 #define HV_FLUSH_USE_EXTENDED_RANGE_FORMAT	BIT(3)
533 
534 /* HvFlushGuestPhysicalAddressList, HvExtCallMemoryHeatHint hypercall */
535 union hv_gpa_page_range {
536 	u64 address_space;
537 	struct {
538 		u64 additional_pages : 11;
539 		u64 largepage : 1;
540 		u64 basepfn : 52;
541 	} page;
542 	struct {
543 		u64 reserved : 12;
544 		u64 page_size : 1;
545 		u64 reserved1 : 8;
546 		u64 base_large_pfn : 43;
547 	};
548 };
549 
550 /*
551  * All input flush parameters should be in single page. The max flush
552  * count is equal with how many entries of union hv_gpa_page_range can
553  * be populated into the input parameter page.
554  */
555 #define HV_MAX_FLUSH_REP_COUNT ((HV_HYP_PAGE_SIZE - 2 * sizeof(u64)) / \
556 				sizeof(union hv_gpa_page_range))
557 
558 struct hv_guest_mapping_flush_list {
559 	u64 address_space;
560 	u64 flags;
561 	union hv_gpa_page_range gpa_list[HV_MAX_FLUSH_REP_COUNT];
562 };
563 
564 struct hv_tlb_flush {	 /* HV_INPUT_FLUSH_VIRTUAL_ADDRESS_LIST */
565 	u64 address_space;
566 	u64 flags;
567 	u64 processor_mask;
568 	u64 gva_list[];
569 } __packed;
570 
571 /* HvFlushVirtualAddressSpaceEx, HvFlushVirtualAddressListEx hypercalls */
572 struct hv_tlb_flush_ex {
573 	u64 address_space;
574 	u64 flags;
575 	struct hv_vpset hv_vp_set;
576 	u64 gva_list[];
577 } __packed;
578 
579 struct ms_hyperv_tsc_page {	 /* HV_REFERENCE_TSC_PAGE */
580 	volatile u32 tsc_sequence;
581 	u32 reserved1;
582 	volatile u64 tsc_scale;
583 	volatile s64 tsc_offset;
584 } __packed;
585 
586 /* Define the number of synthetic interrupt sources. */
587 #define HV_SYNIC_SINT_COUNT (16)
588 
589 /* Define the expected SynIC version. */
590 #define HV_SYNIC_VERSION_1		(0x1)
591 /* Valid SynIC vectors are 16-255. */
592 #define HV_SYNIC_FIRST_VALID_VECTOR	(16)
593 
594 #define HV_SYNIC_CONTROL_ENABLE		(1ULL << 0)
595 #define HV_SYNIC_SIMP_ENABLE		(1ULL << 0)
596 #define HV_SYNIC_SIEFP_ENABLE		(1ULL << 0)
597 #define HV_SYNIC_SINT_MASKED		(1ULL << 16)
598 #define HV_SYNIC_SINT_AUTO_EOI		(1ULL << 17)
599 #define HV_SYNIC_SINT_VECTOR_MASK	(0xFF)
600 
601 /* Hyper-V defined statically assigned SINTs */
602 #define HV_SYNIC_INTERCEPTION_SINT_INDEX 0x00000000
603 #define HV_SYNIC_IOMMU_FAULT_SINT_INDEX  0x00000001
604 #define HV_SYNIC_VMBUS_SINT_INDEX	 0x00000002
605 #define HV_SYNIC_FIRST_UNUSED_SINT_INDEX 0x00000005
606 
607 /* mshv assigned SINT for doorbell */
608 #define HV_SYNIC_DOORBELL_SINT_INDEX     HV_SYNIC_FIRST_UNUSED_SINT_INDEX
609 
610 enum hv_interrupt_type {
611 	HV_X64_INTERRUPT_TYPE_FIXED		= 0x0000,
612 	HV_X64_INTERRUPT_TYPE_LOWESTPRIORITY	= 0x0001,
613 	HV_X64_INTERRUPT_TYPE_SMI		= 0x0002,
614 	HV_X64_INTERRUPT_TYPE_REMOTEREAD	= 0x0003,
615 	HV_X64_INTERRUPT_TYPE_NMI		= 0x0004,
616 	HV_X64_INTERRUPT_TYPE_INIT		= 0x0005,
617 	HV_X64_INTERRUPT_TYPE_SIPI		= 0x0006,
618 	HV_X64_INTERRUPT_TYPE_EXTINT		= 0x0007,
619 	HV_X64_INTERRUPT_TYPE_LOCALINT0		= 0x0008,
620 	HV_X64_INTERRUPT_TYPE_LOCALINT1		= 0x0009,
621 	HV_X64_INTERRUPT_TYPE_MAXIMUM		= 0x000A,
622 };
623 
624 /* Define synthetic interrupt source. */
625 union hv_synic_sint {
626 	u64 as_uint64;
627 	struct {
628 		u64 vector : 8;
629 		u64 reserved1 : 8;
630 		u64 masked : 1;
631 		u64 auto_eoi : 1;
632 		u64 polling : 1;
633 		u64 as_intercept : 1;
634 		u64 proxy : 1;
635 		u64 reserved2 : 43;
636 	} __packed;
637 };
638 
639 union hv_x64_xsave_xfem_register {
640 	u64 as_uint64;
641 	struct {
642 		u32 low_uint32;
643 		u32 high_uint32;
644 	} __packed;
645 	struct {
646 		u64 legacy_x87 : 1;
647 		u64 legacy_sse : 1;
648 		u64 avx : 1;
649 		u64 mpx_bndreg : 1;
650 		u64 mpx_bndcsr : 1;
651 		u64 avx_512_op_mask : 1;
652 		u64 avx_512_zmmhi : 1;
653 		u64 avx_512_zmm16_31 : 1;
654 		u64 rsvd8_9 : 2;
655 		u64 pasid : 1;
656 		u64 cet_u : 1;
657 		u64 cet_s : 1;
658 		u64 rsvd13_16 : 4;
659 		u64 xtile_cfg : 1;
660 		u64 xtile_data : 1;
661 		u64 rsvd19_63 : 45;
662 	} __packed;
663 };
664 
665 /* Synthetic timer configuration */
666 union hv_stimer_config {	 /* HV_X64_MSR_STIMER_CONFIG_CONTENTS */
667 	u64 as_uint64;
668 	struct {
669 		u64 enable : 1;
670 		u64 periodic : 1;
671 		u64 lazy : 1;
672 		u64 auto_enable : 1;
673 		u64 apic_vector : 8;
674 		u64 direct_mode : 1;
675 		u64 reserved_z0 : 3;
676 		u64 sintx : 4;
677 		u64 reserved_z1 : 44;
678 	} __packed;
679 };
680 
681 /* Define the number of synthetic timers */
682 #define HV_SYNIC_STIMER_COUNT	(4)
683 
684 /* Define port identifier type. */
685 union hv_port_id {
686 	u32 asu32;
687 	struct {
688 		u32 id : 24;
689 		u32 reserved : 8;
690 	} __packed u;
691 };
692 
693 #define HV_MESSAGE_SIZE			(256)
694 #define HV_MESSAGE_PAYLOAD_BYTE_COUNT	(240)
695 #define HV_MESSAGE_PAYLOAD_QWORD_COUNT	(30)
696 
697 /* Define hypervisor message types. */
698 enum hv_message_type {
699 	HVMSG_NONE				= 0x00000000,
700 
701 	/* Memory access messages. */
702 	HVMSG_UNMAPPED_GPA			= 0x80000000,
703 	HVMSG_GPA_INTERCEPT			= 0x80000001,
704 
705 	/* Timer notification messages. */
706 	HVMSG_TIMER_EXPIRED			= 0x80000010,
707 
708 	/* Error messages. */
709 	HVMSG_INVALID_VP_REGISTER_VALUE		= 0x80000020,
710 	HVMSG_UNRECOVERABLE_EXCEPTION		= 0x80000021,
711 	HVMSG_UNSUPPORTED_FEATURE		= 0x80000022,
712 
713 	/*
714 	 * Opaque intercept message. The original intercept message is only
715 	 * accessible from the mapped intercept message page.
716 	 */
717 	HVMSG_OPAQUE_INTERCEPT			= 0x8000003F,
718 
719 	/* Trace buffer complete messages. */
720 	HVMSG_EVENTLOG_BUFFERCOMPLETE		= 0x80000040,
721 
722 	/* Hypercall intercept */
723 	HVMSG_HYPERCALL_INTERCEPT		= 0x80000050,
724 
725 	/* SynIC intercepts */
726 	HVMSG_SYNIC_EVENT_INTERCEPT		= 0x80000060,
727 	HVMSG_SYNIC_SINT_INTERCEPT		= 0x80000061,
728 	HVMSG_SYNIC_SINT_DELIVERABLE	= 0x80000062,
729 
730 	/* Async call completion intercept */
731 	HVMSG_ASYNC_CALL_COMPLETION		= 0x80000070,
732 
733 	/* Root scheduler messages */
734 	HVMSG_SCHEDULER_VP_SIGNAL_BITSET	= 0x80000100,
735 	HVMSG_SCHEDULER_VP_SIGNAL_PAIR		= 0x80000101,
736 
737 	/* Platform-specific processor intercept messages. */
738 	HVMSG_X64_IO_PORT_INTERCEPT		= 0x80010000,
739 	HVMSG_X64_MSR_INTERCEPT			= 0x80010001,
740 	HVMSG_X64_CPUID_INTERCEPT		= 0x80010002,
741 	HVMSG_X64_EXCEPTION_INTERCEPT		= 0x80010003,
742 	HVMSG_X64_APIC_EOI			= 0x80010004,
743 	HVMSG_X64_LEGACY_FP_ERROR		= 0x80010005,
744 	HVMSG_X64_IOMMU_PRQ			= 0x80010006,
745 	HVMSG_X64_HALT				= 0x80010007,
746 	HVMSG_X64_INTERRUPTION_DELIVERABLE	= 0x80010008,
747 	HVMSG_X64_SIPI_INTERCEPT		= 0x80010009,
748 };
749 
750 /* Define the format of the SIMP register */
751 union hv_synic_simp {
752 	u64 as_uint64;
753 	struct {
754 		u64 simp_enabled : 1;
755 		u64 preserved : 11;
756 		u64 base_simp_gpa : 52;
757 	} __packed;
758 };
759 
760 union hv_message_flags {
761 	u8 asu8;
762 	struct {
763 		u8 msg_pending : 1;
764 		u8 reserved : 7;
765 	} __packed;
766 };
767 
768 struct hv_message_header {
769 	u32 message_type;
770 	u8 payload_size;
771 	union hv_message_flags message_flags;
772 	u8 reserved[2];
773 	union {
774 		u64 sender;
775 		union hv_port_id port;
776 	};
777 } __packed;
778 
779 /*
780  * Message format for notifications delivered via
781  * intercept message(as_intercept=1)
782  */
783 struct hv_notification_message_payload {
784 	u32 sint_index;
785 } __packed;
786 
787 struct hv_message {
788 	struct hv_message_header header;
789 	union {
790 		u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
791 	} u;
792 } __packed;
793 
794 /* Define the synthetic interrupt message page layout. */
795 struct hv_message_page {
796 	struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
797 } __packed;
798 
799 /* Define timer message payload structure. */
800 struct hv_timer_message_payload {
801 	u32 timer_index;
802 	u32 reserved;
803 	u64 expiration_time;	/* When the timer expired */
804 	u64 delivery_time;	/* When the message was delivered */
805 } __packed;
806 
807 struct hv_x64_segment_register {
808 	u64 base;
809 	u32 limit;
810 	u16 selector;
811 	union {
812 		struct {
813 			u16 segment_type : 4;
814 			u16 non_system_segment : 1;
815 			u16 descriptor_privilege_level : 2;
816 			u16 present : 1;
817 			u16 reserved : 4;
818 			u16 available : 1;
819 			u16 _long : 1;
820 			u16 _default : 1;
821 			u16 granularity : 1;
822 		} __packed;
823 		u16 attributes;
824 	};
825 } __packed;
826 
827 struct hv_x64_table_register {
828 	u16 pad[3];
829 	u16 limit;
830 	u64 base;
831 } __packed;
832 
833 #define HV_NORMAL_VTL	0
834 
835 union hv_input_vtl {
836 	u8 as_uint8;
837 	struct {
838 		u8 target_vtl : 4;
839 		u8 use_target_vtl : 1;
840 		u8 reserved_z : 3;
841 	};
842 } __packed;
843 
844 struct hv_init_vp_context {
845 	u64 rip;
846 	u64 rsp;
847 	u64 rflags;
848 
849 	struct hv_x64_segment_register cs;
850 	struct hv_x64_segment_register ds;
851 	struct hv_x64_segment_register es;
852 	struct hv_x64_segment_register fs;
853 	struct hv_x64_segment_register gs;
854 	struct hv_x64_segment_register ss;
855 	struct hv_x64_segment_register tr;
856 	struct hv_x64_segment_register ldtr;
857 
858 	struct hv_x64_table_register idtr;
859 	struct hv_x64_table_register gdtr;
860 
861 	u64 efer;
862 	u64 cr0;
863 	u64 cr3;
864 	u64 cr4;
865 	u64 msr_cr_pat;
866 } __packed;
867 
868 struct hv_enable_vp_vtl {
869 	u64				partition_id;
870 	u32				vp_index;
871 	union hv_input_vtl		target_vtl;
872 	u8				mbz0;
873 	u16				mbz1;
874 	struct hv_init_vp_context	vp_context;
875 } __packed;
876 
877 struct hv_get_vp_from_apic_id_in {
878 	u64 partition_id;
879 	union hv_input_vtl target_vtl;
880 	u8 res[7];
881 	u32 apic_ids[];
882 } __packed;
883 
884 struct hv_nested_enlightenments_control {
885 	struct {
886 		u32 directhypercall : 1;
887 		u32 reserved : 31;
888 	} __packed features;
889 	struct {
890 		u32 inter_partition_comm : 1;
891 		u32 reserved : 31;
892 	} __packed hypercall_controls;
893 } __packed;
894 
895 /* Define virtual processor assist page structure. */
896 struct hv_vp_assist_page {
897 	u32 apic_assist;
898 	u32 reserved1;
899 	u32 vtl_entry_reason;
900 	u32 vtl_reserved;
901 	u64 vtl_ret_x64rax;
902 	u64 vtl_ret_x64rcx;
903 	struct hv_nested_enlightenments_control nested_control;
904 	u8 enlighten_vmentry;
905 	u8 reserved2[7];
906 	u64 current_nested_vmcs;
907 	u8 synthetic_time_unhalted_timer_expired;
908 	u8 reserved3[7];
909 	u8 virtualization_fault_information[40];
910 	u8 reserved4[8];
911 	u8 intercept_message[256];
912 	u8 vtl_ret_actions[256];
913 } __packed;
914 
915 enum hv_register_name {
916 	/* Suspend Registers */
917 	HV_REGISTER_EXPLICIT_SUSPEND				= 0x00000000,
918 	HV_REGISTER_INTERCEPT_SUSPEND				= 0x00000001,
919 	HV_REGISTER_DISPATCH_SUSPEND				= 0x00000003,
920 
921 	/* Version - 128-bit result same as CPUID 0x40000002 */
922 	HV_REGISTER_HYPERVISOR_VERSION				= 0x00000100,
923 
924 	/* Feature Access (registers are 128 bits) - same as CPUID 0x40000003 - 0x4000000B */
925 	HV_REGISTER_PRIVILEGES_AND_FEATURES_INFO		= 0x00000200,
926 	HV_REGISTER_FEATURES_INFO				= 0x00000201,
927 	HV_REGISTER_IMPLEMENTATION_LIMITS_INFO			= 0x00000202,
928 	HV_REGISTER_HARDWARE_FEATURES_INFO			= 0x00000203,
929 	HV_REGISTER_CPU_MANAGEMENT_FEATURES_INFO		= 0x00000204,
930 	HV_REGISTER_SVM_FEATURES_INFO				= 0x00000205,
931 	HV_REGISTER_SKIP_LEVEL_FEATURES_INFO			= 0x00000206,
932 	HV_REGISTER_NESTED_VIRT_FEATURES_INFO			= 0x00000207,
933 	HV_REGISTER_IPT_FEATURES_INFO				= 0x00000208,
934 
935 	/* Guest Crash Registers */
936 	HV_REGISTER_GUEST_CRASH_P0				= 0x00000210,
937 	HV_REGISTER_GUEST_CRASH_P1				= 0x00000211,
938 	HV_REGISTER_GUEST_CRASH_P2				= 0x00000212,
939 	HV_REGISTER_GUEST_CRASH_P3				= 0x00000213,
940 	HV_REGISTER_GUEST_CRASH_P4				= 0x00000214,
941 	HV_REGISTER_GUEST_CRASH_CTL				= 0x00000215,
942 
943 	/* Misc */
944 	HV_REGISTER_VP_RUNTIME					= 0x00090000,
945 	HV_REGISTER_GUEST_OS_ID					= 0x00090002,
946 	HV_REGISTER_VP_INDEX					= 0x00090003,
947 	HV_REGISTER_TIME_REF_COUNT				= 0x00090004,
948 	HV_REGISTER_CPU_MANAGEMENT_VERSION			= 0x00090007,
949 	HV_REGISTER_VP_ASSIST_PAGE				= 0x00090013,
950 	HV_REGISTER_VP_ROOT_SIGNAL_COUNT			= 0x00090014,
951 	HV_REGISTER_REFERENCE_TSC				= 0x00090017,
952 
953 	/* Hypervisor-defined Registers (Synic) */
954 	HV_REGISTER_SINT0					= 0x000A0000,
955 	HV_REGISTER_SINT1					= 0x000A0001,
956 	HV_REGISTER_SINT2					= 0x000A0002,
957 	HV_REGISTER_SINT3					= 0x000A0003,
958 	HV_REGISTER_SINT4					= 0x000A0004,
959 	HV_REGISTER_SINT5					= 0x000A0005,
960 	HV_REGISTER_SINT6					= 0x000A0006,
961 	HV_REGISTER_SINT7					= 0x000A0007,
962 	HV_REGISTER_SINT8					= 0x000A0008,
963 	HV_REGISTER_SINT9					= 0x000A0009,
964 	HV_REGISTER_SINT10					= 0x000A000A,
965 	HV_REGISTER_SINT11					= 0x000A000B,
966 	HV_REGISTER_SINT12					= 0x000A000C,
967 	HV_REGISTER_SINT13					= 0x000A000D,
968 	HV_REGISTER_SINT14					= 0x000A000E,
969 	HV_REGISTER_SINT15					= 0x000A000F,
970 	HV_REGISTER_SCONTROL					= 0x000A0010,
971 	HV_REGISTER_SVERSION					= 0x000A0011,
972 	HV_REGISTER_SIEFP					= 0x000A0012,
973 	HV_REGISTER_SIMP					= 0x000A0013,
974 	HV_REGISTER_EOM						= 0x000A0014,
975 	HV_REGISTER_SIRBP					= 0x000A0015,
976 
977 	HV_REGISTER_NESTED_SINT0				= 0x000A1000,
978 	HV_REGISTER_NESTED_SINT1				= 0x000A1001,
979 	HV_REGISTER_NESTED_SINT2				= 0x000A1002,
980 	HV_REGISTER_NESTED_SINT3				= 0x000A1003,
981 	HV_REGISTER_NESTED_SINT4				= 0x000A1004,
982 	HV_REGISTER_NESTED_SINT5				= 0x000A1005,
983 	HV_REGISTER_NESTED_SINT6				= 0x000A1006,
984 	HV_REGISTER_NESTED_SINT7				= 0x000A1007,
985 	HV_REGISTER_NESTED_SINT8				= 0x000A1008,
986 	HV_REGISTER_NESTED_SINT9				= 0x000A1009,
987 	HV_REGISTER_NESTED_SINT10				= 0x000A100A,
988 	HV_REGISTER_NESTED_SINT11				= 0x000A100B,
989 	HV_REGISTER_NESTED_SINT12				= 0x000A100C,
990 	HV_REGISTER_NESTED_SINT13				= 0x000A100D,
991 	HV_REGISTER_NESTED_SINT14				= 0x000A100E,
992 	HV_REGISTER_NESTED_SINT15				= 0x000A100F,
993 	HV_REGISTER_NESTED_SCONTROL				= 0x000A1010,
994 	HV_REGISTER_NESTED_SVERSION				= 0x000A1011,
995 	HV_REGISTER_NESTED_SIFP					= 0x000A1012,
996 	HV_REGISTER_NESTED_SIPP					= 0x000A1013,
997 	HV_REGISTER_NESTED_EOM					= 0x000A1014,
998 	HV_REGISTER_NESTED_SIRBP				= 0x000a1015,
999 
1000 	/* Hypervisor-defined Registers (Synthetic Timers) */
1001 	HV_REGISTER_STIMER0_CONFIG				= 0x000B0000,
1002 	HV_REGISTER_STIMER0_COUNT				= 0x000B0001,
1003 
1004 	/* VSM */
1005 	HV_REGISTER_VSM_VP_STATUS				= 0x000D0003,
1006 };
1007 
1008 /*
1009  * Arch compatibility regs for use with hv_set/get_register
1010  */
1011 #if defined(CONFIG_X86)
1012 
1013 /*
1014  * To support arch-generic code calling hv_set/get_register:
1015  * - On x86, HV_MSR_ indicates an MSR accessed via rdmsrq/wrmsrq
1016  * - On ARM, HV_MSR_ indicates a VP register accessed via hypercall
1017  */
1018 #define HV_MSR_CRASH_P0		(HV_X64_MSR_CRASH_P0)
1019 #define HV_MSR_CRASH_P1		(HV_X64_MSR_CRASH_P1)
1020 #define HV_MSR_CRASH_P2		(HV_X64_MSR_CRASH_P2)
1021 #define HV_MSR_CRASH_P3		(HV_X64_MSR_CRASH_P3)
1022 #define HV_MSR_CRASH_P4		(HV_X64_MSR_CRASH_P4)
1023 #define HV_MSR_CRASH_CTL	(HV_X64_MSR_CRASH_CTL)
1024 
1025 #define HV_MSR_VP_INDEX		(HV_X64_MSR_VP_INDEX)
1026 #define HV_MSR_TIME_REF_COUNT	(HV_X64_MSR_TIME_REF_COUNT)
1027 #define HV_MSR_REFERENCE_TSC	(HV_X64_MSR_REFERENCE_TSC)
1028 
1029 #define HV_MSR_SINT0		(HV_X64_MSR_SINT0)
1030 #define HV_MSR_SVERSION		(HV_X64_MSR_SVERSION)
1031 #define HV_MSR_SCONTROL		(HV_X64_MSR_SCONTROL)
1032 #define HV_MSR_SIEFP		(HV_X64_MSR_SIEFP)
1033 #define HV_MSR_SIMP		(HV_X64_MSR_SIMP)
1034 #define HV_MSR_EOM		(HV_X64_MSR_EOM)
1035 #define HV_MSR_SIRBP		(HV_X64_MSR_SIRBP)
1036 
1037 #define HV_MSR_NESTED_SCONTROL	(HV_X64_MSR_NESTED_SCONTROL)
1038 #define HV_MSR_NESTED_SVERSION	(HV_X64_MSR_NESTED_SVERSION)
1039 #define HV_MSR_NESTED_SIEFP	(HV_X64_MSR_NESTED_SIEFP)
1040 #define HV_MSR_NESTED_SIMP	(HV_X64_MSR_NESTED_SIMP)
1041 #define HV_MSR_NESTED_EOM	(HV_X64_MSR_NESTED_EOM)
1042 #define HV_MSR_NESTED_SINT0	(HV_X64_MSR_NESTED_SINT0)
1043 
1044 #define HV_MSR_STIMER0_CONFIG	(HV_X64_MSR_STIMER0_CONFIG)
1045 #define HV_MSR_STIMER0_COUNT	(HV_X64_MSR_STIMER0_COUNT)
1046 
1047 #elif defined(CONFIG_ARM64) /* CONFIG_X86 */
1048 
1049 #define HV_MSR_CRASH_P0		(HV_REGISTER_GUEST_CRASH_P0)
1050 #define HV_MSR_CRASH_P1		(HV_REGISTER_GUEST_CRASH_P1)
1051 #define HV_MSR_CRASH_P2		(HV_REGISTER_GUEST_CRASH_P2)
1052 #define HV_MSR_CRASH_P3		(HV_REGISTER_GUEST_CRASH_P3)
1053 #define HV_MSR_CRASH_P4		(HV_REGISTER_GUEST_CRASH_P4)
1054 #define HV_MSR_CRASH_CTL	(HV_REGISTER_GUEST_CRASH_CTL)
1055 
1056 #define HV_MSR_VP_INDEX		(HV_REGISTER_VP_INDEX)
1057 #define HV_MSR_TIME_REF_COUNT	(HV_REGISTER_TIME_REF_COUNT)
1058 #define HV_MSR_REFERENCE_TSC	(HV_REGISTER_REFERENCE_TSC)
1059 
1060 #define HV_MSR_SINT0		(HV_REGISTER_SINT0)
1061 #define HV_MSR_SCONTROL		(HV_REGISTER_SCONTROL)
1062 #define HV_MSR_SIEFP		(HV_REGISTER_SIEFP)
1063 #define HV_MSR_SIMP		(HV_REGISTER_SIMP)
1064 #define HV_MSR_EOM		(HV_REGISTER_EOM)
1065 #define HV_MSR_SIRBP		(HV_REGISTER_SIRBP)
1066 
1067 #define HV_MSR_STIMER0_CONFIG	(HV_REGISTER_STIMER0_CONFIG)
1068 #define HV_MSR_STIMER0_COUNT	(HV_REGISTER_STIMER0_COUNT)
1069 
1070 #endif /* CONFIG_ARM64 */
1071 
1072 union hv_explicit_suspend_register {
1073 	u64 as_uint64;
1074 	struct {
1075 		u64 suspended : 1;
1076 		u64 reserved : 63;
1077 	} __packed;
1078 };
1079 
1080 union hv_intercept_suspend_register {
1081 	u64 as_uint64;
1082 	struct {
1083 		u64 suspended : 1;
1084 		u64 reserved : 63;
1085 	} __packed;
1086 };
1087 
1088 union hv_dispatch_suspend_register {
1089 	u64 as_uint64;
1090 	struct {
1091 		u64 suspended : 1;
1092 		u64 reserved : 63;
1093 	} __packed;
1094 };
1095 
1096 union hv_arm64_pending_interruption_register {
1097 	u64 as_uint64;
1098 	struct {
1099 		u64 interruption_pending : 1;
1100 		u64 interruption_type: 1;
1101 		u64 reserved : 30;
1102 		u64 error_code : 32;
1103 	} __packed;
1104 };
1105 
1106 union hv_arm64_interrupt_state_register {
1107 	u64 as_uint64;
1108 	struct {
1109 		u64 interrupt_shadow : 1;
1110 		u64 reserved : 63;
1111 	} __packed;
1112 };
1113 
1114 union hv_arm64_pending_synthetic_exception_event {
1115 	u64 as_uint64[2];
1116 	struct {
1117 		u8 event_pending : 1;
1118 		u8 event_type : 3;
1119 		u8 reserved : 4;
1120 		u8 rsvd[3];
1121 		u32 exception_type;
1122 		u64 context;
1123 	} __packed;
1124 };
1125 
1126 union hv_x64_interrupt_state_register {
1127 	u64 as_uint64;
1128 	struct {
1129 		u64 interrupt_shadow : 1;
1130 		u64 nmi_masked : 1;
1131 		u64 reserved : 62;
1132 	} __packed;
1133 };
1134 
1135 union hv_x64_pending_interruption_register {
1136 	u64 as_uint64;
1137 	struct {
1138 		u32 interruption_pending : 1;
1139 		u32 interruption_type : 3;
1140 		u32 deliver_error_code : 1;
1141 		u32 instruction_length : 4;
1142 		u32 nested_event : 1;
1143 		u32 reserved : 6;
1144 		u32 interruption_vector : 16;
1145 		u32 error_code;
1146 	} __packed;
1147 };
1148 
1149 union hv_register_value {
1150 	struct hv_u128 reg128;
1151 	u64 reg64;
1152 	u32 reg32;
1153 	u16 reg16;
1154 	u8 reg8;
1155 
1156 	struct hv_x64_segment_register segment;
1157 	struct hv_x64_table_register table;
1158 	union hv_explicit_suspend_register explicit_suspend;
1159 	union hv_intercept_suspend_register intercept_suspend;
1160 	union hv_dispatch_suspend_register dispatch_suspend;
1161 #ifdef CONFIG_ARM64
1162 	union hv_arm64_interrupt_state_register interrupt_state;
1163 	union hv_arm64_pending_interruption_register pending_interruption;
1164 #endif
1165 #ifdef CONFIG_X86
1166 	union hv_x64_interrupt_state_register interrupt_state;
1167 	union hv_x64_pending_interruption_register pending_interruption;
1168 #endif
1169 	union hv_arm64_pending_synthetic_exception_event pending_synthetic_exception_event;
1170 };
1171 
1172 /* NOTE: Linux helper struct - NOT from Hyper-V code. */
1173 struct hv_output_get_vp_registers {
1174 	DECLARE_FLEX_ARRAY(union hv_register_value, values);
1175 };
1176 
1177 #if defined(CONFIG_ARM64)
1178 /* HvGetVpRegisters returns an array of these output elements */
1179 struct hv_get_vp_registers_output {
1180 	union {
1181 		struct {
1182 			u32 a;
1183 			u32 b;
1184 			u32 c;
1185 			u32 d;
1186 		} as32 __packed;
1187 		struct {
1188 			u64 low;
1189 			u64 high;
1190 		} as64 __packed;
1191 	};
1192 };
1193 
1194 #endif /* CONFIG_ARM64 */
1195 
1196 struct hv_register_assoc {
1197 	u32 name;			/* enum hv_register_name */
1198 	u32 reserved1;
1199 	u64 reserved2;
1200 	union hv_register_value value;
1201 } __packed;
1202 
1203 struct hv_input_get_vp_registers {
1204 	u64 partition_id;
1205 	u32 vp_index;
1206 	union hv_input_vtl input_vtl;
1207 	u8  rsvd_z8;
1208 	u16 rsvd_z16;
1209 	u32 names[];
1210 } __packed;
1211 
1212 struct hv_input_set_vp_registers {
1213 	u64 partition_id;
1214 	u32 vp_index;
1215 	union hv_input_vtl input_vtl;
1216 	u8  rsvd_z8;
1217 	u16 rsvd_z16;
1218 	struct hv_register_assoc elements[];
1219 } __packed;
1220 
1221 #define HV_UNMAP_GPA_LARGE_PAGE		0x2
1222 
1223 /* HvCallSendSyntheticClusterIpi hypercall */
1224 struct hv_send_ipi {	 /* HV_INPUT_SEND_SYNTHETIC_CLUSTER_IPI */
1225 	u32 vector;
1226 	u32 reserved;
1227 	u64 cpu_mask;
1228 } __packed;
1229 
1230 #define	HV_VTL_MASK			GENMASK(3, 0)
1231 
1232 /* Hyper-V memory host visibility */
1233 enum hv_mem_host_visibility {
1234 	VMBUS_PAGE_NOT_VISIBLE		= 0,
1235 	VMBUS_PAGE_VISIBLE_READ_ONLY	= 1,
1236 	VMBUS_PAGE_VISIBLE_READ_WRITE	= 3
1237 };
1238 
1239 /* HvCallModifySparseGpaPageHostVisibility hypercall */
1240 #define HV_MAX_MODIFY_GPA_REP_COUNT	((HV_HYP_PAGE_SIZE / sizeof(u64)) - 2)
1241 struct hv_gpa_range_for_visibility {
1242 	u64 partition_id;
1243 	u32 host_visibility : 2;
1244 	u32 reserved0 : 30;
1245 	u32 reserved1;
1246 	u64 gpa_page_list[HV_MAX_MODIFY_GPA_REP_COUNT];
1247 } __packed;
1248 
1249 #if defined(CONFIG_X86)
1250 union hv_msi_address_register { /* HV_MSI_ADDRESS */
1251 	u32 as_uint32;
1252 	struct {
1253 		u32 reserved1 : 2;
1254 		u32 destination_mode : 1;
1255 		u32 redirection_hint : 1;
1256 		u32 reserved2 : 8;
1257 		u32 destination_id : 8;
1258 		u32 msi_base : 12;
1259 	};
1260 } __packed;
1261 
1262 union hv_msi_data_register {	 /* HV_MSI_ENTRY.Data */
1263 	u32 as_uint32;
1264 	struct {
1265 		u32 vector : 8;
1266 		u32 delivery_mode : 3;
1267 		u32 reserved1 : 3;
1268 		u32 level_assert : 1;
1269 		u32 trigger_mode : 1;
1270 		u32 reserved2 : 16;
1271 	};
1272 } __packed;
1273 
1274 union hv_msi_entry {	 /* HV_MSI_ENTRY */
1275 
1276 	u64 as_uint64;
1277 	struct {
1278 		union hv_msi_address_register address;
1279 		union hv_msi_data_register data;
1280 	} __packed;
1281 };
1282 
1283 #elif defined(CONFIG_ARM64) /* CONFIG_X86 */
1284 
1285 union hv_msi_entry {
1286 	u64 as_uint64[2];
1287 	struct {
1288 		u64 address;
1289 		u32 data;
1290 		u32 reserved;
1291 	} __packed;
1292 };
1293 #endif /* CONFIG_ARM64 */
1294 
1295 union hv_ioapic_rte {
1296 	u64 as_uint64;
1297 
1298 	struct {
1299 		u32 vector : 8;
1300 		u32 delivery_mode : 3;
1301 		u32 destination_mode : 1;
1302 		u32 delivery_status : 1;
1303 		u32 interrupt_polarity : 1;
1304 		u32 remote_irr : 1;
1305 		u32 trigger_mode : 1;
1306 		u32 interrupt_mask : 1;
1307 		u32 reserved1 : 15;
1308 
1309 		u32 reserved2 : 24;
1310 		u32 destination_id : 8;
1311 	};
1312 
1313 	struct {
1314 		u32 low_uint32;
1315 		u32 high_uint32;
1316 	};
1317 } __packed;
1318 
1319 enum hv_interrupt_source {	 /* HV_INTERRUPT_SOURCE */
1320 	HV_INTERRUPT_SOURCE_MSI = 1, /* MSI and MSI-X */
1321 	HV_INTERRUPT_SOURCE_IOAPIC,
1322 };
1323 
1324 struct hv_interrupt_entry {	 /* HV_INTERRUPT_ENTRY */
1325 	u32 source;
1326 	u32 reserved1;
1327 	union {
1328 		union hv_msi_entry msi_entry;
1329 		union hv_ioapic_rte ioapic_rte;
1330 	};
1331 } __packed;
1332 
1333 #define HV_DEVICE_INTERRUPT_TARGET_MULTICAST		1
1334 #define HV_DEVICE_INTERRUPT_TARGET_PROCESSOR_SET	2
1335 
1336 struct hv_device_interrupt_target {	 /* HV_DEVICE_INTERRUPT_TARGET */
1337 	u32 vector;
1338 	u32 flags;		/* HV_DEVICE_INTERRUPT_TARGET_* above */
1339 	union {
1340 		u64 vp_mask;
1341 		struct hv_vpset vp_set;
1342 	};
1343 } __packed;
1344 
1345 struct hv_retarget_device_interrupt {	 /* HV_INPUT_RETARGET_DEVICE_INTERRUPT */
1346 	u64 partition_id;		/* use "self" */
1347 	u64 device_id;
1348 	struct hv_interrupt_entry int_entry;
1349 	u64 reserved2;
1350 	struct hv_device_interrupt_target int_target;
1351 } __packed __aligned(8);
1352 
1353 enum hv_intercept_type {
1354 #if defined(CONFIG_X86)
1355 	HV_INTERCEPT_TYPE_X64_IO_PORT			= 0x00000000,
1356 	HV_INTERCEPT_TYPE_X64_MSR			= 0x00000001,
1357 	HV_INTERCEPT_TYPE_X64_CPUID			= 0x00000002,
1358 #endif
1359 	HV_INTERCEPT_TYPE_EXCEPTION			= 0x00000003,
1360 	/* Used to be HV_INTERCEPT_TYPE_REGISTER */
1361 	HV_INTERCEPT_TYPE_RESERVED0			= 0x00000004,
1362 	HV_INTERCEPT_TYPE_MMIO				= 0x00000005,
1363 #if defined(CONFIG_X86)
1364 	HV_INTERCEPT_TYPE_X64_GLOBAL_CPUID		= 0x00000006,
1365 	HV_INTERCEPT_TYPE_X64_APIC_SMI			= 0x00000007,
1366 #endif
1367 	HV_INTERCEPT_TYPE_HYPERCALL			= 0x00000008,
1368 #if defined(CONFIG_X86)
1369 	HV_INTERCEPT_TYPE_X64_APIC_INIT_SIPI		= 0x00000009,
1370 	HV_INTERCEPT_MC_UPDATE_PATCH_LEVEL_MSR_READ	= 0x0000000A,
1371 	HV_INTERCEPT_TYPE_X64_APIC_WRITE		= 0x0000000B,
1372 	HV_INTERCEPT_TYPE_X64_MSR_INDEX			= 0x0000000C,
1373 #endif
1374 	HV_INTERCEPT_TYPE_MAX,
1375 	HV_INTERCEPT_TYPE_INVALID			= 0xFFFFFFFF,
1376 };
1377 
1378 union hv_intercept_parameters {
1379 	/*  HV_INTERCEPT_PARAMETERS is defined to be an 8-byte field. */
1380 	u64 as_uint64;
1381 #if defined(CONFIG_X86)
1382 	/* HV_INTERCEPT_TYPE_X64_IO_PORT */
1383 	u16 io_port;
1384 	/* HV_INTERCEPT_TYPE_X64_CPUID */
1385 	u32 cpuid_index;
1386 	/* HV_INTERCEPT_TYPE_X64_APIC_WRITE */
1387 	u32 apic_write_mask;
1388 	/* HV_INTERCEPT_TYPE_EXCEPTION */
1389 	u16 exception_vector;
1390 	/* HV_INTERCEPT_TYPE_X64_MSR_INDEX */
1391 	u32 msr_index;
1392 #endif
1393 	/* N.B. Other intercept types do not have any parameters. */
1394 };
1395 
1396 /* Data structures for HVCALL_MMIO_READ and HVCALL_MMIO_WRITE */
1397 #define HV_HYPERCALL_MMIO_MAX_DATA_LENGTH 64
1398 
1399 struct hv_mmio_read_input { /* HV_INPUT_MEMORY_MAPPED_IO_READ */
1400 	u64 gpa;
1401 	u32 size;
1402 	u32 reserved;
1403 } __packed;
1404 
1405 struct hv_mmio_read_output {
1406 	u8 data[HV_HYPERCALL_MMIO_MAX_DATA_LENGTH];
1407 } __packed;
1408 
1409 struct hv_mmio_write_input {
1410 	u64 gpa;
1411 	u32 size;
1412 	u32 reserved;
1413 	u8 data[HV_HYPERCALL_MMIO_MAX_DATA_LENGTH];
1414 } __packed;
1415 
1416 #endif /* _HV_HVGDK_MINI_H */
1417