From patchwork Wed Jun 22 01:45:56 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Ding, Xuan" X-Patchwork-Id: 113202 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 839EEA00C3; Wed, 22 Jun 2022 03:49:43 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 686244069C; Wed, 22 Jun 2022 03:49:43 +0200 (CEST) Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mails.dpdk.org (Postfix) with ESMTP id 2CEB340151 for ; Wed, 22 Jun 2022 03:49:42 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655862582; x=1687398582; h=from:to:cc:subject:date:message-id:in-reply-to: references; bh=nd6LChQgzNbpsyeE5snpzwLzml0n2NZOaoJchpJsiwA=; b=D7y0IBzH6wOSSzh+Pylkkwv0dxV+OT4MRh7IUbyLqlWN6jWbnnz5FC9n AxXvHHxCqNS62fxUBerRIg67Qi4f9uYFcuAfGzdPOu5LJ+4qcdS5br/i2 XA/Jo2pGN8tzKvfCJMbybbMdnufVTegg0X7xH2Y1pTRhXwXQnmJ77AiqV HqMNlXTydfEJrOFU5njwVi5XF6lWEA2uIXsWl+Mq/coiLdmrP5etliW3B E3Yhp+muF4cfvJRKpUjn2QrMI9Z30UmUZJ7qcwZzKWoYpykMfV+R7SQsz 23OYDUIygMBf7cHbDsrJ19qquhd1AVk5a9YCRhh89mPmB8v4wrN7lDkYt A==; X-IronPort-AV: E=McAfee;i="6400,9594,10385"; a="260716582" X-IronPort-AV: E=Sophos;i="5.92,211,1650956400"; d="scan'208";a="260716582" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2022 18:49:41 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,211,1650956400"; d="scan'208";a="585511600" Received: from npg-dpdk-xuan-cbdma.sh.intel.com ([10.67.110.228]) by orsmga007.jf.intel.com with ESMTP; 21 Jun 2022 18:49:39 -0700 From: xuan.ding@intel.com To: maxime.coquelin@redhat.com, chenbo.xia@intel.com Cc: dev@dpdk.org, jiayu.hu@intel.com, Xuan Ding Subject: [PATCH v3] doc: clean vhost async path doc Date: Wed, 22 Jun 2022 01:45:56 +0000 Message-Id: <20220622014556.105081-1-xuan.ding@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220622013535.100253-1-xuan.ding@intel.com> References: <20220622013535.100253-1-xuan.ding@intel.com> X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Xuan Ding This patch moves the 'Recommended IOVA mode in async datapath' section under 'Vhost asynchronous data path' as a sub-section, which makes the doc cleaner. Signed-off-by: Xuan Ding Reviewed-by: Jiayu Hu Reviewed-by: Chenbo Xia --- v3: * add Reviewd-by v2: * fix a typo in commit log --- doc/guides/prog_guide/vhost_lib.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst index 628db3fc38..e93673ce68 100644 --- a/doc/guides/prog_guide/vhost_lib.rst +++ b/doc/guides/prog_guide/vhost_lib.rst @@ -488,11 +488,11 @@ support sharing DMA channels among vrings. not poll completed will cause the DMA ring to be full, which will result in packet loss eventually. -Recommended IOVA mode in async datapath ---------------------------------------- +* Recommended IOVA mode in async datapath -When DMA devices are bound to VFIO driver, VA mode is recommended. -For PA mode, page by page mapping may exceed IOMMU's max capability, -better to use 1G guest hugepage. + When DMA devices are bound to VFIO driver, VA mode is recommended. + For PA mode, page by page mapping may exceed IOMMU's max capability, + better to use 1G guest hugepage. -For UIO driver, any VFIO related error message can be ignored. + For UIO driver or kernel driver, any VFIO related error messages + can be ignored.