From patchwork Thu Nov 26 23:55:22 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 84596 Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id C4DABA04DD; Fri, 27 Nov 2020 00:55:40 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 34B2ECA54; Fri, 27 Nov 2020 00:55:38 +0100 (CET) Received: from wout4-smtp.messagingengine.com (wout4-smtp.messagingengine.com [64.147.123.20]) by dpdk.org (Postfix) with ESMTP id 01642CA0C for ; Fri, 27 Nov 2020 00:55:34 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.west.internal (Postfix) with ESMTP id 842299E4; Thu, 26 Nov 2020 18:55:33 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Thu, 26 Nov 2020 18:55:33 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; s=fm2; bh=USNJq/Pv4z//z 9hAtyKEAvUwSxf8Tu0iHhqpBiw1eoI=; b=YBUyAxvfi/gDa2zxdIMzM7cySMfPm N5nv4EhBQolzifBmMW/wKWUh4aSijDuU+EZW+oi5INYxPrL9oCge/0u6lXP5cTIu KAX5VTmDUuaRUFsRnKt1qFCDchcRHfKlFJ1E+pH5/c90F9lIlzIMvlZ5NNuO1oxy sub88bKGUfL4DKf8nnHuB+hD1VKPBM+L69JcOTlpaZY0WhYnSXMUW2OvuouN2ts5 /aIHdVa0ZtN/U+jmwloLyIC2V2jI9EtIt1UDvlQGTg3zrpnmVtq9u/fVoNHuLPlQ /gV3JEmlLQa6SQ4Lv1LconcMEBLQX3aBuclchk6ol6Hp8VCzz3T//osDA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :in-reply-to:message-id:mime-version:references:subject:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; bh=USNJq/Pv4z//z9hAtyKEAvUwSxf8Tu0iHhqpBiw1eoI=; b=YyShBrlK b4kOK0N2F+iZP7qKSSlGX3OxBkXLzAn8gLibMOkICT6w40hOB72etBkXc83DguL5 EzldHzKpakjo+13CncRz7/xVzXjDJpX32bBAehG2T1ylN/Izvio9OgyKLxC3RKK9 aOWrBW8DggbgaTYmFffGgYdkltf3vjdclcBdmncWtF2Uiwj7JkZvSR5pHEl24MqS 743pe2trIlmXl04RYCUL2xOZnPhDHvdIMObL7TkZXGbzy9Zsg7VLo7NZRHE8X4tV okI8EW3Cs+zqbpNhVpv4Npwbm0JzlEmL7Z4KNQdWhD/kvXSUyhPukFVfkh+NpPEc eoDKkqx9GnjhIA== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrudehfedgudegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepvdehgfeivdejgedtveehfefhteelfefgieevgfffveefjeegtdfg uedthedtgeevnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 30E7D3064AAE; Thu, 26 Nov 2020 18:55:32 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Cc: Asaf Penso , Matan Azrad , Shahaf Shuler , Viacheslav Ovsiienko Date: Fri, 27 Nov 2020 00:55:22 +0100 Message-Id: <20201126235522.2059857-1-thomas@monjalon.net> X-Mailer: git-send-email 2.28.0 In-Reply-To: <1606203856-5736-1-git-send-email-asafp@nvidia.com> References: <1606203856-5736-1-git-send-email-asafp@nvidia.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5] doc: add Rx functions limitations in mlx5 guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: Asaf Penso The mlx5 PMD supports various Rx burst functions. Each function is enabled differently and supports different features. Signed-off-by: Asaf Penso Signed-off-by: Thomas Monjalon --- v5: fix formatting by using a table --- doc/guides/nics/mlx5.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index e96aca21eb..6858e81f72 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -1345,6 +1345,29 @@ Performance tuning - Configure per-lcore cache when creating Mempools for packet buffer. - Refrain from dynamically allocating/freeing memory in run-time. +Rx burst functions +------------------ + +There are multiple Rx burst functions with different advantages and limitations. + +.. table:: Rx burst functions + + +-------------------+------------------------+---------+-----------------+------+-------+ + || Function Name || Enabler || Scatter|| Error Recovery || CQE || Large| + | | | | || comp|| MTU | + +===================+========================+=========+=================+======+=======+ + | rx_burst | rx_vec_en=0 | Yes | Yes | Yes | Yes | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_vec | rx_vec_en=1 (default) | No | if CQE comp off | Yes | No | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_mprq || mprq_en=1 | No | Yes | Yes | Yes | + | || RxQs >= rxqs_min_mprq | | | | | + +-------------------+------------------------+---------+-----------------+------+-------+ + | rx_burst_mprq_vec || rx_vec_en=1 (default) | No | if CQE comp off | Yes | Yes | + | || mprq_en=1 | | | | | + | || RxQs >= rxqs_min_mprq | | | | | + +-------------------+------------------------+---------+-----------------+------+-------+ + .. _mlx5_offloads_support: Supported hardware offloads