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

[Yang, Qiming]

> -----Original Message-----
> From: Zhang, Qi Z <qi.z.zhang at intel.com>
> Sent: Tuesday, January 2, 2024 8:40 PM
> To: Yang, Qiming <qiming.yang at intel.com>; Wu, Wenjun1
> <wenjun1.wu at intel.com>
> Cc: dev at dpdk.org; Zhang, Qi Z <qi.z.zhang at 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 at 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 at intel.com>