From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1B3CCA00E6 for ; Mon, 5 Aug 2019 17:32:55 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 940E81BDF4; Mon, 5 Aug 2019 17:32:49 +0200 (CEST) Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) by dpdk.org (Postfix) with ESMTP id 115061BDF4 for ; Mon, 5 Aug 2019 17:32:48 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id A8DB721AD2; Mon, 5 Aug 2019 11:32:47 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Mon, 05 Aug 2019 11:32:47 -0400 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=mesmtp; bh=YU8VNfjvL3 pRkEhBUgOs1UJ01q8Di9BQu078M/vFlqE=; b=mk0/GorVfv9pntp2f8XNSl03Vs nWqefSoIvmsYygobYIROYRI5saLybrhgMTBDAvK3sQgzzS146km8OhBHr+fav4c5 4aC2p6gJW32g1kENe2klvFirVPdix4qEMRKgbVW+qKXPLtbLRg2QXNnT6orn/qfb 4cMCDFFOYLs80JodM= 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= fm3; bh=YU8VNfjvL3pRkEhBUgOs1UJ01q8Di9BQu078M/vFlqE=; b=c36V4phz KLCyMsgENSsj4iT6gjPbB+4pPe6NhbjNqnd1upt6n0CtYy/mOcKs+vvtXi3POzWB A9nYY9hw55axwP55DXiSkwnnfdAMhnTmZGTd75M4EBwPw1XqKh2JotYIziRk9cHA rfRqIZ9m1G0K8c0iuOzd3RS5eR/3gUchomddrk6dr98UKLiNpoHaZ6mWQ0m80OHV aXK+yBJbQX07aDgkBJZZyOy2k96i9Y/JoCO5R3fHJ0Q/MHzJ9+mRbSIP1x02m0Dj yJpVU4sp1EaAAJe1E/8u4LvhN3YFCJyQVs1Z+TilSlNYzepLz+w7Kc7lavCRBeQi gyG+FwR5XzwJGg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduvddruddtjedgkeelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecukf hppeejjedrudefgedrvddtfedrudekgeenucfrrghrrghmpehmrghilhhfrhhomhepthhh ohhmrghssehmohhnjhgrlhhonhdrnhgvthenucevlhhushhtvghrufhiiigvpedt 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 A4F378005B; Mon, 5 Aug 2019 11:32:46 -0400 (EDT) From: Thomas Monjalon To: Shahaf Shuler , Yongseok Koh , Viacheslav Ovsiienko , John McNamara , Marko Kovacevic Cc: dev@dpdk.org Date: Mon, 5 Aug 2019 17:32:19 +0200 Message-Id: <20190805153222.29593-3-thomas@monjalon.net> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190805153222.29593-1-thomas@monjalon.net> References: <20190805153222.29593-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH 2/5] doc: fix wording and formatting of 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" These are simple fixes of punctuation, anchor placement or wording. The table format is fixed to avoid having a long line in the first column. Signed-off-by: Thomas Monjalon --- doc/guides/nics/mlx5.rst | 57 +++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 30 deletions(-) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 32b1900bd..59c9537c0 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -32,9 +32,9 @@ kernel support), librte_pmd_mlx5 relies heavily on system calls for control operations such as querying/updating the MTU and flow control parameters. For security reasons and robustness, this driver only deals with virtual -memory addresses. The way resources allocations are handled by the kernel -combined with hardware specifications that allow it to handle virtual memory -addresses directly ensure that DPDK applications cannot access random +memory addresses. The way resources allocations are handled by the kernel, +combined with hardware specifications that allow to handle virtual memory +addresses directly, ensure that DPDK applications cannot access random physical memory (or memory that does not belong to the current process). This capability allows the PMD to coexist with kernel network interfaces @@ -80,7 +80,7 @@ Features - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP. - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification. - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL - increment/decrement, count, drop, mark. For details please see :ref:`Supported hardware offloads using rte_flow API`. + increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`. - Flow insertion rate of more then million flows per second, when using Direct Rules. - Support for multiple rte_flow groups. - Hardware LRO. @@ -173,7 +173,7 @@ Limitations Statistics ---------- -MLX5 supports various of methods to report statistics: +MLX5 supports various methods to report statistics: Port statistics can be queried using ``rte_eth_stats_get()``. The received and sent statistics are through SW only and counts the number of packets received or sent successfully by the PMD. The imissed counter is the amount of packets that could not be delivered to SW because a queue was full. Packets not received due to congestion in the bus or on the NIC can be queried via the rx_discards_phy xstats counter. @@ -972,62 +972,59 @@ Performance tuning - Configure per-lcore cache when creating Mempools for packet buffer. - Refrain from dynamically allocating/freeing memory in run-time. +.. _mlx5_offloads_support: + Supported hardware offloads using rte_flow API ---------------------------------------------- -.. _Supported hardware offloads using rte_flow API: - .. table:: Supported hardware offloads using rte_flow API +-----------------------+-----------------+-----------------+ - | Offload | E-Switch | NIC | - | | | | + | Offload | with E-Switch | with vNIC | +=======================+=================+=================+ | Count | | DPDK 19.05 | | DPDK 19.02 | | | | OFED 4.6 | | OFED 4.6 | - | | | RDMA-CORE V24 | | RDMA-CORE V23 | + | | | rdma-core 24 | | rdma-core 23 | | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ | Drop / Queue / RSS | | DPDK 19.05 | | DPDK 18.11 | | | | OFED 4.6 | | OFED 4.5 | - | | | RDMA-CORE V24 | | RDMA-CORE V23 | + | | | rdma-core 24 | | rdma-core 23 | | | | ConnectX-5 | | ConnectX-4 | +-----------------------+-----------------+-----------------+ | Encapsulation | | DPDK 19.05 | | DPDK 19.02 | - | (VXLAN / NVGRE / RAW) | | OFED 4.6.2 | | OFED 4.6 | - | | | RDMA-CORE V24 | | RDMA-CORE V23 | + | (VXLAN / NVGRE / RAW) | | OFED 4.6-2 | | OFED 4.6 | + | | | rdma-core 24 | | rdma-core 23 | | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ - | Header rewrite | | DPDK 19.05 | | DPDK 19.02 | - | (set_ipv4_src / | | OFED 4.6.2 | | OFED 4.6.2 | - | set_ipv4_dst / | | RDMA-CORE V24 | | RDMA-CORE V23 | - | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 | - | set_ipv6_dst / | | | - | set_tp_src / | | | - | set_tp_dst / | | | - | dec_ttl / | | | - | set_ttl / | | | - | set_mac_src / | | | - | set_mac_dst) | | | + | | Header rewrite | | DPDK 19.05 | | DPDK 19.02 | + | | (set_ipv4_src / | | OFED 4.6-2 | | OFED 4.6-2 | + | | set_ipv4_dst / | | rdma-core 24 | | rdma-core 23 | + | | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 | + | | set_ipv6_dst / | | | + | | set_tp_src / | | | + | | set_tp_dst / | | | + | | dec_ttl / | | | + | | set_ttl / | | | + | | set_mac_src / | | | + | | set_mac_dst) | | | +-----------------------+-----------------+-----------------+ | Jump | | DPDK 19.05 | | DPDK 19.02 | - | | | OFED 4.6.2 | | OFED 4.6.2 | - | | | RDMA-CORE V24 | | N/A | + | | | OFED 4.6-2 | | OFED 4.6-2 | + | | | rdma-core 24 | | N/A | | | | ConnectX-5 | | ConnectX-5 | +-----------------------+-----------------+-----------------+ | Mark / Flag | | DPDK 19.05 | | DPDK 18.11 | | | | OFED 4.6 | | OFED 4.5 | - | | | RDMA-CORE V24 | | RDMA-CORE V23 | + | | | rdma-core 24 | | rdma-core 23 | | | | ConnectX-5 | | ConnectX-4 | +-----------------------+-----------------+-----------------+ | Port ID | | DPDK 19.05 | | N/A | | | | OFED 4.6 | | N/A | - | | | RDMA-CORE V24 | | N/A | + | | | rdma-core 24 | | N/A | | | | ConnectX-5 | | N/A | +-----------------------+-----------------+-----------------+ -* Minimum version for each component and nic. - Notes for testpmd ----------------- -- 2.21.0