| 1 | /* $Id: GIMHvInternal.h 53509 2014-12-11 12:14:54Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * GIM - Hyper-V, Internal header file.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2014 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 | #ifndef ___GIMHvInternal_h
|
|---|
| 19 | #define ___GIMHvInternal_h
|
|---|
| 20 |
|
|---|
| 21 | #include <VBox/vmm/gim.h>
|
|---|
| 22 | #include <VBox/vmm/cpum.h>
|
|---|
| 23 |
|
|---|
| 24 |
|
|---|
| 25 | /** @name Hyper-V base feature identification.
|
|---|
| 26 | * Features based on current partition privileges (per-VM).
|
|---|
| 27 | * @{
|
|---|
| 28 | */
|
|---|
| 29 | /** Virtual processor runtime MSR available. */
|
|---|
| 30 | #define GIM_HV_BASE_FEAT_VP_RUNTIME_MSR RT_BIT(0)
|
|---|
| 31 | /** Partition reference counter MSR available. */
|
|---|
| 32 | #define GIM_HV_BASE_FEAT_PART_TIME_REF_COUNT_MSR RT_BIT(1)
|
|---|
| 33 | /** Basic Synthetic Interrupt Controller MSRs available. */
|
|---|
| 34 | #define GIM_HV_BASE_FEAT_BASIC_SYNTH_IC RT_BIT(2)
|
|---|
| 35 | /** Synthetic Timer MSRs available. */
|
|---|
| 36 | #define GIM_HV_BASE_FEAT_SYNTH_TIMER_MSRS RT_BIT(3)
|
|---|
| 37 | /** APIC access MSRs (EOI, ICR, TPR) available. */
|
|---|
| 38 | #define GIM_HV_BASE_FEAT_APIC_ACCESS_MSRS RT_BIT(4)
|
|---|
| 39 | /** Hypercall MSRs available. */
|
|---|
| 40 | #define GIM_HV_BASE_FEAT_HYPERCALL_MSRS RT_BIT(5)
|
|---|
| 41 | /** Access to VCPU index MSR available. */
|
|---|
| 42 | #define GIM_HV_BASE_FEAT_VP_ID_MSR RT_BIT(6)
|
|---|
| 43 | /** Virtual system reset MSR available. */
|
|---|
| 44 | #define GIM_HV_BASE_FEAT_VIRT_SYS_RESET_MSR RT_BIT(7)
|
|---|
| 45 | /** Statistic pages MSRs available. */
|
|---|
| 46 | #define GIM_HV_BASE_FEAT_STAT_PAGES_MSR RT_BIT(8)
|
|---|
| 47 | /** Paritition reference TSC MSR available. */
|
|---|
| 48 | #define GIM_HV_BASE_FEAT_PART_REF_TSC_MSR RT_BIT(9)
|
|---|
| 49 | /** Virtual guest idle state MSR available. */
|
|---|
| 50 | #define GIM_HV_BASE_FEAT_GUEST_IDLE_STATE_MSR RT_BIT(10)
|
|---|
| 51 | /** Timer frequency MSRs (TSC and APIC) available. */
|
|---|
| 52 | #define GIM_HV_BASE_FEAT_TIMER_FREQ_MSRS RT_BIT(11)
|
|---|
| 53 | /** Debug MSRs available. */
|
|---|
| 54 | #define GIM_HV_BASE_FEAT_DEBUG_MSRS RT_BIT(12)
|
|---|
| 55 | /** @} */
|
|---|
| 56 |
|
|---|
| 57 | /** @name Hyper-V partition-creation feature identification.
|
|---|
| 58 | * Indicates flags specified during partition creation.
|
|---|
| 59 | * @{
|
|---|
| 60 | */
|
|---|
| 61 | /** Create partitions. */
|
|---|
| 62 | #define GIM_HV_PART_FLAGS_CREATE_PART RT_BIT(0)
|
|---|
| 63 | /** Access partition Id. */
|
|---|
| 64 | #define GIM_HV_PART_FLAGS_ACCESS_PART_ID RT_BIT(1)
|
|---|
| 65 | /** Access memory pool. */
|
|---|
| 66 | #define GIM_HV_PART_FLAGS_ACCESS_MEMORY_POOL RT_BIT(2)
|
|---|
| 67 | /** Adjust message buffers. */
|
|---|
| 68 | #define GIM_HV_PART_FLAGS_ADJUST_MSG_BUFFERS RT_BIT(3)
|
|---|
| 69 | /** Post messages. */
|
|---|
| 70 | #define GIM_HV_PART_FLAGS_POST_MSGS RT_BIT(4)
|
|---|
| 71 | /** Signal events. */
|
|---|
| 72 | #define GIM_HV_PART_FLAGS_SIGNAL_EVENTS RT_BIT(5)
|
|---|
| 73 | /** Create port. */
|
|---|
| 74 | #define GIM_HV_PART_FLAGS_CREATE_PORT RT_BIT(6)
|
|---|
| 75 | /** Connect port. */
|
|---|
| 76 | #define GIM_HV_PART_FLAGS_CONNECT_PORT RT_BIT(7)
|
|---|
| 77 | /** Access statistics. */
|
|---|
| 78 | #define GIM_HV_PART_FLAGS_ACCESS_STATS RT_BIT(8)
|
|---|
| 79 | /** Debugging.*/
|
|---|
| 80 | #define GIM_HV_PART_FLAGS_DEBUGGING RT_BIT(11)
|
|---|
| 81 | /** CPU management. */
|
|---|
| 82 | #define GIM_HV_PART_FLAGS_CPU_MGMT RT_BIT(12)
|
|---|
| 83 | /** CPU profiler. */
|
|---|
| 84 | #define GIM_HV_PART_FLAGS_CPU_PROFILER RT_BIT(13)
|
|---|
| 85 | /** Enable expanded stack walking. */
|
|---|
| 86 | #define GIM_HV_PART_FLAGS_EXPANDED_STACK_WALK RT_BIT(14)
|
|---|
| 87 | /** @} */
|
|---|
| 88 |
|
|---|
| 89 | /** @name Hyper-V power management feature identification.
|
|---|
| 90 | * @{
|
|---|
| 91 | */
|
|---|
| 92 | /** Maximum CPU power state C0. */
|
|---|
| 93 | #define GIM_HV_PM_MAX_CPU_POWER_STATE_C0 RT_BIT(0)
|
|---|
| 94 | /** Maximum CPU power state C1. */
|
|---|
| 95 | #define GIM_HV_PM_MAX_CPU_POWER_STATE_C1 RT_BIT(1)
|
|---|
| 96 | /** Maximum CPU power state C2. */
|
|---|
| 97 | #define GIM_HV_PM_MAX_CPU_POWER_STATE_C2 RT_BIT(2)
|
|---|
| 98 | /** Maximum CPU power state C3. */
|
|---|
| 99 | #define GIM_HV_PM_MAX_CPU_POWER_STATE_C3 RT_BIT(3)
|
|---|
| 100 | /** HPET is required to enter C3 power state. */
|
|---|
| 101 | #define GIM_HV_PM_HPET_REQD_FOR_C3 RT_BIT(4)
|
|---|
| 102 | /** @} */
|
|---|
| 103 |
|
|---|
| 104 | /** @name Hyper-V miscellaneous feature identification.
|
|---|
| 105 | * Miscellaneous features available for the current partition.
|
|---|
| 106 | * @{
|
|---|
| 107 | */
|
|---|
| 108 | /** MWAIT instruction available. */
|
|---|
| 109 | #define GIM_HV_MISC_FEAT_MWAIT RT_BIT(0)
|
|---|
| 110 | /** Guest debugging support available. */
|
|---|
| 111 | #define GIM_HV_MISC_FEAT_GUEST_DEBUGGING RT_BIT(1)
|
|---|
| 112 | /** Performance monitor support is available. */
|
|---|
| 113 | #define GIM_HV_MISC_FEAT_PERF_MON RT_BIT(2)
|
|---|
| 114 | /** Support for physical CPU dynamic partitioning events. */
|
|---|
| 115 | #define GIM_HV_MISC_FEAT_PCPU_DYN_PART_EVENT RT_BIT(3)
|
|---|
| 116 | /** Support for passing hypercall input parameter block via XMM registers. */
|
|---|
| 117 | #define GIM_HV_MISC_FEAT_XMM_HYPERCALL_INPUT RT_BIT(4)
|
|---|
| 118 | /** Support for virtual guest idle state. */
|
|---|
| 119 | #define GIM_HV_MISC_FEAT_GUEST_IDLE_STATE RT_BIT(5)
|
|---|
| 120 | /** Support for hypervisor sleep state. */
|
|---|
| 121 | #define GIM_HV_MISC_FEAT_HYPERVISOR_SLEEP_STATE RT_BIT(6)
|
|---|
| 122 | /** Support for querying NUMA distances. */
|
|---|
| 123 | #define GIM_HV_MISC_FEAT_QUERY_NUMA_DISTANCE RT_BIT(7)
|
|---|
| 124 | /** Support for determining timer frequencies. */
|
|---|
| 125 | #define GIM_HV_MISC_FEAT_TIMER_FREQ RT_BIT(8)
|
|---|
| 126 | /** Support for injecting synthetic machine checks. */
|
|---|
| 127 | #define GIM_HV_MISC_FEAT_INJECT_SYNTH_MC_XCPT RT_BIT(9)
|
|---|
| 128 | /** Support for guest crash MSRs. */
|
|---|
| 129 | #define GIM_HV_MISC_FEAT_GUEST_CRASH_MSRS RT_BIT(10)
|
|---|
| 130 | /** Support for debug MSRs. */
|
|---|
| 131 | #define GIM_HV_MISC_FEAT_DEBUG_MSRS RT_BIT(11)
|
|---|
| 132 | /** Npiep1 Available */ /** @todo What the heck is this? */
|
|---|
| 133 | #define GIM_HV_MISC_FEAT_NPIEP1 RT_BIT(12)
|
|---|
| 134 | /** Disable hypervisor available. */
|
|---|
| 135 | #define GIM_HV_MISC_FEAT_DISABLE_HYPERVISOR RT_BIT(13)
|
|---|
| 136 | /** @} */
|
|---|
| 137 |
|
|---|
| 138 | /** @name Hyper-V implementation recommendations.
|
|---|
| 139 | * Recommendations from the hypervisor for the guest for optimal performance.
|
|---|
| 140 | * @{
|
|---|
| 141 | */
|
|---|
| 142 | /** Use hypercall for address space switches rather than MOV CR3. */
|
|---|
| 143 | #define GIM_HV_HINT_HYPERCALL_FOR_PROCESS_SWITCH RT_BIT(0)
|
|---|
| 144 | /** Use hypercall for local TLB flushes rather than INVLPG/MOV CR3. */
|
|---|
| 145 | #define GIM_HV_HINT_HYPERCALL_FOR_TLB_FLUSH RT_BIT(1)
|
|---|
| 146 | /** Use hypercall for inter-CPU TLB flushes rather than IPIs. */
|
|---|
| 147 | #define GIM_HV_HINT_HYPERCALL_FOR_TLB_SHOOTDOWN RT_BIT(2)
|
|---|
| 148 | /** Use MSRs for APIC access (EOI, ICR, TPR) rather than MMIO. */
|
|---|
| 149 | #define GIM_HV_HINT_MSR_FOR_APIC_ACCESS RT_BIT(3)
|
|---|
| 150 | /** Use hypervisor provided MSR for a system reset. */
|
|---|
| 151 | #define GIM_HV_HINT_MSR_FOR_SYS_RESET RT_BIT(4)
|
|---|
| 152 | /** Relax timer-related checks (watchdogs/deadman timeouts) that rely on
|
|---|
| 153 | * timely deliver of external interrupts. */
|
|---|
| 154 | #define GIM_HV_HINT_RELAX_TIME_CHECKS RT_BIT(5)
|
|---|
| 155 | /** Use DMA remapping. */
|
|---|
| 156 | #define GIM_HV_HINT_DMA_REMAPPING RT_BIT(6)
|
|---|
| 157 | /** Use interrupt remapping. */
|
|---|
| 158 | #define GIM_HV_HINT_INTERRUPT_REMAPPING RT_BIT(7)
|
|---|
| 159 | /** Use X2APIC MSRs rather than MMIO. */
|
|---|
| 160 | #define GIM_HV_HINT_X2APIC_MSRS RT_BIT(8)
|
|---|
| 161 | /** Deprecate Auto EOI (end of interrupt). */
|
|---|
| 162 | #define GIM_HV_HINT_DEPRECATE_AUTO_EOI RT_BIT(9)
|
|---|
| 163 | /** @} */
|
|---|
| 164 |
|
|---|
| 165 |
|
|---|
| 166 | /** @name Hyper-V implementation hardware features.
|
|---|
| 167 | * Which hardware features are in use by the hypervisor.
|
|---|
| 168 | * @{
|
|---|
| 169 | */
|
|---|
| 170 | /** APIC overlay is used. */
|
|---|
| 171 | #define GIM_HV_HOST_FEAT_AVIC RT_BIT(0)
|
|---|
| 172 | /** MSR bitmaps is used. */
|
|---|
| 173 | #define GIM_HV_HOST_FEAT_MSR_BITMAP RT_BIT(1)
|
|---|
| 174 | /** Architectural performance counter supported. */
|
|---|
| 175 | #define GIM_HV_HOST_FEAT_PERF_COUNTER RT_BIT(2)
|
|---|
| 176 | /** Nested paging is used. */
|
|---|
| 177 | #define GIM_HV_HOST_FEAT_NESTED_PAGING RT_BIT(3)
|
|---|
| 178 | /** DMA remapping is used. */
|
|---|
| 179 | #define GIM_HV_HOST_FEAT_DMA_REMAPPING RT_BIT(4)
|
|---|
| 180 | /** Interrupt remapping is used. */
|
|---|
| 181 | #define GIM_HV_HOST_FEAT_INTERRUPT_REMAPPING RT_BIT(5)
|
|---|
| 182 | /** Memory patrol scrubber is present. */
|
|---|
| 183 | #define GIM_HV_HOST_FEAT_MEM_PATROL_SCRUBBER RT_BIT(6)
|
|---|
| 184 | /** @} */
|
|---|
| 185 |
|
|---|
| 186 |
|
|---|
| 187 | /** @name Hyper-V MSRs.
|
|---|
| 188 | * @{
|
|---|
| 189 | */
|
|---|
| 190 | /** Start of range 0. */
|
|---|
| 191 | #define MSR_GIM_HV_RANGE0_START UINT32_C(0x40000000)
|
|---|
| 192 | /** Guest OS identification (R/W) */
|
|---|
| 193 | #define MSR_GIM_HV_GUEST_OS_ID UINT32_C(0x40000000)
|
|---|
| 194 | /** Enable hypercall interface (R/W) */
|
|---|
| 195 | #define MSR_GIM_HV_HYPERCALL UINT32_C(0x40000001)
|
|---|
| 196 | /** Virtual processor's (VCPU) index (R) */
|
|---|
| 197 | #define MSR_GIM_HV_VP_INDEX UINT32_C(0x40000002)
|
|---|
| 198 | /** Reset operation (R/W) */
|
|---|
| 199 | #define MSR_GIM_HV_RESET UINT32_C(0x40000003)
|
|---|
| 200 | /** End of range 0. */
|
|---|
| 201 | #define MSR_GIM_HV_RANGE0_END MSR_GIM_HV_RESET
|
|---|
| 202 |
|
|---|
| 203 | /** Start of range 1. */
|
|---|
| 204 | #define MSR_GIM_HV_RANGE1_START UINT32_C(0x40000010)
|
|---|
| 205 | /** Virtual processor's (VCPU) runtime (R) */
|
|---|
| 206 | #define MSR_GIM_HV_VP_RUNTIME UINT32_C(0x40000010)
|
|---|
| 207 | /** End of range 1. */
|
|---|
| 208 | #define MSR_GIM_HV_RANGE1_END MSR_GIM_HV_VP_RUNTIME
|
|---|
| 209 |
|
|---|
| 210 | /** Start of range 2. */
|
|---|
| 211 | #define MSR_GIM_HV_RANGE2_START UINT32_C(0x40000020)
|
|---|
| 212 | /** Per-VM reference counter (R) */
|
|---|
| 213 | #define MSR_GIM_HV_TIME_REF_COUNT UINT32_C(0x40000020)
|
|---|
| 214 | /** Per-VM TSC page (R/W) */
|
|---|
| 215 | #define MSR_GIM_HV_REF_TSC UINT32_C(0x40000021)
|
|---|
| 216 | /** Frequency of TSC in Hz as reported by the hypervisor (R) */
|
|---|
| 217 | #define MSR_GIM_HV_TSC_FREQ UINT32_C(0x40000022)
|
|---|
| 218 | /** Frequency of LAPIC in Hz as reported by the hypervisor (R) */
|
|---|
| 219 | #define MSR_GIM_HV_APIC_FREQ UINT32_C(0x40000023)
|
|---|
| 220 | /** End of range 2. */
|
|---|
| 221 | #define MSR_GIM_HV_RANGE2_END MSR_GIM_HV_APIC_FREQ
|
|---|
| 222 |
|
|---|
| 223 | /** Start of range 3. */
|
|---|
| 224 | #define MSR_GIM_HV_RANGE3_START UINT32_C(0x40000070)
|
|---|
| 225 | /** Access to APIC EOI (End-Of-Interrupt) register (W) */
|
|---|
| 226 | #define MSR_GIM_HV_EOI UINT32_C(0x40000070)
|
|---|
| 227 | /** Access to APIC ICR (Interrupt Command) register (R/W) */
|
|---|
| 228 | #define MSR_GIM_HV_ICR UINT32_C(0x40000071)
|
|---|
| 229 | /** Access to APIC TPR (Task Priority) register (R/W) */
|
|---|
| 230 | #define MSR_GIM_HV_TPR UINT32_C(0x40000072)
|
|---|
| 231 | /** Enables lazy EOI processing (R/W) */
|
|---|
| 232 | #define MSR_GIM_HV_APIC_ASSIST_PAGE UINT32_C(0x40000073)
|
|---|
| 233 | /** End of range 3. */
|
|---|
| 234 | #define MSR_GIM_HV_RANGE3_END MSR_GIM_HV_APIC_ASSIST_PAGE
|
|---|
| 235 |
|
|---|
| 236 | /** Start of range 4. */
|
|---|
| 237 | #define MSR_GIM_HV_RANGE4_START UINT32_C(0x40000080)
|
|---|
| 238 | /** Control behaviour of synthetic interrupt controller (R/W) */
|
|---|
| 239 | #define MSR_GIM_HV_SCONTROL UINT32_C(0x40000080)
|
|---|
| 240 | /** Synthetic interrupt controller version (R) */
|
|---|
| 241 | #define MSR_GIM_HV_SVERSION UINT32_C(0x40000081)
|
|---|
| 242 | /** Base address of synthetic interrupt event flag (R/W) */
|
|---|
| 243 | #define MSR_GIM_HV_SIEFP UINT32_C(0x40000082)
|
|---|
| 244 | /** Base address of synthetic interrupt parameter page (R/W) */
|
|---|
| 245 | #define MSR_GIM_HV_SIMP UINT32_C(0x40000083)
|
|---|
| 246 | /** End-Of-Message in synthetic interrupt parameter page (W) */
|
|---|
| 247 | #define MSR_GIM_HV_EOM UINT32_C(0x40000084)
|
|---|
| 248 | /** End of range 4. */
|
|---|
| 249 | #define MSR_GIM_HV_RANGE4_END MSR_GIM_HV_EOM
|
|---|
| 250 |
|
|---|
| 251 | /** Start of range 5. */
|
|---|
| 252 | #define MSR_GIM_HV_RANGE5_START UINT32_C(0x40000090)
|
|---|
| 253 | /** Configures synthetic interrupt source 0 (R/W) */
|
|---|
| 254 | #define MSR_GIM_HV_SINT0 UINT32_C(0x40000090)
|
|---|
| 255 | /** Configures synthetic interrupt source 1 (R/W) */
|
|---|
| 256 | #define MSR_GIM_HV_SINT1 UINT32_C(0x40000091)
|
|---|
| 257 | /** Configures synthetic interrupt source 2 (R/W) */
|
|---|
| 258 | #define MSR_GIM_HV_SINT2 UINT32_C(0x40000092)
|
|---|
| 259 | /** Configures synthetic interrupt source 3 (R/W) */
|
|---|
| 260 | #define MSR_GIM_HV_SINT3 UINT32_C(0x40000093)
|
|---|
| 261 | /** Configures synthetic interrupt source 4 (R/W) */
|
|---|
| 262 | #define MSR_GIM_HV_SINT4 UINT32_C(0x40000094)
|
|---|
| 263 | /** Configures synthetic interrupt source 5 (R/W) */
|
|---|
| 264 | #define MSR_GIM_HV_SINT5 UINT32_C(0x40000095)
|
|---|
| 265 | /** Configures synthetic interrupt source 6 (R/W) */
|
|---|
| 266 | #define MSR_GIM_HV_SINT6 UINT32_C(0x40000096)
|
|---|
| 267 | /** Configures synthetic interrupt source 7 (R/W) */
|
|---|
| 268 | #define MSR_GIM_HV_SINT7 UINT32_C(0x40000097)
|
|---|
| 269 | /** Configures synthetic interrupt source 8 (R/W) */
|
|---|
| 270 | #define MSR_GIM_HV_SINT8 UINT32_C(0x40000098)
|
|---|
| 271 | /** Configures synthetic interrupt source 9 (R/W) */
|
|---|
| 272 | #define MSR_GIM_HV_SINT9 UINT32_C(0x40000099)
|
|---|
| 273 | /** Configures synthetic interrupt source 10 (R/W) */
|
|---|
| 274 | #define MSR_GIM_HV_SINT10 UINT32_C(0x4000009A)
|
|---|
| 275 | /** Configures synthetic interrupt source 11 (R/W) */
|
|---|
| 276 | #define MSR_GIM_HV_SINT11 UINT32_C(0x4000009B)
|
|---|
| 277 | /** Configures synthetic interrupt source 12 (R/W) */
|
|---|
| 278 | #define MSR_GIM_HV_SINT12 UINT32_C(0x4000009C)
|
|---|
| 279 | /** Configures synthetic interrupt source 13 (R/W) */
|
|---|
| 280 | #define MSR_GIM_HV_SINT13 UINT32_C(0x4000009D)
|
|---|
| 281 | /** Configures synthetic interrupt source 14 (R/W) */
|
|---|
| 282 | #define MSR_GIM_HV_SINT14 UINT32_C(0x4000009E)
|
|---|
| 283 | /** Configures synthetic interrupt source 15 (R/W) */
|
|---|
| 284 | #define MSR_GIM_HV_SINT15 UINT32_C(0x4000009F)
|
|---|
| 285 | /** End of range 5. */
|
|---|
| 286 | #define MSR_GIM_HV_RANGE5_END MSR_GIM_HV_SINT15
|
|---|
| 287 |
|
|---|
| 288 | /** Start of range 6. */
|
|---|
| 289 | #define MSR_GIM_HV_RANGE6_START UINT32_C(0x400000B0)
|
|---|
| 290 | /** Configures register for synthetic timer 0 (R/W) */
|
|---|
| 291 | #define MSR_GIM_HV_STIMER0_CONFIG UINT32_C(0x400000B0)
|
|---|
| 292 | /** Expiration time or period for synthetic timer 0 (R/W) */
|
|---|
| 293 | #define MSR_GIM_HV_STIMER0_COUNT UINT32_C(0x400000B1)
|
|---|
| 294 | /** Configures register for synthetic timer 1 (R/W) */
|
|---|
| 295 | #define MSR_GIM_HV_STIMER1_CONFIG UINT32_C(0x400000B2)
|
|---|
| 296 | /** Expiration time or period for synthetic timer 1 (R/W) */
|
|---|
| 297 | #define MSR_GIM_HV_STIMER1_COUNT UINT32_C(0x400000B3)
|
|---|
| 298 | /** Configures register for synthetic timer 2 (R/W) */
|
|---|
| 299 | #define MSR_GIM_HV_STIMER2_CONFIG UINT32_C(0x400000B4)
|
|---|
| 300 | /** Expiration time or period for synthetic timer 2 (R/W) */
|
|---|
| 301 | #define MSR_GIM_HV_STIMER2_COUNT UINT32_C(0x400000B5)
|
|---|
| 302 | /** Configures register for synthetic timer 3 (R/W) */
|
|---|
| 303 | #define MSR_GIM_HV_STIMER3_CONFIG UINT32_C(0x400000B6)
|
|---|
| 304 | /** Expiration time or period for synthetic timer 3 (R/W) */
|
|---|
| 305 | #define MSR_GIM_HV_STIMER3_COUNT UINT32_C(0x400000B7)
|
|---|
| 306 | /** End of range 6. */
|
|---|
| 307 | #define MSR_GIM_HV_RANGE6_END MSR_GIM_HV_STIMER3_COUNT
|
|---|
| 308 |
|
|---|
| 309 | /** Start of range 7. */
|
|---|
| 310 | #define MSR_GIM_HV_RANGE7_START UINT32_C(0x400000C1)
|
|---|
| 311 | /** Trigger to transition to power state C1 (R) */
|
|---|
| 312 | #define MSR_GIM_HV_POWER_STATE_TRIGGER_C1 UINT32_C(0x400000C1)
|
|---|
| 313 | /** Trigger to transition to power state C2 (R) */
|
|---|
| 314 | #define MSR_GIM_HV_POWER_STATE_TRIGGER_C2 UINT32_C(0x400000C2)
|
|---|
| 315 | /** Trigger to transition to power state C3 (R) */
|
|---|
| 316 | #define MSR_GIM_HV_POWER_STATE_TRIGGER_C3 UINT32_C(0x400000C3)
|
|---|
| 317 | /** End of range 7. */
|
|---|
| 318 | #define MSR_GIM_HV_RANGE7_END MSR_GIM_HV_POWER_STATE_TRIGGER_C3
|
|---|
| 319 |
|
|---|
| 320 | /** Start of range 8. */
|
|---|
| 321 | #define MSR_GIM_HV_RANGE8_START UINT32_C(0x400000D1)
|
|---|
| 322 | /** Configure the recipe for power state transitions to C1 (R/W) */
|
|---|
| 323 | #define MSR_GIM_HV_POWER_STATE_CONFIG_C1 UINT32_C(0x400000D1)
|
|---|
| 324 | /** Configure the recipe for power state transitions to C2 (R/W) */
|
|---|
| 325 | #define MSR_GIM_HV_POWER_STATE_CONFIG_C2 UINT32_C(0x400000D2)
|
|---|
| 326 | /** Configure the recipe for power state transitions to C3 (R/W) */
|
|---|
| 327 | #define MSR_GIM_HV_POWER_STATE_CONFIG_C3 UINT32_C(0x400000D3)
|
|---|
| 328 | /** End of range 8. */
|
|---|
| 329 | #define MSR_GIM_HV_RANGE8_END MSR_GIM_HV_POWER_STATE_CONFIG_C3
|
|---|
| 330 |
|
|---|
| 331 | /** Start of range 9. */
|
|---|
| 332 | #define MSR_GIM_HV_RANGE9_START UINT32_C(0x400000E0)
|
|---|
| 333 | /** Map the guest's retail partition stats page (R/W) */
|
|---|
| 334 | #define MSR_GIM_HV_STATS_PART_RETAIL_PAGE UINT32_C(0x400000E0)
|
|---|
| 335 | /** Map the guest's internal partition stats page (R/W) */
|
|---|
| 336 | #define MSR_GIM_HV_STATS_PART_INTERNAL_PAGE UINT32_C(0x400000E1)
|
|---|
| 337 | /** Map the guest's retail VP stats page (R/W) */
|
|---|
| 338 | #define MSR_GIM_HV_STATS_VP_RETAIL_PAGE UINT32_C(0x400000E2)
|
|---|
| 339 | /** Map the guest's internal VP stats page (R/W) */
|
|---|
| 340 | #define MSR_GIM_HV_STATS_VP_INTERNAL_PAGE UINT32_C(0x400000E3)
|
|---|
| 341 | /** End of range 9. */
|
|---|
| 342 | #define MSR_GIM_HV_RANGE9_END MSR_GIM_HV_STATS_VP_INTERNAL_PAGE
|
|---|
| 343 |
|
|---|
| 344 | /** Start of range 10. */
|
|---|
| 345 | #define MSR_GIM_HV_RANGE10_START UINT32_C(0x400000F0)
|
|---|
| 346 | /** Trigger the guest's transition to idle power state (R) */
|
|---|
| 347 | #define MSR_GIM_HV_GUEST_IDLE UINT32_C(0x400000F0)
|
|---|
| 348 | /** Synthetic debug control. */
|
|---|
| 349 | #define MSR_GIM_HV_SYNTH_DEBUG_CONTROL UINT32_C(0x400000F1)
|
|---|
| 350 | /** Synthetic debug status. */
|
|---|
| 351 | #define MSR_GIM_HV_SYNTH_DEBUG_STATUS UINT32_C(0x400000F2)
|
|---|
| 352 | /** Synthetic debug send buffer. */
|
|---|
| 353 | #define MSR_GIM_HV_SYNTH_DEBUG_SEND_BUFFER UINT32_C(0x400000F3)
|
|---|
| 354 | /** Synthetic debug receive buffer. */
|
|---|
| 355 | #define MSR_GIM_HV_SYNTH_DEBUG_RECEIVE_BUFFER UINT32_C(0x400000F4)
|
|---|
| 356 | /** Synthetic debug pending buffer. */
|
|---|
| 357 | #define MSR_GIM_HV_SYNTH_DEBUG_PENDING_BUFFER UINT32_C(0x400000F5)
|
|---|
| 358 | /** End of range 10. */
|
|---|
| 359 | #define MSR_GIM_HV_RANGE10_END MSR_GIM_HV_SYNTH_DEBUG_PENDING_BUFFER
|
|---|
| 360 |
|
|---|
| 361 | /** Start of range 11. */
|
|---|
| 362 | #define MSR_GIM_HV_RANGE11_START UINT32_C(0x40000100)
|
|---|
| 363 | /** Guest crash MSR 0. */
|
|---|
| 364 | #define MSR_GIM_HV_CRASH_P0 UINT32_C(0x40000100)
|
|---|
| 365 | /** Guest crash MSR 1. */
|
|---|
| 366 | #define MSR_GIM_HV_CRASH_P1 UINT32_C(0x40000101)
|
|---|
| 367 | /** Guest crash MSR 2. */
|
|---|
| 368 | #define MSR_GIM_HV_CRASH_P2 UINT32_C(0x40000102)
|
|---|
| 369 | /** Guest crash MSR 3. */
|
|---|
| 370 | #define MSR_GIM_HV_CRASH_P3 UINT32_C(0x40000103)
|
|---|
| 371 | /** Guest crash MSR 4. */
|
|---|
| 372 | #define MSR_GIM_HV_CRASH_P4 UINT32_C(0x40000104)
|
|---|
| 373 | /** Guest crash control. */
|
|---|
| 374 | #define MSR_GIM_HV_CRASH_CTL UINT32_C(0x40000105)
|
|---|
| 375 | /** End of range 11. */
|
|---|
| 376 | #define MSR_GIM_HV_RANGE11_END MSR_GIM_HV_CRASH_CTL
|
|---|
| 377 | /** @} */
|
|---|
| 378 |
|
|---|
| 379 | AssertCompile(MSR_GIM_HV_RANGE0_START <= MSR_GIM_HV_RANGE0_END);
|
|---|
| 380 | AssertCompile(MSR_GIM_HV_RANGE1_START <= MSR_GIM_HV_RANGE1_END);
|
|---|
| 381 | AssertCompile(MSR_GIM_HV_RANGE2_START <= MSR_GIM_HV_RANGE2_END);
|
|---|
| 382 | AssertCompile(MSR_GIM_HV_RANGE3_START <= MSR_GIM_HV_RANGE3_END);
|
|---|
| 383 | AssertCompile(MSR_GIM_HV_RANGE4_START <= MSR_GIM_HV_RANGE4_END);
|
|---|
| 384 | AssertCompile(MSR_GIM_HV_RANGE5_START <= MSR_GIM_HV_RANGE5_END);
|
|---|
| 385 | AssertCompile(MSR_GIM_HV_RANGE6_START <= MSR_GIM_HV_RANGE6_END);
|
|---|
| 386 | AssertCompile(MSR_GIM_HV_RANGE7_START <= MSR_GIM_HV_RANGE7_END);
|
|---|
| 387 | AssertCompile(MSR_GIM_HV_RANGE8_START <= MSR_GIM_HV_RANGE8_END);
|
|---|
| 388 | AssertCompile(MSR_GIM_HV_RANGE9_START <= MSR_GIM_HV_RANGE9_END);
|
|---|
| 389 | AssertCompile(MSR_GIM_HV_RANGE10_START <= MSR_GIM_HV_RANGE10_END);
|
|---|
| 390 | AssertCompile(MSR_GIM_HV_RANGE11_START <= MSR_GIM_HV_RANGE11_END);
|
|---|
| 391 |
|
|---|
| 392 | /** @name Hyper-V MSR - Reset (MSR_GIM_HV_RESET).
|
|---|
| 393 | * @{
|
|---|
| 394 | */
|
|---|
| 395 | /** The hypercall enable bit. */
|
|---|
| 396 | #define MSR_GIM_HV_RESET_BIT RT_BIT_64(0)
|
|---|
| 397 | /** Whether the hypercall-page is enabled or not. */
|
|---|
| 398 | #define MSR_GIM_HV_RESET_IS_SET(a) RT_BOOL((a) & MSR_GIM_HV_RESET_BIT)
|
|---|
| 399 | /** @} */
|
|---|
| 400 |
|
|---|
| 401 | /** @name Hyper-V MSR - Hypercall (MSR_GIM_HV_HYPERCALL).
|
|---|
| 402 | * @{
|
|---|
| 403 | */
|
|---|
| 404 | /** Guest-physical page frame number of the hypercall-page. */
|
|---|
| 405 | #define MSR_GIM_HV_HYPERCALL_GUEST_PFN(a) ((a) >> 12)
|
|---|
| 406 | /** The hypercall enable bit. */
|
|---|
| 407 | #define MSR_GIM_HV_HYPERCALL_ENABLE_BIT RT_BIT_64(0)
|
|---|
| 408 | /** Whether the hypercall-page is enabled or not. */
|
|---|
| 409 | #define MSR_GIM_HV_HYPERCALL_IS_ENABLED(a) RT_BOOL((a) & MSR_GIM_HV_HYPERCALL_ENABLE_BIT)
|
|---|
| 410 | /** @} */
|
|---|
| 411 |
|
|---|
| 412 | /** @name Hyper-V MSR - Reference TSC (MSR_GIM_HV_REF_TSC).
|
|---|
| 413 | * @{
|
|---|
| 414 | */
|
|---|
| 415 | /** Guest-physical page frame number of the TSC-page. */
|
|---|
| 416 | #define MSR_GIM_HV_REF_TSC_GUEST_PFN(a) ((a) >> 12)
|
|---|
| 417 | /** The TSC-page enable bit. */
|
|---|
| 418 | #define MSR_GIM_HV_REF_TSC_ENABLE_BIT RT_BIT_64(0)
|
|---|
| 419 | /** Whether the TSC-page is enabled or not. */
|
|---|
| 420 | #define MSR_GIM_HV_REF_TSC_IS_ENABLED(a) RT_BOOL((a) & MSR_GIM_HV_REF_TSC_ENABLE_BIT)
|
|---|
| 421 | /** @} */
|
|---|
| 422 |
|
|---|
| 423 | /** Hyper-V page size. */
|
|---|
| 424 | #define GIM_HV_PAGE_SIZE 0x1000
|
|---|
| 425 |
|
|---|
| 426 | /**
|
|---|
| 427 | * MMIO2 region indices.
|
|---|
| 428 | */
|
|---|
| 429 | /** The hypercall page region. */
|
|---|
| 430 | #define GIM_HV_HYPERCALL_PAGE_REGION_IDX UINT8_C(0)
|
|---|
| 431 | /** The TSC page region. */
|
|---|
| 432 | #define GIM_HV_REF_TSC_PAGE_REGION_IDX UINT8_C(1)
|
|---|
| 433 | /** The maximum region index (must be <= UINT8_MAX). */
|
|---|
| 434 | #define GIM_HV_REGION_IDX_MAX GIM_HV_REF_TSC_PAGE_REGION_IDX
|
|---|
| 435 |
|
|---|
| 436 | /**
|
|---|
| 437 | * Hyper-V TSC (HV_REFERENCE_TSC_PAGE) structure placed in the TSC reference
|
|---|
| 438 | * page.
|
|---|
| 439 | */
|
|---|
| 440 | typedef struct GIMHVREFTSC
|
|---|
| 441 | {
|
|---|
| 442 | uint32_t u32TscSequence;
|
|---|
| 443 | uint32_t uReserved0;
|
|---|
| 444 | uint64_t u64TscScale;
|
|---|
| 445 | int64_t i64TscOffset;
|
|---|
| 446 | } GIMHVTSCPAGE;
|
|---|
| 447 | /** Pointer to Hyper-V reference TSC. */
|
|---|
| 448 | typedef GIMHVREFTSC *PGIMHVREFTSC;
|
|---|
| 449 | /** Pointer to a const Hyper-V reference TSC. */
|
|---|
| 450 | typedef GIMHVREFTSC const *PCGIMHVREFTSC;
|
|---|
| 451 |
|
|---|
| 452 |
|
|---|
| 453 | /**
|
|---|
| 454 | * GIM Hyper-V VM Instance data.
|
|---|
| 455 | * Changes to this must checked against the padding of the gim union in VM!
|
|---|
| 456 | */
|
|---|
| 457 | typedef struct GIMHV
|
|---|
| 458 | {
|
|---|
| 459 | /** Guest OS identity MSR. */
|
|---|
| 460 | uint64_t u64GuestOsIdMsr;
|
|---|
| 461 | /** Hypercall MSR. */
|
|---|
| 462 | uint64_t u64HypercallMsr;
|
|---|
| 463 | /** Reference TSC page MSR. */
|
|---|
| 464 | uint64_t u64TscPageMsr;
|
|---|
| 465 |
|
|---|
| 466 | /** Basic features. */
|
|---|
| 467 | uint32_t uBaseFeat;
|
|---|
| 468 | /** Partition flags. */
|
|---|
| 469 | uint32_t uPartFlags;
|
|---|
| 470 | /** Power management features. */
|
|---|
| 471 | uint32_t uPowMgmtFeat;
|
|---|
| 472 | /** Miscellaneous features. */
|
|---|
| 473 | uint32_t uMiscFeat;
|
|---|
| 474 | /** Hypervisor hints to the guest. */
|
|---|
| 475 | uint32_t uHyperHints;
|
|---|
| 476 | /** Hypervisor capabilities. */
|
|---|
| 477 | uint32_t uHyperCaps;
|
|---|
| 478 |
|
|---|
| 479 | /** Per-VM R0 Spinlock for protecting EMT writes to the TSC page. */
|
|---|
| 480 | RTSPINLOCK hSpinlockR0;
|
|---|
| 481 | #if HC_ARCH_BITS == 32
|
|---|
| 482 | uint32_t u32Alignment1;
|
|---|
| 483 | #endif
|
|---|
| 484 |
|
|---|
| 485 | /** Array of MMIO2 regions. */
|
|---|
| 486 | GIMMMIO2REGION aMmio2Regions[GIM_HV_REGION_IDX_MAX + 1];
|
|---|
| 487 | } GIMHV;
|
|---|
| 488 | /** Pointer to per-VM GIM Hyper-V instance data. */
|
|---|
| 489 | typedef GIMHV *PGIMHV;
|
|---|
| 490 | /** Pointer to const per-VM GIM Hyper-V instance data. */
|
|---|
| 491 | typedef GIMHV const *PCGIMHV;
|
|---|
| 492 | AssertCompileMemberAlignment(GIMHV, aMmio2Regions, 8);
|
|---|
| 493 | AssertCompileMemberAlignment(GIMHV, hSpinlockR0, sizeof(uintptr_t));
|
|---|
| 494 |
|
|---|
| 495 | RT_C_DECLS_BEGIN
|
|---|
| 496 |
|
|---|
| 497 | /** @todo r=bird: Internal header, internal prefix: s/GIM\(R.|\)Hv/gim\1Hv/g */
|
|---|
| 498 |
|
|---|
| 499 | #ifdef IN_RING0
|
|---|
| 500 | VMMR0_INT_DECL(int) GIMR0HvInitVM(PVM pVM);
|
|---|
| 501 | VMMR0_INT_DECL(int) GIMR0HvTermVM(PVM pVM);
|
|---|
| 502 | VMMR0_INT_DECL(int) GIMR0HvUpdateParavirtTsc(PVM pVM, uint64_t u64Offset);
|
|---|
| 503 | #endif /* IN_RING0 */
|
|---|
| 504 |
|
|---|
| 505 | #ifdef IN_RING3
|
|---|
| 506 | VMMR3_INT_DECL(int) GIMR3HvInit(PVM pVM);
|
|---|
| 507 | VMMR3_INT_DECL(int) GIMR3HvInitCompleted(PVM pVM);
|
|---|
| 508 | VMMR3_INT_DECL(int) GIMR3HvTerm(PVM pVM);
|
|---|
| 509 | VMMR3_INT_DECL(void) GIMR3HvRelocate(PVM pVM, RTGCINTPTR offDelta);
|
|---|
| 510 | VMMR3_INT_DECL(void) GIMR3HvReset(PVM pVM);
|
|---|
| 511 | VMMR3_INT_DECL(PGIMMMIO2REGION) GIMR3HvGetMmio2Regions(PVM pVM, uint32_t *pcRegions);
|
|---|
| 512 | VMMR3_INT_DECL(int) GIMR3HvSave(PVM pVM, PSSMHANDLE pSSM);
|
|---|
| 513 | VMMR3_INT_DECL(int) GIMR3HvLoad(PVM pVM, PSSMHANDLE pSSM, uint32_t uSSMVersion);
|
|---|
| 514 |
|
|---|
| 515 | VMMR3_INT_DECL(int) GIMR3HvDisableTscPage(PVM pVM);
|
|---|
| 516 | VMMR3_INT_DECL(int) GIMR3HvEnableTscPage(PVM pVM, RTGCPHYS GCPhysTscPage, bool fUseThisTscSequence, uint32_t uTscSequence);
|
|---|
| 517 | VMMR3_INT_DECL(int) GIMR3HvDisableHypercallPage(PVM pVM);
|
|---|
| 518 | VMMR3_INT_DECL(int) GIMR3HvEnableHypercallPage(PVM pVM, RTGCPHYS GCPhysHypercallPage);
|
|---|
| 519 | #endif /* IN_RING3 */
|
|---|
| 520 |
|
|---|
| 521 | VMM_INT_DECL(bool) GIMHvIsParavirtTscEnabled(PVM pVM);
|
|---|
| 522 | VMM_INT_DECL(bool) GIMHvAreHypercallsEnabled(PVMCPU pVCpu);
|
|---|
| 523 | VMM_INT_DECL(int) GIMHvHypercall(PVMCPU pVCpu, PCPUMCTX pCtx);
|
|---|
| 524 | VMM_INT_DECL(VBOXSTRICTRC) GIMHvReadMsr(PVMCPU pVCpu, uint32_t idMsr, PCCPUMMSRRANGE pRange, uint64_t *puValue);
|
|---|
| 525 | VMM_INT_DECL(VBOXSTRICTRC) GIMHvWriteMsr(PVMCPU pVCpu, uint32_t idMsr, PCCPUMMSRRANGE pRange, uint64_t uRawValue);
|
|---|
| 526 |
|
|---|
| 527 | RT_C_DECLS_END
|
|---|
| 528 |
|
|---|
| 529 | #endif
|
|---|
| 530 |
|
|---|
