hyperv_reg.h revision 311223 
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/10/sys/dev/hyperv/vmbus/hyperv_reg.h 311223 2017-01-04 01:58:38Z sephe $
27 */
28
29#ifndef _HYPERV_REG_H_
30#define _HYPERV_REG_H_
31
32#include <sys/param.h>
33#include <sys/systm.h>
34
35/*
36 * Hyper-V Synthetic MSRs
37 */
38
39#define MSR_HV_GUEST_OS_ID		0x40000000
40#define MSR_HV_GUESTID_BUILD_MASK	0xffffULL
41#define MSR_HV_GUESTID_VERSION_MASK	0x0000ffffffff0000ULL
42#define MSR_HV_GUESTID_VERSION_SHIFT	16
43#define MSR_HV_GUESTID_OSID_MASK	0x00ff000000000000ULL
44#define MSR_HV_GUESTID_OSID_SHIFT	48
45#define MSR_HV_GUESTID_OSTYPE_MASK	0x7f00000000000000ULL
46#define MSR_HV_GUESTID_OSTYPE_SHIFT	56
47#define MSR_HV_GUESTID_OPENSRC		0x8000000000000000ULL
48#define MSR_HV_GUESTID_OSTYPE_LINUX	\
49	((0x01ULL << MSR_HV_GUESTID_OSTYPE_SHIFT) | MSR_HV_GUESTID_OPENSRC)
50#define MSR_HV_GUESTID_OSTYPE_FREEBSD	\
51	((0x02ULL << MSR_HV_GUESTID_OSTYPE_SHIFT) | MSR_HV_GUESTID_OPENSRC)
52
53#define MSR_HV_HYPERCALL		0x40000001
54#define MSR_HV_HYPERCALL_ENABLE		0x0001ULL
55#define MSR_HV_HYPERCALL_RSVD_MASK	0x0ffeULL
56#define MSR_HV_HYPERCALL_PGSHIFT	12
57
58#define MSR_HV_VP_INDEX			0x40000002
59
60#define MSR_HV_REFERENCE_TSC		0x40000021
61#define MSR_HV_REFTSC_ENABLE		0x0001ULL
62#define MSR_HV_REFTSC_RSVD_MASK		0x0ffeULL
63#define MSR_HV_REFTSC_PGSHIFT		12
64
65#define MSR_HV_SCONTROL			0x40000080
66#define MSR_HV_SCTRL_ENABLE		0x0001ULL
67#define MSR_HV_SCTRL_RSVD_MASK		0xfffffffffffffffeULL
68
69#define MSR_HV_SIEFP			0x40000082
70#define MSR_HV_SIEFP_ENABLE		0x0001ULL
71#define MSR_HV_SIEFP_RSVD_MASK		0x0ffeULL
72#define MSR_HV_SIEFP_PGSHIFT		12
73
74#define MSR_HV_SIMP			0x40000083
75#define MSR_HV_SIMP_ENABLE		0x0001ULL
76#define MSR_HV_SIMP_RSVD_MASK		0x0ffeULL
77#define MSR_HV_SIMP_PGSHIFT		12
78
79#define MSR_HV_EOM			0x40000084
80
81#define MSR_HV_SINT0			0x40000090
82#define MSR_HV_SINT_VECTOR_MASK		0x00ffULL
83#define MSR_HV_SINT_RSVD1_MASK		0xff00ULL
84#define MSR_HV_SINT_MASKED		0x00010000ULL
85#define MSR_HV_SINT_AUTOEOI		0x00020000ULL
86#define MSR_HV_SINT_RSVD2_MASK		0xfffffffffffc0000ULL
87#define MSR_HV_SINT_RSVD_MASK		(MSR_HV_SINT_RSVD1_MASK |	\
88					 MSR_HV_SINT_RSVD2_MASK)
89
90#define MSR_HV_STIMER0_CONFIG		0x400000b0
91#define MSR_HV_STIMER_CFG_ENABLE	0x0001ULL
92#define MSR_HV_STIMER_CFG_PERIODIC	0x0002ULL
93#define MSR_HV_STIMER_CFG_LAZY		0x0004ULL
94#define MSR_HV_STIMER_CFG_AUTOEN	0x0008ULL
95#define MSR_HV_STIMER_CFG_SINT_MASK	0x000f0000ULL
96#define MSR_HV_STIMER_CFG_SINT_SHIFT	16
97
98#define MSR_HV_STIMER0_COUNT		0x400000b1
99
100/*
101 * CPUID leaves
102 */
103
104#define CPUID_LEAF_HV_MAXLEAF		0x40000000
105
106#define CPUID_LEAF_HV_INTERFACE		0x40000001
107#define CPUID_HV_IFACE_HYPERV		0x31237648	/* HV#1 */
108
109#define CPUID_LEAF_HV_IDENTITY		0x40000002
110
111#define CPUID_LEAF_HV_FEATURES		0x40000003
112/* EAX: features include/hyperv.h CPUID_HV_MSR */
113/* ECX: power management features */
114#define CPUPM_HV_CSTATE_MASK		0x000f	/* deepest C-state */
115#define CPUPM_HV_C3_HPET		0x0010	/* C3 requires HPET */
116#define CPUPM_HV_CSTATE(f)		((f) & CPUPM_HV_CSTATE_MASK)
117/* EDX: features3 */
118#define CPUID3_HV_MWAIT			0x0001	/* MWAIT */
119#define CPUID3_HV_XMM_HYPERCALL		0x0010	/* Hypercall input through
120						 * XMM regs */
121#define CPUID3_HV_GUEST_IDLE		0x0020	/* guest idle */
122#define CPUID3_HV_NUMA			0x0080	/* NUMA distance query */
123#define CPUID3_HV_TIME_FREQ		0x0100	/* timer frequency query
124						 * (TSC, LAPIC) */
125#define CPUID3_HV_MSR_CRASH		0x0400	/* MSRs for guest crash */
126
127#define CPUID_LEAF_HV_RECOMMENDS	0x40000004
128#define CPUID_LEAF_HV_LIMITS		0x40000005
129#define CPUID_LEAF_HV_HWFEATURES	0x40000006
130
131/*
132 * Hyper-V Monitor Notification Facility
133 */
134struct hyperv_mon_param {
135	uint32_t	mp_connid;
136	uint16_t	mp_evtflag_ofs;
137	uint16_t	mp_rsvd;
138} __packed;
139
140/*
141 * Hyper-V message types
142 */
143#define HYPERV_MSGTYPE_NONE		0
144#define HYPERV_MSGTYPE_CHANNEL		1
145#define HYPERV_MSGTYPE_TIMER_EXPIRED	0x80000010
146
147/*
148 * Hypercall status codes
149 */
150#define HYPERCALL_STATUS_SUCCESS	0x0000
151
152/*
153 * Hypercall input values
154 */
155#define HYPERCALL_POST_MESSAGE		0x005c
156#define HYPERCALL_SIGNAL_EVENT		0x005d
157
158/*
159 * Hypercall input parameters
160 */
161#define HYPERCALL_PARAM_ALIGN		8
162#if 0
163/*
164 * XXX
165 * <<Hypervisor Top Level Functional Specification 4.0b>> requires
166 * input parameters size to be multiple of 8, however, many post
167 * message input parameters do _not_ meet this requirement.
168 */
169#define HYPERCALL_PARAM_SIZE_ALIGN	8
170#endif
171
172/*
173 * HYPERCALL_POST_MESSAGE
174 */
175#define HYPERCALL_POSTMSGIN_DSIZE_MAX	240
176#define HYPERCALL_POSTMSGIN_SIZE	256
177
178struct hypercall_postmsg_in {
179	uint32_t	hc_connid;
180	uint32_t	hc_rsvd;
181	uint32_t	hc_msgtype;	/* HYPERV_MSGTYPE_ */
182	uint32_t	hc_dsize;
183	uint8_t		hc_data[HYPERCALL_POSTMSGIN_DSIZE_MAX];
184} __packed;
185CTASSERT(sizeof(struct hypercall_postmsg_in) == HYPERCALL_POSTMSGIN_SIZE);
186
187/*
188 * HYPERCALL_SIGNAL_EVENT
189 *
190 * struct hyperv_mon_param.
191 */
192
193#endif	/* !_HYPERV_REG_H_ */
194