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