KVM: PPC: Add documentation for magic page enhancements
authorAlexander Graf <agraf@suse.de>
Tue, 31 Aug 2010 02:25:39 +0000 (04:25 +0200)
committerAvi Kivity <avi@redhat.com>
Sun, 24 Oct 2010 08:52:22 +0000 (10:52 +0200)
This documents how to detect additional features inside the magic
page when a guest maps it.

Signed-off-by: Alexander Graf <agraf@suse.de>
Documentation/kvm/ppc-pv.txt

index 922cf954bd992802f771194166dfa819f8134ab5..a7f2244b3be90238425ff73beea75dc8656edad0 100644 (file)
@@ -102,6 +102,20 @@ struct kvm_vcpu_arch_shared {
 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.
 
+Magic page features
+===================
+
+When mapping the magic page using the KVM hypercall KVM_HC_PPC_MAP_MAGIC_PAGE,
+a second return value is passed to the guest. This second return value contains
+a bitmap of available features inside the magic page.
+
+The following enhancements to the magic page are currently available:
+
+  KVM_MAGIC_FEAT_SR            Maps SR registers r/w in the magic page
+
+For enhanced features in the magic page, please check for the existence of the
+feature before using them!
+
 MSR bits
 ========