From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 86B46A0A02; Fri, 15 Jan 2021 12:03:46 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 48A5A140F0F; Fri, 15 Jan 2021 12:03:46 +0100 (CET) Received: from qq.com (smtpbg550.qq.com [183.3.226.152]) by mails.dpdk.org (Postfix) with ESMTP id 8DC7F140F0E for ; Fri, 15 Jan 2021 12:03:44 +0100 (CET) X-QQ-mid: bizesmtp19t1610708617tquhfsv4 Received: from wxdbg.localdomain.com (unknown [183.129.236.74]) by esmtp6.qq.com (ESMTP) with id ; Fri, 15 Jan 2021 19:03:31 +0800 (CST) X-QQ-SSF: 01400000000000C0D000B00B0000000 X-QQ-FEAT: Ry58bBY793vh+/vXT3ghygLIVknQFOOKXtpk/vPytJc3oKL7V9N6LDpQLz2az 3ZsjSVAqBQ7Flyq3o6UdJf6B29fb3+xrQiZAZ4deBhYhd/5XYXcMyCrDi7F+iFxucRHrHUE FENSQ9q2XEfLDrXfvNJiZSeWVGxSKWhRu+2pZsFPzY9XlBuciTezilaazQbRH5TPOHrTQ63 GwOTL9rPVUj+jJlrHXIbTQJ98De3Rrz99jxFZObMAAN2dWgD14eK6NmLOhqMpJ8UcfYJcZ8 ASHTJ///oAsUTXL+ylkj1WqWN6XK/jMF/ASH3E3HvzM9DECbSZPygHyylQTgbJ4fIWKVvQw UI6G2sRi1WU0NUaHU0= X-QQ-GoodBg: 2 From: Jiawen Wu To: dev@dpdk.org Cc: Jiawen Wu Date: Fri, 15 Jan 2021 19:03:10 +0800 Message-Id: <20210115110310.1838171-1-jiawenwu@trustnetic.com> X-Mailer: git-send-email 2.27.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-QQ-SENDSIZE: 520 Feedback-ID: bizesmtp:trustnetic.com:qybgforeign:qybgforeign6 X-QQ-Bgrelay: 1 Subject: [dpdk-dev] [PATCH] doc: update release notes for txgbe 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 Sender: "dev" Add txgbe PMD new features in release notes, update user guide in txgbe.rst for flow API and traffic manager. Signed-off-by: Jiawen Wu --- doc/guides/nics/txgbe.rst | 38 ++++++++++++++++++++++++++ doc/guides/rel_notes/release_21_02.rst | 7 +++++ 2 files changed, 45 insertions(+) diff --git a/doc/guides/nics/txgbe.rst b/doc/guides/nics/txgbe.rst index 5a7299964..62aa22932 100644 --- a/doc/guides/nics/txgbe.rst +++ b/doc/guides/nics/txgbe.rst @@ -86,6 +86,44 @@ Driver compilation and testing Refer to the document :ref:`compiling and testing a PMD for a NIC ` for details. +Sample Application Notes +------------------------ + +Generic flow API +~~~~~~~~~~~~~~~~ + +TXGBE PMD supports generic flow API which configures hardware to match specific +ingress or egress traffic, alter its fate and query related counters according +to any number of user-defined rules. + +A flow rule is the combination of attributes with a matching pattern and a list of +actions. Theorically one rule can match more than one filters, which named for +different patterns and actions. Like ethertype filter defines a rule in pattern: +the first not void item can be ETH, and the next not void item must be END. + +For example, create a flow rule: + +.. code-block:: console + + testpmd> flow create 0 ingress pattern eth type is 0x0806 / end actions queue index 2 / end + +For a detailed usage description please refer to "Flow rules management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`. + +Traffic Management API +~~~~~~~~~~~~~~~~~~~~~~ + +TXGBE PMD supports generic DPDK Traffic Management API which allows to +configure the following features: hierarchical scheduling, traffic shaping, +congestion management, packet marking. + +For example, add shaper profile + +.. code-block:: console + + testpmd> add port tm node shaper profile 0 0 0 0 25000000 0 0 + +For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`. + Limitations or Known issues --------------------------- diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst index c64294e7a..b49c250f0 100644 --- a/doc/guides/rel_notes/release_21_02.rst +++ b/doc/guides/rel_notes/release_21_02.rst @@ -67,6 +67,13 @@ New Features * Introduced basic support on Windows. +* **Updated Wangxun txgbe driver.** + + Updated the Wangxun txgbe driver with new features and improvements, including: + + * Add support for generic flow API. + * Add support for traffic manager. + * Add support for IPsec. Removed Items ------------- -- 2.21.0.windows.1