diff mbox series

[v6,2/2] doc: add document for ice diagnostic utilities

Message ID 20240102122931.3480916-2-qi.z.zhang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers
Series [v6,1/2] net/ice: add Tx scheduling tree dump support |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Qi Zhang Jan. 2, 2024, 12:29 p.m. UTC 
  Document CLI for diagnose purpose.

Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
---

v6:
- fix title

 doc/guides/nics/ice.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

Comments

Stephen Hemminger Jan. 2, 2024, 5:05 p.m. UTC | #1 
On Tue,  2 Jan 2024 07:29:31 -0500
Qi Zhang <qi.z.zhang@intel.com> wrote:

> Document CLI for diagnose purpose.
> 
> Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>

This raises the question for me.
Why is this only ice driver specific? Other drivers may implement similar features.

DPDK drivers are not supposed to be unique snowflakes.
diff mbox series

Patch

diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 820a385b06..29309abe4d 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -411,6 +411,42 @@  To start ``testpmd``, and add vlan 10 to port 0:
 
     testpmd> rx_vlan add 10 0
 
+Diagnostic Utilities
+--------------------
+
+Dump DDP Package
+~~~~~~~~~~~~~~~~
+
+Dump the runtime packet processing pipeline configuration into a
+binary file. This helps the support team diagnose hardware
+configuration issues.
+
+Usage::
+
+    testpmd>ddp dump <port_id> <output_file>
+
+Dump Switch Configurations
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Dump detail hardware configurations related to the switch pipeline
+stage into a binary file.
+
+Usage::
+
+    testpmd>ddp dump switch <port_id> <output_file>
+
+Dump Tx Scheduling Tree
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Dump the runtime Tx scheduling tree into a DOT file.
+
+Usage::
+
+    testpmd>txsched dump <port_id> <brief|detail> <output_file>
+
+In "brief" mode, all scheduling nodes in the tree are displayed.
+In "detail" mode, each node's configuration parameters are also displayed.
+
 Limitations or Known issues
 ---------------------------