aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2012-07-25 12:52:59 +0100
committerPeter Maydell <peter.maydell@linaro.org>2012-07-26 11:59:21 +0100
commit4be1fb441e8b3a3e33011e7997f74796a45cda0e (patch)
treea78a6e98ea9527932b0862a05e2d336163402a5a
parentb0dac94bc1011dddac608748850dcba6b289d578 (diff)
kvm: Add documentation comment for kvm_irqchip_in_kernel()kvm-x86isms
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>
-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)
/**