[PATCH v7 2/2] net/iavf: add diagnostic support in TX path

[Zhang, Qi Z]

> -----Original Message-----
> From: Mingjin Ye <mingjinx.ye at intel.com>
> Sent: Tuesday, January 2, 2024 6:52 PM
> To: dev at dpdk.org
> Cc: Yang, Qiming <qiming.yang at intel.com>; Ye, MingjinX
> <mingjinx.ye at intel.com>; Wu, Wenjun1 <wenjun1.wu at intel.com>; Zhang,
> Yuying <yuying.zhang at intel.com>; Xing, Beilei <beilei.xing at intel.com>; Su,
> Simei <simei.su at intel.com>; Wu, Jingjing <jingjing.wu at intel.com>
> Subject: [PATCH v7 2/2] net/iavf: add diagnostic support in TX path
> 
> The only way to enable diagnostics for TX paths is to modify the application
> source code. Making it difficult to diagnose faults.
> 
> In this patch, the devarg option "mbuf_check" is introduced and the
> parameters are configured to enable the corresponding diagnostics.
> 
> supported cases: mbuf, size, segment, offload.
>  1. mbuf: check for corrupted mbuf.
>  2. size: check min/max packet length according to hw spec.
>  3. segment: check number of mbuf segments not exceed hw limitation.
>  4. offload: check any unsupported offload flag.
> 
> parameter format: mbuf_check=[mbuf,<case1>,<case2>]
> eg: dpdk-testpmd -a 0000:81:01.0,mbuf_check=[mbuf,size] -- -i
> 
> Signed-off-by: Mingjin Ye <mingjinx.ye at intel.com>
> ---
> v2: Remove call chain.
> ---
> v3: Optimisation implementation.
> ---
> v4: Fix Windows os compilation error.
> ---
> v5: Split Patch.
> ---
> v6: remove strict.
> ---
>  doc/guides/nics/intel_vf.rst   |  4 ++
>  drivers/net/iavf/iavf.h        | 12 +++++
>  drivers/net/iavf/iavf_ethdev.c | 72 +++++++++++++++++++++++++
>  drivers/net/iavf/iavf_rxtx.c   | 98 ++++++++++++++++++++++++++++++++++
>  drivers/net/iavf/iavf_rxtx.h   |  2 +
>  5 files changed, 188 insertions(+)
> 
> diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst index
> ad08198f0f..8e39bc831c 100644
> --- a/doc/guides/nics/intel_vf.rst
> +++ b/doc/guides/nics/intel_vf.rst
> @@ -111,6 +111,10 @@ For more detail on SR-IOV, please refer to the
> following documents:
>      by setting the ``devargs`` parameter like ``-a 18:01.0,no-poll-on-link-
> down=1``
>      when IAVF is backed by an Intel\ |reg| E810 device or an Intel\ |reg| 700
> Series Ethernet device.
> 
> +    Enable mbuf check for Tx diagnostics by setting the devargs parameter
> like
> +    ``-a 18:01.0,mbuf_check=[mbuf,<case1>,<case2>]`` when IAVF is backed
> by an
> +    Intel\ |reg| E810 device or an Intel\ |reg| 700 Series Ethernet device.
> +

Please list all the options with descriptions which you already have them in the commit log.
Its necessary for user to understand the detail about how to use the devarg from document.