[dpdk-dev] [PATCH v2 6/6] doc: Update cxgbe documentation and release notes

[Rahul Lakkireddy <rahul.lakkireddy@chelsio.com>]

- Add a missed step to mount huge pages in Linux.
- Re-structure Sample Application Notes.
- Add Jumbo Frame support to list of supported features and instructions
  on how to enable it via testpmd.
- Update release notes.

Signed-off-by: Rahul Lakkireddy <rahul.lakkireddy@chelsio.com>
Signed-off-by: Kumar Sanghvi <kumaras@chelsio.com>
---
v2:
- No change

 doc/guides/nics/cxgbe.rst            | 81 +++++++++++++++++++++++++-----------
 doc/guides/rel_notes/release_2_2.rst |  5 +++
 2 files changed, 61 insertions(+), 25 deletions(-)

diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
index 148cd25..d718f19 100644
--- a/doc/guides/nics/cxgbe.rst
+++ b/doc/guides/nics/cxgbe.rst
@@ -50,6 +50,7 @@ CXGBE PMD has support for:
 - Promiscuous mode
 - All multicast mode
 - Port hardware statistics
+- Jumbo frames
 
 Limitations
 -----------
@@ -211,8 +212,8 @@ Unified Wire package for Linux operating system are as follows:
 
       firmware-version: 1.13.32.0, TP 0.1.4.8
 
-Sample Application Notes
-~~~~~~~~~~~~~~~~~~~~~~~~
+Running testpmd
+~~~~~~~~~~~~~~~
 
 This section demonstrates how to launch **testpmd** with Chelsio T5
 devices managed by librte_pmd_cxgbe in Linux operating system.
@@ -260,6 +261,13 @@ devices managed by librte_pmd_cxgbe in Linux operating system.
 
       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
 
+#. Mount huge pages:
+
+   .. code-block:: console
+
+      mkdir /mnt/huge
+      mount -t hugetlbfs nodev /mnt/huge
+
 #. Load igb_uio or vfio-pci driver:
 
    .. code-block:: console
@@ -329,19 +337,7 @@ devices managed by librte_pmd_cxgbe in Linux operating system.
 .. note::
 
    Flow control pause TX/RX is disabled by default and can be enabled via
-   testpmd as follows:
-
-   .. code-block:: console
-
-      testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 0
-      testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 1
-
-   To disable again, use:
-
-   .. code-block:: console
-
-      testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 0
-      testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 1
+   testpmd. Refer section :ref:`flow-control` for more details.
 
 FreeBSD
 -------
@@ -409,8 +405,8 @@ Unified Wire package for FreeBSD operating system are as follows:
 
       dev.t5nex.0.firmware_version: 1.13.32.0
 
-Sample Application Notes
-~~~~~~~~~~~~~~~~~~~~~~~~
+Running testpmd
+~~~~~~~~~~~~~~~
 
 This section demonstrates how to launch **testpmd** with Chelsio T5
 devices managed by librte_pmd_cxgbe in FreeBSD operating system.
@@ -543,16 +539,51 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system.
 .. note::
 
    Flow control pause TX/RX is disabled by default and can be enabled via
-   testpmd as follows:
+   testpmd. Refer section :ref:`flow-control` for more details.
 
-   .. code-block:: console
+Sample Application Notes
+------------------------
 
-      testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 0
-      testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 1
+.. _flow-control:
 
-   To disable again, use:
+Enable/Disable Flow Control
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-   .. code-block:: console
+Flow control pause TX/RX is disabled by default and can be enabled via
+testpmd as follows:
+
+.. code-block:: console
+
+   testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 0
+   testpmd> set flow_ctrl rx on tx on 0 0 0 0 mac_ctrl_frame_fwd off autoneg on 1
+
+To disable again, run:
+
+.. code-block:: console
+
+   testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 0
+   testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 1
+
+Jumbo Mode
+~~~~~~~~~~
+
+There are two ways to enable sending and receiving of jumbo frames via testpmd.
+One method involves using the **mtu** command, which changes the mtu of an
+individual port without having to stop the selected port. Another method
+involves stopping all the ports first and then running **max-pkt-len** command
+to configure the mtu of all the ports with a single command.
+
+- To configure each port individually, run the mtu command as follows:
+
+  .. code-block:: console
+
+     testpmd> port config mtu 0 9000
+     testpmd> port config mtu 1 9000
+
+- To configure all the ports at once, stop all the ports first and run the
+  max-pkt-len command as follows:
+
+  .. code-block:: console
 
-      testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 0
-      testpmd> set flow_ctrl rx off tx off 0 0 0 0 mac_ctrl_frame_fwd off autoneg off 1
+     testpmd> port stop all
+     testpmd> port config all max-pkt-len 9000
diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst
index 5687676..a3f4f77 100644
--- a/doc/guides/rel_notes/release_2_2.rst
+++ b/doc/guides/rel_notes/release_2_2.rst
@@ -4,6 +4,11 @@ DPDK Release 2.2
 New Features
 ------------
 
+* **Enhanced support for the Chelsio CXGBE driver.**
+
+  *  Added support for Jumbo Frames.
+  *  Optimize forwarding performance for Chelsio T5 40GbE cards.
+
 
 Resolved Issues
 ---------------
-- 
2.5.3