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$ 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_REFERENCE_TSC 0x40000021 62 #define MSR_HV_REFTSC_ENABLE 0x0001ULL 63 #define MSR_HV_REFTSC_RSVD_MASK 0x0ffeULL 64 #define MSR_HV_REFTSC_PGSHIFT 12 65 66 #define MSR_HV_SCONTROL 0x40000080 67 #define MSR_HV_SCTRL_ENABLE 0x0001ULL 68 #define MSR_HV_SCTRL_RSVD_MASK 0xfffffffffffffffeULL 69 70 #define MSR_HV_SIEFP 0x40000082 71 #define MSR_HV_SIEFP_ENABLE 0x0001ULL 72 #define MSR_HV_SIEFP_RSVD_MASK 0x0ffeULL 73 #define MSR_HV_SIEFP_PGSHIFT 12 74 75 #define MSR_HV_SIMP 0x40000083 76 #define MSR_HV_SIMP_ENABLE 0x0001ULL 77 #define MSR_HV_SIMP_RSVD_MASK 0x0ffeULL 78 #define MSR_HV_SIMP_PGSHIFT 12 79 80 #define MSR_HV_EOM 0x40000084 81 82 #define MSR_HV_SINT0 0x40000090 83 #define MSR_HV_SINT_VECTOR_MASK 0x00ffULL 84 #define MSR_HV_SINT_RSVD1_MASK 0xff00ULL 85 #define MSR_HV_SINT_MASKED 0x00010000ULL 86 #define MSR_HV_SINT_AUTOEOI 0x00020000ULL 87 #define MSR_HV_SINT_RSVD2_MASK 0xfffffffffffc0000ULL 88 #define MSR_HV_SINT_RSVD_MASK (MSR_HV_SINT_RSVD1_MASK | \ 89 MSR_HV_SINT_RSVD2_MASK) 90 91 #define MSR_HV_STIMER0_CONFIG 0x400000b0 92 #define MSR_HV_STIMER_CFG_ENABLE 0x0001ULL 93 #define MSR_HV_STIMER_CFG_PERIODIC 0x0002ULL 94 #define MSR_HV_STIMER_CFG_LAZY 0x0004ULL 95 #define MSR_HV_STIMER_CFG_AUTOEN 0x0008ULL 96 #define MSR_HV_STIMER_CFG_SINT_MASK 0x000f0000ULL 97 #define MSR_HV_STIMER_CFG_SINT_SHIFT 16 98 99 #define MSR_HV_STIMER0_COUNT 0x400000b1 100 101 /* 102 * CPUID leaves 103 */ 104 105 #define CPUID_LEAF_HV_MAXLEAF 0x40000000 106 107 #define CPUID_LEAF_HV_INTERFACE 0x40000001 108 #define CPUID_HV_IFACE_HYPERV 0x31237648 /* HV#1 */ 109 110 #define CPUID_LEAF_HV_IDENTITY 0x40000002 111 112 #define CPUID_LEAF_HV_FEATURES 0x40000003 113 /* EAX: features */ 114 #define CPUID_HV_MSR_TIME_REFCNT 0x0002 /* MSR_HV_TIME_REF_COUNT */ 115 #define CPUID_HV_MSR_SYNIC 0x0004 /* MSRs for SynIC */ 116 #define CPUID_HV_MSR_SYNTIMER 0x0008 /* MSRs for SynTimer */ 117 #define CPUID_HV_MSR_APIC 0x0010 /* MSR_HV_{EOI,ICR,TPR} */ 118 #define CPUID_HV_MSR_HYPERCALL 0x0020 /* MSR_HV_GUEST_OS_ID 119 * MSR_HV_HYPERCALL */ 120 #define CPUID_HV_MSR_VP_INDEX 0x0040 /* MSR_HV_VP_INDEX */ 121 #define CPUID_HV_MSR_REFERENCE_TSC 0x0200 /* MSR_HV_REFERENCE_TSC */ 122 #define CPUID_HV_MSR_GUEST_IDLE 0x0400 /* MSR_HV_GUEST_IDLE */ 123 /* ECX: power management features */ 124 #define CPUPM_HV_CSTATE_MASK 0x000f /* deepest C-state */ 125 #define CPUPM_HV_C3_HPET 0x0010 /* C3 requires HPET */ 126 #define CPUPM_HV_CSTATE(f) ((f) & CPUPM_HV_CSTATE_MASK) 127 /* EDX: features3 */ 128 #define CPUID3_HV_MWAIT 0x0001 /* MWAIT */ 129 #define CPUID3_HV_XMM_HYPERCALL 0x0010 /* Hypercall input through 130 * XMM regs */ 131 #define CPUID3_HV_GUEST_IDLE 0x0020 /* guest idle */ 132 #define CPUID3_HV_NUMA 0x0080 /* NUMA distance query */ 133 #define CPUID3_HV_TIME_FREQ 0x0100 /* timer frequency query 134 * (TSC, LAPIC) */ 135 #define CPUID3_HV_MSR_CRASH 0x0400 /* MSRs for guest crash */ 136 137 #define CPUID_LEAF_HV_RECOMMENDS 0x40000004 138 #define CPUID_LEAF_HV_LIMITS 0x40000005 139 #define CPUID_LEAF_HV_HWFEATURES 0x40000006 140 141 /* 142 * Hyper-V Reference TSC 143 */ 144 struct hyperv_reftsc { 145 volatile uint32_t tsc_seq; 146 volatile uint32_t tsc_rsvd1; 147 volatile uint64_t tsc_scale; 148 volatile int64_t tsc_ofs; 149 } __packed __aligned(PAGE_SIZE); 150 CTASSERT(sizeof(struct hyperv_reftsc) == PAGE_SIZE); 151 152 /* 153 * Hyper-V message types 154 */ 155 #define HYPERV_MSGTYPE_NONE 0 156 #define HYPERV_MSGTYPE_CHANNEL 1 157 #define HYPERV_MSGTYPE_TIMER_EXPIRED 0x80000010 158 159 /* 160 * Hypercall status codes 161 */ 162 #define HYPERCALL_STATUS_SUCCESS 0x0000 163 164 /* 165 * Hypercall input values 166 */ 167 #define HYPERCALL_POST_MESSAGE 0x005c 168 169 /* 170 * Hypercall input parameters 171 */ 172 173 /* 174 * HYPERCALL_POST_MESSAGE 175 */ 176 #define HYPERCALL_POSTMSGIN_DSIZE_MAX 240 177 #define HYPERCALL_POSTMSGIN_SIZE 256 178 #define HYPERCALL_POSTMSGIN_ALIGN 8 179 180 struct hypercall_postmsg_in { 181 uint32_t hc_connid; 182 uint32_t hc_rsvd; 183 uint32_t hc_msgtype; /* HYPERV_MSGTYPE_ */ 184 uint32_t hc_dsize; 185 uint8_t hc_data[HYPERCALL_POSTMSGIN_DSIZE_MAX]; 186 } __packed; 187 CTASSERT(sizeof(struct hypercall_postmsg_in) == HYPERCALL_POSTMSGIN_SIZE); 188 189 #endif /* !_HYPERV_REG_H_ */ 190