sys/dev/hyperv/vmbus/hyperv_reg.h

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