From 96fda35ac477e954eee989d6a3ae9e686cc361d6 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Thu, 26 Jul 2012 15:35:17 +0100 Subject: [PATCH] kvm: Add documentation comment for kvm_irqchip_in_kernel() Now we've cleared out the architecture-independent uses of kvm_irqchip_in_kernel(), we can add a doc comment describing what it means. Signed-off-by: Peter Maydell Signed-off-by: Avi Kivity --- kvm.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/kvm.h b/kvm.h index 444ed2e704..5b8f588813 100644 --- a/kvm.h +++ b/kvm.h @@ -31,6 +31,17 @@ extern bool kvm_gsi_routing_allowed; #if defined CONFIG_KVM || !defined NEED_CPU_H #define kvm_enabled() (kvm_allowed) +/** + * kvm_irqchip_in_kernel: + * + * Returns: true if the user asked us to create an in-kernel + * irqchip via the "kernel_irqchip=on" machine option. + * What this actually means is architecture and machine model + * specific: on PC, for instance, it means that the LAPIC, + * IOAPIC and PIT are all in kernel. This function should never + * be used from generic target-independent code: use one of the + * following functions or some other specific check instead. + */ #define kvm_irqchip_in_kernel() (kvm_kernel_irqchip) /**