From patchwork Wed Jun 22 01:41:27 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Ding, Xuan" X-Patchwork-Id: 113201 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 49865A00C3; Wed, 22 Jun 2022 03:45:18 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E98424069C; Wed, 22 Jun 2022 03:45:17 +0200 (CEST) Received: from mga06.intel.com (mga06b.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id 94DF640151 for ; Wed, 22 Jun 2022 03:45:16 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655862316; x=1687398316; h=from:to:cc:subject:date:message-id:in-reply-to: references; bh=+1jFS3AapDi07j4KTqy+d+T95g37Z4L7LyLDObdoQ7o=; b=a+/V99LdzZOtIe8TK5WF7Eo2EHWDqYhyuWFjhSdtpuFgbhvrgHGUbQwT HWVH+QiH5PrqcY5MdYdlS1cfUPPS/ESnkJhmAW4DjVBo25+8Eu0ckLWTV jPyzTzrTCDel3HdjkqBFIC8Ie1hQvueGa+CCdtpTuKbMgxJSTB6RHU6sO M6NfOgZREyffiudpBYgnqOY17JlQ9NMyIaZNDL7gOAxKs0l1pGD6DLRNS WYJaOgkFNlh26aiGHuwlvag2zn5NWs6O9Fugo/mbFJu7WNuRNbrT10Rby TlIrbCi5JoM7WFkL0vTKR5hkYLHXEdPXWHtriIfBrJuq2IPPT9mUMtz1a A==; X-IronPort-AV: E=McAfee;i="6400,9594,10385"; a="341968977" X-IronPort-AV: E=Sophos;i="5.92,211,1650956400"; d="scan'208";a="341968977" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2022 18:45:15 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,211,1650956400"; d="scan'208";a="585510461" Received: from npg-dpdk-xuan-cbdma.sh.intel.com ([10.67.110.228]) by orsmga007.jf.intel.com with ESMTP; 21 Jun 2022 18:45:13 -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 v2] doc: clean vhost async path doc Date: Wed, 22 Jun 2022 01:41:27 +0000 Message-Id: <20220622014127.103493-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 subsection, which makes the doc cleaner. Signed-off-by: Xuan Ding --- 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.