From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33978) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XVzZW-00053I-78 for qemu-devel@nongnu.org; Mon, 22 Sep 2014 05:06:19 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XVzZR-0007vy-CT for qemu-devel@nongnu.org; Mon, 22 Sep 2014 05:06:14 -0400 Received: from smtp02.citrix.com ([66.165.176.63]:31932) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XVzZR-0007vK-8y for qemu-devel@nongnu.org; Mon, 22 Sep 2014 05:06:09 -0400 From: Owen smith Date: Mon, 22 Sep 2014 10:04:58 +0100 Message-ID: <1411376699-8175-2-git-send-email-owen.smith@citrix.com> In-Reply-To: <1411376699-8175-1-git-send-email-owen.smith@citrix.com> References: <1411376699-8175-1-git-send-email-owen.smith@citrix.com> MIME-Version: 1.0 Content-Type: text/plain Subject: [Qemu-devel] [PATCH 1/2] xenfb: Add comment documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: xen-devel@lists.xen.org Cc: stefano.stabellini@eu.citrix.com, qemu-devel@nongnu.org, Owen smith , ian.campbell@citrix.com 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 --- 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: + * 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: + * 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: + * + * An event channel identifier, which is triggered when the shared page + * is updated. + */ + /* In events (backend -> frontend) */ /* -- 2.1.0