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 <jiawe...@trustnetic.com> --- 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 <pmd_build_and_test>` 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
