[v6,2/2] doc: add document for ice diagnostic utilities
Checks
Commit Message
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
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.
@@ -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
---------------------------