hyperv_reg.h revision 307278
1/*-
2 * Copyright (c) 2016 Microsoft Corp.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice unmodified, this list of conditions, and the following
10 *    disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: stable/11/sys/dev/hyperv/vmbus/hyperv_reg.h 307278 2016-10-14 07:27:29Z sephe $
27 */
28
29#ifndef _HYPERV_REG_H_
30#define _HYPERV_REG_H_
31
32#include <sys/param.h>
33
34/*
35 * Hyper-V Synthetic MSRs
36 */
37
38#define MSR_HV_GUEST_OS_ID		0x40000000
39#define MSR_HV_GUESTID_BUILD_MASK	0xffffULL
40#define MSR_HV_GUESTID_VERSION_MASK	0x0000ffffffff0000ULL
41#define MSR_HV_GUESTID_VERSION_SHIFT	16
42#define MSR_HV_GUESTID_OSID_MASK	0x00ff000000000000ULL
43#define MSR_HV_GUESTID_OSID_SHIFT	48
44#define MSR_HV_GUESTID_OSTYPE_MASK	0x7f00000000000000ULL
45#define MSR_HV_GUESTID_OSTYPE_SHIFT	56
46#define MSR_HV_GUESTID_OPENSRC		0x8000000000000000ULL
47#define MSR_HV_GUESTID_OSTYPE_LINUX	\
48	((0x01ULL << MSR_HV_GUESTID_OSTYPE_SHIFT) | MSR_HV_GUESTID_OPENSRC)
49#define MSR_HV_GUESTID_OSTYPE_FREEBSD	\
50	((0x02ULL << MSR_HV_GUESTID_OSTYPE_SHIFT) | MSR_HV_GUESTID_OPENSRC)
51
52#define MSR_HV_HYPERCALL		0x40000001
53#define MSR_HV_HYPERCALL_ENABLE		0x0001ULL
54#define MSR_HV_HYPERCALL_RSVD_MASK	0x0ffeULL
55#define MSR_HV_HYPERCALL_PGSHIFT	12
56
57#define MSR_HV_VP_INDEX			0x40000002
58
59#define MSR_HV_TIME_REF_COUNT		0x40000020
60
61#define MSR_HV_SCONTROL			0x40000080
62#define MSR_HV_SCTRL_ENABLE		0x0001ULL
63#define MSR_HV_SCTRL_RSVD_MASK		0xfffffffffffffffeULL
64
65#define MSR_HV_SIEFP			0x40000082
66#define MSR_HV_SIEFP_ENABLE		0x0001ULL
67#define MSR_HV_SIEFP_RSVD_MASK		0x0ffeULL
68#define MSR_HV_SIEFP_PGSHIFT		12
69
70#define MSR_HV_SIMP			0x40000083
71#define MSR_HV_SIMP_ENABLE		0x0001ULL
72#define MSR_HV_SIMP_RSVD_MASK		0x0ffeULL
73#define MSR_HV_SIMP_PGSHIFT		12
74
75#define MSR_HV_EOM			0x40000084
76
77#define MSR_HV_SINT0			0x40000090
78#define MSR_HV_SINT_VECTOR_MASK		0x00ffULL
79#define MSR_HV_SINT_RSVD1_MASK		0xff00ULL
80#define MSR_HV_SINT_MASKED		0x00010000ULL
81#define MSR_HV_SINT_AUTOEOI		0x00020000ULL
82#define MSR_HV_SINT_RSVD2_MASK		0xfffffffffffc0000ULL
83#define MSR_HV_SINT_RSVD_MASK		(MSR_HV_SINT_RSVD1_MASK |	\
84					 MSR_HV_SINT_RSVD2_MASK)
85
86#define MSR_HV_STIMER0_CONFIG		0x400000b0
87#define MSR_HV_STIMER_CFG_ENABLE	0x0001ULL
88#define MSR_HV_STIMER_CFG_PERIODIC	0x0002ULL
89#define MSR_HV_STIMER_CFG_LAZY		0x0004ULL
90#define MSR_HV_STIMER_CFG_AUTOEN	0x0008ULL
91#define MSR_HV_STIMER_CFG_SINT_MASK	0x000f0000ULL
92#define MSR_HV_STIMER_CFG_SINT_SHIFT	16
93
94#define MSR_HV_STIMER0_COUNT		0x400000b1
95
96/*
97 * CPUID leaves
98 */
99
100#define CPUID_LEAF_HV_MAXLEAF		0x40000000
101
102#define CPUID_LEAF_HV_INTERFACE		0x40000001
103#define CPUID_HV_IFACE_HYPERV		0x31237648	/* HV#1 */
104
105#define CPUID_LEAF_HV_IDENTITY		0x40000002
106
107#define CPUID_LEAF_HV_FEATURES		0x40000003
108/* EAX: features */
109#define CPUID_HV_MSR_TIME_REFCNT	0x0002	/* MSR_HV_TIME_REF_COUNT */
110#define CPUID_HV_MSR_SYNIC		0x0004	/* MSRs for SynIC */
111#define CPUID_HV_MSR_SYNTIMER		0x0008	/* MSRs for SynTimer */
112#define CPUID_HV_MSR_APIC		0x0010	/* MSR_HV_{EOI,ICR,TPR} */
113#define CPUID_HV_MSR_HYPERCALL		0x0020	/* MSR_HV_GUEST_OS_ID
114						 * MSR_HV_HYPERCALL */
115#define CPUID_HV_MSR_VP_INDEX		0x0040	/* MSR_HV_VP_INDEX */
116#define CPUID_HV_MSR_GUEST_IDLE		0x0400	/* MSR_HV_GUEST_IDLE */
117/* ECX: power management features */
118#define CPUPM_HV_CSTATE_MASK		0x000f	/* deepest C-state */
119#define CPUPM_HV_C3_HPET		0x0010	/* C3 requires HPET */
120#define CPUPM_HV_CSTATE(f)		((f) & CPUPM_HV_CSTATE_MASK)
121/* EDX: features3 */
122#define CPUID3_HV_MWAIT			0x0001	/* MWAIT */
123#define CPUID3_HV_XMM_HYPERCALL		0x0010	/* Hypercall input through
124						 * XMM regs */
125#define CPUID3_HV_GUEST_IDLE		0x0020	/* guest idle */
126#define CPUID3_HV_NUMA			0x0080	/* NUMA distance query */
127#define CPUID3_HV_TIME_FREQ		0x0100	/* timer frequency query
128						 * (TSC, LAPIC) */
129#define CPUID3_HV_MSR_CRASH		0x0400	/* MSRs for guest crash */
130
131#define CPUID_LEAF_HV_RECOMMENDS	0x40000004
132#define CPUID_LEAF_HV_LIMITS		0x40000005
133#define CPUID_LEAF_HV_HWFEATURES	0x40000006
134
135/*
136 * Hyper-V message types
137 */
138#define HYPERV_MSGTYPE_NONE		0
139#define HYPERV_MSGTYPE_CHANNEL		1
140#define HYPERV_MSGTYPE_TIMER_EXPIRED	0x80000010
141
142/*
143 * Hypercall status codes
144 */
145#define HYPERCALL_STATUS_SUCCESS	0x0000
146
147/*
148 * Hypercall input values
149 */
150#define HYPERCALL_POST_MESSAGE		0x005c
151
152/*
153 * Hypercall input parameters
154 */
155
156/*
157 * HYPERCALL_POST_MESSAGE
158 */
159#define HYPERCALL_POSTMSGIN_DSIZE_MAX	240
160#define HYPERCALL_POSTMSGIN_SIZE	256
161#define HYPERCALL_POSTMSGIN_ALIGN	8
162
163struct hypercall_postmsg_in {
164	uint32_t	hc_connid;
165	uint32_t	hc_rsvd;
166	uint32_t	hc_msgtype;	/* HYPERV_MSGTYPE_ */
167	uint32_t	hc_dsize;
168	uint8_t		hc_data[HYPERCALL_POSTMSGIN_DSIZE_MAX];
169} __packed;
170CTASSERT(sizeof(struct hypercall_postmsg_in) == HYPERCALL_POSTMSGIN_SIZE);
171
172#endif	/* !_HYPERV_REG_H_ */
173