diff mbox series

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

Message ID 20240102123935.3524184-2-qi.z.zhang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Qi Zhang
Headers
Series [v7,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/github-robot: build success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Qi Zhang Jan. 2, 2024, 12:39 p.m. UTC 
  Document ice specific testpmd 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

Qiming Yang Jan. 2, 2024, 7:14 a.m. UTC | #1 
> -----Original Message-----
> From: Zhang, Qi Z <qi.z.zhang@intel.com>
> Sent: Tuesday, January 2, 2024 8:40 PM
> To: Yang, Qiming <qiming.yang@intel.com>; Wu, Wenjun1
> <wenjun1.wu@intel.com>
> Cc: dev@dpdk.org; Zhang, Qi Z <qi.z.zhang@intel.com>
> Subject: [PATCH v7 2/2] doc: add document for ice diagnostic utilities
> 
> Document ice specific testpmd 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(+)
> 
> 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
>  ---------------------------
> 
> --
> 2.31.1

Acked-by: Qiming Yang <qiming.yang@intel.com>
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
 ---------------------------