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 8E560A05A1; Wed, 22 Apr 2020 05:11:59 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C49EC1C1A4; Wed, 22 Apr 2020 05:11:58 +0200 (CEST) Received: from git-send-mailer.rdmz.labs.mlnx (unknown [37.142.13.130]) by dpdk.org (Postfix) with ESMTP id A3BC31C196 for ; Wed, 22 Apr 2020 05:11:57 +0200 (CEST) From: Bing Zhao To: john.mcnamara@intel.com, marko.kovacevic@intel.com, viacheslavo@mellanox.com, orika@mellanox.com, matan@mellanox.com Cc: shahafs@mellanox.com, rasland@mellanox.com, dev@dpdk.org, thomas@monjalon.net Date: Wed, 22 Apr 2020 11:11:20 +0800 Message-Id: <1587525080-239250-1-git-send-email-bingz@mellanox.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1587454163-127981-1-git-send-email-bingz@mellanox.com> References: <1587454163-127981-1-git-send-email-bingz@mellanox.com> Subject: [dpdk-dev] [PATCH v4] doc: update hairpin data buffer size config 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" This patch updates the MLX5 PMD and release notes documentations. Adding the guideline for hairpin data buffer size configuration. Signed-off-by: Bing Zhao Acked-by: Ori Kam --- v2: update the range description of hairpin data buffer size v3: correct the minimum value of the range v4: correct some typos and grammatical errors --- doc/guides/nics/mlx5.rst | 16 ++++++++++++++++ doc/guides/rel_notes/release_20_05.rst | 1 + 2 files changed, 17 insertions(+) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 759d0ac..51b5d47 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -99,6 +99,7 @@ Features - Support for multiple rte_flow groups. - Per packet no-inline hint flag to disable packet data copying into Tx descriptors. - Hardware LRO. +- Hairpin. Limitations ----------- @@ -786,6 +787,21 @@ Run-time configuration If this parameter is not specified, by default PMD will set the smallest value supported by HW. +- ``hp_buf_log_sz`` parameter [int] + + The total data buffer size of a hairpin queue (logarithmic form), in bytes. + PMD will set the data buffer size to 2 ** ``hp_buf_log_sz``, both for RX & TX. + The capacity of the value is specified by the firmware and the initialization + will get a failure if it is out of scope. + The range of the value is from 11 to 19 right now, and the supported frame + size of a single packet for hairpin is from 512B to 128KB. It might change if + different firmware release is being used. By using a small value, it could + reduce memory consumption but not work with a large frame. If the value is + too large, the memory consumption will be high and some potential performance + degradation will be introduced. + By default, the PMD will set this value to 16, which means that 9KB jumbo + frames will be supported. + .. _mlx5_firmware_config: Firmware configuration diff --git a/doc/guides/rel_notes/release_20_05.rst b/doc/guides/rel_notes/release_20_05.rst index 1e5304d..d43aa2e 100644 --- a/doc/guides/rel_notes/release_20_05.rst +++ b/doc/guides/rel_notes/release_20_05.rst @@ -78,6 +78,7 @@ New Features * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit. * Added support for creating Relaxed Ordering Memory Regions. + * Added support for configuring Hairpin queue data buffer size. * Added support for jumbo frame size (9K MTU) in Multi-Packet RQ mode. * Optimized the memory consumption of flow. -- 1.8.3.1