xen/vcpu: Document the xen_vcpu_info and xen_vcpu
authorKonrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Sun, 5 May 2013 12:51:47 +0000 (08:51 -0400)
committerKonrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Tue, 7 May 2013 14:05:34 +0000 (10:05 -0400)
commita520996ae2e2792e1f90b74e67c974120c8a3b83
treef853e587a26c19707e797e967a8003a24fe544a5
parent7f1fc268c47491fd5e63548f6415fc8604e13003
xen/vcpu: Document the xen_vcpu_info and xen_vcpu

They are important structures and it is not clear at first
look what they are for.

The xen_vcpu is a pointer. By default it points to the shared_info
structure (at the CPU offset location). However if the
VCPUOP_register_vcpu_info hypercall is implemented we can make the
xen_vcpu pointer point to a per-CPU location.

Acked-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com>
[v1: Added comments from Ian Campbell]
Signed-off-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
arch/x86/xen/enlighten.c