[PATCH v4 64/86] net/ntnic: update documentation

[Ferruh Yigit]

On 10/29/2024 4:42 PM, Serhii Iliushyk wrote:
> From: Oleksandr Kolomeiets <okl-plv at napatech.com>
> 
> Update required documentation
> 
> Signed-off-by: Oleksandr Kolomeiets <okl-plv at napatech.com>
> ---
>  doc/guides/nics/ntnic.rst              | 30 ++++++++++++++++++++++++++
>  doc/guides/rel_notes/release_24_11.rst |  2 ++
>  2 files changed, 32 insertions(+)
> 
> diff --git a/doc/guides/nics/ntnic.rst b/doc/guides/nics/ntnic.rst
> index 2c160ae592..e7e1cbcff7 100644
> --- a/doc/guides/nics/ntnic.rst
> +++ b/doc/guides/nics/ntnic.rst
> @@ -40,6 +40,36 @@ Features
>  - Unicast MAC filter
>  - Multicast MAC filter
>  - Promiscuous mode (Enable only. The device always run promiscuous mode)
> +- Multiple TX and RX queues.
> +- Scattered and gather for TX and RX.
> +- RSS hash
> +- RSS key update
> +- RSS based on VLAN or 5-tuple.
> +- RSS using different combinations of fields: L3 only, L4 only or both, and
> +    source only, destination only or both.
> +- Several RSS hash keys, one for each flow type.
> +- Default RSS operation with no hash key specification.
> +- VLAN filtering.
> +- RX VLAN stripping via raw decap.
> +- TX VLAN insertion via raw encap.
> +- Flow API.
> +- Multiple process.
> +- Tunnel types: GTP.
> +- Tunnel HW offload: Packet type, inner/outer RSS, IP and UDP checksum
> +    verification.
> +- Support for multiple rte_flow groups.
> +- Encapsulation and decapsulation of GTP data.
> +- Packet modification: NAT, TTL decrement, DSCP tagging
> +- Traffic mirroring.
> +- Jumbo frame support.
> +- Port and queue statistics.
> +- RMON statistics in extended stats.
> +- Flow metering, including meter policy API.
> +- Link state information.
> +- CAM and TCAM based matching.
> +- Exact match of 140 million flows and policies.
> +- Basic stats
> +- Extended stats
>

Instead of having a separate commit, can you please distribute document
update to the patch that adds the documented feature?

>  
>  Limitations
>  ~~~~~~~~~~~
> diff --git a/doc/guides/rel_notes/release_24_11.rst b/doc/guides/rel_notes/release_24_11.rst
> index fa4822d928..75769d1992 100644
> --- a/doc/guides/rel_notes/release_24_11.rst
> +++ b/doc/guides/rel_notes/release_24_11.rst
> @@ -160,6 +160,8 @@ New Features
>    * Added NT flow backend initialization.
>    * Added initialization of FPGA modules related to flow HW offload.
>    * Added basic handling of the virtual queues.
> +  * Added flow handling API
> +  * Added statistics API
>  
>  * **Added cryptodev queue pair reset support.**
>