[Xen-devel] [PATCH 2/2] xenfb: Add comment documentation

[Owen smith <owen.smith@xxxxxxxxxx>]

Add documentation for page-ref, page-gref and event-channel.

Signed-off-by: Owen smith <owen.smith@xxxxxxxxxx>
---
 xen/include/public/io/fbif.h | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/xen/include/public/io/fbif.h b/xen/include/public/io/fbif.h
index cc25aab..ba3f524 100644
--- a/xen/include/public/io/fbif.h
+++ b/xen/include/public/io/fbif.h
@@ -26,6 +26,31 @@
 #ifndef __XEN_PUBLIC_IO_FBIF_H__
 #define __XEN_PUBLIC_IO_FBIF_H__
 
+/*
+ * Frontend XenStore Nodes
+ * -----------------------
+ *
+ * page-ref
+ *   Values: <uint64_t>
+ *   Optional, "page-gref" is used if "page-ref" is not set.
+ *
+ *   The MFN of a page of memory for the shared ring structures. If not
+ *   present, "page-gref" must be set.page-ref" overrides "page-gref".
+ *
+ * page-gref
+ *   Values: <uint32_t>
+ *   Only required if "page-ref" is NOT set.
+ *
+ *   A grant reference to the memory page to be mapped for the shared ring
+ *   structures. Must be present if "page-ref" is not present.
+ *
+ * event-channel
+ *   Values: <uint32_t>
+ *
+ *   An event channel identifier, which is triggered when the shared page
+ *   is updated.
+ */
+
 /* Out events (frontend -> backend) */
 
 /*
-- 
2.1.0


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel