[PATCH] KVM: PPC: refer to paravirt docs in header file

[PATCH] KVM: PPC: refer to paravirt docs in header file

[Scott Wood]

Instead of keeping separate copies of struct kvm_vcpu_arch_shared (one in
the code, one in the docs) that inevitably fail to be kept in sync
(already sr[] is missing from the doc version), just point to the header
file as the source of documentation on the contents of the magic page.

Signed-off-by: Scott Wood <scottwood@freescale.com>
---
 Documentation/virtual/kvm/ppc-pv.txt |   24 ++----------------------
 arch/powerpc/include/asm/kvm_para.h  |   10 ++++++++++
 2 files changed, 12 insertions(+), 22 deletions(-)

diff --git a/Documentation/virtual/kvm/ppc-pv.txt b/Documentation/virtual/kvm/ppc-pv.txt
index 2b7ce19..6e7c370 100644
--- a/Documentation/virtual/kvm/ppc-pv.txt
+++ b/Documentation/virtual/kvm/ppc-pv.txt
@@ -81,28 +81,8 @@ additional registers to the magic page. If you add fields to the magic page,
 also define a new hypercall feature to indicate that the host can give you more
 registers. Only if the host supports the additional features, make use of them.
 
-The magic page has the following layout as described in
-arch/powerpc/include/asm/kvm_para.h:
-
-struct kvm_vcpu_arch_shared {
-	__u64 scratch1;
-	__u64 scratch2;
-	__u64 scratch3;
-	__u64 critical;		/* Guest may not get interrupts if == r1 */
-	__u64 sprg0;
-	__u64 sprg1;
-	__u64 sprg2;
-	__u64 sprg3;
-	__u64 srr0;
-	__u64 srr1;
-	__u64 dar;
-	__u64 msr;
-	__u32 dsisr;
-	__u32 int_pending;	/* Tells the guest if we have an interrupt */
-};
-
-Additions to the page must only occur at the end. Struct fields are always 32
-or 64 bit aligned, depending on them being 32 or 64 bit wide respectively.
+The magic page layout is described by struct kvm_vcpu_arch_shared
+in arch/powerpc/include/asm/kvm_para.h.
 
 Magic page features
 ===================
diff --git a/arch/powerpc/include/asm/kvm_para.h b/arch/powerpc/include/asm/kvm_para.h
index ece70fb..7b754e7 100644
--- a/arch/powerpc/include/asm/kvm_para.h
+++ b/arch/powerpc/include/asm/kvm_para.h
@@ -22,6 +22,16 @@
 
 #include <linux/types.h>
 
+/*
+ * Additions to this struct must only occur at the end, and should be
+ * accompanied by a KVM_MAGIC_FEAT flag to advertise that they are present
+ * (albeit not necessarily relevant to the current target hardware platform).
+ *
+ * Struct fields are always 32 or 64 bit aligned, depending on them being 32
+ * or 64 bit wide respectively.
+ *
+ * See Documentation/virtual/kvm/ppc-pv.txt
+ */
 struct kvm_vcpu_arch_shared {
 	__u64 scratch1;
 	__u64 scratch2;
-- 
1.7.7.rc3.4.g8d714

Re: [PATCH] KVM: PPC: refer to paravirt docs in header file

[Alexander Graf]

On 12.01.2012, at 00:37, Scott Wood wrote:

> Instead of keeping separate copies of struct kvm_vcpu_arch_shared (one in
> the code, one in the docs) that inevitably fail to be kept in sync
> (already sr[] is missing from the doc version), just point to the header
> file as the source of documentation on the contents of the magic page.
> 
> Signed-off-by: Scott Wood <scottwood@freescale.com>

Avi, please ack.


Alex

Re: [PATCH] KVM: PPC: refer to paravirt docs in header file

[Avi Kivity]

On 01/12/2012 01:39 AM, Alexander Graf wrote:
> On 12.01.2012, at 00:37, Scott Wood wrote:
>
> > Instead of keeping separate copies of struct kvm_vcpu_arch_shared (one in
> > the code, one in the docs) that inevitably fail to be kept in sync
> > (already sr[] is missing from the doc version), just point to the header
> > file as the source of documentation on the contents of the magic page.
> > 
> > Signed-off-by: Scott Wood <scottwood@freescale.com>
>
> Avi, please ack.
>


ACK

-- 
error compiling committee.c: too many arguments to function