include/standard-headers/asm-x86/hyperv.h

   1 #ifndef _ASM_X86_HYPERV_H
   2 #define _ASM_X86_HYPERV_H
   3
   4 #include "standard-headers/linux/types.h"
   5
   6 /*
   7  * The below CPUID leaves are present if VersionAndFeatures.HypervisorPresent
   8  * is set by CPUID(HvCpuIdFunctionVersionAndFeatures).
   9  */
  10 #define HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS   0x40000000
  11 #define HYPERV_CPUID_INTERFACE                  0x40000001
  12 #define HYPERV_CPUID_VERSION                    0x40000002
  13 #define HYPERV_CPUID_FEATURES                   0x40000003
  14 #define HYPERV_CPUID_ENLIGHTMENT_INFO           0x40000004
  15 #define HYPERV_CPUID_IMPLEMENT_LIMITS           0x40000005
  16
  17 #define HYPERV_HYPERVISOR_PRESENT_BIT           0x80000000
  18 #define HYPERV_CPUID_MIN                        0x40000005
  19 #define HYPERV_CPUID_MAX                        0x4000ffff
  20
  21 /*
  22  * Feature identification. EAX indicates which features are available
  23  * to the partition based upon the current partition privileges.
  24  */
  25
  26 /* VP Runtime (HV_X64_MSR_VP_RUNTIME) available */
  27 #define HV_X64_MSR_VP_RUNTIME_AVAILABLE         (1 << 0)
  28 /* Partition Reference Counter (HV_X64_MSR_TIME_REF_COUNT) available*/
  29 #define HV_X64_MSR_TIME_REF_COUNT_AVAILABLE     (1 << 1)
  30 /* Partition reference TSC MSR is available */
  31 #define HV_X64_MSR_REFERENCE_TSC_AVAILABLE              (1 << 9)
  32
  33 /* A partition's reference time stamp counter (TSC) page */
  34 #define HV_X64_MSR_REFERENCE_TSC                0x40000021
  35
  36 /*
  37  * There is a single feature flag that signifies if the partition has access
  38  * to MSRs with local APIC and TSC frequencies.
  39  */
  40 #define HV_X64_ACCESS_FREQUENCY_MSRS            (1 << 11)
  41
  42 /*
  43  * Basic SynIC MSRs (HV_X64_MSR_SCONTROL through HV_X64_MSR_EOM
  44  * and HV_X64_MSR_SINT0 through HV_X64_MSR_SINT15) available
  45  */
  46 #define HV_X64_MSR_SYNIC_AVAILABLE              (1 << 2)
  47 /*
  48  * Synthetic Timer MSRs (HV_X64_MSR_STIMER0_CONFIG through
  49  * HV_X64_MSR_STIMER3_COUNT) available
  50  */
  51 #define HV_X64_MSR_SYNTIMER_AVAILABLE           (1 << 3)
  52 /*
  53  * APIC access MSRs (HV_X64_MSR_EOI, HV_X64_MSR_ICR and HV_X64_MSR_TPR)
  54  * are available
  55  */
  56 #define HV_X64_MSR_APIC_ACCESS_AVAILABLE        (1 << 4)
  57 /* Hypercall MSRs (HV_X64_MSR_GUEST_OS_ID and HV_X64_MSR_HYPERCALL) available*/
  58 #define HV_X64_MSR_HYPERCALL_AVAILABLE          (1 << 5)
  59 /* Access virtual processor index MSR (HV_X64_MSR_VP_INDEX) available*/
  60 #define HV_X64_MSR_VP_INDEX_AVAILABLE           (1 << 6)
  61 /* Virtual system reset MSR (HV_X64_MSR_RESET) is available*/
  62 #define HV_X64_MSR_RESET_AVAILABLE              (1 << 7)
  63  /*
  64   * Access statistics pages MSRs (HV_X64_MSR_STATS_PARTITION_RETAIL_PAGE,
  65   * HV_X64_MSR_STATS_PARTITION_INTERNAL_PAGE, HV_X64_MSR_STATS_VP_RETAIL_PAGE,
  66   * HV_X64_MSR_STATS_VP_INTERNAL_PAGE) available
  67   */
  68 #define HV_X64_MSR_STAT_PAGES_AVAILABLE         (1 << 8)
  69
  70 /* Frequency MSRs available */
  71 #define HV_FEATURE_FREQUENCY_MSRS_AVAILABLE     (1 << 8)
  72
  73 /* Crash MSR available */
  74 #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE (1 << 10)
  75
  76 /*
  77  * Feature identification: EBX indicates which flags were specified at
  78  * partition creation. The format is the same as the partition creation
  79  * flag structure defined in section Partition Creation Flags.
  80  */
  81 #define HV_X64_CREATE_PARTITIONS                (1 << 0)
  82 #define HV_X64_ACCESS_PARTITION_ID              (1 << 1)
  83 #define HV_X64_ACCESS_MEMORY_POOL               (1 << 2)
  84 #define HV_X64_ADJUST_MESSAGE_BUFFERS           (1 << 3)
  85 #define HV_X64_POST_MESSAGES                    (1 << 4)
  86 #define HV_X64_SIGNAL_EVENTS                    (1 << 5)
  87 #define HV_X64_CREATE_PORT                      (1 << 6)
  88 #define HV_X64_CONNECT_PORT                     (1 << 7)
  89 #define HV_X64_ACCESS_STATS                     (1 << 8)
  90 #define HV_X64_DEBUGGING                        (1 << 11)
  91 #define HV_X64_CPU_POWER_MANAGEMENT             (1 << 12)
  92 #define HV_X64_CONFIGURE_PROFILER               (1 << 13)
  93
  94 /*
  95  * Feature identification. EDX indicates which miscellaneous features
  96  * are available to the partition.
  97  */
  98 /* The MWAIT instruction is available (per section MONITOR / MWAIT) */
  99 #define HV_X64_MWAIT_AVAILABLE                          (1 << 0)
 100 /* Guest debugging support is available */
 101 #define HV_X64_GUEST_DEBUGGING_AVAILABLE                (1 << 1)
 102 /* Performance Monitor support is available*/
 103 #define HV_X64_PERF_MONITOR_AVAILABLE                   (1 << 2)
 104 /* Support for physical CPU dynamic partitioning events is available*/
 105 #define HV_X64_CPU_DYNAMIC_PARTITIONING_AVAILABLE       (1 << 3)
 106 /*
 107  * Support for passing hypercall input parameter block via XMM
 108  * registers is available
 109  */
 110 #define HV_X64_HYPERCALL_PARAMS_XMM_AVAILABLE           (1 << 4)
 111 /* Support for a virtual guest idle state is available */
 112 #define HV_X64_GUEST_IDLE_STATE_AVAILABLE               (1 << 5)
 113 /* Guest crash data handler available */
 114 #define HV_X64_GUEST_CRASH_MSR_AVAILABLE                (1 << 10)
 115
 116 /*
 117  * Implementation recommendations. Indicates which behaviors the hypervisor
 118  * recommends the OS implement for optimal performance.
 119  */
 120  /*
 121   * Recommend using hypercall for address space switches rather
 122   * than MOV to CR3 instruction
 123   */
 124 #define HV_X64_AS_SWITCH_RECOMMENDED            (1 << 0)
 125 /* Recommend using hypercall for local TLB flushes rather
 126  * than INVLPG or MOV to CR3 instructions */
 127 #define HV_X64_LOCAL_TLB_FLUSH_RECOMMENDED      (1 << 1)
 128 /*
 129  * Recommend using hypercall for remote TLB flushes rather
 130  * than inter-processor interrupts
 131  */
 132 #define HV_X64_REMOTE_TLB_FLUSH_RECOMMENDED     (1 << 2)
 133 /*
 134  * Recommend using MSRs for accessing APIC registers
 135  * EOI, ICR and TPR rather than their memory-mapped counterparts
 136  */
 137 #define HV_X64_APIC_ACCESS_RECOMMENDED          (1 << 3)
 138 /* Recommend using the hypervisor-provided MSR to initiate a system RESET */
 139 #define HV_X64_SYSTEM_RESET_RECOMMENDED         (1 << 4)
 140 /*
 141  * Recommend using relaxed timing for this partition. If used,
 142  * the VM should disable any watchdog timeouts that rely on the
 143  * timely delivery of external interrupts
 144  */
 145 #define HV_X64_RELAXED_TIMING_RECOMMENDED       (1 << 5)
 146
 147 /*
 148  * Virtual APIC support
 149  */
 150 #define HV_X64_DEPRECATING_AEOI_RECOMMENDED     (1 << 9)
 151
 152 /*
 153  * HV_VP_SET available
 154  */
 155 #define HV_X64_EX_PROCESSOR_MASKS_RECOMMENDED   (1 << 11)
 156
 157
 158 /*
 159  * Crash notification flag.
 160  */
 161 #define HV_CRASH_CTL_CRASH_NOTIFY (1ULL << 63)
 162
 163 /* MSR used to identify the guest OS. */
 164 #define HV_X64_MSR_GUEST_OS_ID                  0x40000000
 165
 166 /* MSR used to setup pages used to communicate with the hypervisor. */
 167 #define HV_X64_MSR_HYPERCALL                    0x40000001
 168
 169 /* MSR used to provide vcpu index */
 170 #define HV_X64_MSR_VP_INDEX                     0x40000002
 171
 172 /* MSR used to reset the guest OS. */
 173 #define HV_X64_MSR_RESET                        0x40000003
 174
 175 /* MSR used to provide vcpu runtime in 100ns units */
 176 #define HV_X64_MSR_VP_RUNTIME                   0x40000010
 177
 178 /* MSR used to read the per-partition time reference counter */
 179 #define HV_X64_MSR_TIME_REF_COUNT               0x40000020
 180
 181 /* MSR used to retrieve the TSC frequency */
 182 #define HV_X64_MSR_TSC_FREQUENCY                0x40000022
 183
 184 /* MSR used to retrieve the local APIC timer frequency */
 185 #define HV_X64_MSR_APIC_FREQUENCY               0x40000023
 186
 187 /* Define the virtual APIC registers */
 188 #define HV_X64_MSR_EOI                          0x40000070
 189 #define HV_X64_MSR_ICR                          0x40000071
 190 #define HV_X64_MSR_TPR                          0x40000072
 191 #define HV_X64_MSR_APIC_ASSIST_PAGE             0x40000073
 192
 193 /* Define synthetic interrupt controller model specific registers. */
 194 #define HV_X64_MSR_SCONTROL                     0x40000080
 195 #define HV_X64_MSR_SVERSION                     0x40000081
 196 #define HV_X64_MSR_SIEFP                        0x40000082
 197 #define HV_X64_MSR_SIMP                         0x40000083
 198 #define HV_X64_MSR_EOM                          0x40000084
 199 #define HV_X64_MSR_SINT0                        0x40000090
 200 #define HV_X64_MSR_SINT1                        0x40000091
 201 #define HV_X64_MSR_SINT2                        0x40000092
 202 #define HV_X64_MSR_SINT3                        0x40000093
 203 #define HV_X64_MSR_SINT4                        0x40000094
 204 #define HV_X64_MSR_SINT5                        0x40000095
 205 #define HV_X64_MSR_SINT6                        0x40000096
 206 #define HV_X64_MSR_SINT7                        0x40000097
 207 #define HV_X64_MSR_SINT8                        0x40000098
 208 #define HV_X64_MSR_SINT9                        0x40000099
 209 #define HV_X64_MSR_SINT10                       0x4000009A
 210 #define HV_X64_MSR_SINT11                       0x4000009B
 211 #define HV_X64_MSR_SINT12                       0x4000009C
 212 #define HV_X64_MSR_SINT13                       0x4000009D
 213 #define HV_X64_MSR_SINT14                       0x4000009E
 214 #define HV_X64_MSR_SINT15                       0x4000009F
 215
 216 /*
 217  * Synthetic Timer MSRs. Four timers per vcpu.
 218  */
 219 #define HV_X64_MSR_STIMER0_CONFIG               0x400000B0
 220 #define HV_X64_MSR_STIMER0_COUNT                0x400000B1
 221 #define HV_X64_MSR_STIMER1_CONFIG               0x400000B2
 222 #define HV_X64_MSR_STIMER1_COUNT                0x400000B3
 223 #define HV_X64_MSR_STIMER2_CONFIG               0x400000B4
 224 #define HV_X64_MSR_STIMER2_COUNT                0x400000B5
 225 #define HV_X64_MSR_STIMER3_CONFIG               0x400000B6
 226 #define HV_X64_MSR_STIMER3_COUNT                0x400000B7
 227
 228 /* Hyper-V guest crash notification MSR's */
 229 #define HV_X64_MSR_CRASH_P0                     0x40000100
 230 #define HV_X64_MSR_CRASH_P1                     0x40000101
 231 #define HV_X64_MSR_CRASH_P2                     0x40000102
 232 #define HV_X64_MSR_CRASH_P3                     0x40000103
 233 #define HV_X64_MSR_CRASH_P4                     0x40000104
 234 #define HV_X64_MSR_CRASH_CTL                    0x40000105
 235 #define HV_X64_MSR_CRASH_CTL_NOTIFY             (1ULL << 63)
 236 #define HV_X64_MSR_CRASH_PARAMS         \
 237                 (1 + (HV_X64_MSR_CRASH_P4 - HV_X64_MSR_CRASH_P0))
 238
 239 #define HV_X64_MSR_HYPERCALL_ENABLE             0x00000001
 240 #define HV_X64_MSR_HYPERCALL_PAGE_ADDRESS_SHIFT 12
 241 #define HV_X64_MSR_HYPERCALL_PAGE_ADDRESS_MASK  \
 242                 (~((1ull << HV_X64_MSR_HYPERCALL_PAGE_ADDRESS_SHIFT) - 1))
 243
 244 /* Declare the various hypercall operations. */
 245 #define HVCALL_NOTIFY_LONG_SPIN_WAIT            0x0008
 246 #define HVCALL_POST_MESSAGE                     0x005c
 247 #define HVCALL_SIGNAL_EVENT                     0x005d
 248
 249 #define HV_X64_MSR_APIC_ASSIST_PAGE_ENABLE              0x00000001
 250 #define HV_X64_MSR_APIC_ASSIST_PAGE_ADDRESS_SHIFT       12
 251 #define HV_X64_MSR_APIC_ASSIST_PAGE_ADDRESS_MASK        \
 252                 (~((1ull << HV_X64_MSR_APIC_ASSIST_PAGE_ADDRESS_SHIFT) - 1))
 253
 254 #define HV_X64_MSR_TSC_REFERENCE_ENABLE         0x00000001
 255 #define HV_X64_MSR_TSC_REFERENCE_ADDRESS_SHIFT  12
 256
 257 #define HV_PROCESSOR_POWER_STATE_C0             0
 258 #define HV_PROCESSOR_POWER_STATE_C1             1
 259 #define HV_PROCESSOR_POWER_STATE_C2             2
 260 #define HV_PROCESSOR_POWER_STATE_C3             3
 261
 262 /* hypercall status code */
 263 #define HV_STATUS_SUCCESS                       0
 264 #define HV_STATUS_INVALID_HYPERCALL_CODE        2
 265 #define HV_STATUS_INVALID_HYPERCALL_INPUT       3
 266 #define HV_STATUS_INVALID_ALIGNMENT             4
 267 #define HV_STATUS_INSUFFICIENT_MEMORY           11
 268 #define HV_STATUS_INVALID_CONNECTION_ID         18
 269 #define HV_STATUS_INSUFFICIENT_BUFFERS          19
 270
 271 typedef struct _HV_REFERENCE_TSC_PAGE {
 272         uint32_t tsc_sequence;
 273         uint32_t res1;
 274         uint64_t tsc_scale;
 275         int64_t tsc_offset;
 276 } HV_REFERENCE_TSC_PAGE, *PHV_REFERENCE_TSC_PAGE;
 277
 278 /* Define the number of synthetic interrupt sources. */
 279 #define HV_SYNIC_SINT_COUNT             (16)
 280 /* Define the expected SynIC version. */
 281 #define HV_SYNIC_VERSION_1              (0x1)
 282
 283 #define HV_SYNIC_CONTROL_ENABLE         (1ULL << 0)
 284 #define HV_SYNIC_SIMP_ENABLE            (1ULL << 0)
 285 #define HV_SYNIC_SIEFP_ENABLE           (1ULL << 0)
 286 #define HV_SYNIC_SINT_MASKED            (1ULL << 16)
 287 #define HV_SYNIC_SINT_AUTO_EOI          (1ULL << 17)
 288 #define HV_SYNIC_SINT_VECTOR_MASK       (0xFF)
 289
 290 #define HV_SYNIC_STIMER_COUNT           (4)
 291
 292 /* Define synthetic interrupt controller message constants. */
 293 #define HV_MESSAGE_SIZE                 (256)
 294 #define HV_MESSAGE_PAYLOAD_BYTE_COUNT   (240)
 295 #define HV_MESSAGE_PAYLOAD_QWORD_COUNT  (30)
 296
 297 /* Define hypervisor message types. */
 298 enum hv_message_type {
 299         HVMSG_NONE                      = 0x00000000,
 300
 301         /* Memory access messages. */
 302         HVMSG_UNMAPPED_GPA              = 0x80000000,
 303         HVMSG_GPA_INTERCEPT             = 0x80000001,
 304
 305         /* Timer notification messages. */
 306         HVMSG_TIMER_EXPIRED                     = 0x80000010,
 307
 308         /* Error messages. */
 309         HVMSG_INVALID_VP_REGISTER_VALUE = 0x80000020,
 310         HVMSG_UNRECOVERABLE_EXCEPTION   = 0x80000021,
 311         HVMSG_UNSUPPORTED_FEATURE               = 0x80000022,
 312
 313         /* Trace buffer complete messages. */
 314         HVMSG_EVENTLOG_BUFFERCOMPLETE   = 0x80000040,
 315
 316         /* Platform-specific processor intercept messages. */
 317         HVMSG_X64_IOPORT_INTERCEPT              = 0x80010000,
 318         HVMSG_X64_MSR_INTERCEPT         = 0x80010001,
 319         HVMSG_X64_CPUID_INTERCEPT               = 0x80010002,
 320         HVMSG_X64_EXCEPTION_INTERCEPT   = 0x80010003,
 321         HVMSG_X64_APIC_EOI                      = 0x80010004,
 322         HVMSG_X64_LEGACY_FP_ERROR               = 0x80010005
 323 };
 324
 325 /* Define synthetic interrupt controller message flags. */
 326 union hv_message_flags {
 327         uint8_t asu8;
 328         struct {
 329                 uint8_t msg_pending:1;
 330                 uint8_t reserved:7;
 331         };
 332 };
 333
 334 /* Define port identifier type. */
 335 union hv_port_id {
 336         uint32_t asu32;
 337         struct {
 338                 uint32_t id:24;
 339                 uint32_t reserved:8;
 340         } u;
 341 };
 342
 343 /* Define synthetic interrupt controller message header. */
 344 struct hv_message_header {
 345         uint32_t message_type;
 346         uint8_t payload_size;
 347         union hv_message_flags message_flags;
 348         uint8_t reserved[2];
 349         union {
 350                 uint64_t sender;
 351                 union hv_port_id port;
 352         };
 353 };
 354
 355 /* Define synthetic interrupt controller message format. */
 356 struct hv_message {
 357         struct hv_message_header header;
 358         union {
 359                 uint64_t payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT];
 360         } u;
 361 };
 362
 363 /* Define the synthetic interrupt message page layout. */
 364 struct hv_message_page {
 365         struct hv_message sint_message[HV_SYNIC_SINT_COUNT];
 366 };
 367
 368 /* Define timer message payload structure. */
 369 struct hv_timer_message_payload {
 370         uint32_t timer_index;
 371         uint32_t reserved;
 372         uint64_t expiration_time;       /* When the timer expired */
 373         uint64_t delivery_time; /* When the message was delivered */
 374 };
 375
 376 #define HV_STIMER_ENABLE                (1ULL << 0)
 377 #define HV_STIMER_PERIODIC              (1ULL << 1)
 378 #define HV_STIMER_LAZY                  (1ULL << 2)
 379 #define HV_STIMER_AUTOENABLE            (1ULL << 3)
 380 #define HV_STIMER_SINT(config)          (uint8_t)(((config) >> 16) & 0x0F)
 381
 382 #endif