From: Qi Zhang <qi.z.zhang@intel.com>
To: qiming.yang@intel.com, wenjun1.wu@intel.com
Cc: dev@dpdk.org, Qi Zhang <qi.z.zhang@intel.com>
Subject: [PATCH v4 2/2] doc: add document for diagnostic utilities
Date: Tue, 2 Jan 2024 05:33:51 -0500 [thread overview]
Message-ID: <20240102103351.3435716-2-qi.z.zhang@intel.com> (raw)
In-Reply-To: <20240102103351.3435716-1-qi.z.zhang@intel.com>
Document CLI for diagnose purpose.
Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
---
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
next prev parent reply other threads:[~2024-01-02 2:12 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-26 18:54 [PATCH 1/2] net/ice: add Tx scheduling tree dump support Qi Zhang
2023-12-26 18:54 ` [PATCH 2/2] doc: add document for diagnostic utilities Qi Zhang
2023-12-27 12:31 ` [PATCH v2 1/2] net/ice: add Tx scheduling tree dump support Qi Zhang
2023-12-27 12:31 ` [PATCH v2 2/2] doc: add document for diagnostic utilities Qi Zhang
2023-12-28 10:10 ` [PATCH v3 1/2] net/ice: add Tx scheduling tree dump support Qi Zhang
2023-12-28 10:10 ` [PATCH v3 2/2] doc: add document for diagnostic utilities Qi Zhang
2024-01-02 10:28 ` [PATCH v4 1/2] net/ice: reset Tx sched node during commit Qi Zhang
2024-01-02 10:29 ` [PATCH v4 2/2] net/ice: support Tx sched commit before dev_start Qi Zhang
2024-01-02 10:32 ` [PATCH 1/2] net/ice: add Tx scheduling tree dump support Qi Zhang
2024-01-02 10:32 ` [PATCH 2/2] doc: add document for diagnostic utilities Qi Zhang
2024-01-02 10:33 ` [PATCH v4 1/2] net/ice: add Tx scheduling tree dump support Qi Zhang
2024-01-02 10:33 ` Qi Zhang [this message]
2024-01-02 12:24 ` [PATCH v5 " Qi Zhang
2024-01-02 12:24 ` [PATCH v5 2/2] doc: add document for diagnostic utilities Qi Zhang
2024-01-02 23:30 ` [PATCH v5 1/2] net/ice: add Tx scheduling tree dump support Stephen Hemminger
2024-01-02 12:29 ` [PATCH v6 " Qi Zhang
2024-01-02 12:29 ` [PATCH v6 2/2] doc: add document for ice diagnostic utilities Qi Zhang
2024-01-02 17:05 ` Stephen Hemminger
2024-01-02 12:39 ` [PATCH v7 1/2] net/ice: add Tx scheduling tree dump support Qi Zhang
2024-01-02 6:22 ` Wu, Wenjun1
2024-01-02 12:39 ` [PATCH v7 2/2] doc: add document for ice diagnostic utilities Qi Zhang
2024-01-02 7:14 ` Yang, Qiming
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240102103351.3435716-2-qi.z.zhang@intel.com \
--to=qi.z.zhang@intel.com \
--cc=dev@dpdk.org \
--cc=qiming.yang@intel.com \
--cc=wenjun1.wu@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).