From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:34010) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XVzZZ-00053W-IE for qemu-devel@nongnu.org; Mon, 22 Sep 2014 05:06:23 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XVzZR-0007w6-IW for qemu-devel@nongnu.org; Mon, 22 Sep 2014 05:06:17 -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-Ey for qemu-devel@nongnu.org; Mon, 22 Sep 2014 05:06:09 -0400 From: Owen smith Date: Mon, 22 Sep 2014 10:04:59 +0100 Message-ID: <1411376699-8175-3-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 2/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 page-ref, page-gref and event-channel. Signed-off-by: Owen smith --- 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: + * 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. + */ + /* Out events (frontend -> backend) */ /* -- 2.1.0