include/xen/interface/hvm/params.h

   1 /*
   2  * Permission is hereby granted, free of charge, to any person obtaining a copy
   3  * of this software and associated documentation files (the "Software"), to
   4  * deal in the Software without restriction, including without limitation the
   5  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   6  * sell copies of the Software, and to permit persons to whom the Software is
   7  * furnished to do so, subject to the following conditions:
   8  *
   9  * The above copyright notice and this permission notice shall be included in
  10  * all copies or substantial portions of the Software.
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  13  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  14  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  15  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  16  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  17  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  18  * DEALINGS IN THE SOFTWARE.
  19  */
  20
  21 #ifndef __XEN_PUBLIC_HVM_PARAMS_H__
  22 #define __XEN_PUBLIC_HVM_PARAMS_H__
  23
  24 #include <xen/interface/hvm/hvm_op.h>
  25
  26 /*
  27  * Parameter space for HVMOP_{set,get}_param.
  28  */
  29
  30 #define HVM_PARAM_CALLBACK_IRQ 0
  31 /*
  32  * How should CPU0 event-channel notifications be delivered?
  33  *
  34  * If val == 0 then CPU0 event-channel notifications are not delivered.
  35  * If val != 0, val[63:56] encodes the type, as follows:
  36  */
  37
  38 #define HVM_PARAM_CALLBACK_TYPE_GSI      0
  39 /*
  40  * val[55:0] is a delivery GSI.  GSI 0 cannot be used, as it aliases val == 0,
  41  * and disables all notifications.
  42  */
  43
  44 #define HVM_PARAM_CALLBACK_TYPE_PCI_INTX 1
  45 /*
  46  * val[55:0] is a delivery PCI INTx line:
  47  * Domain = val[47:32], Bus = val[31:16] DevFn = val[15:8], IntX = val[1:0]
  48  */
  49
  50 #define HVM_PARAM_CALLBACK_TYPE_VECTOR   2
  51 /*
  52  * val[7:0] is a vector number.  Check for XENFEAT_hvm_callback_vector to know
  53  * if this delivery method is available.
  54  */
  55
  56 #define HVM_PARAM_STORE_PFN    1
  57 #define HVM_PARAM_STORE_EVTCHN 2
  58
  59 #define HVM_PARAM_PAE_ENABLED  4
  60
  61 #define HVM_PARAM_IOREQ_PFN    5
  62
  63 #define HVM_PARAM_BUFIOREQ_PFN 6
  64
  65 /*
  66  * Set mode for virtual timers (currently x86 only):
  67  *  delay_for_missed_ticks (default):
  68  *   Do not advance a vcpu's time beyond the correct delivery time for
  69  *   interrupts that have been missed due to preemption. Deliver missed
  70  *   interrupts when the vcpu is rescheduled and advance the vcpu's virtual
  71  *   time stepwise for each one.
  72  *  no_delay_for_missed_ticks:
  73  *   As above, missed interrupts are delivered, but guest time always tracks
  74  *   wallclock (i.e., real) time while doing so.
  75  *  no_missed_ticks_pending:
  76  *   No missed interrupts are held pending. Instead, to ensure ticks are
  77  *   delivered at some non-zero rate, if we detect missed ticks then the
  78  *   internal tick alarm is not disabled if the VCPU is preempted during the
  79  *   next tick period.
  80  *  one_missed_tick_pending:
  81  *   Missed interrupts are collapsed together and delivered as one 'late tick'.
  82  *   Guest time always tracks wallclock (i.e., real) time.
  83  */
  84 #define HVM_PARAM_TIMER_MODE   10
  85 #define HVMPTM_delay_for_missed_ticks    0
  86 #define HVMPTM_no_delay_for_missed_ticks 1
  87 #define HVMPTM_no_missed_ticks_pending   2
  88 #define HVMPTM_one_missed_tick_pending   3
  89
  90 /* Boolean: Enable virtual HPET (high-precision event timer)? (x86-only) */
  91 #define HVM_PARAM_HPET_ENABLED 11
  92
  93 /* Identity-map page directory used by Intel EPT when CR0.PG=0. */
  94 #define HVM_PARAM_IDENT_PT     12
  95
  96 /* Device Model domain, defaults to 0. */
  97 #define HVM_PARAM_DM_DOMAIN    13
  98
  99 /* ACPI S state: currently support S0 and S3 on x86. */
 100 #define HVM_PARAM_ACPI_S_STATE 14
 101
 102 /* TSS used on Intel when CR0.PE=0. */
 103 #define HVM_PARAM_VM86_TSS     15
 104
 105 /* Boolean: Enable aligning all periodic vpts to reduce interrupts */
 106 #define HVM_PARAM_VPT_ALIGN    16
 107
 108 /* Console debug shared memory ring and event channel */
 109 #define HVM_PARAM_CONSOLE_PFN    17
 110 #define HVM_PARAM_CONSOLE_EVTCHN 18
 111
 112 #define HVM_NR_PARAMS          19
 113
 114 #endif /* __XEN_PUBLIC_HVM_PARAMS_H__ */