Document update for debug options and inforamtion for PMD instances
port, traffic manager, crypto, mempool and ring instances.
Signed-off-by: Vipin Varghese <vipin.vargh...@intel.com>
---
doc/guides/tools/proc_info.rst | 31 +++++++++++++++++++++++++++----
1 file changed, 27 insertions(+), 4 deletions(-)
diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index d5b5ed6a6..2b06e2f86 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -6,9 +6,9 @@ dpdk-procinfo Application
The dpdk-procinfo application is a Data Plane Development Kit (DPDK)
application
that runs as a DPDK secondary process and is capable of retrieving port
-statistics, resetting port statistics and printing DPDK memory information.
-This application extends the original functionality that was supported by
-dump_cfg.
+statistics, resetting port statistics, printing DPDK memory information and
+debug information for port|tm|crypto|ring|mempool. This application extends the
+original functionality that was supported by dump_cfg.
Running the Application
-----------------------
@@ -17,7 +17,8 @@ The application has a number of command line options:
.. code-block:: console
./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats
|
- --stats-reset | --xstats-reset]
+ --stats-reset | --xstats-reset --dbg-port | --dbg-tm | --dbg-crypto |
+ --dbg-mempool[=name] | --dbg-ring[=name]]
Parameters
~~~~~~~~~~
@@ -41,6 +42,28 @@ If no port mask is specified xstats are reset for all DPDK
ports.
**-m**: Print DPDK memory information.
+**--dbg-port**
+The dbg-port parameter displays port level various configuration and
+mbuf pool information associated to RX queues.
+
+**--dbg-tm**
+The dbg-tm parameter displays per port traffic manager settings and
+current configuration. It also display statistics too.
+
+**--dbg-crypto**
+The dbg-crypto parameter displays available cryptodev configurations,
+settings and stats per node.
+
+**--dbg-mempool[=name]**
+The dbg-mempool parameter display current allocation of all mempool
+with debug information. Specifying the name allows display details for
+specific mempool. For invalid|no mempool name, whole list is dump.
+
+**--dbg-ring[=name]**
+The dbg-ring pararmeter display current allocation of all ring with
+debug information. Specifying the name allows to display details for specific
+ring. For invalid|no ring name, whole list is dump.
+
Limitations
-----------
--
2.17.1
