[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 1/2] xenfb: Add comment documentation
From: |
Owen smith |
Subject: |
[Qemu-devel] [PATCH 1/2] xenfb: Add comment documentation |
Date: |
Mon, 22 Sep 2014 10:04:58 +0100 |
Add documentation for feature-abs-pointer, feature-no-abs-rescale,
feature-no-console, page-ref, page-gref and event-channel
Signed-off-by: Owen smith <address@hidden>
---
xen/include/public/io/kbdif.h | 74 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 74 insertions(+)
diff --git a/xen/include/public/io/kbdif.h b/xen/include/public/io/kbdif.h
index 2d2aebd..b29bc12 100644
--- a/xen/include/public/io/kbdif.h
+++ b/xen/include/public/io/kbdif.h
@@ -26,6 +26,80 @@
#ifndef __XEN_PUBLIC_IO_KBDIF_H__
#define __XEN_PUBLIC_IO_KBDIF_H__
+/*
+ * Backend Xenstore Nodes
+ * ----------------------
+ *
+ * feature-abs-pointer
+ * Values: 0/1 (boolean)
+ * Default: 0
+ *
+ * When set to "1", backend supports supplying absolute coordinates via
+ * XENKBD_TYPE_POS messages. When set to "0", backend can only supply
+ * relative movements via XENKBD_TYPE_MOTION messages.
+ *
+ * feature-no-abs-rescale
+ * Values: 0/1 (boolean)
+ * Default: 0
+ *
+ * When set to "1", backend supports unscaled absolute coordinates. Unscaled
+ * coordinates are in the range [0, 0x7fff]. When set to "0", backend can
+ * only supply scaled coordinates. Scaled coordinates are scaled to the
+ * 'screen size' of the console. If "feature-abs-pointer" is "0", this value
+ * has no effect.
+ *
+ * feature-no-console
+ * Values: 0/1 (boolean)
+ * Default: 0
+ *
+ * When set to "1", backend supports connection without a console. When
+ * running without a console, scaled values maximum is undefined. When
+ * set to "0", backend will wait for a console before connecting.
+ *
+ * Frontend XenStore Nodes
+ * -----------------------
+ *
+ * request-abs-pointer
+ * Values: 0/1 (boolean)
+ * Default: 0
+ *
+ * When set to "1", frontend wants absolute coordinates delivered with the
+ * XENKBD_TYPE_POS message.
+ *
+ * request-no-abs-rescale
+ * Values: 0/1 (boolean)
+ * Default: 0
+ *
+ * When set to "1", frontend wants unscaled absolute coordinates. If
+ * "request-abs-pointer" is "0", this value has no effect.
+ *
+ * request-no-console
+ * Values: 0/1 (boolean)
+ * Default: 0
+ *
+ * When set to "1", frontend does not require a console for connection.
+ *
+ * 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.
+ */
+
/* In events (backend -> frontend) */
/*
--
2.1.0