x86/public: Further corrections to vcpu context comments
authorAndrew Cooper <andrew.cooper3@citrix.com>
Fri, 1 Sep 2017 13:14:17 +0000 (14:14 +0100)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Fri, 1 Sep 2017 17:33:06 +0000 (18:33 +0100)
VCPUOP_initialise and DOMCTL_setvcpucontext are not symetric.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Jan Beulich <jbeulich@suse.com>
Reviewed-by: Roger Pau Monné <roger.pau@citrix.com>
xen/include/public/arch-x86/xen.h

index 3f68a43c30a24d3b293e5ceff94948d319e35173..ff918310f688942dec43fcb691377ae0b3fd792f 100644 (file)
@@ -162,10 +162,12 @@ typedef uint64_t tsc_timestamp_t; /* RDTSC timestamp */
  * The following is all CPU context. Note that the fpu_ctxt block is filled
  * in by FXSAVE if the CPU has feature FXSR; otherwise FSAVE is used.
  *
- * Also note that when calling DOMCTL_setvcpucontext and VCPUOP_initialise for
- * HVM guests, not all information in this structure is updated, the fields
- * read include: fpu_ctxt (if VGCT_I387_VALID is set), flags, user_regs and
- * debugreg[*].
+ * Also note that when calling DOMCTL_setvcpucontext for HVM guests, not all
+ * information in this structure is updated, the fields read include: fpu_ctxt
+ * (if VGCT_I387_VALID is set), flags, user_regs and debugreg[*].
+ *
+ * Note: VCPUOP_initialise for HVM guests is non-symetric with
+ * DOMCTL_setvcpucontext, and uses struct vcpu_hvm_context from hvm/hvm_vcpu.h
  */
 struct vcpu_guest_context {
     /* FPU registers come first so they can be aligned for FXSAVE/FXRSTOR. */