From patchwork Thu Feb 9 11:23:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?b?SsO8cmdlbiBHcm/Dnw==?= X-Patchwork-Id: 13134424 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 47AE1C61DA4 for ; Thu, 9 Feb 2023 11:24:02 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.492345.761870 (Exim 4.92) (envelope-from ) id 1pQ51w-0002tM-CR; Thu, 09 Feb 2023 11:23:56 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 492345.761870; Thu, 09 Feb 2023 11:23:56 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1pQ51w-0002tF-9V; Thu, 09 Feb 2023 11:23:56 +0000 Received: by outflank-mailman (input) for mailman id 492345; Thu, 09 Feb 2023 11:23:54 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1pQ51u-0002J1-Q2 for xen-devel@lists.xenproject.org; Thu, 09 Feb 2023 11:23:54 +0000 Received: from smtp-out2.suse.de (smtp-out2.suse.de [195.135.220.29]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id 3c5783f4-a86c-11ed-933c-83870f6b2ba8; Thu, 09 Feb 2023 12:23:54 +0100 (CET) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 055735C830; Thu, 9 Feb 2023 11:23:54 +0000 (UTC) Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id C222E1339E; Thu, 9 Feb 2023 11:23:53 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id 4G8qLsnX5GONPAAAMHmgww (envelope-from ); Thu, 09 Feb 2023 11:23:53 +0000 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 3c5783f4-a86c-11ed-933c-83870f6b2ba8 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=susede1; t=1675941834; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=l9hWyX1xxO2Hr5xWFMrMhIclyrLkWDLxq1LOLbj+I4I=; b=cnhgXp3QLOM22dAa7iRHOVdKpkMg18w1JaOg3jmcq2AVgi8YWHZcTkRa1ICbbL190fAENl ToyEe2sNNx6IUFhuH49oVwBp/dCk0HRnTCxLSUjzcmJB348wrE/2pESJP9WwSqV1PXYBs8 GJAh7ysO0cVYdUy1dsEGJ+znJl0Bttc= From: Juergen Gross To: xen-devel@lists.xenproject.org Cc: andrew.cooper3@citrix.com, george.dunlap@citrix.com, jbeulich@suse.com, julien@xen.org, sstabellini@kernel.org, wl@xen.org, Juergen Gross Subject: [PATCH v4 2/2 RESEND] xen/public: fix 9pfs documentation of connection sequence Date: Thu, 9 Feb 2023 12:23:38 +0100 Message-Id: <20230209112338.26287-3-jgross@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20230209112338.26287-1-jgross@suse.com> References: <20230209112338.26287-1-jgross@suse.com> MIME-Version: 1.0 The documented connection sequence in xen/include/public/io/9pfs.h has a bug: the frontend needs to wait for the backend to have published its features before being able to allocate its rings and event-channels. While correcting that, make it clear that there might be multiple rings and event-channels by adding "(s)". Signed-off-by: Juergen Gross Reviewed-by: Stefano Stabellini --- V4: - patch split off (Julien Grall) --- xen/include/public/io/9pfs.h | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/xen/include/public/io/9pfs.h b/xen/include/public/io/9pfs.h index 617ad9afd7..a0ce82d0a8 100644 --- a/xen/include/public/io/9pfs.h +++ b/xen/include/public/io/9pfs.h @@ -114,14 +114,26 @@ * * *Front* *Back* * XenbusStateInitialising XenbusStateInitialising - * - Query virtual device - Query backend device - * properties. identification data. - * - Setup OS device instance. - Publish backend features - * - Allocate and initialize the and transport parameters - * request ring. | - * - Publish transport parameters | - * that will be in effect during V - * this connection. XenbusStateInitWait + * - Query backend device + * identification data. + * - Publish backend features + * and transport parameters. + * | + * | + * V + * XenbusStateInitWait + * + * - Query virtual device + * properties. + * - Query backend features and + * transport parameters. + * - Setup OS device instance. + * - Allocate and initialize the + * request ring(s) and + * event-channel(s). + * - Publish transport parameters + * that will be in effect during + * this connection. * | * | * V @@ -129,8 +141,8 @@ * * - Query frontend transport * parameters. - * - Connect to the request ring and - * event channel. + * - Connect to the request ring(s) + * and event channel(s). * | * | * V