aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2012-07-26 15:35:17 +0100
committerAvi Kivity <avi@redhat.com>2012-08-09 16:16:58 +0300
commit96fda35ac477e954eee989d6a3ae9e686cc361d6 (patch)
tree39c225b0700c38a6ad2b85bc6f7dedb190e91610
parentf3e1bed8daa35726d2731dd2a010fb91a5bb3792 (diff)
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 <peter.maydell@linaro.org> Signed-off-by: Avi Kivity <avi@redhat.com>
-rw-r--r--kvm.h11
1 files changed, 11 insertions, 0 deletions
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)
/**